@ricado/api-client 2.6.1 → 2.7.1

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

@@ -0,0 +1,300 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _RequestHelper = _interopRequireDefault(require("../../../RequestHelper"));
+
+var _ReemoonSizerModel = _interopRequireDefault(require("../../../Models/Packhouse/Site/ReemoonSizerModel"));
+
+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 Reemoon Sizers
+ * 
+ * @class
+ */
+var ReemoonSizerController = /*#__PURE__*/function () {
+  function ReemoonSizerController() {
+    _classCallCheck(this, ReemoonSizerController);
+  }
+
+  _createClass(ReemoonSizerController, null, [{
+    key: "getOne",
+    value:
+    /**
+     * Retrieve a Reemoon Sizer [GET /packhouse/sites/{siteId}/reemoon-sizers/{id}]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Reemoon Sizer ID
+     * @return {Promise<ReemoonSizerModel>}
+     */
+    function getOne(siteId, id) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.getRequest("/packhouse/sites/".concat(siteId, "/reemoon-sizers/").concat(id)).then(function (result) {
+          var resolveValue = function () {
+            return _ReemoonSizerModel.default.fromJSON(result, siteId);
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+    /**
+     * Update a Reemoon Sizer [PATCH /packhouse/sites/{siteId}/reemoon-sizers/{id}]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Reemoon Sizer ID
+     * @param {ReemoonSizerController.UpdateData} updateData The Reemoon Sizer Update Data
+     * @return {Promise<ReemoonSizerModel>}
+     */
+
+  }, {
+    key: "update",
+    value: function update(siteId, id, updateData) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.patchRequest("/packhouse/sites/".concat(siteId, "/reemoon-sizers/").concat(id), updateData).then(function (result) {
+          var resolveValue = function () {
+            return _ReemoonSizerModel.default.fromJSON(result, siteId);
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+    /**
+     * Delete a Reemoon Sizer [DELETE /packhouse/sites/{siteId}/reemoon-sizers/{id}]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Reemoon Sizer ID
+     * @return {Promise<boolean>}
+     */
+
+  }, {
+    key: "delete",
+    value: function _delete(siteId, id) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.deleteRequest("/packhouse/sites/".concat(siteId, "/reemoon-sizers/").concat(id)).then(function (result) {
+          resolve(result !== null && result !== void 0 ? result : true);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+    /**
+     * List all Reemoon Sizers [GET /packhouse/sites/{siteId}/reemoon-sizers]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {ReemoonSizerController.GetAllQueryParameters} [queryParameters] The Optional Query Parameters
+     * @return {Promise<ReemoonSizerModel[]>}
+     */
+
+  }, {
+    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, "/reemoon-sizers"), queryParameters).then(function (result) {
+          var resolveValue = function () {
+            if (Array.isArray(result) !== true) {
+              return [];
+            }
+
+            return result.map(function (resultItem) {
+              return function () {
+                return _ReemoonSizerModel.default.fromJSON(resultItem, siteId);
+              }();
+            });
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+    /**
+     * Create a Reemoon Sizer [POST /packhouse/sites/{siteId}/reemoon-sizers]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {ReemoonSizerController.CreateData} createData The Reemoon Sizer Create Data
+     * @return {Promise<ReemoonSizerModel>}
+     */
+
+  }, {
+    key: "create",
+    value: function create(siteId, createData) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.postRequest("/packhouse/sites/".concat(siteId, "/reemoon-sizers"), createData).then(function (result) {
+          var resolveValue = function () {
+            return _ReemoonSizerModel.default.fromJSON(result, siteId);
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+  }]);
+
+  return ReemoonSizerController;
+}();
+
+var _default = ReemoonSizerController;
+/**
+ * The Optional Query Parameters for the getAll Function
+ * 
+ * @typedef {Object} ReemoonSizerController.GetAllQueryParameters
+ * @property {?number} [rtuId] The RTU this Reemoon Sizer belongs to
+ * @property {string} [name] The Reemoon Sizer Name
+ * @property {string} [packingLineId] The Packing Line ID that manages this Reemoon Sizer
+ * @property {string} [sizerType] The Sizer Type
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * The Create Data for a Reemoon Sizer
+ * 
+ * @typedef {Object} ReemoonSizerController.CreateData
+ * @property {?number} [rtuId] The RTU this Reemoon Sizer belongs to
+ * @property {string} name The Reemoon Sizer Name
+ * @property {string} packingLineId The Packing Line ID that manages this Reemoon Sizer
+ * @property {string} sizerType The Sizer Type
+ * @property {number} [autoCreateBatchDelay] The Auto Create Batch Delay in Seconds for this Reemoon Sizer
+ * @property {{currentBatchId: number, currentBatchName: number, currentBatchVarietyCode: number, currentBatchStartTimestamp: number, currentBatchPackrunId: number, currentBatchPackrunName: number, machineAverageFruitWeight: number, machineAverageFruitSize: number, machineCupFill: number, machineIncomingFruitPerMinute: number, machineRecycledFruitPerMinute: number, machineTraysPerHour: number, machineTonnesPerHour: number, machineRodsPerMinute: number, machineIncomingFruitPerMinuteBySize: ?number, machineRecycledFruitPerMinuteBySize: ?number, machineLanesFruitPerMinuteBySize: ?number, createNewBatchRequest: number, createBatchOnPackrunChange: number, createBatchOnTimeBatchChange: number, outletGroupSummaries: number, products: number, packTypeOutletUtilizationTargets: number, class1TraysPerHour: ?number}} points The Points used by this Reemoon Sizer
+ * @property {Array<ReemoonSizerController.ReemoonSizerLane>} [lanes] The Lanes defined for this Reemoon Sizer
+ * @property {Array<ReemoonSizerController.ReemoonSizerOutlet>} [outlets] The Outlets defined for this Reemoon Sizer
+ * @property {Array<ReemoonSizerController.ReemoonSizerFruitSize>} [fruitSizes] The Fruit Sizes defined and handled by this Reemoon Sizer
+ * @property {?ReemoonSizerController.FreshPackReemoonSizerIntegration} [freshPackIntegration] The FreshPack Integration Configuration for this Reemoon Sizer
+ * @property {ReemoonSizerController.ReemoonSizerIntegration} reemoonIntegration The Reemoon Integration Configuration for this Reemoon Sizer
+ * @property {Array<ReemoonSizerController.RiserSource|ReemoonSizerController.SizerSource>} [sources] An Array of Sources that deliver Fruit to this Reemoon Sizer
+ * @property {Array<ReemoonSizerController.ProductClassType>} [productClassTypes] An Array of Product to Class Type Maps for this Reemoon Sizer
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * The Update Data for a Reemoon Sizer
+ * 
+ * @typedef {Object} ReemoonSizerController.UpdateData
+ * @property {string} [name] The Reemoon Sizer Name
+ * @property {string} [packingLineId] The Packing Line ID that manages this Reemoon Sizer
+ * @property {string} [sizerType] The Sizer Type
+ * @property {number} [autoCreateBatchDelay] The Auto Create Batch Delay in Seconds for this Reemoon Sizer
+ * @property {{currentBatchId: number, currentBatchName: number, currentBatchVarietyCode: number, currentBatchStartTimestamp: number, currentBatchPackrunId: number, currentBatchPackrunName: number, machineAverageFruitWeight: number, machineAverageFruitSize: number, machineCupFill: number, machineIncomingFruitPerMinute: number, machineRecycledFruitPerMinute: number, machineTraysPerHour: number, machineTonnesPerHour: number, machineRodsPerMinute: number, machineIncomingFruitPerMinuteBySize: ?number, machineRecycledFruitPerMinuteBySize: ?number, machineLanesFruitPerMinuteBySize: ?number, createNewBatchRequest: number, createBatchOnPackrunChange: number, createBatchOnTimeBatchChange: number, outletGroupSummaries: number, products: number, packTypeOutletUtilizationTargets: number, class1TraysPerHour: ?number}} [points] The Points used by this Reemoon Sizer
+ * @property {Array<ReemoonSizerController.ReemoonSizerLane>} [lanes] The Lanes defined for this Reemoon Sizer
+ * @property {Array<ReemoonSizerController.ReemoonSizerOutlet>} [outlets] The Outlets defined for this Reemoon Sizer
+ * @property {Array<ReemoonSizerController.ReemoonSizerFruitSize>} [fruitSizes] The Fruit Sizes defined and handled by this Reemoon Sizer
+ * @property {?ReemoonSizerController.FreshPackReemoonSizerIntegration} [freshPackIntegration] The FreshPack Integration Configuration for this Reemoon Sizer
+ * @property {ReemoonSizerController.ReemoonSizerIntegration} [reemoonIntegration] The Reemoon Integration Configuration for this Reemoon Sizer
+ * @property {Array<ReemoonSizerController.RiserSource|ReemoonSizerController.SizerSource>} [sources] An Array of Sources that deliver Fruit to this Reemoon Sizer
+ * @property {Array<ReemoonSizerController.ProductClassType>} [productClassTypes] An Array of Product to Class Type Maps for this Reemoon Sizer
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **ReemoonSizerLane** Type
+ * 
+ * @typedef {Object} ReemoonSizerController.ReemoonSizerLane
+ * @property {string} id Unique ID of this Lane
+ * @property {number} number The Lane Number
+ * @property {{cupFill: number}} points The Points used by this Lane
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **ReemoonSizerOutlet** Type
+ * 
+ * @typedef {Object} ReemoonSizerController.ReemoonSizerOutlet
+ * @property {string} id Unique ID of this Outlet
+ * @property {number} number The Outlet Number
+ * @property {string} type The Outlet Type
+ * @property {{name: number, fruitPerMinute: number, packsPerMinute: number, utilization: number, status: number, productId: number, productName: number}} points The Points used by this Outlet
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **ReemoonSizerFruitSize** Type
+ * 
+ * @typedef {Object} ReemoonSizerController.ReemoonSizerFruitSize
+ * @property {string} fruitSize The Fruit Size
+ * @property {{incomingFruitPerMinute: number, recycledFruitPerMinute: number, allocatedFruitPerMinute: number}} points The Points used by this Fruit Size Configuration
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **FreshPackReemoonSizerIntegration** Type
+ * 
+ * @typedef {Object} ReemoonSizerController.FreshPackReemoonSizerIntegration
+ * @property {Object} points The Points used by this FreshPack Sizer Integration
+ * @property {boolean} enabled Whether this FreshPack Sizer Integration is Enabled
+ * @property {number} materialGroupId The FreshPack Material Group ID to be used for Multi-Grower Bins from this Sizer
+ * @property {number} binTypeId The FreshPack Bin Type ID to be used for Multi-Grower Bins from this Sizer
+ * @property {string[]} bulkWeightClassTypes An Array of Class Types that should be Sent to FreshPack as Bulk Weights in Multi-Grower Bins
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **ReemoonSizerIntegration** Type
+ * 
+ * @typedef {Object} ReemoonSizerController.ReemoonSizerIntegration
+ * @property {{apiCommunicationStatus: number, machineId: number, machineName: number, machineLaneCount: number, machineOutletCount: number, machineOutletDetails: number}} points The Points used by this Reemoon Sizer Integration
+ * @property {boolean} enabled Whether this Reemoon Sizer Integration is Enabled
+ * @property {string} username Username for Authenticating with the Reemoon Sizer API
+ * @property {string} password Password for Authenticating with the Reemoon Sizer API
+ * @property {string} apiBaseUrl Base URL of the Reemoon Sizer API
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **RiserSource** Type
+ * 
+ * @typedef {Object} ReemoonSizerController.RiserSource
+ * @property {string} type The Source Type
+ * @property {string} riserId ID of the Riser Object
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **SizerSource** Type
+ * 
+ * @typedef {Object} ReemoonSizerController.SizerSource
+ * @property {string} type The Source Type
+ * @property {string} sizerId ID of the Sizer Object
+ * @property {number[]} outletNumbers An Array of Outlet Numbers on the Source Sizer that supply this Reemoon Sizer
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **ProductClassType** Type
+ * 
+ * @typedef {Object} ReemoonSizerController.ProductClassType
+ * @property {string} productName Name of the Reemoon Sizer Product
+ * @property {string} classType The Class Type for this Reemoon Sizer Product
+ * @property {string} matchType The Match Type used when Evaluating the Product Name
+ * @memberof Controllers.Packhouse.Site
+ */
+
+exports.default = _default;