@ricado/api-client 2.4.1 → 2.4.2

package/src/Controllers/Lab/Site/SampleController.js

@@ -1054,8 +1054,8 @@ export default SampleController;
  * @property {string} [labId] The Lab ID this Sample is associated with
  * @property {string} [sampleNumber] The Numeric Sample Number
  * @property {string} [createdSource] The Source that Created this Sample
- * @property {?string} [createdUserId] ID of the User who Created this Sample. Only applies if the `createdSource` is 'System'
- * @property {?string} [createdUserName] Name of the User who Created this Sample. Only applies if the `createdSource` is 'System'
+ * @property {?string} [createdUserId] ID of the User who Created this Sample. Only applies if the `createdSource` is 'User'
+ * @property {?string} [createdUserName] Name of the User who Created this Sample. Only applies if the `createdSource` is 'User'
  * @property {?string} [publishUserId] ID of the User who Published this Sample
  * @property {?string} [publishUserName] Name of the User who Published this Sample
  * @property {string} [fruitProfileId] The Fruit Profile for this Sample
@@ -1068,10 +1068,14 @@ export default SampleController;
  * @property {Date} [createdTimestampEnd] Filter by the Timestamp when Samples were Created. Results Less than or Equal to Timestamp
  * @property {Date} [scheduledTimestampBegin] Filter by the Timestamp when Samples were Scheduled to Begin. Results Greater than or Equal to Timestamp
  * @property {Date} [scheduledTimestampEnd] Filter by the Timestamp when Samples were Scheduled to Begin. Results Less than or Equal to Timestamp
+ * @property {Date} [loadedTimestampBegin] Filter by the Timestamp when Samples were Loaded. Results Greater than or Equal to Timestamp
+ * @property {Date} [loadedTimestampEnd] Filter by the Timestamp when Samples were Loaded. Results Less than or Equal to Timestamp
  * @property {Date} [startTimestampBegin] Filter by the Timestamp when Samples were Started. Results Greater than or Equal to Timestamp
  * @property {Date} [startTimestampEnd] Filter by the Timestamp when Samples were Started. Results Less than or Equal to Timestamp
  * @property {Date} [finishTimestampBegin] Filter by the Timestamp when Samples were Finished. Results Greater than or Equal to Timestamp
  * @property {Date} [finishTimestampEnd] Filter by the Timestamp when Samples were Finished. Results Less than or Equal to Timestamp
+ * @property {Date} [unloadedTimestampBegin] Filter by the Timestamp when Samples were Unloaded. Results Greater than or Equal to Timestamp
+ * @property {Date} [unloadedTimestampEnd] Filter by the Timestamp when Samples were Unloaded. Results Less than or Equal to Timestamp
  * @property {Date} [publishTimestampBegin] Filter by the Timestamp when Samples were Published. Results Greater than or Equal to Timestamp
  * @property {Date} [publishTimestampEnd] Filter by the Timestamp when Samples were Published. Results Less than or Equal to Timestamp
  * @property {Date} [updateTimestampBegin] Filter by the Timestamp when Samples were last Updated. Results Greater than or Equal to Timestamp
@@ -1087,11 +1091,13 @@ export default SampleController;
  * @property {string} [sampleNumber] The Numeric Sample Number
  * @property {Date} [createdTimestamp] When this Sample was Created
  * @property {string} createdSource The Source that Created this Sample
- * @property {?string} [createdUserId] ID of the User who Created this Sample. Only applies if the `createdSource` is 'System'
- * @property {?string} [createdUserName] Name of the User who Created this Sample. Only applies if the `createdSource` is 'System'
+ * @property {?string} [createdUserId] ID of the User who Created this Sample. Only applies if the `createdSource` is 'User'
+ * @property {?string} [createdUserName] Name of the User who Created this Sample. Only applies if the `createdSource` is 'User'
  * @property {?Date} [scheduledTimestamp] Optional Scheduled Timestamp when this Sample should Begin
+ * @property {?Date} [loadedTimestamp] When this Sample was Loaded into the Dehydrator
  * @property {?Date} [startTimestamp] When this Sample was Started
  * @property {?Date} [finishTimestamp] When this Sample was Finished
+ * @property {?Date} [unloadedTimestamp] When this Sample was Unloaded from the Dehydrator
  * @property {?Date} [publishTimestamp] When this Sample was Published
  * @property {?string} [publishUserId] ID of the User who Published this Sample
  * @property {?string} [publishUserName] Name of the User who Published this Sample
@@ -1111,11 +1117,13 @@ export default SampleController;
  * @property {string} [labId] The Lab ID this Sample is associated with
  * @property {Date} [createdTimestamp] When this Sample was Created
  * @property {string} [createdSource] The Source that Created this Sample
- * @property {?string} [createdUserId] ID of the User who Created this Sample. Only applies if the `createdSource` is 'System'
- * @property {?string} [createdUserName] Name of the User who Created this Sample. Only applies if the `createdSource` is 'System'
+ * @property {?string} [createdUserId] ID of the User who Created this Sample. Only applies if the `createdSource` is 'User'
+ * @property {?string} [createdUserName] Name of the User who Created this Sample. Only applies if the `createdSource` is 'User'
  * @property {?Date} [scheduledTimestamp] Optional Scheduled Timestamp when this Sample should Begin
+ * @property {?Date} [loadedTimestamp] When this Sample was Loaded into the Dehydrator
  * @property {?Date} [startTimestamp] When this Sample was Started
  * @property {?Date} [finishTimestamp] When this Sample was Finished
+ * @property {?Date} [unloadedTimestamp] When this Sample was Unloaded from the Dehydrator
  * @property {?Date} [publishTimestamp] When this Sample was Published
  * @property {?string} [publishUserId] ID of the User who Published this Sample
  * @property {?string} [publishUserName] Name of the User who Published this Sample

package/src/Controllers/Lab/Site/SampleFailureReasonController.js

@@ -155,7 +155,7 @@ export default SampleFailureReasonController;
  * The Create Data for a Sample Failure Reason
  * 
  * @typedef {Object} SampleFailureReasonController.CreateData
- * @property {string} [name] The Sample Failure Reason Name
+ * @property {string} name The Sample Failure Reason Name
  * @property {string} description The Sample Failure Reason Description
  * @memberof Controllers.Lab.Site
  */
@@ -164,6 +164,7 @@ export default SampleFailureReasonController;
  * The Update Data for a Sample Failure Reason
  * 
  * @typedef {Object} SampleFailureReasonController.UpdateData
+ * @property {string} [name] The Sample Failure Reason Name
  * @property {string} [description] The Sample Failure Reason Description
  * @memberof Controllers.Lab.Site
  */

package/src/Controllers/Lab/Site/index.js

@@ -10,6 +10,7 @@
 import DehydratorController from './DehydratorController';
 import FruitProfileController from './FruitProfileController';
 import LabController from './LabController';
+import ProbeCalibrationController from './ProbeCalibrationController';
 import RackController from './RackController';
 import RackPositionController from './RackPositionController';
 import SampleController from './SampleController';
@@ -20,6 +21,7 @@ const Site = {
     DehydratorController,
     FruitProfileController,
     LabController,
+    ProbeCalibrationController,
     RackController,
     RackPositionController,
     SampleController,

package/src/Models/Lab/Site/ProbeCalibrationModel.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 Probe Calibration
+ * 
+ * @class
+ * @hideconstructor
+ * @extends BaseModel
+ */
+class ProbeCalibrationModel extends BaseModel
+{
+    /**
+     * ProbeCalibrationModel Constructor
+     * 
+     * @protected
+     * @param {number} siteId The Site ID associated with this Probe Calibration
+     */
+    constructor(siteId)
+    {
+        super();
+        
+        /**
+         * The Probe Calibration ID
+         * 
+         * @type {string}
+         * @public
+         */
+        this.id = "";
+        
+        /**
+         * The Rack Position ID this Probe Calibration is associated with
+         * 
+         * @type {string}
+         * @public
+         */
+        this.rackPositionId = "";
+        
+        /**
+         * When this Probe Calibration was Created
+         * 
+         * @type {Date}
+         * @public
+         */
+        this.createdTimestamp = new Date();
+        
+        /**
+         * ID of the User who Completed this Probe Calibration
+         * 
+         * @type {string}
+         * @public
+         */
+        this.userId = "";
+        
+        /**
+         * Name of the User who Completed this Probe Calibration
+         * 
+         * @type {string}
+         * @public
+         */
+        this.userName = "";
+        
+        /**
+         * The Calibration Offset prior to this Probe Calibration being Created
+         * 
+         * @type {number}
+         * @public
+         */
+        this.preCalibrationOffset = 0;
+        
+        /**
+         * The Calibration Offset after this Probe Calibration was Created
+         * 
+         * @type {number}
+         * @public
+         */
+        this.postCalibrationOffset = 0;
+        
+        /**
+         * The Temperature Probe reading prior to this Probe Calibration being Created
+         * 
+         * @type {number}
+         * @public
+         */
+        this.preCalibrationTemperature = 0;
+        
+        /**
+         * The Temperature Probe reading after this Probe Calibration was Created
+         * 
+         * @type {number}
+         * @public
+         */
+        this.postCalibrationTemperature = 0;
+        
+        /**
+         * Whether the Probe Calibration has been deleted
+         * 
+         * @type {boolean}
+         * @public
+         */
+        this.deleted = false;
+        
+        /**
+         * When the Probe Calibration was last updated
+         * 
+         * @type {Date}
+         * @public
+         */
+        this.updateTimestamp = new Date();
+        
+        /**
+         * The Site ID associated with this Probe Calibration
+         * 
+         * @type {number}
+         * @public
+         */
+        this.siteId = siteId;
+    }
+
+    /**
+     * Create a new **ProbeCalibrationModel** 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 Probe Calibration
+     * @return {ProbeCalibrationModel}
+     */
+    static fromJSON(json, siteId)
+    {
+        let model = new ProbeCalibrationModel(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('rackPositionId' in jsonObject)
+        {
+            model.rackPositionId = (function(){
+                if(typeof jsonObject['rackPositionId'] !== 'string')
+                {
+                    return String(jsonObject['rackPositionId']);
+                }
+        
+                return jsonObject['rackPositionId'];
+            }());
+        }
+        
+        if('createdTimestamp' in jsonObject)
+        {
+            model.createdTimestamp = (function(){
+                if(typeof jsonObject['createdTimestamp'] !== 'string')
+                {
+                    return new Date(String(jsonObject['createdTimestamp']));
+                }
+        
+                return new Date(jsonObject['createdTimestamp']);
+            }());
+        }
+        
+        if('userId' in jsonObject)
+        {
+            model.userId = (function(){
+                if(typeof jsonObject['userId'] !== 'string')
+                {
+                    return String(jsonObject['userId']);
+                }
+        
+                return jsonObject['userId'];
+            }());
+        }
+        
+        if('userName' in jsonObject)
+        {
+            model.userName = (function(){
+                if(typeof jsonObject['userName'] !== 'string')
+                {
+                    return String(jsonObject['userName']);
+                }
+        
+                return jsonObject['userName'];
+            }());
+        }
+        
+        if('preCalibrationOffset' in jsonObject)
+        {
+            model.preCalibrationOffset = (function(){
+                if(typeof jsonObject['preCalibrationOffset'] !== 'number')
+                {
+                    return Number(jsonObject['preCalibrationOffset']);
+                }
+        
+                return jsonObject['preCalibrationOffset'];
+            }());
+        }
+        
+        if('postCalibrationOffset' in jsonObject)
+        {
+            model.postCalibrationOffset = (function(){
+                if(typeof jsonObject['postCalibrationOffset'] !== 'number')
+                {
+                    return Number(jsonObject['postCalibrationOffset']);
+                }
+        
+                return jsonObject['postCalibrationOffset'];
+            }());
+        }
+        
+        if('preCalibrationTemperature' in jsonObject)
+        {
+            model.preCalibrationTemperature = (function(){
+                if(typeof jsonObject['preCalibrationTemperature'] !== 'number')
+                {
+                    return Number(jsonObject['preCalibrationTemperature']);
+                }
+        
+                return jsonObject['preCalibrationTemperature'];
+            }());
+        }
+        
+        if('postCalibrationTemperature' in jsonObject)
+        {
+            model.postCalibrationTemperature = (function(){
+                if(typeof jsonObject['postCalibrationTemperature'] !== 'number')
+                {
+                    return Number(jsonObject['postCalibrationTemperature']);
+                }
+        
+                return jsonObject['postCalibrationTemperature'];
+            }());
+        }
+        
+        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 ProbeCalibrationModel;

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

@@ -66,7 +66,7 @@ class SampleModel extends BaseModel
         this.createdSource = "";
         
         /**
-         * ID of the User who Created this Sample. Only applies if the `createdSource` is 'System'
+         * ID of the User who Created this Sample. Only applies if the `createdSource` is 'User'
          * 
          * @type {?string}
          * @public
@@ -74,7 +74,7 @@ class SampleModel extends BaseModel
         this.createdUserId = null;
         
         /**
-         * Name of the User who Created this Sample. Only applies if the `createdSource` is 'System'
+         * Name of the User who Created this Sample. Only applies if the `createdSource` is 'User'
          * 
          * @type {?string}
          * @public
@@ -89,6 +89,14 @@ class SampleModel extends BaseModel
          */
         this.scheduledTimestamp = null;
         
+        /**
+         * When this Sample was Loaded into the Dehydrator
+         * 
+         * @type {?Date}
+         * @public
+         */
+        this.loadedTimestamp = null;
+        
         /**
          * When this Sample was Started
          * 
@@ -105,6 +113,14 @@ class SampleModel extends BaseModel
          */
         this.finishTimestamp = null;
         
+        /**
+         * When this Sample was Unloaded from the Dehydrator
+         * 
+         * @type {?Date}
+         * @public
+         */
+        this.unloadedTimestamp = null;
+        
         /**
          * When this Sample was Published
          * 
@@ -350,6 +366,23 @@ class SampleModel extends BaseModel
             }());
         }
         
+        if('loadedTimestamp' in jsonObject)
+        {
+            model.loadedTimestamp = (function(){
+                if(jsonObject['loadedTimestamp'] === null)
+                {
+                    return null;
+                }
+        
+                if(typeof jsonObject['loadedTimestamp'] !== 'string')
+                {
+                    return new Date(String(jsonObject['loadedTimestamp']));
+                }
+        
+                return new Date(jsonObject['loadedTimestamp']);
+            }());
+        }
+        
         if('startTimestamp' in jsonObject)
         {
             model.startTimestamp = (function(){
@@ -384,6 +417,23 @@ class SampleModel extends BaseModel
             }());
         }
         
+        if('unloadedTimestamp' in jsonObject)
+        {
+            model.unloadedTimestamp = (function(){
+                if(jsonObject['unloadedTimestamp'] === null)
+                {
+                    return null;
+                }
+        
+                if(typeof jsonObject['unloadedTimestamp'] !== 'string')
+                {
+                    return new Date(String(jsonObject['unloadedTimestamp']));
+                }
+        
+                return new Date(jsonObject['unloadedTimestamp']);
+            }());
+        }
+        
         if('publishTimestamp' in jsonObject)
         {
             model.publishTimestamp = (function(){

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

@@ -10,6 +10,7 @@
 import DehydratorModel from './DehydratorModel';
 import FruitProfileModel from './FruitProfileModel';
 import LabModel from './LabModel';
+import ProbeCalibrationModel from './ProbeCalibrationModel';
 import RackModel from './RackModel';
 import RackPositionModel from './RackPositionModel';
 import SampleFailureReasonModel from './SampleFailureReasonModel';
@@ -20,6 +21,7 @@ const Site = {
     DehydratorModel,
     FruitProfileModel,
     LabModel,
+    ProbeCalibrationModel,
     RackModel,
     RackPositionModel,
     SampleFailureReasonModel,

package/src/PackageVersion.js

@@ -1,2 +1,2 @@
 // Generated by genversion.
-export const version = '2.4.1';
+export const version = '2.4.2';