sfrmobile-api - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

dist/index.js

@@ -6,3 +6,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SfrMobile = exports.Universe = void 0;
+exports.SfrMobile = exports.Environment = exports.Universe = void 0;
 const axios_1 = __importDefault(require("axios"));
@@ -14,2 +14,7 @@ var Universe;
 })(Universe = exports.Universe || (exports.Universe = {}));
+var Environment;
+(function (Environment) {
+    Environment["MOBILE"] = "MOBILE";
+    Environment["FIXE"] = "FIXE";
+})(Environment = exports.Environment || (exports.Environment = {}));
 /**
@@ -127,3 +132,3 @@ * Support non-officiel de l'API mobile de SFR/RED.
      * @param {string} line MSISDN de la ligne à sélectionner
-     * @param {Universe} universe SFR/RED
+     * @param {Universe|string} universe SFR/RED
      */
@@ -137,2 +142,15 @@ async getEquipements(line, universe = Universe.SFR) {
     /**
+   * 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
+   */
+    async getOptionDetail(line, universe, environment, option) {
+        return (await this.instance({
+            url: `https://www.sfr.fr/webservices/parc/v1/APPLI_MOBILE/option/${option}`,
+            params: { line, environment, universe }
+        })).data;
+    }
+    /**
      * Catalogue des catégories d'options
@@ -162,3 +180,3 @@ * @param {string} line MSISDN de la ligne à sélectionner
      * @param {string} optionCode Identifiant de l'option d'équipement
-     * @param {string} universe SFR/RED
+     * @param {Universe|string} universe SFR/RED
      */
@@ -174,6 +192,6 @@ async getEquipementDetail(line, optionCode, universe = Universe.SFR) {
      * @param {string} line MSISDN de la ligne à sélectionner
-     * @param {string} universe SFR/RED
-     * @param {string} environment Environnement de l'utilisateur (MOBILE)
+     * @param {Universe|string} universe SFR/RED
+     * @param {Environment|string} environment Type de ligne
      */
-    async getParc(line, universe = Universe.SFR, environment = 'MOBILE') {
+    async getParc(line, universe = Universe.SFR, environment = Environment.MOBILE) {
         return (await this.instance({
@@ -210,2 +228,3 @@ url: 'https://www.sfr.fr/webservices/parc/v1/APPLI_MOBILE/parc',
         return (await this.instance({
+            method: 'POST',
             url: 'https://selfcare-webservices.sfr.fr/webservices/paiement-tiers/services/rest/smartphones/2.0/options-achat/modification',
@@ -212,0 +231,0 @@ params: { platform: 'smartphones', selectedLine, typeActe: 'optionsAchats' },

package.json

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

README.md

@@ -19,2 +19,3 @@ <a name="SfrMobile"></a>
         * [.getEquipements(line, universe)](#SfrMobile+getEquipements)
+        * [.getOptionDetail(line, universe, environment, option)](#SfrMobile+getOptionDetail)
         * [.getOptionsCatalog(line)](#SfrMobile+getOptionsCatalog)
@@ -119,4 +120,18 @@ * [.getOptions(line, category)](#SfrMobile+getOptions)
 | line | <code>string</code> | MSISDN de la ligne à sélectionner |
-| universe | <code>Universe</code> | SFR/RED |
+| universe | <code>Universe</code> \| <code>string</code> | SFR/RED |
 
+<a name="SfrMobile+getOptionDetail"></a>
+
+### sfrMobile.getOptionDetail(line, universe, environment, option)
+Détail d'une option souscrite
+
+**Kind**: instance method of [<code>SfrMobile</code>](#SfrMobile)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| line | <code>string</code> | MSISDN de la ligne à sélectionner |
+| universe | <code>Universe</code> \| <code>string</code> | SFR/RED |
+| environment | <code>Environment</code> \| <code>string</code> | Type de ligne |
+| option | <code>string</code> | Identifiant de l'option |
+
 <a name="SfrMobile+getOptionsCatalog"></a>
@@ -156,3 +171,3 @@
 | optionCode | <code>string</code> | Identifiant de l'option d'équipement |
-| universe | <code>string</code> | SFR/RED |
+| universe | <code>Universe</code> \| <code>string</code> | SFR/RED |
 
@@ -166,7 +181,7 @@ <a name="SfrMobile+getParc"></a>
 
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| line | <code>string</code> |  | MSISDN de la ligne à sélectionner |
-| universe | <code>string</code> |  | SFR/RED |
-| environment | <code>string</code> | <code>&quot;MOBILE&quot;</code> | Environnement de l'utilisateur (MOBILE) |
+| Param | Type | Description |
+| --- | --- | --- |
+| line | <code>string</code> | MSISDN de la ligne à sélectionner |
+| universe | <code>Universe</code> \| <code>string</code> | SFR/RED |
+| environment | <code>Environment</code> \| <code>string</code> | Type de ligne |
 
@@ -173,0 +188,0 @@ <a name="SfrMobile+getPaiementTiersAchatsAbonnements"></a>

types/index.d.ts

@@ -14,2 +14,3 @@ import { Consumption, ConsumptionNationale } from './entities/Consumption';
 import { OptionsAchat } from './entities/OptionsAchat';
+import { OptionDetail } from './entities/OptionDetail';
 export declare enum Universe {
@@ -19,2 +20,6 @@ SFR = "SFR",
 }
+export declare enum Environment {
+    MOBILE = "MOBILE",
+    FIXE = "FIXE"
+}
 /**
@@ -83,6 +88,14 @@ * Support non-officiel de l'API mobile de SFR/RED.
      * @param {string} line MSISDN de la ligne à sélectionner
-     * @param {Universe} universe SFR/RED
+     * @param {Universe|string} universe SFR/RED
      */
-    getEquipements(line: string, universe?: Universe): Promise<Equipement>;
+    getEquipements(line: string, universe?: Universe | string): Promise<Equipement>;
     /**
+   * 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
+   */
+    getOptionDetail(line: string, universe: Universe | string, environment: Environment | string, option: string): Promise<OptionDetail>;
+    /**
      * Catalogue des catégories d'options
@@ -102,12 +115,12 @@ * @param {string} line MSISDN de la ligne à sélectionner
      * @param {string} optionCode Identifiant de l'option d'équipement
-     * @param {string} universe SFR/RED
+     * @param {Universe|string} universe SFR/RED
      */
-    getEquipementDetail(line: string, optionCode: string, universe?: Universe): Promise<EquipementDetail>;
+    getEquipementDetail(line: string, optionCode: string, universe?: Universe | string): Promise<EquipementDetail>;
     /**
      * Détails de l'offre d'une ligne
      * @param {string} line MSISDN de la ligne à sélectionner
-     * @param {string} universe SFR/RED
-     * @param {string} environment Environnement de l'utilisateur (MOBILE)
+     * @param {Universe|string} universe SFR/RED
+     * @param {Environment|string} environment Type de ligne
      */
-    getParc(line: string, universe?: Universe, environment?: string): Promise<Parc>;
+    getParc(line: string, universe?: Universe | string, environment?: Environment | string): Promise<Parc>;
     /**
@@ -114,0 +127,0 @@ * Liste des achats et abonnements (hors forfait) sur la ligne

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

74666

increased by3.81%

Number of package files

33

increased by6.45%

Lines of code

900

increased by6.64%

Number of lines in readme file

243

increased by6.58%

No dependency changes