@ricado/api-client 2.3.28 → 2.4.1

package/src/Models/Lab/Site/FruitProfileModel.js

@@ -0,0 +1,290 @@
+/**
+ * File Auto-Generated by the RICADO Gen 4 PHP API Project
+ * 
+ * Do Not Edit this File Manually!
+ */
+
+import BaseModel from '../../../Models/BaseModel';
+
+/**
+ * Model Class for a Fruit Profile
+ * 
+ * @class
+ * @hideconstructor
+ * @extends BaseModel
+ */
+class FruitProfileModel extends BaseModel
+{
+    /**
+     * FruitProfileModel Constructor
+     * 
+     * @protected
+     * @param {number} siteId The Site ID associated with this Fruit Profile
+     */
+    constructor(siteId)
+    {
+        super();
+        
+        /**
+         * The Fruit Profile ID
+         * 
+         * @type {string}
+         * @public
+         */
+        this.id = "";
+        
+        /**
+         * The Fruit Profile Name
+         * 
+         * @type {string}
+         * @public
+         */
+        this.name = "";
+        
+        /**
+         * The Fruit Profile Description
+         * 
+         * @type {string}
+         * @public
+         */
+        this.description = "";
+        
+        /**
+         * The Fruit Profile Image Source
+         * 
+         * @type {string}
+         * @public
+         */
+        this.image = "";
+        
+        /**
+         * The Typical Warm Up Duration (in seconds) for a Sample to reach the Minimum Target Temperature
+         * 
+         * @type {number}
+         * @public
+         */
+        this.nominalWarmUpDuration = 0;
+        
+        /**
+         * The Minimum Duration (in seconds) that a Sample should be within the Min and Max Target Temperatures be Successful
+         * 
+         * @type {number}
+         * @public
+         */
+        this.minimumWithinTargetDuration = 0;
+        
+        /**
+         * The Maximum Duration (in seconds) that a Sample should be Dehydrated for before it Fails
+         * 
+         * @type {number}
+         * @public
+         */
+        this.maximumTotalDuration = 0;
+        
+        /**
+         * The Minimum Target Temperature for a Sample to be Successful
+         * 
+         * @type {number}
+         * @public
+         */
+        this.minimumTargetTemperature = 0;
+        
+        /**
+         * The Maximum Target Temperature for a Sample to be Successful
+         * 
+         * @type {number}
+         * @public
+         */
+        this.maximumTargetTemperature = 0;
+        
+        /**
+         * Whether the Fruit Profile has been deleted
+         * 
+         * @type {boolean}
+         * @public
+         */
+        this.deleted = false;
+        
+        /**
+         * When the Fruit Profile was last updated
+         * 
+         * @type {Date}
+         * @public
+         */
+        this.updateTimestamp = new Date();
+        
+        /**
+         * The Site ID associated with this Fruit Profile
+         * 
+         * @type {number}
+         * @public
+         */
+        this.siteId = siteId;
+    }
+
+    /**
+     * Create a new **FruitProfileModel** 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 Fruit Profile
+     * @return {FruitProfileModel}
+     */
+    static fromJSON(json, siteId)
+    {
+        let model = new FruitProfileModel(siteId);
+        
+        /**
+         * The JSON Object
+         * 
+         * @type {Object<string, any>}
+         */
+        let jsonObject = {};
+        
+        if(typeof json === 'string')
+        {
+            jsonObject = JSON.parse(json);
+        }
+        else if(typeof json === 'object')
+        {
+            jsonObject = json;
+        }
+        
+        if('id' in jsonObject)
+        {
+            model.id = (function(){
+                if(typeof jsonObject['id'] !== 'string')
+                {
+                    return String(jsonObject['id']);
+                }
+        
+                return jsonObject['id'];
+            }());
+        }
+        
+        if('name' in jsonObject)
+        {
+            model.name = (function(){
+                if(typeof jsonObject['name'] !== 'string')
+                {
+                    return String(jsonObject['name']);
+                }
+        
+                return jsonObject['name'];
+            }());
+        }
+        
+        if('description' in jsonObject)
+        {
+            model.description = (function(){
+                if(typeof jsonObject['description'] !== 'string')
+                {
+                    return String(jsonObject['description']);
+                }
+        
+                return jsonObject['description'];
+            }());
+        }
+        
+        if('image' in jsonObject)
+        {
+            model.image = (function(){
+                if(typeof jsonObject['image'] !== 'string')
+                {
+                    return String(jsonObject['image']);
+                }
+        
+                return jsonObject['image'];
+            }());
+        }
+        
+        if('nominalWarmUpDuration' in jsonObject)
+        {
+            model.nominalWarmUpDuration = (function(){
+                if(typeof jsonObject['nominalWarmUpDuration'] !== 'number')
+                {
+                    return Number.isInteger(Number(jsonObject['nominalWarmUpDuration'])) ? Number(jsonObject['nominalWarmUpDuration']) : Math.floor(Number(jsonObject['nominalWarmUpDuration']));
+                }
+        
+                return Number.isInteger(jsonObject['nominalWarmUpDuration']) ? jsonObject['nominalWarmUpDuration'] : Math.floor(jsonObject['nominalWarmUpDuration']);
+            }());
+        }
+        
+        if('minimumWithinTargetDuration' in jsonObject)
+        {
+            model.minimumWithinTargetDuration = (function(){
+                if(typeof jsonObject['minimumWithinTargetDuration'] !== 'number')
+                {
+                    return Number.isInteger(Number(jsonObject['minimumWithinTargetDuration'])) ? Number(jsonObject['minimumWithinTargetDuration']) : Math.floor(Number(jsonObject['minimumWithinTargetDuration']));
+                }
+        
+                return Number.isInteger(jsonObject['minimumWithinTargetDuration']) ? jsonObject['minimumWithinTargetDuration'] : Math.floor(jsonObject['minimumWithinTargetDuration']);
+            }());
+        }
+        
+        if('maximumTotalDuration' in jsonObject)
+        {
+            model.maximumTotalDuration = (function(){
+                if(typeof jsonObject['maximumTotalDuration'] !== 'number')
+                {
+                    return Number.isInteger(Number(jsonObject['maximumTotalDuration'])) ? Number(jsonObject['maximumTotalDuration']) : Math.floor(Number(jsonObject['maximumTotalDuration']));
+                }
+        
+                return Number.isInteger(jsonObject['maximumTotalDuration']) ? jsonObject['maximumTotalDuration'] : Math.floor(jsonObject['maximumTotalDuration']);
+            }());
+        }
+        
+        if('minimumTargetTemperature' in jsonObject)
+        {
+            model.minimumTargetTemperature = (function(){
+                if(typeof jsonObject['minimumTargetTemperature'] !== 'number')
+                {
+                    return Number(jsonObject['minimumTargetTemperature']);
+                }
+        
+                return jsonObject['minimumTargetTemperature'];
+            }());
+        }
+        
+        if('maximumTargetTemperature' in jsonObject)
+        {
+            model.maximumTargetTemperature = (function(){
+                if(typeof jsonObject['maximumTargetTemperature'] !== 'number')
+                {
+                    return Number(jsonObject['maximumTargetTemperature']);
+                }
+        
+                return jsonObject['maximumTargetTemperature'];
+            }());
+        }
+        
+        if('deleted' in jsonObject)
+        {
+            model.deleted = (function(){
+                if(typeof jsonObject['deleted'] !== 'boolean')
+                {
+                    return Boolean(jsonObject['deleted']);
+                }
+        
+                return jsonObject['deleted'];
+            }());
+        }
+        
+        if('updateTimestamp' in jsonObject)
+        {
+            model.updateTimestamp = (function(){
+                if(typeof jsonObject['updateTimestamp'] !== 'string')
+                {
+                    return new Date(String(jsonObject['updateTimestamp']));
+                }
+        
+                return new Date(jsonObject['updateTimestamp']);
+            }());
+        }
+        
+        return model;
+    }
+}
+
+export default FruitProfileModel;

package/src/Models/Lab/Site/LabModel.js

@@ -0,0 +1,372 @@
+/**
+ * File Auto-Generated by the RICADO Gen 4 PHP API Project
+ * 
+ * Do Not Edit this File Manually!
+ */
+
+import BaseModel from '../../../Models/BaseModel';
+
+/**
+ * Model Class for a Lab
+ * 
+ * @class
+ * @hideconstructor
+ * @extends BaseModel
+ */
+class LabModel extends BaseModel
+{
+    /**
+     * LabModel Constructor
+     * 
+     * @protected
+     * @param {number} siteId The Site ID associated with this Lab
+     */
+    constructor(siteId)
+    {
+        super();
+        
+        /**
+         * The Lab ID
+         * 
+         * @type {string}
+         * @public
+         */
+        this.id = "";
+        
+        /**
+         * The RTU this Lab belongs to
+         * 
+         * @type {?number}
+         * @public
+         */
+        this.rtuId = null;
+        
+        /**
+         * The Lab Name
+         * 
+         * @type {string}
+         * @public
+         */
+        this.name = "";
+        
+        /**
+         * A Short Name for the Lab Name. Typically used in Reports and Tables showing multiple Labs
+         * 
+         * @type {string}
+         * @public
+         */
+        this.shortName = "";
+        
+        /**
+         * The Points used by this Lab
+         * 
+         * @type {Object}
+         * @public
+         */
+        this.points = {}
+        
+        /**
+         * The Rack Objects that belong to this Lab
+         * 
+         * @type {Array<{id: string, displayOrder: number}>}
+         * @public
+         */
+        this.racks = [];
+        
+        /**
+         * The Alarm Groups that are used by this Lab
+         * 
+         * @type {string[]}
+         * @public
+         */
+        this.alarmGroups = [];
+        
+        /**
+         * The Inspect Integration Configuration for this Lab
+         * 
+         * @type {?{points: Object, enabled: boolean, apiBaseUrl: string}}
+         * @public
+         */
+        this.inspectIntegration = null;
+        
+        /**
+         * Whether the Lab has been deleted
+         * 
+         * @type {boolean}
+         * @public
+         */
+        this.deleted = false;
+        
+        /**
+         * When the Lab was last updated
+         * 
+         * @type {Date}
+         * @public
+         */
+        this.updateTimestamp = new Date();
+        
+        /**
+         * The Site ID associated with this Lab
+         * 
+         * @type {number}
+         * @public
+         */
+        this.siteId = siteId;
+    }
+
+    /**
+     * Create a new **LabModel** 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 Lab
+     * @return {LabModel}
+     */
+    static fromJSON(json, siteId)
+    {
+        let model = new LabModel(siteId);
+        
+        /**
+         * The JSON Object
+         * 
+         * @type {Object<string, any>}
+         */
+        let jsonObject = {};
+        
+        if(typeof json === 'string')
+        {
+            jsonObject = JSON.parse(json);
+        }
+        else if(typeof json === 'object')
+        {
+            jsonObject = json;
+        }
+        
+        if('id' in jsonObject)
+        {
+            model.id = (function(){
+                if(typeof jsonObject['id'] !== 'string')
+                {
+                    return String(jsonObject['id']);
+                }
+        
+                return jsonObject['id'];
+            }());
+        }
+        
+        if('rtuId' in jsonObject)
+        {
+            model.rtuId = (function(){
+                if(jsonObject['rtuId'] === null)
+                {
+                    return null;
+                }
+        
+                if(typeof jsonObject['rtuId'] !== 'number')
+                {
+                    return Number.isInteger(Number(jsonObject['rtuId'])) ? Number(jsonObject['rtuId']) : Math.floor(Number(jsonObject['rtuId']));
+                }
+        
+                return Number.isInteger(jsonObject['rtuId']) ? jsonObject['rtuId'] : Math.floor(jsonObject['rtuId']);
+            }());
+        }
+        
+        if('name' in jsonObject)
+        {
+            model.name = (function(){
+                if(typeof jsonObject['name'] !== 'string')
+                {
+                    return String(jsonObject['name']);
+                }
+        
+                return jsonObject['name'];
+            }());
+        }
+        
+        if('shortName' in jsonObject)
+        {
+            model.shortName = (function(){
+                if(typeof jsonObject['shortName'] !== 'string')
+                {
+                    return String(jsonObject['shortName']);
+                }
+        
+                return jsonObject['shortName'];
+            }());
+        }
+        
+        if('points' in jsonObject)
+        {
+            model.points = (function(){
+                if(typeof jsonObject['points'] !== 'object')
+                {
+                    return Object(jsonObject['points']);
+                }
+        
+                return jsonObject['points'];
+            }());
+        }
+        
+        if('racks' in jsonObject)
+        {
+            model.racks = (function(){
+                if(Array.isArray(jsonObject['racks']) !== true)
+                {
+                    return [];
+                }
+        
+                return jsonObject['racks'].map((racksItem) => {
+                    return (function(){
+                        let racksItemObject = {};
+                        
+                        if(typeof racksItem === 'object' && 'id' in racksItem)
+                        {
+                            racksItemObject.id = (function(){
+                                if(typeof racksItem.id !== 'string')
+                                {
+                                    return String(racksItem.id);
+                                }
+        
+                                return racksItem.id;
+                            }());
+                        }
+                        else
+                        {
+                            racksItemObject.id = "";
+                        }
+                        
+                        if(typeof racksItem === 'object' && 'displayOrder' in racksItem)
+                        {
+                            racksItemObject.displayOrder = (function(){
+                                if(typeof racksItem.displayOrder !== 'number')
+                                {
+                                    return Number.isInteger(Number(racksItem.displayOrder)) ? Number(racksItem.displayOrder) : Math.floor(Number(racksItem.displayOrder));
+                                }
+        
+                                return Number.isInteger(racksItem.displayOrder) ? racksItem.displayOrder : Math.floor(racksItem.displayOrder);
+                            }());
+                        }
+                        else
+                        {
+                            racksItemObject.displayOrder = 0;
+                        }
+        
+                        return racksItemObject;
+                    }());
+                });
+            }());
+        }
+        
+        if('alarmGroups' in jsonObject)
+        {
+            model.alarmGroups = (function(){
+                if(Array.isArray(jsonObject['alarmGroups']) !== true)
+                {
+                    return [];
+                }
+        
+                return jsonObject['alarmGroups'].map((alarmGroupsItem) => {
+                    return (function(){
+                        if(typeof alarmGroupsItem !== 'string')
+                        {
+                            return String(alarmGroupsItem);
+                        }
+        
+                        return alarmGroupsItem;
+                    }());
+                });
+            }());
+        }
+        
+        if('inspectIntegration' in jsonObject)
+        {
+            model.inspectIntegration = (function(){
+                if(jsonObject['inspectIntegration'] === null)
+                {
+                    return null;
+                }
+        
+                let inspectIntegrationObject = {};
+                
+                if(typeof jsonObject['inspectIntegration'] === 'object' && 'points' in jsonObject['inspectIntegration'])
+                {
+                    inspectIntegrationObject.points = (function(){
+                        if(typeof jsonObject['inspectIntegration'].points !== 'object')
+                        {
+                            return Object(jsonObject['inspectIntegration'].points);
+                        }
+        
+                        return jsonObject['inspectIntegration'].points;
+                    }());
+                }
+                else
+                {
+                    inspectIntegrationObject.points = {}
+                }
+                
+                if(typeof jsonObject['inspectIntegration'] === 'object' && 'enabled' in jsonObject['inspectIntegration'])
+                {
+                    inspectIntegrationObject.enabled = (function(){
+                        if(typeof jsonObject['inspectIntegration'].enabled !== 'boolean')
+                        {
+                            return Boolean(jsonObject['inspectIntegration'].enabled);
+                        }
+        
+                        return jsonObject['inspectIntegration'].enabled;
+                    }());
+                }
+                else
+                {
+                    inspectIntegrationObject.enabled = false;
+                }
+                
+                if(typeof jsonObject['inspectIntegration'] === 'object' && 'apiBaseUrl' in jsonObject['inspectIntegration'])
+                {
+                    inspectIntegrationObject.apiBaseUrl = (function(){
+                        if(typeof jsonObject['inspectIntegration'].apiBaseUrl !== 'string')
+                        {
+                            return String(jsonObject['inspectIntegration'].apiBaseUrl);
+                        }
+        
+                        return jsonObject['inspectIntegration'].apiBaseUrl;
+                    }());
+                }
+                else
+                {
+                    inspectIntegrationObject.apiBaseUrl = "";
+                }
+        
+                return inspectIntegrationObject;
+            }());
+        }
+        
+        if('deleted' in jsonObject)
+        {
+            model.deleted = (function(){
+                if(typeof jsonObject['deleted'] !== 'boolean')
+                {
+                    return Boolean(jsonObject['deleted']);
+                }
+        
+                return jsonObject['deleted'];
+            }());
+        }
+        
+        if('updateTimestamp' in jsonObject)
+        {
+            model.updateTimestamp = (function(){
+                if(typeof jsonObject['updateTimestamp'] !== 'string')
+                {
+                    return new Date(String(jsonObject['updateTimestamp']));
+                }
+        
+                return new Date(jsonObject['updateTimestamp']);
+            }());
+        }
+        
+        return model;
+    }
+}
+
+export default LabModel;