@ricado/api-client 2.3.9 → 2.3.12

package/src/Controllers/Packhouse/Site/PackrunController.js

@@ -1420,49 +1420,74 @@ class PackrunController
                 
                             return result.compacSizers.map((compacSizersItem) => {
                                 return (function(){
-                                    let compacSizersItemObject = {};
+                                    if(typeof compacSizersItem !== 'object')
+                                    {
+                                        return Object(compacSizersItem);
+                                    }
+                
+                                    return compacSizersItem;
+                                }());
+                            });
+                        }());
+                    }
+                    else
+                    {
+                        resultObject.compacSizers = [];
+                    }
+                    
+                    if(typeof result === 'object' && 'sizers' in result)
+                    {
+                        resultObject.sizers = (function(){
+                            if(Array.isArray(result.sizers) !== true)
+                            {
+                                return [];
+                            }
+                
+                            return result.sizers.map((sizersItem) => {
+                                return (function(){
+                                    let sizersItemObject = {};
                                     
-                                    if(typeof compacSizersItem === 'object' && 'id' in compacSizersItem)
+                                    if(typeof sizersItem === 'object' && 'id' in sizersItem)
                                     {
-                                        compacSizersItemObject.id = (function(){
-                                            if(typeof compacSizersItem.id !== 'string')
+                                        sizersItemObject.id = (function(){
+                                            if(typeof sizersItem.id !== 'string')
                                             {
-                                                return String(compacSizersItem.id);
+                                                return String(sizersItem.id);
                                             }
                 
-                                            return compacSizersItem.id;
+                                            return sizersItem.id;
                                         }());
                                     }
                                     else
                                     {
-                                        compacSizersItemObject.id = "";
+                                        sizersItemObject.id = "";
                                     }
                                     
-                                    if(typeof compacSizersItem === 'object' && 'name' in compacSizersItem)
+                                    if(typeof sizersItem === 'object' && 'name' in sizersItem)
                                     {
-                                        compacSizersItemObject.name = (function(){
-                                            if(typeof compacSizersItem.name !== 'string')
+                                        sizersItemObject.name = (function(){
+                                            if(typeof sizersItem.name !== 'string')
                                             {
-                                                return String(compacSizersItem.name);
+                                                return String(sizersItem.name);
                                             }
                 
-                                            return compacSizersItem.name;
+                                            return sizersItem.name;
                                         }());
                                     }
                                     else
                                     {
-                                        compacSizersItemObject.name = "";
+                                        sizersItemObject.name = "";
                                     }
                                     
-                                    if(typeof compacSizersItem === 'object' && 'batchSummaries' in compacSizersItem)
+                                    if(typeof sizersItem === 'object' && 'batchSummaries' in sizersItem)
                                     {
-                                        compacSizersItemObject.batchSummaries = (function(){
-                                            if(Array.isArray(compacSizersItem.batchSummaries) !== true)
+                                        sizersItemObject.batchSummaries = (function(){
+                                            if(Array.isArray(sizersItem.batchSummaries) !== true)
                                             {
                                                 return [];
                                             }
                 
-                                            return compacSizersItem.batchSummaries.map((batchSummariesItem) => {
+                                            return sizersItem.batchSummaries.map((batchSummariesItem) => {
                                                 return (function(){
                                                     let batchSummariesItemObject = {};
                                                     
@@ -1633,17 +1658,17 @@ class PackrunController
                                     }
                                     else
                                     {
-                                        compacSizersItemObject.batchSummaries = [];
+                                        sizersItemObject.batchSummaries = [];
                                     }
                 
-                                    return compacSizersItemObject;
+                                    return sizersItemObject;
                                 }());
                             });
                         }());
                     }
                     else
                     {
-                        resultObject.compacSizers = [];
+                        resultObject.sizers = [];
                     }
                     
                     if(typeof result === 'object' && 'rejectBinSummary' in result)
@@ -2502,14 +2527,14 @@ export default PackrunController;
  */
 
 /**
- * A **CompacSizerBatchSummaryItem** Type
+ * A **SizerBatchSummaryItem** Type
  * 
- * @typedef {Object} PackrunController.CompacSizerBatchSummaryItem
- * @property {string} id The Compac Sizer Batch ID
- * @property {number} number The Compac Sizer Batch Number
- * @property {string} name The Compac Sizer Batch Name
- * @property {string} varietyName The Compac Sizer Variety Name
- * @property {Date} timestamp The Compac Sizer Batch Timestamp
+ * @typedef {Object} PackrunController.SizerBatchSummaryItem
+ * @property {string} id The Sizer Batch ID
+ * @property {number} number The Sizer Batch Number
+ * @property {string} name The Sizer Batch Name
+ * @property {string} varietyName The Sizer Variety Name
+ * @property {Date} timestamp The Sizer Batch Timestamp
  * @property {number} totalFruitCount The Total Fruit Count for the Batch
  * @property {number} totalFruitWeight The Total Fruit Weight (kg) for the Batch
  * @property {number} recycleFruitCount The Recycled Fruit Count for the Batch
@@ -2519,12 +2544,12 @@ export default PackrunController;
  */
 
 /**
- * A **CompacSizerItem** Type
+ * A **SizerItem** Type
  * 
- * @typedef {Object} PackrunController.CompacSizerItem
- * @property {string} id The Compac Sizer ID
- * @property {string} name The Compac Sizer Name
- * @property {Array<PackrunController.CompacSizerBatchSummaryItem>} batchSummaries An Array of Summarized Batches for the Compac Sizer
+ * @typedef {Object} PackrunController.SizerItem
+ * @property {string} id The Sizer ID
+ * @property {string} name The Sizer Name
+ * @property {Array<PackrunController.SizerBatchSummaryItem>} batchSummaries An Array of Summarized Batches for the Sizer
  * @memberof Controllers.Packhouse.Site
  */
 
@@ -2547,7 +2572,8 @@ export default PackrunController;
  * @property {string} packingLineId The Packing Line ID
  * @property {?string} packingLineName The Packing Line Name
  * @property {Array<PackrunController.ClassTypeItem>} classTypes An Array of Class Types for the Packing Line
- * @property {Array<PackrunController.CompacSizerItem>} compacSizers 
+ * @property {Object[]} compacSizers *DEPRECATED* - An Array of Summarized Compac Sizer Data
+ * @property {Array<PackrunController.SizerItem>} sizers 
  * @property {Object} rejectBinSummary The Reject Bin Summary for the Packrun
  * @property {Object} binTipSummary The Bin Tip Summary for the Packrun
  * @property {Object[]} classTypeTotals An Array of Totals for each Class Type within the Packrun

package/src/Controllers/Packhouse/Site/ShiftController.js

@@ -891,6 +891,28 @@ class ShiftController
         });
     }
 
+    /**
+     * Retrieve a Shift Summary Report PDF [GET /packhouse/sites/{siteId}/shifts/{id}/summaryReportPdf]
+     * 
+     * Retrieves a Summary Report PDF for a Shift
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Shift ID
+     * @return {Promise<boolean>}
+     */
+    static getSummaryReportPdf(siteId, id)
+    {
+        return new Promise((resolve, reject) => {
+            RequestHelper.getRequest(`/packhouse/sites/${siteId}/shifts/${id}/summaryReportPdf`)
+            .then((result) => {
+                resolve(result ?? true);
+            })
+            .catch(error => reject(error));
+        });
+    }
+
     /**
      * List all Shifts [GET /packhouse/sites/{siteId}/shifts]
      * 

package/src/Controllers/Packhouse/Site/ShiftHourlyEntryController.js

@@ -985,8 +985,11 @@ export default ShiftHourlyEntryController;
  * @property {?number} [class1Manning] The Number of People working in all Areas except Class 2 for this Hour
  * @property {?number} [class2Manning] The Number of People working in the Class 2 Area for this Hour
  * @property {?number} [averageManningTarget] The Average Target Number of People that should be working for this Hour
+ * @property {?number} [averageClass1ManningTarget] The Average Target Number of People that should be working in all Areas except Class 2 for this Hour
+ * @property {?number} [averageClass2ManningTarget] The Average Target Number of People that should be working in the Class 2 Area for this Hour
  * @property {?number} [averageCostPerManningUnit] The Average Cost per Person working in all Areas for this Hour
- * @property {?number} [layeredTrayPercentage] The Percentage of Total Tray Equivalents that are Layered for this Hour
+ * @property {?number} [layeredTrayPercentage] The Actual Percentage of Total Tray Equivalents that are Layered for this Hour
+ * @property {?number} [layeredTrayPercentageTarget] The Target Percentage of Total Tray Equivalents that should be Layered for this Hour
  * @property {?number} [averageClass1Percentage] The Average Class 1 Percentage for this Hour
  * @property {?number} [qualityR600IdealSamplesPercentage] The Number of Quality R600 Samples that were Ideal for this Hour
  * @property {?number} [averageQualityR600IdealSamplesTarget] The Average Target Number of Quality R600 Samples that should be Ideal for this Hour
@@ -998,9 +1001,9 @@ export default ShiftHourlyEntryController;
  * @property {number} [totalClass1Trays] The Total Number of Class 1 Tray Equivalents Packed for this Hour
  * @property {number} [totalClass2Trays] The Total Number of Class 2 Tray Equivalents Packed for this Hour
  * @property {number} [class1TraysPerHourExcludingDowntimeTarget] The Target Number of Class 1 Tray Equivalents that should be Packed excluding all Downtime for this Hour
- * @property {?number} [averageClass1TraysPerHourAdjustedTarget] The Target Number of Class 1 Tray Equivalents that should be Packed after Adjustment (Manning %, Class 1 %, Soft-Sort %) for this Hour
+ * @property {?number} [averageClass1TraysPerHourAdjustedTarget] The Target Number of Class 1 Tray Equivalents that should be Packed after Adjustment (Manning %) for this Hour
  * @property {?number} [averageCostPerTray] The Average Cost per Tray Equivalent for this Hour
- * @property {?number} [averageCostPerTrayTarget] The Average Cost per Tray Equivalent Target for this Hour
+ * @property {?number} [averageCostPerTrayTarget] The Average Cost per Tray Equivalent Target after Adjustment (Class 1 %, Soft-Sort %) for this Hour
  * @property {?string} [primaryIssueCategory] The Primary Issue Category for this Hourly Entry
  * @property {?string} [primaryIssueTag] The Primary Issue Tag for this Hourly Entry
  * @property {?number} [primaryIssuePercentage] A Percentage between 0% and 100% indicating how much the Primary Issue impacted Throughput for this Hourly Entry
@@ -1024,8 +1027,11 @@ export default ShiftHourlyEntryController;
  * @property {?number} [class1Manning] The Number of People working in all Areas except Class 2 for this Hour
  * @property {?number} [class2Manning] The Number of People working in the Class 2 Area for this Hour
  * @property {?number} [averageManningTarget] The Average Target Number of People that should be working for this Hour
+ * @property {?number} [averageClass1ManningTarget] The Average Target Number of People that should be working in all Areas except Class 2 for this Hour
+ * @property {?number} [averageClass2ManningTarget] The Average Target Number of People that should be working in the Class 2 Area for this Hour
  * @property {?number} [averageCostPerManningUnit] The Average Cost per Person working in all Areas for this Hour
- * @property {?number} [layeredTrayPercentage] The Percentage of Total Tray Equivalents that are Layered for this Hour
+ * @property {?number} [layeredTrayPercentage] The Actual Percentage of Total Tray Equivalents that are Layered for this Hour
+ * @property {?number} [layeredTrayPercentageTarget] The Target Percentage of Total Tray Equivalents that should be Layered for this Hour
  * @property {?number} [averageClass1Percentage] The Average Class 1 Percentage for this Hour
  * @property {?number} [qualityR600IdealSamplesPercentage] The Number of Quality R600 Samples that were Ideal for this Hour
  * @property {?number} [averageQualityR600IdealSamplesTarget] The Average Target Number of Quality R600 Samples that should be Ideal for this Hour
@@ -1037,9 +1043,9 @@ export default ShiftHourlyEntryController;
  * @property {number} [totalClass1Trays] The Total Number of Class 1 Tray Equivalents Packed for this Hour
  * @property {number} [totalClass2Trays] The Total Number of Class 2 Tray Equivalents Packed for this Hour
  * @property {number} [class1TraysPerHourExcludingDowntimeTarget] The Target Number of Class 1 Tray Equivalents that should be Packed excluding all Downtime for this Hour
- * @property {?number} [averageClass1TraysPerHourAdjustedTarget] The Target Number of Class 1 Tray Equivalents that should be Packed after Adjustment (Manning %, Class 1 %, Soft-Sort %) for this Hour
+ * @property {?number} [averageClass1TraysPerHourAdjustedTarget] The Target Number of Class 1 Tray Equivalents that should be Packed after Adjustment (Manning %) for this Hour
  * @property {?number} [averageCostPerTray] The Average Cost per Tray Equivalent for this Hour
- * @property {?number} [averageCostPerTrayTarget] The Average Cost per Tray Equivalent Target for this Hour
+ * @property {?number} [averageCostPerTrayTarget] The Average Cost per Tray Equivalent Target after Adjustment (Class 1 %, Soft-Sort %) for this Hour
  * @property {?string} [primaryIssueCategory] The Primary Issue Category for this Hourly Entry
  * @property {?string} [primaryIssueTag] The Primary Issue Tag for this Hourly Entry
  * @property {?number} [primaryIssuePercentage] A Percentage between 0% and 100% indicating how much the Primary Issue impacted Throughput for this Hourly Entry
@@ -1082,6 +1088,6 @@ export default ShiftHourlyEntryController;
  * @property {string} name The Name of this Custom Quality Data Item
  * @property {string} type The Display Type for this Custom Quality Data Item
  * @property {number} value The Number Value for this Custom Quality Data Item
- * @property {number} averageTarget The Average Target for this Custom Quality Data Item
+ * @property {?number} averageTarget The Average Target for this Custom Quality Data Item
  * @memberof Controllers.Packhouse.Site
  */