Server - Technical Reference - v26.4.1
Preparing search index...
services/user.service
UserService
Class UserService
Index
Constructors
constructor
Methods
create
User
Address
create
User
Contact
create
User
Email
create
User
Phone
create
User
With
Profile
create
User
With
Profile
By
Provider
delete
User
delete
User
Address
delete
User
Contact
delete
User
Email
delete
User
Phone
get
User
Profile
update
User
Address
update
User
Contact
update
User
Email
update
User
Phone
update
User
Profile
Constructors
constructor
new
UserService
(
__namedParameters
:
UserServiceDepsType
)
:
UserService
Parameters
__namedParameters
:
UserServiceDepsType
Returns
UserService
Methods
create
User
Address
createUserAddress
(
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
;
}
,
)
:
Promise
<
string
>
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
Promise
<
string
>
create
User
Contact
createUserContact
(
payload
:
{
socials
?:
{
type
:
Socials
;
url
:
string
}
[]
;
user_id
:
string
}
,
)
:
Promise
<
string
>
Parameters
payload
:
{
socials
?:
{
type
:
Socials
;
url
:
string
}
[]
;
user_id
:
string
}
Returns
Promise
<
string
>
create
User
Email
createUserEmail
(
payload
:
{
contact_id
:
string
;
email
:
string
;
is_primary
?:
boolean
;
user_id
:
string
;
}
,
)
:
Promise
<
string
>
Parameters
payload
:
{
contact_id
:
string
;
email
:
string
;
is_primary
?:
boolean
;
user_id
:
string
}
Returns
Promise
<
string
>
create
User
Phone
createUserPhone
(
payload
:
{
contact_id
:
string
;
is_primary
?:
boolean
;
phone
:
string
;
phone_code
:
string
;
user_id
:
string
;
}
,
)
:
Promise
<
string
>
Parameters
payload
:
{
contact_id
:
string
;
is_primary
?:
boolean
;
phone
:
string
;
phone_code
:
string
;
user_id
:
string
;
}
Returns
Promise
<
string
>
create
User
With
Profile
createUserWithProfile
(
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
;
}
;
}
,
)
:
Promise
<
{
profile
:
{
avatar
:
string
|
null
;
cover_img
:
string
|
null
;
created_at
:
Date
;
date_of_birth
:
string
|
null
;
first_name
:
string
;
gender
:
"MALE"
|
"FEMALE"
|
"OTHER"
|
"PREFER_NOT_TO_SAY"
|
null
;
id
:
string
;
last_name
:
string
|
null
;
nickname
:
string
|
null
;
updated_at
:
Date
|
null
;
user_id
:
string
;
}
;
user
:
{
created_at
:
Date
;
email
:
string
;
id
:
string
;
is_verified
:
boolean
;
provider
:
"GOOGLE"
|
"GITHUB"
|
"DISCORD"
|
"MANUAL"
;
role
:
"ADMIN"
|
"USER"
;
updated_at
:
Date
|
null
;
username
:
string
;
verify_code
:
string
|
null
;
verify_expiry
:
Date
|
null
;
}
;
}
,
>
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
Promise
<
{
profile
:
{
avatar
:
string
|
null
;
cover_img
:
string
|
null
;
created_at
:
Date
;
date_of_birth
:
string
|
null
;
first_name
:
string
;
gender
:
"MALE"
|
"FEMALE"
|
"OTHER"
|
"PREFER_NOT_TO_SAY"
|
null
;
id
:
string
;
last_name
:
string
|
null
;
nickname
:
string
|
null
;
updated_at
:
Date
|
null
;
user_id
:
string
;
}
;
user
:
{
created_at
:
Date
;
email
:
string
;
id
:
string
;
is_verified
:
boolean
;
provider
:
"GOOGLE"
|
"GITHUB"
|
"DISCORD"
|
"MANUAL"
;
role
:
"ADMIN"
|
"USER"
;
updated_at
:
Date
|
null
;
username
:
string
;
verify_code
:
string
|
null
;
verify_expiry
:
Date
|
null
;
}
;
}
,
>
create
User
With
Profile
By
Provider
createUserWithProfileByProvider
(
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
;
}
;
}
,
)
:
Promise
<
|
{
email
:
string
;
id
:
string
;
is_verified
:
boolean
;
password
:
string
|
null
;
profile
:
|
{
avatar
:
string
|
null
;
first_name
:
string
;
last_name
:
string
|
null
;
nickname
:
string
|
null
;
}
|
null
;
role
:
"ADMIN"
|
"USER"
;
username
:
string
;
}
|
{
created_at
:
Date
;
email
:
string
;
id
:
string
;
is_verified
:
boolean
;
profile
:
{
avatar
:
string
|
null
;
cover_img
:
string
|
null
;
created_at
:
Date
;
date_of_birth
:
string
|
null
;
first_name
:
string
;
gender
:
"MALE"
|
"FEMALE"
|
"OTHER"
|
"PREFER_NOT_TO_SAY"
|
null
;
id
:
string
;
last_name
:
string
|
null
;
nickname
:
string
|
null
;
updated_at
:
Date
|
null
;
user_id
:
string
;
}
;
provider
:
"GOOGLE"
|
"GITHUB"
|
"DISCORD"
|
"MANUAL"
;
role
:
"ADMIN"
|
"USER"
;
updated_at
:
Date
|
null
;
username
:
string
;
verify_code
:
string
|
null
;
verify_expiry
:
Date
|
null
;
}
,
>
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
Promise
<
|
{
email
:
string
;
id
:
string
;
is_verified
:
boolean
;
password
:
string
|
null
;
profile
:
|
{
avatar
:
string
|
null
;
first_name
:
string
;
last_name
:
string
|
null
;
nickname
:
string
|
null
;
}
|
null
;
role
:
"ADMIN"
|
"USER"
;
username
:
string
;
}
|
{
created_at
:
Date
;
email
:
string
;
id
:
string
;
is_verified
:
boolean
;
profile
:
{
avatar
:
string
|
null
;
cover_img
:
string
|
null
;
created_at
:
Date
;
date_of_birth
:
string
|
null
;
first_name
:
string
;
gender
:
"MALE"
|
"FEMALE"
|
"OTHER"
|
"PREFER_NOT_TO_SAY"
|
null
;
id
:
string
;
last_name
:
string
|
null
;
nickname
:
string
|
null
;
updated_at
:
Date
|
null
;
user_id
:
string
;
}
;
provider
:
"GOOGLE"
|
"GITHUB"
|
"DISCORD"
|
"MANUAL"
;
role
:
"ADMIN"
|
"USER"
;
updated_at
:
Date
|
null
;
username
:
string
;
verify_code
:
string
|
null
;
verify_expiry
:
Date
|
null
;
}
,
>
delete
User
deleteUser
(
payload
:
string
)
:
Promise
<
string
>
Parameters
payload
:
string
Returns
Promise
<
string
>
delete
User
Address
deleteUserAddress
(
payload
:
{
id
:
string
;
user_id
:
string
}
)
:
Promise
<
string
>
Parameters
payload
:
{
id
:
string
;
user_id
:
string
}
Returns
Promise
<
string
>
delete
User
Contact
deleteUserContact
(
payload
:
{
id
:
string
;
user_id
:
string
}
)
:
Promise
<
string
>
Parameters
payload
:
{
id
:
string
;
user_id
:
string
}
Returns
Promise
<
string
>
delete
User
Email
deleteUserEmail
(
payload
:
{
id
:
string
;
user_id
:
string
}
)
:
Promise
<
string
>
Parameters
payload
:
{
id
:
string
;
user_id
:
string
}
Returns
Promise
<
string
>
delete
User
Phone
deleteUserPhone
(
payload
:
{
id
:
string
;
user_id
:
string
}
)
:
Promise
<
string
>
Parameters
payload
:
{
id
:
string
;
user_id
:
string
}
Returns
Promise
<
string
>
get
User
Profile
getUserProfile
(
id
:
string
,
)
:
Promise
<
{
created_at
:
Date
;
email
:
string
;
id
:
string
;
is_verified
:
boolean
;
profile
:
|
{
avatar
:
string
|
null
;
cover_img
:
string
|
null
;
created_at
:
Date
;
date_of_birth
:
string
|
null
;
first_name
:
string
;
gender
:
"MALE"
|
"FEMALE"
|
"OTHER"
|
"PREFER_NOT_TO_SAY"
|
null
;
last_name
:
string
|
null
;
nickname
:
string
|
null
;
updated_at
:
Date
|
null
;
}
|
null
;
provider
:
"GOOGLE"
|
"GITHUB"
|
"DISCORD"
|
"MANUAL"
;
role
:
"ADMIN"
|
"USER"
;
updated_at
:
Date
|
null
;
username
:
string
;
}
,
>
Parameters
id
:
string
Returns
Promise
<
{
created_at
:
Date
;
email
:
string
;
id
:
string
;
is_verified
:
boolean
;
profile
:
|
{
avatar
:
string
|
null
;
cover_img
:
string
|
null
;
created_at
:
Date
;
date_of_birth
:
string
|
null
;
first_name
:
string
;
gender
:
"MALE"
|
"FEMALE"
|
"OTHER"
|
"PREFER_NOT_TO_SAY"
|
null
;
last_name
:
string
|
null
;
nickname
:
string
|
null
;
updated_at
:
Date
|
null
;
}
|
null
;
provider
:
"GOOGLE"
|
"GITHUB"
|
"DISCORD"
|
"MANUAL"
;
role
:
"ADMIN"
|
"USER"
;
updated_at
:
Date
|
null
;
username
:
string
;
}
,
>
update
User
Address
updateUserAddress
(
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
;
}
,
)
:
Promise
<
string
>
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
Promise
<
string
>
update
User
Contact
updateUserContact
(
payload
:
{
id
?:
string
;
socials
?:
{
type
:
Socials
;
url
:
string
}
[]
;
user_id
:
string
;
}
,
)
:
Promise
<
string
>
Parameters
payload
:
{
id
?:
string
;
socials
?:
{
type
:
Socials
;
url
:
string
}
[]
;
user_id
:
string
}
Returns
Promise
<
string
>
update
User
Email
updateUserEmail
(
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
;
}
,
)
:
Promise
<
string
>
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
Promise
<
string
>
update
User
Phone
updateUserPhone
(
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
;
}
,
)
:
Promise
<
string
>
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
Promise
<
string
>
update
User
Profile
updateUserProfile
(
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
;
}
,
)
:
Promise
<
string
>
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
Promise
<
string
>
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
create
User
Address
create
User
Contact
create
User
Email
create
User
Phone
create
User
With
Profile
create
User
With
Profile
By
Provider
delete
User
delete
User
Address
delete
User
Contact
delete
User
Email
delete
User
Phone
get
User
Profile
update
User
Address
update
User
Contact
update
User
Email
update
User
Phone
update
User
Profile
Server - Technical Reference - v26.4.1
Loading...