Server - Technical Reference - v26.4.1
Preparing search index...
validators/inputs/user.validator
UserInputValidators
Class UserInputValidators
Hierarchy (
View Summary
)
Validator
UserInputValidators
Index
Constructors
constructor
Methods
create
User
Address
Input
create
User
Contact
Input
create
User
Email
Input
create
User
Phone
Input
create
User
With
Profile
By
Provider
Input
create
User
With
Profile
Input
email
Input
id
Input
login
User
Input
update
User
Address
Input
update
User
Contact
Input
update
User
Core
Input
update
User
Email
Input
update
User
Phone
Input
update
User
Profile
Input
user
Id
With
Context
Id
Input
validate
verify
Code
Input
verify
Code
With
User
Id
Constructors
constructor
new
UserInputValidators
()
:
UserInputValidators
Returns
UserInputValidators
Methods
create
User
Address
Input
createUserAddressInput
(
payload
:
{
addr_line_1
:
string
;
addr_line_2
?:
string
;
addr_name
:
string
;
city
:
string
;
country
:
string
;
country_iso
:
string
;
is_default
?:
boolean
;
post_code
?:
string
;
state
?:
string
;
user_id
:
string
;
}
,
)
:
|
{
addr_line_1
:
string
;
addr_line_2
?:
string
;
addr_name
:
string
;
city
:
string
;
country
:
string
;
country_iso
:
string
;
is_default
?:
boolean
;
post_code
?:
string
;
state
?:
string
;
user_id
:
string
;
}
|
ZodError
<
unknown
>
Parameters
payload
:
{
addr_line_1
:
string
;
addr_line_2
?:
string
;
addr_name
:
string
;
city
:
string
;
country
:
string
;
country_iso
:
string
;
is_default
?:
boolean
;
post_code
?:
string
;
state
?:
string
;
user_id
:
string
;
}
Returns
|
{
addr_line_1
:
string
;
addr_line_2
?:
string
;
addr_name
:
string
;
city
:
string
;
country
:
string
;
country_iso
:
string
;
is_default
?:
boolean
;
post_code
?:
string
;
state
?:
string
;
user_id
:
string
;
}
|
ZodError
<
unknown
>
create
User
Contact
Input
createUserContactInput
(
payload
:
{
socials
?:
{
type
:
Socials
;
url
:
string
}
[]
;
user_id
:
string
}
,
)
:
|
{
socials
?:
{
type
:
Socials
;
url
:
string
}
[]
;
user_id
:
string
}
|
ZodError
<
unknown
>
Parameters
payload
:
{
socials
?:
{
type
:
Socials
;
url
:
string
}
[]
;
user_id
:
string
}
Returns
|
{
socials
?:
{
type
:
Socials
;
url
:
string
}
[]
;
user_id
:
string
}
|
ZodError
<
unknown
>
create
User
Email
Input
createUserEmailInput
(
payload
:
{
contact_id
:
string
;
email
:
string
;
is_primary
?:
boolean
;
user_id
:
string
;
}
,
)
:
|
{
contact_id
:
string
;
email
:
string
;
is_primary
?:
boolean
;
user_id
:
string
;
}
|
ZodError
<
unknown
>
Parameters
payload
:
{
contact_id
:
string
;
email
:
string
;
is_primary
?:
boolean
;
user_id
:
string
}
Returns
|
{
contact_id
:
string
;
email
:
string
;
is_primary
?:
boolean
;
user_id
:
string
;
}
|
ZodError
<
unknown
>
create
User
Phone
Input
createUserPhoneInput
(
payload
:
{
contact_id
:
string
;
is_primary
?:
boolean
;
phone
:
string
;
phone_code
:
string
;
user_id
:
string
;
}
,
)
:
|
{
contact_id
:
string
;
is_primary
?:
boolean
;
phone
:
string
;
phone_code
:
string
;
user_id
:
string
;
}
|
ZodError
<
unknown
>
Parameters
payload
:
{
contact_id
:
string
;
is_primary
?:
boolean
;
phone
:
string
;
phone_code
:
string
;
user_id
:
string
;
}
Returns
|
{
contact_id
:
string
;
is_primary
?:
boolean
;
phone
:
string
;
phone_code
:
string
;
user_id
:
string
;
}
|
ZodError
<
unknown
>
create
User
With
Profile
By
Provider
Input
createUserWithProfileByProviderInput
(
payload
:
{
profile
:
{
avatar
?:
string
|
null
;
cover_img
?:
string
|
null
;
date_of_birth
?:
Date
|
null
;
first_name
:
string
;
gender
?:
"MALE"
|
"FEMALE"
|
"OTHER"
|
"PREFER_NOT_TO_SAY"
|
null
;
last_name
?:
string
|
null
;
nickname
?:
string
|
null
;
}
;
user
:
{
email
:
string
;
is_verified
?:
boolean
;
role
?:
"ADMIN"
|
"USER"
;
username
:
string
;
}
;
}
,
)
:
|
{
profile
:
{
avatar
?:
string
|
null
;
cover_img
?:
string
|
null
;
date_of_birth
?:
Date
|
null
;
first_name
:
string
;
gender
?:
"MALE"
|
"FEMALE"
|
"OTHER"
|
"PREFER_NOT_TO_SAY"
|
null
;
last_name
?:
string
|
null
;
nickname
?:
string
|
null
;
}
;
user
:
{
email
:
string
;
is_verified
?:
boolean
;
role
?:
"ADMIN"
|
"USER"
;
username
:
string
;
}
;
}
|
ZodError
<
{
profile
:
{
avatar
?:
string
|
null
;
cover_img
?:
string
|
null
;
date_of_birth
?:
Date
|
null
;
first_name
:
string
;
gender
?:
"MALE"
|
"FEMALE"
|
"OTHER"
|
"PREFER_NOT_TO_SAY"
|
null
;
last_name
?:
string
|
null
;
nickname
?:
string
|
null
;
}
;
user
:
{
email
:
string
;
is_verified
?:
boolean
;
role
?:
"ADMIN"
|
"USER"
;
username
:
string
;
}
;
}
,
>
Parameters
payload
:
{
profile
:
{
avatar
?:
string
|
null
;
cover_img
?:
string
|
null
;
date_of_birth
?:
Date
|
null
;
first_name
:
string
;
gender
?:
"MALE"
|
"FEMALE"
|
"OTHER"
|
"PREFER_NOT_TO_SAY"
|
null
;
last_name
?:
string
|
null
;
nickname
?:
string
|
null
;
}
;
user
:
{
email
:
string
;
is_verified
?:
boolean
;
role
?:
"ADMIN"
|
"USER"
;
username
:
string
;
}
;
}
Returns
|
{
profile
:
{
avatar
?:
string
|
null
;
cover_img
?:
string
|
null
;
date_of_birth
?:
Date
|
null
;
first_name
:
string
;
gender
?:
"MALE"
|
"FEMALE"
|
"OTHER"
|
"PREFER_NOT_TO_SAY"
|
null
;
last_name
?:
string
|
null
;
nickname
?:
string
|
null
;
}
;
user
:
{
email
:
string
;
is_verified
?:
boolean
;
role
?:
"ADMIN"
|
"USER"
;
username
:
string
;
}
;
}
|
ZodError
<
{
profile
:
{
avatar
?:
string
|
null
;
cover_img
?:
string
|
null
;
date_of_birth
?:
Date
|
null
;
first_name
:
string
;
gender
?:
"MALE"
|
"FEMALE"
|
"OTHER"
|
"PREFER_NOT_TO_SAY"
|
null
;
last_name
?:
string
|
null
;
nickname
?:
string
|
null
;
}
;
user
:
{
email
:
string
;
is_verified
?:
boolean
;
role
?:
"ADMIN"
|
"USER"
;
username
:
string
;
}
;
}
,
>
create
User
With
Profile
Input
createUserWithProfileInput
(
payload
:
{
profile
:
{
avatar
?:
string
|
null
;
cover_img
?:
string
|
null
;
date_of_birth
?:
Date
|
null
;
first_name
:
string
;
gender
?:
"MALE"
|
"FEMALE"
|
"OTHER"
|
"PREFER_NOT_TO_SAY"
|
null
;
last_name
?:
string
|
null
;
nickname
?:
string
|
null
;
}
;
user
:
{
email
:
string
;
password
:
string
;
role
?:
"ADMIN"
|
"USER"
;
username
:
string
;
}
;
}
,
)
:
|
{
profile
:
{
avatar
?:
string
|
null
;
cover_img
?:
string
|
null
;
date_of_birth
?:
Date
|
null
;
first_name
:
string
;
gender
?:
"MALE"
|
"FEMALE"
|
"OTHER"
|
"PREFER_NOT_TO_SAY"
|
null
;
last_name
?:
string
|
null
;
nickname
?:
string
|
null
;
}
;
user
:
{
email
:
string
;
password
:
string
;
role
?:
"ADMIN"
|
"USER"
;
username
:
string
;
}
;
}
|
ZodError
<
unknown
>
Parameters
payload
:
{
profile
:
{
avatar
?:
string
|
null
;
cover_img
?:
string
|
null
;
date_of_birth
?:
Date
|
null
;
first_name
:
string
;
gender
?:
"MALE"
|
"FEMALE"
|
"OTHER"
|
"PREFER_NOT_TO_SAY"
|
null
;
last_name
?:
string
|
null
;
nickname
?:
string
|
null
;
}
;
user
:
{
email
:
string
;
password
:
string
;
role
?:
"ADMIN"
|
"USER"
;
username
:
string
;
}
;
}
Returns
|
{
profile
:
{
avatar
?:
string
|
null
;
cover_img
?:
string
|
null
;
date_of_birth
?:
Date
|
null
;
first_name
:
string
;
gender
?:
"MALE"
|
"FEMALE"
|
"OTHER"
|
"PREFER_NOT_TO_SAY"
|
null
;
last_name
?:
string
|
null
;
nickname
?:
string
|
null
;
}
;
user
:
{
email
:
string
;
password
:
string
;
role
?:
"ADMIN"
|
"USER"
;
username
:
string
;
}
;
}
|
ZodError
<
unknown
>
email
Input
emailInput
(
payload
:
string
)
:
string
|
ZodError
<
unknown
>
Parameters
payload
:
string
Returns
string
|
ZodError
<
unknown
>
id
Input
idInput
(
payload
:
string
)
:
string
|
ZodError
<
unknown
>
Parameters
payload
:
string
Returns
string
|
ZodError
<
unknown
>
login
User
Input
loginUserInput
(
payload
:
{
identifier
:
string
;
password
:
string
}
,
)
:
{
identifier
:
string
;
password
:
string
}
|
ZodError
<
unknown
>
Parameters
payload
:
{
identifier
:
string
;
password
:
string
}
Returns
{
identifier
:
string
;
password
:
string
}
|
ZodError
<
unknown
>
update
User
Address
Input
updateUserAddressInput
(
payload
:
{
addr_line_1
?:
string
;
addr_line_2
?:
string
;
addr_name
?:
string
;
city
?:
string
;
country
?:
string
;
country_iso
?:
string
;
id
:
string
;
is_default
?:
boolean
;
post_code
?:
string
;
state
?:
string
;
user_id
:
string
;
}
,
)
:
|
{
addr_line_1
?:
string
;
addr_line_2
?:
string
;
addr_name
?:
string
;
city
?:
string
;
country
?:
string
;
country_iso
?:
string
;
id
:
string
;
is_default
?:
boolean
;
post_code
?:
string
;
state
?:
string
;
user_id
:
string
;
}
|
ZodError
<
unknown
>
Parameters
payload
:
{
addr_line_1
?:
string
;
addr_line_2
?:
string
;
addr_name
?:
string
;
city
?:
string
;
country
?:
string
;
country_iso
?:
string
;
id
:
string
;
is_default
?:
boolean
;
post_code
?:
string
;
state
?:
string
;
user_id
:
string
;
}
Returns
|
{
addr_line_1
?:
string
;
addr_line_2
?:
string
;
addr_name
?:
string
;
city
?:
string
;
country
?:
string
;
country_iso
?:
string
;
id
:
string
;
is_default
?:
boolean
;
post_code
?:
string
;
state
?:
string
;
user_id
:
string
;
}
|
ZodError
<
unknown
>
update
User
Contact
Input
updateUserContactInput
(
payload
:
{
id
?:
string
;
socials
?:
{
type
:
Socials
;
url
:
string
}
[]
;
user_id
:
string
;
}
,
)
:
|
{
id
?:
string
;
socials
?:
{
type
:
Socials
;
url
:
string
}
[]
;
user_id
:
string
;
}
|
ZodError
<
unknown
>
Parameters
payload
:
{
id
?:
string
;
socials
?:
{
type
:
Socials
;
url
:
string
}
[]
;
user_id
:
string
}
Returns
|
{
id
?:
string
;
socials
?:
{
type
:
Socials
;
url
:
string
}
[]
;
user_id
:
string
;
}
|
ZodError
<
unknown
>
update
User
Core
Input
updateUserCoreInput
(
payload
:
{
email
?:
string
;
id
:
string
;
is_verified
?:
boolean
;
password
?:
string
;
provider
?:
"GOOGLE"
|
"GITHUB"
|
"DISCORD"
|
"MANUAL"
;
role
?:
"ADMIN"
|
"USER"
;
username
?:
string
;
verify_code
?:
string
|
null
;
verify_expiry
?:
Date
|
null
;
}
,
)
:
|
ZodError
<
unknown
>
|
{
email
?:
string
;
id
:
string
;
is_verified
?:
boolean
;
password
?:
string
;
provider
?:
"GOOGLE"
|
"GITHUB"
|
"DISCORD"
|
"MANUAL"
;
role
?:
"ADMIN"
|
"USER"
;
username
?:
string
;
verify_code
?:
string
|
null
;
verify_expiry
?:
Date
|
null
;
}
Parameters
payload
:
{
email
?:
string
;
id
:
string
;
is_verified
?:
boolean
;
password
?:
string
;
provider
?:
"GOOGLE"
|
"GITHUB"
|
"DISCORD"
|
"MANUAL"
;
role
?:
"ADMIN"
|
"USER"
;
username
?:
string
;
verify_code
?:
string
|
null
;
verify_expiry
?:
Date
|
null
;
}
Returns
|
ZodError
<
unknown
>
|
{
email
?:
string
;
id
:
string
;
is_verified
?:
boolean
;
password
?:
string
;
provider
?:
"GOOGLE"
|
"GITHUB"
|
"DISCORD"
|
"MANUAL"
;
role
?:
"ADMIN"
|
"USER"
;
username
?:
string
;
verify_code
?:
string
|
null
;
verify_expiry
?:
Date
|
null
;
}
update
User
Email
Input
updateUserEmailInput
(
payload
:
{
contact_id
?:
string
;
email
?:
string
;
id
:
string
;
is_primary
?:
boolean
;
is_verified
?:
boolean
;
user_id
:
string
;
verify_code
?:
string
|
null
;
verify_expiry
?:
Date
|
null
;
}
,
)
:
|
{
contact_id
?:
string
;
email
?:
string
;
id
:
string
;
is_primary
?:
boolean
;
is_verified
?:
boolean
;
user_id
:
string
;
verify_code
?:
string
|
null
;
verify_expiry
?:
Date
|
null
;
}
|
ZodError
<
unknown
>
Parameters
payload
:
{
contact_id
?:
string
;
email
?:
string
;
id
:
string
;
is_primary
?:
boolean
;
is_verified
?:
boolean
;
user_id
:
string
;
verify_code
?:
string
|
null
;
verify_expiry
?:
Date
|
null
;
}
Returns
|
{
contact_id
?:
string
;
email
?:
string
;
id
:
string
;
is_primary
?:
boolean
;
is_verified
?:
boolean
;
user_id
:
string
;
verify_code
?:
string
|
null
;
verify_expiry
?:
Date
|
null
;
}
|
ZodError
<
unknown
>
update
User
Phone
Input
updateUserPhoneInput
(
payload
:
{
contact_id
?:
string
;
id
:
string
;
is_primary
?:
boolean
;
is_verified
?:
boolean
;
phone
?:
string
;
phone_code
?:
string
;
user_id
:
string
;
verify_code
?:
string
|
null
;
verify_expiry
?:
Date
|
null
;
}
,
)
:
|
{
contact_id
?:
string
;
id
:
string
;
is_primary
?:
boolean
;
is_verified
?:
boolean
;
phone
?:
string
;
phone_code
?:
string
;
user_id
:
string
;
verify_code
?:
string
|
null
;
verify_expiry
?:
Date
|
null
;
}
|
ZodError
<
unknown
>
Parameters
payload
:
{
contact_id
?:
string
;
id
:
string
;
is_primary
?:
boolean
;
is_verified
?:
boolean
;
phone
?:
string
;
phone_code
?:
string
;
user_id
:
string
;
verify_code
?:
string
|
null
;
verify_expiry
?:
Date
|
null
;
}
Returns
|
{
contact_id
?:
string
;
id
:
string
;
is_primary
?:
boolean
;
is_verified
?:
boolean
;
phone
?:
string
;
phone_code
?:
string
;
user_id
:
string
;
verify_code
?:
string
|
null
;
verify_expiry
?:
Date
|
null
;
}
|
ZodError
<
unknown
>
update
User
Profile
Input
updateUserProfileInput
(
payload
:
{
avatar
?:
string
|
null
;
cover_img
?:
string
|
null
;
date_of_birth
?:
Date
|
null
;
first_name
?:
string
;
gender
?:
"MALE"
|
"FEMALE"
|
"OTHER"
|
"PREFER_NOT_TO_SAY"
|
null
;
last_name
?:
string
|
null
;
nickname
?:
string
|
null
;
user_id
:
string
;
}
,
)
:
|
{
avatar
?:
string
|
null
;
cover_img
?:
string
|
null
;
date_of_birth
?:
Date
|
null
;
first_name
?:
string
;
gender
?:
"MALE"
|
"FEMALE"
|
"OTHER"
|
"PREFER_NOT_TO_SAY"
|
null
;
last_name
?:
string
|
null
;
nickname
?:
string
|
null
;
user_id
:
string
;
}
|
ZodError
<
unknown
>
Parameters
payload
:
{
avatar
?:
string
|
null
;
cover_img
?:
string
|
null
;
date_of_birth
?:
Date
|
null
;
first_name
?:
string
;
gender
?:
"MALE"
|
"FEMALE"
|
"OTHER"
|
"PREFER_NOT_TO_SAY"
|
null
;
last_name
?:
string
|
null
;
nickname
?:
string
|
null
;
user_id
:
string
;
}
Returns
|
{
avatar
?:
string
|
null
;
cover_img
?:
string
|
null
;
date_of_birth
?:
Date
|
null
;
first_name
?:
string
;
gender
?:
"MALE"
|
"FEMALE"
|
"OTHER"
|
"PREFER_NOT_TO_SAY"
|
null
;
last_name
?:
string
|
null
;
nickname
?:
string
|
null
;
user_id
:
string
;
}
|
ZodError
<
unknown
>
user
Id
With
Context
Id
Input
userIdWithContextIdInput
(
payload
:
{
id
:
string
;
user_id
:
string
}
,
)
:
{
id
:
string
;
user_id
:
string
}
|
ZodError
<
unknown
>
Parameters
payload
:
{
id
:
string
;
user_id
:
string
}
Returns
{
id
:
string
;
user_id
:
string
}
|
ZodError
<
unknown
>
Protected
validate
validate
<
T
>
(
payload
:
unknown
,
schema
:
ZodType
<
T
>
)
:
ZodSafeParseResult
<
T
>
Type Parameters
T
Parameters
payload
:
unknown
schema
:
ZodType
<
T
>
Returns
ZodSafeParseResult
<
T
>
verify
Code
Input
verifyCodeInput
(
payload
:
{
id
:
string
;
verify_code
?:
string
|
null
}
,
)
:
{
id
:
string
;
verify_code
?:
string
|
null
}
|
ZodError
<
unknown
>
Parameters
payload
:
{
id
:
string
;
verify_code
?:
string
|
null
}
Returns
{
id
:
string
;
verify_code
?:
string
|
null
}
|
ZodError
<
unknown
>
verify
Code
With
User
Id
verifyCodeWithUserId
(
payload
:
{
id
:
string
;
user_id
:
string
;
verify_code
?:
string
|
null
}
,
)
:
|
{
id
:
string
;
user_id
:
string
;
verify_code
?:
string
|
null
}
|
ZodError
<
unknown
>
Parameters
payload
:
{
id
:
string
;
user_id
:
string
;
verify_code
?:
string
|
null
}
Returns
{
id
:
string
;
user_id
:
string
;
verify_code
?:
string
|
null
}
|
ZodError
<
unknown
>
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
create
User
Address
Input
create
User
Contact
Input
create
User
Email
Input
create
User
Phone
Input
create
User
With
Profile
By
Provider
Input
create
User
With
Profile
Input
email
Input
id
Input
login
User
Input
update
User
Address
Input
update
User
Contact
Input
update
User
Core
Input
update
User
Email
Input
update
User
Phone
Input
update
User
Profile
Input
user
Id
With
Context
Id
Input
validate
verify
Code
Input
verify
Code
With
User
Id
Server - Technical Reference - v26.4.1
Loading...