Server - Technical Reference - v26.4.1
Preparing search index...
database/repositories/user.repository
UserRepository
Class UserRepository
Index
Constructors
constructor
Methods
Create
New
Address
Create
New
Contact
Create
New
Email
Create
New
Phone
Create
New
User
And
Profile
Create
New
User
And
Profile
By
Provider
Delete
Single
Address
Delete
Single
Contact
Delete
Single
Contact
Email
Delete
Single
Contact
Phone
Delete
User
By
Id
Get
Auth
User
Profile
By
Id
Get
Contact
Email
Verify
Details
Get
Contact
Phone
Verify
Details
Get
User
Data
For
Login
By
Email
Or
Username
Or
Id
Get
User
Id
By
Email
Get
User
Verify
Details
Set
Email
Verify
Code
Set
Phone
Verify
Code
Set
Verify
Code
For
Core
User
Update
Address
Update
Contact
Update
Contact
Email
Update
Contact
Phone
Update
User
Profile
Update
User
Verify
Details
Constructors
constructor
new
UserRepository
()
:
UserRepository
Returns
UserRepository
Methods
Create
New
Address
CreateNewAddress
(
data
:
{
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
<
{
id
:
string
}
|
undefined
>
Parameters
data
:
{
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
<
{
id
:
string
}
|
undefined
>
Create
New
Contact
CreateNewContact
(
data
:
{
socials
?:
{
type
:
Socials
;
url
:
string
}
[]
;
user_id
:
string
}
,
)
:
Promise
<
{
id
:
string
}
|
undefined
>
Parameters
data
:
{
socials
?:
{
type
:
Socials
;
url
:
string
}
[]
;
user_id
:
string
}
Returns
Promise
<
{
id
:
string
}
|
undefined
>
Create
New
Email
CreateNewEmail
(
data
:
{
contact_id
:
string
;
email
:
string
;
is_primary
?:
boolean
;
user_id
:
string
;
}
,
)
:
Promise
<
{
id
:
string
}
|
undefined
>
Parameters
data
:
{
contact_id
:
string
;
email
:
string
;
is_primary
?:
boolean
;
user_id
:
string
}
Returns
Promise
<
{
id
:
string
}
|
undefined
>
Create
New
Phone
CreateNewPhone
(
data
:
{
contact_id
:
string
;
is_primary
?:
boolean
;
phone
:
string
;
phone_code
:
string
;
user_id
:
string
;
}
,
)
:
Promise
<
{
id
:
string
}
|
undefined
>
Parameters
data
:
{
contact_id
:
string
;
is_primary
?:
boolean
;
phone
:
string
;
phone_code
:
string
;
user_id
:
string
;
}
Returns
Promise
<
{
id
:
string
}
|
undefined
>
Create
New
User
And
Profile
CreateNewUserAndProfile
(
data
:
{
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
data
:
{
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
New
User
And
Profile
By
Provider
CreateNewUserAndProfileByProvider
(
data
:
{
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
<
{
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
data
:
{
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
<
{
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
Single
Address
DeleteSingleAddress
(
address_id
:
string
,
user_id
:
string
,
)
:
Promise
<
{
id
:
string
}
|
undefined
>
Parameters
address_id
:
string
user_id
:
string
Returns
Promise
<
{
id
:
string
}
|
undefined
>
Delete
Single
Contact
DeleteSingleContact
(
contact_id
:
string
,
user_id
:
string
,
)
:
Promise
<
{
id
:
string
}
|
undefined
>
Parameters
contact_id
:
string
user_id
:
string
Returns
Promise
<
{
id
:
string
}
|
undefined
>
Delete
Single
Contact
Email
DeleteSingleContactEmail
(
email_table_id
:
string
,
user_id
:
string
,
)
:
Promise
<
{
id
:
string
}
|
undefined
>
Parameters
email_table_id
:
string
user_id
:
string
Returns
Promise
<
{
id
:
string
}
|
undefined
>
Delete
Single
Contact
Phone
DeleteSingleContactPhone
(
phone_id
:
string
,
user_id
:
string
,
)
:
Promise
<
{
id
:
string
}
|
undefined
>
Parameters
phone_id
:
string
user_id
:
string
Returns
Promise
<
{
id
:
string
}
|
undefined
>
Delete
User
By
Id
DeleteUserById
(
id
:
string
)
:
Promise
<
{
id
:
string
}
|
undefined
>
Parameters
id
:
string
Returns
Promise
<
{
id
:
string
}
|
undefined
>
Get
Auth
User
Profile
By
Id
GetAuthUserProfileById
(
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
;
}
|
undefined
,
>
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
;
}
|
undefined
,
>
Get
Contact
Email
Verify
Details
GetContactEmailVerifyDetails
(
email_table_id
:
string
,
)
:
Promise
<
|
{
id
:
string
;
is_verified
:
boolean
;
verify_code
:
string
|
null
;
verify_expiry
:
Date
|
null
;
}
|
undefined
,
>
Parameters
email_table_id
:
string
Returns
Promise
<
|
{
id
:
string
;
is_verified
:
boolean
;
verify_code
:
string
|
null
;
verify_expiry
:
Date
|
null
;
}
|
undefined
,
>
Get
Contact
Phone
Verify
Details
GetContactPhoneVerifyDetails
(
phone_id
:
string
,
)
:
Promise
<
|
{
id
:
string
;
is_verified
:
boolean
;
verify_code
:
string
|
null
;
verify_expiry
:
Date
|
null
;
}
|
undefined
,
>
Parameters
phone_id
:
string
Returns
Promise
<
|
{
id
:
string
;
is_verified
:
boolean
;
verify_code
:
string
|
null
;
verify_expiry
:
Date
|
null
;
}
|
undefined
,
>
Get
User
Data
For
Login
By
Email
Or
Username
Or
Id
GetUserDataForLoginByEmailOrUsernameOrId
(
data
:
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
;
}
|
undefined
,
>
Parameters
data
:
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
;
}
|
undefined
,
>
Get
User
Id
By
Email
GetUserIdByEmail
(
email
:
string
)
:
Promise
<
{
id
:
string
}
|
undefined
>
Parameters
email
:
string
Returns
Promise
<
{
id
:
string
}
|
undefined
>
Get
User
Verify
Details
GetUserVerifyDetails
(
user_id
:
string
,
)
:
Promise
<
|
{
id
:
string
;
is_verified
:
boolean
;
verify_code
:
string
|
null
;
verify_expiry
:
Date
|
null
;
}
|
undefined
,
>
Parameters
user_id
:
string
Returns
Promise
<
|
{
id
:
string
;
is_verified
:
boolean
;
verify_code
:
string
|
null
;
verify_expiry
:
Date
|
null
;
}
|
undefined
,
>
Set
Email
Verify
Code
SetEmailVerifyCode
(
code
:
string
,
expiry
:
Date
,
email_table_id
:
string
,
user_id
:
string
,
)
:
Promise
<
{
email
:
string
;
id
:
string
}
|
undefined
>
Parameters
code
:
string
expiry
:
Date
email_table_id
:
string
user_id
:
string
Returns
Promise
<
{
email
:
string
;
id
:
string
}
|
undefined
>
Set
Phone
Verify
Code
SetPhoneVerifyCode
(
code
:
string
,
expiry
:
Date
,
phone_table_id
:
string
,
user_id
:
string
,
)
:
Promise
<
{
id
:
string
;
phone
:
string
;
phone_code
:
string
}
|
undefined
>
Parameters
code
:
string
expiry
:
Date
phone_table_id
:
string
user_id
:
string
Returns
Promise
<
{
id
:
string
;
phone
:
string
;
phone_code
:
string
}
|
undefined
>
Set
Verify
Code
For
Core
User
SetVerifyCodeForCoreUser
(
code
:
string
,
expiry
:
Date
,
email
:
string
,
)
:
Promise
<
{
id
:
string
}
|
undefined
>
Parameters
code
:
string
expiry
:
Date
email
:
string
Returns
Promise
<
{
id
:
string
}
|
undefined
>
Update
Address
UpdateAddress
(
data
:
{
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
<
{
id
:
string
}
|
undefined
>
Parameters
data
:
{
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
<
{
id
:
string
}
|
undefined
>
Update
Contact
UpdateContact
(
data
:
{
id
?:
string
;
socials
?:
{
type
:
Socials
;
url
:
string
}
[]
;
user_id
:
string
;
}
,
)
:
Promise
<
{
id
:
string
}
|
undefined
>
Parameters
data
:
{
id
?:
string
;
socials
?:
{
type
:
Socials
;
url
:
string
}
[]
;
user_id
:
string
}
Returns
Promise
<
{
id
:
string
}
|
undefined
>
Update
Contact
Email
UpdateContactEmail
(
data
:
{
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
<
{
id
:
string
}
|
undefined
>
Parameters
data
:
{
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
<
{
id
:
string
}
|
undefined
>
Update
Contact
Phone
UpdateContactPhone
(
data
:
{
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
<
{
id
:
string
}
|
undefined
>
Parameters
data
:
{
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
<
{
id
:
string
}
|
undefined
>
Update
User
Profile
UpdateUserProfile
(
data
:
{
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
<
{
id
:
string
}
|
undefined
>
Parameters
data
:
{
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
<
{
id
:
string
}
|
undefined
>
Update
User
Verify
Details
UpdateUserVerifyDetails
(
user_id
:
string
)
:
Promise
<
{
id
:
string
}
|
undefined
>
Parameters
user_id
:
string
Returns
Promise
<
{
id
:
string
}
|
undefined
>
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
Create
New
Address
Create
New
Contact
Create
New
Email
Create
New
Phone
Create
New
User
And
Profile
Create
New
User
And
Profile
By
Provider
Delete
Single
Address
Delete
Single
Contact
Delete
Single
Contact
Email
Delete
Single
Contact
Phone
Delete
User
By
Id
Get
Auth
User
Profile
By
Id
Get
Contact
Email
Verify
Details
Get
Contact
Phone
Verify
Details
Get
User
Data
For
Login
By
Email
Or
Username
Or
Id
Get
User
Id
By
Email
Get
User
Verify
Details
Set
Email
Verify
Code
Set
Phone
Verify
Code
Set
Verify
Code
For
Core
User
Update
Address
Update
Contact
Update
Contact
Email
Update
Contact
Phone
Update
User
Profile
Update
User
Verify
Details
Server - Technical Reference - v26.4.1
Loading...