Skip to main content

geekle-demand-user-service

This service handles the user information and creation of the demand user entity in the platform.

Custom Fields

These are the additional fields for a demand site user added from src/custom-user-fields.ts.

Field NameTypeDescription
katakana_namestringthe katakana name of the user
profession_category_namesarraya list of profession catagories the user belongs to
skillsarraya list of skills the user has
years_experienceobjecthow many years of experience the user has
compensation_typestringthe users preferred compensation type, eg month
compensation_amountstringthe users preferred compensation amount
is_signup_wizard_completebooleanhas the user completed the sign up wizard

Custom Validators

Inside src/custom-user-fields.ts custom field validators have been added to check the user has an valid data.

EndpointsValidator NameDescription
createUservalid_katakana_createchecks if katakana_name contains only katakana
updateUservalid_katakana_updatechecks if katakana_name contains only katakana
createUservalid_years_experience_createchecks if years_experience is in the correct format eg 'lt1', '1-3', '3-5', '5-10', 'gt10'
updateUservalid_years_experience_createchecks if years_experience is in the correct format eg 'lt1', '1-3', '3-5', '5-10', 'gt10'
createUservalid_compensation_type_createchecks if the compensation_type is 'month', 'hour', 'day'
updateUservalid_compensation_type_updatechecks if the compensation_type is 'month', 'hour', 'day'
createUservalid_compensation_type_updatechecks if valid_compensation_type is in the correct format
updateUservalid_compensation_type_updatechecks if valid_compensation_type is in the correct format
createUservalid_compensation_type_amount_createchecks if the compensation_amount is in the correct format
updateUservalid_compensation_type_amount_createchecks if the compensation_amount is in the correct format

Custom Emails

The custom emails are stored inside src/emails and enabled from the src/index.ts file.

EndpointsTemplateDescription
updateUsernew-registered-users.htmlsends an email to the user on the demand site which was created.

Disabled Endpoints

Some endpoints are disabled because they are unused.

  adapter = sdkAdapter.setEnabledAdapterMethods(adapter, [
'createUser',
'updateUser',
'getUser',
'resetPassword',
'changeUserPassword',
'sendResetPasswordEmail',
'sendVerificationEmail',
'verifyEmail',
'changeUserEmail',
'verifyChangeEmail',
'deactivateUser',
'checkUserPassword',
'createUserForAdmin',
'listAttachments',
]);