@ricado/api-client 2.4.2 → 2.5.0

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.0';

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

@@ -1,193 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _RequestHelper = _interopRequireDefault(require("../../../RequestHelper"));
-
-var _SampleFailureReasonModel = _interopRequireDefault(require("../../../Models/Lab/Site/SampleFailureReasonModel"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
-
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
-
-/**
- * Controller Class for Sample Failure Reasons
- * 
- * @class
- */
-var SampleFailureReasonController = /*#__PURE__*/function () {
-  function SampleFailureReasonController() {
-    _classCallCheck(this, SampleFailureReasonController);
-  }
-
-  _createClass(SampleFailureReasonController, null, [{
-    key: "getOne",
-    value:
-    /**
-     * Retrieve a Sample Failure Reason [GET /lab/sites/{siteId}/sample-failure-reasons/{id}]
-     * 
-     * @static
-     * @public
-     * @param {number} siteId The Site ID
-     * @param {string} id The Sample Failure Reason ID
-     * @return {Promise<SampleFailureReasonModel>}
-     */
-    function getOne(siteId, id) {
-      return new Promise(function (resolve, reject) {
-        _RequestHelper.default.getRequest("/lab/sites/".concat(siteId, "/sample-failure-reasons/").concat(id)).then(function (result) {
-          var resolveValue = function () {
-            return _SampleFailureReasonModel.default.fromJSON(result, siteId);
-          }();
-
-          resolve(resolveValue);
-        }).catch(function (error) {
-          return reject(error);
-        });
-      });
-    }
-    /**
-     * Update a Sample Failure Reason [PATCH /lab/sites/{siteId}/sample-failure-reasons/{id}]
-     * 
-     * @static
-     * @public
-     * @param {number} siteId The Site ID
-     * @param {string} id The Sample Failure Reason ID
-     * @param {SampleFailureReasonController.UpdateData} updateData The Sample Failure Reason Update Data
-     * @return {Promise<SampleFailureReasonModel>}
-     */
-
-  }, {
-    key: "update",
-    value: function update(siteId, id, updateData) {
-      return new Promise(function (resolve, reject) {
-        _RequestHelper.default.patchRequest("/lab/sites/".concat(siteId, "/sample-failure-reasons/").concat(id), updateData).then(function (result) {
-          var resolveValue = function () {
-            return _SampleFailureReasonModel.default.fromJSON(result, siteId);
-          }();
-
-          resolve(resolveValue);
-        }).catch(function (error) {
-          return reject(error);
-        });
-      });
-    }
-    /**
-     * Delete a Sample Failure Reason [DELETE /lab/sites/{siteId}/sample-failure-reasons/{id}]
-     * 
-     * @static
-     * @public
-     * @param {number} siteId The Site ID
-     * @param {string} id The Sample Failure Reason ID
-     * @return {Promise<boolean>}
-     */
-
-  }, {
-    key: "delete",
-    value: function _delete(siteId, id) {
-      return new Promise(function (resolve, reject) {
-        _RequestHelper.default.deleteRequest("/lab/sites/".concat(siteId, "/sample-failure-reasons/").concat(id)).then(function (result) {
-          resolve(result !== null && result !== void 0 ? result : true);
-        }).catch(function (error) {
-          return reject(error);
-        });
-      });
-    }
-    /**
-     * List all Sample Failure Reasons [GET /lab/sites/{siteId}/sample-failure-reasons]
-     * 
-     * @static
-     * @public
-     * @param {number} siteId The Site ID
-     * @param {SampleFailureReasonController.GetAllQueryParameters} [queryParameters] The Optional Query Parameters
-     * @return {Promise<SampleFailureReasonModel[]>}
-     */
-
-  }, {
-    key: "getAll",
-    value: function getAll(siteId) {
-      var queryParameters = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-      return new Promise(function (resolve, reject) {
-        _RequestHelper.default.getRequest("/lab/sites/".concat(siteId, "/sample-failure-reasons"), queryParameters).then(function (result) {
-          var resolveValue = function () {
-            if (Array.isArray(result) !== true) {
-              return [];
-            }
-
-            return result.map(function (resultItem) {
-              return function () {
-                return _SampleFailureReasonModel.default.fromJSON(resultItem, siteId);
-              }();
-            });
-          }();
-
-          resolve(resolveValue);
-        }).catch(function (error) {
-          return reject(error);
-        });
-      });
-    }
-    /**
-     * Create a Sample Failure Reason [POST /lab/sites/{siteId}/sample-failure-reasons]
-     * 
-     * @static
-     * @public
-     * @param {number} siteId The Site ID
-     * @param {SampleFailureReasonController.CreateData} createData The Sample Failure Reason Create Data
-     * @return {Promise<SampleFailureReasonModel>}
-     */
-
-  }, {
-    key: "create",
-    value: function create(siteId, createData) {
-      return new Promise(function (resolve, reject) {
-        _RequestHelper.default.postRequest("/lab/sites/".concat(siteId, "/sample-failure-reasons"), createData).then(function (result) {
-          var resolveValue = function () {
-            return _SampleFailureReasonModel.default.fromJSON(result, siteId);
-          }();
-
-          resolve(resolveValue);
-        }).catch(function (error) {
-          return reject(error);
-        });
-      });
-    }
-  }]);
-
-  return SampleFailureReasonController;
-}();
-
-var _default = SampleFailureReasonController;
-/**
- * The Optional Query Parameters for the getAll Function
- * 
- * @typedef {Object} SampleFailureReasonController.GetAllQueryParameters
- * @property {string} [name] The Sample Failure Reason Name
- * @memberof Controllers.Lab.Site
- */
-
-/**
- * The Create Data for a Sample Failure Reason
- * 
- * @typedef {Object} SampleFailureReasonController.CreateData
- * @property {string} name The Sample Failure Reason Name
- * @property {string} description The Sample Failure Reason Description
- * @memberof Controllers.Lab.Site
- */
-
-/**
- * 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
- */
-
-exports.default = _default;