@ricado/api-client 1.4.1 → 2.0.0

package/lib/Models/Site/AlarmModel.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 
-var _BaseSiteModel2 = _interopRequireDefault(require("../../Models/Site/BaseSiteModel"));
+var _BaseModel2 = _interopRequireDefault(require("../../Models/BaseModel"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
@@ -36,10 +36,10 @@ function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.g
  * 
  * @class
  * @hideconstructor
- * @extends BaseSiteModel
+ * @extends BaseModel
  */
-var AlarmModel = /*#__PURE__*/function (_BaseSiteModel) {
-  _inherits(AlarmModel, _BaseSiteModel);
+var AlarmModel = /*#__PURE__*/function (_BaseModel) {
+  _inherits(AlarmModel, _BaseModel);
 
   var _super = _createSuper(AlarmModel);
 
@@ -47,9 +47,8 @@ var AlarmModel = /*#__PURE__*/function (_BaseSiteModel) {
    * AlarmModel Constructor
    * 
    * @protected
-   * @param {number} siteId The Site ID associated with this Alarm
    */
-  function AlarmModel(siteId) {
+  function AlarmModel() {
     var _this;
 
     _classCallCheck(this, AlarmModel);
@@ -59,409 +58,154 @@ var AlarmModel = /*#__PURE__*/function (_BaseSiteModel) {
      * The Alarm ID
      * 
      * @type {string}
-     * @private
+     * @public
      */
 
-    _this._id = undefined;
+    _this.id = undefined;
     /**
      * The RTU this Alarm belongs to
      * 
      * @type {?number}
-     * @private
+     * @public
      */
 
-    _this._rtuId = undefined;
+    _this.rtuId = undefined;
     /**
      * The Alarm Group this Alarm is a part of
      * 
      * @type {string}
-     * @private
+     * @public
      */
 
-    _this._groupId = undefined;
+    _this.groupId = undefined;
     /**
      * The Alarm Name
      * 
      * @type {string}
-     * @private
+     * @public
      */
 
-    _this._name = undefined;
+    _this.name = undefined;
     /**
      * Whether the Alarm is Critical or not
      * 
      * @type {boolean}
-     * @private
+     * @public
      */
 
-    _this._critical = undefined;
+    _this.critical = undefined;
     /**
      * The Python Script with the Conditions to Trip this Alarm
      * 
      * @type {string}
-     * @private
+     * @public
      */
 
-    _this._tripScript = undefined;
+    _this.tripScript = undefined;
     /**
      * The Python Script with the Conditions to Reset this Alarm
      * 
      * @type {?string}
-     * @private
+     * @public
      */
 
-    _this._resetScript = undefined;
+    _this.resetScript = undefined;
     /**
      * The Delay before this Alarm will Trip in Milliseconds
      * 
      * @type {number}
-     * @private
+     * @public
      */
 
-    _this._tripDelay = undefined;
+    _this.tripDelay = undefined;
     /**
      * The Delay before this Alarm will Reset in Milliseconds
      * 
      * @type {number}
-     * @private
+     * @public
      */
 
-    _this._resetDelay = undefined;
+    _this.resetDelay = undefined;
     /**
      * Whether the Alarm should Automatically Reset
      * 
      * @type {boolean}
-     * @private
+     * @public
      */
 
-    _this._autoReset = undefined;
+    _this.autoReset = undefined;
     /**
      * The Delay before this Alarm should Auto Reset in Milliseconds
      * 
      * @type {number}
-     * @private
+     * @public
      */
 
-    _this._autoResetDelay = undefined;
+    _this.autoResetDelay = undefined;
     /**
      * The Point used to store the Alarm Tripped State
      * 
      * @type {number}
-     * @private
+     * @public
      */
 
-    _this._trippedStatePoint = undefined;
+    _this.trippedStatePoint = undefined;
     /**
      * The Point used to store the Alarm Tripped Timestamp
      * 
      * @type {number}
-     * @private
+     * @public
      */
 
-    _this._trippedTimestampPoint = undefined;
+    _this.trippedTimestampPoint = undefined;
     /**
      * The Point used to store the Alarm's Internal Trip Start
      * 
      * @type {number}
-     * @private
+     * @public
      */
 
-    _this._internalTripStartPoint = undefined;
+    _this.internalTripStartPoint = undefined;
     /**
      * The Point used to store the Alarm's Internal Reset Start
      * 
      * @type {number}
-     * @private
+     * @public
      */
 
-    _this._internalResetStartPoint = undefined;
+    _this.internalResetStartPoint = undefined;
     /**
      * Whether the Alarm has been deleted
      * 
      * @type {boolean}
-     * @private
+     * @public
      */
 
-    _this._deleted = undefined;
+    _this.deleted = undefined;
     /**
      * When the Alarm was last updated
      * 
      * @type {Date}
-     * @private
-     */
-
-    _this._updateTimestamp = undefined;
-    /**
-     * The Site ID associated with this Alarm
-     * 
-     * @type {number}
-     * @private
+     * @public
      */
 
-    _this._siteId = siteId;
+    _this.updateTimestamp = undefined;
     return _this;
   }
   /**
-   * The Alarm ID
+   * Create a new **AlarmModel** from a JSON Object or JSON String
    * 
+   * @static
    * @public
-   * @type {string}
+   * @param {Object<string, any>|string} json A JSON Object or JSON String
+   * @return {AlarmModel}
    */
 
 
-  _createClass(AlarmModel, [{
-    key: "id",
-    get: function get() {
-      return this._id;
-    }
-    /**
-     * The RTU this Alarm belongs to
-     * 
-     * @public
-     * @type {?number}
-     */
-
-  }, {
-    key: "rtuId",
-    get: function get() {
-      return this._rtuId;
-    }
-    /**
-     * The Alarm Group this Alarm is a part of
-     * 
-     * @public
-     * @type {string}
-     */
-
-  }, {
-    key: "groupId",
-    get: function get() {
-      return this._groupId;
-    }
-    /**
-     * The Alarm Name
-     * 
-     * @public
-     * @type {string}
-     */
-
-  }, {
-    key: "name",
-    get: function get() {
-      return this._name;
-    }
-    /**
-     * Whether the Alarm is Critical or not
-     * 
-     * @public
-     * @type {boolean}
-     */
-
-  }, {
-    key: "critical",
-    get: function get() {
-      return this._critical;
-    }
-    /**
-     * The Python Script with the Conditions to Trip this Alarm
-     * 
-     * @public
-     * @type {string}
-     */
-
-  }, {
-    key: "tripScript",
-    get: function get() {
-      return this._tripScript;
-    }
-    /**
-     * The Python Script with the Conditions to Reset this Alarm
-     * 
-     * @public
-     * @type {?string}
-     */
-
-  }, {
-    key: "resetScript",
-    get: function get() {
-      return this._resetScript;
-    }
-    /**
-     * The Delay before this Alarm will Trip in Milliseconds
-     * 
-     * @public
-     * @type {number}
-     */
-
-  }, {
-    key: "tripDelay",
-    get: function get() {
-      return this._tripDelay;
-    }
-    /**
-     * The Delay before this Alarm will Reset in Milliseconds
-     * 
-     * @public
-     * @type {number}
-     */
-
-  }, {
-    key: "resetDelay",
-    get: function get() {
-      return this._resetDelay;
-    }
-    /**
-     * Whether the Alarm should Automatically Reset
-     * 
-     * @public
-     * @type {boolean}
-     */
-
-  }, {
-    key: "autoReset",
-    get: function get() {
-      return this._autoReset;
-    }
-    /**
-     * The Delay before this Alarm should Auto Reset in Milliseconds
-     * 
-     * @public
-     * @type {number}
-     */
-
-  }, {
-    key: "autoResetDelay",
-    get: function get() {
-      return this._autoResetDelay;
-    }
-    /**
-     * The Point used to store the Alarm Tripped State
-     * 
-     * @public
-     * @type {number}
-     */
-
-  }, {
-    key: "trippedStatePoint",
-    get: function get() {
-      return this._trippedStatePoint;
-    }
-    /**
-     * The Point used to store the Alarm Tripped Timestamp
-     * 
-     * @public
-     * @type {number}
-     */
-
-  }, {
-    key: "trippedTimestampPoint",
-    get: function get() {
-      return this._trippedTimestampPoint;
-    }
-    /**
-     * The Point used to store the Alarm's Internal Trip Start
-     * 
-     * @public
-     * @type {number}
-     */
-
-  }, {
-    key: "internalTripStartPoint",
-    get: function get() {
-      return this._internalTripStartPoint;
-    }
-    /**
-     * The Point used to store the Alarm's Internal Reset Start
-     * 
-     * @public
-     * @type {number}
-     */
-
-  }, {
-    key: "internalResetStartPoint",
-    get: function get() {
-      return this._internalResetStartPoint;
-    }
-    /**
-     * Whether the Alarm has been deleted
-     * 
-     * @public
-     * @type {boolean}
-     */
-
-  }, {
-    key: "deleted",
-    get: function get() {
-      return this._deleted;
-    }
-    /**
-     * When the Alarm was last updated
-     * 
-     * @public
-     * @type {Date}
-     */
-
-  }, {
-    key: "updateTimestamp",
-    get: function get() {
-      return this._updateTimestamp;
-    }
-    /**
-     * The Site ID associated with this Alarm
-     * 
-     * @public
-     * @type {number}
-     */
-
-  }, {
-    key: "siteId",
-    get: function get() {
-      return this._siteId;
-    }
-    /**
-     * Convert this **AlarmModel** to a JSON Object
-     * 
-     * @public
-     * @return {Object<string, any>}
-     */
-
-  }, {
-    key: "toJSON",
-    value: function toJSON() {
-      return {
-        id: this._id,
-        rtuId: this._rtuId,
-        groupId: this._groupId,
-        name: this._name,
-        critical: this._critical,
-        tripScript: this._tripScript,
-        resetScript: this._resetScript,
-        tripDelay: this._tripDelay,
-        resetDelay: this._resetDelay,
-        autoReset: this._autoReset,
-        autoResetDelay: this._autoResetDelay,
-        trippedStatePoint: this._trippedStatePoint,
-        trippedTimestampPoint: this._trippedTimestampPoint,
-        internalTripStartPoint: this._internalTripStartPoint,
-        internalResetStartPoint: this._internalResetStartPoint,
-        deleted: this._deleted,
-        updateTimestamp: this._updateTimestamp
-      };
-    }
-    /**
-     * Create a new **AlarmModel** from a JSON Object or JSON String
-     * 
-     * @static
-     * @public
-     * @param {Object<string, any>|string} json A JSON Object or JSON String
-     * @param {number} siteId The Site ID associated with this Alarm
-     * @return {AlarmModel}
-     */
-
-  }], [{
+  _createClass(AlarmModel, null, [{
     key: "fromJSON",
-    value: function fromJSON(json, siteId) {
-      var model = new AlarmModel(siteId);
+    value: function fromJSON(json) {
+      var model = new AlarmModel();
       /**
        * The JSON Object
        * 
@@ -477,7 +221,7 @@ var AlarmModel = /*#__PURE__*/function (_BaseSiteModel) {
       }
 
       if ('id' in jsonObject) {
-        model._id = function () {
+        model.id = function () {
           if (typeof jsonObject['id'] !== 'string') {
             return String(jsonObject['id']);
           }
@@ -487,7 +231,7 @@ var AlarmModel = /*#__PURE__*/function (_BaseSiteModel) {
       }
 
       if ('rtuId' in jsonObject) {
-        model._rtuId = function () {
+        model.rtuId = function () {
           if (jsonObject['rtuId'] === null) {
             return null;
           }
@@ -501,7 +245,7 @@ var AlarmModel = /*#__PURE__*/function (_BaseSiteModel) {
       }
 
       if ('groupId' in jsonObject) {
-        model._groupId = function () {
+        model.groupId = function () {
           if (typeof jsonObject['groupId'] !== 'string') {
             return String(jsonObject['groupId']);
           }
@@ -511,7 +255,7 @@ var AlarmModel = /*#__PURE__*/function (_BaseSiteModel) {
       }
 
       if ('name' in jsonObject) {
-        model._name = function () {
+        model.name = function () {
           if (typeof jsonObject['name'] !== 'string') {
             return String(jsonObject['name']);
           }
@@ -521,7 +265,7 @@ var AlarmModel = /*#__PURE__*/function (_BaseSiteModel) {
       }
 
       if ('critical' in jsonObject) {
-        model._critical = function () {
+        model.critical = function () {
           if (typeof jsonObject['critical'] !== 'boolean') {
             return Boolean(jsonObject['critical']);
           }
@@ -531,7 +275,7 @@ var AlarmModel = /*#__PURE__*/function (_BaseSiteModel) {
       }
 
       if ('tripScript' in jsonObject) {
-        model._tripScript = function () {
+        model.tripScript = function () {
           if (typeof jsonObject['tripScript'] !== 'string') {
             return String(jsonObject['tripScript']);
           }
@@ -541,7 +285,7 @@ var AlarmModel = /*#__PURE__*/function (_BaseSiteModel) {
       }
 
       if ('resetScript' in jsonObject) {
-        model._resetScript = function () {
+        model.resetScript = function () {
           if (jsonObject['resetScript'] === null) {
             return null;
           }
@@ -555,7 +299,7 @@ var AlarmModel = /*#__PURE__*/function (_BaseSiteModel) {
       }
 
       if ('tripDelay' in jsonObject) {
-        model._tripDelay = function () {
+        model.tripDelay = function () {
           if (typeof jsonObject['tripDelay'] !== 'number') {
             return Number.isInteger(Number(jsonObject['tripDelay'])) ? Number(jsonObject['tripDelay']) : Math.floor(Number(jsonObject['tripDelay']));
           }
@@ -565,7 +309,7 @@ var AlarmModel = /*#__PURE__*/function (_BaseSiteModel) {
       }
 
       if ('resetDelay' in jsonObject) {
-        model._resetDelay = function () {
+        model.resetDelay = function () {
           if (typeof jsonObject['resetDelay'] !== 'number') {
             return Number.isInteger(Number(jsonObject['resetDelay'])) ? Number(jsonObject['resetDelay']) : Math.floor(Number(jsonObject['resetDelay']));
           }
@@ -575,7 +319,7 @@ var AlarmModel = /*#__PURE__*/function (_BaseSiteModel) {
       }
 
       if ('autoReset' in jsonObject) {
-        model._autoReset = function () {
+        model.autoReset = function () {
           if (typeof jsonObject['autoReset'] !== 'boolean') {
             return Boolean(jsonObject['autoReset']);
           }
@@ -585,7 +329,7 @@ var AlarmModel = /*#__PURE__*/function (_BaseSiteModel) {
       }
 
       if ('autoResetDelay' in jsonObject) {
-        model._autoResetDelay = function () {
+        model.autoResetDelay = function () {
           if (typeof jsonObject['autoResetDelay'] !== 'number') {
             return Number.isInteger(Number(jsonObject['autoResetDelay'])) ? Number(jsonObject['autoResetDelay']) : Math.floor(Number(jsonObject['autoResetDelay']));
           }
@@ -595,7 +339,7 @@ var AlarmModel = /*#__PURE__*/function (_BaseSiteModel) {
       }
 
       if ('trippedStatePoint' in jsonObject) {
-        model._trippedStatePoint = function () {
+        model.trippedStatePoint = function () {
           if (typeof jsonObject['trippedStatePoint'] !== 'number') {
             return Number.isInteger(Number(jsonObject['trippedStatePoint'])) ? Number(jsonObject['trippedStatePoint']) : Math.floor(Number(jsonObject['trippedStatePoint']));
           }
@@ -605,7 +349,7 @@ var AlarmModel = /*#__PURE__*/function (_BaseSiteModel) {
       }
 
       if ('trippedTimestampPoint' in jsonObject) {
-        model._trippedTimestampPoint = function () {
+        model.trippedTimestampPoint = function () {
           if (typeof jsonObject['trippedTimestampPoint'] !== 'number') {
             return Number.isInteger(Number(jsonObject['trippedTimestampPoint'])) ? Number(jsonObject['trippedTimestampPoint']) : Math.floor(Number(jsonObject['trippedTimestampPoint']));
           }
@@ -615,7 +359,7 @@ var AlarmModel = /*#__PURE__*/function (_BaseSiteModel) {
       }
 
       if ('internalTripStartPoint' in jsonObject) {
-        model._internalTripStartPoint = function () {
+        model.internalTripStartPoint = function () {
           if (typeof jsonObject['internalTripStartPoint'] !== 'number') {
             return Number.isInteger(Number(jsonObject['internalTripStartPoint'])) ? Number(jsonObject['internalTripStartPoint']) : Math.floor(Number(jsonObject['internalTripStartPoint']));
           }
@@ -625,7 +369,7 @@ var AlarmModel = /*#__PURE__*/function (_BaseSiteModel) {
       }
 
       if ('internalResetStartPoint' in jsonObject) {
-        model._internalResetStartPoint = function () {
+        model.internalResetStartPoint = function () {
           if (typeof jsonObject['internalResetStartPoint'] !== 'number') {
             return Number.isInteger(Number(jsonObject['internalResetStartPoint'])) ? Number(jsonObject['internalResetStartPoint']) : Math.floor(Number(jsonObject['internalResetStartPoint']));
           }
@@ -635,7 +379,7 @@ var AlarmModel = /*#__PURE__*/function (_BaseSiteModel) {
       }
 
       if ('deleted' in jsonObject) {
-        model._deleted = function () {
+        model.deleted = function () {
           if (typeof jsonObject['deleted'] !== 'boolean') {
             return Boolean(jsonObject['deleted']);
           }
@@ -645,7 +389,7 @@ var AlarmModel = /*#__PURE__*/function (_BaseSiteModel) {
       }
 
       if ('updateTimestamp' in jsonObject) {
-        model._updateTimestamp = function () {
+        model.updateTimestamp = function () {
           if (typeof jsonObject['updateTimestamp'] !== 'string') {
             return new Date(String(jsonObject['updateTimestamp']));
           }
@@ -659,7 +403,7 @@ var AlarmModel = /*#__PURE__*/function (_BaseSiteModel) {
   }]);
 
   return AlarmModel;
-}(_BaseSiteModel2.default);
+}(_BaseModel2.default);
 
 var _default = AlarmModel;
 exports.default = _default;