urembo-hub-api
Preparing search index...
onboarding/onboarding.service
OnboardingService
Class OnboardingService
Index
Constructors
constructor
Methods
bulk
Submit
Requirements
create
Requirement
create
Review
delete
Requirement
get
All
Requirements
get
All
Reviews
get
Incomplete
Submissions
get
Onboarding
Stats
get
Requirement
By
Id
get
Requirements
By
Role
get
Review
By
Id
get
Submission
By
Id
get
User
Reviews
get
Users
By
Onboarding
Status
get
User
Submission
By
Requirement
get
User
Submissions
submit
Requirement
update
Requirement
update
User
Onboarding
Status
validate
Submission
Constructors
constructor
new
OnboardingService
(
prisma
:
PrismaService
,
emailService
:
EmailService
,
)
:
OnboardingService
Parameters
prisma
:
PrismaService
emailService
:
EmailService
Returns
OnboardingService
Methods
bulk
Submit
Requirements
bulkSubmitRequirements
(
userId
:
string
,
bulkSubmitDto
:
BulkSubmitDto
,
)
:
Promise
<
any
[]
>
Parameters
userId
:
string
bulkSubmitDto
:
BulkSubmitDto
Returns
Promise
<
any
[]
>
create
Requirement
createRequirement
(
createRequirementDto
:
CreateRequirementDto
,
)
:
Promise
<
{
createdAt
:
Date
;
description
:
string
;
fieldType
:
onboarding_field_type
;
id
:
string
;
isActive
:
boolean
;
isMandatory
:
boolean
;
isPaymentRelated
:
boolean
;
label
:
string
;
placeholder
:
string
;
position
:
number
;
role
:
user_role
;
selectOptions
:
JsonValue
;
updatedAt
:
Date
;
validationRules
:
JsonValue
;
}
,
>
Parameters
createRequirementDto
:
CreateRequirementDto
Returns
Promise
<
{
createdAt
:
Date
;
description
:
string
;
fieldType
:
onboarding_field_type
;
id
:
string
;
isActive
:
boolean
;
isMandatory
:
boolean
;
isPaymentRelated
:
boolean
;
label
:
string
;
placeholder
:
string
;
position
:
number
;
role
:
user_role
;
selectOptions
:
JsonValue
;
updatedAt
:
Date
;
validationRules
:
JsonValue
;
}
,
>
create
Review
createReview
(
adminId
:
string
,
reviewSubmissionDto
:
ReviewSubmissionDto
,
)
:
Promise
<
{
adminId
:
string
;
createdAt
:
Date
;
id
:
string
;
notes
:
string
;
rejectionReason
:
string
;
status
:
onboarding_status
;
updatedAt
:
Date
;
userId
:
string
;
}
,
>
Parameters
adminId
:
string
reviewSubmissionDto
:
ReviewSubmissionDto
Returns
Promise
<
{
adminId
:
string
;
createdAt
:
Date
;
id
:
string
;
notes
:
string
;
rejectionReason
:
string
;
status
:
onboarding_status
;
updatedAt
:
Date
;
userId
:
string
;
}
,
>
delete
Requirement
deleteRequirement
(
id
:
string
,
)
:
Promise
<
{
createdAt
:
Date
;
description
:
string
;
fieldType
:
onboarding_field_type
;
id
:
string
;
isActive
:
boolean
;
isMandatory
:
boolean
;
isPaymentRelated
:
boolean
;
label
:
string
;
placeholder
:
string
;
position
:
number
;
role
:
user_role
;
selectOptions
:
JsonValue
;
updatedAt
:
Date
;
validationRules
:
JsonValue
;
}
,
>
Parameters
id
:
string
Returns
Promise
<
{
createdAt
:
Date
;
description
:
string
;
fieldType
:
onboarding_field_type
;
id
:
string
;
isActive
:
boolean
;
isMandatory
:
boolean
;
isPaymentRelated
:
boolean
;
label
:
string
;
placeholder
:
string
;
position
:
number
;
role
:
user_role
;
selectOptions
:
JsonValue
;
updatedAt
:
Date
;
validationRules
:
JsonValue
;
}
,
>
get
All
Requirements
getAllRequirements
()
:
Promise
<
{
createdAt
:
Date
;
description
:
string
;
fieldType
:
onboarding_field_type
;
id
:
string
;
isActive
:
boolean
;
isMandatory
:
boolean
;
isPaymentRelated
:
boolean
;
label
:
string
;
placeholder
:
string
;
position
:
number
;
role
:
user_role
;
selectOptions
:
JsonValue
;
updatedAt
:
Date
;
validationRules
:
JsonValue
;
}
[]
,
>
Returns
Promise
<
{
createdAt
:
Date
;
description
:
string
;
fieldType
:
onboarding_field_type
;
id
:
string
;
isActive
:
boolean
;
isMandatory
:
boolean
;
isPaymentRelated
:
boolean
;
label
:
string
;
placeholder
:
string
;
position
:
number
;
role
:
user_role
;
selectOptions
:
JsonValue
;
updatedAt
:
Date
;
validationRules
:
JsonValue
;
}
[]
,
>
get
All
Reviews
getAllReviews
()
:
Promise
<
(
{
admin
:
{
email
:
string
;
fullName
:
string
;
id
:
string
}
;
user
:
{
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
role
:
user_role
;
}
;
}
&
{
adminId
:
string
;
createdAt
:
Date
;
id
:
string
;
notes
:
string
;
rejectionReason
:
string
;
status
:
onboarding_status
;
updatedAt
:
Date
;
userId
:
string
;
}
)
[]
,
>
Returns
Promise
<
(
{
admin
:
{
email
:
string
;
fullName
:
string
;
id
:
string
}
;
user
:
{
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
role
:
user_role
;
}
;
}
&
{
adminId
:
string
;
createdAt
:
Date
;
id
:
string
;
notes
:
string
;
rejectionReason
:
string
;
status
:
onboarding_status
;
updatedAt
:
Date
;
userId
:
string
;
}
)
[]
,
>
get
Incomplete
Submissions
getIncompleteSubmissions
(
userId
:
string
,
)
:
Promise
<
{
completedRequirements
:
number
;
completionPercentage
:
number
;
incompleteRequirements
:
{
createdAt
:
Date
;
description
:
string
;
fieldType
:
onboarding_field_type
;
id
:
string
;
isActive
:
boolean
;
isMandatory
:
boolean
;
isPaymentRelated
:
boolean
;
label
:
string
;
placeholder
:
string
;
position
:
number
;
role
:
user_role
;
selectOptions
:
JsonValue
;
updatedAt
:
Date
;
validationRules
:
JsonValue
;
}
[]
;
totalRequirements
:
number
;
}
,
>
Parameters
userId
:
string
Returns
Promise
<
{
completedRequirements
:
number
;
completionPercentage
:
number
;
incompleteRequirements
:
{
createdAt
:
Date
;
description
:
string
;
fieldType
:
onboarding_field_type
;
id
:
string
;
isActive
:
boolean
;
isMandatory
:
boolean
;
isPaymentRelated
:
boolean
;
label
:
string
;
placeholder
:
string
;
position
:
number
;
role
:
user_role
;
selectOptions
:
JsonValue
;
updatedAt
:
Date
;
validationRules
:
JsonValue
;
}
[]
;
totalRequirements
:
number
;
}
,
>
get
Onboarding
Stats
getOnboardingStats
()
:
Promise
<
{
pendingReviews
:
number
;
requirementsByRole
:
(
PickEnumerable
<
OnboardingRequirementGroupByOutputType
,
"role"
[]
>
&
{
_count
:
{
role
:
number
}
;
}
)
[]
;
totalUsers
:
number
;
usersByStatus
:
(
PickEnumerable
<
ProfileGroupByOutputType
,
"onboardingStatus"
[]
>
&
{
_count
:
{
onboardingStatus
:
number
}
;
}
)
[]
;
}
,
>
Returns
Promise
<
{
pendingReviews
:
number
;
requirementsByRole
:
(
PickEnumerable
<
OnboardingRequirementGroupByOutputType
,
"role"
[]
>
&
{
_count
:
{
role
:
number
}
;
}
)
[]
;
totalUsers
:
number
;
usersByStatus
:
(
PickEnumerable
<
ProfileGroupByOutputType
,
"onboardingStatus"
[]
>
&
{
_count
:
{
onboardingStatus
:
number
}
;
}
)
[]
;
}
,
>
get
Requirement
By
Id
getRequirementById
(
id
:
string
,
)
:
Promise
<
{
createdAt
:
Date
;
description
:
string
;
fieldType
:
onboarding_field_type
;
id
:
string
;
isActive
:
boolean
;
isMandatory
:
boolean
;
isPaymentRelated
:
boolean
;
label
:
string
;
placeholder
:
string
;
position
:
number
;
role
:
user_role
;
selectOptions
:
JsonValue
;
updatedAt
:
Date
;
validationRules
:
JsonValue
;
}
,
>
Parameters
id
:
string
Returns
Promise
<
{
createdAt
:
Date
;
description
:
string
;
fieldType
:
onboarding_field_type
;
id
:
string
;
isActive
:
boolean
;
isMandatory
:
boolean
;
isPaymentRelated
:
boolean
;
label
:
string
;
placeholder
:
string
;
position
:
number
;
role
:
user_role
;
selectOptions
:
JsonValue
;
updatedAt
:
Date
;
validationRules
:
JsonValue
;
}
,
>
get
Requirements
By
Role
getRequirementsByRole
(
role
:
user_role
,
)
:
Promise
<
{
createdAt
:
Date
;
description
:
string
;
fieldType
:
onboarding_field_type
;
id
:
string
;
isActive
:
boolean
;
isMandatory
:
boolean
;
isPaymentRelated
:
boolean
;
label
:
string
;
placeholder
:
string
;
position
:
number
;
role
:
user_role
;
selectOptions
:
JsonValue
;
updatedAt
:
Date
;
validationRules
:
JsonValue
;
}
[]
,
>
Parameters
role
:
user_role
Returns
Promise
<
{
createdAt
:
Date
;
description
:
string
;
fieldType
:
onboarding_field_type
;
id
:
string
;
isActive
:
boolean
;
isMandatory
:
boolean
;
isPaymentRelated
:
boolean
;
label
:
string
;
placeholder
:
string
;
position
:
number
;
role
:
user_role
;
selectOptions
:
JsonValue
;
updatedAt
:
Date
;
validationRules
:
JsonValue
;
}
[]
,
>
get
Review
By
Id
getReviewById
(
id
:
string
,
)
:
Promise
<
{
admin
:
{
email
:
string
;
fullName
:
string
;
id
:
string
}
;
user
:
{
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
role
:
user_role
;
}
;
}
&
{
adminId
:
string
;
createdAt
:
Date
;
id
:
string
;
notes
:
string
;
rejectionReason
:
string
;
status
:
onboarding_status
;
updatedAt
:
Date
;
userId
:
string
;
}
,
>
Parameters
id
:
string
Returns
Promise
<
{
admin
:
{
email
:
string
;
fullName
:
string
;
id
:
string
}
;
user
:
{
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
role
:
user_role
;
}
;
}
&
{
adminId
:
string
;
createdAt
:
Date
;
id
:
string
;
notes
:
string
;
rejectionReason
:
string
;
status
:
onboarding_status
;
updatedAt
:
Date
;
userId
:
string
;
}
,
>
get
Submission
By
Id
getSubmissionById
(
id
:
string
,
)
:
Promise
<
{
requirement
:
{
createdAt
:
Date
;
description
:
string
;
fieldType
:
onboarding_field_type
;
id
:
string
;
isActive
:
boolean
;
isMandatory
:
boolean
;
isPaymentRelated
:
boolean
;
label
:
string
;
placeholder
:
string
;
position
:
number
;
role
:
user_role
;
selectOptions
:
JsonValue
;
updatedAt
:
Date
;
validationRules
:
JsonValue
;
}
;
user
:
{
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
role
:
user_role
;
}
;
}
&
{
createdAt
:
Date
;
fileUrl
:
string
;
id
:
string
;
requirementId
:
string
;
updatedAt
:
Date
;
userId
:
string
;
value
:
string
;
}
,
>
Parameters
id
:
string
Returns
Promise
<
{
requirement
:
{
createdAt
:
Date
;
description
:
string
;
fieldType
:
onboarding_field_type
;
id
:
string
;
isActive
:
boolean
;
isMandatory
:
boolean
;
isPaymentRelated
:
boolean
;
label
:
string
;
placeholder
:
string
;
position
:
number
;
role
:
user_role
;
selectOptions
:
JsonValue
;
updatedAt
:
Date
;
validationRules
:
JsonValue
;
}
;
user
:
{
businessName
:
string
;
email
:
string
;
fullName
:
string
;
id
:
string
;
role
:
user_role
;
}
;
}
&
{
createdAt
:
Date
;
fileUrl
:
string
;
id
:
string
;
requirementId
:
string
;
updatedAt
:
Date
;
userId
:
string
;
value
:
string
;
}
,
>
get
User
Reviews
getUserReviews
(
userId
:
string
,
)
:
Promise
<
(
{
admin
:
{
email
:
string
;
fullName
:
string
;
id
:
string
}
}
&
{
adminId
:
string
;
createdAt
:
Date
;
id
:
string
;
notes
:
string
;
rejectionReason
:
string
;
status
:
onboarding_status
;
updatedAt
:
Date
;
userId
:
string
;
}
)
[]
,
>
Parameters
userId
:
string
Returns
Promise
<
(
{
admin
:
{
email
:
string
;
fullName
:
string
;
id
:
string
}
}
&
{
adminId
:
string
;
createdAt
:
Date
;
id
:
string
;
notes
:
string
;
rejectionReason
:
string
;
status
:
onboarding_status
;
updatedAt
:
Date
;
userId
:
string
;
}
)
[]
,
>
get
Users
By
Onboarding
Status
getUsersByOnboardingStatus
(
status
:
onboarding_status
,
)
:
Promise
<
{
businessName
:
string
;
createdAt
:
Date
;
email
:
string
;
fullName
:
string
;
id
:
string
;
onboardingStatus
:
onboarding_status
;
role
:
user_role
;
}
[]
,
>
Parameters
status
:
onboarding_status
Returns
Promise
<
{
businessName
:
string
;
createdAt
:
Date
;
email
:
string
;
fullName
:
string
;
id
:
string
;
onboardingStatus
:
onboarding_status
;
role
:
user_role
;
}
[]
,
>
get
User
Submission
By
Requirement
getUserSubmissionByRequirement
(
userId
:
string
,
requirementId
:
string
,
)
:
Promise
<
{
requirement
:
{
createdAt
:
Date
;
description
:
string
;
fieldType
:
onboarding_field_type
;
id
:
string
;
isActive
:
boolean
;
isMandatory
:
boolean
;
isPaymentRelated
:
boolean
;
label
:
string
;
placeholder
:
string
;
position
:
number
;
role
:
user_role
;
selectOptions
:
JsonValue
;
updatedAt
:
Date
;
validationRules
:
JsonValue
;
}
;
}
&
{
createdAt
:
Date
;
fileUrl
:
string
;
id
:
string
;
requirementId
:
string
;
updatedAt
:
Date
;
userId
:
string
;
value
:
string
;
}
,
>
Parameters
userId
:
string
requirementId
:
string
Returns
Promise
<
{
requirement
:
{
createdAt
:
Date
;
description
:
string
;
fieldType
:
onboarding_field_type
;
id
:
string
;
isActive
:
boolean
;
isMandatory
:
boolean
;
isPaymentRelated
:
boolean
;
label
:
string
;
placeholder
:
string
;
position
:
number
;
role
:
user_role
;
selectOptions
:
JsonValue
;
updatedAt
:
Date
;
validationRules
:
JsonValue
;
}
;
}
&
{
createdAt
:
Date
;
fileUrl
:
string
;
id
:
string
;
requirementId
:
string
;
updatedAt
:
Date
;
userId
:
string
;
value
:
string
;
}
,
>
get
User
Submissions
getUserSubmissions
(
userId
:
string
,
)
:
Promise
<
(
{
requirement
:
{
createdAt
:
Date
;
description
:
string
;
fieldType
:
onboarding_field_type
;
id
:
string
;
isActive
:
boolean
;
isMandatory
:
boolean
;
isPaymentRelated
:
boolean
;
label
:
string
;
placeholder
:
string
;
position
:
number
;
role
:
user_role
;
selectOptions
:
JsonValue
;
updatedAt
:
Date
;
validationRules
:
JsonValue
;
}
;
}
&
{
createdAt
:
Date
;
fileUrl
:
string
;
id
:
string
;
requirementId
:
string
;
updatedAt
:
Date
;
userId
:
string
;
value
:
string
;
}
)
[]
,
>
Parameters
userId
:
string
Returns
Promise
<
(
{
requirement
:
{
createdAt
:
Date
;
description
:
string
;
fieldType
:
onboarding_field_type
;
id
:
string
;
isActive
:
boolean
;
isMandatory
:
boolean
;
isPaymentRelated
:
boolean
;
label
:
string
;
placeholder
:
string
;
position
:
number
;
role
:
user_role
;
selectOptions
:
JsonValue
;
updatedAt
:
Date
;
validationRules
:
JsonValue
;
}
;
}
&
{
createdAt
:
Date
;
fileUrl
:
string
;
id
:
string
;
requirementId
:
string
;
updatedAt
:
Date
;
userId
:
string
;
value
:
string
;
}
)
[]
,
>
submit
Requirement
submitRequirement
(
userId
:
string
,
submitRequirementDto
:
SubmitRequirementDto
,
)
:
Promise
<
{
createdAt
:
Date
;
fileUrl
:
string
;
id
:
string
;
requirementId
:
string
;
updatedAt
:
Date
;
userId
:
string
;
value
:
string
;
}
,
>
Parameters
userId
:
string
submitRequirementDto
:
SubmitRequirementDto
Returns
Promise
<
{
createdAt
:
Date
;
fileUrl
:
string
;
id
:
string
;
requirementId
:
string
;
updatedAt
:
Date
;
userId
:
string
;
value
:
string
;
}
,
>
update
Requirement
updateRequirement
(
id
:
string
,
updateRequirementDto
:
UpdateRequirementDto
,
)
:
Promise
<
{
createdAt
:
Date
;
description
:
string
;
fieldType
:
onboarding_field_type
;
id
:
string
;
isActive
:
boolean
;
isMandatory
:
boolean
;
isPaymentRelated
:
boolean
;
label
:
string
;
placeholder
:
string
;
position
:
number
;
role
:
user_role
;
selectOptions
:
JsonValue
;
updatedAt
:
Date
;
validationRules
:
JsonValue
;
}
,
>
Parameters
id
:
string
updateRequirementDto
:
UpdateRequirementDto
Returns
Promise
<
{
createdAt
:
Date
;
description
:
string
;
fieldType
:
onboarding_field_type
;
id
:
string
;
isActive
:
boolean
;
isMandatory
:
boolean
;
isPaymentRelated
:
boolean
;
label
:
string
;
placeholder
:
string
;
position
:
number
;
role
:
user_role
;
selectOptions
:
JsonValue
;
updatedAt
:
Date
;
validationRules
:
JsonValue
;
}
,
>
update
User
Onboarding
Status
updateUserOnboardingStatus
(
userId
:
string
,
status
:
onboarding_status
,
adminId
:
string
,
notes
?:
string
,
rejectionReason
?:
string
,
)
:
Promise
<
{
review
:
{
adminId
:
string
;
createdAt
:
Date
;
id
:
string
;
notes
:
string
;
rejectionReason
:
string
;
status
:
onboarding_status
;
updatedAt
:
Date
;
userId
:
string
;
}
;
user
:
{
avatarUrl
:
string
;
businessAddress
:
string
;
businessDescription
:
string
;
businessName
:
string
;
businessPhone
:
string
;
createdAt
:
Date
;
email
:
string
;
fullName
:
string
;
id
:
string
;
isSuspended
:
boolean
;
isVerified
:
boolean
;
onboardingStatus
:
onboarding_status
;
password
:
string
;
paymentAccountDetails
:
JsonValue
;
paymentAccountType
:
string
;
paymentDetailsVerified
:
boolean
;
paystackSubaccountId
:
string
;
paystackSubaccountVerified
:
boolean
;
phone
:
string
;
role
:
user_role
;
suspendedAt
:
Date
;
suspendedBy
:
string
;
suspensionReason
:
string
;
updatedAt
:
Date
;
}
;
}
,
>
Parameters
userId
:
string
status
:
onboarding_status
adminId
:
string
Optional
notes
:
string
Optional
rejectionReason
:
string
Returns
Promise
<
{
review
:
{
adminId
:
string
;
createdAt
:
Date
;
id
:
string
;
notes
:
string
;
rejectionReason
:
string
;
status
:
onboarding_status
;
updatedAt
:
Date
;
userId
:
string
;
}
;
user
:
{
avatarUrl
:
string
;
businessAddress
:
string
;
businessDescription
:
string
;
businessName
:
string
;
businessPhone
:
string
;
createdAt
:
Date
;
email
:
string
;
fullName
:
string
;
id
:
string
;
isSuspended
:
boolean
;
isVerified
:
boolean
;
onboardingStatus
:
onboarding_status
;
password
:
string
;
paymentAccountDetails
:
JsonValue
;
paymentAccountType
:
string
;
paymentDetailsVerified
:
boolean
;
paystackSubaccountId
:
string
;
paystackSubaccountVerified
:
boolean
;
phone
:
string
;
role
:
user_role
;
suspendedAt
:
Date
;
suspendedBy
:
string
;
suspensionReason
:
string
;
updatedAt
:
Date
;
}
;
}
,
>
validate
Submission
validateSubmission
(
userId
:
string
,
requirementId
:
string
,
value
?:
string
,
fileUrl
?:
string
,
)
:
Promise
<
boolean
>
Parameters
userId
:
string
requirementId
:
string
Optional
value
:
string
Optional
fileUrl
:
string
Returns
Promise
<
boolean
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
bulk
Submit
Requirements
create
Requirement
create
Review
delete
Requirement
get
All
Requirements
get
All
Reviews
get
Incomplete
Submissions
get
Onboarding
Stats
get
Requirement
By
Id
get
Requirements
By
Role
get
Review
By
Id
get
Submission
By
Id
get
User
Reviews
get
Users
By
Onboarding
Status
get
User
Submission
By
Requirement
get
User
Submissions
submit
Requirement
update
Requirement
update
User
Onboarding
Status
validate
Submission
urembo-hub-api
Loading...