@ricado/api-client 2.1.0 → 2.1.1

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

@@ -187,7 +187,18 @@ var _default = RejectBinScaleController;
  * @property {?string} [packrunSourceId] The Permanent Object that provides the Next Packrun for this Reject Bin Scale
  * @property {?number} [packrunGroup] The Packrun Group this Reject Bin Scale is a part of
  * @property {Object[]} [sources] An Array of Sources that deliver Fruit to this Reject Bin Scale
- * @property {?number} [autoPackrunChange] The Auto Packrun Change Configuration for this Reject Bin Scale
+ * @property {?{delay: ?number}} [autoPackrunChange] The Auto Packrun Change Configuration for this Reject Bin Scale
+ * @property {?boolean} [supportsLiveWeighing] Whether this Reject Bin Scale supports Live Weighing
+ * @property {?number} [autoWeighingStartThreshold] The Minimum Weight Change Required to Automatically Start Live Weighing
+ * @property {?number} [autoWeighingStartDelay] The Delay in Milliseconds before Auto Live Weighing would Start
+ * @property {?number} [autoWeighingFinishThreshold] The Minimum Weight Change Required to Automatically Finish Live Weighing
+ * @property {?number} [autoWeighingFinishDelay] The Delay in Milliseconds before Auto Live Weighing would Finish
+ * @property {?number} [manualInterventionMaximumDuration] The Maximum Duration in Milliseconds before a Manual Intervention would end
+ * @property {?number} [liveWeighingIncreaseTolerance] The Maximum Weight Increase allowed within a single Live Weighing Update Interval
+ * @property {?number} [liveWeighingDecreaseTolerance] The Maximum Weight Decrease allowed within a single Live Weighing Update Interval
+ * @property {?number} [liveWeighingUpdateInterval] The Interval in Milliseconds between Live Weighing Updates
+ * @property {?boolean} [liveWeighingUsesStableStatus] Whether the Loadcell Stable Status is used to ignore Changes during Live Weighing
+ * @property {?number} [incorrectOperationTolerance] The Maximum Weight Change allowed while Live Weighing before an Incorrect Operation is Logged
  * @property {?Object} [freshPackIntegration] The FreshPack Integration Configuration for this Reject Bin Scale
  * @memberof Controllers.Packhouse.Site
  */
@@ -202,7 +213,18 @@ var _default = RejectBinScaleController;
  * @property {?string} [packrunSourceId] The Permanent Object that provides the Next Packrun for this Reject Bin Scale
  * @property {?number} [packrunGroup] The Packrun Group this Reject Bin Scale is a part of
  * @property {Object[]} [sources] An Array of Sources that deliver Fruit to this Reject Bin Scale
- * @property {?number} [autoPackrunChange] The Auto Packrun Change Configuration for this Reject Bin Scale
+ * @property {?{delay: ?number}} [autoPackrunChange] The Auto Packrun Change Configuration for this Reject Bin Scale
+ * @property {?boolean} [supportsLiveWeighing] Whether this Reject Bin Scale supports Live Weighing
+ * @property {?number} [autoWeighingStartThreshold] The Minimum Weight Change Required to Automatically Start Live Weighing
+ * @property {?number} [autoWeighingStartDelay] The Delay in Milliseconds before Auto Live Weighing would Start
+ * @property {?number} [autoWeighingFinishThreshold] The Minimum Weight Change Required to Automatically Finish Live Weighing
+ * @property {?number} [autoWeighingFinishDelay] The Delay in Milliseconds before Auto Live Weighing would Finish
+ * @property {?number} [manualInterventionMaximumDuration] The Maximum Duration in Milliseconds before a Manual Intervention would end
+ * @property {?number} [liveWeighingIncreaseTolerance] The Maximum Weight Increase allowed within a single Live Weighing Update Interval
+ * @property {?number} [liveWeighingDecreaseTolerance] The Maximum Weight Decrease allowed within a single Live Weighing Update Interval
+ * @property {?number} [liveWeighingUpdateInterval] The Interval in Milliseconds between Live Weighing Updates
+ * @property {?boolean} [liveWeighingUsesStableStatus] Whether the Loadcell Stable Status is used to ignore Changes during Live Weighing
+ * @property {?number} [incorrectOperationTolerance] The Maximum Weight Change allowed while Live Weighing before an Incorrect Operation is Logged
  * @property {?Object} [freshPackIntegration] The FreshPack Integration Configuration for this Reject Bin Scale
  * @memberof Controllers.Packhouse.Site
  */

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

@@ -0,0 +1,453 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _RequestHelper = _interopRequireDefault(require("../../../RequestHelper"));
+
+var _SoftSortBeltModel = _interopRequireDefault(require("../../../Models/Packhouse/Site/SoftSortBeltModel"));
+
+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; }
+
+/**
+ * Controller Class for Soft Sort Belts
+ * 
+ * @class
+ */
+var SoftSortBeltController = /*#__PURE__*/function () {
+  function SoftSortBeltController() {
+    _classCallCheck(this, SoftSortBeltController);
+  }
+
+  _createClass(SoftSortBeltController, null, [{
+    key: "getOne",
+    value:
+    /**
+     * Retrieve a Soft Sort Belt [GET /packhouse/sites/{siteId}/soft-sort-belts/{id}]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Soft Sort Belt ID
+     * @return {Promise<SoftSortBeltModel>}
+     */
+    function getOne(siteId, id) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.getRequest("/packhouse/sites/".concat(siteId, "/soft-sort-belts/").concat(id)).then(function (result) {
+          var resolveValue = function () {
+            return _SoftSortBeltModel.default.fromJSON(result, siteId);
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+    /**
+     * Update a Soft Sort Belt [PATCH /packhouse/sites/{siteId}/soft-sort-belts/{id}]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Soft Sort Belt ID
+     * @param {SoftSortBeltController.UpdateData} updateData The Soft Sort Belt Update Data
+     * @return {Promise<SoftSortBeltModel>}
+     */
+
+  }, {
+    key: "update",
+    value: function update(siteId, id, updateData) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.patchRequest("/packhouse/sites/".concat(siteId, "/soft-sort-belts/").concat(id), updateData).then(function (result) {
+          var resolveValue = function () {
+            return _SoftSortBeltModel.default.fromJSON(result, siteId);
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+    /**
+     * Delete a Soft Sort Belt [DELETE /packhouse/sites/{siteId}/soft-sort-belts/{id}]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Soft Sort Belt ID
+     * @return {Promise<boolean>}
+     */
+
+  }, {
+    key: "delete",
+    value: function _delete(siteId, id) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.deleteRequest("/packhouse/sites/".concat(siteId, "/soft-sort-belts/").concat(id)).then(function (result) {
+          resolve(result !== null && result !== void 0 ? result : true);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+    /**
+     * Retrieve the Events of a Soft Sort Belt [GET /packhouse/sites/{siteId}/soft-sort-belts/{id}/events]
+     * 
+     * Retrieves Events for a Single Soft Sort Belt
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Soft Sort Belt ID
+     * @param {SoftSortBeltController.GetOneEventsQueryParameters} [queryParameters] The Optional Query Parameters
+     * @return {Promise<Array<SoftSortBeltController.SoftSortEventItem>>}
+     */
+
+  }, {
+    key: "getOneEvents",
+    value: function getOneEvents(siteId, id) {
+      var queryParameters = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.getRequest("/packhouse/sites/".concat(siteId, "/soft-sort-belts/").concat(id, "/events"), queryParameters).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' && 'beltId' in resultItem) {
+                  resultItemObject.beltId = function () {
+                    if (typeof resultItem.beltId !== 'string') {
+                      return String(resultItem.beltId);
+                    }
+
+                    return resultItem.beltId;
+                  }();
+                } else {
+                  resultItemObject.beltId = "";
+                }
+
+                if (_typeof(resultItem) === 'object' && 'packrunId' in resultItem) {
+                  resultItemObject.packrunId = function () {
+                    if (typeof resultItem.packrunId !== 'string') {
+                      return String(resultItem.packrunId);
+                    }
+
+                    return resultItem.packrunId;
+                  }();
+                } else {
+                  resultItemObject.packrunId = "";
+                }
+
+                if (_typeof(resultItem) === 'object' && 'packrunName' in resultItem) {
+                  resultItemObject.packrunName = function () {
+                    if (typeof resultItem.packrunName !== 'string') {
+                      return String(resultItem.packrunName);
+                    }
+
+                    return resultItem.packrunName;
+                  }();
+                } else {
+                  resultItemObject.packrunName = "";
+                }
+
+                if (_typeof(resultItem) === 'object' && 'startTimestamp' in resultItem) {
+                  resultItemObject.startTimestamp = function () {
+                    if (typeof resultItem.startTimestamp !== 'string') {
+                      return new Date(String(resultItem.startTimestamp));
+                    }
+
+                    return new Date(resultItem.startTimestamp);
+                  }();
+                } else {
+                  resultItemObject.startTimestamp = new Date();
+                }
+
+                if (_typeof(resultItem) === 'object' && 'endTimestamp' in resultItem) {
+                  resultItemObject.endTimestamp = function () {
+                    if (typeof resultItem.endTimestamp !== 'string') {
+                      return new Date(String(resultItem.endTimestamp));
+                    }
+
+                    return new Date(resultItem.endTimestamp);
+                  }();
+                } else {
+                  resultItemObject.endTimestamp = new Date();
+                }
+
+                if (_typeof(resultItem) === 'object' && 'duration' in resultItem) {
+                  resultItemObject.duration = function () {
+                    if (typeof resultItem.duration !== 'number') {
+                      return Number.isInteger(Number(resultItem.duration)) ? Number(resultItem.duration) : Math.floor(Number(resultItem.duration));
+                    }
+
+                    return Number.isInteger(resultItem.duration) ? resultItem.duration : Math.floor(resultItem.duration);
+                  }();
+                } else {
+                  resultItemObject.duration = 0;
+                }
+
+                return resultItemObject;
+              }();
+            });
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+    /**
+     * List all Soft Sort Belts [GET /packhouse/sites/{siteId}/soft-sort-belts]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {SoftSortBeltController.GetAllQueryParameters} [queryParameters] The Optional Query Parameters
+     * @return {Promise<SoftSortBeltModel[]>}
+     */
+
+  }, {
+    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("/packhouse/sites/".concat(siteId, "/soft-sort-belts"), queryParameters).then(function (result) {
+          var resolveValue = function () {
+            if (Array.isArray(result) !== true) {
+              return [];
+            }
+
+            return result.map(function (resultItem) {
+              return function () {
+                return _SoftSortBeltModel.default.fromJSON(resultItem, siteId);
+              }();
+            });
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+    /**
+     * Create a Soft Sort Belt [POST /packhouse/sites/{siteId}/soft-sort-belts]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {SoftSortBeltController.CreateData} createData The Soft Sort Belt Create Data
+     * @return {Promise<SoftSortBeltModel>}
+     */
+
+  }, {
+    key: "create",
+    value: function create(siteId, createData) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.postRequest("/packhouse/sites/".concat(siteId, "/soft-sort-belts"), createData).then(function (result) {
+          var resolveValue = function () {
+            return _SoftSortBeltModel.default.fromJSON(result, siteId);
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+    /**
+     * Retrieve the Events of all Soft Sort Belts [GET /packhouse/sites/{siteId}/soft-sort-belts/events]
+     * 
+     * Retrieves Events for all Soft Sort Belts
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {SoftSortBeltController.GetAllEventsQueryParameters} [queryParameters] The Optional Query Parameters
+     * @return {Promise<Array<SoftSortBeltController.SoftSortEventItem>>}
+     */
+
+  }, {
+    key: "getAllEvents",
+    value: function getAllEvents(siteId) {
+      var queryParameters = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.getRequest("/packhouse/sites/".concat(siteId, "/soft-sort-belts/events"), queryParameters).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' && 'beltId' in resultItem) {
+                  resultItemObject.beltId = function () {
+                    if (typeof resultItem.beltId !== 'string') {
+                      return String(resultItem.beltId);
+                    }
+
+                    return resultItem.beltId;
+                  }();
+                } else {
+                  resultItemObject.beltId = "";
+                }
+
+                if (_typeof(resultItem) === 'object' && 'packrunId' in resultItem) {
+                  resultItemObject.packrunId = function () {
+                    if (typeof resultItem.packrunId !== 'string') {
+                      return String(resultItem.packrunId);
+                    }
+
+                    return resultItem.packrunId;
+                  }();
+                } else {
+                  resultItemObject.packrunId = "";
+                }
+
+                if (_typeof(resultItem) === 'object' && 'packrunName' in resultItem) {
+                  resultItemObject.packrunName = function () {
+                    if (typeof resultItem.packrunName !== 'string') {
+                      return String(resultItem.packrunName);
+                    }
+
+                    return resultItem.packrunName;
+                  }();
+                } else {
+                  resultItemObject.packrunName = "";
+                }
+
+                if (_typeof(resultItem) === 'object' && 'startTimestamp' in resultItem) {
+                  resultItemObject.startTimestamp = function () {
+                    if (typeof resultItem.startTimestamp !== 'string') {
+                      return new Date(String(resultItem.startTimestamp));
+                    }
+
+                    return new Date(resultItem.startTimestamp);
+                  }();
+                } else {
+                  resultItemObject.startTimestamp = new Date();
+                }
+
+                if (_typeof(resultItem) === 'object' && 'endTimestamp' in resultItem) {
+                  resultItemObject.endTimestamp = function () {
+                    if (typeof resultItem.endTimestamp !== 'string') {
+                      return new Date(String(resultItem.endTimestamp));
+                    }
+
+                    return new Date(resultItem.endTimestamp);
+                  }();
+                } else {
+                  resultItemObject.endTimestamp = new Date();
+                }
+
+                if (_typeof(resultItem) === 'object' && 'duration' in resultItem) {
+                  resultItemObject.duration = function () {
+                    if (typeof resultItem.duration !== 'number') {
+                      return Number.isInteger(Number(resultItem.duration)) ? Number(resultItem.duration) : Math.floor(Number(resultItem.duration));
+                    }
+
+                    return Number.isInteger(resultItem.duration) ? resultItem.duration : Math.floor(resultItem.duration);
+                  }();
+                } else {
+                  resultItemObject.duration = 0;
+                }
+
+                return resultItemObject;
+              }();
+            });
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+  }]);
+
+  return SoftSortBeltController;
+}();
+
+var _default = SoftSortBeltController;
+/**
+ * The Optional Query Parameters for the getOneEvents Function
+ * 
+ * @typedef {Object} SoftSortBeltController.GetOneEventsQueryParameters
+ * @property {Date} [timestampBegin] The Beginning Timestamp of the Soft-Sort Event Results. Defaults to 24 Hours ago
+ * @property {Date} [timestampEnd] The End Timestamp of the Soft-Sort Event Results. Defaults to Now
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * The Optional Query Parameters for the getAll Function
+ * 
+ * @typedef {Object} SoftSortBeltController.GetAllQueryParameters
+ * @property {?number} [rtuId] The RTU this Soft Sort Belt belongs to
+ * @property {string} [name] The Name of this Soft Sort Belt
+ * @property {string} [packingLineId] The Packing Line that owns this Soft Sort Belt
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * The Optional Query Parameters for the getAllEvents Function
+ * 
+ * @typedef {Object} SoftSortBeltController.GetAllEventsQueryParameters
+ * @property {string[]} [beltIds] A List of Soft-Sort Belt IDs to Filter by
+ * @property {Date} [timestampBegin] The Beginning Timestamp of the Soft-Sort Event Results. Defaults to 24 Hours ago
+ * @property {Date} [timestampEnd] The End Timestamp of the Soft-Sort Event Results. Defaults to Now
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * The Create Data for a Soft Sort Belt
+ * 
+ * @typedef {Object} SoftSortBeltController.CreateData
+ * @property {?number} [rtuId] The RTU this Soft Sort Belt belongs to
+ * @property {string} name The Name of this Soft Sort Belt
+ * @property {Object} points The Points used by this Soft Sort Belt
+ * @property {string} packingLineId The Packing Line that owns this Soft Sort Belt
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * The Update Data for a Soft Sort Belt
+ * 
+ * @typedef {Object} SoftSortBeltController.UpdateData
+ * @property {string} [name] The Name of this Soft Sort Belt
+ * @property {Object} [points] The Points used by this Soft Sort Belt
+ * @property {string} [packingLineId] The Packing Line that owns this Soft Sort Belt
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **SoftSortEventItem** Type
+ * 
+ * @typedef {Object} SoftSortBeltController.SoftSortEventItem
+ * @property {string} beltId The Soft-Sort Belt ID
+ * @property {string} packrunId The ID of the associated Packrun
+ * @property {string} packrunName The Name of the associated Packrun
+ * @property {Date} startTimestamp When the Event Started
+ * @property {Date} endTimestamp When the Event Ended
+ * @property {number} duration The Duration in Seconds of the Event
+ * @memberof Controllers.Packhouse.Site
+ */
+
+exports.default = _default;

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

@@ -43,6 +43,8 @@ var _ShiftFocusMeetingController = _interopRequireDefault(require("./ShiftFocusM
 
 var _ShiftHourlyEntryController = _interopRequireDefault(require("./ShiftHourlyEntryController"));
 
+var _SoftSortBeltController = _interopRequireDefault(require("./SoftSortBeltController"));
+
 var _VarietyController = _interopRequireDefault(require("./VarietyController"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
@@ -76,6 +78,7 @@ var Site = {
   ShiftController: _ShiftController.default,
   ShiftFocusMeetingController: _ShiftFocusMeetingController.default,
   ShiftHourlyEntryController: _ShiftHourlyEntryController.default,
+  SoftSortBeltController: _SoftSortBeltController.default,
   VarietyController: _VarietyController.default
 };
 var _default = Site;