@ricado/api-client 2.1.1 → 2.2.0

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

@@ -0,0 +1,622 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _RequestHelper = _interopRequireDefault(require("../../../RequestHelper"));
+
+var _BinTipBinModel = _interopRequireDefault(require("../../../Models/Packhouse/Site/BinTipBinModel"));
+
+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 Bin Tip Bins
+ * 
+ * @class
+ */
+var BinTipBinController = /*#__PURE__*/function () {
+  function BinTipBinController() {
+    _classCallCheck(this, BinTipBinController);
+  }
+
+  _createClass(BinTipBinController, null, [{
+    key: "getOne",
+    value:
+    /**
+     * Retrieve a Bin Tip Bin [GET /packhouse/sites/{siteId}/bin-tip-bins/{id}]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Bin Tip Bin ID
+     * @return {Promise<BinTipBinModel>}
+     */
+    function getOne(siteId, id) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.getRequest("/packhouse/sites/".concat(siteId, "/bin-tip-bins/").concat(id)).then(function (result) {
+          var resolveValue = function () {
+            return _BinTipBinModel.default.fromJSON(result, siteId);
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+    /**
+     * Update a Bin Tip Bin [PATCH /packhouse/sites/{siteId}/bin-tip-bins/{id}]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Bin Tip Bin ID
+     * @param {BinTipBinController.UpdateData} updateData The Bin Tip Bin Update Data
+     * @return {Promise<BinTipBinModel>}
+     */
+
+  }, {
+    key: "update",
+    value: function update(siteId, id, updateData) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.patchRequest("/packhouse/sites/".concat(siteId, "/bin-tip-bins/").concat(id), updateData).then(function (result) {
+          var resolveValue = function () {
+            return _BinTipBinModel.default.fromJSON(result, siteId);
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+    /**
+     * Delete a Bin Tip Bin [DELETE /packhouse/sites/{siteId}/bin-tip-bins/{id}]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Bin Tip Bin 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-bins/").concat(id)).then(function (result) {
+          resolve(result !== null && result !== void 0 ? result : true);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+    /**
+     * Retrieve Comments [GET /packhouse/sites/{siteId}/bin-tip-bins/{id}/comments]
+     * 
+     * Retrieves Comments for a Bin Tip Bin
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Bin Tip Bin ID
+     * @return {Promise<Array<BinTipBinController.CommentItem>>}
+     */
+
+  }, {
+    key: "getComments",
+    value: function getComments(siteId, id) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.getRequest("/packhouse/sites/".concat(siteId, "/bin-tip-bins/").concat(id, "/comments")).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' && 'id' in resultItem) {
+                  resultItemObject.id = function () {
+                    if (typeof resultItem.id !== 'string') {
+                      return String(resultItem.id);
+                    }
+
+                    return resultItem.id;
+                  }();
+                } else {
+                  resultItemObject.id = "";
+                }
+
+                if (_typeof(resultItem) === 'object' && 'content' in resultItem) {
+                  resultItemObject.content = function () {
+                    if (resultItem.content === null) {
+                      return null;
+                    }
+
+                    if (typeof resultItem.content !== 'string') {
+                      return String(resultItem.content);
+                    }
+
+                    return resultItem.content;
+                  }();
+                } else {
+                  resultItemObject.content = null;
+                }
+
+                if (_typeof(resultItem) === 'object' && 'createdTimestamp' in resultItem) {
+                  resultItemObject.createdTimestamp = function () {
+                    if (resultItem.createdTimestamp === null) {
+                      return null;
+                    }
+
+                    if (typeof resultItem.createdTimestamp !== 'string') {
+                      return new Date(String(resultItem.createdTimestamp));
+                    }
+
+                    return new Date(resultItem.createdTimestamp);
+                  }();
+                } else {
+                  resultItemObject.createdTimestamp = null;
+                }
+
+                if (_typeof(resultItem) === 'object' && 'updatedTimestamp' in resultItem) {
+                  resultItemObject.updatedTimestamp = function () {
+                    if (resultItem.updatedTimestamp === null) {
+                      return null;
+                    }
+
+                    if (typeof resultItem.updatedTimestamp !== 'string') {
+                      return new Date(String(resultItem.updatedTimestamp));
+                    }
+
+                    return new Date(resultItem.updatedTimestamp);
+                  }();
+                } else {
+                  resultItemObject.updatedTimestamp = null;
+                }
+
+                return resultItemObject;
+              }();
+            });
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+    /**
+     * Create a Comment [POST /packhouse/sites/{siteId}/bin-tip-bins/{id}/comments]
+     * 
+     * Create a Comment for a Bin Tip Bin
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Bin Tip Bin ID
+     * @param {string} content The Content of the New Comment
+     * @return {Promise<BinTipBinController.CommentItem>}
+     */
+
+  }, {
+    key: "createComment",
+    value: function createComment(siteId, id, content) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.postRequest("/packhouse/sites/".concat(siteId, "/bin-tip-bins/").concat(id, "/comments"), {
+          content: content
+        }).then(function (result) {
+          var resolveValue = function () {
+            var resultObject = {};
+
+            if (_typeof(result) === 'object' && 'id' in result) {
+              resultObject.id = function () {
+                if (typeof result.id !== 'string') {
+                  return String(result.id);
+                }
+
+                return result.id;
+              }();
+            } else {
+              resultObject.id = "";
+            }
+
+            if (_typeof(result) === 'object' && 'content' in result) {
+              resultObject.content = function () {
+                if (result.content === null) {
+                  return null;
+                }
+
+                if (typeof result.content !== 'string') {
+                  return String(result.content);
+                }
+
+                return result.content;
+              }();
+            } else {
+              resultObject.content = null;
+            }
+
+            if (_typeof(result) === 'object' && 'createdTimestamp' in result) {
+              resultObject.createdTimestamp = function () {
+                if (result.createdTimestamp === null) {
+                  return null;
+                }
+
+                if (typeof result.createdTimestamp !== 'string') {
+                  return new Date(String(result.createdTimestamp));
+                }
+
+                return new Date(result.createdTimestamp);
+              }();
+            } else {
+              resultObject.createdTimestamp = null;
+            }
+
+            if (_typeof(result) === 'object' && 'updatedTimestamp' in result) {
+              resultObject.updatedTimestamp = function () {
+                if (result.updatedTimestamp === null) {
+                  return null;
+                }
+
+                if (typeof result.updatedTimestamp !== 'string') {
+                  return new Date(String(result.updatedTimestamp));
+                }
+
+                return new Date(result.updatedTimestamp);
+              }();
+            } else {
+              resultObject.updatedTimestamp = null;
+            }
+
+            return resultObject;
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+    /**
+     * Retrieve a Comment [GET /packhouse/sites/{siteId}/bin-tip-bins/{id}/comments/{commentId}]
+     * 
+     * Retrieves Comments for a Bin Tip Bin
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Bin Tip Bin ID
+     * @param {string} commentId The Comment ID
+     * @return {Promise<BinTipBinController.CommentItem>}
+     */
+
+  }, {
+    key: "getOneComment",
+    value: function getOneComment(siteId, id, commentId) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.getRequest("/packhouse/sites/".concat(siteId, "/bin-tip-bins/").concat(id, "/comments/").concat(commentId)).then(function (result) {
+          var resolveValue = function () {
+            var resultObject = {};
+
+            if (_typeof(result) === 'object' && 'id' in result) {
+              resultObject.id = function () {
+                if (typeof result.id !== 'string') {
+                  return String(result.id);
+                }
+
+                return result.id;
+              }();
+            } else {
+              resultObject.id = "";
+            }
+
+            if (_typeof(result) === 'object' && 'content' in result) {
+              resultObject.content = function () {
+                if (result.content === null) {
+                  return null;
+                }
+
+                if (typeof result.content !== 'string') {
+                  return String(result.content);
+                }
+
+                return result.content;
+              }();
+            } else {
+              resultObject.content = null;
+            }
+
+            if (_typeof(result) === 'object' && 'createdTimestamp' in result) {
+              resultObject.createdTimestamp = function () {
+                if (result.createdTimestamp === null) {
+                  return null;
+                }
+
+                if (typeof result.createdTimestamp !== 'string') {
+                  return new Date(String(result.createdTimestamp));
+                }
+
+                return new Date(result.createdTimestamp);
+              }();
+            } else {
+              resultObject.createdTimestamp = null;
+            }
+
+            if (_typeof(result) === 'object' && 'updatedTimestamp' in result) {
+              resultObject.updatedTimestamp = function () {
+                if (result.updatedTimestamp === null) {
+                  return null;
+                }
+
+                if (typeof result.updatedTimestamp !== 'string') {
+                  return new Date(String(result.updatedTimestamp));
+                }
+
+                return new Date(result.updatedTimestamp);
+              }();
+            } else {
+              resultObject.updatedTimestamp = null;
+            }
+
+            return resultObject;
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+    /**
+     * Update a Comment [PATCH /packhouse/sites/{siteId}/bin-tip-bins/{id}/comments/{commentId}]
+     * 
+     * Update a Comment for a Bin Tip Bin
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Bin Tip Bin ID
+     * @param {string} commentId The Comment ID
+     * @param {string} content The Updated Content for the Comment
+     * @return {Promise<BinTipBinController.CommentItem>}
+     */
+
+  }, {
+    key: "updateOneComment",
+    value: function updateOneComment(siteId, id, commentId, content) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.patchRequest("/packhouse/sites/".concat(siteId, "/bin-tip-bins/").concat(id, "/comments/").concat(commentId), {
+          content: content
+        }).then(function (result) {
+          var resolveValue = function () {
+            var resultObject = {};
+
+            if (_typeof(result) === 'object' && 'id' in result) {
+              resultObject.id = function () {
+                if (typeof result.id !== 'string') {
+                  return String(result.id);
+                }
+
+                return result.id;
+              }();
+            } else {
+              resultObject.id = "";
+            }
+
+            if (_typeof(result) === 'object' && 'content' in result) {
+              resultObject.content = function () {
+                if (result.content === null) {
+                  return null;
+                }
+
+                if (typeof result.content !== 'string') {
+                  return String(result.content);
+                }
+
+                return result.content;
+              }();
+            } else {
+              resultObject.content = null;
+            }
+
+            if (_typeof(result) === 'object' && 'createdTimestamp' in result) {
+              resultObject.createdTimestamp = function () {
+                if (result.createdTimestamp === null) {
+                  return null;
+                }
+
+                if (typeof result.createdTimestamp !== 'string') {
+                  return new Date(String(result.createdTimestamp));
+                }
+
+                return new Date(result.createdTimestamp);
+              }();
+            } else {
+              resultObject.createdTimestamp = null;
+            }
+
+            if (_typeof(result) === 'object' && 'updatedTimestamp' in result) {
+              resultObject.updatedTimestamp = function () {
+                if (result.updatedTimestamp === null) {
+                  return null;
+                }
+
+                if (typeof result.updatedTimestamp !== 'string') {
+                  return new Date(String(result.updatedTimestamp));
+                }
+
+                return new Date(result.updatedTimestamp);
+              }();
+            } else {
+              resultObject.updatedTimestamp = null;
+            }
+
+            return resultObject;
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+    /**
+     * Delete a Comment [DELETE /packhouse/sites/{siteId}/bin-tip-bins/{id}/comments/{commentId}]
+     * 
+     * Delete a Comment for a Bin Tip Bin
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Bin Tip Bin ID
+     * @param {string} commentId The Comment ID
+     * @return {Promise<boolean>}
+     */
+
+  }, {
+    key: "deleteOneComment",
+    value: function deleteOneComment(siteId, id, commentId) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.deleteRequest("/packhouse/sites/".concat(siteId, "/bin-tip-bins/").concat(id, "/comments/").concat(commentId)).then(function (result) {
+          resolve(result !== null && result !== void 0 ? result : true);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+    /**
+     * List all Bin Tip Bins [GET /packhouse/sites/{siteId}/bin-tip-bins]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {BinTipBinController.GetAllQueryParameters} [queryParameters] The Optional Query Parameters
+     * @return {Promise<BinTipBinModel[]>}
+     */
+
+  }, {
+    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-bins"), queryParameters).then(function (result) {
+          var resolveValue = function () {
+            if (Array.isArray(result) !== true) {
+              return [];
+            }
+
+            return result.map(function (resultItem) {
+              return function () {
+                return _BinTipBinModel.default.fromJSON(resultItem, siteId);
+              }();
+            });
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+    /**
+     * Create a Bin Tip Bin [POST /packhouse/sites/{siteId}/bin-tip-bins]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {BinTipBinController.CreateData} createData The Bin Tip Bin Create Data
+     * @return {Promise<BinTipBinModel>}
+     */
+
+  }, {
+    key: "create",
+    value: function create(siteId, createData) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.postRequest("/packhouse/sites/".concat(siteId, "/bin-tip-bins"), createData).then(function (result) {
+          var resolveValue = function () {
+            return _BinTipBinModel.default.fromJSON(result, siteId);
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+  }]);
+
+  return BinTipBinController;
+}();
+
+var _default = BinTipBinController;
+/**
+ * The Optional Query Parameters for the getAll Function
+ * 
+ * @typedef {Object} BinTipBinController.GetAllQueryParameters
+ * @property {string} [binTipId] The Bin Tip ID associated with this Bin
+ * @property {string} [packrunId] The Packrun ID associated with 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 {Date} [createdTimestampBegin] Filter by the Timestamp when this Bin was Created. Results Greater than or Equal to Timestamp
+ * @property {Date} [createdTimestampEnd] Filter by the Timestamp when this Bin was Created. Results Less than or Equal to Timestamp
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * The Create Data for a Bin Tip Bin
+ * 
+ * @typedef {Object} BinTipBinController.CreateData
+ * @property {string} binTipId The Bin Tip ID associated with this Bin
+ * @property {string} [packrunId] The Packrun ID associated with this Bin
+ * @property {Date} [createdTimestamp] When this Bin was Created
+ * @property {?string} [binNumber] A 10-Digit Bin Number made up of a Bin Lot (4-Digits) and a Unique Number (6-Digits)
+ * @property {?string} [timeBatchId] The Time Batch ID associated with this Bin
+ * @property {?number} [fullWeight] The Full Weight for this Bin
+ * @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
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * The Update Data for a Bin Tip Bin
+ * 
+ * @typedef {Object} BinTipBinController.UpdateData
+ * @property {string} [binTipId] The Bin Tip ID associated with this Bin
+ * @property {Date} [createdTimestamp] When this Bin was Created
+ * @property {?string} [binNumber] A 10-Digit Bin Number made up of a Bin Lot (4-Digits) and a Unique Number (6-Digits)
+ * @property {?string} [timeBatchId] The Time Batch ID associated with this Bin
+ * @property {?number} [fullWeight] The Full Weight for this Bin
+ * @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
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **CommentItem** Type
+ * 
+ * @typedef {Object} BinTipBinController.CommentItem
+ * @property {string} id The Comment ID
+ * @property {?string} content The Content of the Comment
+ * @property {?Date} createdTimestamp When the Comment was Created
+ * @property {?Date} updatedTimestamp When the Comment was last Updated
+ * @memberof Controllers.Packhouse.Site
+ */
+
+exports.default = _default;

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

@@ -171,7 +171,7 @@ var _default = CompacSizerController;
  * @property {?number} [rtuId] The RTU this Compac Sizer belongs to
  * @property {string} [name] The Compac Sizer Name
  * @property {string} [sizerType] The Sizer Type
- * @property {string} [packingLineId] The Packing Line ID this Compac Sizer belongs to
+ * @property {string} [packingLineId] The Packing Line ID that manages this Compac Sizer
  * @memberof Controllers.Packhouse.Site
  */
 
@@ -187,7 +187,7 @@ var _default = CompacSizerController;
  * @property {string} sizerType The Sizer Type
  * @property {number} [autoCreateBatchDelay] The Auto Create Batch Delay in Seconds for this Compac Sizer
  * @property {Object[]} [fruitSizes] The Fruit Sizes defined and handled by this Compac Sizer
- * @property {string} packingLineId The Packing Line ID this Compac Sizer belongs to
+ * @property {string} packingLineId The Packing Line ID that manages this Compac Sizer
  * @property {?Object} [freshPackIntegration] The FreshPack Integration Configuration for this Compac Sizer
  * @property {Object[]} [sources] An Array of Sources that deliver Fruit to this Compac Sizer
  * @memberof Controllers.Packhouse.Site
@@ -204,7 +204,7 @@ var _default = CompacSizerController;
  * @property {string} [sizerType] The Sizer Type
  * @property {number} [autoCreateBatchDelay] The Auto Create Batch Delay in Seconds for this Compac Sizer
  * @property {Object[]} [fruitSizes] The Fruit Sizes defined and handled by this Compac Sizer
- * @property {string} [packingLineId] The Packing Line ID this Compac Sizer belongs to
+ * @property {string} [packingLineId] The Packing Line ID that manages this Compac Sizer
  * @property {?Object} [freshPackIntegration] The FreshPack Integration Configuration for this Compac Sizer
  * @property {Object[]} [sources] An Array of Sources that deliver Fruit to this Compac Sizer
  * @memberof Controllers.Packhouse.Site