[Review] new sample properties (#247)

* new sample properties

* update api client with new fruitprofile properties

Author: daniel-ricado

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ricado/api-client",
-    "version": "2.5.16",
+    "version": "2.5.18",
     "description": "RICADO Gen 4 API Client Library for NodeJS and Browsers",
     "author": {
         "name": "Ash Neilson"

src/Controllers/Lab/Site/FruitProfileController.js

@@ -164,6 +164,14 @@ export default FruitProfileController;
  * @property {number} maximumTotalDuration The Maximum Duration (in seconds) that a Sample can be Dehydrated for before it is Considered Non-Compliant
  * @property {number} minimumTargetTemperature The Minimum Target Temperature for a Sample to be Compliant
  * @property {number} maximumTargetTemperature The Maximum Target Temperature for a Sample to be Compliant
+ * @property {number} warmUpStartExpectedTemperature The Warm-Up Temperature for starting the Warm Up alerts
+ * @property {number} warmUpStartExpectedRateOfChange The Warm-Up Start Expected Rate of Change
+ * @property {number} warmUpStageTwoExpectedTemperature The Warm-Up Stage Two Expected Temperature
+ * @property {number} warmUpStageTwoExpectedRateOfChange The Warm-Up Stage Two Expected Rate of Change
+ * @property {number} warmUpStageThreeExpectedTemperature The Warm-Up Stage Three Expected Temperature
+ * @property {number} warmUpStageThreeExpectedRateOfChange The Warm-Up Stage Three Expected Rate of Change
+ * @property {number} warmUpEndExpectedTemperature The Warm-Up End Expected Temperature
+ * @property {number} warmUpEndExpectedRateOfChange The Warm-Up End Expected Rate of Change
  * @memberof Controllers.Lab.Site
  */
 
@@ -180,5 +188,13 @@ export default FruitProfileController;
  * @property {number} [maximumTotalDuration] The Maximum Duration (in seconds) that a Sample can be Dehydrated for before it is Considered Non-Compliant
  * @property {number} [minimumTargetTemperature] The Minimum Target Temperature for a Sample to be Compliant
  * @property {number} [maximumTargetTemperature] The Maximum Target Temperature for a Sample to be Compliant
+ * @property {number} [warmUpStartExpectedTemperature] The Warm-Up Temperature for starting the Warm Up alerts
+ * @property {number} [warmUpStartExpectedRateOfChange] The Warm-Up Start Expected Rate of Change
+ * @property {number} [warmUpStageTwoExpectedTemperature] The Warm-Up Stage Two Expected Temperature
+ * @property {number} [warmUpStageTwoExpectedRateOfChange] The Warm-Up Stage Two Expected Rate of Change
+ * @property {number} [warmUpStageThreeExpectedTemperature] The Warm-Up Stage Three Expected Temperature
+ * @property {number} [warmUpStageThreeExpectedRateOfChange] The Warm-Up Stage Three Expected Rate of Change
+ * @property {number} [warmUpEndExpectedTemperature] The Warm-Up End Expected Temperature
+ * @property {number} [warmUpEndExpectedRateOfChange] The Warm-Up End Expected Rate of Change
  * @memberof Controllers.Lab.Site
  */

src/Controllers/Lab/Site/SampleController.js

@@ -1091,6 +1091,7 @@ export default SampleController;
  * @property {string} createdSource The Source that Created this Sample
  * @property {?string} [createdUserName] Name of the User who Created this Sample
  * @property {?Date} [scheduledTimestamp] Optional Scheduled Timestamp when this Sample should Begin
+ * @property {?Date} [scheduleReceivedTimestamp] Optional When the Schedule was received from Inspect
  * @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
@@ -1102,6 +1103,9 @@ export default SampleController;
  * @property {string} rackPositionId The Rack Position used for this Sample
  * @property {string} dehydratorId The Dehydrator used for this Sample
  * @property {?string} [resultId] The Sample Result ID asociated with this Sample
+ * @property {?string} [blindedSampleID] Optional the BlindedSampleID Reference defined in RadfordsInspect
+ * @property {?string} [shortDescription] Optional the Sample Short Description defined in RadfordsInspect
+ * @property {?string} [sampleDescription] Optional the Sample Description defined in RadfordsInspect
  * @memberof Controllers.Lab.Site
  */
 
@@ -1114,6 +1118,7 @@ export default SampleController;
  * @property {string} [createdSource] The Source that Created this Sample
  * @property {?string} [createdUserName] Name of the User who Created this Sample
  * @property {?Date} [scheduledTimestamp] Optional Scheduled Timestamp when this Sample should Begin
+ * @property {?Date} [scheduleReceivedTimestamp] Optional When the Schedule was received from Inspect
  * @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
@@ -1125,6 +1130,9 @@ export default SampleController;
  * @property {string} [rackPositionId] The Rack Position used for this Sample
  * @property {string} [dehydratorId] The Dehydrator used for this Sample
  * @property {?string} [resultId] The Sample Result ID asociated with this Sample
+ * @property {?string} [blindedSampleID] Optional the BlindedSampleID Reference defined in RadfordsInspect
+ * @property {?string} [shortDescription] Optional the Sample Short Description defined in RadfordsInspect
+ * @property {?string} [sampleDescription] Optional the Sample Description defined in RadfordsInspect
  * @memberof Controllers.Lab.Site
  */
 

src/Models/Lab/Site/FruitProfileModel.js

@@ -105,6 +105,70 @@ class FruitProfileModel extends BaseModel
          */
         this.maximumTargetTemperature = 0;
 
+        /**
+         * The Warm-Up Temperature for starting the Warm Up alerts
+         * 
+         * @type {number}
+         * @public
+         */
+        this.warmUpStartExpectedTemperature = 0;
+        
+        /**
+         * The Warm-Up Start Expected Rate of Change
+         * 
+         * @type {number}
+         * @public
+         */
+        this.warmUpStartExpectedRateOfChange = 0;
+        
+        /**
+         * The Warm-Up Stage Two Expected Temperature
+         * 
+         * @type {number}
+         * @public
+         */
+        this.warmUpStageTwoExpectedTemperature = 0;
+        
+        /**
+         * The Warm-Up Stage Two Expected Rate of Change
+         * 
+         * @type {number}
+         * @public
+         */
+        this.warmUpStageTwoExpectedRateOfChange = 0;
+        
+        /**
+         * The Warm-Up Stage Three Expected Temperature
+         * 
+         * @type {number}
+         * @public
+         */
+        this.warmUpStageThreeExpectedTemperature = 0;
+        
+        /**
+         * The Warm-Up Stage Three Expected Rate of Change
+         * 
+         * @type {number}
+         * @public
+         */
+        this.warmUpStageThreeExpectedRateOfChange = 0;
+        
+        /**
+         * The Warm-Up End Expected Temperature
+         * 
+         * @type {number}
+         * @public
+         */
+        this.warmUpEndExpectedTemperature = 0;
+        
+        /**
+         * The Warm-Up End Expected Rate of Change
+         * 
+         * @type {number}
+         * @public
+         */
+        this.warmUpEndExpectedRateOfChange = 0;
+        
         /**
          * Whether the Fruit Profile has been deleted
          * 
@@ -279,6 +343,102 @@ class FruitProfileModel extends BaseModel
             }());
         }
 
+        if('warmUpStartExpectedTemperature' in jsonObject)
+        {
+            model.warmUpStartExpectedTemperature = (function(){
+                if(typeof jsonObject['warmUpStartExpectedTemperature'] !== 'number')
+                {
+                    return Number(jsonObject['warmUpStartExpectedTemperature']);
+                }
+        
+                return jsonObject['warmUpStartExpectedTemperature'];
+            }());
+        }
+        
+        if('warmUpStartExpectedRateOfChange' in jsonObject)
+        {
+            model.warmUpStartExpectedRateOfChange = (function(){
+                if(typeof jsonObject['warmUpStartExpectedRateOfChange'] !== 'number')
+                {
+                    return Number(jsonObject['warmUpStartExpectedRateOfChange']);
+                }
+        
+                return jsonObject['warmUpStartExpectedRateOfChange'];
+            }());
+        }
+        
+        if('warmUpStageTwoExpectedTemperature' in jsonObject)
+        {
+            model.warmUpStageTwoExpectedTemperature = (function(){
+                if(typeof jsonObject['warmUpStageTwoExpectedTemperature'] !== 'number')
+                {
+                    return Number(jsonObject['warmUpStageTwoExpectedTemperature']);
+                }
+        
+                return jsonObject['warmUpStageTwoExpectedTemperature'];
+            }());
+        }
+        
+        if('warmUpStageTwoExpectedRateOfChange' in jsonObject)
+        {
+            model.warmUpStageTwoExpectedRateOfChange = (function(){
+                if(typeof jsonObject['warmUpStageTwoExpectedRateOfChange'] !== 'number')
+                {
+                    return Number(jsonObject['warmUpStageTwoExpectedRateOfChange']);
+                }
+        
+                return jsonObject['warmUpStageTwoExpectedRateOfChange'];
+            }());
+        }
+        
+        if('warmUpStageThreeExpectedTemperature' in jsonObject)
+        {
+            model.warmUpStageThreeExpectedTemperature = (function(){
+                if(typeof jsonObject['warmUpStageThreeExpectedTemperature'] !== 'number')
+                {
+                    return Number(jsonObject['warmUpStageThreeExpectedTemperature']);
+                }
+        
+                return jsonObject['warmUpStageThreeExpectedTemperature'];
+            }());
+        }
+        
+        if('warmUpStageThreeExpectedRateOfChange' in jsonObject)
+        {
+            model.warmUpStageThreeExpectedRateOfChange = (function(){
+                if(typeof jsonObject['warmUpStageThreeExpectedRateOfChange'] !== 'number')
+                {
+                    return Number(jsonObject['warmUpStageThreeExpectedRateOfChange']);
+                }
+        
+                return jsonObject['warmUpStageThreeExpectedRateOfChange'];
+            }());
+        }
+        
+        if('warmUpEndExpectedTemperature' in jsonObject)
+        {
+            model.warmUpEndExpectedTemperature = (function(){
+                if(typeof jsonObject['warmUpEndExpectedTemperature'] !== 'number')
+                {
+                    return Number(jsonObject['warmUpEndExpectedTemperature']);
+                }
+        
+                return jsonObject['warmUpEndExpectedTemperature'];
+            }());
+        }
+        
+        if('warmUpEndExpectedRateOfChange' in jsonObject)
+        {
+            model.warmUpEndExpectedRateOfChange = (function(){
+                if(typeof jsonObject['warmUpEndExpectedRateOfChange'] !== 'number')
+                {
+                    return Number(jsonObject['warmUpEndExpectedRateOfChange']);
+                }
+        
+                return jsonObject['warmUpEndExpectedRateOfChange'];
+            }());
+        }
+        
         if('deleted' in jsonObject)
         {
             model.deleted = (function(){

src/Models/Lab/Site/SampleModel.js

@@ -81,6 +81,14 @@ class SampleModel extends BaseModel
          */
         this.scheduledTimestamp = null;
 
+        /**
+         * Optional When the Schedule was received from Inspect
+         * 
+         * @type {?Date}
+         * @public
+         */
+        this.scheduleReceivedTimestamp = null;
+        
         /**
          * When this Sample was Loaded into the Dehydrator
          * 
@@ -169,6 +177,30 @@ class SampleModel extends BaseModel
          */
         this.resultId = null;
 
+        /**
+         * Optional the BlindedSampleID Reference defined in RadfordsInspect
+         * 
+         * @type {?string}
+         * @public
+         */
+        this.blindedSampleID = null;
+        
+        /**
+         * Optional the Sample Short Description defined in RadfordsInspect
+         * 
+         * @type {?string}
+         * @public
+         */
+        this.shortDescription = null;
+        
+        /**
+         * Optional the Sample Description defined in RadfordsInspect
+         * 
+         * @type {?string}
+         * @public
+         */
+        this.sampleDescription = null;
+        
         /**
          * The Status of this Sample
          * 
@@ -325,6 +357,23 @@ class SampleModel extends BaseModel
             }());
         }
 
+        if('scheduleReceivedTimestamp' in jsonObject)
+        {
+            model.scheduleReceivedTimestamp = (function(){
+                if(jsonObject['scheduleReceivedTimestamp'] === null)
+                {
+                    return null;
+                }
+        
+                if(typeof jsonObject['scheduleReceivedTimestamp'] !== 'string')
+                {
+                    return new Date(String(jsonObject['scheduleReceivedTimestamp']));
+                }
+        
+                return new Date(jsonObject['scheduleReceivedTimestamp']);
+            }());
+        }
+        
         if('loadedTimestamp' in jsonObject)
         {
             model.loadedTimestamp = (function(){
@@ -497,6 +546,57 @@ class SampleModel extends BaseModel
             }());
         }
 
+        if('blindedSampleID' in jsonObject)
+        {
+            model.blindedSampleID = (function(){
+                if(jsonObject['blindedSampleID'] === null)
+                {
+                    return null;
+                }
+        
+                if(typeof jsonObject['blindedSampleID'] !== 'string')
+                {
+                    return String(jsonObject['blindedSampleID']);
+                }
+        
+                return jsonObject['blindedSampleID'];
+            }());
+        }
+        
+        if('shortDescription' in jsonObject)
+        {
+            model.shortDescription = (function(){
+                if(jsonObject['shortDescription'] === null)
+                {
+                    return null;
+                }
+        
+                if(typeof jsonObject['shortDescription'] !== 'string')
+                {
+                    return String(jsonObject['shortDescription']);
+                }
+        
+                return jsonObject['shortDescription'];
+            }());
+        }
+        
+        if('sampleDescription' in jsonObject)
+        {
+            model.sampleDescription = (function(){
+                if(jsonObject['sampleDescription'] === null)
+                {
+                    return null;
+                }
+        
+                if(typeof jsonObject['sampleDescription'] !== 'string')
+                {
+                    return String(jsonObject['sampleDescription']);
+                }
+        
+                return jsonObject['sampleDescription'];
+            }());
+        }
+        
         if('status' in jsonObject)
         {
             model.status = (function(){