diff --git a/README.md b/README.md index 2f57811..e45a015 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,9 @@ Ce module permet de gérer et récupérer la consommation des compteurs communic * [.getUserAccreditation()](#GRDF+getUserAccreditation) ⇒ Promise.<Array.<Accreditation>> * [.putUserAccreditation(pce, partialPCE)](#GRDF+putUserAccreditation) ⇒ Promise.<PCE> * [.getInfoLogements()](#GRDF+getInfoLogements) ⇒ Promise.<Array.<InfoLogement>> - * [.getInfoLogementPCE()](#GRDF+getInfoLogementPCE) ⇒ Promise.<InfoLogement> + * [.getInfoLogementPCE(pce)](#GRDF+getInfoLogementPCE) ⇒ Promise.<InfoLogement> + * [.getConnaissancesClient(pce)](#GRDF+getConnaissancesClient) ⇒ Promise.<ConnaissancesClient> + * [.patchConnaissancesClient(id, data)](#GRDF+patchConnaissancesClient) ⇒ Promise.<ConnaissancesClient> * _static_ * [.login(email, password)](#GRDF.login) ⇒ Promise.<string> @@ -294,7 +296,7 @@ Mise à jour de l'accréditation (changement de l'alias par exemple) | Param | Type | Description | | --- | --- | --- | | pce | string | Identifiant du PCE | -| partialPCE | | | +| partialPCE | | L'objet PCE revendiqué | @@ -304,10 +306,38 @@ Informations sur le logement **Kind**: instance method of [GRDF](#GRDF) -### grdF.getInfoLogementPCE() ⇒ Promise.<InfoLogement> +### grdF.getInfoLogementPCE(pce) ⇒ Promise.<InfoLogement> Informations sur le logement d'un PCE **Kind**: instance method of [GRDF](#GRDF) + +| Param | Type | Description | +| --- | --- | --- | +| pce | string | Identifiant PCE | + + + +### grdF.getConnaissancesClient(pce) ⇒ Promise.<ConnaissancesClient> +Informations sur le client (type de logement, surface, mode de chauffage, etc.) + +**Kind**: instance method of [GRDF](#GRDF) + +| Param | Type | Description | +| --- | --- | --- | +| pce | string | Identifiant PCE | + + + +### grdF.patchConnaissancesClient(id, data) ⇒ Promise.<ConnaissancesClient> +Mettre à jour le formulaire de connaissances client (type de logement, surface, mode de chauffage, etc.) + +**Kind**: instance method of [GRDF](#GRDF) + +| Param | Type | Description | +| --- | --- | --- | +| id | number | Identifiant du formulaire | +| data | ConnaissancesClient | Données partielles à mettre à jour dans le formulaire | + ### GRDF.login(email, password) ⇒ Promise.<string> diff --git a/src/components/User/index.ts b/src/components/User/index.ts index e6facf1..a7fcb96 100644 --- a/src/components/User/index.ts +++ b/src/components/User/index.ts @@ -1,3 +1,4 @@ export { HistoriqueConsultation, HistoriqueConsultationRequest } from './HistoriqueConsultation' export { Accreditation } from './Accreditation' export { InfoLogement } from './InfoLogement' +export { UserInfo } from './UserInfo' diff --git a/src/index.ts b/src/index.ts index ce8f43c..3128d62 100644 --- a/src/index.ts +++ b/src/index.ts @@ -5,9 +5,8 @@ import { OktaAuth } from '@okta/okta-auth-js' import { wrapper } from 'axios-cookiejar-support' import { CookieJar } from 'tough-cookie' -import { UserInfo } from './components/User/UserInfo' import { PCE, Adresse, Consommation, ConsommationReference, ConsommationType, Frequency, PCECoefficient, Seuils, SeuilsCreated, ConnaissancesClient } from './components/PCE' -import { Accreditation, HistoriqueConsultation, HistoriqueConsultationRequest, InfoLogement } from './components/User' +import { Accreditation, HistoriqueConsultation, HistoriqueConsultationRequest, InfoLogement, UserInfo } from './components/User' import { HTMLResponseError } from './components/Errors'