@ricado/api-client 2.3.28 → 2.4.1

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

@@ -0,0 +1,46 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _DehydratorController = _interopRequireDefault(require("./DehydratorController"));
+
+var _FruitProfileController = _interopRequireDefault(require("./FruitProfileController"));
+
+var _LabController = _interopRequireDefault(require("./LabController"));
+
+var _RackController = _interopRequireDefault(require("./RackController"));
+
+var _RackPositionController = _interopRequireDefault(require("./RackPositionController"));
+
+var _SampleController = _interopRequireDefault(require("./SampleController"));
+
+var _SampleFailureReasonController = _interopRequireDefault(require("./SampleFailureReasonController"));
+
+var _SampleResultController = _interopRequireDefault(require("./SampleResultController"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/**
+ * File Auto-Generated by the RICADO Gen 4 PHP API Project
+ * 
+ * Do Not Edit this File Manually!
+ */
+
+/**
+ * @namespace Controllers.Lab.Site
+ */
+var Site = {
+  DehydratorController: _DehydratorController.default,
+  FruitProfileController: _FruitProfileController.default,
+  LabController: _LabController.default,
+  RackController: _RackController.default,
+  RackPositionController: _RackPositionController.default,
+  SampleController: _SampleController.default,
+  SampleFailureReasonController: _SampleFailureReasonController.default,
+  SampleResultController: _SampleResultController.default
+};
+var _default = Site;
+exports.default = _default;

package/lib/Controllers/Lab/index.js

@@ -0,0 +1,25 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _index = _interopRequireDefault(require("./Site/index"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/**
+ * File Auto-Generated by the RICADO Gen 4 PHP API Project
+ * 
+ * Do Not Edit this File Manually!
+ */
+
+/**
+ * @namespace Controllers.Lab
+ */
+var Lab = {
+  Site: _index.default
+};
+var _default = Lab;
+exports.default = _default;

package/lib/Controllers/Packhouse/Site/ShiftController.js

@@ -776,6 +776,274 @@ var ShiftController = /*#__PURE__*/function () {
         });
       });
     }
+    /**
+     * Retrieve a Shift's Score History [GET /packhouse/sites/{siteId}/shifts/{id}/scoreHistory]
+     * 
+     * Retrieves the Score History for a Shift
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Shift ID
+     * @return {Promise<Array<ShiftController.ScoreHistoryItem>>}
+     */
+
+  }, {
+    key: "getScoreHistory",
+    value: function getScoreHistory(siteId, id) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.getRequest("/packhouse/sites/".concat(siteId, "/shifts/").concat(id, "/scoreHistory")).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' && 'score' in resultItem) {
+                  resultItemObject.score = function () {
+                    if (typeof resultItem.score !== 'number') {
+                      return Number(resultItem.score);
+                    }
+
+                    return resultItem.score;
+                  }();
+                } else {
+                  resultItemObject.score = 0;
+                }
+
+                return resultItemObject;
+              }();
+            });
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+    /**
+     * Retrieve a Shift Score Metrics [GET /packhouse/sites/{siteId}/shifts/{id}/scoreMetrics]
+     * 
+     * Retrieves the Score Metrics for a Shift
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Shift ID
+     * @return {Promise<ShiftController.ShiftScoreMetrics>}
+     */
+
+  }, {
+    key: "getScoreMetrics",
+    value: function getScoreMetrics(siteId, id) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.getRequest("/packhouse/sites/".concat(siteId, "/shifts/").concat(id, "/scoreMetrics")).then(function (result) {
+          var resolveValue = function () {
+            var resultObject = {};
+
+            if (_typeof(result) === 'object' && 'scoreActual' in result) {
+              resultObject.scoreActual = function () {
+                if (typeof result.scoreActual !== 'number') {
+                  return Number(result.scoreActual);
+                }
+
+                return result.scoreActual;
+              }();
+            } else {
+              resultObject.scoreActual = 0;
+            }
+
+            if (_typeof(result) === 'object' && 'traysPerHourActual' in result) {
+              resultObject.traysPerHourActual = function () {
+                if (typeof result.traysPerHourActual !== 'number') {
+                  return Number.isInteger(Number(result.traysPerHourActual)) ? Number(result.traysPerHourActual) : Math.floor(Number(result.traysPerHourActual));
+                }
+
+                return Number.isInteger(result.traysPerHourActual) ? result.traysPerHourActual : Math.floor(result.traysPerHourActual);
+              }();
+            } else {
+              resultObject.traysPerHourActual = 0;
+            }
+
+            if (_typeof(result) === 'object' && 'traysPerHourTarget' in result) {
+              resultObject.traysPerHourTarget = function () {
+                if (result.traysPerHourTarget === null) {
+                  return null;
+                }
+
+                if (typeof result.traysPerHourTarget !== 'number') {
+                  return Number.isInteger(Number(result.traysPerHourTarget)) ? Number(result.traysPerHourTarget) : Math.floor(Number(result.traysPerHourTarget));
+                }
+
+                return Number.isInteger(result.traysPerHourTarget) ? result.traysPerHourTarget : Math.floor(result.traysPerHourTarget);
+              }();
+            } else {
+              resultObject.traysPerHourTarget = null;
+            }
+
+            if (_typeof(result) === 'object' && 'costPerTrayActual' in result) {
+              resultObject.costPerTrayActual = function () {
+                if (typeof result.costPerTrayActual !== 'number') {
+                  return Number(result.costPerTrayActual);
+                }
+
+                return result.costPerTrayActual;
+              }();
+            } else {
+              resultObject.costPerTrayActual = 0;
+            }
+
+            if (_typeof(result) === 'object' && 'costPerTrayTarget' in result) {
+              resultObject.costPerTrayTarget = function () {
+                if (result.costPerTrayTarget === null) {
+                  return null;
+                }
+
+                if (typeof result.costPerTrayTarget !== 'number') {
+                  return Number(result.costPerTrayTarget);
+                }
+
+                return result.costPerTrayTarget;
+              }();
+            } else {
+              resultObject.costPerTrayTarget = null;
+            }
+
+            if (_typeof(result) === 'object' && 'qualityR600IdealActual' in result) {
+              resultObject.qualityR600IdealActual = function () {
+                if (typeof result.qualityR600IdealActual !== 'number') {
+                  return Number(result.qualityR600IdealActual);
+                }
+
+                return result.qualityR600IdealActual;
+              }();
+            } else {
+              resultObject.qualityR600IdealActual = 0;
+            }
+
+            if (_typeof(result) === 'object' && 'qualityR600IdealTarget' in result) {
+              resultObject.qualityR600IdealTarget = function () {
+                if (result.qualityR600IdealTarget === null) {
+                  return null;
+                }
+
+                if (typeof result.qualityR600IdealTarget !== 'number') {
+                  return Number(result.qualityR600IdealTarget);
+                }
+
+                return result.qualityR600IdealTarget;
+              }();
+            } else {
+              resultObject.qualityR600IdealTarget = null;
+            }
+
+            if (_typeof(result) === 'object' && 'customQualityMetrics' in result) {
+              resultObject.customQualityMetrics = function () {
+                if (Array.isArray(result.customQualityMetrics) !== true) {
+                  return [];
+                }
+
+                return result.customQualityMetrics.map(function (customQualityMetricsItem) {
+                  return function () {
+                    var customQualityMetricsItemObject = {};
+
+                    if (_typeof(customQualityMetricsItem) === 'object' && 'id' in customQualityMetricsItem) {
+                      customQualityMetricsItemObject.id = function () {
+                        if (typeof customQualityMetricsItem.id !== 'string') {
+                          return String(customQualityMetricsItem.id);
+                        }
+
+                        return customQualityMetricsItem.id;
+                      }();
+                    } else {
+                      customQualityMetricsItemObject.id = "";
+                    }
+
+                    if (_typeof(customQualityMetricsItem) === 'object' && 'name' in customQualityMetricsItem) {
+                      customQualityMetricsItemObject.name = function () {
+                        if (typeof customQualityMetricsItem.name !== 'string') {
+                          return String(customQualityMetricsItem.name);
+                        }
+
+                        return customQualityMetricsItem.name;
+                      }();
+                    } else {
+                      customQualityMetricsItemObject.name = "";
+                    }
+
+                    if (_typeof(customQualityMetricsItem) === 'object' && 'type' in customQualityMetricsItem) {
+                      customQualityMetricsItemObject.type = function () {
+                        if (typeof customQualityMetricsItem.type !== 'string') {
+                          return String(customQualityMetricsItem.type);
+                        }
+
+                        return customQualityMetricsItem.type;
+                      }();
+                    } else {
+                      customQualityMetricsItemObject.type = "";
+                    }
+
+                    if (_typeof(customQualityMetricsItem) === 'object' && 'value' in customQualityMetricsItem) {
+                      customQualityMetricsItemObject.value = function () {
+                        if (typeof customQualityMetricsItem.value !== 'number') {
+                          return Number(customQualityMetricsItem.value);
+                        }
+
+                        return customQualityMetricsItem.value;
+                      }();
+                    } else {
+                      customQualityMetricsItemObject.value = 0;
+                    }
+
+                    if (_typeof(customQualityMetricsItem) === 'object' && 'target' in customQualityMetricsItem) {
+                      customQualityMetricsItemObject.target = function () {
+                        if (customQualityMetricsItem.target === null) {
+                          return null;
+                        }
+
+                        if (typeof customQualityMetricsItem.target !== 'number') {
+                          return Number(customQualityMetricsItem.target);
+                        }
+
+                        return customQualityMetricsItem.target;
+                      }();
+                    } else {
+                      customQualityMetricsItemObject.target = null;
+                    }
+
+                    return customQualityMetricsItemObject;
+                  }();
+                });
+              }();
+            } else {
+              resultObject.customQualityMetrics = [];
+            }
+
+            return resultObject;
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
     /**
      * List all Shifts [GET /packhouse/sites/{siteId}/shifts]
      * 
@@ -929,6 +1197,42 @@ var _default = ShiftController;
  * @memberof Controllers.Packhouse.Site
  */
 
+/**
+ * A **ScoreHistoryItem** Type
+ * 
+ * @typedef {Object} ShiftController.ScoreHistoryItem
+ * @property {Date} timestamp The Timestamp for the Score Percentage Value
+ * @property {number} score The Score Value as a Percentage
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **CustomQualityMetricItem** Type
+ * 
+ * @typedef {Object} ShiftController.CustomQualityMetricItem
+ * @property {string} id The ID of this Custom Quality Metric Item
+ * @property {string} name The Name of this Custom Quality Metric Item
+ * @property {string} type The Display Type for this Custom Quality Metric Item
+ * @property {number} value The Actual Value for this Custom Quality Metric Item
+ * @property {?number} target The Target Value for this Custom Quality Metric Item
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **ShiftScoreMetrics** Type
+ * 
+ * @typedef {Object} ShiftController.ShiftScoreMetrics
+ * @property {number} scoreActual The Actual Score represented as a Percentage
+ * @property {number} traysPerHourActual The Actual Tray Equivalents per Hour
+ * @property {?number} traysPerHourTarget The Target Tray Equivalents per Hour
+ * @property {number} costPerTrayActual The Actual Cost per Tray Equivalent represented in cents
+ * @property {?number} costPerTrayTarget The Target Cost per Tray Equivalent represented in cents
+ * @property {number} qualityR600IdealActual The Actual Quality R600 Ideal Samples represented as a Percentage
+ * @property {?number} qualityR600IdealTarget The Target Quality R600 Ideal Samples represented as a Percentage
+ * @property {Array<ShiftController.CustomQualityMetricItem>} customQualityMetrics An Array of Custom Quality Metric Items for the Shift
+ * @memberof Controllers.Packhouse.Site
+ */
+
 /**
  * A **ShiftHandoverNote** Type
  * 

package/lib/Controllers/index.js

@@ -27,11 +27,13 @@ var _UserAccountActionTokenController = _interopRequireDefault(require("./UserAc
 
 var _UserAccountController = _interopRequireDefault(require("./UserAccountController"));
 
-var _index = _interopRequireDefault(require("./Packhouse/index"));
+var _index = _interopRequireDefault(require("./Lab/index"));
 
-var _index2 = _interopRequireDefault(require("./RTU/index"));
+var _index2 = _interopRequireDefault(require("./Packhouse/index"));
 
-var _index3 = _interopRequireDefault(require("./Site/index"));
+var _index3 = _interopRequireDefault(require("./RTU/index"));
+
+var _index4 = _interopRequireDefault(require("./Site/index"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
@@ -56,9 +58,10 @@ var Controllers = {
   ToolsController: _ToolsController.default,
   UserAccountActionTokenController: _UserAccountActionTokenController.default,
   UserAccountController: _UserAccountController.default,
-  Packhouse: _index.default,
-  RTU: _index2.default,
-  Site: _index3.default
+  Lab: _index.default,
+  Packhouse: _index2.default,
+  RTU: _index3.default,
+  Site: _index4.default
 };
 var _default = Controllers;
 exports.default = _default;

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

@@ -0,0 +1,250 @@
+"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 Dehydrator
+ * 
+ * @class
+ * @hideconstructor
+ * @extends BaseModel
+ */
+var DehydratorModel = /*#__PURE__*/function (_BaseModel) {
+  _inherits(DehydratorModel, _BaseModel);
+
+  var _super = _createSuper(DehydratorModel);
+
+  /**
+   * DehydratorModel Constructor
+   * 
+   * @protected
+   * @param {number} siteId The Site ID associated with this Dehydrator
+   */
+  function DehydratorModel(siteId) {
+    var _this;
+
+    _classCallCheck(this, DehydratorModel);
+
+    _this = _super.call(this);
+    /**
+     * The Dehydrator ID
+     * 
+     * @type {string}
+     * @public
+     */
+
+    _this.id = "";
+    /**
+     * The RTU this Dehydrator belongs to
+     * 
+     * @type {?number}
+     * @public
+     */
+
+    _this.rtuId = null;
+    /**
+     * The Name of this Dehydrator
+     * 
+     * @type {string}
+     * @public
+     */
+
+    _this.name = "";
+    /**
+     * The Points used by this Dehydrator
+     * 
+     * @type {{rackPositionId: number}}
+     * @public
+     */
+
+    _this.points = function () {
+      var pointsDefaultValue = {};
+      pointsDefaultValue.rackPositionId = 0;
+      return pointsDefaultValue;
+    }();
+    /**
+     * The Lab that owns this Dehydrator
+     * 
+     * @type {string}
+     * @public
+     */
+
+
+    _this.labId = "";
+    /**
+     * Whether the Dehydrator has been deleted
+     * 
+     * @type {boolean}
+     * @public
+     */
+
+    _this.deleted = false;
+    /**
+     * When the Dehydrator was last updated
+     * 
+     * @type {Date}
+     * @public
+     */
+
+    _this.updateTimestamp = new Date();
+    /**
+     * The Site ID associated with this Dehydrator
+     * 
+     * @type {number}
+     * @public
+     */
+
+    _this.siteId = siteId;
+    return _this;
+  }
+  /**
+   * Create a new **DehydratorModel** 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 Dehydrator
+   * @return {DehydratorModel}
+   */
+
+
+  _createClass(DehydratorModel, null, [{
+    key: "fromJSON",
+    value: function fromJSON(json, siteId) {
+      var model = new DehydratorModel(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 ('rtuId' in jsonObject) {
+        model.rtuId = function () {
+          if (jsonObject['rtuId'] === null) {
+            return null;
+          }
+
+          if (typeof jsonObject['rtuId'] !== 'number') {
+            return Number.isInteger(Number(jsonObject['rtuId'])) ? Number(jsonObject['rtuId']) : Math.floor(Number(jsonObject['rtuId']));
+          }
+
+          return Number.isInteger(jsonObject['rtuId']) ? jsonObject['rtuId'] : Math.floor(jsonObject['rtuId']);
+        }();
+      }
+
+      if ('name' in jsonObject) {
+        model.name = function () {
+          if (typeof jsonObject['name'] !== 'string') {
+            return String(jsonObject['name']);
+          }
+
+          return jsonObject['name'];
+        }();
+      }
+
+      if ('points' in jsonObject) {
+        model.points = function () {
+          var pointsObject = {};
+
+          if (_typeof(jsonObject['points']) === 'object' && 'rackPositionId' in jsonObject['points']) {
+            pointsObject.rackPositionId = function () {
+              if (typeof jsonObject['points'].rackPositionId !== 'number') {
+                return Number.isInteger(Number(jsonObject['points'].rackPositionId)) ? Number(jsonObject['points'].rackPositionId) : Math.floor(Number(jsonObject['points'].rackPositionId));
+              }
+
+              return Number.isInteger(jsonObject['points'].rackPositionId) ? jsonObject['points'].rackPositionId : Math.floor(jsonObject['points'].rackPositionId);
+            }();
+          } else {
+            pointsObject.rackPositionId = 0;
+          }
+
+          return pointsObject;
+        }();
+      }
+
+      if ('labId' in jsonObject) {
+        model.labId = function () {
+          if (typeof jsonObject['labId'] !== 'string') {
+            return String(jsonObject['labId']);
+          }
+
+          return jsonObject['labId'];
+        }();
+      }
+
+      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 DehydratorModel;
+}(_BaseModel2.default);
+
+var _default = DehydratorModel;
+exports.default = _default;