User
User
Description
L'entitĂ© User regroupe les informations relatives Ă l'utilisateur actif de l'OAV (gĂ©nĂ©ralement un apporteur ou un courtier, mais peut ĂȘtre un end user dans le cadre d'un OAV ouvert au public).
Relations
Ascendantes
Entité | Propriété |
|---|---|
Project | users |
Descendantes
Entité | Propriété |
|---|---|
GDPR | GDPRs |
Address | addresses |
emails | |
History | history |
Phone | phones |
Liste des propriétés
Nom | Type | DerniÚre version modifiée | Description | Getter | Setter | Deprecated |
|---|---|---|---|---|---|---|
ORIAS | String | 2.6.1 | numéro/ID ORIAS de la société de l'utilisateur dans le cas d'un courtier | getUserORIAS | setUserORIAS | - |
companyName | String | 2.0.0 | Nom de la société de l'utilisateur (agence, cabinet, etc) | getUserCompanyName | setUserCompanyName | - |
createdAt | Date | ï»ż | Date de crĂ©ation de l'entitĂ© User | getUserCreatedAt | Lecture seule | - |
createdBy | String | ï»ż | Utilisateur Ă l'origine de la crĂ©ation de l'entitĂ© User | getUserCreatedBy | Lecture seule | - |
String | 2.0.0 | E-mail de l'utilisateur | getUserEmail | setUserEmail | - | |
externalId | String | 2.0.0 | Identifiant externe (exemple : id du CRM) | getUserExternalId | setUserExternalId | - |
firstName | String | 2.0.0 | Prénom de l'utilisateur | getUserFirstName | setUserFirstName | - |
id | String | ï»ż | Identifiant unique de l'entitĂ© User | getUserId | Lecture seule | - |
lastName | String | 2.0.0 | Nom de famille l'utilisateur | getUserLastName | setUserLastName | - |
login | String | 2.0.0 | Login de l'utilisateur | getUserLogin | setUserLogin | - |
network | String | 2.0.0 | Réseau de courtiers auquel appartient l'utilisateur | getUserNetwork | setUserNetwork | - |
origin | userOriginEnum | 2.22.0 | Origine du décrochage de l'utilisateur au moment du décrochage. | getUserOrigin | setUserOrigin | - |
roles | String[] | 2.0.0 | Roles de l'utilisateur | getUserRoles | setUserRoles | - |
updatedAt | Date | ï»ż | Date de modification de l'entitĂ© User | getUserUpdatedAt | Lecture seule | - |
updatedBy | String | ï»ż | Utilisateur Ă l'origine de la modification de l'entitĂ© User | getUserUpdatedBy | Lecture seule | - |
Enums
userOriginEnum
- userOriginEnum.CRM
- userOriginEnum.SELF
Exemple
import { Entities } from '@fasstech/oip-core';
import { getProjectId } from '@fasstech/oip-core/entities/project';
import { getUserCompanyName, getUserEmail, getUserExternalId, getUserFirstName, getUserLastName, getUserLogin, getUserNetwork, getUserORIAS, getUserOrigin, getUserRoles, getuserId, setUserCompanyName, setUserEmail, setUserExternalId, setUserFirstName, setUserLastName, setUserLogin, setUserNetwork, setUserORIAS, setUserOrigin, setUserRoles } from '@fasstech/oip-core/entities/user';
import { userOriginEnum } from '@fasstech/oip-core/entities/user/enums';
(async () => {
let ProjectEntity = await Entities('Project').get({ id: projectId });
const UserEntity = await Entities('User').create();
setUserORIAS('OOOOOOOO', UserEntity);
setUserCompanyName('companyName', UserEntity);
setUserEmail('email', UserEntity);
setUserExternalId('externalId', UserEntity);
setUserFirstName('firstName', UserEntity);
setUserLastName('lastName', UserEntity);
setUserLogin('login', UserEntity);
setUserNetwork('network', UserEntity);
setUserOrigin(userOriginEnum.SELF, UserEntity);
setUserRoles(['roles'], UserEntity);
ProjectEntity = await Entities('User').save(ProjectEntity, UserEntity);
await Entities('Project').save(ProjectEntity);
const ProjectEntityToTest = await Entities('Project').get({ id: getProjectId(ProjectEntity) });
const UserEntityToTest = await Entities('User').get(ProjectEntityToTest, getUserId(UserEntity));
getUserORIAS(UserEntityToTest); // 'OOOOOOOO'
getUserCompanyName(UserEntityToTest); // 'companyName'
getUserEmail(UserEntityToTest); // 'email'
getUserExternalId(UserEntityToTest); // 'externalId'
getUserFirstName(UserEntityToTest); // 'firstName'
getUserLastName(UserEntityToTest); // 'lastName'
getUserLogin(UserEntityToTest); // 'login'
getUserNetwork(UserEntityToTest); // 'network'
getUserOrigin(UserEntityToTest); // userOriginEnum.SELF
getUserRoles(UserEntityToTest); // ['roles']
})();