@ricado/api-client 2.3.15 → 2.3.17

package/lib/Controllers/Packhouse/Integrations/ExternalShiftManagementController.js

@@ -0,0 +1,76 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _RequestHelper = _interopRequireDefault(require("../../../RequestHelper"));
+
+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; }
+
+/**
+ * The External Shift Management Controller Class
+ * 
+ * @class
+ */
+var ExternalShiftManagementController = /*#__PURE__*/function () {
+  function ExternalShiftManagementController() {
+    _classCallCheck(this, ExternalShiftManagementController);
+  }
+
+  _createClass(ExternalShiftManagementController, null, [{
+    key: "updateTeamsHeadCount",
+    value:
+    /**
+     * Update Teams Head Count [POST /integrations/packhouse/external-shift-management/update-teams-headcount]
+     * 
+     * Update the Current Shift Manning Head Count by Team for a given Packing Line
+     * 
+     * @static
+     * @public
+     * @param {ExternalShiftManagementController.PackingLineTeamsHeadCount} objectData The Object Properties
+     * @return {Promise<boolean>}
+     */
+    function updateTeamsHeadCount(objectData) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.postRequest("/integrations/packhouse/external-shift-management/update-teams-headcount", objectData).then(function (result) {
+          resolve(result !== null && result !== void 0 ? result : true);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+  }]);
+
+  return ExternalShiftManagementController;
+}();
+
+var _default = ExternalShiftManagementController;
+/**
+ * A **TeamHeadCount** Type
+ * 
+ * @typedef {Object} ExternalShiftManagementController.TeamHeadCount
+ * @property {string} team Name of the Team
+ * @property {number} count Number of People Present in the Team
+ * @memberof Controllers.Packhouse.Integrations
+ */
+
+/**
+ * A **PackingLineTeamsHeadCount** Type
+ * 
+ * @typedef {Object} ExternalShiftManagementController.PackingLineTeamsHeadCount
+ * @property {number} siteId Numeric ID of the RICADO Site
+ * @property {string} packingLineId UUID of the Packing Line
+ * @property {Array<ExternalShiftManagementController.TeamHeadCount>} headCounts An Array of Head Counts by Team
+ * @property {Date} validAfterTimestamp Timestamp of when this Head Count Data should be Applied
+ * @memberof Controllers.Packhouse.Integrations
+ */
+
+exports.default = _default;

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

@@ -0,0 +1,25 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _ExternalShiftManagementController = _interopRequireDefault(require("./ExternalShiftManagementController"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/**
+ * File Auto-Generated by the RICADO Gen 4 PHP API Project
+ * 
+ * Do Not Edit this File Manually!
+ */
+
+/**
+ * @namespace Controllers.Packhouse.Integrations
+ */
+var Integrations = {
+  ExternalShiftManagementController: _ExternalShiftManagementController.default
+};
+var _default = Integrations;
+exports.default = _default;

package/lib/Controllers/Packhouse/ProductionDataExportController.js

@@ -318,6 +318,18 @@ var ProductionDataExportController = /*#__PURE__*/function () {
                       packrunsItemObject.averageBinsTippedPerHour = 0;
                     }
 
+                    if (_typeof(packrunsItem) === 'object' && 'averageBinsTippedPerHourExcludingDowntime' in packrunsItem) {
+                      packrunsItemObject.averageBinsTippedPerHourExcludingDowntime = function () {
+                        if (typeof packrunsItem.averageBinsTippedPerHourExcludingDowntime !== 'number') {
+                          return Number(packrunsItem.averageBinsTippedPerHourExcludingDowntime);
+                        }
+
+                        return packrunsItem.averageBinsTippedPerHourExcludingDowntime;
+                      }();
+                    } else {
+                      packrunsItemObject.averageBinsTippedPerHourExcludingDowntime = 0;
+                    }
+
                     if (_typeof(packrunsItem) === 'object' && 'averageTimePerTippedBin' in packrunsItem) {
                       packrunsItemObject.averageTimePerTippedBin = function () {
                         if (typeof packrunsItem.averageTimePerTippedBin !== 'number') {
@@ -3374,6 +3386,118 @@ var ProductionDataExportController = /*#__PURE__*/function () {
                       shiftHourlyEntriesItemObject.qualityR600IdealSamplesActual = null;
                     }
 
+                    if (_typeof(shiftHourlyEntriesItem) === 'object' && 'primaryIssueCategory' in shiftHourlyEntriesItem) {
+                      shiftHourlyEntriesItemObject.primaryIssueCategory = function () {
+                        if (shiftHourlyEntriesItem.primaryIssueCategory === null) {
+                          return null;
+                        }
+
+                        if (typeof shiftHourlyEntriesItem.primaryIssueCategory !== 'string') {
+                          return String(shiftHourlyEntriesItem.primaryIssueCategory);
+                        }
+
+                        return shiftHourlyEntriesItem.primaryIssueCategory;
+                      }();
+                    } else {
+                      shiftHourlyEntriesItemObject.primaryIssueCategory = null;
+                    }
+
+                    if (_typeof(shiftHourlyEntriesItem) === 'object' && 'primaryIssueTag' in shiftHourlyEntriesItem) {
+                      shiftHourlyEntriesItemObject.primaryIssueTag = function () {
+                        if (shiftHourlyEntriesItem.primaryIssueTag === null) {
+                          return null;
+                        }
+
+                        if (typeof shiftHourlyEntriesItem.primaryIssueTag !== 'string') {
+                          return String(shiftHourlyEntriesItem.primaryIssueTag);
+                        }
+
+                        return shiftHourlyEntriesItem.primaryIssueTag;
+                      }();
+                    } else {
+                      shiftHourlyEntriesItemObject.primaryIssueTag = null;
+                    }
+
+                    if (_typeof(shiftHourlyEntriesItem) === 'object' && 'primaryIssuePercentage' in shiftHourlyEntriesItem) {
+                      shiftHourlyEntriesItemObject.primaryIssuePercentage = function () {
+                        if (shiftHourlyEntriesItem.primaryIssuePercentage === null) {
+                          return null;
+                        }
+
+                        if (typeof shiftHourlyEntriesItem.primaryIssuePercentage !== 'number') {
+                          return Number(shiftHourlyEntriesItem.primaryIssuePercentage);
+                        }
+
+                        return shiftHourlyEntriesItem.primaryIssuePercentage;
+                      }();
+                    } else {
+                      shiftHourlyEntriesItemObject.primaryIssuePercentage = null;
+                    }
+
+                    if (_typeof(shiftHourlyEntriesItem) === 'object' && 'secondaryIssueCategory' in shiftHourlyEntriesItem) {
+                      shiftHourlyEntriesItemObject.secondaryIssueCategory = function () {
+                        if (shiftHourlyEntriesItem.secondaryIssueCategory === null) {
+                          return null;
+                        }
+
+                        if (typeof shiftHourlyEntriesItem.secondaryIssueCategory !== 'string') {
+                          return String(shiftHourlyEntriesItem.secondaryIssueCategory);
+                        }
+
+                        return shiftHourlyEntriesItem.secondaryIssueCategory;
+                      }();
+                    } else {
+                      shiftHourlyEntriesItemObject.secondaryIssueCategory = null;
+                    }
+
+                    if (_typeof(shiftHourlyEntriesItem) === 'object' && 'secondaryIssueTag' in shiftHourlyEntriesItem) {
+                      shiftHourlyEntriesItemObject.secondaryIssueTag = function () {
+                        if (shiftHourlyEntriesItem.secondaryIssueTag === null) {
+                          return null;
+                        }
+
+                        if (typeof shiftHourlyEntriesItem.secondaryIssueTag !== 'string') {
+                          return String(shiftHourlyEntriesItem.secondaryIssueTag);
+                        }
+
+                        return shiftHourlyEntriesItem.secondaryIssueTag;
+                      }();
+                    } else {
+                      shiftHourlyEntriesItemObject.secondaryIssueTag = null;
+                    }
+
+                    if (_typeof(shiftHourlyEntriesItem) === 'object' && 'secondaryIssuePercentage' in shiftHourlyEntriesItem) {
+                      shiftHourlyEntriesItemObject.secondaryIssuePercentage = function () {
+                        if (shiftHourlyEntriesItem.secondaryIssuePercentage === null) {
+                          return null;
+                        }
+
+                        if (typeof shiftHourlyEntriesItem.secondaryIssuePercentage !== 'number') {
+                          return Number(shiftHourlyEntriesItem.secondaryIssuePercentage);
+                        }
+
+                        return shiftHourlyEntriesItem.secondaryIssuePercentage;
+                      }();
+                    } else {
+                      shiftHourlyEntriesItemObject.secondaryIssuePercentage = null;
+                    }
+
+                    if (_typeof(shiftHourlyEntriesItem) === 'object' && 'nextHourFocus' in shiftHourlyEntriesItem) {
+                      shiftHourlyEntriesItemObject.nextHourFocus = function () {
+                        if (shiftHourlyEntriesItem.nextHourFocus === null) {
+                          return null;
+                        }
+
+                        if (typeof shiftHourlyEntriesItem.nextHourFocus !== 'string') {
+                          return String(shiftHourlyEntriesItem.nextHourFocus);
+                        }
+
+                        return shiftHourlyEntriesItem.nextHourFocus;
+                      }();
+                    } else {
+                      shiftHourlyEntriesItemObject.nextHourFocus = null;
+                    }
+
                     return shiftHourlyEntriesItemObject;
                   }();
                 });
@@ -3829,6 +3953,7 @@ var _default = ProductionDataExportController;
  * @property {number} totalNetWeightTipped Total Net Fruit Weight Tipped during this Packrun
  * @property {number} averageNetWeightPerBin Average Net Fruit Weight per Bin for this Packrun
  * @property {number} averageBinsTippedPerHour Average Bins Tipped per Hour during this Packrun
+ * @property {number} averageBinsTippedPerHourExcludingDowntime Average Bins Tipped per Hour excluding Downtime during this Packrun
  * @property {number} averageTimePerTippedBin Average Time Taken in Seconds to Tip a Bin during this Packrun
  * @property {number} averageBinTipWeightThroughput Average Throughput in Kilograms per Hour for the Bin Tip during this Packrun
  * @property {number} softSortEventsPerBin Number of Soft-Sort Events per Bin Tipped during this Packrun
@@ -4053,6 +4178,13 @@ var _default = ProductionDataExportController;
  * @property {?number} averageClass1Percentage Average Class 1 Packout Percentage during this Hour
  * @property {?number} qualityR600IdealSamplesTarget Target Percentage of R600 Samples that should be in the Ideal Range for this Hour
  * @property {?number} qualityR600IdealSamplesActual Actual Percentage of R600 Samples that were in the Ideal Range during this Hour
+ * @property {?string} primaryIssueCategory Category of the Primary Issue that constrained throughput during this Hour
+ * @property {?string} primaryIssueTag Tag of the Primary Issue that constrained throughput during this Hour
+ * @property {?number} primaryIssuePercentage Percentage representing how much the Primary Issue constrained throughput during this Hour
+ * @property {?string} secondaryIssueCategory Category of the Secondary Issue that constrained throughput during this Hour
+ * @property {?string} secondaryIssueTag Tag of the Secondary Issue that constrained throughput during this Hour
+ * @property {?number} secondaryIssuePercentage Percentage representing how much the Secondary Issue constrained throughput during this Hour
+ * @property {?string} nextHourFocus An Optional Focus for the Next Hour based on experiences and review during this Hour
  * @memberof Controllers.Packhouse
  */
 

package/lib/Controllers/Packhouse/index.js

@@ -7,7 +7,9 @@ exports.default = void 0;
 
 var _ProductionDataExportController = _interopRequireDefault(require("./ProductionDataExportController"));
 
-var _index = _interopRequireDefault(require("./Site/index"));
+var _index = _interopRequireDefault(require("./Integrations/index"));
+
+var _index2 = _interopRequireDefault(require("./Site/index"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
@@ -22,7 +24,8 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  */
 var Packhouse = {
   ProductionDataExportController: _ProductionDataExportController.default,
-  Site: _index.default
+  Integrations: _index.default,
+  Site: _index2.default
 };
 var _default = Packhouse;
 exports.default = _default;

package/lib/PackageVersion.js

@@ -5,5 +5,5 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.version = void 0;
 // Generated by genversion.
-var version = '2.3.15';
+var version = '2.3.17';
 exports.version = version;

package/lib/index.d.ts

@@ -2168,9 +2168,11 @@ declare module '@ricado/api-client/Controllers/Packhouse' {
     export default Packhouse;
     namespace Packhouse {
         export { ProductionDataExportController };
+        export { Integrations };
         export { Site };
     }
     import ProductionDataExportController from "@ricado/api-client/Controllers/Packhouse/ProductionDataExportController";
+    import Integrations from "@ricado/api-client/Controllers/Packhouse/Integrations";
     import Site from "@ricado/api-client/Controllers/Packhouse/Site";
 }
 
@@ -3274,6 +3276,10 @@ declare module '@ricado/api-client/Controllers/Packhouse/ProductionDataExportCon
                         * Average Bins Tipped per Hour during this Packrun
                         */
                     averageBinsTippedPerHour: number;
+                    /**
+                        * Average Bins Tipped per Hour excluding Downtime during this Packrun
+                        */
+                    averageBinsTippedPerHourExcludingDowntime: number;
                     /**
                         * Average Time Taken in Seconds to Tip a Bin during this Packrun
                         */
@@ -4124,6 +4130,34 @@ declare module '@ricado/api-client/Controllers/Packhouse/ProductionDataExportCon
                         * Actual Percentage of R600 Samples that were in the Ideal Range during this Hour
                         */
                     qualityR600IdealSamplesActual: number | null;
+                    /**
+                        * Category of the Primary Issue that constrained throughput during this Hour
+                        */
+                    primaryIssueCategory: string | null;
+                    /**
+                        * Tag of the Primary Issue that constrained throughput during this Hour
+                        */
+                    primaryIssueTag: string | null;
+                    /**
+                        * Percentage representing how much the Primary Issue constrained throughput during this Hour
+                        */
+                    primaryIssuePercentage: number | null;
+                    /**
+                        * Category of the Secondary Issue that constrained throughput during this Hour
+                        */
+                    secondaryIssueCategory: string | null;
+                    /**
+                        * Tag of the Secondary Issue that constrained throughput during this Hour
+                        */
+                    secondaryIssueTag: string | null;
+                    /**
+                        * Percentage representing how much the Secondary Issue constrained throughput during this Hour
+                        */
+                    secondaryIssuePercentage: number | null;
+                    /**
+                        * An Optional Focus for the Next Hour based on experiences and review during this Hour
+                        */
+                    nextHourFocus: string | null;
             };
             /**
                 * A **DowntimeData** Type
@@ -4263,6 +4297,14 @@ declare module '@ricado/api-client/Controllers/Packhouse/ProductionDataExportCon
     }
 }
 
+declare module '@ricado/api-client/Controllers/Packhouse/Integrations' {
+    export default Integrations;
+    namespace Integrations {
+        export { ExternalShiftManagementController };
+    }
+    import ExternalShiftManagementController from "@ricado/api-client/Controllers/Packhouse/Integrations/ExternalShiftManagementController";
+}
+
 declare module '@ricado/api-client/Controllers/Packhouse/Site' {
     export default Site;
     namespace Site {
@@ -6538,6 +6580,64 @@ declare module '@ricado/api-client/Models/Site/TemporaryObjectModel' {
     import BaseModel from "@ricado/api-client/Models/BaseModel";
 }
 
+declare module '@ricado/api-client/Controllers/Packhouse/Integrations/ExternalShiftManagementController' {
+    export default ExternalShiftManagementController;
+    /**
+        * The External Shift Management Controller Class
+        *
+        * @class
+        */
+    class ExternalShiftManagementController {
+            /**
+                * Update Teams Head Count [POST /integrations/packhouse/external-shift-management/update-teams-headcount]
+                *
+                * Update the Current Shift Manning Head Count by Team for a given Packing Line
+                *
+                * @static
+                * @public
+                * @param {ExternalShiftManagementController.PackingLineTeamsHeadCount} objectData The Object Properties
+                * @return {Promise<boolean>}
+                */
+            static updateTeamsHeadCount(objectData: ExternalShiftManagementController.PackingLineTeamsHeadCount): Promise<boolean>;
+    }
+    namespace ExternalShiftManagementController {
+            /**
+                * A **TeamHeadCount** Type
+                */
+            export type TeamHeadCount = {
+                    /**
+                        * Name of the Team
+                        */
+                    team: string;
+                    /**
+                        * Number of People Present in the Team
+                        */
+                    count: number;
+            };
+            /**
+                * A **PackingLineTeamsHeadCount** Type
+                */
+            export type PackingLineTeamsHeadCount = {
+                    /**
+                        * Numeric ID of the RICADO Site
+                        */
+                    siteId: number;
+                    /**
+                        * UUID of the Packing Line
+                        */
+                    packingLineId: string;
+                    /**
+                        * An Array of Head Counts by Team
+                        */
+                    headCounts: TeamHeadCount[];
+                    /**
+                        * Timestamp of when this Head Count Data should be Applied
+                        */
+                    validAfterTimestamp: Date;
+            };
+    }
+}
+
 declare module '@ricado/api-client/Controllers/Packhouse/Site/BinTipBinCardController' {
     export default BinTipBinCardController;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ricado/api-client",
-    "version": "2.3.15",
+    "version": "2.3.17",
     "description": "RICADO Gen 4 API Client Library for NodeJS and Browsers",
     "author": {
         "name": "Ash Neilson"

package/src/Controllers/Packhouse/Integrations/ExternalShiftManagementController.js

@@ -0,0 +1,58 @@
+/**
+ * File Auto-Generated by the RICADO Gen 4 PHP API Project
+ * 
+ * Do Not Edit this File Manually!
+ */
+
+import RequestHelper from '../../../RequestHelper';
+
+/**
+ * The External Shift Management Controller Class
+ * 
+ * @class
+ */
+class ExternalShiftManagementController
+{
+    /**
+     * Update Teams Head Count [POST /integrations/packhouse/external-shift-management/update-teams-headcount]
+     * 
+     * Update the Current Shift Manning Head Count by Team for a given Packing Line
+     * 
+     * @static
+     * @public
+     * @param {ExternalShiftManagementController.PackingLineTeamsHeadCount} objectData The Object Properties
+     * @return {Promise<boolean>}
+     */
+    static updateTeamsHeadCount(objectData)
+    {
+        return new Promise((resolve, reject) => {
+            RequestHelper.postRequest(`/integrations/packhouse/external-shift-management/update-teams-headcount`, objectData)
+            .then((result) => {
+                resolve(result ?? true);
+            })
+            .catch(error => reject(error));
+        });
+    }
+}
+
+export default ExternalShiftManagementController;
+
+/**
+ * A **TeamHeadCount** Type
+ * 
+ * @typedef {Object} ExternalShiftManagementController.TeamHeadCount
+ * @property {string} team Name of the Team
+ * @property {number} count Number of People Present in the Team
+ * @memberof Controllers.Packhouse.Integrations
+ */
+
+/**
+ * A **PackingLineTeamsHeadCount** Type
+ * 
+ * @typedef {Object} ExternalShiftManagementController.PackingLineTeamsHeadCount
+ * @property {number} siteId Numeric ID of the RICADO Site
+ * @property {string} packingLineId UUID of the Packing Line
+ * @property {Array<ExternalShiftManagementController.TeamHeadCount>} headCounts An Array of Head Counts by Team
+ * @property {Date} validAfterTimestamp Timestamp of when this Head Count Data should be Applied
+ * @memberof Controllers.Packhouse.Integrations
+ */

package/src/Controllers/Packhouse/Integrations/index.js

@@ -0,0 +1,16 @@
+/**
+ * File Auto-Generated by the RICADO Gen 4 PHP API Project
+ * 
+ * Do Not Edit this File Manually!
+ */
+
+/**
+ * @namespace Controllers.Packhouse.Integrations
+ */
+import ExternalShiftManagementController from './ExternalShiftManagementController';
+
+const Integrations = {
+    ExternalShiftManagementController,
+};
+
+export default Integrations;