sfrmobile-api v1.0.9

SfrMobile

Support non-officiel de l'API mobile de SFR/RED. Les identifiants utilisés sont les mêmes que pour se connecter sur le site de l'opérateur.

Kind: global class

• SfrMobile
  • new SfrMobile(casauthenticationtoken)
  • instance
    • .getConso(line) ⇒ Promise.<Consumption>
    • .getConsoNationale(line) ⇒ Promise.<ConsumptionNationale>
    • .getFacturationMobile(line, duration) ⇒ Promise.<Facturation>
    • .downloadFactureMobile(line, numeroFacture, fadet) ⇒ Promise.<Stream>
    • .getFacturationFixe(line, duration) ⇒ Promise.<FacturationFixe>
    • .downloadFactureFixe(line, idFact) ⇒ Promise.<Stream>
    • .getInfosClientFixe(line) ⇒ Promise.<InfosClientFixe>
    • .getFicheMonCompte() ⇒ Promise.<FicheMonCompte>
    • .getDashboard(line) ⇒ Promise.<Dashboard>
    • .getInfosPersonnelles(line) ⇒ Promise.<InfoPersonnelles>
    • .getNotificationsCount() ⇒ Promise.<NotificationsCount>
    • .getNotifications() ⇒ Promise.<{notifications: Array.<Notification>}>
    • .getEquipements(line, universe) ⇒ Promise.<Equipement>
    • .getOptionDetail(line, universe, environment, option) ⇒ Promise.<OptionDetail>
    • .getOptionsCatalog(line) ⇒ Promise.<OptionsCatalog>
    • .getOptionsCatalogDetail(line) ⇒ Promise.<OptionsCatalogDetail>
    • .getOptions(line, category) ⇒ Promise.<OptionsList>
    • .getEquipementDetail(line, optionCode, universe) ⇒ Promise.<EquipementDetail>
    • .getParc(line, universe, environment) ⇒ Promise.<Parc>
    • .getPaiementTiersAchatsAbonnements(line) ⇒ Promise.<AchatsAbonnements>
    • .getPaiementTiersOptionsAchat(line) ⇒ Promise.<OptionsAchat>
    • .postPaiementTiersOptionsAchat(selectedLine, otp, data)
    • .getOTPSMS(line) ⇒ Promise.<OTPSMSResponse>
    • .getOffreAMES(line) ⇒ Promise.<OffreAmes>
  • static
    • .login(username, password, duration, universe) ⇒ Promise.<LoginResponse>
    • .verifyUsername(username, universe) ⇒ Promise.<VerifyUsernameResponse>
    • .getTerminalInfoIMEI(imei) ⇒ Promise.<InfosTerminalIMEI>
    • .getTerminalInfo(id, type) ⇒ Promise.<InfosTerminal>
    • .getTerminauxInfo(ids, type) ⇒ Promise.<Array.<InfosTerminal>>

new SfrMobile(casauthenticationtoken)

Example

const { SfrMobile } = require('sfrmobile-api')

SfrMobile.login(username, password).then(({ token }) => {
   const user = new SfrMobile(token)
   // Votre code
})

sfrMobile.getConso(line) ⇒ Promise.<Consumption>

Consommation générale de la ligne

Kind: instance method of SfrMobile

sfrMobile.getConsoNationale(line) ⇒ Promise.<ConsumptionNationale>

Historique de la consommation sur le territoire national

Kind: instance method of SfrMobile

sfrMobile.getFacturationMobile(line, duration) ⇒ Promise.<Facturation>

Historique de facturation d'une ligne mobile

Kind: instance method of SfrMobile

sfrMobile.downloadFactureMobile(line, numeroFacture, fadet) ⇒ Promise.<Stream>

Télécharger la facture d'une ligne mobile

Kind: instance method of SfrMobile

sfrMobile.getFacturationFixe(line, duration) ⇒ Promise.<FacturationFixe>

Historique de facturation d'une ligne fixe

Kind: instance method of SfrMobile

sfrMobile.downloadFactureFixe(line, idFact) ⇒ Promise.<Stream>

Télécharger la facture d'une ligne fixe

Kind: instance method of SfrMobile

sfrMobile.getInfosClientFixe(line) ⇒ Promise.<InfosClientFixe>

Détails de la ligne fixe

Kind: instance method of SfrMobile

sfrMobile.getFicheMonCompte() ⇒ Promise.<FicheMonCompte>

Fiche descriptive du compte de l'utilisateur courant

Kind: instance method of SfrMobile

sfrMobile.getDashboard(line) ⇒ Promise.<Dashboard>

Informations générales de la ligne

Kind: instance method of SfrMobile

sfrMobile.getInfosPersonnelles(line) ⇒ Promise.<InfoPersonnelles>

Informations personnelles concernant la ligne

Kind: instance method of SfrMobile

sfrMobile.getNotificationsCount() ⇒ Promise.<NotificationsCount>

Nombre de notifications de l'utilisateur

Kind: instance method of SfrMobile

sfrMobile.getNotifications() ⇒ Promise.<{notifications: Array.<Notification>}>

Lister les notifications de l'utilisateur

Kind: instance method of SfrMobile

sfrMobile.getEquipements(line, universe) ⇒ Promise.<Equipement>

Liste des équipements mis à disposition pour une ligne

Kind: instance method of SfrMobile

sfrMobile.getOptionDetail(line, universe, environment, option) ⇒ Promise.<OptionDetail>

Détail d'une option souscrite

Kind: instance method of SfrMobile

sfrMobile.getOptionsCatalog(line) ⇒ Promise.<OptionsCatalog>

Catalogue des catégories d'options disponibles pour une ligne

Kind: instance method of SfrMobile

sfrMobile.getOptionsCatalogDetail(line) ⇒ Promise.<OptionsCatalogDetail>

Catalogue détaillé des catégories d'options disponibles pour une ligne

Kind: instance method of SfrMobile

sfrMobile.getOptions(line, category) ⇒ Promise.<OptionsList>

Lister les options disponibles dans une catégorie

Kind: instance method of SfrMobile

sfrMobile.getEquipementDetail(line, optionCode, universe) ⇒ Promise.<EquipementDetail>

Obtenir la description complète de l'équipement

Kind: instance method of SfrMobile

sfrMobile.getParc(line, universe, environment) ⇒ Promise.<Parc>

Détails de l'offre d'une ligne

Kind: instance method of SfrMobile

sfrMobile.getPaiementTiersAchatsAbonnements(line) ⇒ Promise.<AchatsAbonnements>

Liste des achats et abonnements (hors forfait) sur la ligne

Kind: instance method of SfrMobile

sfrMobile.getPaiementTiersOptionsAchat(line) ⇒ Promise.<OptionsAchat>

Droits d'achat sur la ligne (Stores, jeux, ...)

Kind: instance method of SfrMobile

sfrMobile.postPaiementTiersOptionsAchat(selectedLine, otp, data)

Mettre à jour les droits d'achat sur la ligne

Kind: instance method of SfrMobile

sfrMobile.getOTPSMS(line) ⇒ Promise.<OTPSMSResponse>

Obtenir un code à usage unique pour effectuer une opération

Kind: instance method of SfrMobile

sfrMobile.getOffreAMES(line) ⇒ Promise.<OffreAmes>

Informations sur les remises Multi-Pack

Kind: instance method of SfrMobile

SfrMobile.login(username, password, duration, universe) ⇒ Promise.<LoginResponse>

Obtenir un jeton d'authentification auprès du CAS de SFR

Kind: static method of SfrMobile

SfrMobile.verifyUsername(username, universe) ⇒ Promise.<VerifyUsernameResponse>

Tester la validité d'un nom d'utilisateur

Kind: static method of SfrMobile

SfrMobile.getTerminalInfoIMEI(imei) ⇒ Promise.<InfosTerminalIMEI>

Description du terminal associé à un IMEI

Kind: static method of SfrMobile

SfrMobile.getTerminalInfo(id, type) ⇒ Promise.<InfosTerminal>

Description du terminal associé à un identifiant

Kind: static method of SfrMobile

SfrMobile.getTerminauxInfo(ids, type) ⇒ Promise.<Array.<InfosTerminal>>

Description des terminaux associés à leur identifiant

Kind: static method of SfrMobile