From d63161d32ad97fcaec339ed0d42341f689c0d4b3 Mon Sep 17 00:00:00 2001 From: Vaggelis Yfantis Date: Fri, 1 Nov 2024 13:54:24 +0200 Subject: [PATCH] Update references to include legaAccepted and legalAcceptedAt --- .../javascript/sign-up/authenticate-with.mdx | 35 +++++++++++++++++++ .../references/javascript/sign-up/sign-up.mdx | 7 ++++ docs/references/javascript/user/user.mdx | 7 ++++ 3 files changed, 49 insertions(+) diff --git a/docs/references/javascript/sign-up/authenticate-with.mdx b/docs/references/javascript/sign-up/authenticate-with.mdx index bab387c6b3..031a72b075 100644 --- a/docs/references/javascript/sign-up/authenticate-with.mdx +++ b/docs/references/javascript/sign-up/authenticate-with.mdx @@ -58,6 +58,13 @@ function authenticateWithRedirect(params: AuthenticateWithRedirectParams): Promi - `string | undefined` Email address to use for targeting a SAML connection at sign-up. + + --- + + - `legalAccepted?` + - `boolean` + + The user has accepted the legal documents. ## `authenticateWithWeb3()` @@ -89,6 +96,13 @@ function authenticateWithWeb3(params: AuthenticateWithWeb3Params): Promise ### `GenerateSignatureParams` @@ -112,6 +126,13 @@ function authenticateWithWeb3(params: AuthenticateWithWeb3Params): Promise ## `authenticateWithMetamask()` @@ -131,6 +152,13 @@ function authenticateWithMetamask( - `{[string]: any}` Custom fields that will be attached to the [`User`](/docs/references/javascript/user/user) object post-signup. + + --- + + - `legalAccepted?` + - `boolean` + + The user has accepted the legal documents. ## `authenticateWithCoinbaseWallet()` @@ -150,6 +178,13 @@ function authenticateWithCoinbaseWallet( - `{[string]: any}` Custom fields that will be attached to the [`User`](/docs/references/javascript/user/user) object post-signup. + + --- + + - `legalAccepted?` + - `boolean` + + The user has accepted the legal documents. [signup-ref]: /docs/references/javascript/sign-up/sign-up diff --git a/docs/references/javascript/sign-up/sign-up.mdx b/docs/references/javascript/sign-up/sign-up.mdx index f69e16b59b..b1693e6e47 100644 --- a/docs/references/javascript/sign-up/sign-up.mdx +++ b/docs/references/javascript/sign-up/sign-up.mdx @@ -264,6 +264,13 @@ function create(params: SignUpCreateParams): Promise - `boolean` Transfer the user to a dedicated sign-up for an OAuth flow. + + --- + + - `legalAccepted` + - `boolean` + + The user has accepted the legal documents. ### `update()` diff --git a/docs/references/javascript/user/user.mdx b/docs/references/javascript/user/user.mdx index d426a4c9cd..404d9d0f21 100644 --- a/docs/references/javascript/user/user.mdx +++ b/docs/references/javascript/user/user.mdx @@ -252,6 +252,13 @@ The ClerkJS SDK provides some helper [methods](#methods) on the `User` object to --- + - `legalAcceptedAt` + - `Date` + + Date when the user accepted the legal documents. May be empty if express consent is not enabled. + + --- + - `lastSignInAt` - `Date`