grdf-api

GRDF

Support non-officiel de l'API GRDF

Kind: global class

• GRDF
  • new GRDF(token)
  • .getUserInfo() ⇒ Promise.<UserInfo>
  • .getUserDetails(id) ⇒ Promise.<UserInfo>
  • .putUserDetails(id, userInfoDetails) ⇒ Promise.<UserInfo>
  • .getConsultationHistory() ⇒ Promise.<Array.<HistoriqueConsultation>>
  • .getPCEList() ⇒ Promise.<Array.<PCE>>
  • .getPCEAddress(pce) ⇒ Promise.<Adresse>
  • .getPCEDetails(pce) ⇒ Promise.<PCE>
  • .getPCEDetailsPlus() ⇒ Promise.<Array.<PCE>>
  • .getPCECoefficient(pce) ⇒ Promise.<PCECoefficient>
  • .getPCEMeteo(pce, dateFinPeriode, nbJour) ⇒
  • .getPCEConsoRef(pce) ⇒ Promise.<Array.<ConsommationReference>>
  • .getPCEConsumption(type, pceList, dateDebut, dateFin) ⇒ Promise.<Consommation>
  • .getConsumptionSheet(type, pceList, frequence, dateDebut, dateFin) ⇒ Promise.<stream>

new GRDF(token)

Param	Type	Description
token	string	Jeton d'accès obtenu avec la méthode GRDF.login(email, password)

Example

const { GRDF, ConsommationType } = require('grdf-api')
const pce = '01234567890123'
GRDF.login('email', 'password').then(async token => {
    const user = new GRDF(token)
    const consommation = await user.getPCEConsumption(ConsommationType.informatives, [pce], '2021-09-01', '2021-12-01')
    console.log(consommation[pce].releves)
})

grdF.getUserInfo() ⇒ Promise.<UserInfo>

Informations générales sur l'utilisateur connecté

Kind: instance method of GRDF

grdF.getUserDetails(id) ⇒ Promise.<UserInfo>

Détails sur un utilisateur

Kind: instance method of GRDF

Param	Type	Description
id	number	Identifiant de l'utilisateur

grdF.putUserDetails(id, userInfoDetails) ⇒ Promise.<UserInfo>

Mise à jour du profil de l'utilisateur

Kind: instance method of GRDF

Param	Type	Description
id	number	Identifiant de l'utilisateur
userInfoDetails	UserInfoDetails	Les informations de l'utilisateur à modifier

grdF.getConsultationHistory() ⇒ Promise.<Array.<HistoriqueConsultation>>

Historique de consultation des informations du PCE

Kind: instance method of GRDF

grdF.getPCEList() ⇒ Promise.<Array.<PCE>>

Liste des PCE associés à l'utilisateur

Kind: instance method of GRDF

grdF.getPCEAddress(pce) ⇒ Promise.<Adresse>

Adresse d'un PCE spécifique

Kind: instance method of GRDF

Param	Type	Description
pce	string	Numéro du PCE

grdF.getPCEDetails(pce) ⇒ Promise.<PCE>

Détails d'un PCE

Kind: instance method of GRDF

Param	Type	Description
pce	string	Numéro du PCE

grdF.getPCEDetailsPlus() ⇒ Promise.<Array.<PCE>>

Informations les plus détaillées sur les PCE associés à l'utilisateur

Kind: instance method of GRDF

grdF.getPCECoefficient(pce) ⇒ Promise.<PCECoefficient>

Kind: instance method of GRDF

Param	Type	Description
pce	string	Numéro du PCE

grdF.getPCEMeteo(pce, dateFinPeriode, nbJour) ⇒

Kind: instance method of GRDF
Returns: Objet dont les clés sont les dates et les valeurs sont les températures associées

Param	Type	Description
pce	string	Numéro du PCE
dateFinPeriode	string	Date de fin au format YYYY-MM-DD
nbJour	number	Nombre de jour

grdF.getPCEConsoRef(pce) ⇒ Promise.<Array.<ConsommationReference>>

Consommation annuelle de référence

Kind: instance method of GRDF

Param	Type	Description
pce	string	Numéro du PCE

grdF.getPCEConsumption(type, pceList, dateDebut, dateFin) ⇒ Promise.<Consommation>

Relevés de consommation

Kind: instance method of GRDF

Param	Type	Description
type	ConsommationType	informatives: les plus détaillés, publiees: destinées à la facturation
pceList	Array.<string>	Liste des numéros de PCE
dateDebut	string	Date de début au format YYYY-MM-DD
dateFin	string	Date de fin au format YYYY-MM-DD

grdF.getConsumptionSheet(type, pceList, frequence, dateDebut, dateFin) ⇒ Promise.<stream>

Stream d'une feuille de calcul déjà formatée contenant les relevés

Kind: instance method of GRDF

Param	Type	Description
type	ConsommationType	informatives: les plus détaillés, publiees: destinées à la facturation
pceList	Array.<string>	Liste des numéros de PCE
frequence	Frequency	Fréquence des relevés (Mensuel, Hebdomadaire, Journalier, Horaire)
dateDebut	string	Date de début au format YYYY-MM-DD
dateFin	string	Date de fin au format YYYY-MM-DD