@ricado/api-client 2.4.0 → 2.4.2

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

@@ -16,66 +16,46 @@ import SampleResultModel from '../../../Models/Lab/Site/SampleResultModel';
 class SampleController
 {
     /**
-     * Retrieve Temperature Data [GET /lab/sites/{siteId}/samples/{id}]
-     * 
-     * Retrieves Temperature Data for a Sample
+     * Retrieve a Sample [GET /lab/sites/{siteId}/samples/{id}]
      * 
      * @static
      * @public
      * @param {number} siteId The Site ID
      * @param {string} id The Sample ID
-     * @return {Promise<Array<SampleController.TemperatureDataItem>>}
+     * @return {Promise<SampleModel>}
      */
-    static getTemperatureData(siteId, id)
+    static getOne(siteId, id)
     {
         return new Promise((resolve, reject) => {
             RequestHelper.getRequest(`/lab/sites/${siteId}/samples/${id}`)
             .then((result) => {
                 let resolveValue = (function(){
-                    if(Array.isArray(result) !== true)
-                    {
-                        return [];
-                    }
-                
-                    return result.map((resultItem) => {
-                        return (function(){
-                            let resultItemObject = {};
-                            
-                            if(typeof resultItem === 'object' && 'timestamp' in resultItem)
-                            {
-                                resultItemObject.timestamp = (function(){
-                                    if(typeof resultItem.timestamp !== 'string')
-                                    {
-                                        return new Date(String(resultItem.timestamp));
-                                    }
-                
-                                    return new Date(resultItem.timestamp);
-                                }());
-                            }
-                            else
-                            {
-                                resultItemObject.timestamp = new Date();
-                            }
-                            
-                            if(typeof resultItem === 'object' && 'temperature' in resultItem)
-                            {
-                                resultItemObject.temperature = (function(){
-                                    if(typeof resultItem.temperature !== 'number')
-                                    {
-                                        return Number(resultItem.temperature);
-                                    }
-                
-                                    return resultItem.temperature;
-                                }());
-                            }
-                            else
-                            {
-                                resultItemObject.temperature = 0;
-                            }
+                    return SampleModel.fromJSON(result, siteId);
+                }());
                 
-                            return resultItemObject;
-                        }());
-                    });
+                resolve(resolveValue);
+            })
+            .catch(error => reject(error));
+        });
+    }
+
+    /**
+     * Update a Sample [PATCH /lab/sites/{siteId}/samples/{id}]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Sample ID
+     * @param {SampleController.UpdateData} updateData The Sample Update Data
+     * @return {Promise<SampleModel>}
+     */
+    static update(siteId, id, updateData)
+    {
+        return new Promise((resolve, reject) => {
+            RequestHelper.patchRequest(`/lab/sites/${siteId}/samples/${id}`, updateData)
+            .then((result) => {
+                let resolveValue = (function(){
+                    return SampleModel.fromJSON(result, siteId);
                 }());
                 
                 resolve(resolveValue);
@@ -84,6 +64,26 @@ class SampleController
         });
     }
 
+    /**
+     * Delete a Sample [DELETE /lab/sites/{siteId}/samples/{id}]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Sample ID
+     * @return {Promise<boolean>}
+     */
+    static delete(siteId, id)
+    {
+        return new Promise((resolve, reject) => {
+            RequestHelper.deleteRequest(`/lab/sites/${siteId}/samples/${id}`)
+            .then((result) => {
+                resolve(result ?? true);
+            })
+            .catch(error => reject(error));
+        });
+    }
+
     /**
      * Retrieve Comments [GET /lab/sites/{siteId}/samples/{id}/comments]
      * 
@@ -918,6 +918,75 @@ class SampleController
         });
     }
 
+    /**
+     * Retrieve Temperature Data [GET /lab/sites/{siteId}/samples/{id}/temperature-data]
+     * 
+     * Retrieves Temperature Data for a Sample
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Sample ID
+     * @return {Promise<Array<SampleController.TemperatureDataItem>>}
+     */
+    static getTemperatureData(siteId, id)
+    {
+        return new Promise((resolve, reject) => {
+            RequestHelper.getRequest(`/lab/sites/${siteId}/samples/${id}/temperature-data`)
+            .then((result) => {
+                let resolveValue = (function(){
+                    if(Array.isArray(result) !== true)
+                    {
+                        return [];
+                    }
+                
+                    return result.map((resultItem) => {
+                        return (function(){
+                            let resultItemObject = {};
+                            
+                            if(typeof resultItem === 'object' && 'timestamp' in resultItem)
+                            {
+                                resultItemObject.timestamp = (function(){
+                                    if(typeof resultItem.timestamp !== 'string')
+                                    {
+                                        return new Date(String(resultItem.timestamp));
+                                    }
+                
+                                    return new Date(resultItem.timestamp);
+                                }());
+                            }
+                            else
+                            {
+                                resultItemObject.timestamp = new Date();
+                            }
+                            
+                            if(typeof resultItem === 'object' && 'temperature' in resultItem)
+                            {
+                                resultItemObject.temperature = (function(){
+                                    if(typeof resultItem.temperature !== 'number')
+                                    {
+                                        return Number(resultItem.temperature);
+                                    }
+                
+                                    return resultItem.temperature;
+                                }());
+                            }
+                            else
+                            {
+                                resultItemObject.temperature = 0;
+                            }
+                
+                            return resultItemObject;
+                        }());
+                    });
+                }());
+                
+                resolve(resolveValue);
+            })
+            .catch(error => reject(error));
+        });
+    }
+
     /**
      * List all Samples [GET /lab/sites/{siteId}/samples]
      * 
@@ -985,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
@@ -999,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
@@ -1018,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
@@ -1036,11 +1111,28 @@ export default SampleController;
  */
 
 /**
- * A **TemperatureDataItem** Type
+ * The Update Data for a Sample
  * 
- * @typedef {Object} SampleController.TemperatureDataItem
- * @property {Date} timestamp The Timestamp for the Temperature Value
- * @property {number} temperature The Temperature Value
+ * @typedef {Object} SampleController.UpdateData
+ * @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 '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
+ * @property {string} [fruitProfileId] The Fruit Profile for this Sample
+ * @property {string} [rackPositionId] The Rack Position used for this Sample
+ * @property {string} [dehydratorId] The Dehydrator used for this Sample
+ * @property {?string} [outcome] The Outcome of this Sample
+ * @property {?string} [failureReasonId] A Sample Failure Reason ID if this Sample Failed
+ * @property {?string} [resultId] The Sample Result ID asociated with this Sample
  * @memberof Controllers.Lab.Site
  */
 
@@ -1064,4 +1156,13 @@ export default SampleController;
  * @property {?Date} createdTimestamp When the Comment was Created
  * @property {?Date} updatedTimestamp When the Comment was last Updated
  * @memberof Controllers.Lab.Site
+ */
+
+/**
+ * A **TemperatureDataItem** Type
+ * 
+ * @typedef {Object} SampleController.TemperatureDataItem
+ * @property {Date} timestamp The Timestamp for the Temperature Value
+ * @property {number} temperature The Temperature Value
+ * @memberof Controllers.Lab.Site
  */

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;