@ricado/api-client 2.3.17 → 2.3.18

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

@@ -0,0 +1,198 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _RequestHelper = _interopRequireDefault(require("../../../RequestHelper"));
+
+var _BinTipBarcodeScannerModel = _interopRequireDefault(require("../../../Models/Packhouse/Site/BinTipBarcodeScannerModel"));
+
+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 Bin Tip Barcode Scanners
+ * 
+ * @class
+ */
+var BinTipBarcodeScannerController = /*#__PURE__*/function () {
+  function BinTipBarcodeScannerController() {
+    _classCallCheck(this, BinTipBarcodeScannerController);
+  }
+
+  _createClass(BinTipBarcodeScannerController, null, [{
+    key: "getOne",
+    value:
+    /**
+     * Retrieve a Bin Tip Barcode Scanner [GET /packhouse/sites/{siteId}/bin-tip-barcode-scanners/{id}]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Bin Tip Barcode Scanner ID
+     * @return {Promise<BinTipBarcodeScannerModel>}
+     */
+    function getOne(siteId, id) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.getRequest("/packhouse/sites/".concat(siteId, "/bin-tip-barcode-scanners/").concat(id)).then(function (result) {
+          var resolveValue = function () {
+            return _BinTipBarcodeScannerModel.default.fromJSON(result, siteId);
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+    /**
+     * Update a Bin Tip Barcode Scanner [PATCH /packhouse/sites/{siteId}/bin-tip-barcode-scanners/{id}]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Bin Tip Barcode Scanner ID
+     * @param {BinTipBarcodeScannerController.UpdateData} updateData The Bin Tip Barcode Scanner Update Data
+     * @return {Promise<BinTipBarcodeScannerModel>}
+     */
+
+  }, {
+    key: "update",
+    value: function update(siteId, id, updateData) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.patchRequest("/packhouse/sites/".concat(siteId, "/bin-tip-barcode-scanners/").concat(id), updateData).then(function (result) {
+          var resolveValue = function () {
+            return _BinTipBarcodeScannerModel.default.fromJSON(result, siteId);
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+    /**
+     * Delete a Bin Tip Barcode Scanner [DELETE /packhouse/sites/{siteId}/bin-tip-barcode-scanners/{id}]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Bin Tip Barcode Scanner ID
+     * @return {Promise<boolean>}
+     */
+
+  }, {
+    key: "delete",
+    value: function _delete(siteId, id) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.deleteRequest("/packhouse/sites/".concat(siteId, "/bin-tip-barcode-scanners/").concat(id)).then(function (result) {
+          resolve(result !== null && result !== void 0 ? result : true);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+    /**
+     * List all Bin Tip Barcode Scanners [GET /packhouse/sites/{siteId}/bin-tip-barcode-scanners]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {BinTipBarcodeScannerController.GetAllQueryParameters} [queryParameters] The Optional Query Parameters
+     * @return {Promise<BinTipBarcodeScannerModel[]>}
+     */
+
+  }, {
+    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, "/bin-tip-barcode-scanners"), queryParameters).then(function (result) {
+          var resolveValue = function () {
+            if (Array.isArray(result) !== true) {
+              return [];
+            }
+
+            return result.map(function (resultItem) {
+              return function () {
+                return _BinTipBarcodeScannerModel.default.fromJSON(resultItem, siteId);
+              }();
+            });
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+    /**
+     * Create a Bin Tip Barcode Scanner [POST /packhouse/sites/{siteId}/bin-tip-barcode-scanners]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {BinTipBarcodeScannerController.CreateData} createData The Bin Tip Barcode Scanner Create Data
+     * @return {Promise<BinTipBarcodeScannerModel>}
+     */
+
+  }, {
+    key: "create",
+    value: function create(siteId, createData) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.postRequest("/packhouse/sites/".concat(siteId, "/bin-tip-barcode-scanners"), createData).then(function (result) {
+          var resolveValue = function () {
+            return _BinTipBarcodeScannerModel.default.fromJSON(result, siteId);
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+  }]);
+
+  return BinTipBarcodeScannerController;
+}();
+
+var _default = BinTipBarcodeScannerController;
+/**
+ * The Optional Query Parameters for the getAll Function
+ * 
+ * @typedef {Object} BinTipBarcodeScannerController.GetAllQueryParameters
+ * @property {?number} [rtuId] The RTU this Bin Tip Barcode Scanner Belt belongs to
+ * @property {string} [name] The Name of this Bin Tip Barcode Scanner
+ * @property {string} [binTipId] The Bin Tip that owns this Barcode Scanner
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * The Create Data for a Bin Tip Barcode Scanner
+ * 
+ * @typedef {Object} BinTipBarcodeScannerController.CreateData
+ * @property {?number} [rtuId] The RTU this Bin Tip Barcode Scanner Belt belongs to
+ * @property {string} name The Name of this Bin Tip Barcode Scanner
+ * @property {{scannerErrorBeepRequest: number, restartServiceRequest: number}} points The Points used by this Bin Tip Barcode Scanner
+ * @property {string} binTipId The Bin Tip that owns this Barcode Scanner
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * The Update Data for a Bin Tip Barcode Scanner
+ * 
+ * @typedef {Object} BinTipBarcodeScannerController.UpdateData
+ * @property {string} [name] The Name of this Bin Tip Barcode Scanner
+ * @property {{scannerErrorBeepRequest: number, restartServiceRequest: number}} [points] The Points used by this Bin Tip Barcode Scanner
+ * @property {string} [binTipId] The Bin Tip that owns this Barcode Scanner
+ * @memberof Controllers.Packhouse.Site
+ */
+
+exports.default = _default;

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

@@ -847,7 +847,7 @@ var _default = BinTipBinController;
  * @property {?number} [emptyWeight] The Empty Weight for this Bin
  * @property {?string} [fullBinWeightId] The `BinTipWeight` ID as the Source for the Full Weight of this Bin
  * @property {?string} [emptyBinWeightId] The `BinTipWeight` ID as the Source for the Empty Weight of this Bin
- * @property {?Object} [freshPackFieldBinWeightApi] The FreshPack Field Bin Weight API Data
+ * @property {?BinTipBinController.FieldBinWeightApiStatus} [freshPackFieldBinWeightApi] Results from Interacting with the FreshPack API to Send Field Bin Weights
  * @memberof Controllers.Packhouse.Site
  */
 
@@ -864,7 +864,7 @@ var _default = BinTipBinController;
  * @property {?number} [emptyWeight] The Empty Weight for this Bin
  * @property {?string} [fullBinWeightId] The `BinTipWeight` ID as the Source for the Full Weight of this Bin
  * @property {?string} [emptyBinWeightId] The `BinTipWeight` ID as the Source for the Empty Weight of this Bin
- * @property {?Object} [freshPackFieldBinWeightApi] The FreshPack Field Bin Weight API Data
+ * @property {?BinTipBinController.FieldBinWeightApiStatus} [freshPackFieldBinWeightApi] Results from Interacting with the FreshPack API to Send Field Bin Weights
  * @memberof Controllers.Packhouse.Site
  */
 
@@ -890,4 +890,16 @@ var _default = BinTipBinController;
  * @memberof Controllers.Packhouse.Site
  */
 
+/**
+ * A **FieldBinWeightApiStatus** Type
+ * 
+ * @typedef {Object} BinTipBinController.FieldBinWeightApiStatus
+ * @property {number} requestCount Number of Requests made to the FreshPack API
+ * @property {?Date} requestTimestamp Timestamp of the last Request made to the FreshPack API
+ * @property {?number} responseCode Response Code from the last FreshPack API Request
+ * @property {?string} responseMessage Response Message from the last FreshPack API Request
+ * @property {boolean} completed Whether Interaction with the FreshPack API has been Completed
+ * @memberof Controllers.Packhouse.Site
+ */
+
 exports.default = _default;

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

@@ -839,7 +839,7 @@ var _default = CompacSizerBatchController;
  * @property {string} [batchId] The Numeric Compac Batch ID
  * @property {Date} [createdTimestamp] When this Batch was Created
  * @property {?string} [packrunId] The Packrun ID associated with this Batch
- * @property {Object} batch The Compac Sizer Batch Data
+ * @property {CompacSizerBatchController.CompacSizerBatch} batch The Compac Sizer Batch Data
  * @memberof Controllers.Packhouse.Site
  */
 
@@ -850,7 +850,7 @@ var _default = CompacSizerBatchController;
  * @property {string} [compacSizerId] The Compac Sizer ID this Batch is associated with
  * @property {Date} [createdTimestamp] When this Batch was Created
  * @property {?string} [packrunId] The Packrun ID associated with this Batch
- * @property {Object} [batch] The Compac Sizer Batch Data
+ * @property {CompacSizerBatchController.CompacSizerBatch} [batch] The Compac Sizer Batch Data
  * @memberof Controllers.Packhouse.Site
  */
 
@@ -876,4 +876,188 @@ var _default = CompacSizerBatchController;
  * @memberof Controllers.Packhouse.Site
  */
 
+/**
+ * A **BatchEvent** Type
+ * 
+ * @typedef {Object} CompacSizerBatchController.BatchEvent
+ * @property {number} id ID of this Event
+ * @property {number} batchId The Batch ID this Event is associated with
+ * @property {string} type The Event Type
+ * @property {string} details Details of this Event
+ * @property {Date} timestamp When this Event Occurred
+ * @property {number} runningSeconds Total Seconds the Sizer was Running during this Event
+ * @property {number} fruitRunningSeconds Total Seconds the Sizer was Running with Fruit during this Event
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **BatchSizingMapFruitSize** Type
+ * 
+ * @typedef {Object} CompacSizerBatchController.BatchSizingMapFruitSize
+ * @property {number} id ID of this Fruit Size
+ * @property {number} eventId The Event ID this Fruit Size is associated with
+ * @property {number} index Index of this Fruit Size
+ * @property {?string} name Name of this Fruit Size
+ * @property {number} minimumFruitWeight The Minimum Weight in Grams for this Fruit Size
+ * @property {number} fruitCount The Fruit Count for this Fruit Size
+ * @property {number} minimumTrayWeight The Minimum Tray Weight in Grams for this Fruit Size
+ * @property {number} varietySizingMapId ID of the Variety Sizing Map
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **BatchSizingMap** Type
+ * 
+ * @typedef {Object} CompacSizerBatchController.BatchSizingMap
+ * @property {number} id ID of this Sizing Map
+ * @property {number} eventId The Event ID this Sizing Map is associated with
+ * @property {number} varietySizingMapId ID of the Variety Sizing Map
+ * @property {?string} name Name of this Sizing Map
+ * @property {Array<CompacSizerBatchController.BatchSizingMapFruitSize>} fruitSizes An Array of Fruit Sizes defined in this Sizing Map
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **BatchGrade** Type
+ * 
+ * @typedef {Object} CompacSizerBatchController.BatchGrade
+ * @property {number} id ID of this Grade
+ * @property {number} eventId The Event ID this Grade is associated with
+ * @property {number} index Index of this Grade
+ * @property {?string} name Name of this Grade
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **BatchQuality** Type
+ * 
+ * @typedef {Object} CompacSizerBatchController.BatchQuality
+ * @property {number} id ID of this Quality
+ * @property {number} eventId The Event ID this Quality is associated with
+ * @property {number} index Index of this Quality
+ * @property {?string} name Name of this Quality
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **BatchProduct** Type
+ * 
+ * @typedef {Object} CompacSizerBatchController.BatchProduct
+ * @property {number} id ID of this Product
+ * @property {number} eventId The Event ID this Product is associated with
+ * @property {string} guid UUID of this Product
+ * @property {?string} name Name of this Product
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **BatchPack** Type
+ * 
+ * @typedef {Object} CompacSizerBatchController.BatchPack
+ * @property {number} id ID of this Pack
+ * @property {number} eventId The Event ID this Pack is associated with
+ * @property {string} guid UUID of this Pack
+ * @property {?string} name Name of this Pack
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **BatchSummaryGroup** Type
+ * 
+ * @typedef {Object} CompacSizerBatchController.BatchSummaryGroup
+ * @property {number} id ID of this Summary Group
+ * @property {?string} name Name of this Summary Group
+ * @property {boolean} isReject Whether this Summary Group is classes as Reject
+ * @property {number} orderIndex The Display Order Index for this Summary Group
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **BatchDropSummary** Type
+ * 
+ * @typedef {Object} CompacSizerBatchController.BatchDropSummary
+ * @property {number} id ID of this Drop Summary
+ * @property {number} eventId The Event ID this Drop Summary is associated with
+ * @property {number} summaryGroupId ID of the Summary Group for this Drop Summary
+ * @property {number} productId ID of the Product for this Drop Summary
+ * @property {number} dropId ID of the Drop for this Drop Summary
+ * @property {number} gradeIndex Index of the Grade for this Drop Summary
+ * @property {number} sizeIndex Index of the Fruit Size for this Drop Summary
+ * @property {number} qualityIndex Index of the Quality for this Drop Summary
+ * @property {number} fruitWeight Fruit Weight in Grams for this Drop Summary
+ * @property {number} fruitCount Fruit Count for this Drop Summary
+ * @property {number} varietySizingMapId Variety Sizing Map ID for this Drop Summary
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **BatchRecycleSummary** Type
+ * 
+ * @typedef {Object} CompacSizerBatchController.BatchRecycleSummary
+ * @property {number} id ID of this Recycle Summary
+ * @property {number} eventId The Event ID this Recycle Summary is associated with
+ * @property {number} productId ID of the Product for this Recycle Summary
+ * @property {number} dropId ID of the Drop for this Recycle Summary
+ * @property {number} gradeIndex Index of the Grade for this Recycle Summary
+ * @property {number} sizeIndex Index of the Fruit Size for this Recycle Summary
+ * @property {number} qualityIndex Index of the Quality for this Recycle Summary
+ * @property {number} fruitWeight Fruit Weight in Grams for this Recycle Summary
+ * @property {number} fruitCount Fruit Count for this Recycle Summary
+ * @property {number} varietySizingMapId Variety Sizing Map ID for this Recycle Summary
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **BatchPackSummary** Type
+ * 
+ * @typedef {Object} CompacSizerBatchController.BatchPackSummary
+ * @property {number} id ID of this Pack Summary
+ * @property {number} eventId The Event ID this Pack Summary is associated with
+ * @property {number} summaryGroupId ID of the Summary Group for this Pack Summary
+ * @property {number} productId ID of the Product for this Pack Summary
+ * @property {number} packId ID of the Pack for this Pack Summary
+ * @property {number} packCount Pack Count for this Pack Summary
+ * @property {number} fruitWeight Fruit Weight in Grams for this Drop Summary
+ * @property {number} fruitCount Fruit Count for this Drop Summary
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **BatchDrop** Type
+ * 
+ * @typedef {Object} CompacSizerBatchController.BatchDrop
+ * @property {number} id ID of this Drop (Outlet)
+ * @property {?string} name Name of this Drop (Outlet)
+ * @property {boolean} totallingEnabled Whether Fruit sent to this Drop (Outlet) should be recorded in the Drop Summary
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **CompacSizerBatch** Type
+ * 
+ * @typedef {Object} CompacSizerBatchController.CompacSizerBatch
+ * @property {number} id ID of this Batch
+ * @property {?string} name Name of this Batch
+ * @property {?string} growerCode Code of the Grower for this Batch
+ * @property {?string} growerName Name of the Grower for this Batch
+ * @property {?Date} startTimestamp When this Batch was Started
+ * @property {?Date} endTimestamp When this Batch was Finished
+ * @property {string[]} comments An Array of Comments for this Batch
+ * @property {string} varietyId ID of the Variety for this Batch
+ * @property {string} varietyName Name of the Variety for this Batch
+ * @property {boolean} finished Whether this Batch has been Finished
+ * @property {Array<CompacSizerBatchController.BatchEvent>} events An Array of Events for this Batch
+ * @property {Array<CompacSizerBatchController.BatchSizingMap>} sizingMaps An Array of Sizing Maps for this Batch
+ * @property {Array<CompacSizerBatchController.BatchGrade>} grades An Array of Grades for this Batch
+ * @property {Array<CompacSizerBatchController.BatchQuality>} qualities An Array of Qualities for this Batch
+ * @property {Array<CompacSizerBatchController.BatchProduct>} products An Array of Products for this Batch
+ * @property {Array<CompacSizerBatchController.BatchPack>} packs An Array of Packs for this Batch
+ * @property {Array<CompacSizerBatchController.BatchSummaryGroup>} summaryGroups An Array of Summary Groups for this Batch
+ * @property {Array<CompacSizerBatchController.BatchDropSummary>} dropSummaries An Array of Drop Summaries for this Batch
+ * @property {Array<CompacSizerBatchController.BatchRecycleSummary>} recycleSummaries An Array of Recycle Summaries for this Batch
+ * @property {Array<CompacSizerBatchController.BatchPackSummary>} packSummaries An Array of Pack Summaries for this Batch
+ * @property {Array<CompacSizerBatchController.BatchDrop>} drops An Array of Drops (Outlets) for this Batch
+ * @memberof Controllers.Packhouse.Site
+ */
+
 exports.default = _default;