@ricado/api-client 2.4.0 → 2.4.2

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

@@ -32,58 +32,48 @@ var SampleController = /*#__PURE__*/function () {
   }
 
   _createClass(SampleController, null, [{
-    key: "getTemperatureData",
+    key: "getOne",
     value:
     /**
-     * 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>}
      */
-    function getTemperatureData(siteId, id) {
+    function getOne(siteId, id) {
       return new Promise(function (resolve, reject) {
         _RequestHelper.default.getRequest("/lab/sites/".concat(siteId, "/samples/").concat(id)).then(function (result) {
           var resolveValue = function () {
-            if (Array.isArray(result) !== true) {
-              return [];
-            }
-
-            return result.map(function (resultItem) {
-              return function () {
-                var 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 _SampleModel.default.fromJSON(result, siteId);
+          }();
 
-                    return resultItem.temperature;
-                  }();
-                } else {
-                  resultItemObject.temperature = 0;
-                }
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return 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>}
+     */
 
-                return resultItemObject;
-              }();
-            });
+  }, {
+    key: "update",
+    value: function update(siteId, id, updateData) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.patchRequest("/lab/sites/".concat(siteId, "/samples/").concat(id), updateData).then(function (result) {
+          var resolveValue = function () {
+            return _SampleModel.default.fromJSON(result, siteId);
           }();
 
           resolve(resolveValue);
@@ -92,6 +82,27 @@ var SampleController = /*#__PURE__*/function () {
         });
       });
     }
+    /**
+     * 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>}
+     */
+
+  }, {
+    key: "delete",
+    value: function _delete(siteId, id) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.deleteRequest("/lab/sites/".concat(siteId, "/samples/").concat(id)).then(function (result) {
+          resolve(result !== null && result !== void 0 ? result : true);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
     /**
      * Retrieve Comments [GET /lab/sites/{siteId}/samples/{id}/comments]
      * 
@@ -771,6 +782,67 @@ var SampleController = /*#__PURE__*/function () {
         });
       });
     }
+    /**
+     * 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>>}
+     */
+
+  }, {
+    key: "getTemperatureData",
+    value: function getTemperatureData(siteId, id) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.getRequest("/lab/sites/".concat(siteId, "/samples/").concat(id, "/temperature-data")).then(function (result) {
+          var resolveValue = function () {
+            if (Array.isArray(result) !== true) {
+              return [];
+            }
+
+            return result.map(function (resultItem) {
+              return function () {
+                var 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(function (error) {
+          return reject(error);
+        });
+      });
+    }
     /**
      * List all Samples [GET /lab/sites/{siteId}/samples]
      * 
@@ -843,8 +915,8 @@ var _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
@@ -857,10 +929,14 @@ var _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
@@ -876,11 +952,13 @@ var _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
@@ -894,11 +972,28 @@ var _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
  */
 
@@ -924,4 +1019,13 @@ var _default = SampleController;
  * @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
+ */
+
 exports.default = _default;

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

@@ -176,7 +176,7 @@ var _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
  */
@@ -185,6 +185,7 @@ var _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/lib/Controllers/Lab/Site/index.js

@@ -11,6 +11,8 @@ var _FruitProfileController = _interopRequireDefault(require("./FruitProfileCont
 
 var _LabController = _interopRequireDefault(require("./LabController"));
 
+var _ProbeCalibrationController = _interopRequireDefault(require("./ProbeCalibrationController"));
+
 var _RackController = _interopRequireDefault(require("./RackController"));
 
 var _RackPositionController = _interopRequireDefault(require("./RackPositionController"));
@@ -36,6 +38,7 @@ var Site = {
   DehydratorController: _DehydratorController.default,
   FruitProfileController: _FruitProfileController.default,
   LabController: _LabController.default,
+  ProbeCalibrationController: _ProbeCalibrationController.default,
   RackController: _RackController.default,
   RackPositionController: _RackPositionController.default,
   SampleController: _SampleController.default,

package/lib/Models/Lab/Site/ProbeCalibrationModel.js

@@ -0,0 +1,303 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _BaseModel2 = _interopRequireDefault(require("../../../Models/BaseModel"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(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; }
+
+function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); Object.defineProperty(subClass, "prototype", { writable: false }); if (superClass) _setPrototypeOf(subClass, superClass); }
+
+function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }
+
+function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }
+
+function _possibleConstructorReturn(self, call) { if (call && (_typeof(call) === "object" || typeof call === "function")) { return call; } else if (call !== void 0) { throw new TypeError("Derived constructors may only return object or undefined"); } return _assertThisInitialized(self); }
+
+function _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return self; }
+
+function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
+
+function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }
+
+/**
+ * Model Class for a Probe Calibration
+ * 
+ * @class
+ * @hideconstructor
+ * @extends BaseModel
+ */
+var ProbeCalibrationModel = /*#__PURE__*/function (_BaseModel) {
+  _inherits(ProbeCalibrationModel, _BaseModel);
+
+  var _super = _createSuper(ProbeCalibrationModel);
+
+  /**
+   * ProbeCalibrationModel Constructor
+   * 
+   * @protected
+   * @param {number} siteId The Site ID associated with this Probe Calibration
+   */
+  function ProbeCalibrationModel(siteId) {
+    var _this;
+
+    _classCallCheck(this, ProbeCalibrationModel);
+
+    _this = _super.call(this);
+    /**
+     * 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;
+    return _this;
+  }
+  /**
+   * 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}
+   */
+
+
+  _createClass(ProbeCalibrationModel, null, [{
+    key: "fromJSON",
+    value: function fromJSON(json, siteId) {
+      var model = new ProbeCalibrationModel(siteId);
+      /**
+       * The JSON Object
+       * 
+       * @type {Object<string, any>}
+       */
+
+      var 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;
+    }
+  }]);
+
+  return ProbeCalibrationModel;
+}(_BaseModel2.default);
+
+var _default = ProbeCalibrationModel;
+exports.default = _default;