urembo-hub-api
Preparing search index...
onboarding/onboarding.controller
OnboardingController
Class OnboardingController
Index
Constructors
constructor
Methods
bulk
Submit
Requirements
create
Requirement
create
Review
delete
Requirement
get
All
Requirements
get
All
Reviews
get
My
Incomplete
Submissions
get
My
Reviews
get
My
Submissions
get
Onboarding
Stats
get
Public
Requirements
By
Role
get
Requirement
By
Id
get
Requirements
By
Role
get
Review
By
Id
get
Submission
By
Id
get
Users
By
Onboarding
Status
get
User
Submissions
submit
Requirement
update
Requirement
update
User
Onboarding
Status
Constructors
constructor
new
OnboardingController
(
onboardingService
:
OnboardingService
,
)
:
OnboardingController
Parameters
onboardingService
:
OnboardingService
Returns
OnboardingController
Methods
bulk
Submit
Requirements
bulkSubmitRequirements
(
bulkSubmitDto
:
BulkSubmitDto
,
req
:
any
)
:
Promise
<
any
[]
>
Parameters
bulkSubmitDto
:
BulkSubmitDto
req
:
any
Returns
Promise
<
any
[]
>
create
Requirement
createRequirement
(
createRequirementDto
:
CreateRequirementDto
,
req
:
any
,
)
:
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
req
:
any
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
(
reviewSubmissionDto
:
ReviewSubmissionDto
,
req
:
any
,
)
:
Promise
<
{
adminId
:
string
;
createdAt
:
Date
;
id
:
string
;
notes
:
string
;
rejectionReason
:
string
;
status
:
onboarding_status
;
updatedAt
:
Date
;
userId
:
string
;
}
,
>
Parameters
reviewSubmissionDto
:
ReviewSubmissionDto
req
:
any
Returns
Promise
<
{
adminId
:
string
;
createdAt
:
Date
;
id
:
string
;
notes
:
string
;
rejectionReason
:
string
;
status
:
onboarding_status
;
updatedAt
:
Date
;
userId
:
string
;
}
,
>
delete
Requirement
deleteRequirement
(
id
:
string
,
req
:
any
,
)
:
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
req
:
any
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
(
req
:
any
,
)
:
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
req
:
any
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
My
Incomplete
Submissions
getMyIncompleteSubmissions
(
req
:
any
,
)
:
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
req
:
any
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
My
Reviews
getMyReviews
(
req
:
any
,
)
:
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
req
:
any
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
My
Submissions
getMySubmissions
(
req
:
any
,
)
:
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
req
:
any
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
Onboarding
Stats
getOnboardingStats
(
req
:
any
,
)
:
Promise
<
{
pendingReviews
:
number
;
requirementsByRole
:
(
PickEnumerable
<
OnboardingRequirementGroupByOutputType
,
"role"
[]
>
&
{
_count
:
{
role
:
number
}
;
}
)
[]
;
totalUsers
:
number
;
usersByStatus
:
(
PickEnumerable
<
ProfileGroupByOutputType
,
"onboardingStatus"
[]
>
&
{
_count
:
{
onboardingStatus
:
number
}
;
}
)
[]
;
}
,
>
Parameters
req
:
any
Returns
Promise
<
{
pendingReviews
:
number
;
requirementsByRole
:
(
PickEnumerable
<
OnboardingRequirementGroupByOutputType
,
"role"
[]
>
&
{
_count
:
{
role
:
number
}
;
}
)
[]
;
totalUsers
:
number
;
usersByStatus
:
(
PickEnumerable
<
ProfileGroupByOutputType
,
"onboardingStatus"
[]
>
&
{
_count
:
{
onboardingStatus
:
number
}
;
}
)
[]
;
}
,
>
get
Public
Requirements
By
Role
getPublicRequirementsByRole
(
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
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
,
req
:
any
,
)
:
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
req
:
any
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
,
req
:
any
,
)
:
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
req
:
any
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
Users
By
Onboarding
Status
getUsersByOnboardingStatus
(
status
:
onboarding_status
,
req
:
any
,
)
:
Promise
<
{
businessName
:
string
;
createdAt
:
Date
;
email
:
string
;
fullName
:
string
;
id
:
string
;
onboardingStatus
:
onboarding_status
;
role
:
user_role
;
}
[]
,
>
Parameters
status
:
onboarding_status
req
:
any
Returns
Promise
<
{
businessName
:
string
;
createdAt
:
Date
;
email
:
string
;
fullName
:
string
;
id
:
string
;
onboardingStatus
:
onboarding_status
;
role
:
user_role
;
}
[]
,
>
get
User
Submissions
getUserSubmissions
(
userId
:
string
,
req
:
any
,
)
:
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
req
:
any
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
(
submitRequirementDto
:
SubmitRequirementDto
,
req
:
any
,
)
:
Promise
<
{
createdAt
:
Date
;
fileUrl
:
string
;
id
:
string
;
requirementId
:
string
;
updatedAt
:
Date
;
userId
:
string
;
value
:
string
;
}
,
>
Parameters
submitRequirementDto
:
SubmitRequirementDto
req
:
any
Returns
Promise
<
{
createdAt
:
Date
;
fileUrl
:
string
;
id
:
string
;
requirementId
:
string
;
updatedAt
:
Date
;
userId
:
string
;
value
:
string
;
}
,
>
update
Requirement
updateRequirement
(
id
:
string
,
updateRequirementDto
:
UpdateRequirementDto
,
req
:
any
,
)
:
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
req
:
any
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
,
body
:
{
notes
?:
string
;
rejectionReason
?:
string
;
status
:
onboarding_status
;
}
,
req
:
any
,
)
:
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
body
:
{
notes
?:
string
;
rejectionReason
?:
string
;
status
:
onboarding_status
}
req
:
any
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
;
}
;
}
,
>
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
My
Incomplete
Submissions
get
My
Reviews
get
My
Submissions
get
Onboarding
Stats
get
Public
Requirements
By
Role
get
Requirement
By
Id
get
Requirements
By
Role
get
Review
By
Id
get
Submission
By
Id
get
Users
By
Onboarding
Status
get
User
Submissions
submit
Requirement
update
Requirement
update
User
Onboarding
Status
urembo-hub-api
Loading...