Skip to main content

user

Workspace API


Workspace API / types/user

types/user

Interfaces

User

Defined in: types/user.ts:4

Properties

user_id

user_id: string

Defined in: types/user.ts:5

email

email: string

Defined in: types/user.ts:6

password_hash?

optional password_hash: string

Defined in: types/user.ts:7

first_name?

optional first_name: string

Defined in: types/user.ts:8

last_name?

optional last_name: string

Defined in: types/user.ts:9

title?

optional title: string

Defined in: types/user.ts:10

phone?

optional phone: string

Defined in: types/user.ts:11

status

status: "active" | "inactive" | "suspended" | "pending" | "pending_verification"

Defined in: types/user.ts:12

email_verified_at?

optional email_verified_at: Date

Defined in: types/user.ts:13

created_at

created_at: Date

Defined in: types/user.ts:14

updated_at

updated_at: Date

Defined in: types/user.ts:15

last_login_at?

optional last_login_at: Date

Defined in: types/user.ts:16

password_reset_token?

optional password_reset_token: string

Defined in: types/user.ts:17

password_reset_expires_at?

optional password_reset_expires_at: Date

Defined in: types/user.ts:18

email_verification_token?

optional email_verification_token: string

Defined in: types/user.ts:19


CreateUserData

Defined in: types/user.ts:23

Properties

email

email: string

Defined in: types/user.ts:24

password

password: string

Defined in: types/user.ts:25

firstName?

optional firstName: string

Defined in: types/user.ts:26

lastName?

optional lastName: string

Defined in: types/user.ts:27

title?

optional title: string

Defined in: types/user.ts:28

phone?

optional phone: string

Defined in: types/user.ts:29

status?

optional status: "active" | "inactive" | "suspended" | "pending" | "pending_verification"

Defined in: types/user.ts:30


UpdateUserData

Defined in: types/user.ts:34

Properties

firstName?

optional firstName: string

Defined in: types/user.ts:35

lastName?

optional lastName: string

Defined in: types/user.ts:36

title?

optional title: string

Defined in: types/user.ts:37

phone?

optional phone: string

Defined in: types/user.ts:38

status?

optional status: "active" | "inactive" | "suspended" | "pending" | "pending_verification"

Defined in: types/user.ts:39

lastLoginAt?

optional lastLoginAt: Date

Defined in: types/user.ts:40


UserFilters

Defined in: types/user.ts:44

Properties

status?

optional status: "active" | "inactive" | "suspended" | "pending" | "pending_verification"

Defined in: types/user.ts:45

email?

optional email: string

Defined in: types/user.ts:46

limit?

optional limit: number

Defined in: types/user.ts:47

offset?

optional offset: number

Defined in: types/user.ts:48


PasswordValidation

Defined in: types/user.ts:52

Properties

valid

valid: boolean

Defined in: types/user.ts:53

message?

optional message: string

Defined in: types/user.ts:54


UserStats

Defined in: types/user.ts:58

Properties

total

total: number

Defined in: types/user.ts:59

active

active: number

Defined in: types/user.ts:60

inactive

inactive: number

Defined in: types/user.ts:61

suspended

suspended: number

Defined in: types/user.ts:62

pending

pending: number

Defined in: types/user.ts:63


UserResponse

Defined in: types/user.ts:67

Properties

id

id: string

Defined in: types/user.ts:68

email

email: string

Defined in: types/user.ts:69

firstName?

optional firstName: string

Defined in: types/user.ts:70

lastName?

optional lastName: string

Defined in: types/user.ts:71

title?

optional title: string

Defined in: types/user.ts:72

phone?

optional phone: string

Defined in: types/user.ts:73

status

status: "active" | "inactive" | "suspended" | "pending" | "pending_verification"

Defined in: types/user.ts:74

createdAt

createdAt: Date

Defined in: types/user.ts:75

updatedAt

updatedAt: Date

Defined in: types/user.ts:76

lastLoginAt?

optional lastLoginAt: Date

Defined in: types/user.ts:77


CreateUserRequest

Defined in: types/user.ts:80

Properties

email

email: string

Defined in: types/user.ts:81

password

password: string

Defined in: types/user.ts:82

firstName?

optional firstName: string

Defined in: types/user.ts:83

lastName?

optional lastName: string

Defined in: types/user.ts:84

title?

optional title: string

Defined in: types/user.ts:85

phone?

optional phone: string

Defined in: types/user.ts:86

status?

optional status: "active" | "inactive" | "suspended" | "pending" | "pending_verification"

Defined in: types/user.ts:87


UpdateUserRequest

Defined in: types/user.ts:90

Properties

firstName?

optional firstName: string

Defined in: types/user.ts:91

lastName?

optional lastName: string

Defined in: types/user.ts:92

title?

optional title: string

Defined in: types/user.ts:93

phone?

optional phone: string

Defined in: types/user.ts:94

status?

optional status: "active" | "inactive" | "suspended" | "pending" | "pending_verification"

Defined in: types/user.ts:95