Skip to content

Commit

Permalink
docs: update type documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
maelgangloff committed Apr 28, 2024
1 parent 6a46cca commit 3af6d42
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 3 deletions.
4 changes: 4 additions & 0 deletions src/components/PCE/Coefficient.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
export interface PCECoefficient {
id: number
/**
* Profil Type de consommation
* @see profil
*/
profil: string
mois1: number
mois2: number
Expand Down
45 changes: 42 additions & 3 deletions src/components/PCE/Seuils.ts
Original file line number Diff line number Diff line change
@@ -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
}>
}
Expand Down
1 change: 1 addition & 0 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 3af6d42

Please sign in to comment.