Update references to include legaAccepted and legalAcceptedAt

clerk · Nov 4, 2024 · d63161d · d63161d
1 parent 70bd6bc
commit d63161d
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 0 deletions.
diff --git 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.
 </Properties>
 
 ## `authenticateWithWeb3()`
@@ -89,6 +96,13 @@ function authenticateWithWeb3(params: AuthenticateWithWeb3Params): Promise<SignU
   - `Web3Strategy`
 
   The Web3 verification strategy.
+
+  ---
+
+  - `legalAccepted?`
+  - `boolean`
+
+  The user has accepted the legal documents.
 </Properties>
 
 ### `GenerateSignatureParams`
@@ -112,6 +126,13 @@ function authenticateWithWeb3(params: AuthenticateWithWeb3Params): Promise<SignU
   - `Web3Provider`
 
   The Web3 provider to generate the signature with.
+
+  ---
+
+  - `legalAccepted?`
+  - `boolean`
+
+  The user has accepted the legal documents.
 </Properties>
 
 ## `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.
 </Properties>
 
 ## `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.
 </Properties>
 
 [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
@@ -264,6 +264,13 @@ function create(params: SignUpCreateParams): Promise<SignUpResource>
   - `boolean`
 
   Transfer the user to a dedicated sign-up for an OAuth flow.
+
+    ---
+
+  - `legalAccepted`
+  - `boolean`
+
+  The user has accepted the legal documents.
 </Properties>
 
 ### `update()`

diff --git 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`
-Original file line number
+Diff line change
@@ Expand Up @@
       ---
+      - `legalAcceptedAt`
+      - `Date`
+      Date when the user accepted the legal documents. May be empty if express consent is not enabled.
+      ---
       - `lastSignInAt`
       - `Date`
@@ Expand Down @@