@ricado/api-client 2.4.2 → 2.5.1

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

@@ -52,7 +52,7 @@ class RackPositionModel extends BaseModel
         /**
          * The Points used by this Rack Position
          * 
-         * @type {{pushButton: number, indicatorLight: number, temperature: number, calibrationOffset: number, disabled: number, currentSampleId: number, currentSampleStatus: number, nextSampleId: number, startCurrentSampleRequest: number, finishCurrentSampleRequest: number, currentSampleTotalDuration: number, currentSampleWarmUpDuration: number, currentSampleWarmUpCompleted: number, currentSampleBelowTargetDuration: number, currentSampleAboveTargetDuration: number, currentSampleWithinTargetDuration: number, currentSampleSuccessCriteriaMet: number, currentSampleFailureCriteriaMet: number}}
+         * @type {{pushButton: number, indicatorLight: number, temperature: number, calibrationOffset: number, disabled: number, currentSampleId: number, currentSampleStatus: number, nextSampleId: number, loadCurrentSampleRequest: number, startCurrentSampleRequest: number, finishCurrentSampleRequest: number, unloadCurrentSampleRequest: number, currentSampleTotalDuration: number, currentSampleWarmUpDuration: number, currentSampleWarmUpRateOfChange: number, currentSampleWarmUpWarning: number, currentSampleWarmUpCompleted: number, currentSampleBelowTargetDuration: number, currentSampleAboveTargetDuration: number, currentSampleWithinTargetDuration: number, currentSampleFinishCriteriaMet: number, currentSampleLatestUnloadTimestamp: number}}
          * @public
          */
         this.points = (function(){
@@ -74,14 +74,22 @@ class RackPositionModel extends BaseModel
             
             pointsDefaultValue.nextSampleId = 0;
             
+            pointsDefaultValue.loadCurrentSampleRequest = 0;
+            
             pointsDefaultValue.startCurrentSampleRequest = 0;
             
             pointsDefaultValue.finishCurrentSampleRequest = 0;
             
+            pointsDefaultValue.unloadCurrentSampleRequest = 0;
+            
             pointsDefaultValue.currentSampleTotalDuration = 0;
             
             pointsDefaultValue.currentSampleWarmUpDuration = 0;
             
+            pointsDefaultValue.currentSampleWarmUpRateOfChange = 0;
+            
+            pointsDefaultValue.currentSampleWarmUpWarning = 0;
+            
             pointsDefaultValue.currentSampleWarmUpCompleted = 0;
             
             pointsDefaultValue.currentSampleBelowTargetDuration = 0;
@@ -90,9 +98,9 @@ class RackPositionModel extends BaseModel
             
             pointsDefaultValue.currentSampleWithinTargetDuration = 0;
             
-            pointsDefaultValue.currentSampleSuccessCriteriaMet = 0;
+            pointsDefaultValue.currentSampleFinishCriteriaMet = 0;
             
-            pointsDefaultValue.currentSampleFailureCriteriaMet = 0;
+            pointsDefaultValue.currentSampleLatestUnloadTimestamp = 0;
             
             return pointsDefaultValue;
         }());
@@ -357,6 +365,22 @@ class RackPositionModel extends BaseModel
                     pointsObject.nextSampleId = 0;
                 }
                 
+                if(typeof jsonObject['points'] === 'object' && 'loadCurrentSampleRequest' in jsonObject['points'])
+                {
+                    pointsObject.loadCurrentSampleRequest = (function(){
+                        if(typeof jsonObject['points'].loadCurrentSampleRequest !== 'number')
+                        {
+                            return Number.isInteger(Number(jsonObject['points'].loadCurrentSampleRequest)) ? Number(jsonObject['points'].loadCurrentSampleRequest) : Math.floor(Number(jsonObject['points'].loadCurrentSampleRequest));
+                        }
+        
+                        return Number.isInteger(jsonObject['points'].loadCurrentSampleRequest) ? jsonObject['points'].loadCurrentSampleRequest : Math.floor(jsonObject['points'].loadCurrentSampleRequest);
+                    }());
+                }
+                else
+                {
+                    pointsObject.loadCurrentSampleRequest = 0;
+                }
+                
                 if(typeof jsonObject['points'] === 'object' && 'startCurrentSampleRequest' in jsonObject['points'])
                 {
                     pointsObject.startCurrentSampleRequest = (function(){
@@ -389,6 +413,22 @@ class RackPositionModel extends BaseModel
                     pointsObject.finishCurrentSampleRequest = 0;
                 }
                 
+                if(typeof jsonObject['points'] === 'object' && 'unloadCurrentSampleRequest' in jsonObject['points'])
+                {
+                    pointsObject.unloadCurrentSampleRequest = (function(){
+                        if(typeof jsonObject['points'].unloadCurrentSampleRequest !== 'number')
+                        {
+                            return Number.isInteger(Number(jsonObject['points'].unloadCurrentSampleRequest)) ? Number(jsonObject['points'].unloadCurrentSampleRequest) : Math.floor(Number(jsonObject['points'].unloadCurrentSampleRequest));
+                        }
+        
+                        return Number.isInteger(jsonObject['points'].unloadCurrentSampleRequest) ? jsonObject['points'].unloadCurrentSampleRequest : Math.floor(jsonObject['points'].unloadCurrentSampleRequest);
+                    }());
+                }
+                else
+                {
+                    pointsObject.unloadCurrentSampleRequest = 0;
+                }
+                
                 if(typeof jsonObject['points'] === 'object' && 'currentSampleTotalDuration' in jsonObject['points'])
                 {
                     pointsObject.currentSampleTotalDuration = (function(){
@@ -421,6 +461,38 @@ class RackPositionModel extends BaseModel
                     pointsObject.currentSampleWarmUpDuration = 0;
                 }
                 
+                if(typeof jsonObject['points'] === 'object' && 'currentSampleWarmUpRateOfChange' in jsonObject['points'])
+                {
+                    pointsObject.currentSampleWarmUpRateOfChange = (function(){
+                        if(typeof jsonObject['points'].currentSampleWarmUpRateOfChange !== 'number')
+                        {
+                            return Number.isInteger(Number(jsonObject['points'].currentSampleWarmUpRateOfChange)) ? Number(jsonObject['points'].currentSampleWarmUpRateOfChange) : Math.floor(Number(jsonObject['points'].currentSampleWarmUpRateOfChange));
+                        }
+        
+                        return Number.isInteger(jsonObject['points'].currentSampleWarmUpRateOfChange) ? jsonObject['points'].currentSampleWarmUpRateOfChange : Math.floor(jsonObject['points'].currentSampleWarmUpRateOfChange);
+                    }());
+                }
+                else
+                {
+                    pointsObject.currentSampleWarmUpRateOfChange = 0;
+                }
+                
+                if(typeof jsonObject['points'] === 'object' && 'currentSampleWarmUpWarning' in jsonObject['points'])
+                {
+                    pointsObject.currentSampleWarmUpWarning = (function(){
+                        if(typeof jsonObject['points'].currentSampleWarmUpWarning !== 'number')
+                        {
+                            return Number.isInteger(Number(jsonObject['points'].currentSampleWarmUpWarning)) ? Number(jsonObject['points'].currentSampleWarmUpWarning) : Math.floor(Number(jsonObject['points'].currentSampleWarmUpWarning));
+                        }
+        
+                        return Number.isInteger(jsonObject['points'].currentSampleWarmUpWarning) ? jsonObject['points'].currentSampleWarmUpWarning : Math.floor(jsonObject['points'].currentSampleWarmUpWarning);
+                    }());
+                }
+                else
+                {
+                    pointsObject.currentSampleWarmUpWarning = 0;
+                }
+                
                 if(typeof jsonObject['points'] === 'object' && 'currentSampleWarmUpCompleted' in jsonObject['points'])
                 {
                     pointsObject.currentSampleWarmUpCompleted = (function(){
@@ -485,36 +557,36 @@ class RackPositionModel extends BaseModel
                     pointsObject.currentSampleWithinTargetDuration = 0;
                 }
                 
-                if(typeof jsonObject['points'] === 'object' && 'currentSampleSuccessCriteriaMet' in jsonObject['points'])
+                if(typeof jsonObject['points'] === 'object' && 'currentSampleFinishCriteriaMet' in jsonObject['points'])
                 {
-                    pointsObject.currentSampleSuccessCriteriaMet = (function(){
-                        if(typeof jsonObject['points'].currentSampleSuccessCriteriaMet !== 'number')
+                    pointsObject.currentSampleFinishCriteriaMet = (function(){
+                        if(typeof jsonObject['points'].currentSampleFinishCriteriaMet !== 'number')
                         {
-                            return Number.isInteger(Number(jsonObject['points'].currentSampleSuccessCriteriaMet)) ? Number(jsonObject['points'].currentSampleSuccessCriteriaMet) : Math.floor(Number(jsonObject['points'].currentSampleSuccessCriteriaMet));
+                            return Number.isInteger(Number(jsonObject['points'].currentSampleFinishCriteriaMet)) ? Number(jsonObject['points'].currentSampleFinishCriteriaMet) : Math.floor(Number(jsonObject['points'].currentSampleFinishCriteriaMet));
                         }
         
-                        return Number.isInteger(jsonObject['points'].currentSampleSuccessCriteriaMet) ? jsonObject['points'].currentSampleSuccessCriteriaMet : Math.floor(jsonObject['points'].currentSampleSuccessCriteriaMet);
+                        return Number.isInteger(jsonObject['points'].currentSampleFinishCriteriaMet) ? jsonObject['points'].currentSampleFinishCriteriaMet : Math.floor(jsonObject['points'].currentSampleFinishCriteriaMet);
                     }());
                 }
                 else
                 {
-                    pointsObject.currentSampleSuccessCriteriaMet = 0;
+                    pointsObject.currentSampleFinishCriteriaMet = 0;
                 }
                 
-                if(typeof jsonObject['points'] === 'object' && 'currentSampleFailureCriteriaMet' in jsonObject['points'])
+                if(typeof jsonObject['points'] === 'object' && 'currentSampleLatestUnloadTimestamp' in jsonObject['points'])
                 {
-                    pointsObject.currentSampleFailureCriteriaMet = (function(){
-                        if(typeof jsonObject['points'].currentSampleFailureCriteriaMet !== 'number')
+                    pointsObject.currentSampleLatestUnloadTimestamp = (function(){
+                        if(typeof jsonObject['points'].currentSampleLatestUnloadTimestamp !== 'number')
                         {
-                            return Number.isInteger(Number(jsonObject['points'].currentSampleFailureCriteriaMet)) ? Number(jsonObject['points'].currentSampleFailureCriteriaMet) : Math.floor(Number(jsonObject['points'].currentSampleFailureCriteriaMet));
+                            return Number.isInteger(Number(jsonObject['points'].currentSampleLatestUnloadTimestamp)) ? Number(jsonObject['points'].currentSampleLatestUnloadTimestamp) : Math.floor(Number(jsonObject['points'].currentSampleLatestUnloadTimestamp));
                         }
         
-                        return Number.isInteger(jsonObject['points'].currentSampleFailureCriteriaMet) ? jsonObject['points'].currentSampleFailureCriteriaMet : Math.floor(jsonObject['points'].currentSampleFailureCriteriaMet);
+                        return Number.isInteger(jsonObject['points'].currentSampleLatestUnloadTimestamp) ? jsonObject['points'].currentSampleLatestUnloadTimestamp : Math.floor(jsonObject['points'].currentSampleLatestUnloadTimestamp);
                     }());
                 }
                 else
                 {
-                    pointsObject.currentSampleFailureCriteriaMet = 0;
+                    pointsObject.currentSampleLatestUnloadTimestamp = 0;
                 }
         
                 return pointsObject;

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

@@ -66,15 +66,7 @@ class SampleModel extends BaseModel
         this.createdSource = "";
         
         /**
-         * ID of the User who Created this Sample. Only applies if the `createdSource` is 'User'
-         * 
-         * @type {?string}
-         * @public
-         */
-        this.createdUserId = null;
-        
-        /**
-         * Name of the User who Created this Sample. Only applies if the `createdSource` is 'User'
+         * Name of the User who Created this Sample
          * 
          * @type {?string}
          * @public
@@ -130,12 +122,12 @@ class SampleModel extends BaseModel
         this.publishTimestamp = null;
         
         /**
-         * ID of the User who Published this Sample
+         * The Source that Published this Sample
          * 
          * @type {?string}
          * @public
          */
-        this.publishUserId = null;
+        this.publishSource = null;
         
         /**
          * Name of the User who Published this Sample
@@ -169,22 +161,6 @@ class SampleModel extends BaseModel
          */
         this.dehydratorId = "";
         
-        /**
-         * The Outcome of this Sample
-         * 
-         * @type {?string}
-         * @public
-         */
-        this.outcome = null;
-        
-        /**
-         * A Sample Failure Reason ID if this Sample Failed
-         * 
-         * @type {?string}
-         * @public
-         */
-        this.failureReasonId = null;
-        
         /**
          * The Sample Result ID asociated with this Sample
          * 
@@ -315,23 +291,6 @@ class SampleModel extends BaseModel
             }());
         }
         
-        if('createdUserId' in jsonObject)
-        {
-            model.createdUserId = (function(){
-                if(jsonObject['createdUserId'] === null)
-                {
-                    return null;
-                }
-        
-                if(typeof jsonObject['createdUserId'] !== 'string')
-                {
-                    return String(jsonObject['createdUserId']);
-                }
-        
-                return jsonObject['createdUserId'];
-            }());
-        }
-        
         if('createdUserName' in jsonObject)
         {
             model.createdUserName = (function(){
@@ -451,20 +410,20 @@ class SampleModel extends BaseModel
             }());
         }
         
-        if('publishUserId' in jsonObject)
+        if('publishSource' in jsonObject)
         {
-            model.publishUserId = (function(){
-                if(jsonObject['publishUserId'] === null)
+            model.publishSource = (function(){
+                if(jsonObject['publishSource'] === null)
                 {
                     return null;
                 }
         
-                if(typeof jsonObject['publishUserId'] !== 'string')
+                if(typeof jsonObject['publishSource'] !== 'string')
                 {
-                    return String(jsonObject['publishUserId']);
+                    return String(jsonObject['publishSource']);
                 }
         
-                return jsonObject['publishUserId'];
+                return jsonObject['publishSource'];
             }());
         }
         
@@ -521,40 +480,6 @@ class SampleModel extends BaseModel
             }());
         }
         
-        if('outcome' in jsonObject)
-        {
-            model.outcome = (function(){
-                if(jsonObject['outcome'] === null)
-                {
-                    return null;
-                }
-        
-                if(typeof jsonObject['outcome'] !== 'string')
-                {
-                    return String(jsonObject['outcome']);
-                }
-        
-                return jsonObject['outcome'];
-            }());
-        }
-        
-        if('failureReasonId' in jsonObject)
-        {
-            model.failureReasonId = (function(){
-                if(jsonObject['failureReasonId'] === null)
-                {
-                    return null;
-                }
-        
-                if(typeof jsonObject['failureReasonId'] !== 'string')
-                {
-                    return String(jsonObject['failureReasonId']);
-                }
-        
-                return jsonObject['failureReasonId'];
-            }());
-        }
-        
         if('resultId' in jsonObject)
         {
             model.resultId = (function(){

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

@@ -7,7 +7,7 @@
 import BaseModel from '../../../Models/BaseModel';
 
 /**
- * Model Class for a Sample Results
+ * Model Class for a Sample Result
  * 
  * @class
  * @hideconstructor
@@ -19,14 +19,14 @@ class SampleResultModel extends BaseModel
      * SampleResultModel Constructor
      * 
      * @protected
-     * @param {number} siteId The Site ID associated with this Sample Results
+     * @param {number} siteId The Site ID associated with this Sample Result
      */
     constructor(siteId)
     {
         super();
         
         /**
-         * The Sample Results ID
+         * The Sample Result ID
          * 
          * @type {string}
          * @public
@@ -106,20 +106,20 @@ class SampleResultModel extends BaseModel
         this.withinTargetDuration = 0;
         
         /**
-         * Timestamp of when the Success Criteria was Met for the Sample - `null` if not Met
+         * Timestamp of when the Finish Criteria was Met for the Sample - `null` if not Met
          * 
          * @type {?Date}
          * @public
          */
-        this.successCriteriaMetTimestamp = null;
+        this.finishCriteriaMetTimestamp = null;
         
         /**
-         * Timestamp of when the Failure Criteria was Met for the Sample - `null` if not Met
+         * Latest Possible Timestamp of when the Sample should have been Unloaded to remain Compliant
          * 
          * @type {?Date}
          * @public
          */
-        this.failureCriteriaMetTimestamp = null;
+        this.latestUnloadTimestamp = null;
         
         /**
          * The Average Temperature for the Total Duration of the Sample
@@ -129,6 +129,14 @@ class SampleResultModel extends BaseModel
          */
         this.totalAverageTemperature = null;
         
+        /**
+         * The Average Temperature Rate-of-Change seen during the Warm Up process for the Sample
+         * 
+         * @type {?number}
+         * @public
+         */
+        this.warmUpRateOfChangeTemperature = null;
+        
         /**
          * The Minimum Temperature seen Below the Temperature Target for the Sample
          * 
@@ -186,7 +194,7 @@ class SampleResultModel extends BaseModel
         this.withinTargetAverageTemperature = null;
         
         /**
-         * Whether the Sample Results has been deleted
+         * Whether the Sample Result has been deleted
          * 
          * @type {boolean}
          * @public
@@ -194,7 +202,7 @@ class SampleResultModel extends BaseModel
         this.deleted = false;
         
         /**
-         * When the Sample Results was last updated
+         * When the Sample Result was last updated
          * 
          * @type {Date}
          * @public
@@ -202,7 +210,7 @@ class SampleResultModel extends BaseModel
         this.updateTimestamp = new Date();
         
         /**
-         * The Site ID associated with this Sample Results
+         * The Site ID associated with this Sample Result
          * 
          * @type {number}
          * @public
@@ -216,7 +224,7 @@ class SampleResultModel extends BaseModel
      * @static
      * @public
      * @param {Object<string, any>|string} json A JSON Object or JSON String
-     * @param {number} siteId The Site ID associated with this Sample Results
+     * @param {number} siteId The Site ID associated with this Sample Result
      * @return {SampleResultModel}
      */
     static fromJSON(json, siteId)
@@ -364,37 +372,37 @@ class SampleResultModel extends BaseModel
             }());
         }
         
-        if('successCriteriaMetTimestamp' in jsonObject)
+        if('finishCriteriaMetTimestamp' in jsonObject)
         {
-            model.successCriteriaMetTimestamp = (function(){
-                if(jsonObject['successCriteriaMetTimestamp'] === null)
+            model.finishCriteriaMetTimestamp = (function(){
+                if(jsonObject['finishCriteriaMetTimestamp'] === null)
                 {
                     return null;
                 }
         
-                if(typeof jsonObject['successCriteriaMetTimestamp'] !== 'string')
+                if(typeof jsonObject['finishCriteriaMetTimestamp'] !== 'string')
                 {
-                    return new Date(String(jsonObject['successCriteriaMetTimestamp']));
+                    return new Date(String(jsonObject['finishCriteriaMetTimestamp']));
                 }
         
-                return new Date(jsonObject['successCriteriaMetTimestamp']);
+                return new Date(jsonObject['finishCriteriaMetTimestamp']);
             }());
         }
         
-        if('failureCriteriaMetTimestamp' in jsonObject)
+        if('latestUnloadTimestamp' in jsonObject)
         {
-            model.failureCriteriaMetTimestamp = (function(){
-                if(jsonObject['failureCriteriaMetTimestamp'] === null)
+            model.latestUnloadTimestamp = (function(){
+                if(jsonObject['latestUnloadTimestamp'] === null)
                 {
                     return null;
                 }
         
-                if(typeof jsonObject['failureCriteriaMetTimestamp'] !== 'string')
+                if(typeof jsonObject['latestUnloadTimestamp'] !== 'string')
                 {
-                    return new Date(String(jsonObject['failureCriteriaMetTimestamp']));
+                    return new Date(String(jsonObject['latestUnloadTimestamp']));
                 }
         
-                return new Date(jsonObject['failureCriteriaMetTimestamp']);
+                return new Date(jsonObject['latestUnloadTimestamp']);
             }());
         }
         
@@ -415,6 +423,23 @@ class SampleResultModel extends BaseModel
             }());
         }
         
+        if('warmUpRateOfChangeTemperature' in jsonObject)
+        {
+            model.warmUpRateOfChangeTemperature = (function(){
+                if(jsonObject['warmUpRateOfChangeTemperature'] === null)
+                {
+                    return null;
+                }
+        
+                if(typeof jsonObject['warmUpRateOfChangeTemperature'] !== 'number')
+                {
+                    return Number(jsonObject['warmUpRateOfChangeTemperature']);
+                }
+        
+                return jsonObject['warmUpRateOfChangeTemperature'];
+            }());
+        }
+        
         if('belowTargetMinimumTemperature' in jsonObject)
         {
             model.belowTargetMinimumTemperature = (function(){

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

@@ -13,7 +13,6 @@ import LabModel from './LabModel';
 import ProbeCalibrationModel from './ProbeCalibrationModel';
 import RackModel from './RackModel';
 import RackPositionModel from './RackPositionModel';
-import SampleFailureReasonModel from './SampleFailureReasonModel';
 import SampleModel from './SampleModel';
 import SampleResultModel from './SampleResultModel';
 
@@ -24,7 +23,6 @@ const Site = {
     ProbeCalibrationModel,
     RackModel,
     RackPositionModel,
-    SampleFailureReasonModel,
     SampleModel,
     SampleResultModel,
 };

package/src/PackageVersion.js

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