Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add legalAcceptedAt and skipLegalChecks fields to user management methods #1828

Merged
merged 6 commits into from
Dec 19, 2024
+46 −6
Merged

Add legalAcceptedAt and skipLegalChecks fields to user management methods #1828

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
145c59e
Add legalAcceptedAt and skipLegalChecks fields to user management met…
NWylynko Dec 19, 2024
e7220a9
Update the response models for createUser and updateUser to reflect i…
NWylynko Dec 19, 2024
3134212
Updated user backend model to include the `legalAcceptedAt` property
NWylynko Dec 19, 2024
c8f4b72
Update `legalAcceptedAt` type to reflect backend sdk auto parsing the…
NWylynko Dec 19, 2024
005789e
Indicate to devs that `true` is a possible value of `skipLegalChecks`
NWylynko Dec 19, 2024
542b399
description updates
alexisintech Dec 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/references/backend/user/create-user.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,20 @@ function createUser(params: CreateUserParams): Promise<User>

---

- `legalAcceptedAt?`
- `string`
alexisintech marked this conversation as resolved.
Show resolved Hide resolved

A custom timestamp denoting when the user accepted legal requirements, specified in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339). For example: `2012-10-20T07:15:20.902Z`.

---

- `skipLegalChecks?`
- `boolean`

When set to true all legal checks are skipped. It is not recommended to skip legal checks unless you are migrating a user to Clerk.
alexisintech marked this conversation as resolved.
Show resolved Hide resolved

---

- `createdAt`
- `string`

Expand Down
6 changes: 4 additions & 2 deletions docs/references/backend/user/get-user-list.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,8 @@ console.log(response)
web3Wallets: [],
externalAccounts: [Array],
lastActiveAt: 1707523200000,
createOrganizationEnabled: true
createOrganizationEnabled: true,
legalAcceptedAt: null
},
_User {
id: 'user_456',
Expand Down Expand Up @@ -170,7 +171,8 @@ console.log(response)
web3Wallets: [],
externalAccounts: [Array],
lastActiveAt: 1707523200000,
createOrganizationEnabled: true
createOrganizationEnabled: true,
legalAcceptedAt: null
},
...
],
Expand Down
3 changes: 2 additions & 1 deletion docs/references/backend/user/get-user.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,8 @@ _User {
web3Wallets: [],
externalAccounts: [],
lastActiveAt: null,
createOrganizationEnabled: true
createOrganizationEnabled: true,
legalAcceptedAt: null
}
*/
```
Expand Down
14 changes: 14 additions & 0 deletions docs/references/backend/user/update-user.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,20 @@ function updateUser(userId: string, params: UpdateUserParams): Promise<User>

---

- `legalAcceptedAt?`
- `string`

A custom timestamp denoting when the user accepted legal requirements, specified in [RFC3339 format](https://datatracker.ietf.org/doc/html/rfc3339). For example: `2012-10-20T07:15:20.902Z`.

---

- `skipLegalChecks?`
- `boolean`

When set to true all legal checks are skipped. It is not recommended to skip legal checks unless you are migrating a user to Clerk.

---

- `createdAt?`
- `Date`

Expand Down
Loading