From e68c4948f43b66b47c5ff3ac4459eb5c22dfaa36 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Tue, 13 Aug 2024 15:20:35 +0000 Subject: [PATCH] ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.363.1 --- .speakeasy/gen.lock | 16 +- .speakeasy/workflow.lock | 10 +- README.md | 110 +- RELEASES.md | 12 +- USAGE.md | 34 +- build.gradle | 4 +- docs/models/components/ActorToken.md | 22 +- docs/models/components/Admin.md | 12 +- docs/models/components/AllowlistIdentifier.md | 20 +- docs/models/components/AttributeMapping.md | 12 +- docs/models/components/BlocklistIdentifier.md | 18 +- .../models/components/BlocklistIdentifiers.md | 8 +- docs/models/components/ClerkError.md | 14 +- docs/models/components/Client.md | 22 +- docs/models/components/DeletedObject.md | 12 +- docs/models/components/Domain.md | 22 +- docs/models/components/Domains.md | 8 +- docs/models/components/EmailAddress.md | 20 +- docs/models/components/ErrorClerkError.md | 14 +- docs/models/components/IdentificationLink.md | 8 +- .../models/components/InstanceRestrictions.md | 14 +- docs/models/components/InstanceSettings.md | 16 +- docs/models/components/Invitation.md | 22 +- docs/models/components/InvitationRevoked.md | 22 +- docs/models/components/JWTTemplate.md | 24 +- docs/models/components/OAuthApplication.md | 30 +- .../components/OAuthApplicationWithSecret.md | 32 +- docs/models/components/OAuthApplications.md | 8 +- docs/models/components/Oauth.md | 16 +- docs/models/components/Organization.md | 28 +- .../components/OrganizationInvitation.md | 24 +- .../components/OrganizationInvitations.md | 8 +- .../components/OrganizationMembership.md | 24 +- .../OrganizationMembershipOrganization.md | 28 +- .../components/OrganizationMemberships.md | 8 +- .../models/components/OrganizationSettings.md | 24 +- .../models/components/OrganizationWithLogo.md | 34 +- docs/models/components/Organizations.md | 8 +- docs/models/components/Otp.md | 12 +- docs/models/components/Passkey.md | 14 +- docs/models/components/PhoneNumber.md | 26 +- docs/models/components/ProxyCheck.md | 20 +- docs/models/components/PublicUserData.md | 14 +- docs/models/components/RedirectURL.md | 14 +- docs/models/components/SAMLAccount.md | 24 +- docs/models/components/SAMLConnection.md | 46 +- docs/models/components/SAMLConnections.md | 8 +- docs/models/components/SAMLErrorClerkError.md | 14 +- docs/models/components/Saml.md | 16 +- docs/models/components/SchemasPasskey.md | 14 +- docs/models/components/Security.md | 6 +- docs/models/components/Session.md | 28 +- docs/models/components/SignInToken.md | 20 +- docs/models/components/SignUp.md | 50 +- docs/models/components/Template.md | 46 +- docs/models/components/TestingToken.md | 2 +- docs/models/components/Ticket.md | 12 +- docs/models/components/TotalCount.md | 8 +- docs/models/components/User.md | 74 +- docs/models/components/VerificationAdmin.md | 12 +- docs/models/components/VerificationOTP.md | 12 +- docs/models/components/Web3Signature.md | 14 +- docs/models/components/Web3Wallet.md | 16 +- .../components/Web3WalletVerificationAdmin.md | 12 +- docs/models/errors/ClerkErrors.md | 8 +- .../models/operations/AddDomainRequestBody.md | 2 +- docs/models/operations/AddDomainResponse.md | 2 +- docs/models/operations/AttributeMapping.md | 12 +- docs/models/operations/BanUserResponse.md | 2 +- ...angeProductionInstanceDomainRequestBody.md | 2 +- .../operations/CreateActorTokenRequestBody.md | 6 +- .../operations/CreateActorTokenResponse.md | 2 +- .../CreateAllowlistIdentifierRequestBody.md | 2 +- .../CreateAllowlistIdentifierResponse.md | 12 +- .../CreateBlocklistIdentifierResponse.md | 12 +- .../CreateEmailAddressRequestBody.md | 8 +- .../operations/CreateEmailAddressResponse.md | 2 +- .../operations/CreateInvitationRequestBody.md | 8 +- .../operations/CreateInvitationResponse.md | 2 +- .../CreateJWTTemplateRequestBody.md | 18 +- .../operations/CreateJWTTemplateResponse.md | 2 +- .../CreateOAuthApplicationRequestBody.md | 4 +- .../CreateOAuthApplicationResponse.md | 12 +- ...CreateOrganizationInvitationBulkRequest.md | 8 +- ...reateOrganizationInvitationBulkResponse.md | 12 +- .../CreateOrganizationInvitationRequest.md | 8 +- ...CreateOrganizationInvitationRequestBody.md | 16 +- .../CreateOrganizationInvitationResponse.md | 12 +- .../CreateOrganizationMembershipRequest.md | 8 +- .../CreateOrganizationMembershipResponse.md | 12 +- .../CreateOrganizationRequestBody.md | 16 +- .../operations/CreateOrganizationResponse.md | 2 +- .../CreatePhoneNumberRequestBody.md | 10 +- .../operations/CreatePhoneNumberResponse.md | 2 +- .../CreateRedirectURLRequestBody.md | 2 +- .../operations/CreateRedirectURLResponse.md | 2 +- .../CreateSAMLConnectionRequestBody.md | 22 +- .../CreateSAMLConnectionResponse.md | 2 +- .../CreateSessionTokenFromTemplateResponse.md | 12 +- ...ateSessionTokenFromTemplateResponseBody.md | 8 +- .../CreateSignInTokenRequestBody.md | 4 +- .../operations/CreateSignInTokenResponse.md | 2 +- .../operations/CreateSvixAppResponse.md | 2 +- .../operations/CreateTestingTokenResponse.md | 2 +- .../operations/CreateUserRequestBody.md | 28 +- docs/models/operations/CreateUserResponse.md | 2 +- .../DeleteAllowlistIdentifierResponse.md | 2 +- .../DeleteBlocklistIdentifierResponse.md | 2 +- .../models/operations/DeleteDomainResponse.md | 2 +- .../operations/DeleteEmailAddressResponse.md | 2 +- .../operations/DeleteJWTTemplateResponse.md | 2 +- .../DeleteOAuthApplicationResponse.md | 2 +- .../DeleteOrganizationLogoResponse.md | 2 +- .../DeleteOrganizationMembershipResponse.md | 12 +- .../operations/DeleteOrganizationResponse.md | 2 +- .../operations/DeletePhoneNumberResponse.md | 2 +- .../operations/DeleteRedirectURLResponse.md | 2 +- .../DeleteSAMLConnectionResponse.md | 2 +- .../DeleteUserProfileImageResponse.md | 2 +- docs/models/operations/DeleteUserResponse.md | 2 +- docs/models/operations/DisableMFAResponse.md | 12 +- .../operations/DisableMFAResponseBody.md | 6 +- .../operations/GenerateSvixAuthURLResponse.md | 2 +- .../models/operations/GetClientListRequest.md | 4 +- .../operations/GetClientListResponse.md | 2 +- docs/models/operations/GetClientResponse.md | 2 +- .../operations/GetEmailAddressResponse.md | 2 +- .../operations/GetJWTTemplateResponse.md | 2 +- .../operations/GetOAuthAccessTokenResponse.md | 2 +- .../operations/GetOAuthApplicationResponse.md | 2 +- .../GetOrganizationInvitationResponse.md | 12 +- .../operations/GetOrganizationResponse.md | 2 +- .../operations/GetPhoneNumberResponse.md | 2 +- .../GetPublicInterstitialRequest.md | 4 +- .../operations/GetRedirectURLResponse.md | 2 +- .../operations/GetSAMLConnectionResponse.md | 2 +- .../operations/GetSessionListRequest.md | 10 +- .../operations/GetSessionListResponse.md | 2 +- docs/models/operations/GetSessionResponse.md | 2 +- .../operations/GetTemplateListRequest.md | 6 +- .../operations/GetTemplateListResponse.md | 2 +- docs/models/operations/GetTemplateRequest.md | 8 +- docs/models/operations/GetTemplateResponse.md | 2 +- docs/models/operations/GetUserListRequest.md | 10 +- docs/models/operations/GetUserListResponse.md | 2 +- docs/models/operations/GetUserResponse.md | 2 +- .../models/operations/GetUsersCountRequest.md | 2 +- .../operations/GetUsersCountResponse.md | 2 +- .../ListAllowlistIdentifiersResponse.md | 2 +- .../ListBlocklistIdentifiersResponse.md | 12 +- docs/models/operations/ListDomainsResponse.md | 2 +- .../operations/ListInvitationsRequest.md | 6 +- .../operations/ListInvitationsResponse.md | 2 +- .../operations/ListJWTTemplatesResponse.md | 2 +- .../ListOAuthApplicationsRequest.md | 4 +- .../ListOAuthApplicationsResponse.md | 2 +- .../ListOrganizationInvitationsRequest.md | 12 +- .../ListOrganizationInvitationsResponse.md | 12 +- .../ListOrganizationMembershipsRequest.md | 6 +- .../ListOrganizationMembershipsResponse.md | 12 +- .../operations/ListOrganizationsRequest.md | 10 +- .../operations/ListOrganizationsResponse.md | 2 +- ...stPendingOrganizationInvitationsRequest.md | 4 +- ...tPendingOrganizationInvitationsResponse.md | 12 +- .../operations/ListRedirectURLsResponse.md | 2 +- .../operations/ListSAMLConnectionsRequest.md | 4 +- .../operations/ListSAMLConnectionsResponse.md | 2 +- docs/models/operations/LockUserResponse.md | 2 +- .../MergeOrganizationMetadataRequest.md | 8 +- .../MergeOrganizationMetadataRequestBody.md | 8 +- .../MergeOrganizationMetadataResponse.md | 2 +- .../operations/PreviewTemplateRequest.md | 10 +- .../operations/PreviewTemplateRequestBody.md | 8 +- .../operations/PreviewTemplateResponse.md | 12 +- docs/models/operations/RequestBody.md | 16 +- docs/models/operations/ResponseBody.md | 22 +- .../operations/RevertTemplateRequest.md | 8 +- .../operations/RevertTemplateResponse.md | 2 +- .../operations/RevokeActorTokenResponse.md | 2 +- .../operations/RevokeInvitationResponse.md | 2 +- .../RevokeOrganizationInvitationRequest.md | 10 +- .../RevokeOrganizationInvitationResponse.md | 12 +- .../operations/RevokeSessionResponse.md | 2 +- .../operations/RevokeSignInTokenResponse.md | 2 +- .../RotateOAuthApplicationSecretResponse.md | 12 +- .../operations/SetUserProfileImageRequest.md | 8 +- .../SetUserProfileImageRequestBody.md | 6 +- .../operations/SetUserProfileImageResponse.md | 2 +- .../ToggleTemplateDeliveryRequest.md | 10 +- .../ToggleTemplateDeliveryRequestBody.md | 2 +- .../ToggleTemplateDeliveryResponse.md | 2 +- docs/models/operations/UnbanUserResponse.md | 2 +- docs/models/operations/UnlockUserResponse.md | 2 +- docs/models/operations/UpdateDomainRequest.md | 8 +- .../operations/UpdateDomainRequestBody.md | 4 +- .../models/operations/UpdateDomainResponse.md | 2 +- .../operations/UpdateEmailAddressRequest.md | 8 +- .../UpdateEmailAddressRequestBody.md | 4 +- .../operations/UpdateEmailAddressResponse.md | 2 +- .../UpdateInstanceAuthConfigRequestBody.md | 12 +- .../UpdateInstanceAuthConfigResponse.md | 2 +- ...InstanceOrganizationSettingsRequestBody.md | 12 +- ...ateInstanceOrganizationSettingsResponse.md | 12 +- .../operations/UpdateInstanceRequestBody.md | 16 +- .../UpdateInstanceRestrictionsRequestBody.md | 14 +- .../UpdateInstanceRestrictionsResponse.md | 12 +- .../operations/UpdateJWTTemplateRequest.md | 8 +- .../UpdateJWTTemplateRequestBody.md | 18 +- .../operations/UpdateJWTTemplateResponse.md | 2 +- .../UpdateOAuthApplicationRequest.md | 8 +- .../UpdateOAuthApplicationRequestBody.md | 6 +- .../UpdateOAuthApplicationResponse.md | 2 +- ...teOrganizationMembershipMetadataRequest.md | 10 +- ...ganizationMembershipMetadataRequestBody.md | 8 +- ...eOrganizationMembershipMetadataResponse.md | 12 +- .../UpdateOrganizationMembershipRequest.md | 10 +- .../UpdateOrganizationMembershipResponse.md | 12 +- .../operations/UpdateOrganizationRequest.md | 8 +- .../UpdateOrganizationRequestBody.md | 16 +- .../operations/UpdateOrganizationResponse.md | 2 +- .../operations/UpdatePhoneNumberRequest.md | 8 +- .../UpdatePhoneNumberRequestBody.md | 6 +- .../operations/UpdatePhoneNumberResponse.md | 2 +- ...dateProductionInstanceDomainRequestBody.md | 2 +- .../UpdateSAMLConnectionAttributeMapping.md | 12 +- .../operations/UpdateSAMLConnectionRequest.md | 8 +- .../UpdateSAMLConnectionRequestBody.md | 28 +- .../UpdateSAMLConnectionResponse.md | 2 +- docs/models/operations/UpdateSignUpRequest.md | 8 +- .../operations/UpdateSignUpRequestBody.md | 4 +- .../models/operations/UpdateSignUpResponse.md | 2 +- .../operations/UpdateUserMetadataRequest.md | 8 +- .../UpdateUserMetadataRequestBody.md | 6 +- .../operations/UpdateUserMetadataResponse.md | 2 +- docs/models/operations/UpdateUserRequest.md | 8 +- .../operations/UpdateUserRequestBody.md | 42 +- docs/models/operations/UpdateUserResponse.md | 2 +- .../UploadOrganizationLogoRequest.md | 8 +- .../UploadOrganizationLogoRequestBody.md | 8 +- .../UploadOrganizationLogoResponse.md | 12 +- .../operations/UpsertTemplateRequest.md | 10 +- .../operations/UpsertTemplateRequestBody.md | 14 +- .../operations/UpsertTemplateResponse.md | 2 +- .../UsersGetOrganizationMembershipsRequest.md | 4 +- ...UsersGetOrganizationMembershipsResponse.md | 12 +- .../operations/VerifyClientRequestBody.md | 2 +- .../models/operations/VerifyClientResponse.md | 2 +- .../VerifyDomainProxyRequestBody.md | 4 +- .../operations/VerifyDomainProxyResponse.md | 2 +- .../operations/VerifyPasswordRequest.md | 8 +- .../operations/VerifyPasswordResponse.md | 12 +- .../operations/VerifyPasswordResponseBody.md | 6 +- .../models/operations/VerifySessionRequest.md | 8 +- .../operations/VerifySessionRequestBody.md | 2 +- .../operations/VerifySessionResponse.md | 2 +- docs/models/operations/VerifyTOTPRequest.md | 8 +- docs/models/operations/VerifyTOTPResponse.md | 12 +- .../operations/VerifyTOTPResponseBody.md | 8 +- docs/sdks/actors/README.md | 52 +- docs/sdks/allowlist/README.md | 67 +- docs/sdks/blocklist/README.md | 67 +- docs/sdks/clients/README.md | 67 +- docs/sdks/domains/README.md | 96 +- docs/sdks/emailaddresses/README.md | 96 +- docs/sdks/instance/README.md | 162 +-- docs/sdks/invitations/README.md | 70 +- docs/sdks/jwks/README.md | 20 +- docs/sdks/jwttemplates/README.md | 116 +- docs/sdks/miscellaneous/README.md | 24 +- docs/sdks/oauthapplications/README.md | 136 +- docs/sdks/organizationinvitations/README.md | 161 +-- docs/sdks/organizationmemberships/README.md | 133 +- docs/sdks/organizations/README.md | 202 ++- docs/sdks/phonenumbers/README.md | 96 +- docs/sdks/proxy/README.md | 27 +- docs/sdks/redirecturls/README.md | 87 +- docs/sdks/samlconnections/README.md | 117 +- docs/sdks/sessions/README.md | 116 +- docs/sdks/signintokens/README.md | 47 +- docs/sdks/signups/README.md | 29 +- docs/sdks/templates/README.md | 180 ++- docs/sdks/testingtokens/README.md | 20 +- docs/sdks/users/README.md | 426 +++--- docs/sdks/webhooks/README.md | 60 +- .../java/com/clerk/backend_api/Actors.java | 146 +- .../java/com/clerk/backend_api/Allowlist.java | 200 ++- .../java/com/clerk/backend_api/Blocklist.java | 201 ++- .../java/com/clerk/backend_api/Clerk.java | 17 +- .../java/com/clerk/backend_api/Clients.java | 212 +-- .../java/com/clerk/backend_api/Domains.java | 264 ++-- .../com/clerk/backend_api/EmailAddresses.java | 284 ++-- .../java/com/clerk/backend_api/Instance.java | 415 ++++-- .../com/clerk/backend_api/Invitations.java | 211 +-- src/main/java/com/clerk/backend_api/Jwks.java | 49 +- .../com/clerk/backend_api/JwtTemplates.java | 331 +++-- .../com/clerk/backend_api/Miscellaneous.java | 64 +- .../clerk/backend_api/OAuthApplications.java | 403 ++++-- .../backend_api/OrganizationInvitations.java | 424 +++--- .../backend_api/OrganizationMemberships.java | 363 +++-- .../com/clerk/backend_api/Organizations.java | 548 +++++--- .../com/clerk/backend_api/PhoneNumbers.java | 284 ++-- .../java/com/clerk/backend_api/Proxy.java | 86 +- .../com/clerk/backend_api/RedirectURLs.java | 254 ++-- .../clerk/backend_api/SDKConfiguration.java | 26 +- .../clerk/backend_api/SamlConnections.java | 347 +++-- .../java/com/clerk/backend_api/Sessions.java | 334 +++-- .../com/clerk/backend_api/SignInTokens.java | 146 +- .../java/com/clerk/backend_api/SignUps.java | 93 +- .../java/com/clerk/backend_api/Templates.java | 447 ++++--- .../com/clerk/backend_api/TestingTokens.java | 60 +- .../java/com/clerk/backend_api/Users.java | 1192 +++++++++++------ .../java/com/clerk/backend_api/Webhooks.java | 165 ++- .../backend_api/models/components/Actor.java | 14 +- .../models/components/ActorToken.java | 58 +- .../models/components/ActorTokenActor.java | 14 +- .../models/components/ActorTokenObject.java | 11 +- .../models/components/ActorTokenStatus.java | 11 +- .../backend_api/models/components/Admin.java | 48 +- .../AdminVerificationPhoneNumberStatus.java | 11 +- .../components/AdminVerificationStatus.java | 11 +- .../components/AdminVerificationStrategy.java | 11 +- .../AdminVerificationWeb3WalletStatus.java | 11 +- .../AdminVerificationWeb3WalletStrategy.java | 11 +- .../components/AllowlistIdentifier.java | 109 +- .../components/AllowlistIdentifierObject.java | 11 +- .../models/components/AttributeMapping.java | 73 +- .../components/BlocklistIdentifier.java | 94 +- .../BlocklistIdentifierIdentifierType.java | 11 +- .../components/BlocklistIdentifierObject.java | 11 +- .../components/BlocklistIdentifiers.java | 31 +- .../models/components/CNameTarget.java | 20 +- .../backend_api/models/components/Claims.java | 14 +- .../models/components/ClerkError.java | 37 +- .../components/ClerkErrorErrorMeta.java | 14 +- .../backend_api/models/components/Client.java | 100 +- .../models/components/DeletedObject.java | 48 +- .../backend_api/models/components/Domain.java | 78 +- .../models/components/DomainObject.java | 11 +- .../models/components/Domains.java | 31 +- .../components/DomainsEnrollmentModes.java | 11 +- .../models/components/EmailAddress.java | 60 +- .../models/components/EmailAddressObject.java | 11 +- .../backend_api/models/components/Error.java | 35 +- .../models/components/ErrorClerkError.java | 37 +- .../models/components/ErrorMeta.java | 14 +- .../models/components/ExternalAccount.java | 14 +- .../models/components/ExternalAccounts.java | 14 +- .../models/components/IdentificationLink.java | 17 +- .../models/components/IdentifierType.java | 11 +- .../components/InstanceRestrictions.java | 77 +- .../InstanceRestrictionsObject.java | 11 +- .../models/components/InstanceSettings.java | 92 +- .../components/InstanceSettingsObject.java | 11 +- .../models/components/Invitation.java | 60 +- .../models/components/InvitationObject.java | 11 +- .../components/InvitationPublicMetadata.java | 14 +- .../models/components/InvitationRevoked.java | 60 +- .../components/InvitationRevokedObject.java | 11 +- .../InvitationRevokedPublicMetadata.java | 14 +- .../components/InvitationRevokedStatus.java | 11 +- .../models/components/InvitationStatus.java | 11 +- .../models/components/JWTTemplate.java | 61 +- .../models/components/JWTTemplateObject.java | 11 +- .../backend_api/models/components/Meta.java | 14 +- .../backend_api/models/components/Nonce.java | 11 +- .../models/components/OAuthApplication.java | 41 +- .../components/OAuthApplicationObject.java | 11 +- .../OAuthApplicationWithSecret.java | 56 +- .../OAuthApplicationWithSecretObject.java | 11 +- .../models/components/OAuthApplications.java | 31 +- .../components/OTPVerificationStatus.java | 11 +- .../components/OTPVerificationStrategy.java | 11 +- .../backend_api/models/components/Oauth.java | 53 +- .../components/OauthVerificationStatus.java | 11 +- .../components/OauthVerificationStrategy.java | 11 +- .../backend_api/models/components/Object.java | 11 +- .../models/components/Organization.java | 78 +- .../components/OrganizationInvitation.java | 126 +- .../OrganizationInvitationObject.java | 11 +- ...OrganizationInvitationPrivateMetadata.java | 14 +- .../OrganizationInvitationPublicMetadata.java | 14 +- .../components/OrganizationInvitations.java | 31 +- .../components/OrganizationMembership.java | 106 +- .../OrganizationMembershipObject.java | 11 +- .../OrganizationMembershipOrganization.java | 78 +- ...anizationMembershipOrganizationObject.java | 11 +- ...MembershipOrganizationPrivateMetadata.java | 14 +- ...nMembershipOrganizationPublicMetadata.java | 14 +- ...OrganizationMembershipPrivateMetadata.java | 14 +- .../OrganizationMembershipPublicMetadata.java | 14 +- .../components/OrganizationMemberships.java | 31 +- .../models/components/OrganizationObject.java | 11 +- .../OrganizationPrivateMetadata.java | 14 +- .../OrganizationPublicMetadata.java | 14 +- .../components/OrganizationSettings.java | 76 +- .../OrganizationSettingsObject.java | 11 +- .../components/OrganizationWithLogo.java | 109 +- .../OrganizationWithLogoObject.java | 11 +- .../OrganizationWithLogoPrivateMetadata.java | 14 +- .../OrganizationWithLogoPublicMetadata.java | 14 +- .../models/components/Organizations.java | 31 +- .../backend_api/models/components/Otp.java | 73 +- .../models/components/Passkey.java | 51 +- .../components/PasskeyVerificationStatus.java | 11 +- .../PasskeyVerificationStrategy.java | 11 +- .../models/components/PhoneNumber.java | 110 +- .../models/components/PhoneNumberObject.java | 11 +- .../components/PhoneNumberVerification.java | 39 +- .../models/components/PrivateMetadata.java | 14 +- .../models/components/ProxyCheck.java | 31 +- .../models/components/ProxyCheckObject.java | 11 +- .../models/components/PublicMetadata.java | 14 +- .../models/components/PublicUserData.java | 118 +- .../models/components/RedirectURL.java | 24 +- .../models/components/RedirectURLObject.java | 11 +- .../models/components/SAMLAccount.java | 74 +- .../models/components/SAMLAccountObject.java | 11 +- .../components/SAMLAccountPublicMetadata.java | 14 +- .../components/SAMLAccountVerification.java | 39 +- .../models/components/SAMLConnection.java | 149 +-- .../components/SAMLConnectionObject.java | 11 +- .../models/components/SAMLConnections.java | 31 +- .../components/SAMLErrorClerkError.java | 37 +- .../components/SAMLVerificationStatus.java | 11 +- .../components/SAMLVerificationStrategy.java | 11 +- .../backend_api/models/components/Saml.java | 53 +- .../models/components/SchemasPasskey.java | 38 +- .../components/SchemasPasskeyObject.java | 11 +- .../SchemasPasskeyVerification.java | 35 +- .../models/components/Security.java | 28 +- .../models/components/Session.java | 52 +- .../models/components/SessionObject.java | 11 +- .../models/components/SignInToken.java | 56 +- .../models/components/SignInTokenObject.java | 11 +- .../models/components/SignInTokenStatus.java | 11 +- .../backend_api/models/components/SignUp.java | 252 ++-- .../models/components/SignUpObject.java | 11 +- .../components/SignUpPublicMetadata.java | 14 +- .../models/components/SignUpStatus.java | 11 +- .../components/SignUpUnsafeMetadata.java | 14 +- .../backend_api/models/components/Status.java | 11 +- .../models/components/Strategy.java | 11 +- .../models/components/SvixURL.java | 15 +- .../models/components/Template.java | 329 +++-- .../models/components/TemplateObject.java | 11 +- .../models/components/TestingToken.java | 20 +- .../models/components/TestingTokenObject.java | 11 +- .../backend_api/models/components/Ticket.java | 48 +- .../components/TicketVerificationStatus.java | 11 +- .../TicketVerificationStrategy.java | 11 +- .../models/components/TotalCount.java | 18 +- .../models/components/TotalCountObject.java | 11 +- .../backend_api/models/components/Type.java | 11 +- .../models/components/UnsafeMetadata.java | 14 +- .../backend_api/models/components/User.java | 549 ++++---- .../models/components/UserObject.java | 11 +- .../models/components/Verification.java | 43 +- .../models/components/VerificationAdmin.java | 48 +- .../models/components/VerificationError.java | 35 +- .../models/components/VerificationNonce.java | 11 +- .../models/components/VerificationOTP.java | 73 +- .../models/components/VerificationStatus.java | 11 +- .../components/VerificationStrategy.java | 11 +- .../models/components/Verifications.java | 14 +- .../models/components/Web3Signature.java | 50 +- .../Web3SignatureVerificationStatus.java | 11 +- .../Web3SignatureVerificationStrategy.java | 11 +- .../models/components/Web3Wallet.java | 40 +- .../models/components/Web3WalletObject.java | 11 +- .../components/Web3WalletVerification.java | 39 +- .../Web3WalletVerificationAdmin.java | 48 +- .../models/errors/ClerkErrors.java | 37 +- .../clerk/backend_api/models/errors/Meta.java | 14 +- .../operations/AddDomainRequestBody.java | 33 +- .../operations/AddDomainRequestBuilder.java | 14 +- .../models/operations/AddDomainResponse.java | 44 +- .../models/operations/AttributeMapping.java | 73 +- .../models/operations/BanUserRequest.java | 15 +- .../operations/BanUserRequestBuilder.java | 14 +- .../models/operations/BanUserResponse.java | 44 +- ...geProductionInstanceDomainRequestBody.java | 28 +- ...roductionInstanceDomainRequestBuilder.java | 14 +- ...hangeProductionInstanceDomainResponse.java | 22 +- .../backend_api/models/operations/Claims.java | 14 +- .../models/operations/CodeType.java | 11 +- .../CreateActorTokenRequestBody.java | 71 +- .../CreateActorTokenRequestBuilder.java | 14 +- .../operations/CreateActorTokenResponse.java | 44 +- .../CreateAllowlistIdentifierRequestBody.java | 34 +- ...eateAllowlistIdentifierRequestBuilder.java | 14 +- .../CreateAllowlistIdentifierResponse.java | 44 +- .../CreateBlocklistIdentifierRequestBody.java | 15 +- ...eateBlocklistIdentifierRequestBuilder.java | 14 +- .../CreateBlocklistIdentifierResponse.java | 44 +- .../CreateEmailAddressRequestBody.java | 74 +- .../CreateEmailAddressRequestBuilder.java | 14 +- .../CreateEmailAddressResponse.java | 44 +- .../CreateInvitationPublicMetadata.java | 14 +- .../CreateInvitationRequestBody.java | 71 +- .../CreateInvitationRequestBuilder.java | 14 +- .../operations/CreateInvitationResponse.java | 44 +- .../CreateJWTTemplateRequestBody.java | 108 +- .../CreateJWTTemplateRequestBuilder.java | 14 +- .../operations/CreateJWTTemplateResponse.java | 44 +- .../CreateOAuthApplicationRequestBody.java | 51 +- .../CreateOAuthApplicationRequestBuilder.java | 14 +- .../CreateOAuthApplicationResponse.java | 44 +- ...nizationInvitationBulkPrivateMetadata.java | 14 +- ...anizationInvitationBulkPublicMetadata.java | 14 +- ...eateOrganizationInvitationBulkRequest.java | 30 +- ...anizationInvitationBulkRequestBuilder.java | 19 +- ...ateOrganizationInvitationBulkResponse.java | 44 +- ...OrganizationInvitationPrivateMetadata.java | 14 +- ...eOrganizationInvitationPublicMetadata.java | 14 +- .../CreateOrganizationInvitationRequest.java | 17 +- ...eateOrganizationInvitationRequestBody.java | 39 +- ...eOrganizationInvitationRequestBuilder.java | 16 +- .../CreateOrganizationInvitationResponse.java | 44 +- .../CreateOrganizationMembershipRequest.java | 17 +- ...eateOrganizationMembershipRequestBody.java | 17 +- ...eOrganizationMembershipRequestBuilder.java | 16 +- .../CreateOrganizationMembershipResponse.java | 44 +- .../CreateOrganizationPrivateMetadata.java | 14 +- .../CreateOrganizationPublicMetadata.java | 14 +- .../CreateOrganizationRequestBody.java | 53 +- .../CreateOrganizationRequestBuilder.java | 14 +- .../CreateOrganizationResponse.java | 44 +- .../CreatePhoneNumberRequestBody.java | 89 +- .../CreatePhoneNumberRequestBuilder.java | 14 +- .../operations/CreatePhoneNumberResponse.java | 44 +- .../CreateRedirectURLRequestBody.java | 28 +- .../CreateRedirectURLRequestBuilder.java | 14 +- .../operations/CreateRedirectURLResponse.java | 44 +- .../CreateSAMLConnectionRequestBody.java | 97 +- .../CreateSAMLConnectionRequestBuilder.java | 14 +- .../CreateSAMLConnectionResponse.java | 44 +- ...CreateSessionTokenFromTemplateRequest.java | 17 +- ...essionTokenFromTemplateRequestBuilder.java | 16 +- ...reateSessionTokenFromTemplateResponse.java | 25 +- ...eSessionTokenFromTemplateResponseBody.java | 31 +- .../CreateSignInTokenRequestBody.java | 47 +- .../CreateSignInTokenRequestBuilder.java | 14 +- .../operations/CreateSignInTokenResponse.java | 44 +- .../CreateSvixAppRequestBuilder.java | 12 - .../operations/CreateSvixAppResponse.java | 44 +- .../CreateTestingTokenRequestBuilder.java | 12 - .../CreateTestingTokenResponse.java | 44 +- .../operations/CreateUserRequestBody.java | 254 ++-- .../operations/CreateUserRequestBuilder.java | 13 +- .../models/operations/CreateUserResponse.java | 44 +- .../DeleteAllowlistIdentifierRequest.java | 15 +- ...leteAllowlistIdentifierRequestBuilder.java | 14 +- .../DeleteAllowlistIdentifierResponse.java | 44 +- .../DeleteBlocklistIdentifierRequest.java | 15 +- ...leteBlocklistIdentifierRequestBuilder.java | 14 +- .../DeleteBlocklistIdentifierResponse.java | 44 +- .../operations/DeleteDomainRequest.java | 15 +- .../DeleteDomainRequestBuilder.java | 14 +- .../operations/DeleteDomainResponse.java | 44 +- .../operations/DeleteEmailAddressRequest.java | 15 +- .../DeleteEmailAddressRequestBuilder.java | 14 +- .../DeleteEmailAddressResponse.java | 44 +- .../operations/DeleteJWTTemplateRequest.java | 15 +- .../DeleteJWTTemplateRequestBuilder.java | 14 +- .../operations/DeleteJWTTemplateResponse.java | 44 +- .../DeleteOAuthApplicationRequest.java | 15 +- .../DeleteOAuthApplicationRequestBuilder.java | 14 +- .../DeleteOAuthApplicationResponse.java | 44 +- .../DeleteOrganizationLogoRequest.java | 15 +- .../DeleteOrganizationLogoRequestBuilder.java | 14 +- .../DeleteOrganizationLogoResponse.java | 44 +- .../DeleteOrganizationMembershipRequest.java | 17 +- ...eOrganizationMembershipRequestBuilder.java | 16 +- .../DeleteOrganizationMembershipResponse.java | 44 +- .../operations/DeleteOrganizationRequest.java | 15 +- .../DeleteOrganizationRequestBuilder.java | 14 +- .../DeleteOrganizationResponse.java | 44 +- .../operations/DeletePhoneNumberRequest.java | 15 +- .../DeletePhoneNumberRequestBuilder.java | 14 +- .../operations/DeletePhoneNumberResponse.java | 44 +- .../operations/DeleteRedirectURLRequest.java | 15 +- .../DeleteRedirectURLRequestBuilder.java | 14 +- .../operations/DeleteRedirectURLResponse.java | 44 +- .../DeleteSAMLConnectionRequest.java | 15 +- .../DeleteSAMLConnectionRequestBuilder.java | 14 +- .../DeleteSAMLConnectionResponse.java | 44 +- .../DeleteSvixAppRequestBuilder.java | 12 - .../operations/DeleteSvixAppResponse.java | 22 +- .../DeleteUserProfileImageRequest.java | 15 +- .../DeleteUserProfileImageRequestBuilder.java | 14 +- .../DeleteUserProfileImageResponse.java | 44 +- .../models/operations/DeleteUserRequest.java | 15 +- .../operations/DeleteUserRequestBuilder.java | 14 +- .../models/operations/DeleteUserResponse.java | 44 +- .../models/operations/DisableMFARequest.java | 15 +- .../operations/DisableMFARequestBuilder.java | 14 +- .../models/operations/DisableMFAResponse.java | 25 +- .../operations/DisableMFAResponseBody.java | 28 +- .../backend_api/models/operations/File.java | 17 +- .../GenerateSvixAuthURLRequestBuilder.java | 12 - .../GenerateSvixAuthURLResponse.java | 44 +- .../operations/GetClientListRequest.java | 51 +- .../GetClientListRequestBuilder.java | 27 +- .../operations/GetClientListResponse.java | 47 +- .../models/operations/GetClientRequest.java | 15 +- .../operations/GetClientRequestBuilder.java | 14 +- .../models/operations/GetClientResponse.java | 44 +- .../operations/GetEmailAddressRequest.java | 15 +- .../GetEmailAddressRequestBuilder.java | 14 +- .../operations/GetEmailAddressResponse.java | 44 +- .../operations/GetJWKSRequestBuilder.java | 12 - .../models/operations/GetJWKSResponse.java | 22 +- .../operations/GetJWTTemplateRequest.java | 15 +- .../GetJWTTemplateRequestBuilder.java | 14 +- .../operations/GetJWTTemplateResponse.java | 44 +- .../GetOAuthAccessTokenPublicMetadata.java | 14 +- .../GetOAuthAccessTokenRequest.java | 17 +- .../GetOAuthAccessTokenRequestBuilder.java | 16 +- .../GetOAuthAccessTokenResponse.java | 44 +- .../GetOAuthApplicationRequest.java | 15 +- .../GetOAuthApplicationRequestBuilder.java | 14 +- .../GetOAuthApplicationResponse.java | 44 +- .../GetOrganizationInvitationRequest.java | 17 +- ...tOrganizationInvitationRequestBuilder.java | 16 +- .../GetOrganizationInvitationResponse.java | 44 +- .../operations/GetOrganizationRequest.java | 15 +- .../GetOrganizationRequestBuilder.java | 14 +- .../operations/GetOrganizationResponse.java | 44 +- .../operations/GetPhoneNumberRequest.java | 15 +- .../GetPhoneNumberRequestBuilder.java | 14 +- .../operations/GetPhoneNumberResponse.java | 44 +- .../GetPublicInterstitialRequest.java | 43 +- .../GetPublicInterstitialRequestBuilder.java | 23 +- .../GetPublicInterstitialResponse.java | 22 +- .../operations/GetRedirectURLRequest.java | 15 +- .../GetRedirectURLRequestBuilder.java | 14 +- .../operations/GetRedirectURLResponse.java | 44 +- .../operations/GetSAMLConnectionRequest.java | 15 +- .../GetSAMLConnectionRequestBuilder.java | 14 +- .../operations/GetSAMLConnectionResponse.java | 44 +- .../operations/GetSessionListRequest.java | 84 +- .../GetSessionListRequestBuilder.java | 13 +- .../operations/GetSessionListResponse.java | 45 +- .../models/operations/GetSessionRequest.java | 15 +- .../operations/GetSessionRequestBuilder.java | 14 +- .../models/operations/GetSessionResponse.java | 44 +- .../operations/GetTemplateListRequest.java | 15 +- .../GetTemplateListRequestBuilder.java | 13 +- .../operations/GetTemplateListResponse.java | 45 +- .../models/operations/GetTemplateRequest.java | 17 +- .../operations/GetTemplateRequestBuilder.java | 16 +- .../operations/GetTemplateResponse.java | 44 +- .../models/operations/GetUserListRequest.java | 242 ++-- .../operations/GetUserListRequestBuilder.java | 13 +- .../operations/GetUserListResponse.java | 45 +- .../models/operations/GetUserRequest.java | 15 +- .../operations/GetUserRequestBuilder.java | 14 +- .../models/operations/GetUserResponse.java | 44 +- .../operations/GetUsersCountRequest.java | 150 +-- .../GetUsersCountRequestBuilder.java | 13 +- .../operations/GetUsersCountResponse.java | 44 +- ...istAllowlistIdentifiersRequestBuilder.java | 12 - .../ListAllowlistIdentifiersResponse.java | 45 +- ...istBlocklistIdentifiersRequestBuilder.java | 12 - .../ListBlocklistIdentifiersResponse.java | 44 +- .../operations/ListDomainsRequestBuilder.java | 12 - .../operations/ListDomainsResponse.java | 44 +- .../operations/ListInvitationsRequest.java | 54 +- .../ListInvitationsRequestBuilder.java | 31 +- .../operations/ListInvitationsResponse.java | 47 +- .../ListJWTTemplatesRequestBuilder.java | 12 - .../operations/ListJWTTemplatesResponse.java | 45 +- .../ListOAuthApplicationsRequest.java | 51 +- .../ListOAuthApplicationsRequestBuilder.java | 27 +- .../ListOAuthApplicationsResponse.java | 46 +- ...ganizationInvitationsQueryParamStatus.java | 11 +- .../ListOrganizationInvitationsRequest.java | 56 +- ...OrganizationInvitationsRequestBuilder.java | 34 +- .../ListOrganizationInvitationsResponse.java | 46 +- .../ListOrganizationMembershipsRequest.java | 68 +- ...OrganizationMembershipsRequestBuilder.java | 36 +- .../ListOrganizationMembershipsResponse.java | 46 +- .../operations/ListOrganizationsRequest.java | 101 +- .../ListOrganizationsRequestBuilder.java | 13 +- .../operations/ListOrganizationsResponse.java | 44 +- ...PendingOrganizationInvitationsRequest.java | 53 +- ...OrganizationInvitationsRequestBuilder.java | 30 +- ...endingOrganizationInvitationsResponse.java | 46 +- .../ListRedirectURLsRequestBuilder.java | 12 - .../operations/ListRedirectURLsResponse.java | 45 +- .../ListSAMLConnectionsRequest.java | 51 +- .../ListSAMLConnectionsRequestBuilder.java | 27 +- .../ListSAMLConnectionsResponse.java | 46 +- .../models/operations/LockUserRequest.java | 15 +- .../operations/LockUserRequestBuilder.java | 14 +- .../models/operations/LockUserResponse.java | 44 +- ...geOrganizationMetadataPrivateMetadata.java | 14 +- ...rgeOrganizationMetadataPublicMetadata.java | 14 +- .../MergeOrganizationMetadataRequest.java | 17 +- .../MergeOrganizationMetadataRequestBody.java | 18 +- ...rgeOrganizationMetadataRequestBuilder.java | 16 +- .../MergeOrganizationMetadataResponse.java | 44 +- .../backend_api/models/operations/Object.java | 11 +- .../models/operations/PasswordHasher.java | 11 +- .../operations/PathParamTemplateType.java | 11 +- .../operations/PreviewTemplateRequest.java | 20 +- .../PreviewTemplateRequestBody.java | 73 +- .../PreviewTemplateRequestBuilder.java | 19 +- .../operations/PreviewTemplateResponse.java | 25 +- .../PreviewTemplateResponseBody.java | 14 +- .../models/operations/PrivateMetadata.java | 14 +- .../models/operations/Provider.java | 11 +- .../models/operations/PublicMetadata.java | 14 +- .../models/operations/QueryParamStatus.java | 11 +- .../models/operations/RequestBody.java | 39 +- .../models/operations/ResponseBody.java | 142 +- .../RevertTemplatePathParamTemplateType.java | 11 +- .../operations/RevertTemplateRequest.java | 17 +- .../RevertTemplateRequestBuilder.java | 16 +- .../operations/RevertTemplateResponse.java | 44 +- .../operations/RevokeActorTokenRequest.java | 15 +- .../RevokeActorTokenRequestBuilder.java | 14 +- .../operations/RevokeActorTokenResponse.java | 44 +- .../operations/RevokeInvitationRequest.java | 15 +- .../RevokeInvitationRequestBuilder.java | 14 +- .../operations/RevokeInvitationResponse.java | 44 +- .../RevokeOrganizationInvitationRequest.java | 19 +- ...vokeOrganizationInvitationRequestBody.java | 15 +- ...eOrganizationInvitationRequestBuilder.java | 18 +- .../RevokeOrganizationInvitationResponse.java | 44 +- .../operations/RevokeSessionRequest.java | 15 +- .../RevokeSessionRequestBuilder.java | 14 +- .../operations/RevokeSessionResponse.java | 44 +- .../operations/RevokeSignInTokenRequest.java | 15 +- .../RevokeSignInTokenRequestBuilder.java | 14 +- .../operations/RevokeSignInTokenResponse.java | 44 +- .../RotateOAuthApplicationSecretRequest.java | 15 +- ...eOAuthApplicationSecretRequestBuilder.java | 14 +- .../RotateOAuthApplicationSecretResponse.java | 44 +- .../operations/SDKMethodInterfaces.java | 165 ++- .../SetUserProfileImageRequest.java | 17 +- .../SetUserProfileImageRequestBody.java | 16 +- .../SetUserProfileImageRequestBuilder.java | 16 +- .../SetUserProfileImageResponse.java | 44 +- .../backend_api/models/operations/Status.java | 11 +- .../models/operations/TemplateType.java | 11 +- ...TemplateDeliveryPathParamTemplateType.java | 11 +- .../ToggleTemplateDeliveryRequest.java | 20 +- .../ToggleTemplateDeliveryRequestBody.java | 29 +- .../ToggleTemplateDeliveryRequestBuilder.java | 19 +- .../ToggleTemplateDeliveryResponse.java | 44 +- .../models/operations/UnbanUserRequest.java | 15 +- .../operations/UnbanUserRequestBuilder.java | 14 +- .../models/operations/UnbanUserResponse.java | 44 +- .../models/operations/UnlockUserRequest.java | 15 +- .../operations/UnlockUserRequestBuilder.java | 14 +- .../models/operations/UnlockUserResponse.java | 44 +- .../models/operations/UnsafeMetadata.java | 14 +- .../operations/UpdateDomainRequest.java | 17 +- .../operations/UpdateDomainRequestBody.java | 43 +- .../UpdateDomainRequestBuilder.java | 16 +- .../operations/UpdateDomainResponse.java | 44 +- .../operations/UpdateEmailAddressRequest.java | 18 +- .../UpdateEmailAddressRequestBody.java | 44 +- .../UpdateEmailAddressRequestBuilder.java | 17 +- .../UpdateEmailAddressResponse.java | 44 +- .../UpdateInstanceAuthConfigRequestBody.java | 107 +- ...pdateInstanceAuthConfigRequestBuilder.java | 14 +- .../UpdateInstanceAuthConfigResponse.java | 44 +- ...stanceOrganizationSettingsRequestBody.java | 127 +- ...nceOrganizationSettingsRequestBuilder.java | 14 +- ...eInstanceOrganizationSettingsResponse.java | 44 +- .../operations/UpdateInstanceRequestBody.java | 155 ++- .../UpdateInstanceRequestBuilder.java | 14 +- .../operations/UpdateInstanceResponse.java | 22 +- ...UpdateInstanceRestrictionsRequestBody.java | 89 +- ...ateInstanceRestrictionsRequestBuilder.java | 14 +- .../UpdateInstanceRestrictionsResponse.java | 44 +- .../operations/UpdateJWTTemplateClaims.java | 14 +- .../operations/UpdateJWTTemplateRequest.java | 18 +- .../UpdateJWTTemplateRequestBody.java | 108 +- .../UpdateJWTTemplateRequestBuilder.java | 17 +- .../operations/UpdateJWTTemplateResponse.java | 44 +- .../UpdateOAuthApplicationRequest.java | 17 +- .../UpdateOAuthApplicationRequestBody.java | 61 +- .../UpdateOAuthApplicationRequestBuilder.java | 16 +- .../UpdateOAuthApplicationResponse.java | 44 +- ...tionMembershipMetadataPrivateMetadata.java | 14 +- ...ationMembershipMetadataPublicMetadata.java | 14 +- ...OrganizationMembershipMetadataRequest.java | 19 +- ...nizationMembershipMetadataRequestBody.java | 18 +- ...ationMembershipMetadataRequestBuilder.java | 18 +- ...rganizationMembershipMetadataResponse.java | 44 +- .../UpdateOrganizationMembershipRequest.java | 19 +- ...dateOrganizationMembershipRequestBody.java | 15 +- ...eOrganizationMembershipRequestBuilder.java | 18 +- .../UpdateOrganizationMembershipResponse.java | 44 +- .../UpdateOrganizationPrivateMetadata.java | 14 +- .../UpdateOrganizationPublicMetadata.java | 14 +- .../operations/UpdateOrganizationRequest.java | 17 +- .../UpdateOrganizationRequestBody.java | 80 +- .../UpdateOrganizationRequestBuilder.java | 16 +- .../UpdateOrganizationResponse.java | 44 +- .../operations/UpdatePhoneNumberRequest.java | 18 +- .../UpdatePhoneNumberRequestBody.java | 59 +- .../UpdatePhoneNumberRequestBuilder.java | 17 +- .../operations/UpdatePhoneNumberResponse.java | 44 +- ...teProductionInstanceDomainRequestBody.java | 28 +- ...roductionInstanceDomainRequestBuilder.java | 14 +- ...pdateProductionInstanceDomainResponse.java | 22 +- .../UpdateSAMLConnectionAttributeMapping.java | 73 +- .../UpdateSAMLConnectionRequest.java | 17 +- .../UpdateSAMLConnectionRequestBody.java | 182 ++- .../UpdateSAMLConnectionRequestBuilder.java | 16 +- .../UpdateSAMLConnectionResponse.java | 44 +- .../operations/UpdateSignUpRequest.java | 18 +- .../operations/UpdateSignUpRequestBody.java | 44 +- .../UpdateSignUpRequestBuilder.java | 17 +- .../operations/UpdateSignUpResponse.java | 44 +- .../UpdateUserMetadataPrivateMetadata.java | 14 +- .../UpdateUserMetadataPublicMetadata.java | 14 +- .../operations/UpdateUserMetadataRequest.java | 18 +- .../UpdateUserMetadataRequestBody.java | 20 +- .../UpdateUserMetadataRequestBuilder.java | 17 +- .../UpdateUserMetadataResponse.java | 44 +- .../UpdateUserMetadataUnsafeMetadata.java | 14 +- .../operations/UpdateUserPasswordHasher.java | 11 +- .../operations/UpdateUserPrivateMetadata.java | 14 +- .../operations/UpdateUserPublicMetadata.java | 14 +- .../models/operations/UpdateUserRequest.java | 17 +- .../operations/UpdateUserRequestBody.java | 302 ++--- .../operations/UpdateUserRequestBuilder.java | 16 +- .../models/operations/UpdateUserResponse.java | 44 +- .../operations/UpdateUserUnsafeMetadata.java | 14 +- .../UploadOrganizationLogoFile.java | 17 +- .../UploadOrganizationLogoRequest.java | 18 +- .../UploadOrganizationLogoRequestBody.java | 17 +- .../UploadOrganizationLogoRequestBuilder.java | 17 +- .../UploadOrganizationLogoResponse.java | 44 +- .../UpsertTemplatePathParamTemplateType.java | 11 +- .../operations/UpsertTemplateRequest.java | 20 +- .../operations/UpsertTemplateRequestBody.java | 119 +- .../UpsertTemplateRequestBuilder.java | 19 +- .../operations/UpsertTemplateResponse.java | 44 +- ...sersGetOrganizationMembershipsRequest.java | 53 +- ...OrganizationMembershipsRequestBuilder.java | 30 +- ...ersGetOrganizationMembershipsResponse.java | 46 +- .../operations/VerifyClientRequestBody.java | 28 +- .../VerifyClientRequestBuilder.java | 14 +- .../operations/VerifyClientResponse.java | 44 +- .../VerifyDomainProxyRequestBody.java | 43 +- .../VerifyDomainProxyRequestBuilder.java | 14 +- .../operations/VerifyDomainProxyResponse.java | 44 +- .../operations/VerifyPasswordRequest.java | 18 +- .../operations/VerifyPasswordRequestBody.java | 15 +- .../VerifyPasswordRequestBuilder.java | 17 +- .../operations/VerifyPasswordResponse.java | 25 +- .../VerifyPasswordResponseBody.java | 29 +- .../operations/VerifySessionRequest.java | 18 +- .../operations/VerifySessionRequestBody.java | 28 +- .../VerifySessionRequestBuilder.java | 17 +- .../operations/VerifySessionResponse.java | 44 +- .../models/operations/VerifyTOTPRequest.java | 18 +- .../operations/VerifyTOTPRequestBody.java | 15 +- .../operations/VerifyTOTPRequestBuilder.java | 17 +- .../models/operations/VerifyTOTPResponse.java | 25 +- .../operations/VerifyTOTPResponseBody.java | 32 +- .../com/clerk/backend_api/utils/Options.java | 2 - .../backend_api/utils/QueryParameters.java | 3 - .../clerk/backend_api/utils/RequestBody.java | 1 - .../com/clerk/backend_api/utils/Retries.java | 3 - .../clerk/backend_api/utils/RetryConfig.java | 2 - .../com/clerk/backend_api/utils/Security.java | 3 - .../com/clerk/backend_api/utils/Utils.java | 4 + 874 files changed, 15592 insertions(+), 15770 deletions(-) diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index 8695fb8..83eb5c2 100755 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,23 +1,23 @@ lockVersion: 2.0.0 id: 1d22a5a4-8bac-42e3-b164-121fcacf66c9 management: - docChecksum: 8a8b44e8346bd0bbfc9f9cf4d44c5332 + docChecksum: f6e25376d224dc39635a7f5eed081de2 docVersion: v1 - speakeasyVersion: 1.355.0 - generationVersion: 2.387.0 - releaseVersion: 0.2.0-beta.2 - configChecksum: 57f8a85077c5d6ca82c3da201d722346 + speakeasyVersion: 1.363.1 + generationVersion: 2.396.0 + releaseVersion: 0.3.0-beta.2 + configChecksum: 80434d26185e1d667e08dee8aa5c755a repoURL: https://github.com/clerk/clerk-sdk-java.git published: true features: java: additionalDependencies: 0.1.0 constsAndDefaults: 0.1.1 - core: 3.27.0 + core: 3.28.1 deprecations: 2.81.1 examples: 2.81.3 flattening: 2.81.1 - globalSecurity: 2.82.6 + globalSecurity: 2.82.7 globalSecurityCallbacks: 0.1.0 globalSecurityFlattening: 0.1.0 globalServerURLs: 2.82.1 @@ -26,7 +26,7 @@ features: nullables: 0.1.0 pagination: 0.2.2 sdkHooks: 0.1.0 - unions: 0.0.4 + unions: 0.0.5 generatedFiles: - src/main/java/com/clerk/backend_api/SecuritySource.java - src/main/java/com/clerk/backend_api/SDKConfiguration.java diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 77d42e9..1200bf3 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,9 +1,9 @@ -speakeasyVersion: 1.355.0 +speakeasyVersion: 1.363.1 sources: clerk-java-sdk: sourceNamespace: clerk-java-sdk - sourceRevisionDigest: sha256:7ac60d05f033a6b76be256a2f662720f9fe030f96984c4f42443865b8ba37128 - sourceBlobDigest: sha256:169753eaf7b084082ad40ccdf4b11222d46b71259ed6c7eb809dbeb9089462c9 + sourceRevisionDigest: sha256:a1d17471885280f9bc34dcc58e923357e6497e706b83ee918cdc2078413a95f4 + sourceBlobDigest: sha256:709394a2b429d8bae8f4277a60d93a25c65c9a88cecd5f073ee1b576fd8129f1 tags: - latest - main @@ -11,8 +11,8 @@ targets: clerk-java: source: clerk-java-sdk sourceNamespace: clerk-java-sdk - sourceRevisionDigest: sha256:7ac60d05f033a6b76be256a2f662720f9fe030f96984c4f42443865b8ba37128 - sourceBlobDigest: sha256:169753eaf7b084082ad40ccdf4b11222d46b71259ed6c7eb809dbeb9089462c9 + sourceRevisionDigest: sha256:a1d17471885280f9bc34dcc58e923357e6497e706b83ee918cdc2078413a95f4 + sourceBlobDigest: sha256:709394a2b429d8bae8f4277a60d93a25c65c9a88cecd5f073ee1b576fd8129f1 outLocation: /github/workspace/repo my-first-target: source: clerk-java-sdk diff --git a/README.md b/README.md index 880e4de..e77987a 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ The samples below show how a published SDK artifact is used: Gradle: ```groovy -implementation 'com.clerk:backend-api:0.2.0-beta.2' +implementation 'com.clerk:backend-api:0.3.0-beta.2' ``` Maven: @@ -27,7 +27,7 @@ Maven: com.clerk backend-api - 0.2.0-beta.2 + 0.3.0-beta.2 ``` @@ -55,17 +55,7 @@ gradlew.bat publishToMavenLocal -Pskip.signing package hello.world; import com.clerk.backend_api.Clerk; -import com.clerk.backend_api.models.components.*; -import com.clerk.backend_api.models.operations.*; -import com.clerk.backend_api.utils.EventStream; -import java.math.BigDecimal; -import java.math.BigDecimal; -import java.math.BigInteger; -import java.time.LocalDate; -import java.time.OffsetDateTime; -import java.util.Optional; -import org.openapitools.jackson.nullable.JsonNullable; -import static java.util.Map.entry; +import java.lang.Exception; public class Application { @@ -103,17 +93,11 @@ This example shows how to create an actor token that can be used to impersonate package hello.world; import com.clerk.backend_api.Clerk; -import com.clerk.backend_api.models.components.*; -import com.clerk.backend_api.models.operations.*; -import com.clerk.backend_api.utils.EventStream; -import java.math.BigDecimal; -import java.math.BigDecimal; -import java.math.BigInteger; -import java.time.LocalDate; -import java.time.OffsetDateTime; -import java.util.Optional; -import org.openapitools.jackson.nullable.JsonNullable; -import static java.util.Map.entry; +import com.clerk.backend_api.models.errors.SDKError; +import com.clerk.backend_api.models.operations.CreateActorTokenRequestBody; +import com.clerk.backend_api.models.operations.CreateActorTokenResponse; +import java.lang.Exception; +import java.util.Map; public class Application { @@ -125,8 +109,8 @@ public class Application { CreateActorTokenRequestBody req = CreateActorTokenRequestBody.builder() .userId("") - .actor(java.util.Map.ofEntries( - entry("sub", "user_2OEpKhcCN1Lat9NQ0G6puh7q5Rb"))) + .actor(Map.ofEntries( + Map.entry("sub", "user_2OEpKhcCN1Lat9NQ0G6puh7q5Rb"))) .build(); CreateActorTokenResponse res = sdk.actors().createToken() @@ -139,7 +123,7 @@ public class Application { } catch (com.clerk.backend_api.models.errors.ClerkErrors e) { // handle exception throw e; - } catch (com.clerk.backend_api.models.errors.SDKError e) { + } catch (SDKError e) { // handle exception throw e; } catch (Exception e) { @@ -356,17 +340,7 @@ Here's an example of one such pagination call: package hello.world; import com.clerk.backend_api.Clerk; -import com.clerk.backend_api.models.components.*; -import com.clerk.backend_api.models.operations.*; -import com.clerk.backend_api.utils.EventStream; -import java.math.BigDecimal; -import java.math.BigDecimal; -import java.math.BigInteger; -import java.time.LocalDate; -import java.time.OffsetDateTime; -import java.util.Optional; -import org.openapitools.jackson.nullable.JsonNullable; -import static java.util.Map.entry; +import java.lang.Exception; public class Application { @@ -413,17 +387,7 @@ Handling errors in this SDK should largely match your expectations. All operati package hello.world; import com.clerk.backend_api.Clerk; -import com.clerk.backend_api.models.components.*; -import com.clerk.backend_api.models.operations.*; -import com.clerk.backend_api.utils.EventStream; -import java.math.BigDecimal; -import java.math.BigDecimal; -import java.math.BigInteger; -import java.time.LocalDate; -import java.time.OffsetDateTime; -import java.util.Optional; -import org.openapitools.jackson.nullable.JsonNullable; -import static java.util.Map.entry; +import java.lang.Exception; public class Application { @@ -471,17 +435,9 @@ You can override the default server globally by passing a server index to the `s package hello.world; import com.clerk.backend_api.Clerk; -import com.clerk.backend_api.models.components.*; -import com.clerk.backend_api.models.operations.*; -import com.clerk.backend_api.utils.EventStream; -import java.math.BigDecimal; -import java.math.BigDecimal; -import java.math.BigInteger; -import java.time.LocalDate; -import java.time.OffsetDateTime; -import java.util.Optional; -import org.openapitools.jackson.nullable.JsonNullable; -import static java.util.Map.entry; +import com.clerk.backend_api.models.errors.SDKError; +import com.clerk.backend_api.models.operations.GetPublicInterstitialResponse; +import java.lang.Exception; public class Application { @@ -497,7 +453,7 @@ public class Application { .call(); // handle response - } catch (com.clerk.backend_api.models.errors.SDKError e) { + } catch (SDKError e) { // handle exception throw e; } catch (Exception e) { @@ -517,17 +473,9 @@ The default server can also be overridden globally by passing a URL to the `serv package hello.world; import com.clerk.backend_api.Clerk; -import com.clerk.backend_api.models.components.*; -import com.clerk.backend_api.models.operations.*; -import com.clerk.backend_api.utils.EventStream; -import java.math.BigDecimal; -import java.math.BigDecimal; -import java.math.BigInteger; -import java.time.LocalDate; -import java.time.OffsetDateTime; -import java.util.Optional; -import org.openapitools.jackson.nullable.JsonNullable; -import static java.util.Map.entry; +import com.clerk.backend_api.models.errors.SDKError; +import com.clerk.backend_api.models.operations.GetPublicInterstitialResponse; +import java.lang.Exception; public class Application { @@ -543,7 +491,7 @@ public class Application { .call(); // handle response - } catch (com.clerk.backend_api.models.errors.SDKError e) { + } catch (SDKError e) { // handle exception throw e; } catch (Exception e) { @@ -572,17 +520,9 @@ To authenticate with the API the `bearerAuth` parameter must be set when initial package hello.world; import com.clerk.backend_api.Clerk; -import com.clerk.backend_api.models.components.*; -import com.clerk.backend_api.models.operations.*; -import com.clerk.backend_api.utils.EventStream; -import java.math.BigDecimal; -import java.math.BigDecimal; -import java.math.BigInteger; -import java.time.LocalDate; -import java.time.OffsetDateTime; -import java.util.Optional; -import org.openapitools.jackson.nullable.JsonNullable; -import static java.util.Map.entry; +import com.clerk.backend_api.models.errors.SDKError; +import com.clerk.backend_api.models.operations.GetPublicInterstitialResponse; +import java.lang.Exception; public class Application { @@ -598,7 +538,7 @@ public class Application { .call(); // handle response - } catch (com.clerk.backend_api.models.errors.SDKError e) { + } catch (SDKError e) { // handle exception throw e; } catch (Exception e) { diff --git a/RELEASES.md b/RELEASES.md index 013873b..55566e4 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -108,4 +108,14 @@ Based on: ### Generated - [java v0.2.0-beta.2] . ### Releases -- [Maven Central v0.2.0-beta.2] https://central.sonatype.com/artifact/com.clerk/backend-api/0.2.0-beta.2 - . \ No newline at end of file +- [Maven Central v0.2.0-beta.2] https://central.sonatype.com/artifact/com.clerk/backend-api/0.2.0-beta.2 - . + +## 2024-08-13 15:19:32 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.363.1 (2.396.0) https://github.com/speakeasy-api/speakeasy +### Generated +- [java v0.3.0-beta.2] . +### Releases +- [Maven Central v0.3.0-beta.2] https://central.sonatype.com/artifact/com.clerk/backend-api/0.3.0-beta.2 - . \ No newline at end of file diff --git a/USAGE.md b/USAGE.md index 6a0e69c..ac5863c 100644 --- a/USAGE.md +++ b/USAGE.md @@ -3,17 +3,7 @@ package hello.world; import com.clerk.backend_api.Clerk; -import com.clerk.backend_api.models.components.*; -import com.clerk.backend_api.models.operations.*; -import com.clerk.backend_api.utils.EventStream; -import java.math.BigDecimal; -import java.math.BigDecimal; -import java.math.BigInteger; -import java.time.LocalDate; -import java.time.OffsetDateTime; -import java.util.Optional; -import org.openapitools.jackson.nullable.JsonNullable; -import static java.util.Map.entry; +import java.lang.Exception; public class Application { @@ -51,17 +41,11 @@ This example shows how to create an actor token that can be used to impersonate package hello.world; import com.clerk.backend_api.Clerk; -import com.clerk.backend_api.models.components.*; -import com.clerk.backend_api.models.operations.*; -import com.clerk.backend_api.utils.EventStream; -import java.math.BigDecimal; -import java.math.BigDecimal; -import java.math.BigInteger; -import java.time.LocalDate; -import java.time.OffsetDateTime; -import java.util.Optional; -import org.openapitools.jackson.nullable.JsonNullable; -import static java.util.Map.entry; +import com.clerk.backend_api.models.errors.SDKError; +import com.clerk.backend_api.models.operations.CreateActorTokenRequestBody; +import com.clerk.backend_api.models.operations.CreateActorTokenResponse; +import java.lang.Exception; +import java.util.Map; public class Application { @@ -73,8 +57,8 @@ public class Application { CreateActorTokenRequestBody req = CreateActorTokenRequestBody.builder() .userId("") - .actor(java.util.Map.ofEntries( - entry("sub", "user_2OEpKhcCN1Lat9NQ0G6puh7q5Rb"))) + .actor(Map.ofEntries( + Map.entry("sub", "user_2OEpKhcCN1Lat9NQ0G6puh7q5Rb"))) .build(); CreateActorTokenResponse res = sdk.actors().createToken() @@ -87,7 +71,7 @@ public class Application { } catch (com.clerk.backend_api.models.errors.ClerkErrors e) { // handle exception throw e; - } catch (com.clerk.backend_api.models.errors.SDKError e) { + } catch (SDKError e) { // handle exception throw e; } catch (Exception e) { diff --git a/build.gradle b/build.gradle index 42ec431..330898a 100644 --- a/build.gradle +++ b/build.gradle @@ -62,7 +62,7 @@ tasks.withType(Javadoc) { options.addStringOption('Xdoclint:none', '-quiet') } group = "com.clerk" -version = "0.2.0-beta.2" +version = "0.3.0-beta.2" sourcesJar { archiveBaseName = "backend-api" @@ -99,7 +99,7 @@ publishing { maven(MavenPublication) { groupId = 'com.clerk' artifactId = 'backend-api' - version = '0.2.0-beta.2' + version = '0.3.0-beta.2' from components.java diff --git a/docs/models/components/ActorToken.md b/docs/models/components/ActorToken.md index 9d8c016..6213a1c 100644 --- a/docs/models/components/ActorToken.md +++ b/docs/models/components/ActorToken.md @@ -3,14 +3,14 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | -| `object` | [com.clerk.backend_api.models.components.ActorTokenObject](../../models/components/ActorTokenObject.md) | :heavy_check_mark: | N/A | -| `id` | *String* | :heavy_check_mark: | N/A | -| `status` | [com.clerk.backend_api.models.components.ActorTokenStatus](../../models/components/ActorTokenStatus.md) | :heavy_check_mark: | N/A | -| `userId` | *String* | :heavy_check_mark: | N/A | -| `actor` | [com.clerk.backend_api.models.components.ActorTokenActor](../../models/components/ActorTokenActor.md) | :heavy_check_mark: | N/A | -| `token` | *JsonNullable* | :heavy_minus_sign: | N/A | -| `url` | *JsonNullable* | :heavy_minus_sign: | N/A | -| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.
| -| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.
| \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | +| `object` | [ActorTokenObject](../../models/components/ActorTokenObject.md) | :heavy_check_mark: | N/A | +| `id` | *String* | :heavy_check_mark: | N/A | +| `status` | [ActorTokenStatus](../../models/components/ActorTokenStatus.md) | :heavy_check_mark: | N/A | +| `userId` | *String* | :heavy_check_mark: | N/A | +| `actor` | [ActorTokenActor](../../models/components/ActorTokenActor.md) | :heavy_check_mark: | N/A | +| `token` | *JsonNullable* | :heavy_minus_sign: | N/A | +| `url` | *JsonNullable* | :heavy_minus_sign: | N/A | +| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.
| +| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.
| \ No newline at end of file diff --git a/docs/models/components/Admin.md b/docs/models/components/Admin.md index e1090a4..d60f1f5 100644 --- a/docs/models/components/Admin.md +++ b/docs/models/components/Admin.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `status` | [com.clerk.backend_api.models.components.AdminVerificationStatus](../../models/components/AdminVerificationStatus.md) | :heavy_check_mark: | N/A | -| `strategy` | [com.clerk.backend_api.models.components.VerificationStrategy](../../models/components/VerificationStrategy.md) | :heavy_check_mark: | N/A | -| `attempts` | *JsonNullable* | :heavy_minus_sign: | N/A | -| `expireAt` | *JsonNullable* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | +| `status` | [AdminVerificationStatus](../../models/components/AdminVerificationStatus.md) | :heavy_check_mark: | N/A | +| `strategy` | [VerificationStrategy](../../models/components/VerificationStrategy.md) | :heavy_check_mark: | N/A | +| `attempts` | *JsonNullable* | :heavy_minus_sign: | N/A | +| `expireAt` | *JsonNullable* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/AllowlistIdentifier.md b/docs/models/components/AllowlistIdentifier.md index a0ffefd..2be845e 100644 --- a/docs/models/components/AllowlistIdentifier.md +++ b/docs/models/components/AllowlistIdentifier.md @@ -3,13 +3,13 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `object` | [Optional](../../models/components/AllowlistIdentifierObject.md) | :heavy_minus_sign: | String representing the object's type. Objects of the same type share the same value.
| -| `id` | *Optional* | :heavy_minus_sign: | N/A | -| `invitationId` | *Optional* | :heavy_minus_sign: | N/A | -| `identifier` | *Optional* | :heavy_minus_sign: | An email address or a phone number.
| -| `identifierType` | [Optional](../../models/components/IdentifierType.md) | :heavy_minus_sign: | N/A | -| `instanceId` | *Optional* | :heavy_minus_sign: | N/A | -| `createdAt` | *Optional* | :heavy_minus_sign: | Unix timestamp of creation
| -| `updatedAt` | *Optional* | :heavy_minus_sign: | Unix timestamp of last update.
| \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | +| `object` | [Optional](../../models/components/AllowlistIdentifierObject.md) | :heavy_minus_sign: | String representing the object's type. Objects of the same type share the same value.
| +| `id` | *Optional* | :heavy_minus_sign: | N/A | +| `invitationId` | *Optional* | :heavy_minus_sign: | N/A | +| `identifier` | *Optional* | :heavy_minus_sign: | An email address or a phone number.
| +| `identifierType` | [Optional](../../models/components/IdentifierType.md) | :heavy_minus_sign: | N/A | +| `instanceId` | *Optional* | :heavy_minus_sign: | N/A | +| `createdAt` | *Optional* | :heavy_minus_sign: | Unix timestamp of creation
| +| `updatedAt` | *Optional* | :heavy_minus_sign: | Unix timestamp of last update.
| \ No newline at end of file diff --git a/docs/models/components/AttributeMapping.md b/docs/models/components/AttributeMapping.md index 3ff71d3..de4f9d5 100644 --- a/docs/models/components/AttributeMapping.md +++ b/docs/models/components/AttributeMapping.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | -| `userId` | *Optional* | :heavy_minus_sign: | N/A | -| `emailAddress` | *Optional* | :heavy_minus_sign: | N/A | -| `firstName` | *Optional* | :heavy_minus_sign: | N/A | -| `lastName` | *Optional* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `userId` | *Optional* | :heavy_minus_sign: | N/A | +| `emailAddress` | *Optional* | :heavy_minus_sign: | N/A | +| `firstName` | *Optional* | :heavy_minus_sign: | N/A | +| `lastName` | *Optional* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/BlocklistIdentifier.md b/docs/models/components/BlocklistIdentifier.md index c71f4c0..0cb7744 100644 --- a/docs/models/components/BlocklistIdentifier.md +++ b/docs/models/components/BlocklistIdentifier.md @@ -3,12 +3,12 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `object` | [Optional](../../models/components/BlocklistIdentifierObject.md) | :heavy_minus_sign: | String representing the object's type. Objects of the same type share the same value.
| -| `id` | *Optional* | :heavy_minus_sign: | N/A | -| `identifier` | *Optional* | :heavy_minus_sign: | An email address, email domain, phone number or web3 wallet.
| -| `identifierType` | [Optional](../../models/components/BlocklistIdentifierIdentifierType.md) | :heavy_minus_sign: | N/A | -| `instanceId` | *Optional* | :heavy_minus_sign: | N/A | -| `createdAt` | *Optional* | :heavy_minus_sign: | Unix timestamp of creation
| -| `updatedAt` | *Optional* | :heavy_minus_sign: | Unix timestamp of last update.
| \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| `object` | [Optional](../../models/components/BlocklistIdentifierObject.md) | :heavy_minus_sign: | String representing the object's type. Objects of the same type share the same value.
| +| `id` | *Optional* | :heavy_minus_sign: | N/A | +| `identifier` | *Optional* | :heavy_minus_sign: | An email address, email domain, phone number or web3 wallet.
| +| `identifierType` | [Optional](../../models/components/BlocklistIdentifierIdentifierType.md) | :heavy_minus_sign: | N/A | +| `instanceId` | *Optional* | :heavy_minus_sign: | N/A | +| `createdAt` | *Optional* | :heavy_minus_sign: | Unix timestamp of creation
| +| `updatedAt` | *Optional* | :heavy_minus_sign: | Unix timestamp of last update.
| \ No newline at end of file diff --git a/docs/models/components/BlocklistIdentifiers.md b/docs/models/components/BlocklistIdentifiers.md index 72a8a51..adcfeae 100644 --- a/docs/models/components/BlocklistIdentifiers.md +++ b/docs/models/components/BlocklistIdentifiers.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | -| `data` | List<[com.clerk.backend_api.models.components.BlocklistIdentifier](../../models/components/BlocklistIdentifier.md)> | :heavy_check_mark: | N/A | -| `totalCount` | *long* | :heavy_check_mark: | Total number of blocklist identifiers
| \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| `data` | List<[BlocklistIdentifier](../../models/components/BlocklistIdentifier.md)> | :heavy_check_mark: | N/A | +| `totalCount` | *long* | :heavy_check_mark: | Total number of blocklist identifiers
| \ No newline at end of file diff --git a/docs/models/components/ClerkError.md b/docs/models/components/ClerkError.md index 00552ed..793ed1a 100644 --- a/docs/models/components/ClerkError.md +++ b/docs/models/components/ClerkError.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `message` | *String* | :heavy_check_mark: | N/A | -| `longMessage` | *String* | :heavy_check_mark: | N/A | -| `code` | *String* | :heavy_check_mark: | N/A | -| `meta` | [Optional](../../models/components/Meta.md) | :heavy_minus_sign: | N/A | -| `clerkTraceId` | *Optional* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | +| `message` | *String* | :heavy_check_mark: | N/A | +| `longMessage` | *String* | :heavy_check_mark: | N/A | +| `code` | *String* | :heavy_check_mark: | N/A | +| `meta` | [Optional](../../models/components/Meta.md) | :heavy_minus_sign: | N/A | +| `clerkTraceId` | *Optional* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/Client.md b/docs/models/components/Client.md index 306c40f..9b9cda7 100644 --- a/docs/models/components/Client.md +++ b/docs/models/components/Client.md @@ -3,14 +3,14 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | -| `object` | [com.clerk.backend_api.models.components.Object](../../models/components/Object.md) | :heavy_check_mark: | String representing the object's type. Objects of the same type share the same value.
| -| `id` | *String* | :heavy_check_mark: | String representing the identifier of the session.
| -| `sessionIds` | List<*String*> | :heavy_check_mark: | N/A | -| `sessions` | List<[com.clerk.backend_api.models.components.Session](../../models/components/Session.md)> | :heavy_check_mark: | N/A | -| `signInId` | *Optional* | :heavy_check_mark: | N/A | -| `signUpId` | *Optional* | :heavy_check_mark: | N/A | -| `lastActiveSessionId` | *Optional* | :heavy_check_mark: | Last active session_id.
| -| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.
| -| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.
| \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `object` | [Object](../../models/components/Object.md) | :heavy_check_mark: | String representing the object's type. Objects of the same type share the same value.
| +| `id` | *String* | :heavy_check_mark: | String representing the identifier of the session.
| +| `sessionIds` | List<*String*> | :heavy_check_mark: | N/A | +| `sessions` | List<[Session](../../models/components/Session.md)> | :heavy_check_mark: | N/A | +| `signInId` | *Optional* | :heavy_check_mark: | N/A | +| `signUpId` | *Optional* | :heavy_check_mark: | N/A | +| `lastActiveSessionId` | *Optional* | :heavy_check_mark: | Last active session_id.
| +| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.
| +| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.
| \ No newline at end of file diff --git a/docs/models/components/DeletedObject.md b/docs/models/components/DeletedObject.md index 4465bfe..8985dcb 100644 --- a/docs/models/components/DeletedObject.md +++ b/docs/models/components/DeletedObject.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | -| `object` | *String* | :heavy_check_mark: | N/A | -| `id` | *Optional* | :heavy_minus_sign: | N/A | -| `slug` | *Optional* | :heavy_minus_sign: | N/A | -| `deleted` | *boolean* | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `object` | *String* | :heavy_check_mark: | N/A | +| `id` | *Optional* | :heavy_minus_sign: | N/A | +| `slug` | *Optional* | :heavy_minus_sign: | N/A | +| `deleted` | *boolean* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/Domain.md b/docs/models/components/Domain.md index 4026ce7..9aa5692 100644 --- a/docs/models/components/Domain.md +++ b/docs/models/components/Domain.md @@ -3,14 +3,14 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `object` | [com.clerk.backend_api.models.components.DomainObject](../../models/components/DomainObject.md) | :heavy_check_mark: | N/A | -| `id` | *String* | :heavy_check_mark: | N/A | -| `name` | *String* | :heavy_check_mark: | N/A | -| `isSatellite` | *boolean* | :heavy_check_mark: | N/A | -| `frontendApiUrl` | *String* | :heavy_check_mark: | N/A | -| `accountsPortalUrl` | *JsonNullable* | :heavy_minus_sign: | Null for satellite domains.
| -| `proxyUrl` | *JsonNullable* | :heavy_minus_sign: | N/A | -| `developmentOrigin` | *String* | :heavy_check_mark: | N/A | -| `cnameTargets` | List<[com.clerk.backend_api.models.components.CNameTarget](../../models/components/CNameTarget.md)> | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | +| `object` | [DomainObject](../../models/components/DomainObject.md) | :heavy_check_mark: | N/A | +| `id` | *String* | :heavy_check_mark: | N/A | +| `name` | *String* | :heavy_check_mark: | N/A | +| `isSatellite` | *boolean* | :heavy_check_mark: | N/A | +| `frontendApiUrl` | *String* | :heavy_check_mark: | N/A | +| `accountsPortalUrl` | *JsonNullable* | :heavy_minus_sign: | Null for satellite domains.
| +| `proxyUrl` | *JsonNullable* | :heavy_minus_sign: | N/A | +| `developmentOrigin` | *String* | :heavy_check_mark: | N/A | +| `cnameTargets` | List<[CNameTarget](../../models/components/CNameTarget.md)> | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/Domains.md b/docs/models/components/Domains.md index a6ff079..712fc28 100644 --- a/docs/models/components/Domains.md +++ b/docs/models/components/Domains.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| `data` | List<[com.clerk.backend_api.models.components.Domain](../../models/components/Domain.md)> | :heavy_check_mark: | N/A | -| `totalCount` | *long* | :heavy_check_mark: | Total number of domains
| \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | +| `data` | List<[Domain](../../models/components/Domain.md)> | :heavy_check_mark: | N/A | +| `totalCount` | *long* | :heavy_check_mark: | Total number of domains
| \ No newline at end of file diff --git a/docs/models/components/EmailAddress.md b/docs/models/components/EmailAddress.md index 851517e..9594578 100644 --- a/docs/models/components/EmailAddress.md +++ b/docs/models/components/EmailAddress.md @@ -3,13 +3,13 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | -| `id` | *Optional* | :heavy_minus_sign: | N/A | -| `object` | [com.clerk.backend_api.models.components.EmailAddressObject](../../models/components/EmailAddressObject.md) | :heavy_check_mark: | String representing the object's type. Objects of the same type share the same value.
| -| `emailAddress` | *String* | :heavy_check_mark: | N/A | -| `reserved` | *boolean* | :heavy_check_mark: | N/A | -| `verification` | [Optional](../../models/components/Verification.md) | :heavy_check_mark: | N/A | -| `linkedTo` | List<[com.clerk.backend_api.models.components.IdentificationLink](../../models/components/IdentificationLink.md)> | :heavy_check_mark: | N/A | -| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation
| -| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of creation
| \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `id` | *Optional* | :heavy_minus_sign: | N/A | +| `object` | [EmailAddressObject](../../models/components/EmailAddressObject.md) | :heavy_check_mark: | String representing the object's type. Objects of the same type share the same value.
| +| `emailAddress` | *String* | :heavy_check_mark: | N/A | +| `reserved` | *boolean* | :heavy_check_mark: | N/A | +| `verification` | [Optional](../../models/components/Verification.md) | :heavy_check_mark: | N/A | +| `linkedTo` | List<[IdentificationLink](../../models/components/IdentificationLink.md)> | :heavy_check_mark: | N/A | +| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation
| +| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of creation
| \ No newline at end of file diff --git a/docs/models/components/ErrorClerkError.md b/docs/models/components/ErrorClerkError.md index 19af3aa..73da77a 100644 --- a/docs/models/components/ErrorClerkError.md +++ b/docs/models/components/ErrorClerkError.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | -| `message` | *String* | :heavy_check_mark: | N/A | -| `longMessage` | *String* | :heavy_check_mark: | N/A | -| `code` | *String* | :heavy_check_mark: | N/A | -| `meta` | [Optional](../../models/components/ErrorMeta.md) | :heavy_minus_sign: | N/A | -| `clerkTraceId` | *Optional* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | +| `message` | *String* | :heavy_check_mark: | N/A | +| `longMessage` | *String* | :heavy_check_mark: | N/A | +| `code` | *String* | :heavy_check_mark: | N/A | +| `meta` | [Optional](../../models/components/ErrorMeta.md) | :heavy_minus_sign: | N/A | +| `clerkTraceId` | *Optional* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/IdentificationLink.md b/docs/models/components/IdentificationLink.md index b19c2cb..5f6b4ef 100644 --- a/docs/models/components/IdentificationLink.md +++ b/docs/models/components/IdentificationLink.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | -| `type` | [com.clerk.backend_api.models.components.Type](../../models/components/Type.md) | :heavy_check_mark: | N/A | -| `id` | *String* | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | +| `type` | [Type](../../models/components/Type.md) | :heavy_check_mark: | N/A | +| `id` | *String* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/InstanceRestrictions.md b/docs/models/components/InstanceRestrictions.md index da67f5a..808fbf0 100644 --- a/docs/models/components/InstanceRestrictions.md +++ b/docs/models/components/InstanceRestrictions.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | -| `object` | [Optional](../../models/components/InstanceRestrictionsObject.md) | :heavy_minus_sign: | String representing the object's type. Objects of the same type share the same value. | -| `allowlist` | *Optional* | :heavy_minus_sign: | N/A | -| `blocklist` | *Optional* | :heavy_minus_sign: | N/A | -| `blockEmailSubaddresses` | *Optional* | :heavy_minus_sign: | N/A | -| `ignoreDotsForGmailAddresses` | *Optional* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `object` | [Optional](../../models/components/InstanceRestrictionsObject.md) | :heavy_minus_sign: | String representing the object's type. Objects of the same type share the same value. | +| `allowlist` | *Optional* | :heavy_minus_sign: | N/A | +| `blocklist` | *Optional* | :heavy_minus_sign: | N/A | +| `blockEmailSubaddresses` | *Optional* | :heavy_minus_sign: | N/A | +| `ignoreDotsForGmailAddresses` | *Optional* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/InstanceSettings.md b/docs/models/components/InstanceSettings.md index 3d457bf..660a8df 100644 --- a/docs/models/components/InstanceSettings.md +++ b/docs/models/components/InstanceSettings.md @@ -3,11 +3,11 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -| `object` | [Optional](../../models/components/InstanceSettingsObject.md) | :heavy_minus_sign: | String representing the object's type. Objects of the same type share the same value. | -| `id` | *Optional* | :heavy_minus_sign: | N/A | -| `restrictedToAllowlist` | *Optional* | :heavy_minus_sign: | N/A | -| `fromEmailAddress` | *Optional* | :heavy_minus_sign: | N/A | -| `progressiveSignUp` | *Optional* | :heavy_minus_sign: | N/A | -| `enhancedEmailDeliverability` | *Optional* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `object` | [Optional](../../models/components/InstanceSettingsObject.md) | :heavy_minus_sign: | String representing the object's type. Objects of the same type share the same value. | +| `id` | *Optional* | :heavy_minus_sign: | N/A | +| `restrictedToAllowlist` | *Optional* | :heavy_minus_sign: | N/A | +| `fromEmailAddress` | *Optional* | :heavy_minus_sign: | N/A | +| `progressiveSignUp` | *Optional* | :heavy_minus_sign: | N/A | +| `enhancedEmailDeliverability` | *Optional* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/Invitation.md b/docs/models/components/Invitation.md index 49cd69c..031e4ff 100644 --- a/docs/models/components/Invitation.md +++ b/docs/models/components/Invitation.md @@ -3,14 +3,14 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -| `object` | [com.clerk.backend_api.models.components.InvitationObject](../../models/components/InvitationObject.md) | :heavy_check_mark: | N/A | | -| `id` | *String* | :heavy_check_mark: | N/A | | -| `emailAddress` | *String* | :heavy_check_mark: | N/A | | -| `publicMetadata` | [Optional](../../models/components/InvitationPublicMetadata.md) | :heavy_minus_sign: | N/A | | -| `revoked` | *Optional* | :heavy_minus_sign: | N/A | false | -| `status` | [com.clerk.backend_api.models.components.InvitationStatus](../../models/components/InvitationStatus.md) | :heavy_check_mark: | N/A | pending | -| `url` | *JsonNullable* | :heavy_minus_sign: | N/A | | -| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.
| | -| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.
| | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | +| `object` | [InvitationObject](../../models/components/InvitationObject.md) | :heavy_check_mark: | N/A | | +| `id` | *String* | :heavy_check_mark: | N/A | | +| `emailAddress` | *String* | :heavy_check_mark: | N/A | | +| `publicMetadata` | [Optional](../../models/components/InvitationPublicMetadata.md) | :heavy_minus_sign: | N/A | | +| `revoked` | *Optional* | :heavy_minus_sign: | N/A | false | +| `status` | [InvitationStatus](../../models/components/InvitationStatus.md) | :heavy_check_mark: | N/A | pending | +| `url` | *JsonNullable* | :heavy_minus_sign: | N/A | | +| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.
| | +| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.
| | \ No newline at end of file diff --git a/docs/models/components/InvitationRevoked.md b/docs/models/components/InvitationRevoked.md index e4b1dae..807dc10 100644 --- a/docs/models/components/InvitationRevoked.md +++ b/docs/models/components/InvitationRevoked.md @@ -3,14 +3,14 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `object` | [com.clerk.backend_api.models.components.InvitationRevokedObject](../../models/components/InvitationRevokedObject.md) | :heavy_check_mark: | N/A | | -| `id` | *String* | :heavy_check_mark: | N/A | | -| `emailAddress` | *String* | :heavy_check_mark: | N/A | | -| `publicMetadata` | [Optional](../../models/components/InvitationRevokedPublicMetadata.md) | :heavy_minus_sign: | N/A | | -| `revoked` | *Optional* | :heavy_minus_sign: | N/A | true | -| `status` | [com.clerk.backend_api.models.components.InvitationRevokedStatus](../../models/components/InvitationRevokedStatus.md) | :heavy_check_mark: | N/A | revoked | -| `url` | *JsonNullable* | :heavy_minus_sign: | N/A | | -| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.
| | -| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.
| | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | +| `object` | [InvitationRevokedObject](../../models/components/InvitationRevokedObject.md) | :heavy_check_mark: | N/A | | +| `id` | *String* | :heavy_check_mark: | N/A | | +| `emailAddress` | *String* | :heavy_check_mark: | N/A | | +| `publicMetadata` | [Optional](../../models/components/InvitationRevokedPublicMetadata.md) | :heavy_minus_sign: | N/A | | +| `revoked` | *Optional* | :heavy_minus_sign: | N/A | true | +| `status` | [InvitationRevokedStatus](../../models/components/InvitationRevokedStatus.md) | :heavy_check_mark: | N/A | revoked | +| `url` | *JsonNullable* | :heavy_minus_sign: | N/A | | +| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.
| | +| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.
| | \ No newline at end of file diff --git a/docs/models/components/JWTTemplate.md b/docs/models/components/JWTTemplate.md index 663321c..0ff3d7b 100644 --- a/docs/models/components/JWTTemplate.md +++ b/docs/models/components/JWTTemplate.md @@ -3,15 +3,15 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| `object` | [com.clerk.backend_api.models.components.JWTTemplateObject](../../models/components/JWTTemplateObject.md) | :heavy_check_mark: | N/A | -| `id` | *String* | :heavy_check_mark: | N/A | -| `name` | *String* | :heavy_check_mark: | N/A | -| `claims` | [com.clerk.backend_api.models.components.Claims](../../models/components/Claims.md) | :heavy_check_mark: | N/A | -| `lifetime` | *long* | :heavy_check_mark: | N/A | -| `allowedClockSkew` | *long* | :heavy_check_mark: | N/A | -| `customSigningKey` | *Optional* | :heavy_minus_sign: | N/A | -| `signingAlgorithm` | *Optional* | :heavy_minus_sign: | N/A | -| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.
| -| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.
| \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | +| `object` | [JWTTemplateObject](../../models/components/JWTTemplateObject.md) | :heavy_check_mark: | N/A | +| `id` | *String* | :heavy_check_mark: | N/A | +| `name` | *String* | :heavy_check_mark: | N/A | +| `claims` | [Claims](../../models/components/Claims.md) | :heavy_check_mark: | N/A | +| `lifetime` | *long* | :heavy_check_mark: | N/A | +| `allowedClockSkew` | *long* | :heavy_check_mark: | N/A | +| `customSigningKey` | *Optional* | :heavy_minus_sign: | N/A | +| `signingAlgorithm` | *Optional* | :heavy_minus_sign: | N/A | +| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.
| +| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.
| \ No newline at end of file diff --git a/docs/models/components/OAuthApplication.md b/docs/models/components/OAuthApplication.md index a6cc9b8..44962e4 100644 --- a/docs/models/components/OAuthApplication.md +++ b/docs/models/components/OAuthApplication.md @@ -3,18 +3,18 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | -| `object` | [com.clerk.backend_api.models.components.OAuthApplicationObject](../../models/components/OAuthApplicationObject.md) | :heavy_check_mark: | N/A | -| `id` | *String* | :heavy_check_mark: | N/A | -| `instanceId` | *String* | :heavy_check_mark: | N/A | -| `name` | *String* | :heavy_check_mark: | N/A | -| `clientId` | *String* | :heavy_check_mark: | N/A | -| `public_` | *boolean* | :heavy_check_mark: | N/A | -| `scopes` | *String* | :heavy_check_mark: | N/A | -| `callbackUrl` | *String* | :heavy_check_mark: | N/A | -| `authorizeUrl` | *String* | :heavy_check_mark: | N/A | -| `tokenFetchUrl` | *String* | :heavy_check_mark: | N/A | -| `userInfoUrl` | *String* | :heavy_check_mark: | N/A | -| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.
| -| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.
| \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | +| `object` | [OAuthApplicationObject](../../models/components/OAuthApplicationObject.md) | :heavy_check_mark: | N/A | +| `id` | *String* | :heavy_check_mark: | N/A | +| `instanceId` | *String* | :heavy_check_mark: | N/A | +| `name` | *String* | :heavy_check_mark: | N/A | +| `clientId` | *String* | :heavy_check_mark: | N/A | +| `public_` | *boolean* | :heavy_check_mark: | N/A | +| `scopes` | *String* | :heavy_check_mark: | N/A | +| `callbackUrl` | *String* | :heavy_check_mark: | N/A | +| `authorizeUrl` | *String* | :heavy_check_mark: | N/A | +| `tokenFetchUrl` | *String* | :heavy_check_mark: | N/A | +| `userInfoUrl` | *String* | :heavy_check_mark: | N/A | +| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.
| +| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.
| \ No newline at end of file diff --git a/docs/models/components/OAuthApplicationWithSecret.md b/docs/models/components/OAuthApplicationWithSecret.md index 7ed81ee..3e63c05 100644 --- a/docs/models/components/OAuthApplicationWithSecret.md +++ b/docs/models/components/OAuthApplicationWithSecret.md @@ -3,19 +3,19 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -| `object` | [com.clerk.backend_api.models.components.OAuthApplicationWithSecretObject](../../models/components/OAuthApplicationWithSecretObject.md) | :heavy_check_mark: | N/A | -| `id` | *String* | :heavy_check_mark: | N/A | -| `instanceId` | *String* | :heavy_check_mark: | N/A | -| `name` | *String* | :heavy_check_mark: | N/A | -| `clientId` | *String* | :heavy_check_mark: | N/A | -| `public_` | *boolean* | :heavy_check_mark: | N/A | -| `scopes` | *String* | :heavy_check_mark: | N/A | -| `callbackUrl` | *String* | :heavy_check_mark: | N/A | -| `authorizeUrl` | *String* | :heavy_check_mark: | N/A | -| `tokenFetchUrl` | *String* | :heavy_check_mark: | N/A | -| `userInfoUrl` | *String* | :heavy_check_mark: | N/A | -| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.
| -| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.
| -| `clientSecret` | *Optional* | :heavy_minus_sign: | Empty if public client.
| \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `object` | [OAuthApplicationWithSecretObject](../../models/components/OAuthApplicationWithSecretObject.md) | :heavy_check_mark: | N/A | +| `id` | *String* | :heavy_check_mark: | N/A | +| `instanceId` | *String* | :heavy_check_mark: | N/A | +| `name` | *String* | :heavy_check_mark: | N/A | +| `clientId` | *String* | :heavy_check_mark: | N/A | +| `public_` | *boolean* | :heavy_check_mark: | N/A | +| `scopes` | *String* | :heavy_check_mark: | N/A | +| `callbackUrl` | *String* | :heavy_check_mark: | N/A | +| `authorizeUrl` | *String* | :heavy_check_mark: | N/A | +| `tokenFetchUrl` | *String* | :heavy_check_mark: | N/A | +| `userInfoUrl` | *String* | :heavy_check_mark: | N/A | +| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.
| +| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.
| +| `clientSecret` | *Optional* | :heavy_minus_sign: | Empty if public client.
| \ No newline at end of file diff --git a/docs/models/components/OAuthApplications.md b/docs/models/components/OAuthApplications.md index 9f6647c..35f03ef 100644 --- a/docs/models/components/OAuthApplications.md +++ b/docs/models/components/OAuthApplications.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | -| `data` | List<[com.clerk.backend_api.models.components.OAuthApplication](../../models/components/OAuthApplication.md)> | :heavy_check_mark: | N/A | -| `totalCount` | *long* | :heavy_check_mark: | Total number of OAuth applications
| \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | +| `data` | List<[OAuthApplication](../../models/components/OAuthApplication.md)> | :heavy_check_mark: | N/A | +| `totalCount` | *long* | :heavy_check_mark: | Total number of OAuth applications
| \ No newline at end of file diff --git a/docs/models/components/Oauth.md b/docs/models/components/Oauth.md index 84f2480..2f32a84 100644 --- a/docs/models/components/Oauth.md +++ b/docs/models/components/Oauth.md @@ -3,11 +3,11 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | -| `status` | [com.clerk.backend_api.models.components.OauthVerificationStatus](../../models/components/OauthVerificationStatus.md) | :heavy_check_mark: | N/A | -| `strategy` | [com.clerk.backend_api.models.components.OauthVerificationStrategy](../../models/components/OauthVerificationStrategy.md) | :heavy_check_mark: | N/A | -| `externalVerificationRedirectUrl` | *Optional* | :heavy_minus_sign: | N/A | -| `error` | [JsonNullable](../../models/components/Error.md) | :heavy_minus_sign: | N/A | -| `expireAt` | *long* | :heavy_check_mark: | N/A | -| `attempts` | *JsonNullable* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | +| `status` | [OauthVerificationStatus](../../models/components/OauthVerificationStatus.md) | :heavy_check_mark: | N/A | +| `strategy` | [OauthVerificationStrategy](../../models/components/OauthVerificationStrategy.md) | :heavy_check_mark: | N/A | +| `externalVerificationRedirectUrl` | *Optional* | :heavy_minus_sign: | N/A | +| `error` | [JsonNullable](../../models/components/Error.md) | :heavy_minus_sign: | N/A | +| `expireAt` | *long* | :heavy_check_mark: | N/A | +| `attempts` | *JsonNullable* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/Organization.md b/docs/models/components/Organization.md index 149093d..da5f751 100644 --- a/docs/models/components/Organization.md +++ b/docs/models/components/Organization.md @@ -3,17 +3,17 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `object` | [com.clerk.backend_api.models.components.OrganizationObject](../../models/components/OrganizationObject.md) | :heavy_check_mark: | N/A | -| `id` | *String* | :heavy_check_mark: | N/A | -| `name` | *String* | :heavy_check_mark: | N/A | -| `slug` | *String* | :heavy_check_mark: | N/A | -| `membersCount` | *JsonNullable* | :heavy_minus_sign: | N/A | -| `maxAllowedMemberships` | *long* | :heavy_check_mark: | N/A | -| `adminDeleteEnabled` | *Optional* | :heavy_minus_sign: | N/A | -| `publicMetadata` | [com.clerk.backend_api.models.components.OrganizationPublicMetadata](../../models/components/OrganizationPublicMetadata.md) | :heavy_check_mark: | N/A | -| `privateMetadata` | [com.clerk.backend_api.models.components.OrganizationPrivateMetadata](../../models/components/OrganizationPrivateMetadata.md) | :heavy_check_mark: | N/A | -| `createdBy` | *Optional* | :heavy_minus_sign: | N/A | -| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.
| -| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.
| \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `object` | [OrganizationObject](../../models/components/OrganizationObject.md) | :heavy_check_mark: | N/A | +| `id` | *String* | :heavy_check_mark: | N/A | +| `name` | *String* | :heavy_check_mark: | N/A | +| `slug` | *String* | :heavy_check_mark: | N/A | +| `membersCount` | *JsonNullable* | :heavy_minus_sign: | N/A | +| `maxAllowedMemberships` | *long* | :heavy_check_mark: | N/A | +| `adminDeleteEnabled` | *Optional* | :heavy_minus_sign: | N/A | +| `publicMetadata` | [OrganizationPublicMetadata](../../models/components/OrganizationPublicMetadata.md) | :heavy_check_mark: | N/A | +| `privateMetadata` | [OrganizationPrivateMetadata](../../models/components/OrganizationPrivateMetadata.md) | :heavy_check_mark: | N/A | +| `createdBy` | *Optional* | :heavy_minus_sign: | N/A | +| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.
| +| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.
| \ No newline at end of file diff --git a/docs/models/components/OrganizationInvitation.md b/docs/models/components/OrganizationInvitation.md index 2711ddd..fdcb823 100644 --- a/docs/models/components/OrganizationInvitation.md +++ b/docs/models/components/OrganizationInvitation.md @@ -5,15 +5,15 @@ An organization invitation ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *Optional* | :heavy_minus_sign: | N/A | -| `object` | [Optional](../../models/components/OrganizationInvitationObject.md) | :heavy_minus_sign: | String representing the object's type. Objects of the same type share the same value.
| -| `emailAddress` | *Optional* | :heavy_minus_sign: | N/A | -| `role` | *Optional* | :heavy_minus_sign: | N/A | -| `organizationId` | *Optional* | :heavy_minus_sign: | N/A | -| `status` | *Optional* | :heavy_minus_sign: | N/A | -| `publicMetadata` | [Optional](../../models/components/OrganizationInvitationPublicMetadata.md) | :heavy_minus_sign: | N/A | -| `privateMetadata` | [Optional](../../models/components/OrganizationInvitationPrivateMetadata.md) | :heavy_minus_sign: | N/A | -| `createdAt` | *Optional* | :heavy_minus_sign: | Unix timestamp of creation. | -| `updatedAt` | *Optional* | :heavy_minus_sign: | Unix timestamp of last update. | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | +| `id` | *Optional* | :heavy_minus_sign: | N/A | +| `object` | [Optional](../../models/components/OrganizationInvitationObject.md) | :heavy_minus_sign: | String representing the object's type. Objects of the same type share the same value.
| +| `emailAddress` | *Optional* | :heavy_minus_sign: | N/A | +| `role` | *Optional* | :heavy_minus_sign: | N/A | +| `organizationId` | *Optional* | :heavy_minus_sign: | N/A | +| `status` | *Optional* | :heavy_minus_sign: | N/A | +| `publicMetadata` | [Optional](../../models/components/OrganizationInvitationPublicMetadata.md) | :heavy_minus_sign: | N/A | +| `privateMetadata` | [Optional](../../models/components/OrganizationInvitationPrivateMetadata.md) | :heavy_minus_sign: | N/A | +| `createdAt` | *Optional* | :heavy_minus_sign: | Unix timestamp of creation. | +| `updatedAt` | *Optional* | :heavy_minus_sign: | Unix timestamp of last update. | \ No newline at end of file diff --git a/docs/models/components/OrganizationInvitations.md b/docs/models/components/OrganizationInvitations.md index a04087d..eacc98d 100644 --- a/docs/models/components/OrganizationInvitations.md +++ b/docs/models/components/OrganizationInvitations.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | -| `data` | List<[com.clerk.backend_api.models.components.OrganizationInvitation](../../models/components/OrganizationInvitation.md)> | :heavy_check_mark: | N/A | -| `totalCount` | *long* | :heavy_check_mark: | Total number of organization invitations
| \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | +| `data` | List<[OrganizationInvitation](../../models/components/OrganizationInvitation.md)> | :heavy_check_mark: | N/A | +| `totalCount` | *long* | :heavy_check_mark: | Total number of organization invitations
| \ No newline at end of file diff --git a/docs/models/components/OrganizationMembership.md b/docs/models/components/OrganizationMembership.md index 031561a..d4178da 100644 --- a/docs/models/components/OrganizationMembership.md +++ b/docs/models/components/OrganizationMembership.md @@ -5,15 +5,15 @@ Hello world ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *Optional* | :heavy_minus_sign: | N/A | -| `object` | [Optional](../../models/components/OrganizationMembershipObject.md) | :heavy_minus_sign: | String representing the object's type. Objects of the same type share the same value.
| -| `role` | *Optional* | :heavy_minus_sign: | N/A | -| `permissions` | List<*String*> | :heavy_minus_sign: | N/A | -| `publicMetadata` | [Optional](../../models/components/OrganizationMembershipPublicMetadata.md) | :heavy_minus_sign: | Metadata saved on the organization membership, accessible from both Frontend and Backend APIs | -| `privateMetadata` | [Optional](../../models/components/OrganizationMembershipPrivateMetadata.md) | :heavy_minus_sign: | Metadata saved on the organization membership, accessible only from the Backend API | -| `organization` | [Optional](../../models/components/OrganizationMembershipOrganization.md) | :heavy_minus_sign: | N/A | -| `publicUserData` | [Optional](../../models/components/PublicUserData.md) | :heavy_minus_sign: | N/A | -| `createdAt` | *Optional* | :heavy_minus_sign: | Unix timestamp of creation. | -| `updatedAt` | *Optional* | :heavy_minus_sign: | Unix timestamp of last update. | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | +| `id` | *Optional* | :heavy_minus_sign: | N/A | +| `object` | [Optional](../../models/components/OrganizationMembershipObject.md) | :heavy_minus_sign: | String representing the object's type. Objects of the same type share the same value.
| +| `role` | *Optional* | :heavy_minus_sign: | N/A | +| `permissions` | List<*String*> | :heavy_minus_sign: | N/A | +| `publicMetadata` | [Optional](../../models/components/OrganizationMembershipPublicMetadata.md) | :heavy_minus_sign: | Metadata saved on the organization membership, accessible from both Frontend and Backend APIs | +| `privateMetadata` | [Optional](../../models/components/OrganizationMembershipPrivateMetadata.md) | :heavy_minus_sign: | Metadata saved on the organization membership, accessible only from the Backend API | +| `organization` | [Optional](../../models/components/OrganizationMembershipOrganization.md) | :heavy_minus_sign: | N/A | +| `publicUserData` | [Optional](../../models/components/PublicUserData.md) | :heavy_minus_sign: | N/A | +| `createdAt` | *Optional* | :heavy_minus_sign: | Unix timestamp of creation. | +| `updatedAt` | *Optional* | :heavy_minus_sign: | Unix timestamp of last update. | \ No newline at end of file diff --git a/docs/models/components/OrganizationMembershipOrganization.md b/docs/models/components/OrganizationMembershipOrganization.md index 22acd4c..4bad1ca 100644 --- a/docs/models/components/OrganizationMembershipOrganization.md +++ b/docs/models/components/OrganizationMembershipOrganization.md @@ -3,17 +3,17 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `object` | [com.clerk.backend_api.models.components.OrganizationMembershipOrganizationObject](../../models/components/OrganizationMembershipOrganizationObject.md) | :heavy_check_mark: | N/A | -| `id` | *String* | :heavy_check_mark: | N/A | -| `name` | *String* | :heavy_check_mark: | N/A | -| `slug` | *String* | :heavy_check_mark: | N/A | -| `membersCount` | *JsonNullable* | :heavy_minus_sign: | N/A | -| `maxAllowedMemberships` | *long* | :heavy_check_mark: | N/A | -| `adminDeleteEnabled` | *Optional* | :heavy_minus_sign: | N/A | -| `publicMetadata` | [com.clerk.backend_api.models.components.OrganizationMembershipOrganizationPublicMetadata](../../models/components/OrganizationMembershipOrganizationPublicMetadata.md) | :heavy_check_mark: | N/A | -| `privateMetadata` | [com.clerk.backend_api.models.components.OrganizationMembershipOrganizationPrivateMetadata](../../models/components/OrganizationMembershipOrganizationPrivateMetadata.md) | :heavy_check_mark: | N/A | -| `createdBy` | *Optional* | :heavy_minus_sign: | N/A | -| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.
| -| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.
| \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | +| `object` | [OrganizationMembershipOrganizationObject](../../models/components/OrganizationMembershipOrganizationObject.md) | :heavy_check_mark: | N/A | +| `id` | *String* | :heavy_check_mark: | N/A | +| `name` | *String* | :heavy_check_mark: | N/A | +| `slug` | *String* | :heavy_check_mark: | N/A | +| `membersCount` | *JsonNullable* | :heavy_minus_sign: | N/A | +| `maxAllowedMemberships` | *long* | :heavy_check_mark: | N/A | +| `adminDeleteEnabled` | *Optional* | :heavy_minus_sign: | N/A | +| `publicMetadata` | [OrganizationMembershipOrganizationPublicMetadata](../../models/components/OrganizationMembershipOrganizationPublicMetadata.md) | :heavy_check_mark: | N/A | +| `privateMetadata` | [OrganizationMembershipOrganizationPrivateMetadata](../../models/components/OrganizationMembershipOrganizationPrivateMetadata.md) | :heavy_check_mark: | N/A | +| `createdBy` | *Optional* | :heavy_minus_sign: | N/A | +| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.
| +| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.
| \ No newline at end of file diff --git a/docs/models/components/OrganizationMemberships.md b/docs/models/components/OrganizationMemberships.md index 9cca8c4..8bbc80e 100644 --- a/docs/models/components/OrganizationMemberships.md +++ b/docs/models/components/OrganizationMemberships.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | -| `data` | List<[com.clerk.backend_api.models.components.OrganizationMembership](../../models/components/OrganizationMembership.md)> | :heavy_check_mark: | N/A | -| `totalCount` | *long* | :heavy_check_mark: | Total number of organization memberships
| \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | +| `data` | List<[OrganizationMembership](../../models/components/OrganizationMembership.md)> | :heavy_check_mark: | N/A | +| `totalCount` | *long* | :heavy_check_mark: | Total number of organization memberships
| \ No newline at end of file diff --git a/docs/models/components/OrganizationSettings.md b/docs/models/components/OrganizationSettings.md index 8e1095c..108eac4 100644 --- a/docs/models/components/OrganizationSettings.md +++ b/docs/models/components/OrganizationSettings.md @@ -3,15 +3,15 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | -| `object` | [com.clerk.backend_api.models.components.OrganizationSettingsObject](../../models/components/OrganizationSettingsObject.md) | :heavy_check_mark: | String representing the object's type. Objects of the same type share the same value. | -| `enabled` | *boolean* | :heavy_check_mark: | N/A | -| `maxAllowedMemberships` | *long* | :heavy_check_mark: | N/A | -| `maxAllowedRoles` | *Optional* | :heavy_minus_sign: | N/A | -| `maxAllowedPermissions` | *Optional* | :heavy_minus_sign: | N/A | -| `creatorRole` | *String* | :heavy_check_mark: | The role key that a user will be assigned after creating an organization. | -| `adminDeleteEnabled` | *boolean* | :heavy_check_mark: | The default for whether an admin can delete an organization with the Frontend API. | -| `domainsEnabled` | *boolean* | :heavy_check_mark: | N/A | -| `domainsEnrollmentModes` | List<[com.clerk.backend_api.models.components.DomainsEnrollmentModes](../../models/components/DomainsEnrollmentModes.md)> | :heavy_check_mark: | N/A | -| `domainsDefaultRole` | *String* | :heavy_check_mark: | The role key that it will be used in order to create an organization invitation or suggestion. | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| `object` | [OrganizationSettingsObject](../../models/components/OrganizationSettingsObject.md) | :heavy_check_mark: | String representing the object's type. Objects of the same type share the same value. | +| `enabled` | *boolean* | :heavy_check_mark: | N/A | +| `maxAllowedMemberships` | *long* | :heavy_check_mark: | N/A | +| `maxAllowedRoles` | *Optional* | :heavy_minus_sign: | N/A | +| `maxAllowedPermissions` | *Optional* | :heavy_minus_sign: | N/A | +| `creatorRole` | *String* | :heavy_check_mark: | The role key that a user will be assigned after creating an organization. | +| `adminDeleteEnabled` | *boolean* | :heavy_check_mark: | The default for whether an admin can delete an organization with the Frontend API. | +| `domainsEnabled` | *boolean* | :heavy_check_mark: | N/A | +| `domainsEnrollmentModes` | List<[DomainsEnrollmentModes](../../models/components/DomainsEnrollmentModes.md)> | :heavy_check_mark: | N/A | +| `domainsDefaultRole` | *String* | :heavy_check_mark: | The role key that it will be used in order to create an organization invitation or suggestion. | \ No newline at end of file diff --git a/docs/models/components/OrganizationWithLogo.md b/docs/models/components/OrganizationWithLogo.md index 6764d07..df649a7 100644 --- a/docs/models/components/OrganizationWithLogo.md +++ b/docs/models/components/OrganizationWithLogo.md @@ -3,20 +3,20 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `object` | [com.clerk.backend_api.models.components.OrganizationWithLogoObject](../../models/components/OrganizationWithLogoObject.md) | :heavy_check_mark: | N/A | -| `id` | *String* | :heavy_check_mark: | N/A | -| `name` | *String* | :heavy_check_mark: | N/A | -| `slug` | *String* | :heavy_check_mark: | N/A | -| `membersCount` | *JsonNullable* | :heavy_minus_sign: | N/A | -| `maxAllowedMemberships` | *long* | :heavy_check_mark: | N/A | -| `adminDeleteEnabled` | *Optional* | :heavy_minus_sign: | N/A | -| `publicMetadata` | [com.clerk.backend_api.models.components.OrganizationWithLogoPublicMetadata](../../models/components/OrganizationWithLogoPublicMetadata.md) | :heavy_check_mark: | N/A | -| `privateMetadata` | [com.clerk.backend_api.models.components.OrganizationWithLogoPrivateMetadata](../../models/components/OrganizationWithLogoPrivateMetadata.md) | :heavy_check_mark: | N/A | -| `createdBy` | *Optional* | :heavy_minus_sign: | N/A | -| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.
| -| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.
| -| ~~`logoUrl`~~ | *Optional* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | -| `imageUrl` | *String* | :heavy_check_mark: | N/A | -| `hasImage` | *Optional* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | +| `object` | [OrganizationWithLogoObject](../../models/components/OrganizationWithLogoObject.md) | :heavy_check_mark: | N/A | +| `id` | *String* | :heavy_check_mark: | N/A | +| `name` | *String* | :heavy_check_mark: | N/A | +| `slug` | *String* | :heavy_check_mark: | N/A | +| `membersCount` | *JsonNullable* | :heavy_minus_sign: | N/A | +| `maxAllowedMemberships` | *long* | :heavy_check_mark: | N/A | +| `adminDeleteEnabled` | *Optional* | :heavy_minus_sign: | N/A | +| `publicMetadata` | [OrganizationWithLogoPublicMetadata](../../models/components/OrganizationWithLogoPublicMetadata.md) | :heavy_check_mark: | N/A | +| `privateMetadata` | [OrganizationWithLogoPrivateMetadata](../../models/components/OrganizationWithLogoPrivateMetadata.md) | :heavy_check_mark: | N/A | +| `createdBy` | *Optional* | :heavy_minus_sign: | N/A | +| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.
| +| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.
| +| ~~`logoUrl`~~ | *Optional* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | +| `imageUrl` | *String* | :heavy_check_mark: | N/A | +| `hasImage` | *Optional* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/Organizations.md b/docs/models/components/Organizations.md index 03cac70..0580a72 100644 --- a/docs/models/components/Organizations.md +++ b/docs/models/components/Organizations.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `data` | List<[com.clerk.backend_api.models.components.Organization](../../models/components/Organization.md)> | :heavy_check_mark: | N/A | -| `totalCount` | *long* | :heavy_check_mark: | Total number of organizations
| \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | +| `data` | List<[Organization](../../models/components/Organization.md)> | :heavy_check_mark: | N/A | +| `totalCount` | *long* | :heavy_check_mark: | Total number of organizations
| \ No newline at end of file diff --git a/docs/models/components/Otp.md b/docs/models/components/Otp.md index c92315e..46bdb90 100644 --- a/docs/models/components/Otp.md +++ b/docs/models/components/Otp.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `status` | [com.clerk.backend_api.models.components.VerificationStatus](../../models/components/VerificationStatus.md) | :heavy_check_mark: | N/A | -| `strategy` | [com.clerk.backend_api.models.components.Strategy](../../models/components/Strategy.md) | :heavy_check_mark: | N/A | -| `attempts` | *long* | :heavy_check_mark: | N/A | -| `expireAt` | *long* | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | ------------------------------------------------------------------- | +| `status` | [VerificationStatus](../../models/components/VerificationStatus.md) | :heavy_check_mark: | N/A | +| `strategy` | [Strategy](../../models/components/Strategy.md) | :heavy_check_mark: | N/A | +| `attempts` | *Optional* | :heavy_minus_sign: | N/A | +| `expireAt` | *Optional* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/Passkey.md b/docs/models/components/Passkey.md index 9b2202e..b733561 100644 --- a/docs/models/components/Passkey.md +++ b/docs/models/components/Passkey.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | -| `status` | [com.clerk.backend_api.models.components.PasskeyVerificationStatus](../../models/components/PasskeyVerificationStatus.md) | :heavy_check_mark: | N/A | -| `strategy` | [com.clerk.backend_api.models.components.PasskeyVerificationStrategy](../../models/components/PasskeyVerificationStrategy.md) | :heavy_check_mark: | N/A | -| `nonce` | [Optional](../../models/components/VerificationNonce.md) | :heavy_minus_sign: | N/A | -| `attempts` | *JsonNullable* | :heavy_minus_sign: | N/A | -| `expireAt` | *JsonNullable* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `status` | [PasskeyVerificationStatus](../../models/components/PasskeyVerificationStatus.md) | :heavy_check_mark: | N/A | +| `strategy` | [PasskeyVerificationStrategy](../../models/components/PasskeyVerificationStrategy.md) | :heavy_check_mark: | N/A | +| `nonce` | [Optional](../../models/components/VerificationNonce.md) | :heavy_minus_sign: | N/A | +| `attempts` | *JsonNullable* | :heavy_minus_sign: | N/A | +| `expireAt` | *JsonNullable* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/PhoneNumber.md b/docs/models/components/PhoneNumber.md index b7607c6..42f2bc3 100644 --- a/docs/models/components/PhoneNumber.md +++ b/docs/models/components/PhoneNumber.md @@ -3,16 +3,16 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *Optional* | :heavy_minus_sign: | N/A | -| `object` | [com.clerk.backend_api.models.components.PhoneNumberObject](../../models/components/PhoneNumberObject.md) | :heavy_check_mark: | String representing the object's type. Objects of the same type share the same value.
| -| `phoneNumber` | *String* | :heavy_check_mark: | N/A | -| `reservedForSecondFactor` | *Optional* | :heavy_minus_sign: | N/A | -| `defaultSecondFactor` | *Optional* | :heavy_minus_sign: | N/A | -| `reserved` | *boolean* | :heavy_check_mark: | N/A | -| `verification` | [Optional](../../models/components/PhoneNumberVerification.md) | :heavy_check_mark: | N/A | -| `linkedTo` | List<[com.clerk.backend_api.models.components.IdentificationLink](../../models/components/IdentificationLink.md)> | :heavy_check_mark: | N/A | -| `backupCodes` | List<*String*> | :heavy_minus_sign: | N/A | -| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation
| -| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of creation
| \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | +| `id` | *Optional* | :heavy_minus_sign: | N/A | +| `object` | [PhoneNumberObject](../../models/components/PhoneNumberObject.md) | :heavy_check_mark: | String representing the object's type. Objects of the same type share the same value.
| +| `phoneNumber` | *String* | :heavy_check_mark: | N/A | +| `reservedForSecondFactor` | *Optional* | :heavy_minus_sign: | N/A | +| `defaultSecondFactor` | *Optional* | :heavy_minus_sign: | N/A | +| `reserved` | *boolean* | :heavy_check_mark: | N/A | +| `verification` | [Optional](../../models/components/PhoneNumberVerification.md) | :heavy_check_mark: | N/A | +| `linkedTo` | List<[IdentificationLink](../../models/components/IdentificationLink.md)> | :heavy_check_mark: | N/A | +| `backupCodes` | List<*String*> | :heavy_minus_sign: | N/A | +| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation
| +| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of creation
| \ No newline at end of file diff --git a/docs/models/components/ProxyCheck.md b/docs/models/components/ProxyCheck.md index 2eeea81..852af45 100644 --- a/docs/models/components/ProxyCheck.md +++ b/docs/models/components/ProxyCheck.md @@ -3,13 +3,13 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | -| `object` | [com.clerk.backend_api.models.components.ProxyCheckObject](../../models/components/ProxyCheckObject.md) | :heavy_check_mark: | N/A | -| `id` | *String* | :heavy_check_mark: | N/A | -| `domainId` | *String* | :heavy_check_mark: | N/A | -| `lastRunAt` | *long* | :heavy_check_mark: | N/A | -| `proxyUrl` | *String* | :heavy_check_mark: | N/A | -| `successful` | *boolean* | :heavy_check_mark: | N/A | -| `createdAt` | *long* | :heavy_check_mark: | N/A | -| `updatedAt` | *long* | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- | +| `object` | [ProxyCheckObject](../../models/components/ProxyCheckObject.md) | :heavy_check_mark: | N/A | +| `id` | *String* | :heavy_check_mark: | N/A | +| `domainId` | *String* | :heavy_check_mark: | N/A | +| `lastRunAt` | *long* | :heavy_check_mark: | N/A | +| `proxyUrl` | *String* | :heavy_check_mark: | N/A | +| `successful` | *boolean* | :heavy_check_mark: | N/A | +| `createdAt` | *long* | :heavy_check_mark: | N/A | +| `updatedAt` | *long* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/PublicUserData.md b/docs/models/components/PublicUserData.md index a6bcdea..d51504b 100644 --- a/docs/models/components/PublicUserData.md +++ b/docs/models/components/PublicUserData.md @@ -5,10 +5,10 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| `userId` | *Optional* | :heavy_minus_sign: | N/A | -| `firstName` | *JsonNullable* | :heavy_minus_sign: | N/A | -| `lastName` | *JsonNullable* | :heavy_minus_sign: | N/A | -| ~~`profileImageUrl`~~ | *JsonNullable* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | -| `imageUrl` | *Optional* | :heavy_minus_sign: | N/A | -| `hasImage` | *Optional* | :heavy_minus_sign: | N/A | -| `identifier` | *JsonNullable* | :heavy_minus_sign: | N/A | \ No newline at end of file +| `userId` | *Optional* | :heavy_minus_sign: | N/A | +| `firstName` | *JsonNullable* | :heavy_minus_sign: | N/A | +| `lastName` | *JsonNullable* | :heavy_minus_sign: | N/A | +| ~~`profileImageUrl`~~ | *JsonNullable* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | +| `imageUrl` | *Optional* | :heavy_minus_sign: | N/A | +| `hasImage` | *Optional* | :heavy_minus_sign: | N/A | +| `identifier` | *JsonNullable* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/RedirectURL.md b/docs/models/components/RedirectURL.md index 76b2cfd..4a9782e 100644 --- a/docs/models/components/RedirectURL.md +++ b/docs/models/components/RedirectURL.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| `object` | [com.clerk.backend_api.models.components.RedirectURLObject](../../models/components/RedirectURLObject.md) | :heavy_check_mark: | N/A | -| `id` | *String* | :heavy_check_mark: | N/A | -| `url` | *String* | :heavy_check_mark: | N/A | -| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.
| -| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.
| \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | +| `object` | [RedirectURLObject](../../models/components/RedirectURLObject.md) | :heavy_check_mark: | N/A | +| `id` | *String* | :heavy_check_mark: | N/A | +| `url` | *String* | :heavy_check_mark: | N/A | +| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.
| +| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.
| \ No newline at end of file diff --git a/docs/models/components/SAMLAccount.md b/docs/models/components/SAMLAccount.md index 7b79076..e69579f 100644 --- a/docs/models/components/SAMLAccount.md +++ b/docs/models/components/SAMLAccount.md @@ -3,15 +3,15 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *String* | :heavy_check_mark: | N/A | -| `object` | [com.clerk.backend_api.models.components.SAMLAccountObject](../../models/components/SAMLAccountObject.md) | :heavy_check_mark: | String representing the object's type. Objects of the same type share the same value.
| -| `provider` | *String* | :heavy_check_mark: | N/A | -| `active` | *boolean* | :heavy_check_mark: | N/A | -| `emailAddress` | *String* | :heavy_check_mark: | N/A | -| `firstName` | *JsonNullable* | :heavy_minus_sign: | N/A | -| `lastName` | *JsonNullable* | :heavy_minus_sign: | N/A | -| `providerUserId` | *JsonNullable* | :heavy_minus_sign: | N/A | -| `publicMetadata` | [Optional](../../models/components/SAMLAccountPublicMetadata.md) | :heavy_minus_sign: | N/A | -| `verification` | [Optional](../../models/components/SAMLAccountVerification.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | +| `id` | *String* | :heavy_check_mark: | N/A | +| `object` | [SAMLAccountObject](../../models/components/SAMLAccountObject.md) | :heavy_check_mark: | String representing the object's type. Objects of the same type share the same value.
| +| `provider` | *String* | :heavy_check_mark: | N/A | +| `active` | *boolean* | :heavy_check_mark: | N/A | +| `emailAddress` | *String* | :heavy_check_mark: | N/A | +| `firstName` | *JsonNullable* | :heavy_minus_sign: | N/A | +| `lastName` | *JsonNullable* | :heavy_minus_sign: | N/A | +| `providerUserId` | *JsonNullable* | :heavy_minus_sign: | N/A | +| `publicMetadata` | [Optional](../../models/components/SAMLAccountPublicMetadata.md) | :heavy_minus_sign: | N/A | +| `verification` | [Optional](../../models/components/SAMLAccountVerification.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/SAMLConnection.md b/docs/models/components/SAMLConnection.md index f9b81aa..e155a68 100644 --- a/docs/models/components/SAMLConnection.md +++ b/docs/models/components/SAMLConnection.md @@ -3,26 +3,26 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | -| `object` | [com.clerk.backend_api.models.components.SAMLConnectionObject](../../models/components/SAMLConnectionObject.md) | :heavy_check_mark: | N/A | -| `id` | *String* | :heavy_check_mark: | N/A | -| `name` | *String* | :heavy_check_mark: | N/A | -| `domain` | *String* | :heavy_check_mark: | N/A | -| `idpEntityId` | *Optional* | :heavy_check_mark: | N/A | -| `idpSsoUrl` | *Optional* | :heavy_check_mark: | N/A | -| `idpCertificate` | *Optional* | :heavy_check_mark: | N/A | -| `idpMetadataUrl` | *JsonNullable* | :heavy_minus_sign: | N/A | -| `idpMetadata` | *JsonNullable* | :heavy_minus_sign: | N/A | -| `acsUrl` | *String* | :heavy_check_mark: | N/A | -| `spEntityId` | *String* | :heavy_check_mark: | N/A | -| `spMetadataUrl` | *String* | :heavy_check_mark: | N/A | -| `attributeMapping` | [Optional](../../models/components/AttributeMapping.md) | :heavy_minus_sign: | N/A | -| `active` | *boolean* | :heavy_check_mark: | N/A | -| `provider` | *String* | :heavy_check_mark: | N/A | -| `userCount` | *long* | :heavy_check_mark: | N/A | -| `syncUserAttributes` | *boolean* | :heavy_check_mark: | N/A | -| `allowSubdomains` | *Optional* | :heavy_minus_sign: | N/A | -| `allowIdpInitiated` | *Optional* | :heavy_minus_sign: | N/A | -| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.
| -| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.
| \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `object` | [SAMLConnectionObject](../../models/components/SAMLConnectionObject.md) | :heavy_check_mark: | N/A | +| `id` | *String* | :heavy_check_mark: | N/A | +| `name` | *String* | :heavy_check_mark: | N/A | +| `domain` | *String* | :heavy_check_mark: | N/A | +| `idpEntityId` | *Optional* | :heavy_check_mark: | N/A | +| `idpSsoUrl` | *Optional* | :heavy_check_mark: | N/A | +| `idpCertificate` | *Optional* | :heavy_check_mark: | N/A | +| `idpMetadataUrl` | *JsonNullable* | :heavy_minus_sign: | N/A | +| `idpMetadata` | *JsonNullable* | :heavy_minus_sign: | N/A | +| `acsUrl` | *String* | :heavy_check_mark: | N/A | +| `spEntityId` | *String* | :heavy_check_mark: | N/A | +| `spMetadataUrl` | *String* | :heavy_check_mark: | N/A | +| `attributeMapping` | [Optional](../../models/components/AttributeMapping.md) | :heavy_minus_sign: | N/A | +| `active` | *boolean* | :heavy_check_mark: | N/A | +| `provider` | *String* | :heavy_check_mark: | N/A | +| `userCount` | *long* | :heavy_check_mark: | N/A | +| `syncUserAttributes` | *boolean* | :heavy_check_mark: | N/A | +| `allowSubdomains` | *Optional* | :heavy_minus_sign: | N/A | +| `allowIdpInitiated` | *Optional* | :heavy_minus_sign: | N/A | +| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.
| +| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.
| \ No newline at end of file diff --git a/docs/models/components/SAMLConnections.md b/docs/models/components/SAMLConnections.md index 33a829a..18f5039 100644 --- a/docs/models/components/SAMLConnections.md +++ b/docs/models/components/SAMLConnections.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| `data` | List<[com.clerk.backend_api.models.components.SAMLConnection](../../models/components/SAMLConnection.md)> | :heavy_check_mark: | N/A | -| `totalCount` | *long* | :heavy_check_mark: | Total number of SAML Connections
| \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | +| `data` | List<[SAMLConnection](../../models/components/SAMLConnection.md)> | :heavy_check_mark: | N/A | +| `totalCount` | *long* | :heavy_check_mark: | Total number of SAML Connections
| \ No newline at end of file diff --git a/docs/models/components/SAMLErrorClerkError.md b/docs/models/components/SAMLErrorClerkError.md index 242bc51..3656831 100644 --- a/docs/models/components/SAMLErrorClerkError.md +++ b/docs/models/components/SAMLErrorClerkError.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `message` | *String* | :heavy_check_mark: | N/A | -| `longMessage` | *String* | :heavy_check_mark: | N/A | -| `code` | *String* | :heavy_check_mark: | N/A | -| `meta` | [Optional](../../models/components/ClerkErrorErrorMeta.md) | :heavy_minus_sign: | N/A | -| `clerkTraceId` | *Optional* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | +| `message` | *String* | :heavy_check_mark: | N/A | +| `longMessage` | *String* | :heavy_check_mark: | N/A | +| `code` | *String* | :heavy_check_mark: | N/A | +| `meta` | [Optional](../../models/components/ClerkErrorErrorMeta.md) | :heavy_minus_sign: | N/A | +| `clerkTraceId` | *Optional* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/Saml.md b/docs/models/components/Saml.md index 4ba661e..25d7775 100644 --- a/docs/models/components/Saml.md +++ b/docs/models/components/Saml.md @@ -3,11 +3,11 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `status` | [com.clerk.backend_api.models.components.SAMLVerificationStatus](../../models/components/SAMLVerificationStatus.md) | :heavy_check_mark: | N/A | -| `strategy` | [com.clerk.backend_api.models.components.SAMLVerificationStrategy](../../models/components/SAMLVerificationStrategy.md) | :heavy_check_mark: | N/A | -| `externalVerificationRedirectUrl` | *Optional* | :heavy_check_mark: | N/A | -| `error` | [JsonNullable](../../models/components/VerificationError.md) | :heavy_minus_sign: | N/A | -| `expireAt` | *long* | :heavy_check_mark: | N/A | -| `attempts` | *JsonNullable* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | +| `status` | [SAMLVerificationStatus](../../models/components/SAMLVerificationStatus.md) | :heavy_check_mark: | N/A | +| `strategy` | [SAMLVerificationStrategy](../../models/components/SAMLVerificationStrategy.md) | :heavy_check_mark: | N/A | +| `externalVerificationRedirectUrl` | *Optional* | :heavy_check_mark: | N/A | +| `error` | [JsonNullable](../../models/components/VerificationError.md) | :heavy_minus_sign: | N/A | +| `expireAt` | *long* | :heavy_check_mark: | N/A | +| `attempts` | *JsonNullable* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/SchemasPasskey.md b/docs/models/components/SchemasPasskey.md index dd3a42d..d46c600 100644 --- a/docs/models/components/SchemasPasskey.md +++ b/docs/models/components/SchemasPasskey.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *Optional* | :heavy_minus_sign: | N/A | -| `object` | [com.clerk.backend_api.models.components.SchemasPasskeyObject](../../models/components/SchemasPasskeyObject.md) | :heavy_check_mark: | String representing the object's type. Objects of the same type share the same value.
| -| `name` | *String* | :heavy_check_mark: | N/A | -| `lastUsedAt` | *long* | :heavy_check_mark: | Unix timestamp of when the passkey was last used.
| -| `verification` | [Optional](../../models/components/SchemasPasskeyVerification.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | +| `id` | *Optional* | :heavy_minus_sign: | N/A | +| `object` | [SchemasPasskeyObject](../../models/components/SchemasPasskeyObject.md) | :heavy_check_mark: | String representing the object's type. Objects of the same type share the same value.
| +| `name` | *String* | :heavy_check_mark: | N/A | +| `lastUsedAt` | *long* | :heavy_check_mark: | Unix timestamp of when the passkey was last used.
| +| `verification` | [Optional](../../models/components/SchemasPasskeyVerification.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/Security.md b/docs/models/components/Security.md index 494b03f..4934713 100644 --- a/docs/models/components/Security.md +++ b/docs/models/components/Security.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | -| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | -| `bearerAuth` | *Optional* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `bearerAuth` | *Optional* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/Session.md b/docs/models/components/Session.md index 3d4e989..17e351a 100644 --- a/docs/models/components/Session.md +++ b/docs/models/components/Session.md @@ -3,17 +3,17 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| `object` | [com.clerk.backend_api.models.components.SessionObject](../../models/components/SessionObject.md) | :heavy_check_mark: | String representing the object's type. Objects of the same type share the same value.
| -| `id` | *String* | :heavy_check_mark: | N/A | -| `userId` | *String* | :heavy_check_mark: | N/A | -| `clientId` | *String* | :heavy_check_mark: | N/A | -| `actor` | [JsonNullable](../../models/components/Actor.md) | :heavy_minus_sign: | N/A | -| `status` | [com.clerk.backend_api.models.components.Status](../../models/components/Status.md) | :heavy_check_mark: | N/A | -| `lastActiveOrganizationId` | *JsonNullable* | :heavy_minus_sign: | N/A | -| `lastActiveAt` | *long* | :heavy_check_mark: | N/A | -| `expireAt` | *long* | :heavy_check_mark: | N/A | -| `abandonAt` | *long* | :heavy_check_mark: | N/A | -| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.
| -| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.
| \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `object` | [SessionObject](../../models/components/SessionObject.md) | :heavy_check_mark: | String representing the object's type. Objects of the same type share the same value.
| +| `id` | *String* | :heavy_check_mark: | N/A | +| `userId` | *String* | :heavy_check_mark: | N/A | +| `clientId` | *String* | :heavy_check_mark: | N/A | +| `actor` | [JsonNullable](../../models/components/Actor.md) | :heavy_minus_sign: | N/A | +| `status` | [Status](../../models/components/Status.md) | :heavy_check_mark: | N/A | +| `lastActiveOrganizationId` | *JsonNullable* | :heavy_minus_sign: | N/A | +| `lastActiveAt` | *long* | :heavy_check_mark: | N/A | +| `expireAt` | *long* | :heavy_check_mark: | N/A | +| `abandonAt` | *long* | :heavy_check_mark: | N/A | +| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.
| +| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.
| \ No newline at end of file diff --git a/docs/models/components/SignInToken.md b/docs/models/components/SignInToken.md index 537232f..fc26b4b 100644 --- a/docs/models/components/SignInToken.md +++ b/docs/models/components/SignInToken.md @@ -3,13 +3,13 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| `object` | [com.clerk.backend_api.models.components.SignInTokenObject](../../models/components/SignInTokenObject.md) | :heavy_check_mark: | N/A | -| `id` | *String* | :heavy_check_mark: | N/A | -| `status` | [com.clerk.backend_api.models.components.SignInTokenStatus](../../models/components/SignInTokenStatus.md) | :heavy_check_mark: | N/A | -| `userId` | *String* | :heavy_check_mark: | N/A | -| `token` | *Optional* | :heavy_minus_sign: | N/A | -| `url` | *JsonNullable* | :heavy_minus_sign: | N/A | -| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.
| -| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.
| \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | +| `object` | [SignInTokenObject](../../models/components/SignInTokenObject.md) | :heavy_check_mark: | N/A | +| `id` | *String* | :heavy_check_mark: | N/A | +| `status` | [SignInTokenStatus](../../models/components/SignInTokenStatus.md) | :heavy_check_mark: | N/A | +| `userId` | *String* | :heavy_check_mark: | N/A | +| `token` | *Optional* | :heavy_minus_sign: | N/A | +| `url` | *JsonNullable* | :heavy_minus_sign: | N/A | +| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation.
| +| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of last update.
| \ No newline at end of file diff --git a/docs/models/components/SignUp.md b/docs/models/components/SignUp.md index ec3744d..077af0b 100644 --- a/docs/models/components/SignUp.md +++ b/docs/models/components/SignUp.md @@ -3,28 +3,28 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | -| `object` | [com.clerk.backend_api.models.components.SignUpObject](../../models/components/SignUpObject.md) | :heavy_check_mark: | N/A | -| `id` | *String* | :heavy_check_mark: | N/A | -| `status` | [com.clerk.backend_api.models.components.SignUpStatus](../../models/components/SignUpStatus.md) | :heavy_check_mark: | N/A | -| `requiredFields` | List<*String*> | :heavy_minus_sign: | N/A | -| `optionalFields` | List<*String*> | :heavy_minus_sign: | N/A | -| `missingFields` | List<*String*> | :heavy_minus_sign: | N/A | -| `unverifiedFields` | List<*String*> | :heavy_minus_sign: | N/A | -| `verifications` | [Optional](../../models/components/Verifications.md) | :heavy_minus_sign: | N/A | -| `username` | *JsonNullable* | :heavy_minus_sign: | N/A | -| `emailAddress` | *JsonNullable* | :heavy_minus_sign: | N/A | -| `phoneNumber` | *JsonNullable* | :heavy_minus_sign: | N/A | -| `web3Wallet` | *JsonNullable* | :heavy_minus_sign: | N/A | -| `passwordEnabled` | *boolean* | :heavy_check_mark: | N/A | -| `firstName` | *JsonNullable* | :heavy_minus_sign: | N/A | -| `lastName` | *JsonNullable* | :heavy_minus_sign: | N/A | -| `unsafeMetadata` | [Optional](../../models/components/SignUpUnsafeMetadata.md) | :heavy_minus_sign: | N/A | -| `publicMetadata` | [Optional](../../models/components/SignUpPublicMetadata.md) | :heavy_minus_sign: | N/A | -| `customAction` | *boolean* | :heavy_check_mark: | N/A | -| `externalId` | *JsonNullable* | :heavy_minus_sign: | N/A | -| `createdSessionId` | *JsonNullable* | :heavy_minus_sign: | N/A | -| `createdUserId` | *JsonNullable* | :heavy_minus_sign: | N/A | -| `abandonAt` | *long* | :heavy_check_mark: | N/A | -| `externalAccount` | [Optional](../../models/components/ExternalAccount.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | +| `object` | [SignUpObject](../../models/components/SignUpObject.md) | :heavy_check_mark: | N/A | +| `id` | *String* | :heavy_check_mark: | N/A | +| `status` | [SignUpStatus](../../models/components/SignUpStatus.md) | :heavy_check_mark: | N/A | +| `requiredFields` | List<*String*> | :heavy_minus_sign: | N/A | +| `optionalFields` | List<*String*> | :heavy_minus_sign: | N/A | +| `missingFields` | List<*String*> | :heavy_minus_sign: | N/A | +| `unverifiedFields` | List<*String*> | :heavy_minus_sign: | N/A | +| `verifications` | [Optional](../../models/components/Verifications.md) | :heavy_minus_sign: | N/A | +| `username` | *JsonNullable* | :heavy_minus_sign: | N/A | +| `emailAddress` | *JsonNullable* | :heavy_minus_sign: | N/A | +| `phoneNumber` | *JsonNullable* | :heavy_minus_sign: | N/A | +| `web3Wallet` | *JsonNullable* | :heavy_minus_sign: | N/A | +| `passwordEnabled` | *boolean* | :heavy_check_mark: | N/A | +| `firstName` | *JsonNullable* | :heavy_minus_sign: | N/A | +| `lastName` | *JsonNullable* | :heavy_minus_sign: | N/A | +| `unsafeMetadata` | [Optional](../../models/components/SignUpUnsafeMetadata.md) | :heavy_minus_sign: | N/A | +| `publicMetadata` | [Optional](../../models/components/SignUpPublicMetadata.md) | :heavy_minus_sign: | N/A | +| `customAction` | *boolean* | :heavy_check_mark: | N/A | +| `externalId` | *JsonNullable* | :heavy_minus_sign: | N/A | +| `createdSessionId` | *JsonNullable* | :heavy_minus_sign: | N/A | +| `createdUserId` | *JsonNullable* | :heavy_minus_sign: | N/A | +| `abandonAt` | *long* | :heavy_check_mark: | N/A | +| `externalAccount` | [Optional](../../models/components/ExternalAccount.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/Template.md b/docs/models/components/Template.md index 9c2a3c6..3b9079d 100644 --- a/docs/models/components/Template.md +++ b/docs/models/components/Template.md @@ -3,26 +3,26 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| `id` | *Optional* | :heavy_minus_sign: | N/A | -| `object` | [Optional](../../models/components/TemplateObject.md) | :heavy_minus_sign: | String representing the object's type. Objects of the same type share the same value.
| -| `instanceId` | *JsonNullable* | :heavy_minus_sign: | the id of the instance the template belongs to | -| `resourceType` | *Optional* | :heavy_minus_sign: | whether this is a system (default) or user overridden) template | -| `templateType` | *Optional* | :heavy_minus_sign: | whether this is an email or SMS template | -| `name` | *Optional* | :heavy_minus_sign: | user-friendly name of the template | -| `slug` | *Optional* | :heavy_minus_sign: | machine-friendly name of the template | -| `position` | *Optional* | :heavy_minus_sign: | position with the listing of templates | -| `canRevert` | *Optional* | :heavy_minus_sign: | whether this template can be reverted to the corresponding system default | -| `canDelete` | *Optional* | :heavy_minus_sign: | whether this template can be deleted | -| `canDisable` | *Optional* | :heavy_minus_sign: | whether this template can be disabled, true only for notification SMS templates | -| `subject` | *JsonNullable* | :heavy_minus_sign: | email subject | -| `markup` | *Optional* | :heavy_minus_sign: | the editor markup used to generate the body of the template | -| `body` | *Optional* | :heavy_minus_sign: | the template body before variable interpolation | -| `availableVariables` | List<*String*> | :heavy_minus_sign: | list of variables that are available for use in the template body | -| `requiredVariables` | List<*String*> | :heavy_minus_sign: | list of variables that must be contained in the template body | -| `fromEmailName` | *Optional* | :heavy_minus_sign: | N/A | -| `replyToEmailName` | *Optional* | :heavy_minus_sign: | N/A | -| `deliveredByClerk` | *Optional* | :heavy_minus_sign: | N/A | -| `updatedAt` | *Optional* | :heavy_minus_sign: | Unix timestamp of last update.
| -| `createdAt` | *Optional* | :heavy_minus_sign: | Unix timestamp of creation.
| \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `id` | *Optional* | :heavy_minus_sign: | N/A | +| `object` | [Optional](../../models/components/TemplateObject.md) | :heavy_minus_sign: | String representing the object's type. Objects of the same type share the same value.
| +| `instanceId` | *JsonNullable* | :heavy_minus_sign: | the id of the instance the template belongs to | +| `resourceType` | *Optional* | :heavy_minus_sign: | whether this is a system (default) or user overridden) template | +| `templateType` | *Optional* | :heavy_minus_sign: | whether this is an email or SMS template | +| `name` | *Optional* | :heavy_minus_sign: | user-friendly name of the template | +| `slug` | *Optional* | :heavy_minus_sign: | machine-friendly name of the template | +| `position` | *Optional* | :heavy_minus_sign: | position with the listing of templates | +| `canRevert` | *Optional* | :heavy_minus_sign: | whether this template can be reverted to the corresponding system default | +| `canDelete` | *Optional* | :heavy_minus_sign: | whether this template can be deleted | +| `canDisable` | *Optional* | :heavy_minus_sign: | whether this template can be disabled, true only for notification SMS templates | +| `subject` | *JsonNullable* | :heavy_minus_sign: | email subject | +| `markup` | *Optional* | :heavy_minus_sign: | the editor markup used to generate the body of the template | +| `body` | *Optional* | :heavy_minus_sign: | the template body before variable interpolation | +| `availableVariables` | List<*String*> | :heavy_minus_sign: | list of variables that are available for use in the template body | +| `requiredVariables` | List<*String*> | :heavy_minus_sign: | list of variables that must be contained in the template body | +| `fromEmailName` | *Optional* | :heavy_minus_sign: | N/A | +| `replyToEmailName` | *Optional* | :heavy_minus_sign: | N/A | +| `deliveredByClerk` | *Optional* | :heavy_minus_sign: | N/A | +| `updatedAt` | *Optional* | :heavy_minus_sign: | Unix timestamp of last update.
| +| `createdAt` | *Optional* | :heavy_minus_sign: | Unix timestamp of creation.
| \ No newline at end of file diff --git a/docs/models/components/TestingToken.md b/docs/models/components/TestingToken.md index 8fc016e..2d03e5d 100644 --- a/docs/models/components/TestingToken.md +++ b/docs/models/components/TestingToken.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | -| `object` | [com.clerk.backend_api.models.components.TestingTokenObject](../../models/components/TestingTokenObject.md) | :heavy_check_mark: | N/A | | +| `object` | [TestingTokenObject](../../models/components/TestingTokenObject.md) | :heavy_check_mark: | N/A | | | `token` | *String* | :heavy_check_mark: | The actual token. This value is meant to be passed in the `__clerk_testing_token` query parameter with requests to the Frontend API. | 1713877200-c_2J2MvPu9PnXcuhbPZNao0LOXqK9A7YrnBn0HmIWxy | | `expiresAt` | *long* | :heavy_check_mark: | Unix timestamp of the token's expiration time.
| 1713880800 | \ No newline at end of file diff --git a/docs/models/components/Ticket.md b/docs/models/components/Ticket.md index d634dd1..5ca25f7 100644 --- a/docs/models/components/Ticket.md +++ b/docs/models/components/Ticket.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | -| `status` | [com.clerk.backend_api.models.components.TicketVerificationStatus](../../models/components/TicketVerificationStatus.md) | :heavy_check_mark: | N/A | -| `strategy` | [com.clerk.backend_api.models.components.TicketVerificationStrategy](../../models/components/TicketVerificationStrategy.md) | :heavy_check_mark: | N/A | -| `attempts` | *JsonNullable* | :heavy_minus_sign: | N/A | -| `expireAt` | *JsonNullable* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | +| `status` | [TicketVerificationStatus](../../models/components/TicketVerificationStatus.md) | :heavy_check_mark: | N/A | +| `strategy` | [TicketVerificationStrategy](../../models/components/TicketVerificationStrategy.md) | :heavy_check_mark: | N/A | +| `attempts` | *JsonNullable* | :heavy_minus_sign: | N/A | +| `expireAt` | *JsonNullable* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/TotalCount.md b/docs/models/components/TotalCount.md index b7ba547..01f8e44 100644 --- a/docs/models/components/TotalCount.md +++ b/docs/models/components/TotalCount.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | -| `object` | [com.clerk.backend_api.models.components.TotalCountObject](../../models/components/TotalCountObject.md) | :heavy_check_mark: | String representing the object's type. Objects of the same type share the same value.
| -| `totalCount` | *long* | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `object` | [TotalCountObject](../../models/components/TotalCountObject.md) | :heavy_check_mark: | String representing the object's type. Objects of the same type share the same value.
| +| `totalCount` | *long* | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/components/User.md b/docs/models/components/User.md index a8f0598..cc8fbe9 100644 --- a/docs/models/components/User.md +++ b/docs/models/components/User.md @@ -5,40 +5,40 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *Optional* | :heavy_minus_sign: | N/A | | -| `object` | [Optional](../../models/components/UserObject.md) | :heavy_minus_sign: | String representing the object's type. Objects of the same type share the same value.
| | -| `externalId` | *JsonNullable* | :heavy_minus_sign: | N/A | | -| `primaryEmailAddressId` | *JsonNullable* | :heavy_minus_sign: | N/A | | -| `primaryPhoneNumberId` | *JsonNullable* | :heavy_minus_sign: | N/A | | -| `primaryWeb3WalletId` | *JsonNullable* | :heavy_minus_sign: | N/A | | -| `username` | *JsonNullable* | :heavy_minus_sign: | N/A | | -| `firstName` | *JsonNullable* | :heavy_minus_sign: | N/A | | -| `lastName` | *JsonNullable* | :heavy_minus_sign: | N/A | | -| ~~`profileImageUrl`~~ | *Optional* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | | -| `imageUrl` | *Optional* | :heavy_minus_sign: | N/A | | -| `hasImage` | *Optional* | :heavy_minus_sign: | N/A | | -| `publicMetadata` | [Optional](../../models/components/PublicMetadata.md) | :heavy_minus_sign: | N/A | | -| `privateMetadata` | [JsonNullable](../../models/components/PrivateMetadata.md) | :heavy_minus_sign: | N/A | | -| `unsafeMetadata` | [Optional](../../models/components/UnsafeMetadata.md) | :heavy_minus_sign: | N/A | | -| `emailAddresses` | List<[com.clerk.backend_api.models.components.EmailAddress](../../models/components/EmailAddress.md)> | :heavy_minus_sign: | N/A | | -| `phoneNumbers` | List<[com.clerk.backend_api.models.components.PhoneNumber](../../models/components/PhoneNumber.md)> | :heavy_minus_sign: | N/A | | -| `web3Wallets` | List<[com.clerk.backend_api.models.components.Web3Wallet](../../models/components/Web3Wallet.md)> | :heavy_minus_sign: | N/A | | -| `passkeys` | List<[com.clerk.backend_api.models.components.SchemasPasskey](../../models/components/SchemasPasskey.md)> | :heavy_minus_sign: | N/A | | -| `passwordEnabled` | *Optional* | :heavy_minus_sign: | N/A | | -| `twoFactorEnabled` | *Optional* | :heavy_minus_sign: | N/A | | -| `totpEnabled` | *Optional* | :heavy_minus_sign: | N/A | | -| `backupCodeEnabled` | *Optional* | :heavy_minus_sign: | N/A | | -| `mfaEnabledAt` | *JsonNullable* | :heavy_minus_sign: | Unix timestamp of when MFA was last enabled for this user. It should be noted that this field is not nullified if MFA is disabled.
| | -| `mfaDisabledAt` | *JsonNullable* | :heavy_minus_sign: | Unix timestamp of when MFA was last disabled for this user. It should be noted that this field is not nullified if MFA is enabled again.
| | -| `externalAccounts` | List<[com.clerk.backend_api.models.components.ExternalAccounts](../../models/components/ExternalAccounts.md)> | :heavy_minus_sign: | N/A | | -| `samlAccounts` | List<[com.clerk.backend_api.models.components.SAMLAccount](../../models/components/SAMLAccount.md)> | :heavy_minus_sign: | N/A | | -| `lastSignInAt` | *JsonNullable* | :heavy_minus_sign: | Unix timestamp of last sign-in.
| | -| `banned` | *Optional* | :heavy_minus_sign: | Flag to denote whether user is banned or not.
| | -| `locked` | *Optional* | :heavy_minus_sign: | Flag to denote whether user is currently locked, i.e. restricted from signing in or not.
| | -| `lockoutExpiresInSeconds` | *JsonNullable* | :heavy_minus_sign: | The number of seconds remaining until the lockout period expires for a locked user. A null value for a locked user indicates that lockout never expires.
| | -| `verificationAttemptsRemaining` | *JsonNullable* | :heavy_minus_sign: | The number of verification attempts remaining until the user is locked. Null if account lockout is not enabled. Note: if a user is locked explicitly via the Backend API, they may still have verification attempts remaining.
| | -| `updatedAt` | *Optional* | :heavy_minus_sign: | Unix timestamp of last update.
| | -| `createdAt` | *Optional* | :heavy_minus_sign: | Unix timestamp of creation.
| | -| `deleteSelfEnabled` | *Optional* | :heavy_minus_sign: | If enabled, user can delete themselves via FAPI.
| | -| `createOrganizationEnabled` | *Optional* | :heavy_minus_sign: | If enabled, user can create organizations via FAPI.
| | -| `lastActiveAt` | *JsonNullable* | :heavy_minus_sign: | Unix timestamp of the latest session activity, with day precision.
| 1700690400000 | \ No newline at end of file +| `id` | *Optional* | :heavy_minus_sign: | N/A | | +| `object` | [Optional](../../models/components/UserObject.md) | :heavy_minus_sign: | String representing the object's type. Objects of the same type share the same value.
| | +| `externalId` | *JsonNullable* | :heavy_minus_sign: | N/A | | +| `primaryEmailAddressId` | *JsonNullable* | :heavy_minus_sign: | N/A | | +| `primaryPhoneNumberId` | *JsonNullable* | :heavy_minus_sign: | N/A | | +| `primaryWeb3WalletId` | *JsonNullable* | :heavy_minus_sign: | N/A | | +| `username` | *JsonNullable* | :heavy_minus_sign: | N/A | | +| `firstName` | *JsonNullable* | :heavy_minus_sign: | N/A | | +| `lastName` | *JsonNullable* | :heavy_minus_sign: | N/A | | +| ~~`profileImageUrl`~~ | *Optional* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. | | +| `imageUrl` | *Optional* | :heavy_minus_sign: | N/A | | +| `hasImage` | *Optional* | :heavy_minus_sign: | N/A | | +| `publicMetadata` | [Optional](../../models/components/PublicMetadata.md) | :heavy_minus_sign: | N/A | | +| `privateMetadata` | [JsonNullable](../../models/components/PrivateMetadata.md) | :heavy_minus_sign: | N/A | | +| `unsafeMetadata` | [Optional](../../models/components/UnsafeMetadata.md) | :heavy_minus_sign: | N/A | | +| `emailAddresses` | List<[EmailAddress](../../models/components/EmailAddress.md)> | :heavy_minus_sign: | N/A | | +| `phoneNumbers` | List<[PhoneNumber](../../models/components/PhoneNumber.md)> | :heavy_minus_sign: | N/A | | +| `web3Wallets` | List<[Web3Wallet](../../models/components/Web3Wallet.md)> | :heavy_minus_sign: | N/A | | +| `passkeys` | List<[SchemasPasskey](../../models/components/SchemasPasskey.md)> | :heavy_minus_sign: | N/A | | +| `passwordEnabled` | *Optional* | :heavy_minus_sign: | N/A | | +| `twoFactorEnabled` | *Optional* | :heavy_minus_sign: | N/A | | +| `totpEnabled` | *Optional* | :heavy_minus_sign: | N/A | | +| `backupCodeEnabled` | *Optional* | :heavy_minus_sign: | N/A | | +| `mfaEnabledAt` | *JsonNullable* | :heavy_minus_sign: | Unix timestamp of when MFA was last enabled for this user. It should be noted that this field is not nullified if MFA is disabled.
| | +| `mfaDisabledAt` | *JsonNullable* | :heavy_minus_sign: | Unix timestamp of when MFA was last disabled for this user. It should be noted that this field is not nullified if MFA is enabled again.
| | +| `externalAccounts` | List<[ExternalAccounts](../../models/components/ExternalAccounts.md)> | :heavy_minus_sign: | N/A | | +| `samlAccounts` | List<[SAMLAccount](../../models/components/SAMLAccount.md)> | :heavy_minus_sign: | N/A | | +| `lastSignInAt` | *JsonNullable* | :heavy_minus_sign: | Unix timestamp of last sign-in.
| | +| `banned` | *Optional* | :heavy_minus_sign: | Flag to denote whether user is banned or not.
| | +| `locked` | *Optional* | :heavy_minus_sign: | Flag to denote whether user is currently locked, i.e. restricted from signing in or not.
| | +| `lockoutExpiresInSeconds` | *JsonNullable* | :heavy_minus_sign: | The number of seconds remaining until the lockout period expires for a locked user. A null value for a locked user indicates that lockout never expires.
| | +| `verificationAttemptsRemaining` | *JsonNullable* | :heavy_minus_sign: | The number of verification attempts remaining until the user is locked. Null if account lockout is not enabled. Note: if a user is locked explicitly via the Backend API, they may still have verification attempts remaining.
| | +| `updatedAt` | *Optional* | :heavy_minus_sign: | Unix timestamp of last update.
| | +| `createdAt` | *Optional* | :heavy_minus_sign: | Unix timestamp of creation.
| | +| `deleteSelfEnabled` | *Optional* | :heavy_minus_sign: | If enabled, user can delete themselves via FAPI.
| | +| `createOrganizationEnabled` | *Optional* | :heavy_minus_sign: | If enabled, user can create organizations via FAPI.
| | +| `lastActiveAt` | *JsonNullable* | :heavy_minus_sign: | Unix timestamp of the latest session activity, with day precision.
| 1700690400000 | \ No newline at end of file diff --git a/docs/models/components/VerificationAdmin.md b/docs/models/components/VerificationAdmin.md index dab3f3a..deb020e 100644 --- a/docs/models/components/VerificationAdmin.md +++ b/docs/models/components/VerificationAdmin.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | [com.clerk.backend_api.models.components.AdminVerificationPhoneNumberStatus](../../models/components/AdminVerificationPhoneNumberStatus.md) | :heavy_check_mark: | N/A | -| `strategy` | [com.clerk.backend_api.models.components.AdminVerificationStrategy](../../models/components/AdminVerificationStrategy.md) | :heavy_check_mark: | N/A | -| `attempts` | *JsonNullable* | :heavy_minus_sign: | N/A | -| `expireAt` | *JsonNullable* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | +| `status` | [AdminVerificationPhoneNumberStatus](../../models/components/AdminVerificationPhoneNumberStatus.md) | :heavy_check_mark: | N/A | +| `strategy` | [AdminVerificationStrategy](../../models/components/AdminVerificationStrategy.md) | :heavy_check_mark: | N/A | +| `attempts` | *JsonNullable* | :heavy_minus_sign: | N/A | +| `expireAt` | *JsonNullable* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/VerificationOTP.md b/docs/models/components/VerificationOTP.md index 4329c98..8dda9c7 100644 --- a/docs/models/components/VerificationOTP.md +++ b/docs/models/components/VerificationOTP.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `status` | [com.clerk.backend_api.models.components.OTPVerificationStatus](../../models/components/OTPVerificationStatus.md) | :heavy_check_mark: | N/A | -| `strategy` | [com.clerk.backend_api.models.components.OTPVerificationStrategy](../../models/components/OTPVerificationStrategy.md) | :heavy_check_mark: | N/A | -| `attempts` | *long* | :heavy_check_mark: | N/A | -| `expireAt` | *long* | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | +| `status` | [OTPVerificationStatus](../../models/components/OTPVerificationStatus.md) | :heavy_check_mark: | N/A | +| `strategy` | [OTPVerificationStrategy](../../models/components/OTPVerificationStrategy.md) | :heavy_check_mark: | N/A | +| `attempts` | *Optional* | :heavy_minus_sign: | N/A | +| `expireAt` | *Optional* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/Web3Signature.md b/docs/models/components/Web3Signature.md index 6f2abcd..487884c 100644 --- a/docs/models/components/Web3Signature.md +++ b/docs/models/components/Web3Signature.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | [com.clerk.backend_api.models.components.Web3SignatureVerificationStatus](../../models/components/Web3SignatureVerificationStatus.md) | :heavy_check_mark: | N/A | -| `strategy` | [com.clerk.backend_api.models.components.Web3SignatureVerificationStrategy](../../models/components/Web3SignatureVerificationStrategy.md) | :heavy_check_mark: | N/A | -| `nonce` | [com.clerk.backend_api.models.components.Nonce](../../models/components/Nonce.md) | :heavy_check_mark: | N/A | -| `attempts` | *JsonNullable* | :heavy_minus_sign: | N/A | -| `expireAt` | *JsonNullable* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | +| `status` | [Web3SignatureVerificationStatus](../../models/components/Web3SignatureVerificationStatus.md) | :heavy_check_mark: | N/A | +| `strategy` | [Web3SignatureVerificationStrategy](../../models/components/Web3SignatureVerificationStrategy.md) | :heavy_check_mark: | N/A | +| `nonce` | [Nonce](../../models/components/Nonce.md) | :heavy_check_mark: | N/A | +| `attempts` | *JsonNullable* | :heavy_minus_sign: | N/A | +| `expireAt` | *JsonNullable* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/components/Web3Wallet.md b/docs/models/components/Web3Wallet.md index 08e8e33..28f9560 100644 --- a/docs/models/components/Web3Wallet.md +++ b/docs/models/components/Web3Wallet.md @@ -3,11 +3,11 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -| `id` | *Optional* | :heavy_minus_sign: | N/A | -| `object` | [com.clerk.backend_api.models.components.Web3WalletObject](../../models/components/Web3WalletObject.md) | :heavy_check_mark: | String representing the object's type. Objects of the same type share the same value.
| -| `web3Wallet` | *String* | :heavy_check_mark: | N/A | -| `verification` | [Optional](../../models/components/Web3WalletVerification.md) | :heavy_check_mark: | N/A | -| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation
| -| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of creation
| \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | +| `id` | *Optional* | :heavy_minus_sign: | N/A | +| `object` | [Web3WalletObject](../../models/components/Web3WalletObject.md) | :heavy_check_mark: | String representing the object's type. Objects of the same type share the same value.
| +| `web3Wallet` | *String* | :heavy_check_mark: | N/A | +| `verification` | [Optional](../../models/components/Web3WalletVerification.md) | :heavy_check_mark: | N/A | +| `createdAt` | *long* | :heavy_check_mark: | Unix timestamp of creation
| +| `updatedAt` | *long* | :heavy_check_mark: | Unix timestamp of creation
| \ No newline at end of file diff --git a/docs/models/components/Web3WalletVerificationAdmin.md b/docs/models/components/Web3WalletVerificationAdmin.md index 6de2aa5..e326814 100644 --- a/docs/models/components/Web3WalletVerificationAdmin.md +++ b/docs/models/components/Web3WalletVerificationAdmin.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `status` | [com.clerk.backend_api.models.components.AdminVerificationWeb3WalletStatus](../../models/components/AdminVerificationWeb3WalletStatus.md) | :heavy_check_mark: | N/A | -| `strategy` | [com.clerk.backend_api.models.components.AdminVerificationWeb3WalletStrategy](../../models/components/AdminVerificationWeb3WalletStrategy.md) | :heavy_check_mark: | N/A | -| `attempts` | *JsonNullable* | :heavy_minus_sign: | N/A | -| `expireAt` | *JsonNullable* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | +| `status` | [AdminVerificationWeb3WalletStatus](../../models/components/AdminVerificationWeb3WalletStatus.md) | :heavy_check_mark: | N/A | +| `strategy` | [AdminVerificationWeb3WalletStrategy](../../models/components/AdminVerificationWeb3WalletStrategy.md) | :heavy_check_mark: | N/A | +| `attempts` | *JsonNullable* | :heavy_minus_sign: | N/A | +| `expireAt` | *JsonNullable* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/errors/ClerkErrors.md b/docs/models/errors/ClerkErrors.md index ec72b41..958613d 100644 --- a/docs/models/errors/ClerkErrors.md +++ b/docs/models/errors/ClerkErrors.md @@ -5,7 +5,7 @@ Request was not successful ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -| `errors` | List<[com.clerk.backend_api.models.components.ClerkError](../../models/components/ClerkError.md)> | :heavy_check_mark: | N/A | -| `meta` | [Optional](../../models/errors/Meta.md) | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | +| `errors` | List<[ClerkError](../../models/components/ClerkError.md)> | :heavy_check_mark: | N/A | +| `meta` | [Optional](../../models/errors/Meta.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/AddDomainRequestBody.md b/docs/models/operations/AddDomainRequestBody.md index c8ba329..08ae43d 100644 --- a/docs/models/operations/AddDomainRequestBody.md +++ b/docs/models/operations/AddDomainRequestBody.md @@ -7,4 +7,4 @@ | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | `name` | *String* | :heavy_check_mark: | The new domain name. Can contain the port for development instances. | | `isSatellite` | *boolean* | :heavy_check_mark: | Marks the new domain as satellite. Only `true` is accepted at the moment. | -| `proxyUrl` | *Optional* | :heavy_minus_sign: | The full URL of the proxy which will forward requests to the Clerk Frontend API for this domain. Applicable only to production instances. | \ No newline at end of file +| `proxyUrl` | *Optional* | :heavy_minus_sign: | The full URL of the proxy which will forward requests to the Clerk Frontend API for this domain. Applicable only to production instances. | \ No newline at end of file diff --git a/docs/models/operations/AddDomainResponse.md b/docs/models/operations/AddDomainResponse.md index 58833a8..3d29a1b 100644 --- a/docs/models/operations/AddDomainResponse.md +++ b/docs/models/operations/AddDomainResponse.md @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `domain` | [Optional](../../models/components/Domain.md) | :heavy_minus_sign: | A domain | \ No newline at end of file +| `domain` | [Optional](../../models/components/Domain.md) | :heavy_minus_sign: | A domain | \ No newline at end of file diff --git a/docs/models/operations/AttributeMapping.md b/docs/models/operations/AttributeMapping.md index f809916..31d3901 100644 --- a/docs/models/operations/AttributeMapping.md +++ b/docs/models/operations/AttributeMapping.md @@ -5,9 +5,9 @@ Define the attribute name mapping between Identity Provider and Clerk's user pro ## Fields -| Field | Type | Required | Description | -| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | -| `userId` | *Optional* | :heavy_minus_sign: | N/A | -| `emailAddress` | *Optional* | :heavy_minus_sign: | N/A | -| `firstName` | *Optional* | :heavy_minus_sign: | N/A | -| `lastName` | *Optional* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `userId` | *Optional* | :heavy_minus_sign: | N/A | +| `emailAddress` | *Optional* | :heavy_minus_sign: | N/A | +| `firstName` | *Optional* | :heavy_minus_sign: | N/A | +| `lastName` | *Optional* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/BanUserResponse.md b/docs/models/operations/BanUserResponse.md index d5f3289..8b0b006 100644 --- a/docs/models/operations/BanUserResponse.md +++ b/docs/models/operations/BanUserResponse.md @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `user` | [Optional](../../models/components/User.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| `user` | [Optional](../../models/components/User.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/docs/models/operations/ChangeProductionInstanceDomainRequestBody.md b/docs/models/operations/ChangeProductionInstanceDomainRequestBody.md index da4d960..af1c182 100644 --- a/docs/models/operations/ChangeProductionInstanceDomainRequestBody.md +++ b/docs/models/operations/ChangeProductionInstanceDomainRequestBody.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | -| `homeUrl` | *Optional* | :heavy_minus_sign: | The new home URL of the production instance e.g. https://www.example.com | \ No newline at end of file +| `homeUrl` | *Optional* | :heavy_minus_sign: | The new home URL of the production instance e.g. https://www.example.com | \ No newline at end of file diff --git a/docs/models/operations/CreateActorTokenRequestBody.md b/docs/models/operations/CreateActorTokenRequestBody.md index 2a6e7cb..62beaac 100644 --- a/docs/models/operations/CreateActorTokenRequestBody.md +++ b/docs/models/operations/CreateActorTokenRequestBody.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `userId` | *String* | :heavy_check_mark: | The ID of the user that can use the newly created sign in token. | | -| `actor` | Map | :heavy_check_mark: | The actor payload. It needs to include a sub property which should contain the ID of the actor.
This whole payload will be also included in the JWT session token. | {
"sub": "user_2OEpKhcCN1Lat9NQ0G6puh7q5Rb"
} | -| `expiresInSeconds` | *Optional* | :heavy_minus_sign: | Optional parameter to specify the life duration of the actor token in seconds.
By default, the duration is 1 hour. | | -| `sessionMaxDurationInSeconds` | *Optional* | :heavy_minus_sign: | The maximum duration that the session which will be created by the generated actor token should last.
By default, the duration of a session created via an actor token, lasts 30 minutes. | | \ No newline at end of file +| `actor` | Map | :heavy_check_mark: | The actor payload. It needs to include a sub property which should contain the ID of the actor.
This whole payload will be also included in the JWT session token. | {
"sub": "user_2OEpKhcCN1Lat9NQ0G6puh7q5Rb"
} | +| `expiresInSeconds` | *Optional* | :heavy_minus_sign: | Optional parameter to specify the life duration of the actor token in seconds.
By default, the duration is 1 hour. | | +| `sessionMaxDurationInSeconds` | *Optional* | :heavy_minus_sign: | The maximum duration that the session which will be created by the generated actor token should last.
By default, the duration of a session created via an actor token, lasts 30 minutes. | | \ No newline at end of file diff --git a/docs/models/operations/CreateActorTokenResponse.md b/docs/models/operations/CreateActorTokenResponse.md index 61e153a..37357dc 100644 --- a/docs/models/operations/CreateActorTokenResponse.md +++ b/docs/models/operations/CreateActorTokenResponse.md @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `actorToken` | [Optional](../../models/components/ActorToken.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| `actorToken` | [Optional](../../models/components/ActorToken.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/docs/models/operations/CreateAllowlistIdentifierRequestBody.md b/docs/models/operations/CreateAllowlistIdentifierRequestBody.md index dad20a9..cb09bac 100644 --- a/docs/models/operations/CreateAllowlistIdentifierRequestBody.md +++ b/docs/models/operations/CreateAllowlistIdentifierRequestBody.md @@ -6,4 +6,4 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `identifier` | *String* | :heavy_check_mark: | The identifier to be added in the allow-list.
This can be an email address, a phone number or a web3 wallet. | -| `notify_` | *Optional* | :heavy_minus_sign: | This flag denotes whether the given identifier will receive an invitation to join the application.
Note that this only works for email address and phone number identifiers. | \ No newline at end of file +| `notify_` | *Optional* | :heavy_minus_sign: | This flag denotes whether the given identifier will receive an invitation to join the application.
Note that this only works for email address and phone number identifiers. | \ No newline at end of file diff --git a/docs/models/operations/CreateAllowlistIdentifierResponse.md b/docs/models/operations/CreateAllowlistIdentifierResponse.md index a1b3f19..500e1c1 100644 --- a/docs/models/operations/CreateAllowlistIdentifierResponse.md +++ b/docs/models/operations/CreateAllowlistIdentifierResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `allowlistIdentifier` | [Optional](../../models/components/AllowlistIdentifier.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `allowlistIdentifier` | [Optional](../../models/components/AllowlistIdentifier.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/docs/models/operations/CreateBlocklistIdentifierResponse.md b/docs/models/operations/CreateBlocklistIdentifierResponse.md index b6f14b6..e3fab1f 100644 --- a/docs/models/operations/CreateBlocklistIdentifierResponse.md +++ b/docs/models/operations/CreateBlocklistIdentifierResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `blocklistIdentifier` | [Optional](../../models/components/BlocklistIdentifier.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `blocklistIdentifier` | [Optional](../../models/components/BlocklistIdentifier.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/docs/models/operations/CreateEmailAddressRequestBody.md b/docs/models/operations/CreateEmailAddressRequestBody.md index 5d32bba..c02a8aa 100644 --- a/docs/models/operations/CreateEmailAddressRequestBody.md +++ b/docs/models/operations/CreateEmailAddressRequestBody.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `userId` | *Optional* | :heavy_minus_sign: | The ID representing the user | -| `emailAddress` | *Optional* | :heavy_minus_sign: | The new email address. Must adhere to the RFC 5322 specification for email address format. | -| `verified` | *JsonNullable* | :heavy_minus_sign: | When created, the email address will be marked as verified. | -| `primary` | *JsonNullable* | :heavy_minus_sign: | Create this email address as the primary email address for the user.
Default: false, unless it is the first email address. | \ No newline at end of file +| `userId` | *Optional* | :heavy_minus_sign: | The ID representing the user | +| `emailAddress` | *Optional* | :heavy_minus_sign: | The new email address. Must adhere to the RFC 5322 specification for email address format. | +| `verified` | *JsonNullable* | :heavy_minus_sign: | When created, the email address will be marked as verified. | +| `primary` | *JsonNullable* | :heavy_minus_sign: | Create this email address as the primary email address for the user.
Default: false, unless it is the first email address. | \ No newline at end of file diff --git a/docs/models/operations/CreateEmailAddressResponse.md b/docs/models/operations/CreateEmailAddressResponse.md index 581622f..a063c98 100644 --- a/docs/models/operations/CreateEmailAddressResponse.md +++ b/docs/models/operations/CreateEmailAddressResponse.md @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `emailAddress` | [Optional](../../models/components/EmailAddress.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| `emailAddress` | [Optional](../../models/components/EmailAddress.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/docs/models/operations/CreateInvitationRequestBody.md b/docs/models/operations/CreateInvitationRequestBody.md index 07bf90e..216d47a 100644 --- a/docs/models/operations/CreateInvitationRequestBody.md +++ b/docs/models/operations/CreateInvitationRequestBody.md @@ -8,7 +8,7 @@ Required parameters | Field | Type | Required | Description | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `emailAddress` | *String* | :heavy_check_mark: | The email address the invitation will be sent to | -| `publicMetadata` | [Optional](../../models/operations/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. | -| `redirectUrl` | *Optional* | :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. | -| `notify_` | *JsonNullable* | :heavy_minus_sign: | Optional flag which denotes whether an email invitation should be sent to the given email address.
Defaults to true. | -| `ignoreExisting` | *JsonNullable* | :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. | \ No newline at end of file +| `publicMetadata` | [Optional](../../models/operations/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. | +| `redirectUrl` | *Optional* | :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. | +| `notify_` | *JsonNullable* | :heavy_minus_sign: | Optional flag which denotes whether an email invitation should be sent to the given email address.
Defaults to true. | +| `ignoreExisting` | *JsonNullable* | :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. | \ No newline at end of file diff --git a/docs/models/operations/CreateInvitationResponse.md b/docs/models/operations/CreateInvitationResponse.md index ff0b44a..f29e43c 100644 --- a/docs/models/operations/CreateInvitationResponse.md +++ b/docs/models/operations/CreateInvitationResponse.md @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `invitation` | [Optional](../../models/components/Invitation.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| `invitation` | [Optional](../../models/components/Invitation.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/docs/models/operations/CreateJWTTemplateRequestBody.md b/docs/models/operations/CreateJWTTemplateRequestBody.md index 9e14cdc..5f0ab31 100644 --- a/docs/models/operations/CreateJWTTemplateRequestBody.md +++ b/docs/models/operations/CreateJWTTemplateRequestBody.md @@ -3,12 +3,12 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | -| `name` | *Optional* | :heavy_minus_sign: | JWT template name | -| `claims` | [Optional](../../models/operations/Claims.md) | :heavy_minus_sign: | JWT template claims in JSON format | -| `lifetime` | *JsonNullable* | :heavy_minus_sign: | JWT token lifetime | -| `allowedClockSkew` | *JsonNullable* | :heavy_minus_sign: | JWT token allowed clock skew | -| `customSigningKey` | *Optional* | :heavy_minus_sign: | Whether a custom signing key/algorithm is also provided for this template | -| `signingAlgorithm` | *JsonNullable* | :heavy_minus_sign: | The custom signing algorithm to use when minting JWTs | -| `signingKey` | *JsonNullable* | :heavy_minus_sign: | The custom signing private key to use when minting JWTs | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `name` | *Optional* | :heavy_minus_sign: | JWT template name | +| `claims` | [Optional](../../models/operations/Claims.md) | :heavy_minus_sign: | JWT template claims in JSON format | +| `lifetime` | *JsonNullable* | :heavy_minus_sign: | JWT token lifetime | +| `allowedClockSkew` | *JsonNullable* | :heavy_minus_sign: | JWT token allowed clock skew | +| `customSigningKey` | *Optional* | :heavy_minus_sign: | Whether a custom signing key/algorithm is also provided for this template | +| `signingAlgorithm` | *JsonNullable* | :heavy_minus_sign: | The custom signing algorithm to use when minting JWTs | +| `signingKey` | *JsonNullable* | :heavy_minus_sign: | The custom signing private key to use when minting JWTs | \ No newline at end of file diff --git a/docs/models/operations/CreateJWTTemplateResponse.md b/docs/models/operations/CreateJWTTemplateResponse.md index 3d9366c..052a6ea 100644 --- a/docs/models/operations/CreateJWTTemplateResponse.md +++ b/docs/models/operations/CreateJWTTemplateResponse.md @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `jwtTemplate` | [Optional](../../models/components/JWTTemplate.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| `jwtTemplate` | [Optional](../../models/components/JWTTemplate.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/docs/models/operations/CreateOAuthApplicationRequestBody.md b/docs/models/operations/CreateOAuthApplicationRequestBody.md index 4086744..e7c68d8 100644 --- a/docs/models/operations/CreateOAuthApplicationRequestBody.md +++ b/docs/models/operations/CreateOAuthApplicationRequestBody.md @@ -7,5 +7,5 @@ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `name` | *String* | :heavy_check_mark: | The name of the new OAuth application | | | `callbackUrl` | *String* | :heavy_check_mark: | The callback URL of the new OAuth application | | -| `scopes` | *Optional* | :heavy_minus_sign: | Define the allowed scopes for the new OAuth applications that dictate the user payload of the OAuth user info endpoint. Available scopes are `profile`, `email`, `public_metadata`, `private_metadata`. Provide the requested scopes as a string, separated by spaces. | profile email public_metadata | -| `public_` | *Optional* | :heavy_minus_sign: | If true, this client is public and cannot securely store a client secret.
Only the authorization code flow with proof key for code exchange (PKCE) may be used.
Public clients cannot be updated to be confidential clients, and vice versa. | | \ No newline at end of file +| `scopes` | *Optional* | :heavy_minus_sign: | Define the allowed scopes for the new OAuth applications that dictate the user payload of the OAuth user info endpoint. Available scopes are `profile`, `email`, `public_metadata`, `private_metadata`. Provide the requested scopes as a string, separated by spaces. | profile email public_metadata | +| `public_` | *Optional* | :heavy_minus_sign: | If true, this client is public and cannot securely store a client secret.
Only the authorization code flow with proof key for code exchange (PKCE) may be used.
Public clients cannot be updated to be confidential clients, and vice versa. | | \ No newline at end of file diff --git a/docs/models/operations/CreateOAuthApplicationResponse.md b/docs/models/operations/CreateOAuthApplicationResponse.md index 6470b12..84c9aca 100644 --- a/docs/models/operations/CreateOAuthApplicationResponse.md +++ b/docs/models/operations/CreateOAuthApplicationResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `oAuthApplicationWithSecret` | [Optional](../../models/components/OAuthApplicationWithSecret.md) | :heavy_minus_sign: | An OAuth application with client secret | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `oAuthApplicationWithSecret` | [Optional](../../models/components/OAuthApplicationWithSecret.md) | :heavy_minus_sign: | An OAuth application with client secret | \ No newline at end of file diff --git a/docs/models/operations/CreateOrganizationInvitationBulkRequest.md b/docs/models/operations/CreateOrganizationInvitationBulkRequest.md index 1f0a3ef..142b953 100644 --- a/docs/models/operations/CreateOrganizationInvitationBulkRequest.md +++ b/docs/models/operations/CreateOrganizationInvitationBulkRequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `organizationId` | *String* | :heavy_check_mark: | The organization ID. | -| `requestBody` | List<[com.clerk.backend_api.models.operations.RequestBody](../../models/operations/RequestBody.md)> | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | ----------------------------------------------------------- | +| `organizationId` | *String* | :heavy_check_mark: | The organization ID. | +| `requestBody` | List<[RequestBody](../../models/operations/RequestBody.md)> | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/CreateOrganizationInvitationBulkResponse.md b/docs/models/operations/CreateOrganizationInvitationBulkResponse.md index 3bfa8e6..a9e40c0 100644 --- a/docs/models/operations/CreateOrganizationInvitationBulkResponse.md +++ b/docs/models/operations/CreateOrganizationInvitationBulkResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `organizationInvitations` | [Optional](../../models/components/OrganizationInvitations.md) | :heavy_minus_sign: | A list of organization invitations | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `organizationInvitations` | [Optional](../../models/components/OrganizationInvitations.md) | :heavy_minus_sign: | A list of organization invitations | \ No newline at end of file diff --git a/docs/models/operations/CreateOrganizationInvitationRequest.md b/docs/models/operations/CreateOrganizationInvitationRequest.md index 59e3d10..ad86a2b 100644 --- a/docs/models/operations/CreateOrganizationInvitationRequest.md +++ b/docs/models/operations/CreateOrganizationInvitationRequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `organizationId` | *String* | :heavy_check_mark: | The ID of the organization for which to send the invitation | -| `requestBody` | [com.clerk.backend_api.models.operations.CreateOrganizationInvitationRequestBody](../../models/operations/CreateOrganizationInvitationRequestBody.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | +| `organizationId` | *String* | :heavy_check_mark: | The ID of the organization for which to send the invitation | +| `requestBody` | [CreateOrganizationInvitationRequestBody](../../models/operations/CreateOrganizationInvitationRequestBody.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/CreateOrganizationInvitationRequestBody.md b/docs/models/operations/CreateOrganizationInvitationRequestBody.md index 7e35283..f1074ca 100644 --- a/docs/models/operations/CreateOrganizationInvitationRequestBody.md +++ b/docs/models/operations/CreateOrganizationInvitationRequestBody.md @@ -3,11 +3,11 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `emailAddress` | *String* | :heavy_check_mark: | The email address of the new member that is going to be invited to the organization | -| `inviterUserId` | *String* | :heavy_check_mark: | The ID of the user that invites the new member to the organization.
Must be an administrator in the organization. | -| `role` | *String* | :heavy_check_mark: | The role of the new member in the organization | -| `publicMetadata` | [Optional](../../models/operations/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. | -| `privateMetadata` | [Optional](../../models/operations/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. | -| `redirectUrl` | *Optional* | :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. | \ No newline at end of file +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | +| `emailAddress` | *String* | :heavy_check_mark: | The email address of the new member that is going to be invited to the organization | +| `inviterUserId` | *String* | :heavy_check_mark: | The ID of the user that invites the new member to the organization.
Must be an administrator in the organization. | +| `role` | *String* | :heavy_check_mark: | The role of the new member in the organization | +| `publicMetadata` | [Optional](../../models/operations/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. | +| `privateMetadata` | [Optional](../../models/operations/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. | +| `redirectUrl` | *Optional* | :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. | \ No newline at end of file diff --git a/docs/models/operations/CreateOrganizationInvitationResponse.md b/docs/models/operations/CreateOrganizationInvitationResponse.md index 8b6f9fb..209dfdf 100644 --- a/docs/models/operations/CreateOrganizationInvitationResponse.md +++ b/docs/models/operations/CreateOrganizationInvitationResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `organizationInvitation` | [Optional](../../models/components/OrganizationInvitation.md) | :heavy_minus_sign: | An organization invitation | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `organizationInvitation` | [Optional](../../models/components/OrganizationInvitation.md) | :heavy_minus_sign: | An organization invitation | \ No newline at end of file diff --git a/docs/models/operations/CreateOrganizationMembershipRequest.md b/docs/models/operations/CreateOrganizationMembershipRequest.md index 8d27eba..acd17c3 100644 --- a/docs/models/operations/CreateOrganizationMembershipRequest.md +++ b/docs/models/operations/CreateOrganizationMembershipRequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -| `organizationId` | *String* | :heavy_check_mark: | The ID of the organization where the new membership will be created | -| `requestBody` | [com.clerk.backend_api.models.operations.CreateOrganizationMembershipRequestBody](../../models/operations/CreateOrganizationMembershipRequestBody.md) | :heavy_check_mark: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | +| `organizationId` | *String* | :heavy_check_mark: | The ID of the organization where the new membership will be created | +| `requestBody` | [CreateOrganizationMembershipRequestBody](../../models/operations/CreateOrganizationMembershipRequestBody.md) | :heavy_check_mark: | N/A | \ No newline at end of file diff --git a/docs/models/operations/CreateOrganizationMembershipResponse.md b/docs/models/operations/CreateOrganizationMembershipResponse.md index e2d08cc..3a3295b 100644 --- a/docs/models/operations/CreateOrganizationMembershipResponse.md +++ b/docs/models/operations/CreateOrganizationMembershipResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `organizationMembership` | [Optional](../../models/components/OrganizationMembership.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `organizationMembership` | [Optional](../../models/components/OrganizationMembership.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/docs/models/operations/CreateOrganizationRequestBody.md b/docs/models/operations/CreateOrganizationRequestBody.md index 0373d23..6df38c7 100644 --- a/docs/models/operations/CreateOrganizationRequestBody.md +++ b/docs/models/operations/CreateOrganizationRequestBody.md @@ -3,11 +3,11 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `name` | *String* | :heavy_check_mark: | The name of the new organization | -| `createdBy` | *String* | :heavy_check_mark: | The ID of the User who will become the administrator for the new organization | -| `privateMetadata` | [Optional](../../models/operations/CreateOrganizationPrivateMetadata.md) | :heavy_minus_sign: | Metadata saved on the organization, accessible only from the Backend API | -| `publicMetadata` | [Optional](../../models/operations/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 | -| `slug` | *Optional* | :heavy_minus_sign: | A slug for the new organization.
Can contain only lowercase alphanumeric characters and the dash "-".
Must be unique for the instance. | -| `maxAllowedMemberships` | *Optional* | :heavy_minus_sign: | The maximum number of memberships allowed for this organization | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | +| `name` | *String* | :heavy_check_mark: | The name of the new organization | +| `createdBy` | *String* | :heavy_check_mark: | The ID of the User who will become the administrator for the new organization | +| `privateMetadata` | [Optional](../../models/operations/CreateOrganizationPrivateMetadata.md) | :heavy_minus_sign: | Metadata saved on the organization, accessible only from the Backend API | +| `publicMetadata` | [Optional](../../models/operations/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 | +| `slug` | *Optional* | :heavy_minus_sign: | A slug for the new organization.
Can contain only lowercase alphanumeric characters and the dash "-".
Must be unique for the instance. | +| `maxAllowedMemberships` | *Optional* | :heavy_minus_sign: | The maximum number of memberships allowed for this organization | \ No newline at end of file diff --git a/docs/models/operations/CreateOrganizationResponse.md b/docs/models/operations/CreateOrganizationResponse.md index 84c9498..9b2f6a7 100644 --- a/docs/models/operations/CreateOrganizationResponse.md +++ b/docs/models/operations/CreateOrganizationResponse.md @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `organization` | [Optional](../../models/components/Organization.md) | :heavy_minus_sign: | An organization | \ No newline at end of file +| `organization` | [Optional](../../models/components/Organization.md) | :heavy_minus_sign: | An organization | \ No newline at end of file diff --git a/docs/models/operations/CreatePhoneNumberRequestBody.md b/docs/models/operations/CreatePhoneNumberRequestBody.md index beea2c2..3817227 100644 --- a/docs/models/operations/CreatePhoneNumberRequestBody.md +++ b/docs/models/operations/CreatePhoneNumberRequestBody.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `userId` | *Optional* | :heavy_minus_sign: | The ID representing the user | -| `phoneNumber` | *Optional* | :heavy_minus_sign: | The new phone number. Must adhere to the E.164 standard for phone number format. | -| `verified` | *JsonNullable* | :heavy_minus_sign: | When created, the phone number will be marked as verified. | -| `primary` | *JsonNullable* | :heavy_minus_sign: | Create this phone number as the primary phone number for the user.
Default: false, unless it is the first phone number. | -| `reservedForSecondFactor` | *JsonNullable* | :heavy_minus_sign: | Create this phone number as reserved for multi-factor authentication.
The phone number must also be verified.
If there are no other reserved second factors, the phone number will be set as the default second factor. | \ No newline at end of file +| `userId` | *Optional* | :heavy_minus_sign: | The ID representing the user | +| `phoneNumber` | *Optional* | :heavy_minus_sign: | The new phone number. Must adhere to the E.164 standard for phone number format. | +| `verified` | *JsonNullable* | :heavy_minus_sign: | When created, the phone number will be marked as verified. | +| `primary` | *JsonNullable* | :heavy_minus_sign: | Create this phone number as the primary phone number for the user.
Default: false, unless it is the first phone number. | +| `reservedForSecondFactor` | *JsonNullable* | :heavy_minus_sign: | Create this phone number as reserved for multi-factor authentication.
The phone number must also be verified.
If there are no other reserved second factors, the phone number will be set as the default second factor. | \ No newline at end of file diff --git a/docs/models/operations/CreatePhoneNumberResponse.md b/docs/models/operations/CreatePhoneNumberResponse.md index df2862b..cff9d44 100644 --- a/docs/models/operations/CreatePhoneNumberResponse.md +++ b/docs/models/operations/CreatePhoneNumberResponse.md @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `phoneNumber` | [Optional](../../models/components/PhoneNumber.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| `phoneNumber` | [Optional](../../models/components/PhoneNumber.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/docs/models/operations/CreateRedirectURLRequestBody.md b/docs/models/operations/CreateRedirectURLRequestBody.md index f318418..4cf5314 100644 --- a/docs/models/operations/CreateRedirectURLRequestBody.md +++ b/docs/models/operations/CreateRedirectURLRequestBody.md @@ -5,4 +5,4 @@ | Field | Type | Required | Description | | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| `url` | *Optional* | :heavy_minus_sign: | The full url value prefixed with `https://` or a custom scheme e.g. `"https://my-app.com/oauth-callback"` or `"my-app://oauth-callback"` | \ No newline at end of file +| `url` | *Optional* | :heavy_minus_sign: | The full url value prefixed with `https://` or a custom scheme e.g. `"https://my-app.com/oauth-callback"` or `"my-app://oauth-callback"` | \ No newline at end of file diff --git a/docs/models/operations/CreateRedirectURLResponse.md b/docs/models/operations/CreateRedirectURLResponse.md index 9b771d8..cb02ec9 100644 --- a/docs/models/operations/CreateRedirectURLResponse.md +++ b/docs/models/operations/CreateRedirectURLResponse.md @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `redirectURL` | [Optional](../../models/components/RedirectURL.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| `redirectURL` | [Optional](../../models/components/RedirectURL.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/docs/models/operations/CreateSAMLConnectionRequestBody.md b/docs/models/operations/CreateSAMLConnectionRequestBody.md index ee0c77f..b9b9762 100644 --- a/docs/models/operations/CreateSAMLConnectionRequestBody.md +++ b/docs/models/operations/CreateSAMLConnectionRequestBody.md @@ -3,14 +3,14 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| `name` | *String* | :heavy_check_mark: | The name to use as a label for this SAML Connection | -| `domain` | *String* | :heavy_check_mark: | The domain of your organization. Sign in flows using an email with this domain, will use this SAML Connection. | -| `provider` | [com.clerk.backend_api.models.operations.Provider](../../models/operations/Provider.md) | :heavy_check_mark: | The IdP provider of the connection. | -| `idpEntityId` | *JsonNullable* | :heavy_minus_sign: | The Entity ID as provided by the IdP | -| `idpSsoUrl` | *JsonNullable* | :heavy_minus_sign: | The Single-Sign On URL as provided by the IdP | -| `idpCertificate` | *JsonNullable* | :heavy_minus_sign: | The X.509 certificate as provided by the IdP | -| `idpMetadataUrl` | *JsonNullable* | :heavy_minus_sign: | The URL which serves the IdP metadata. If present, it takes priority over the corresponding individual properties | -| `idpMetadata` | *JsonNullable* | :heavy_minus_sign: | The XML content of the IdP metadata file. If present, it takes priority over the corresponding individual properties | -| `attributeMapping` | [JsonNullable](../../models/operations/AttributeMapping.md) | :heavy_minus_sign: | Define the attribute name mapping between Identity Provider and Clerk's user properties | \ No newline at end of file +| Field | Type | Required | Description | +| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | +| `name` | *String* | :heavy_check_mark: | The name to use as a label for this SAML Connection | +| `domain` | *String* | :heavy_check_mark: | The domain of your organization. Sign in flows using an email with this domain, will use this SAML Connection. | +| `provider` | [Provider](../../models/operations/Provider.md) | :heavy_check_mark: | The IdP provider of the connection. | +| `idpEntityId` | *JsonNullable* | :heavy_minus_sign: | The Entity ID as provided by the IdP | +| `idpSsoUrl` | *JsonNullable* | :heavy_minus_sign: | The Single-Sign On URL as provided by the IdP | +| `idpCertificate` | *JsonNullable* | :heavy_minus_sign: | The X.509 certificate as provided by the IdP | +| `idpMetadataUrl` | *JsonNullable* | :heavy_minus_sign: | The URL which serves the IdP metadata. If present, it takes priority over the corresponding individual properties | +| `idpMetadata` | *JsonNullable* | :heavy_minus_sign: | The XML content of the IdP metadata file. If present, it takes priority over the corresponding individual properties | +| `attributeMapping` | [JsonNullable](../../models/operations/AttributeMapping.md) | :heavy_minus_sign: | Define the attribute name mapping between Identity Provider and Clerk's user properties | \ No newline at end of file diff --git a/docs/models/operations/CreateSAMLConnectionResponse.md b/docs/models/operations/CreateSAMLConnectionResponse.md index b2ee68f..4df6509 100644 --- a/docs/models/operations/CreateSAMLConnectionResponse.md +++ b/docs/models/operations/CreateSAMLConnectionResponse.md @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `samlConnection` | [Optional](../../models/components/SAMLConnection.md) | :heavy_minus_sign: | A SAML Connection | \ No newline at end of file +| `samlConnection` | [Optional](../../models/components/SAMLConnection.md) | :heavy_minus_sign: | A SAML Connection | \ No newline at end of file diff --git a/docs/models/operations/CreateSessionTokenFromTemplateResponse.md b/docs/models/operations/CreateSessionTokenFromTemplateResponse.md index aec48b3..9755a5d 100644 --- a/docs/models/operations/CreateSessionTokenFromTemplateResponse.md +++ b/docs/models/operations/CreateSessionTokenFromTemplateResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `object` | [Optional](../../models/operations/CreateSessionTokenFromTemplateResponseBody.md) | :heavy_minus_sign: | OK | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `object` | [Optional](../../models/operations/CreateSessionTokenFromTemplateResponseBody.md) | :heavy_minus_sign: | OK | \ No newline at end of file diff --git a/docs/models/operations/CreateSessionTokenFromTemplateResponseBody.md b/docs/models/operations/CreateSessionTokenFromTemplateResponseBody.md index 620952f..5198c66 100644 --- a/docs/models/operations/CreateSessionTokenFromTemplateResponseBody.md +++ b/docs/models/operations/CreateSessionTokenFromTemplateResponseBody.md @@ -5,7 +5,7 @@ OK ## Fields -| Field | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | -| `object` | [Optional](../../models/operations/Object.md) | :heavy_minus_sign: | N/A | -| `jwt` | *Optional* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | +| `object` | [Optional](../../models/operations/Object.md) | :heavy_minus_sign: | N/A | +| `jwt` | *Optional* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/CreateSignInTokenRequestBody.md b/docs/models/operations/CreateSignInTokenRequestBody.md index 4639d10..9c57c07 100644 --- a/docs/models/operations/CreateSignInTokenRequestBody.md +++ b/docs/models/operations/CreateSignInTokenRequestBody.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `userId` | *Optional* | :heavy_minus_sign: | The ID of the user that can use the newly created sign in token | -| `expiresInSeconds` | *Optional* | :heavy_minus_sign: | Optional parameter to specify the life duration of the sign in token in seconds.
By default, the duration is 30 days. | \ No newline at end of file +| `userId` | *Optional* | :heavy_minus_sign: | The ID of the user that can use the newly created sign in token | +| `expiresInSeconds` | *Optional* | :heavy_minus_sign: | Optional parameter to specify the life duration of the sign in token in seconds.
By default, the duration is 30 days. | \ No newline at end of file diff --git a/docs/models/operations/CreateSignInTokenResponse.md b/docs/models/operations/CreateSignInTokenResponse.md index 2cbc428..7bff320 100644 --- a/docs/models/operations/CreateSignInTokenResponse.md +++ b/docs/models/operations/CreateSignInTokenResponse.md @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `signInToken` | [Optional](../../models/components/SignInToken.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| `signInToken` | [Optional](../../models/components/SignInToken.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/docs/models/operations/CreateSvixAppResponse.md b/docs/models/operations/CreateSvixAppResponse.md index 1b63e3e..bfc1f7a 100644 --- a/docs/models/operations/CreateSvixAppResponse.md +++ b/docs/models/operations/CreateSvixAppResponse.md @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `svixURL` | [Optional](../../models/components/SvixURL.md) | :heavy_minus_sign: | Response that contains a temporary Svix URL to access management dashboard | \ No newline at end of file +| `svixURL` | [Optional](../../models/components/SvixURL.md) | :heavy_minus_sign: | Response that contains a temporary Svix URL to access management dashboard | \ No newline at end of file diff --git a/docs/models/operations/CreateTestingTokenResponse.md b/docs/models/operations/CreateTestingTokenResponse.md index 246ba0f..8636e08 100644 --- a/docs/models/operations/CreateTestingTokenResponse.md +++ b/docs/models/operations/CreateTestingTokenResponse.md @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `testingToken` | [Optional](../../models/components/TestingToken.md) | :heavy_minus_sign: | A Testing Token | \ No newline at end of file +| `testingToken` | [Optional](../../models/components/TestingToken.md) | :heavy_minus_sign: | A Testing Token | \ No newline at end of file diff --git a/docs/models/operations/CreateUserRequestBody.md b/docs/models/operations/CreateUserRequestBody.md index ca2617c..3a62267 100644 --- a/docs/models/operations/CreateUserRequestBody.md +++ b/docs/models/operations/CreateUserRequestBody.md @@ -5,21 +5,21 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `externalId` | *JsonNullable* | :heavy_minus_sign: | The ID of the user as used in your external systems or your previous authentication solution.
Must be unique across your instance. | -| `firstName` | *JsonNullable* | :heavy_minus_sign: | The first name to assign to the user | -| `lastName` | *JsonNullable* | :heavy_minus_sign: | The last name to assign to the user | +| `externalId` | *JsonNullable* | :heavy_minus_sign: | The ID of the user as used in your external systems or your previous authentication solution.
Must be unique across your instance. | +| `firstName` | *JsonNullable* | :heavy_minus_sign: | The first name to assign to the user | +| `lastName` | *JsonNullable* | :heavy_minus_sign: | The last name to assign to the user | | `emailAddress` | List<*String*> | :heavy_minus_sign: | Email addresses to add to the user.
Must be unique across your instance.
The first email address will be set as the user's primary email address. | | `phoneNumber` | List<*String*> | :heavy_minus_sign: | Phone numbers to add to the user.
Must be unique across your instance.
The first phone number will be set as the user's primary phone number. | | `web3Wallet` | List<*String*> | :heavy_minus_sign: | Web3 wallets to add to the user.
Must be unique across your instance.
The first wallet will be set as the user's primary wallet. | -| `username` | *JsonNullable* | :heavy_minus_sign: | The username to give to the user.
It must be unique across your instance. | -| `password` | *JsonNullable* | :heavy_minus_sign: | The plaintext password to give the user.
Must be at least 8 characters long, and can not be in any list of hacked passwords. | -| `passwordDigest` | *Optional* | :heavy_minus_sign: | In case you already have the password digests and not the passwords, you can use them for the newly created user via this property.
The digests should be generated with one of the supported algorithms.
The hashing algorithm can be specified using the `password_hasher` property. | -| `passwordHasher` | [Optional](../../models/operations/PasswordHasher.md) | :heavy_minus_sign: | The hashing algorithm that was used to generate the password digest.
The algorithms we support at the moment are [bcrypt](https://en.wikipedia.org/wiki/Bcrypt), [bcrypt_sha256_django](https://docs.djangoproject.com/en/4.0/topics/auth/passwords/),
[md5](https://en.wikipedia.org/wiki/MD5), pbkdf2_sha256, pbkdf2_sha512, [pbkdf2_sha256_django](https://docs.djangoproject.com/en/4.0/topics/auth/passwords/),
[phpass](https://www.openwall.com/phpass/), [scrypt_firebase](https://firebaseopensource.com/projects/firebase/scrypt/),
[scrypt_werkzeug](https://werkzeug.palletsprojects.com/en/3.0.x/utils/#werkzeug.security.generate_password_hash), [sha256](https://en.wikipedia.org/wiki/SHA-2)
and the [argon2](https://argon2.online/) variants argon2i and argon2id.

If you need support for any particular hashing algorithm, [please let us know](https://clerk.com/support).

Note: for password hashers considered insecure (at this moment MD5 and SHA256), the corresponding user password hashes will be transparently migrated to Bcrypt (a secure hasher) upon the user's first successful password sign in.
Insecure schemes are marked with `(insecure)` in the list below.

Each of the supported hashers expects the incoming digest to be in a particular format. Specifically:

**bcrypt:** The digest should be of the following form:

`$$$`

**bcrypt_sha256_django:** This is the Django-specific variant of Bcrypt, using SHA256 hashing function. The format should be as follows (as exported from Django):

`bcrypt_sha256$$$$`

**md5** (insecure): The digest should follow the regular form e.g.:

`5f4dcc3b5aa765d61d8327deb882cf99`

**pbkdf2_sha256:** This is the PBKDF2 algorithm using the SHA256 hashing function. The format should be as follows:

`pbkdf2_sha256$$$`

Note: Both the salt and the hash are expected to be base64-encoded.

**pbkdf2_sha512:** This is the PBKDF2 algorithm using the SHA512 hashing function. The format should be as follows:

`pbkdf2_sha512$$$`

_iterations:_ The number of iterations used. Must be an integer less than 420000.
_salt:_ The salt used when generating the hash. Must be less than 1024 bytes.
_hash:_ The hex-encoded hash. Must have been generated with a key length less than 1024 bytes.

**pbkdf2_sha256_django:** This is the Django-specific variant of PBKDF2 and the digest should have the following format (as exported from Django):

`pbkdf2_sha256$$$`

Note: The salt is expected to be un-encoded, the hash is expected base64-encoded.

**pbkdf2_sha1:** This is similar to pkbdf2_sha256_django, but with two differences:
1. uses sha1 instead of sha256
2. accepts the hash as a hex-encoded string

The format is the following:

`pbkdf2_sha1$$$`

**phpass:** Portable public domain password hashing framework for use in PHP applications. Digests hashed with phpass have the following sections:

The format is the following:

`$P$`

- $P$ is the prefix used to identify phpass hashes.
- rounds is a single character encoding a 6-bit integer representing the number of rounds used.
- salt is eight characters drawn from [./0-9A-Za-z], providing a 48-bit salt.
- checksum is 22 characters drawn from the same set, encoding the 128-bit checksum with MD5.

**scrypt_firebase:** The Firebase-specific variant of scrypt.
The value is expected to have 6 segments separated by the $ character and include the following information:

_hash:_ The actual Base64 hash. This can be retrieved when exporting the user from Firebase.
_salt:_ The salt used to generate the above hash. Again, this is given when exporting the user.
_signer key:_ The base64 encoded signer key.
_salt separator:_ The base64 encoded salt separator.
_rounds:_ The number of rounds the algorithm needs to run.
_memory cost:_ The cost of the algorithm run

The first 2 (hash and salt) are per user and can be retrieved when exporting the user from Firebase.
The other 4 values (signer key, salt separator, rounds and memory cost) are project-wide settings and can be retrieved from the project's password hash parameters.

Once you have all these, you can combine it in the following format and send this as the digest in order for Clerk to accept it:

`$$$$$`

**scrypt_werkzeug:** The Werkzeug-specific variant of scrypt.

The value is expected to have 3 segments separated by the $ character and include the following information:

_algorithm args:_ The algorithm used to generate the hash.
_salt:_ The salt used to generate the above hash.
_hash:_ The actual Base64 hash.

The algorithm args are the parameters used to generate the hash and are included in the digest.

**argon2i:** Algorithms in the argon2 family generate digests that encode the following information:

_version (v):_ The argon version, version 19 is assumed
_memory (m):_ The memory used by the algorithm (in kibibytes)
_iterations (t):_ The number of iterations to perform
_parallelism (p):_ The number of threads to use

Parts are demarcated by the `$` character, with the first part identifying the algorithm variant.
The middle part is a comma-separated list of the encoding options (memory, iterations, parallelism).
The final part is the actual digest.

`$argon2i$v=19$m=4096,t=3,p=1$4t6CL3P7YiHBtwESXawI8Hm20zJj4cs7/4/G3c187e0$m7RQFczcKr5bIR0IIxbpO2P0tyrLjf3eUW3M3QSwnLc`

**argon2id:** See the previous algorithm for an explanation of the formatting.

For the argon2id case, the value of the algorithm in the first part of the digest is `argon2id`:

`$argon2id$v=19$m=64,t=4,p=8$Z2liZXJyaXNo$iGXEpMBTDYQ8G/71tF0qGjxRHEmR3gpGULcE93zUJVU`

**sha256** (insecure): The digest should be a 64-length hex string, e.g.:

`9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08`

**sha256_salted** (insecure): The digest should be a 64-length hex string with a salt.

The format is the following:
`$`

The value is expected to have 2 segments separated by the $ character and include the following information:
_hash:_ The sha256 hash, a 64-length hex string.
_salt:_ The salt used to generate the above hash. Must be between 1 and 1024 bits. | -| `skipPasswordChecks` | *Optional* | :heavy_minus_sign: | When set to `true` all password checks are skipped.
It is recommended to use this method only when migrating plaintext passwords to Clerk.
Upon migration the user base should be prompted to pick stronger password. | -| `skipPasswordRequirement` | *Optional* | :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. | -| `totpSecret` | *Optional* | :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 | +| `username` | *JsonNullable* | :heavy_minus_sign: | The username to give to the user.
It must be unique across your instance. | +| `password` | *JsonNullable* | :heavy_minus_sign: | The plaintext password to give the user.
Must be at least 8 characters long, and can not be in any list of hacked passwords. | +| `passwordDigest` | *Optional* | :heavy_minus_sign: | In case you already have the password digests and not the passwords, you can use them for the newly created user via this property.
The digests should be generated with one of the supported algorithms.
The hashing algorithm can be specified using the `password_hasher` property. | +| `passwordHasher` | [Optional](../../models/operations/PasswordHasher.md) | :heavy_minus_sign: | The hashing algorithm that was used to generate the password digest.
The algorithms we support at the moment are [bcrypt](https://en.wikipedia.org/wiki/Bcrypt), [bcrypt_sha256_django](https://docs.djangoproject.com/en/4.0/topics/auth/passwords/),
[md5](https://en.wikipedia.org/wiki/MD5), pbkdf2_sha256, pbkdf2_sha512, [pbkdf2_sha256_django](https://docs.djangoproject.com/en/4.0/topics/auth/passwords/),
[phpass](https://www.openwall.com/phpass/), [scrypt_firebase](https://firebaseopensource.com/projects/firebase/scrypt/),
[scrypt_werkzeug](https://werkzeug.palletsprojects.com/en/3.0.x/utils/#werkzeug.security.generate_password_hash), [sha256](https://en.wikipedia.org/wiki/SHA-2)
and the [argon2](https://argon2.online/) variants argon2i and argon2id.

If you need support for any particular hashing algorithm, [please let us know](https://clerk.com/support).

Note: for password hashers considered insecure (at this moment MD5 and SHA256), the corresponding user password hashes will be transparently migrated to Bcrypt (a secure hasher) upon the user's first successful password sign in.
Insecure schemes are marked with `(insecure)` in the list below.

Each of the supported hashers expects the incoming digest to be in a particular format. Specifically:

**bcrypt:** The digest should be of the following form:

`$$$`

**bcrypt_sha256_django:** This is the Django-specific variant of Bcrypt, using SHA256 hashing function. The format should be as follows (as exported from Django):

`bcrypt_sha256$$$$`

**md5** (insecure): The digest should follow the regular form e.g.:

`5f4dcc3b5aa765d61d8327deb882cf99`

**pbkdf2_sha256:** This is the PBKDF2 algorithm using the SHA256 hashing function. The format should be as follows:

`pbkdf2_sha256$$$`

Note: Both the salt and the hash are expected to be base64-encoded.

**pbkdf2_sha512:** This is the PBKDF2 algorithm using the SHA512 hashing function. The format should be as follows:

`pbkdf2_sha512$$$`

_iterations:_ The number of iterations used. Must be an integer less than 420000.
_salt:_ The salt used when generating the hash. Must be less than 1024 bytes.
_hash:_ The hex-encoded hash. Must have been generated with a key length less than 1024 bytes.

**pbkdf2_sha256_django:** This is the Django-specific variant of PBKDF2 and the digest should have the following format (as exported from Django):

`pbkdf2_sha256$$$`

Note: The salt is expected to be un-encoded, the hash is expected base64-encoded.

**pbkdf2_sha1:** This is similar to pkbdf2_sha256_django, but with two differences:
1. uses sha1 instead of sha256
2. accepts the hash as a hex-encoded string

The format is the following:

`pbkdf2_sha1$$$`

**phpass:** Portable public domain password hashing framework for use in PHP applications. Digests hashed with phpass have the following sections:

The format is the following:

`$P$`

- $P$ is the prefix used to identify phpass hashes.
- rounds is a single character encoding a 6-bit integer representing the number of rounds used.
- salt is eight characters drawn from [./0-9A-Za-z], providing a 48-bit salt.
- checksum is 22 characters drawn from the same set, encoding the 128-bit checksum with MD5.

**scrypt_firebase:** The Firebase-specific variant of scrypt.
The value is expected to have 6 segments separated by the $ character and include the following information:

_hash:_ The actual Base64 hash. This can be retrieved when exporting the user from Firebase.
_salt:_ The salt used to generate the above hash. Again, this is given when exporting the user.
_signer key:_ The base64 encoded signer key.
_salt separator:_ The base64 encoded salt separator.
_rounds:_ The number of rounds the algorithm needs to run.
_memory cost:_ The cost of the algorithm run

The first 2 (hash and salt) are per user and can be retrieved when exporting the user from Firebase.
The other 4 values (signer key, salt separator, rounds and memory cost) are project-wide settings and can be retrieved from the project's password hash parameters.

Once you have all these, you can combine it in the following format and send this as the digest in order for Clerk to accept it:

`$$$$$`

**scrypt_werkzeug:** The Werkzeug-specific variant of scrypt.

The value is expected to have 3 segments separated by the $ character and include the following information:

_algorithm args:_ The algorithm used to generate the hash.
_salt:_ The salt used to generate the above hash.
_hash:_ The actual Base64 hash.

The algorithm args are the parameters used to generate the hash and are included in the digest.

**argon2i:** Algorithms in the argon2 family generate digests that encode the following information:

_version (v):_ The argon version, version 19 is assumed
_memory (m):_ The memory used by the algorithm (in kibibytes)
_iterations (t):_ The number of iterations to perform
_parallelism (p):_ The number of threads to use

Parts are demarcated by the `$` character, with the first part identifying the algorithm variant.
The middle part is a comma-separated list of the encoding options (memory, iterations, parallelism).
The final part is the actual digest.

`$argon2i$v=19$m=4096,t=3,p=1$4t6CL3P7YiHBtwESXawI8Hm20zJj4cs7/4/G3c187e0$m7RQFczcKr5bIR0IIxbpO2P0tyrLjf3eUW3M3QSwnLc`

**argon2id:** See the previous algorithm for an explanation of the formatting.

For the argon2id case, the value of the algorithm in the first part of the digest is `argon2id`:

`$argon2id$v=19$m=64,t=4,p=8$Z2liZXJyaXNo$iGXEpMBTDYQ8G/71tF0qGjxRHEmR3gpGULcE93zUJVU`

**sha256** (insecure): The digest should be a 64-length hex string, e.g.:

`9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08`

**sha256_salted** (insecure): The digest should be a 64-length hex string with a salt.

The format is the following:
`$`

The value is expected to have 2 segments separated by the $ character and include the following information:
_hash:_ The sha256 hash, a 64-length hex string.
_salt:_ The salt used to generate the above hash. Must be between 1 and 1024 bits. | +| `skipPasswordChecks` | *Optional* | :heavy_minus_sign: | When set to `true` all password checks are skipped.
It is recommended to use this method only when migrating plaintext passwords to Clerk.
Upon migration the user base should be prompted to pick stronger password. | +| `skipPasswordRequirement` | *Optional* | :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. | +| `totpSecret` | *Optional* | :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 | | `backupCodes` | List<*String*> | :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. | -| `publicMetadata` | [Optional](../../models/operations/PublicMetadata.md) | :heavy_minus_sign: | Metadata saved on the user, that is visible to both your Frontend and Backend APIs | -| `privateMetadata` | [Optional](../../models/operations/PrivateMetadata.md) | :heavy_minus_sign: | Metadata saved on the user, that is only visible to your Backend API | -| `unsafeMetadata` | [Optional](../../models/operations/UnsafeMetadata.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. | -| `createdAt` | *Optional* | :heavy_minus_sign: | A custom date/time denoting _when_ the user signed up to the application, specified in RFC3339 format (e.g. `2012-10-20T07:15:20.902Z`). | \ No newline at end of file +| `publicMetadata` | [Optional](../../models/operations/PublicMetadata.md) | :heavy_minus_sign: | Metadata saved on the user, that is visible to both your Frontend and Backend APIs | +| `privateMetadata` | [Optional](../../models/operations/PrivateMetadata.md) | :heavy_minus_sign: | Metadata saved on the user, that is only visible to your Backend API | +| `unsafeMetadata` | [Optional](../../models/operations/UnsafeMetadata.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. | +| `createdAt` | *Optional* | :heavy_minus_sign: | A custom date/time denoting _when_ the user signed up to the application, specified in RFC3339 format (e.g. `2012-10-20T07:15:20.902Z`). | \ No newline at end of file diff --git a/docs/models/operations/CreateUserResponse.md b/docs/models/operations/CreateUserResponse.md index 69f963b..f030da2 100644 --- a/docs/models/operations/CreateUserResponse.md +++ b/docs/models/operations/CreateUserResponse.md @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `user` | [Optional](../../models/components/User.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| `user` | [Optional](../../models/components/User.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/docs/models/operations/DeleteAllowlistIdentifierResponse.md b/docs/models/operations/DeleteAllowlistIdentifierResponse.md index 8f66574..2437c7d 100644 --- a/docs/models/operations/DeleteAllowlistIdentifierResponse.md +++ b/docs/models/operations/DeleteAllowlistIdentifierResponse.md @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `deletedObject` | [Optional](../../models/components/DeletedObject.md) | :heavy_minus_sign: | Deleted Object | \ No newline at end of file +| `deletedObject` | [Optional](../../models/components/DeletedObject.md) | :heavy_minus_sign: | Deleted Object | \ No newline at end of file diff --git a/docs/models/operations/DeleteBlocklistIdentifierResponse.md b/docs/models/operations/DeleteBlocklistIdentifierResponse.md index 2d2a858..c088a5c 100644 --- a/docs/models/operations/DeleteBlocklistIdentifierResponse.md +++ b/docs/models/operations/DeleteBlocklistIdentifierResponse.md @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `deletedObject` | [Optional](../../models/components/DeletedObject.md) | :heavy_minus_sign: | Deleted Object | \ No newline at end of file +| `deletedObject` | [Optional](../../models/components/DeletedObject.md) | :heavy_minus_sign: | Deleted Object | \ No newline at end of file diff --git a/docs/models/operations/DeleteDomainResponse.md b/docs/models/operations/DeleteDomainResponse.md index 45f963e..783281c 100644 --- a/docs/models/operations/DeleteDomainResponse.md +++ b/docs/models/operations/DeleteDomainResponse.md @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `deletedObject` | [Optional](../../models/components/DeletedObject.md) | :heavy_minus_sign: | Deleted Object | \ No newline at end of file +| `deletedObject` | [Optional](../../models/components/DeletedObject.md) | :heavy_minus_sign: | Deleted Object | \ No newline at end of file diff --git a/docs/models/operations/DeleteEmailAddressResponse.md b/docs/models/operations/DeleteEmailAddressResponse.md index e0d6fff..afb0389 100644 --- a/docs/models/operations/DeleteEmailAddressResponse.md +++ b/docs/models/operations/DeleteEmailAddressResponse.md @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `deletedObject` | [Optional](../../models/components/DeletedObject.md) | :heavy_minus_sign: | Deleted Object | \ No newline at end of file +| `deletedObject` | [Optional](../../models/components/DeletedObject.md) | :heavy_minus_sign: | Deleted Object | \ No newline at end of file diff --git a/docs/models/operations/DeleteJWTTemplateResponse.md b/docs/models/operations/DeleteJWTTemplateResponse.md index a6644fd..483c226 100644 --- a/docs/models/operations/DeleteJWTTemplateResponse.md +++ b/docs/models/operations/DeleteJWTTemplateResponse.md @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `deletedObject` | [Optional](../../models/components/DeletedObject.md) | :heavy_minus_sign: | Deleted Object | \ No newline at end of file +| `deletedObject` | [Optional](../../models/components/DeletedObject.md) | :heavy_minus_sign: | Deleted Object | \ No newline at end of file diff --git a/docs/models/operations/DeleteOAuthApplicationResponse.md b/docs/models/operations/DeleteOAuthApplicationResponse.md index 371d244..d1396ae 100644 --- a/docs/models/operations/DeleteOAuthApplicationResponse.md +++ b/docs/models/operations/DeleteOAuthApplicationResponse.md @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `deletedObject` | [Optional](../../models/components/DeletedObject.md) | :heavy_minus_sign: | Deleted Object | \ No newline at end of file +| `deletedObject` | [Optional](../../models/components/DeletedObject.md) | :heavy_minus_sign: | Deleted Object | \ No newline at end of file diff --git a/docs/models/operations/DeleteOrganizationLogoResponse.md b/docs/models/operations/DeleteOrganizationLogoResponse.md index 78a574a..442ba51 100644 --- a/docs/models/operations/DeleteOrganizationLogoResponse.md +++ b/docs/models/operations/DeleteOrganizationLogoResponse.md @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `organization` | [Optional](../../models/components/Organization.md) | :heavy_minus_sign: | An organization | \ No newline at end of file +| `organization` | [Optional](../../models/components/Organization.md) | :heavy_minus_sign: | An organization | \ No newline at end of file diff --git a/docs/models/operations/DeleteOrganizationMembershipResponse.md b/docs/models/operations/DeleteOrganizationMembershipResponse.md index 8403169..9857f0b 100644 --- a/docs/models/operations/DeleteOrganizationMembershipResponse.md +++ b/docs/models/operations/DeleteOrganizationMembershipResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `organizationMembership` | [Optional](../../models/components/OrganizationMembership.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `organizationMembership` | [Optional](../../models/components/OrganizationMembership.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/docs/models/operations/DeleteOrganizationResponse.md b/docs/models/operations/DeleteOrganizationResponse.md index 92c15cb..e90f6f7 100644 --- a/docs/models/operations/DeleteOrganizationResponse.md +++ b/docs/models/operations/DeleteOrganizationResponse.md @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `deletedObject` | [Optional](../../models/components/DeletedObject.md) | :heavy_minus_sign: | Deleted Object | \ No newline at end of file +| `deletedObject` | [Optional](../../models/components/DeletedObject.md) | :heavy_minus_sign: | Deleted Object | \ No newline at end of file diff --git a/docs/models/operations/DeletePhoneNumberResponse.md b/docs/models/operations/DeletePhoneNumberResponse.md index 85b58b2..0d5a275 100644 --- a/docs/models/operations/DeletePhoneNumberResponse.md +++ b/docs/models/operations/DeletePhoneNumberResponse.md @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `deletedObject` | [Optional](../../models/components/DeletedObject.md) | :heavy_minus_sign: | Deleted Object | \ No newline at end of file +| `deletedObject` | [Optional](../../models/components/DeletedObject.md) | :heavy_minus_sign: | Deleted Object | \ No newline at end of file diff --git a/docs/models/operations/DeleteRedirectURLResponse.md b/docs/models/operations/DeleteRedirectURLResponse.md index 18204d6..1c5ec8a 100644 --- a/docs/models/operations/DeleteRedirectURLResponse.md +++ b/docs/models/operations/DeleteRedirectURLResponse.md @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `deletedObject` | [Optional](../../models/components/DeletedObject.md) | :heavy_minus_sign: | Deleted Object | \ No newline at end of file +| `deletedObject` | [Optional](../../models/components/DeletedObject.md) | :heavy_minus_sign: | Deleted Object | \ No newline at end of file diff --git a/docs/models/operations/DeleteSAMLConnectionResponse.md b/docs/models/operations/DeleteSAMLConnectionResponse.md index b0c2105..7b51e1e 100644 --- a/docs/models/operations/DeleteSAMLConnectionResponse.md +++ b/docs/models/operations/DeleteSAMLConnectionResponse.md @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `deletedObject` | [Optional](../../models/components/DeletedObject.md) | :heavy_minus_sign: | Deleted Object | \ No newline at end of file +| `deletedObject` | [Optional](../../models/components/DeletedObject.md) | :heavy_minus_sign: | Deleted Object | \ No newline at end of file diff --git a/docs/models/operations/DeleteUserProfileImageResponse.md b/docs/models/operations/DeleteUserProfileImageResponse.md index c98f1b1..b28ac97 100644 --- a/docs/models/operations/DeleteUserProfileImageResponse.md +++ b/docs/models/operations/DeleteUserProfileImageResponse.md @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `user` | [Optional](../../models/components/User.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| `user` | [Optional](../../models/components/User.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/docs/models/operations/DeleteUserResponse.md b/docs/models/operations/DeleteUserResponse.md index c856514..f85df3b 100644 --- a/docs/models/operations/DeleteUserResponse.md +++ b/docs/models/operations/DeleteUserResponse.md @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `deletedObject` | [Optional](../../models/components/DeletedObject.md) | :heavy_minus_sign: | Deleted Object | \ No newline at end of file +| `deletedObject` | [Optional](../../models/components/DeletedObject.md) | :heavy_minus_sign: | Deleted Object | \ No newline at end of file diff --git a/docs/models/operations/DisableMFAResponse.md b/docs/models/operations/DisableMFAResponse.md index a38cd11..3e49c56 100644 --- a/docs/models/operations/DisableMFAResponse.md +++ b/docs/models/operations/DisableMFAResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `object` | [Optional](../../models/operations/DisableMFAResponseBody.md) | :heavy_minus_sign: | Successful operation. | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `object` | [Optional](../../models/operations/DisableMFAResponseBody.md) | :heavy_minus_sign: | Successful operation. | \ No newline at end of file diff --git a/docs/models/operations/DisableMFAResponseBody.md b/docs/models/operations/DisableMFAResponseBody.md index 51cea15..518e505 100644 --- a/docs/models/operations/DisableMFAResponseBody.md +++ b/docs/models/operations/DisableMFAResponseBody.md @@ -5,6 +5,6 @@ Successful operation. ## Fields -| Field | Type | Required | Description | -| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | -| `userId` | *Optional* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------ | ------------------ | ------------------ | ------------------ | +| `userId` | *Optional* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/GenerateSvixAuthURLResponse.md b/docs/models/operations/GenerateSvixAuthURLResponse.md index 5a3360f..290e36e 100644 --- a/docs/models/operations/GenerateSvixAuthURLResponse.md +++ b/docs/models/operations/GenerateSvixAuthURLResponse.md @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `svixURL` | [Optional](../../models/components/SvixURL.md) | :heavy_minus_sign: | Response that contains a temporary Svix URL to access management dashboard | \ No newline at end of file +| `svixURL` | [Optional](../../models/components/SvixURL.md) | :heavy_minus_sign: | Response that contains a temporary Svix URL to access management dashboard | \ No newline at end of file diff --git a/docs/models/operations/GetClientListRequest.md b/docs/models/operations/GetClientListRequest.md index 12d725b..e9677dc 100644 --- a/docs/models/operations/GetClientListRequest.md +++ b/docs/models/operations/GetClientListRequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `limit` | *Optional* | :heavy_minus_sign: | Applies a limit to the number of results returned.
Can be used for paginating the results together with `offset`. | -| `offset` | *Optional* | :heavy_minus_sign: | Skip the first `offset` results when paginating.
Needs to be an integer greater or equal to zero.
To be used in conjunction with `limit`. | \ No newline at end of file +| `limit` | *Optional* | :heavy_minus_sign: | Applies a limit to the number of results returned.
Can be used for paginating the results together with `offset`. | +| `offset` | *Optional* | :heavy_minus_sign: | Skip the first `offset` results when paginating.
Needs to be an integer greater or equal to zero.
To be used in conjunction with `limit`. | \ No newline at end of file diff --git a/docs/models/operations/GetClientListResponse.md b/docs/models/operations/GetClientListResponse.md index 0be48b6..663b019 100644 --- a/docs/models/operations/GetClientListResponse.md +++ b/docs/models/operations/GetClientListResponse.md @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `clientList` | List<[com.clerk.backend_api.models.components.Client](../../models/components/Client.md)> | :heavy_minus_sign: | Success | \ No newline at end of file +| `clientList` | List<[Client](../../models/components/Client.md)> | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/docs/models/operations/GetClientResponse.md b/docs/models/operations/GetClientResponse.md index 37cdd9e..2e91e41 100644 --- a/docs/models/operations/GetClientResponse.md +++ b/docs/models/operations/GetClientResponse.md @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `client` | [Optional](../../models/components/Client.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| `client` | [Optional](../../models/components/Client.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/docs/models/operations/GetEmailAddressResponse.md b/docs/models/operations/GetEmailAddressResponse.md index a3fe442..d284d02 100644 --- a/docs/models/operations/GetEmailAddressResponse.md +++ b/docs/models/operations/GetEmailAddressResponse.md @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `emailAddress` | [Optional](../../models/components/EmailAddress.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| `emailAddress` | [Optional](../../models/components/EmailAddress.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/docs/models/operations/GetJWTTemplateResponse.md b/docs/models/operations/GetJWTTemplateResponse.md index c2f16d0..be6b029 100644 --- a/docs/models/operations/GetJWTTemplateResponse.md +++ b/docs/models/operations/GetJWTTemplateResponse.md @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `jwtTemplate` | [Optional](../../models/components/JWTTemplate.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| `jwtTemplate` | [Optional](../../models/components/JWTTemplate.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/docs/models/operations/GetOAuthAccessTokenResponse.md b/docs/models/operations/GetOAuthAccessTokenResponse.md index c785f2c..2402520 100644 --- a/docs/models/operations/GetOAuthAccessTokenResponse.md +++ b/docs/models/operations/GetOAuthAccessTokenResponse.md @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `responseBodies` | List<[com.clerk.backend_api.models.operations.ResponseBody](../../models/operations/ResponseBody.md)> | :heavy_minus_sign: | The OAuth access token of the user, if any. | \ No newline at end of file +| `responseBodies` | List<[ResponseBody](../../models/operations/ResponseBody.md)> | :heavy_minus_sign: | The OAuth access token of the user, if any. | \ No newline at end of file diff --git a/docs/models/operations/GetOAuthApplicationResponse.md b/docs/models/operations/GetOAuthApplicationResponse.md index 60980a9..5c3d64a 100644 --- a/docs/models/operations/GetOAuthApplicationResponse.md +++ b/docs/models/operations/GetOAuthApplicationResponse.md @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `oAuthApplication` | [Optional](../../models/components/OAuthApplication.md) | :heavy_minus_sign: | An OAuth application | \ No newline at end of file +| `oAuthApplication` | [Optional](../../models/components/OAuthApplication.md) | :heavy_minus_sign: | An OAuth application | \ No newline at end of file diff --git a/docs/models/operations/GetOrganizationInvitationResponse.md b/docs/models/operations/GetOrganizationInvitationResponse.md index 73cc33b..beed689 100644 --- a/docs/models/operations/GetOrganizationInvitationResponse.md +++ b/docs/models/operations/GetOrganizationInvitationResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | -| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | -| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `organizationInvitation` | [Optional](../../models/components/OrganizationInvitation.md) | :heavy_minus_sign: | An organization invitation | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | +| `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | +| `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | +| `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | +| `organizationInvitation` | [Optional](../../models/components/OrganizationInvitation.md) | :heavy_minus_sign: | An organization invitation | \ No newline at end of file diff --git a/docs/models/operations/GetOrganizationResponse.md b/docs/models/operations/GetOrganizationResponse.md index 8a30447..f251eab 100644 --- a/docs/models/operations/GetOrganizationResponse.md +++ b/docs/models/operations/GetOrganizationResponse.md @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `organization` | [Optional](../../models/components/Organization.md) | :heavy_minus_sign: | An organization | \ No newline at end of file +| `organization` | [Optional](../../models/components/Organization.md) | :heavy_minus_sign: | An organization | \ No newline at end of file diff --git a/docs/models/operations/GetPhoneNumberResponse.md b/docs/models/operations/GetPhoneNumberResponse.md index f32c45c..8400501 100644 --- a/docs/models/operations/GetPhoneNumberResponse.md +++ b/docs/models/operations/GetPhoneNumberResponse.md @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `phoneNumber` | [Optional](../../models/components/PhoneNumber.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| `phoneNumber` | [Optional](../../models/components/PhoneNumber.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/docs/models/operations/GetPublicInterstitialRequest.md b/docs/models/operations/GetPublicInterstitialRequest.md index 4a14c6f..c59da8c 100644 --- a/docs/models/operations/GetPublicInterstitialRequest.md +++ b/docs/models/operations/GetPublicInterstitialRequest.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | -| `frontendApi` | *Optional* | :heavy_minus_sign: | The Frontend API key of your instance | -| `publishableKey` | *Optional* | :heavy_minus_sign: | The publishable key of your instance | \ No newline at end of file +| `frontendApi` | *Optional* | :heavy_minus_sign: | The Frontend API key of your instance | +| `publishableKey` | *Optional* | :heavy_minus_sign: | The publishable key of your instance | \ No newline at end of file diff --git a/docs/models/operations/GetRedirectURLResponse.md b/docs/models/operations/GetRedirectURLResponse.md index 66eab5a..98678a8 100644 --- a/docs/models/operations/GetRedirectURLResponse.md +++ b/docs/models/operations/GetRedirectURLResponse.md @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `redirectURL` | [Optional](../../models/components/RedirectURL.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| `redirectURL` | [Optional](../../models/components/RedirectURL.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/docs/models/operations/GetSAMLConnectionResponse.md b/docs/models/operations/GetSAMLConnectionResponse.md index d35aca2..a5ff7d5 100644 --- a/docs/models/operations/GetSAMLConnectionResponse.md +++ b/docs/models/operations/GetSAMLConnectionResponse.md @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `samlConnection` | [Optional](../../models/components/SAMLConnection.md) | :heavy_minus_sign: | A SAML Connection | \ No newline at end of file +| `samlConnection` | [Optional](../../models/components/SAMLConnection.md) | :heavy_minus_sign: | A SAML Connection | \ No newline at end of file diff --git a/docs/models/operations/GetSessionListRequest.md b/docs/models/operations/GetSessionListRequest.md index 7faf1cd..f2e72ee 100644 --- a/docs/models/operations/GetSessionListRequest.md +++ b/docs/models/operations/GetSessionListRequest.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `clientId` | *Optional* | :heavy_minus_sign: | List sessions for the given client | -| `userId` | *Optional* | :heavy_minus_sign: | List sessions for the given user | -| `status` | [Optional](../../models/operations/Status.md) | :heavy_minus_sign: | Filter sessions by the provided status | -| `limit` | *Optional* | :heavy_minus_sign: | Applies a limit to the number of results returned.
Can be used for paginating the results together with `offset`. | -| `offset` | *Optional* | :heavy_minus_sign: | Skip the first `offset` results when paginating.
Needs to be an integer greater or equal to zero.
To be used in conjunction with `limit`. | \ No newline at end of file +| `clientId` | *Optional* | :heavy_minus_sign: | List sessions for the given client | +| `userId` | *Optional* | :heavy_minus_sign: | List sessions for the given user | +| `status` | [Optional](../../models/operations/Status.md) | :heavy_minus_sign: | Filter sessions by the provided status | +| `limit` | *Optional* | :heavy_minus_sign: | Applies a limit to the number of results returned.
Can be used for paginating the results together with `offset`. | +| `offset` | *Optional* | :heavy_minus_sign: | Skip the first `offset` results when paginating.
Needs to be an integer greater or equal to zero.
To be used in conjunction with `limit`. | \ No newline at end of file diff --git a/docs/models/operations/GetSessionListResponse.md b/docs/models/operations/GetSessionListResponse.md index d892d20..adf4fd4 100644 --- a/docs/models/operations/GetSessionListResponse.md +++ b/docs/models/operations/GetSessionListResponse.md @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `sessionList` | List<[com.clerk.backend_api.models.components.Session](../../models/components/Session.md)> | :heavy_minus_sign: | Success | \ No newline at end of file +| `sessionList` | List<[Session](../../models/components/Session.md)> | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/docs/models/operations/GetSessionResponse.md b/docs/models/operations/GetSessionResponse.md index 477ad70..026fc3f 100644 --- a/docs/models/operations/GetSessionResponse.md +++ b/docs/models/operations/GetSessionResponse.md @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `session` | [Optional](../../models/components/Session.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| `session` | [Optional](../../models/components/Session.md) | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/docs/models/operations/GetTemplateListRequest.md b/docs/models/operations/GetTemplateListRequest.md index cd5fed0..301e0f4 100644 --- a/docs/models/operations/GetTemplateListRequest.md +++ b/docs/models/operations/GetTemplateListRequest.md @@ -3,6 +3,6 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `templateType` | [com.clerk.backend_api.models.operations.TemplateType](../../models/operations/TemplateType.md) | :heavy_check_mark: | The type of templates to list (email or SMS) | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | +| `templateType` | [TemplateType](../../models/operations/TemplateType.md) | :heavy_check_mark: | The type of templates to list (email or SMS) | \ No newline at end of file diff --git a/docs/models/operations/GetTemplateListResponse.md b/docs/models/operations/GetTemplateListResponse.md index da950a7..a085702 100644 --- a/docs/models/operations/GetTemplateListResponse.md +++ b/docs/models/operations/GetTemplateListResponse.md @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `templateList` | List<[com.clerk.backend_api.models.components.Template](../../models/components/Template.md)> | :heavy_minus_sign: | Success | \ No newline at end of file +| `templateList` | List<[Template](../../models/components/Template.md)> | :heavy_minus_sign: | Success | \ No newline at end of file diff --git a/docs/models/operations/GetTemplateRequest.md b/docs/models/operations/GetTemplateRequest.md index 7aad703..83c3011 100644 --- a/docs/models/operations/GetTemplateRequest.md +++ b/docs/models/operations/GetTemplateRequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `templateType` | [com.clerk.backend_api.models.operations.PathParamTemplateType](../../models/operations/PathParamTemplateType.md) | :heavy_check_mark: | The type of templates to retrieve (email or SMS) | -| `slug` | *String* | :heavy_check_mark: | The slug (i.e. machine-friendly name) of the template to retrieve | \ No newline at end of file +| Field | Type | Required | Description | +| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `templateType` | [PathParamTemplateType](../../models/operations/PathParamTemplateType.md) | :heavy_check_mark: | The type of templates to retrieve (email or SMS) | +| `slug` | *String* | :heavy_check_mark: | The slug (i.e. machine-friendly name) of the template to retrieve | \ No newline at end of file diff --git a/docs/models/operations/GetTemplateResponse.md b/docs/models/operations/GetTemplateResponse.md index 8bef704..9162903 100644 --- a/docs/models/operations/GetTemplateResponse.md +++ b/docs/models/operations/GetTemplateResponse.md @@ -8,4 +8,4 @@ | `contentType` | *String* | :heavy_check_mark: | HTTP response content type for this operation | | `statusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | `rawResponse` | [HttpResponse](https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpResponse.html) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `template` | [Optional](../../models/components/Template.md) | :heavy_minus_sign: | Success | \ No newline at end of file +| `template` | [Optional