@ricado/api-client 2.1.1 → 2.2.0

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

@@ -0,0 +1,661 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _RequestHelper = _interopRequireDefault(require("../../../RequestHelper"));
+
+var _ShiftQualitySummaryModel = _interopRequireDefault(require("../../../Models/Packhouse/Site/ShiftQualitySummaryModel"));
+
+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 Shift Quality Summaries
+ * 
+ * @class
+ */
+var ShiftQualitySummaryController = /*#__PURE__*/function () {
+  function ShiftQualitySummaryController() {
+    _classCallCheck(this, ShiftQualitySummaryController);
+  }
+
+  _createClass(ShiftQualitySummaryController, null, [{
+    key: "getOne",
+    value:
+    /**
+     * Retrieve a Shift Quality Summary [GET /packhouse/sites/{siteId}/shift-quality-summaries/{id}]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Shift Quality Summary ID
+     * @return {Promise<ShiftQualitySummaryModel>}
+     */
+    function getOne(siteId, id) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.getRequest("/packhouse/sites/".concat(siteId, "/shift-quality-summaries/").concat(id)).then(function (result) {
+          var resolveValue = function () {
+            return _ShiftQualitySummaryModel.default.fromJSON(result, siteId);
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+    /**
+     * Update a Shift Quality Summary [PATCH /packhouse/sites/{siteId}/shift-quality-summaries/{id}]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Shift Quality Summary ID
+     * @param {ShiftQualitySummaryController.UpdateData} updateData The Shift Quality Summary Update Data
+     * @return {Promise<ShiftQualitySummaryModel>}
+     */
+
+  }, {
+    key: "update",
+    value: function update(siteId, id, updateData) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.patchRequest("/packhouse/sites/".concat(siteId, "/shift-quality-summaries/").concat(id), updateData).then(function (result) {
+          var resolveValue = function () {
+            return _ShiftQualitySummaryModel.default.fromJSON(result, siteId);
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+    /**
+     * Delete a Shift Quality Summary [DELETE /packhouse/sites/{siteId}/shift-quality-summaries/{id}]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Shift Quality Summary ID
+     * @return {Promise<boolean>}
+     */
+
+  }, {
+    key: "delete",
+    value: function _delete(siteId, id) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.deleteRequest("/packhouse/sites/".concat(siteId, "/shift-quality-summaries/").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}/shift-quality-summaries/{id}/comments]
+     * 
+     * Retrieves Comments for a Shift Quality Summary
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Shift Quality Summary ID
+     * @return {Promise<Array<ShiftQualitySummaryController.CommentItem>>}
+     */
+
+  }, {
+    key: "getComments",
+    value: function getComments(siteId, id) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.getRequest("/packhouse/sites/".concat(siteId, "/shift-quality-summaries/").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}/shift-quality-summaries/{id}/comments]
+     * 
+     * Create a Comment for a Shift Quality Summary
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Shift Quality Summary ID
+     * @param {string} content The Content of the New Comment
+     * @return {Promise<ShiftQualitySummaryController.CommentItem>}
+     */
+
+  }, {
+    key: "createComment",
+    value: function createComment(siteId, id, content) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.postRequest("/packhouse/sites/".concat(siteId, "/shift-quality-summaries/").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}/shift-quality-summaries/{id}/comments/{commentId}]
+     * 
+     * Retrieves Comments for a Shift Quality Summary
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Shift Quality Summary ID
+     * @param {string} commentId The Comment ID
+     * @return {Promise<ShiftQualitySummaryController.CommentItem>}
+     */
+
+  }, {
+    key: "getOneComment",
+    value: function getOneComment(siteId, id, commentId) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.getRequest("/packhouse/sites/".concat(siteId, "/shift-quality-summaries/").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}/shift-quality-summaries/{id}/comments/{commentId}]
+     * 
+     * Update a Comment for a Shift Quality Summary
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Shift Quality Summary ID
+     * @param {string} commentId The Comment ID
+     * @param {string} content The Updated Content for the Comment
+     * @return {Promise<ShiftQualitySummaryController.CommentItem>}
+     */
+
+  }, {
+    key: "updateOneComment",
+    value: function updateOneComment(siteId, id, commentId, content) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.patchRequest("/packhouse/sites/".concat(siteId, "/shift-quality-summaries/").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}/shift-quality-summaries/{id}/comments/{commentId}]
+     * 
+     * Delete a Comment for a Shift Quality Summary
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Shift Quality Summary 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, "/shift-quality-summaries/").concat(id, "/comments/").concat(commentId)).then(function (result) {
+          resolve(result !== null && result !== void 0 ? result : true);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+    /**
+     * List all Shift Quality Summaries [GET /packhouse/sites/{siteId}/shift-quality-summaries]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {ShiftQualitySummaryController.GetAllQueryParameters} [queryParameters] The Optional Query Parameters
+     * @return {Promise<ShiftQualitySummaryModel[]>}
+     */
+
+  }, {
+    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, "/shift-quality-summaries"), queryParameters).then(function (result) {
+          var resolveValue = function () {
+            if (Array.isArray(result) !== true) {
+              return [];
+            }
+
+            return result.map(function (resultItem) {
+              return function () {
+                return _ShiftQualitySummaryModel.default.fromJSON(resultItem, siteId);
+              }();
+            });
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+    /**
+     * Create a Shift Quality Summary [POST /packhouse/sites/{siteId}/shift-quality-summaries]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {ShiftQualitySummaryController.CreateData} createData The Shift Quality Summary Create Data
+     * @return {Promise<ShiftQualitySummaryModel>}
+     */
+
+  }, {
+    key: "create",
+    value: function create(siteId, createData) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.postRequest("/packhouse/sites/".concat(siteId, "/shift-quality-summaries"), createData).then(function (result) {
+          var resolveValue = function () {
+            return _ShiftQualitySummaryModel.default.fromJSON(result, siteId);
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+  }]);
+
+  return ShiftQualitySummaryController;
+}();
+
+var _default = ShiftQualitySummaryController;
+/**
+ * The Optional Query Parameters for the getAll Function
+ * 
+ * @typedef {Object} ShiftQualitySummaryController.GetAllQueryParameters
+ * @property {string} [packingLineId] The Packing Line ID this Quality Summary is associated with
+ * @property {string} [shiftId] The Shift ID this Quality Summary is asssociated with
+ * @property {?string} [qualityManagerUserId] The User ID of the Quality Manager for this Summary
+ * @property {string} [qualityManagerName] The Name of the Quality Manager for this Summary
+ * @property {Date} [createdTimestampBegin] Filter by the Timestamp when Quality Summaries were Created. Results Greater than or Equal to Timestamp
+ * @property {Date} [createdTimestampEnd] Filter by the Timestamp when Quality Summaries were Created. Results Less than or Equal to Timestamp
+ * @property {Date} [updateTimestampBegin] Filter by the Timestamp when Quality Summaries were last Updated. Results Greater than or Equal to Timestamp
+ * @property {Date} [updateTimestampEnd] Filter by the Timestamp when Quality Summaries were last Updated. Results Less than or Equal to Timestamp
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * The Create Data for a Shift Quality Summary
+ * 
+ * @typedef {Object} ShiftQualitySummaryController.CreateData
+ * @property {string} packingLineId The Packing Line ID this Quality Summary is associated with
+ * @property {string} [shiftId] The Shift ID this Quality Summary is asssociated with
+ * @property {Date} [createdTimestamp] When this Quality Summary was Created
+ * @property {?Date} [publishTimestamp] When this Quality Summary was Published
+ * @property {?string} [qualityManagerUserId] The User ID of the Quality Manager for this Summary
+ * @property {string} qualityManagerName The Name of the Quality Manager for this Summary
+ * @property {Array<ShiftQualitySummaryController.AccuracyResult>} [accuracyResults] An Array of Accuracy Results for this Summary
+ * @property {Array<ShiftQualitySummaryController.AuditResult>} [auditResults] An Array of Audit Results for this Summary
+ * @property {Array<ShiftQualitySummaryController.PackrunResult>} [packrunResults] An Array of Packrun Results for this Summary
+ * @property {?number} [satisfactionRating] An Optional Rating between 1 and 10 on how Satisfied the Quality Manager was with this Shift
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * The Update Data for a Shift Quality Summary
+ * 
+ * @typedef {Object} ShiftQualitySummaryController.UpdateData
+ * @property {string} [packingLineId] The Packing Line ID this Quality Summary is associated with
+ * @property {Date} [createdTimestamp] When this Quality Summary was Created
+ * @property {?Date} [publishTimestamp] When this Quality Summary was Published
+ * @property {?string} [qualityManagerUserId] The User ID of the Quality Manager for this Summary
+ * @property {string} [qualityManagerName] The Name of the Quality Manager for this Summary
+ * @property {Array<ShiftQualitySummaryController.AccuracyResult>} [accuracyResults] An Array of Accuracy Results for this Summary
+ * @property {Array<ShiftQualitySummaryController.AuditResult>} [auditResults] An Array of Audit Results for this Summary
+ * @property {Array<ShiftQualitySummaryController.PackrunResult>} [packrunResults] An Array of Packrun Results for this Summary
+ * @property {?number} [satisfactionRating] An Optional Rating between 1 and 10 on how Satisfied the Quality Manager was with this Shift
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **CommentItem** Type
+ * 
+ * @typedef {Object} ShiftQualitySummaryController.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
+ */
+
+/**
+ * A **AccuracyResult** Type
+ * 
+ * @typedef {Object} ShiftQualitySummaryController.AccuracyResult
+ * @property {string} type The Accuracy Type
+ * @property {number} value The Accuracy Result Value
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **AuditResult** Type
+ * 
+ * @typedef {Object} ShiftQualitySummaryController.AuditResult
+ * @property {string} type The Audit Type
+ * @property {number} value The Audit Result Value
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **PackrunResult** Type
+ * 
+ * @typedef {Object} ShiftQualitySummaryController.PackrunResult
+ * @property {string} packrunId The ID of the associated Packrun
+ * @property {string} packrunName The Name of the associated Packrun
+ * @property {number} minorPackingDefects The R600 Minor Defects Percentage
+ * @property {number} majorPackingDefects The R600 Major Defects Percentage
+ * @property {number} softs The R600 Softs Percentage
+ * @property {number} cuts The R600 Cuts (e.g. Flesh Damage) Percentage
+ * @property {number} rots The R600 Rots Percentage
+ * @property {?number} softsLineAverageSampleSize The Softs Line Average Sample Size
+ * @property {?number} softsLineAverageValue The Softs Line Average Value
+ * @property {?number} exportFruitInClass2 The Percentage of Export (Class 1) Fruit found in Class 2
+ * @property {?number} exportFruitInLocalMarket The Percentage of Export (Class 1) Fruit found in Local Market
+ * @property {?number} exportFruitInWaste The Percentage of Export (Class 1) Fruit found in Waste
+ * @memberof Controllers.Packhouse.Site
+ */
+
+exports.default = _default;