@ricado/api-client 1.2.6 → 2.0.0

package/src/Models/Site/PermanentObjectModel.js

@@ -4,24 +4,23 @@
  * Do Not Edit this File Manually!
  */
 
-import BaseSiteModel from '../../Models/Site/BaseSiteModel';
+import BaseModel from '../../Models/BaseModel';
 
 /**
  * Model Class for a Permanent Object
  * 
  * @class
  * @hideconstructor
- * @extends BaseSiteModel
+ * @extends BaseModel
  */
-class PermanentObjectModel extends BaseSiteModel
+class PermanentObjectModel extends BaseModel
 {
     /**
      * PermanentObjectModel Constructor
      * 
      * @protected
-     * @param {number} siteId The Site ID associated with this Permanent Object
      */
-    constructor(siteId)
+    constructor()
     {
         super();
         
@@ -29,172 +28,57 @@ class PermanentObjectModel extends BaseSiteModel
          * The Permanent Object ID
          * 
          * @type {string}
-         * @private
+         * @public
          */
-        this._id = undefined;
+        this.id = undefined;
         
         /**
          * The RTU this Permanent Object belongs to
          * 
          * @type {?number}
-         * @private
+         * @public
          */
-        this._rtuId = undefined;
+        this.rtuId = undefined;
         
         /**
          * The Permanent Object Key Index
          * 
          * @type {string}
-         * @private
+         * @public
          */
-        this._keyIndex = undefined;
+        this.keyIndex = undefined;
         
         /**
          * The Permanent Object Type
          * 
          * @type {string}
-         * @private
+         * @public
          */
-        this._type = undefined;
+        this.type = undefined;
         
         /**
          * The Permanent Object Definition
          * 
          * @type {Object}
-         * @private
+         * @public
          */
-        this._definition = undefined;
+        this.definition = undefined;
         
         /**
          * Whether the Permanent Object has been deleted
          * 
          * @type {boolean}
-         * @private
+         * @public
          */
-        this._deleted = undefined;
+        this.deleted = undefined;
         
         /**
          * When the Permanent Object was last updated
          * 
          * @type {Date}
-         * @private
+         * @public
          */
-        this._updateTimestamp = undefined;
-        
-        /**
-         * The Site ID associated with this Permanent Object
-         * 
-         * @type {number}
-         * @private
-         */
-        this._siteId = siteId;
-    }
-
-    /**
-     * The Permanent Object ID
-     * 
-     * @public
-     * @type {string}
-     */
-    get id()
-    {
-        return this._id;
-    }
-
-    /**
-     * The RTU this Permanent Object belongs to
-     * 
-     * @public
-     * @type {?number}
-     */
-    get rtuId()
-    {
-        return this._rtuId;
-    }
-
-    /**
-     * The Permanent Object Key Index
-     * 
-     * @public
-     * @type {string}
-     */
-    get keyIndex()
-    {
-        return this._keyIndex;
-    }
-
-    /**
-     * The Permanent Object Type
-     * 
-     * @public
-     * @type {string}
-     */
-    get type()
-    {
-        return this._type;
-    }
-
-    /**
-     * The Permanent Object Definition
-     * 
-     * @public
-     * @type {Object}
-     */
-    get definition()
-    {
-        return this._definition;
-    }
-
-    /**
-     * Whether the Permanent Object has been deleted
-     * 
-     * @public
-     * @type {boolean}
-     */
-    get deleted()
-    {
-        return this._deleted;
-    }
-
-    /**
-     * When the Permanent Object was last updated
-     * 
-     * @public
-     * @type {Date}
-     */
-    get updateTimestamp()
-    {
-        return this._updateTimestamp;
-    }
-
-    /**
-     * The Site ID associated with this Permanent Object
-     * 
-     * @public
-     * @type {number}
-     */
-    get siteId()
-    {
-        return this._siteId;
-    }
-
-    /**
-     * Convert this **PermanentObjectModel** to a JSON Object
-     * 
-     * @public
-     * @return {Object<string, any>}
-     */
-    toJSON()
-    {
-        return {
-            id: this._id,
-            rtuId: this._rtuId,
-            keyIndex: this._keyIndex,
-            type: this._type,
-            definition: this._definition,
-            deleted: this._deleted,
-            updateTimestamp: this._updateTimestamp
-        };
+        this.updateTimestamp = undefined;
     }
 
     /**
@@ -203,12 +87,11 @@ class PermanentObjectModel extends BaseSiteModel
      * @static
      * @public
      * @param {Object<string, any>|string} json A JSON Object or JSON String
-     * @param {number} siteId The Site ID associated with this Permanent Object
      * @return {PermanentObjectModel}
      */
-    static fromJSON(json, siteId)
+    static fromJSON(json)
     {
-        let model = new PermanentObjectModel(siteId);
+        let model = new PermanentObjectModel();
         
         /**
          * The JSON Object
@@ -228,7 +111,7 @@ class PermanentObjectModel extends BaseSiteModel
         
         if('id' in jsonObject)
         {
-            model._id = (function(){
+            model.id = (function(){
                 if(typeof jsonObject['id'] !== 'string')
                 {
                     return String(jsonObject['id']);
@@ -240,7 +123,7 @@ class PermanentObjectModel extends BaseSiteModel
         
         if('rtuId' in jsonObject)
         {
-            model._rtuId = (function(){
+            model.rtuId = (function(){
                 if(jsonObject['rtuId'] === null)
                 {
                     return null;
@@ -257,7 +140,7 @@ class PermanentObjectModel extends BaseSiteModel
         
         if('keyIndex' in jsonObject)
         {
-            model._keyIndex = (function(){
+            model.keyIndex = (function(){
                 if(typeof jsonObject['keyIndex'] !== 'string')
                 {
                     return String(jsonObject['keyIndex']);
@@ -269,7 +152,7 @@ class PermanentObjectModel extends BaseSiteModel
         
         if('type' in jsonObject)
         {
-            model._type = (function(){
+            model.type = (function(){
                 if(typeof jsonObject['type'] !== 'string')
                 {
                     return String(jsonObject['type']);
@@ -281,7 +164,7 @@ class PermanentObjectModel extends BaseSiteModel
         
         if('definition' in jsonObject)
         {
-            model._definition = (function(){
+            model.definition = (function(){
                 if(typeof jsonObject['definition'] !== 'object')
                 {
                     return Object(jsonObject['definition']);
@@ -293,7 +176,7 @@ class PermanentObjectModel extends BaseSiteModel
         
         if('deleted' in jsonObject)
         {
-            model._deleted = (function(){
+            model.deleted = (function(){
                 if(typeof jsonObject['deleted'] !== 'boolean')
                 {
                     return Boolean(jsonObject['deleted']);
@@ -305,7 +188,7 @@ class PermanentObjectModel extends BaseSiteModel
         
         if('updateTimestamp' in jsonObject)
         {
-            model._updateTimestamp = (function(){
+            model.updateTimestamp = (function(){
                 if(typeof jsonObject['updateTimestamp'] !== 'string')
                 {
                     return new Date(String(jsonObject['updateTimestamp']));

package/src/Models/Site/PointModel.js

@@ -4,24 +4,23 @@
  * Do Not Edit this File Manually!
  */
 
-import BaseSiteModel from '../../Models/Site/BaseSiteModel';
+import BaseModel from '../../Models/BaseModel';
 
 /**
  * Model Class for a Point
  * 
  * @class
  * @hideconstructor
- * @extends BaseSiteModel
+ * @extends BaseModel
  */
-class PointModel extends BaseSiteModel
+class PointModel extends BaseModel
 {
     /**
      * PointModel Constructor
      * 
      * @protected
-     * @param {number} siteId The Site ID associated with this Point
      */
-    constructor(siteId)
+    constructor()
     {
         super();
         
@@ -29,252 +28,89 @@ class PointModel extends BaseSiteModel
          * The Point ID
          * 
          * @type {number}
-         * @private
+         * @public
          */
-        this._id = undefined;
+        this.id = undefined;
         
         /**
          * The RTU this Point belongs to
          * 
          * @type {?number}
-         * @private
+         * @public
          */
-        this._rtuId = undefined;
+        this.rtuId = undefined;
         
         /**
          * The Plugin ID
          * 
          * @type {?number}
-         * @private
+         * @public
          */
-        this._pluginId = undefined;
+        this.pluginId = undefined;
         
         /**
          * The Point Name
          * 
          * @type {string}
-         * @private
+         * @public
          */
-        this._name = undefined;
+        this.name = undefined;
         
         /**
          * The Point Type
          * 
          * @type {string}
-         * @private
+         * @public
          */
-        this._type = undefined;
+        this.type = undefined;
         
         /**
          * The Point's Value Type
          * 
          * @type {string}
-         * @private
+         * @public
          */
-        this._valueType = undefined;
+        this.valueType = undefined;
         
         /**
          * The Permissions
          * 
          * @type {string}
-         * @private
+         * @public
          */
-        this._permissions = undefined;
+        this.permissions = undefined;
         
         /**
          * Whether the Point is Enabled
          * 
          * @type {boolean}
-         * @private
+         * @public
          */
-        this._enabled = undefined;
+        this.enabled = undefined;
         
         /**
          * The Point Settings
          * 
          * @type {Object}
-         * @private
+         * @public
          */
-        this._settings = undefined;
+        this.settings = undefined;
         
         /**
          * Whether the Point has been deleted
          * 
          * @type {boolean}
-         * @private
+         * @public
          */
-        this._deleted = undefined;
+        this.deleted = undefined;
         
         /**
          * When the Point was last updated
          * 
          * @type {Date}
-         * @private
+         * @public
          */
-        this._updateTimestamp = undefined;
-        
-        /**
-         * The Site ID associated with this Point
-         * 
-         * @type {number}
-         * @private
-         */
-        this._siteId = siteId;
-    }
-
-    /**
-     * The Point ID
-     * 
-     * @public
-     * @type {number}
-     */
-    get id()
-    {
-        return this._id;
-    }
-
-    /**
-     * The RTU this Point belongs to
-     * 
-     * @public
-     * @type {?number}
-     */
-    get rtuId()
-    {
-        return this._rtuId;
-    }
-
-    /**
-     * The Plugin ID
-     * 
-     * @public
-     * @type {?number}
-     */
-    get pluginId()
-    {
-        return this._pluginId;
-    }
-
-    /**
-     * The Point Name
-     * 
-     * @public
-     * @type {string}
-     */
-    get name()
-    {
-        return this._name;
-    }
-
-    /**
-     * The Point Type
-     * 
-     * @public
-     * @type {string}
-     */
-    get type()
-    {
-        return this._type;
-    }
-
-    /**
-     * The Point's Value Type
-     * 
-     * @public
-     * @type {string}
-     */
-    get valueType()
-    {
-        return this._valueType;
-    }
-
-    /**
-     * The Permissions
-     * 
-     * @public
-     * @type {string}
-     */
-    get permissions()
-    {
-        return this._permissions;
-    }
-
-    /**
-     * Whether the Point is Enabled
-     * 
-     * @public
-     * @type {boolean}
-     */
-    get enabled()
-    {
-        return this._enabled;
-    }
-
-    /**
-     * The Point Settings
-     * 
-     * @public
-     * @type {Object}
-     */
-    get settings()
-    {
-        return this._settings;
-    }
-
-    /**
-     * Whether the Point has been deleted
-     * 
-     * @public
-     * @type {boolean}
-     */
-    get deleted()
-    {
-        return this._deleted;
-    }
-
-    /**
-     * When the Point was last updated
-     * 
-     * @public
-     * @type {Date}
-     */
-    get updateTimestamp()
-    {
-        return this._updateTimestamp;
-    }
-
-    /**
-     * The Site ID associated with this Point
-     * 
-     * @public
-     * @type {number}
-     */
-    get siteId()
-    {
-        return this._siteId;
-    }
-
-    /**
-     * Convert this **PointModel** to a JSON Object
-     * 
-     * @public
-     * @return {Object<string, any>}
-     */
-    toJSON()
-    {
-        return {
-            id: this._id,
-            rtuId: this._rtuId,
-            pluginId: this._pluginId,
-            name: this._name,
-            type: this._type,
-            valueType: this._valueType,
-            permissions: this._permissions,
-            enabled: this._enabled,
-            settings: this._settings,
-            deleted: this._deleted,
-            updateTimestamp: this._updateTimestamp
-        };
+        this.updateTimestamp = undefined;
     }
 
     /**
@@ -283,12 +119,11 @@ class PointModel extends BaseSiteModel
      * @static
      * @public
      * @param {Object<string, any>|string} json A JSON Object or JSON String
-     * @param {number} siteId The Site ID associated with this Point
      * @return {PointModel}
      */
-    static fromJSON(json, siteId)
+    static fromJSON(json)
     {
-        let model = new PointModel(siteId);
+        let model = new PointModel();
         
         /**
          * The JSON Object
@@ -308,7 +143,7 @@ class PointModel extends BaseSiteModel
         
         if('id' in jsonObject)
         {
-            model._id = (function(){
+            model.id = (function(){
                 if(typeof jsonObject['id'] !== 'number')
                 {
                     return Number.isInteger(Number(jsonObject['id'])) ? Number(jsonObject['id']) : Math.floor(Number(jsonObject['id']));
@@ -320,7 +155,7 @@ class PointModel extends BaseSiteModel
         
         if('rtuId' in jsonObject)
         {
-            model._rtuId = (function(){
+            model.rtuId = (function(){
                 if(jsonObject['rtuId'] === null)
                 {
                     return null;
@@ -337,7 +172,7 @@ class PointModel extends BaseSiteModel
         
         if('pluginId' in jsonObject)
         {
-            model._pluginId = (function(){
+            model.pluginId = (function(){
                 if(jsonObject['pluginId'] === null)
                 {
                     return null;
@@ -354,7 +189,7 @@ class PointModel extends BaseSiteModel
         
         if('name' in jsonObject)
         {
-            model._name = (function(){
+            model.name = (function(){
                 if(typeof jsonObject['name'] !== 'string')
                 {
                     return String(jsonObject['name']);
@@ -366,7 +201,7 @@ class PointModel extends BaseSiteModel
         
         if('type' in jsonObject)
         {
-            model._type = (function(){
+            model.type = (function(){
                 if(typeof jsonObject['type'] !== 'string')
                 {
                     return String(jsonObject['type']);
@@ -378,7 +213,7 @@ class PointModel extends BaseSiteModel
         
         if('valueType' in jsonObject)
         {
-            model._valueType = (function(){
+            model.valueType = (function(){
                 if(typeof jsonObject['valueType'] !== 'string')
                 {
                     return String(jsonObject['valueType']);
@@ -390,7 +225,7 @@ class PointModel extends BaseSiteModel
         
         if('permissions' in jsonObject)
         {
-            model._permissions = (function(){
+            model.permissions = (function(){
                 if(typeof jsonObject['permissions'] !== 'string')
                 {
                     return String(jsonObject['permissions']);
@@ -402,7 +237,7 @@ class PointModel extends BaseSiteModel
         
         if('enabled' in jsonObject)
         {
-            model._enabled = (function(){
+            model.enabled = (function(){
                 if(typeof jsonObject['enabled'] !== 'boolean')
                 {
                     return Boolean(jsonObject['enabled']);
@@ -414,7 +249,7 @@ class PointModel extends BaseSiteModel
         
         if('settings' in jsonObject)
         {
-            model._settings = (function(){
+            model.settings = (function(){
                 if(typeof jsonObject['settings'] !== 'object')
                 {
                     return Object(jsonObject['settings']);
@@ -426,7 +261,7 @@ class PointModel extends BaseSiteModel
         
         if('deleted' in jsonObject)
         {
-            model._deleted = (function(){
+            model.deleted = (function(){
                 if(typeof jsonObject['deleted'] !== 'boolean')
                 {
                     return Boolean(jsonObject['deleted']);
@@ -438,7 +273,7 @@ class PointModel extends BaseSiteModel
         
         if('updateTimestamp' in jsonObject)
         {
-            model._updateTimestamp = (function(){
+            model.updateTimestamp = (function(){
                 if(typeof jsonObject['updateTimestamp'] !== 'string')
                 {
                     return new Date(String(jsonObject['updateTimestamp']));