sfrmobile-api - npm Package Compare versions

Comparing version 1.0.2 to 1.0.3

dist/index.js

@@ -95,7 +95,7 @@ "use strict";
     /**
-   * Historique de facturation d'une ligne mobile
-   * @param {string} line MSISDN de la ligne mobile à sélectionner
-   * @param {number} duration Nombre de périodes de facturation (6,12,18,24)
-   * @return {Promise<Facturation>}
-   */
+     * Historique de facturation d'une ligne mobile
+     * @param {string} line MSISDN de la ligne mobile à sélectionner
+     * @param {number} duration Nombre de périodes de facturation (6,12,18,24)
+     * @return {Promise<Facturation>}
+     */
     async getFacturationMobile(line, duration = 6) {
@@ -108,8 +108,8 @@ return (await this.instance({
     /**
-   * Télécharger la facture d'une ligne mobile
-   * @param {string} line MSISDN de la ligne mobile à sélectionner
-   * @param {string} numeroFacture Identifiant de facturation de la ligne mobile
-   * @param {boolean} fadet Facture détaillée
-   * @return {Promise<Stream>}
-   */
+     * Télécharger la facture d'une ligne mobile
+     * @param {string} line MSISDN de la ligne mobile à sélectionner
+     * @param {string} numeroFacture Identifiant de la facture de la ligne mobile
+     * @param {boolean} fadet Facture détaillée
+     * @return {Promise<Stream>}
+     */
     async downloadFactureMobile(line, numeroFacture, fadet = false) {
@@ -122,3 +122,28 @@ return (await this.instance({
     /**
-     * Fiche descriptive du compte de l'utilisateur courrant
+   * Historique de facturation d'une ligne fixe
+   * @param {string} line MSISDN de la ligne fixe
+   * @param {number} duration Nombre de périodes de facturation (6,12,18,24)
+   * @returns {Promise<FacturationFixe>}
+   */
+    async getFacturationFixe(line, duration = 6) {
+        return (await this.instance({
+            url: `https://selfcare-webservices.sfr.fr/services/facture-fixe-md/consulterfactures/${line}`,
+            params: { duration }
+        })).data;
+    }
+    /**
+     * Télécharger la facture d'une ligne fixe
+     * @param {string} line MSISDN de la ligne fixe
+     * @param {string} idFact Identifiant de la facture de la ligne fixe
+     * @return {Promise<Stream>}
+     */
+    async downloadFactureFixe(line, idFact) {
+        return (await this.instance({
+            url: `https://espace-client.sfr.fr/webservices/infosclientfixe/services/rest/1.0/facture/${line}`,
+            params: { idFact },
+            responseType: 'stream'
+        })).data;
+    }
+    /**
+     * Fiche descriptive du compte de l'utilisateur courant
      * @return {Promise<FicheMonCompte>}
@@ -155,5 +180,5 @@ */
     /**
-   * Notifications de l'utilisateur courant
-   * @return {Promise<Notifications>}
-   */
+     * Notifications de l'utilisateur courant
+    * @return {Promise<Notifications>}
+    */
     async getNotifications() {
@@ -178,9 +203,9 @@ return (await this.instance({
     /**
-   * Détail d'une option souscrite
-   * @param {string} line MSISDN de la ligne à sélectionner
-   * @param {Universe|string} universe SFR/RED
-   * @param {Environment|string} environment Type de ligne
-   * @param {string} option Identifiant de l'option
-   * @return {Promise<OptionDetail>}
-   */
+     * Détail d'une option souscrite
+     * @param {string} line MSISDN de la ligne à sélectionner
+     * @param {Universe|string} universe SFR/RED
+     * @param {Environment|string} environment Type de ligne
+     * @param {string} option Identifiant de l'option
+     * @return {Promise<OptionDetail>}
+     */
     async getOptionDetail(line, universe, environment, option) {
@@ -204,6 +229,6 @@ return (await this.instance({
     /**
-   * Catalogue détaillé des catégories d'options disponibles pour une ligne
-   * @param {string} line MSISDN de la ligne à sélectionner
-   * @return {Promise<OptionsCatalogDetail>}
-   */
+     * Catalogue détaillé des catégories d'options disponibles pour une ligne
+     * @param {string} line MSISDN de la ligne à sélectionner
+     * @return {Promise<OptionsCatalogDetail>}
+     */
     async getOptionsCatalogDetail(line) {
@@ -274,7 +299,7 @@ return (await this.instance({
     /**
-   * Mettre à jour les droits d'achat sur la ligne
-   * @param {string} selectedLine MSISDN de la ligne à sélectionner
-   * @param {string} otp Code à usage unique obtenu avec getOTPSMS()
-   * @param {OptionsAchat} data Droits d'achats à permuter
-   */
+     * Mettre à jour les droits d'achat sur la ligne
+     * @param {string} selectedLine MSISDN de la ligne à sélectionner
+     * @param {string} otp Code à usage unique obtenu avec getOTPSMS()
+     * @param {OptionsAchat} data Droits d'achats à permuter
+     */
     async postPaiementTiersOptionsAchat(selectedLine, otp, data) {
@@ -295,3 +320,3 @@ return (await this.instance({
      * @param line MSISDN de la ligne à sélectionner
-     * @return {Promise<{codeRetour: number, secured: boolean, line: string}>}
+     * @return {Promise<OTPSMSResponse>}
      */
@@ -303,3 +328,14 @@ async getOTPSMS(line) {
     }
+    /**
+   * Informations sur les remises Multi-Pack
+   * @param line MSISDN de la ligne à sélectionner
+   * @returns {Promise<OffreAmes>}
+   */
+    async getOffreAME(line) {
+        return (await this.instance({
+            url: 'https://www.sfr.fr/webservices/selfcare/offre-ws/rest/public/v41/ames',
+            params: { ligne: line }
+        })).data;
+    }
 }
 exports.SfrMobile = SfrMobile;

package.json

 {
   "name": "sfrmobile-api",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "main": "dist/index.js",
@@ -5,0 +5,0 @@ "types": "types/index.d.ts",

README.md

@@ -15,2 +15,4 @@ <a name="SfrMobile"></a>
         * [.downloadFactureMobile(line, numeroFacture, fadet)](#SfrMobile+downloadFactureMobile) ⇒ <code>Promise.&lt;Stream&gt;</code>
+        * [.getFacturationFixe(line, duration)](#SfrMobile+getFacturationFixe) ⇒ <code>Promise.&lt;FacturationFixe&gt;</code>
+        * [.downloadFactureFixe(line, idFact)](#SfrMobile+downloadFactureFixe) ⇒ <code>Promise.&lt;Stream&gt;</code>
         * [.getFicheMonCompte()](#SfrMobile+getFicheMonCompte) ⇒ <code>Promise.&lt;FicheMonCompte&gt;</code>
@@ -30,3 +32,4 @@ * [.getDashboard(line)](#SfrMobile+getDashboard) ⇒ <code>Promise.&lt;Dashboard&gt;</code>
         * [.postPaiementTiersOptionsAchat(selectedLine, otp, data)](#SfrMobile+postPaiementTiersOptionsAchat)
-        * [.getOTPSMS(line)](#SfrMobile+getOTPSMS) ⇒ <code>Promise.&lt;{codeRetour: number, secured: boolean, line: string}&gt;</code>
+        * [.getOTPSMS(line)](#SfrMobile+getOTPSMS) ⇒ <code>Promise.&lt;OTPSMSResponse&gt;</code>
+        * [.getOffreAME(line)](#SfrMobile+getOffreAME) ⇒ <code>Promise.&lt;OffreAmes&gt;</code>
     * _static_
@@ -90,9 +93,33 @@ * [.login(username, password, duration, universe)](#SfrMobile.login) ⇒ <code>Promise.&lt;LoginResponse&gt;</code>
 | line | <code>string</code> |  | MSISDN de la ligne mobile à sélectionner |
-| numeroFacture | <code>string</code> |  | Identifiant de facturation de la ligne mobile |
+| numeroFacture | <code>string</code> |  | Identifiant de la facture de la ligne mobile |
 | fadet | <code>boolean</code> | <code>false</code> | Facture détaillée |
 
+<a name="SfrMobile+getFacturationFixe"></a>
+
+### sfrMobile.getFacturationFixe(line, duration) ⇒ <code>Promise.&lt;FacturationFixe&gt;</code>
+Historique de facturation d'une ligne fixe
+
+**Kind**: instance method of [<code>SfrMobile</code>](#SfrMobile)  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| line | <code>string</code> |  | MSISDN de la ligne fixe |
+| duration | <code>number</code> | <code>6</code> | Nombre de périodes de facturation (6,12,18,24) |
+
+<a name="SfrMobile+downloadFactureFixe"></a>
+
+### sfrMobile.downloadFactureFixe(line, idFact) ⇒ <code>Promise.&lt;Stream&gt;</code>
+Télécharger la facture d'une ligne fixe
+
+**Kind**: instance method of [<code>SfrMobile</code>](#SfrMobile)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| line | <code>string</code> | MSISDN de la ligne fixe |
+| idFact | <code>string</code> | Identifiant de la facture de la ligne fixe |
+
 <a name="SfrMobile+getFicheMonCompte"></a>
 
 ### sfrMobile.getFicheMonCompte() ⇒ <code>Promise.&lt;FicheMonCompte&gt;</code>
-Fiche descriptive du compte de l'utilisateur courrant
+Fiche descriptive du compte de l'utilisateur courant
 
@@ -251,3 +278,3 @@ **Kind**: instance method of [<code>SfrMobile</code>](#SfrMobile)
 
-### sfrMobile.getOTPSMS(line) ⇒ <code>Promise.&lt;{codeRetour: number, secured: boolean, line: string}&gt;</code>
+### sfrMobile.getOTPSMS(line) ⇒ <code>Promise.&lt;OTPSMSResponse&gt;</code>
 Obtenir un code à usage unique pour effectuer une opération
@@ -261,2 +288,13 @@
 
+<a name="SfrMobile+getOffreAME"></a>
+
+### sfrMobile.getOffreAME(line) ⇒ <code>Promise.&lt;OffreAmes&gt;</code>
+Informations sur les remises Multi-Pack
+
+**Kind**: instance method of [<code>SfrMobile</code>](#SfrMobile)  
+
+| Param | Description |
+| --- | --- |
+| line | MSISDN de la ligne à sélectionner |
+
 <a name="SfrMobile.login"></a>
@@ -263,0 +301,0 @@

types/index.d.ts

@@ -19,2 +19,5 @@ /// <reference types="node" />
 import { VerifyUsernameResponse } from './entities/VerifyUsernameResponse';
+import { OTPSMSResponse } from './entities/OTPSMSResponse';
+import { OffreAmes } from './entities/OffreAmes';
+import { FacturationFixe } from './entities/FacturationFixe';
 export declare enum Universe {
@@ -77,18 +80,32 @@ SFR = "SFR",
     /**
-   * Historique de facturation d'une ligne mobile
-   * @param {string} line MSISDN de la ligne mobile à sélectionner
-   * @param {number} duration Nombre de périodes de facturation (6,12,18,24)
-   * @return {Promise<Facturation>}
-   */
+     * Historique de facturation d'une ligne mobile
+     * @param {string} line MSISDN de la ligne mobile à sélectionner
+     * @param {number} duration Nombre de périodes de facturation (6,12,18,24)
+     * @return {Promise<Facturation>}
+     */
     getFacturationMobile(line: string, duration?: 6 | 12 | 18 | 24): Promise<Facturation>;
     /**
-   * Télécharger la facture d'une ligne mobile
-   * @param {string} line MSISDN de la ligne mobile à sélectionner
-   * @param {string} numeroFacture Identifiant de facturation de la ligne mobile
-   * @param {boolean} fadet Facture détaillée
-   * @return {Promise<Stream>}
-   */
+     * Télécharger la facture d'une ligne mobile
+     * @param {string} line MSISDN de la ligne mobile à sélectionner
+     * @param {string} numeroFacture Identifiant de la facture de la ligne mobile
+     * @param {boolean} fadet Facture détaillée
+     * @return {Promise<Stream>}
+     */
     downloadFactureMobile(line: string, numeroFacture: string, fadet?: boolean): Promise<Stream>;
     /**
-     * Fiche descriptive du compte de l'utilisateur courrant
+   * Historique de facturation d'une ligne fixe
+   * @param {string} line MSISDN de la ligne fixe
+   * @param {number} duration Nombre de périodes de facturation (6,12,18,24)
+   * @returns {Promise<FacturationFixe>}
+   */
+    getFacturationFixe(line: string, duration?: 6 | 12 | 18 | 24): Promise<FacturationFixe>;
+    /**
+     * Télécharger la facture d'une ligne fixe
+     * @param {string} line MSISDN de la ligne fixe
+     * @param {string} idFact Identifiant de la facture de la ligne fixe
+     * @return {Promise<Stream>}
+     */
+    downloadFactureFixe(line: string, idFact: string): Promise<Stream>;
+    /**
+     * Fiche descriptive du compte de l'utilisateur courant
      * @return {Promise<FicheMonCompte>}
@@ -110,5 +127,5 @@ */
     /**
-   * Notifications de l'utilisateur courant
-   * @return {Promise<Notifications>}
-   */
+     * Notifications de l'utilisateur courant
+    * @return {Promise<Notifications>}
+    */
     getNotifications(): Promise<Notifications>;
@@ -123,9 +140,9 @@ /**
     /**
-   * Détail d'une option souscrite
-   * @param {string} line MSISDN de la ligne à sélectionner
-   * @param {Universe|string} universe SFR/RED
-   * @param {Environment|string} environment Type de ligne
-   * @param {string} option Identifiant de l'option
-   * @return {Promise<OptionDetail>}
-   */
+     * Détail d'une option souscrite
+     * @param {string} line MSISDN de la ligne à sélectionner
+     * @param {Universe|string} universe SFR/RED
+     * @param {Environment|string} environment Type de ligne
+     * @param {string} option Identifiant de l'option
+     * @return {Promise<OptionDetail>}
+     */
     getOptionDetail(line: string, universe: Universe | string, environment: Environment | string, option: string): Promise<OptionDetail>;
@@ -139,6 +156,6 @@ /**
     /**
-   * Catalogue détaillé des catégories d'options disponibles pour une ligne
-   * @param {string} line MSISDN de la ligne à sélectionner
-   * @return {Promise<OptionsCatalogDetail>}
-   */
+     * Catalogue détaillé des catégories d'options disponibles pour une ligne
+     * @param {string} line MSISDN de la ligne à sélectionner
+     * @return {Promise<OptionsCatalogDetail>}
+     */
     getOptionsCatalogDetail(line: string): Promise<OptionsCatalogDetail>;
@@ -181,7 +198,7 @@ /**
     /**
-   * Mettre à jour les droits d'achat sur la ligne
-   * @param {string} selectedLine MSISDN de la ligne à sélectionner
-   * @param {string} otp Code à usage unique obtenu avec getOTPSMS()
-   * @param {OptionsAchat} data Droits d'achats à permuter
-   */
+     * Mettre à jour les droits d'achat sur la ligne
+     * @param {string} selectedLine MSISDN de la ligne à sélectionner
+     * @param {string} otp Code à usage unique obtenu avec getOTPSMS()
+     * @param {OptionsAchat} data Droits d'achats à permuter
+     */
     postPaiementTiersOptionsAchat(selectedLine: string, otp: string, data: OptionsAchat): Promise<any>;
@@ -191,9 +208,11 @@ /**
      * @param line MSISDN de la ligne à sélectionner
-     * @return {Promise<{codeRetour: number, secured: boolean, line: string}>}
+     * @return {Promise<OTPSMSResponse>}
      */
-    getOTPSMS(line: string): Promise<{
-        codeRetour: number;
-        secured: boolean;
-        line: string;
-    }>;
+    getOTPSMS(line: string): Promise<OTPSMSResponse>;
+    /**
+   * Informations sur les remises Multi-Pack
+   * @param line MSISDN de la ligne à sélectionner
+   * @returns {Promise<OffreAmes>}
+   */
+    getOffreAME(line: string): Promise<OffreAmes>;
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

94150

increased by8.84%

Number of package files

44

increased by15.79%

Lines of code

1230

increased by15.17%

Number of lines in readme file

321

increased by13.43%

No dependency changes