diff --git a/src/components/PCE/Coefficient.ts b/src/components/PCE/Coefficient.ts index d2e758d..7606b9e 100644 --- a/src/components/PCE/Coefficient.ts +++ b/src/components/PCE/Coefficient.ts @@ -1,5 +1,9 @@ export interface PCECoefficient { id: number + /** + * Profil Type de consommation + * @see profil + */ profil: string mois1: number mois2: number diff --git a/src/components/PCE/Seuils.ts b/src/components/PCE/Seuils.ts index 2544a67..6f608da 100644 --- a/src/components/PCE/Seuils.ts +++ b/src/components/PCE/Seuils.ts @@ -1,21 +1,60 @@ export interface Seuils { - id: number | null - idSouscriptionAssocier: number | null + /** + * Identifiant du seuil + */ + id: number + idSouscriptionAssocier: number + /** + * Fréquence de mesure associé au seuil + */ frequence: 'Annuel' | 'Mensuel' | 'Journalier' - pce: string | null + /** + * Numéro unique identifiant le Point de Comptage et d'Estimation + */ + pce: string pourcentage?: number notification: { + /** + * Indique si le client a souhaité être averti du dépassement par courriel + */ mail: boolean + /** + * Indique si le client a souhaité être averti du dépassement par SMS + */ sms: boolean + /** + * Indique si le client a souhaité être averti avant le dépassement du seuil + */ notifierAvantSeuil: boolean + /** + * Indique si le client a souhaité être averti après le dépassement du seuil + */ notifierApresSeuil: boolean + /** + * Date de début de l'alerte + */ dateDebut: string | number + /** + * Date de fin de l'alerte + */ dateFin: string | number + /** + * Mode de notification de l'alerte + */ modeNotifReceived?: string | null } seuils: Array<{ + /** + * Valeur du seuil en kWh + */ valeur: number + /** + * Mois du seuil + */ mois: number + /** + * Année du seuil + */ annee: number }> } diff --git a/src/index.ts b/src/index.ts index c6f9122..63acd34 100644 --- a/src/index.ts +++ b/src/index.ts @@ -307,6 +307,7 @@ export class GRDF { /** * Obtention d'un jeton d'accès auprès de l'API + * * Attention: ne JAMAIS transmettre ce jeton à un tier, il vous est strictement personnel ! * @param {string} email Courriel de connexion de l'utilisateur * @param {string} password Mot de passe