From e379da917efb166f4a42fb236bcf801936dbb460 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Julien=20Fastr=C3=A9?= <julien.fastre@champs-libres.coop>
Date: Fri, 3 Jun 2022 14:15:28 +0200
Subject: [PATCH] ajout doc personnes ressources usager

---
 admin/generation-documents.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/admin/generation-documents.md b/admin/generation-documents.md
index 1c58024..5f1617d 100644
--- a/admin/generation-documents.md
+++ b/admin/generation-documents.md
@@ -312,6 +312,7 @@ Présence à l'échange
 * `memo` (texte): le mémo
 * `numberOfChildren` (texte): le nombre d'enfants
 * `address` (Adresse): l'adresse actuelle
+* `resources` (PersonResource): les personnes ressources, ajoutées depuis le dossier de l'usager.
 
 ::: { .vendee }
 
@@ -520,6 +521,28 @@ Téléphone du père: ${personFatherFirstphonenumber} // 01 23 45 67 89
 
 ::: { .vendee }
 
+### PersonResource (Ressources associée à l'usager)
+
+Pour rappel, les ressources peuvent être:
+
+* des tiers;
+* des usagers;
+* ou un champ de texte libre.
+
+
+* `comment` (Comment)
+* `freeText` (texte): commentaire, quand la personne ressources un texte libre
+* `id` (int)
+* `kind` (PersonResourceKind): le type de personne ressources (voisin, etc.)
+* `thirdParty` (ThirdParty): le tiers, quand la ressources est liée à un tiers
+* `person` (Person): l'usager, quand la ressources liée à un autre usager
+* `resourceKind` (texte): un discriminateur qui permet de vérifier si la ressources est lié à un usager (alors égal à `person`, un tiers (`thirdparty`) ou un texte libre (`freetext`). A utiliser dans les conditions dans les documents.
+
+### PersonResourceKind (Type de personne ressource)
+
+* `id` (int)
+* `title` (texte) 
+
 ### StatutLogement
 
 * `id` (int): identifiant (utile pour des comparaisons);