@ricado/api-client 2.1.0 → 2.3.0

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

@@ -162,6 +162,7 @@ export default PackingLineController;
  * @property {Object[]} [sizers] The Sizer Objects that belong to this Packing Line
  * @property {Object[]} [binTips] The Bin Tip Objects that belong to this this Packing Line
  * @property {Object[]} [rejectBinScales] The Reject Bin Scale Objects that belong to this Packing Line
+ * @property {?Object} [secondaryPackingLine] An Optional Secondary Packing Line Reference
  * @property {?Object} [automation] The Automation Object for this Packing Line
  * @property {string[]} [alarmGroups] The Alarm Groups that are used by this Packing Line
  * @property {Object[]} [classTypes] The Class Types that are defined for this Packing Line
@@ -180,6 +181,7 @@ export default PackingLineController;
  * @property {Object[]} [sizers] The Sizer Objects that belong to this Packing Line
  * @property {Object[]} [binTips] The Bin Tip Objects that belong to this this Packing Line
  * @property {Object[]} [rejectBinScales] The Reject Bin Scale Objects that belong to this Packing Line
+ * @property {?Object} [secondaryPackingLine] An Optional Secondary Packing Line Reference
  * @property {?Object} [automation] The Automation Object for this Packing Line
  * @property {string[]} [alarmGroups] The Alarm Groups that are used by this Packing Line
  * @property {Object[]} [classTypes] The Class Types that are defined for this Packing Line
@@ -189,11 +191,33 @@ export default PackingLineController;
  * @memberof Controllers.Packhouse.Site
  */
 
+/**
+ * A **ShiftTaskTagDefinition** Type
+ * 
+ * @typedef {Object} PackingLineController.ShiftTaskTagDefinition
+ * @property {string} id The Unique Tag ID
+ * @property {string} name The Tag Display Name
+ * @property {string} color The Tag Display Color
+ * @property {boolean} deleted Whether the Tag has been Deleted
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **ShiftTaskDefinition** Type
+ * 
+ * @typedef {Object} PackingLineController.ShiftTaskDefinition
+ * @property {string} type The Task Type
+ * @property {Array<PackingLineController.ShiftTaskTagDefinition>} tags An Array of Tags defined for the Task Type
+ * @memberof Controllers.Packhouse.Site
+ */
+
 /**
  * A **ShiftManagement** Type
  * 
  * @typedef {Object} PackingLineController.ShiftManagement
- * @property {{currentShiftId: number, createNewDayShiftRequest: number, createNewNightShiftRequest: number, startCurrentShiftRequest: number, finishCurrentShiftRequest: number, currentFocusMeetingId: number, startFocusMeetingRequest: number, finishFocusMeetingRequest: number, shiftSchedules: number}} points The Points used for Shift Management
+ * @property {{currentShiftId: number, createNewDayShiftRequest: number, createNewNightShiftRequest: number, startCurrentShiftRequest: number, finishCurrentShiftRequest: number, currentFocusMeetingId: number, startFocusMeetingRequest: number, finishFocusMeetingRequest: number, currentShiftStatus: number, currentShiftModifyHourlyEntryRequest: number, shiftSchedules: number, currentShiftClass1TraysPerHourTarget: number, currentShiftClass1TraysPerHourAdjustedTarget: number, currentShiftClass1TraysPerHour: number, currentShiftCostPerTrayTarget: number, currentShiftCostPerTrayAdjustedTarget: number, currentShiftCostPerTray: number, currentShiftManningTarget: number, currentShiftClass1Manning: number, currentShiftClass2Manning: number, currentShiftQualityR600IdealTarget: number, currentShiftQualityR600Ideal: number, currentShiftScorePercentage: number, class1TraysPerHourTargets: number, costPerTrayTargets: number, manningTargets: number, qualityR600IdealTargets: number, costPerManningUnitHour: number, class1TraysPerHourScoreWeighting: number, costPerTrayScoreWeighting: number, qualityR600IdealScoreWeighting: number}} points The Points used for Shift Management
+ * @property {Array<{id: string, name: string, type: string, points: {currentShiftCustomQualityTarget: number, currentShiftCustomQualityValue: number, customQualityTargets: number, customQualityScoreWeighting: number}}>} customQualityConfiguration An Optional Array of Configuration Data for Custom Qualities in Shift Management
  * @property {boolean} enabled Whether Shift Management is Enabled on this Packing Line
+ * @property {Array<PackingLineController.ShiftTaskDefinition>} taskDefinitions An Array of Shift Task Types for this Packing Line
  * @memberof Controllers.Packhouse.Site
  */

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

@@ -1915,6 +1915,48 @@ class PackrunController
                     {
                         resultObject.totalSoftSortEventsDuration = 0;
                     }
+                    
+                    if(typeof result === 'object' && 'softSortEventsIsAccurate' in result)
+                    {
+                        resultObject.softSortEventsIsAccurate = (function(){
+                            if(result.softSortEventsIsAccurate === null)
+                            {
+                                return null;
+                            }
+                
+                            if(typeof result.softSortEventsIsAccurate !== 'boolean')
+                            {
+                                return Boolean(result.softSortEventsIsAccurate);
+                            }
+                
+                            return result.softSortEventsIsAccurate;
+                        }());
+                    }
+                    else
+                    {
+                        resultObject.softSortEventsIsAccurate = null;
+                    }
+                    
+                    if(typeof result === 'object' && 'softSortEventsNotAccurateReason' in result)
+                    {
+                        resultObject.softSortEventsNotAccurateReason = (function(){
+                            if(result.softSortEventsNotAccurateReason === null)
+                            {
+                                return null;
+                            }
+                
+                            if(typeof result.softSortEventsNotAccurateReason !== 'string')
+                            {
+                                return String(result.softSortEventsNotAccurateReason);
+                            }
+                
+                            return result.softSortEventsNotAccurateReason;
+                        }());
+                    }
+                    else
+                    {
+                        resultObject.softSortEventsNotAccurateReason = null;
+                    }
                 
                     return resultObject;
                 }());
@@ -1996,6 +2038,8 @@ export default PackrunController;
  * @property {string} [maturityArea] The Maturity Area for this Packrun
  * @property {string} [varietyId] The Variety for this Packrun
  * @property {?string} [growingMethodId] The Growing Method for this Packrun
+ * @property {?number} [freshPackGraderId] The FreshPack Grader ID associated with this Packrun
+ * @property {?string} [freshPackBinLotCode] The FreshPack Bin Lot Code associated with this Packrun
  * @property {Date} [createdTimestampBegin] Filter by the Timestamp when this Packrun was Created. Results Greater than or Equal to Timestamp
  * @property {Date} [createdTimestampEnd] Filter by the Timestamp when this Packrun was Created. Results Less than or Equal to Timestamp
  * @property {Date} [startTimestampBegin] Filter by the Timestamp when this Packrun was Started. Results Greater than or Equal to Timestamp
@@ -2021,6 +2065,9 @@ export default PackrunController;
  * @property {?string} [growingMethodId] The Growing Method for this Packrun
  * @property {number} [allocatedBins] The Number of Allocated Bins for this Packrun
  * @property {Object[]} [timeBatches] The Time Batches for this Packrun
+ * @property {?number} [freshPackGraderId] The FreshPack Grader ID associated with this Packrun
+ * @property {?string} [freshPackBinLotCode] The FreshPack Bin Lot Code associated with this Packrun
+ * @property {?string} [freshPackProduceCode] The FreshPack Produce Code associated with this Packrun
  * @memberof Controllers.Packhouse.Site
  */
 
@@ -2039,6 +2086,9 @@ export default PackrunController;
  * @property {?string} [growingMethodId] The Growing Method for this Packrun
  * @property {number} [allocatedBins] The Number of Allocated Bins for this Packrun
  * @property {Object[]} [timeBatches] The Time Batches for this Packrun
+ * @property {?number} [freshPackGraderId] The FreshPack Grader ID associated with this Packrun
+ * @property {?string} [freshPackBinLotCode] The FreshPack Bin Lot Code associated with this Packrun
+ * @property {?string} [freshPackProduceCode] The FreshPack Produce Code associated with this Packrun
  * @memberof Controllers.Packhouse.Site
  */
 
@@ -2180,5 +2230,7 @@ export default PackrunController;
  * @property {number} totalSoftSortEventsCount The Number of Soft-Sort Events that occurred for the Packrun
  * @property {number} averageSoftSortEventsDuration The Average Duration of Soft-Sort Events for the Packrun expressed in Seconds
  * @property {number} totalSoftSortEventsDuration The Total Duration of all Soft-Sort Events for the Packrun expressed in Seconds
+ * @property {?boolean} softSortEventsIsAccurate Whether the Soft-Sort Events Data is considered accurate or not
+ * @property {?string} softSortEventsNotAccurateReason A Reason for why the Soft-Sort Events Data is not accurate. Applies when `softSortEventsIsAccurate` is false
  * @memberof Controllers.Packhouse.Site
  */

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

@@ -166,7 +166,18 @@ export default RejectBinScaleController;
  * @property {?string} [packrunSourceId] The Permanent Object that provides the Next Packrun for this Reject Bin Scale
  * @property {?number} [packrunGroup] The Packrun Group this Reject Bin Scale is a part of
  * @property {Object[]} [sources] An Array of Sources that deliver Fruit to this Reject Bin Scale
- * @property {?number} [autoPackrunChange] The Auto Packrun Change Configuration for this Reject Bin Scale
+ * @property {?{delay: ?number}} [autoPackrunChange] The Auto Packrun Change Configuration for this Reject Bin Scale
+ * @property {?boolean} [supportsLiveWeighing] Whether this Reject Bin Scale supports Live Weighing
+ * @property {?number} [autoWeighingStartThreshold] The Minimum Weight Change Required to Automatically Start Live Weighing
+ * @property {?number} [autoWeighingStartDelay] The Delay in Milliseconds before Auto Live Weighing would Start
+ * @property {?number} [autoWeighingFinishThreshold] The Minimum Weight Change Required to Automatically Finish Live Weighing
+ * @property {?number} [autoWeighingFinishDelay] The Delay in Milliseconds before Auto Live Weighing would Finish
+ * @property {?number} [manualInterventionMaximumDuration] The Maximum Duration in Milliseconds before a Manual Intervention would end
+ * @property {?number} [liveWeighingIncreaseTolerance] The Maximum Weight Increase allowed within a single Live Weighing Update Interval
+ * @property {?number} [liveWeighingDecreaseTolerance] The Maximum Weight Decrease allowed within a single Live Weighing Update Interval
+ * @property {?number} [liveWeighingUpdateInterval] The Interval in Milliseconds between Live Weighing Updates
+ * @property {?boolean} [liveWeighingUsesStableStatus] Whether the Loadcell Stable Status is used to ignore Changes during Live Weighing
+ * @property {?number} [incorrectOperationTolerance] The Maximum Weight Change allowed while Live Weighing before an Incorrect Operation is Logged
  * @property {?Object} [freshPackIntegration] The FreshPack Integration Configuration for this Reject Bin Scale
  * @memberof Controllers.Packhouse.Site
  */
@@ -181,7 +192,18 @@ export default RejectBinScaleController;
  * @property {?string} [packrunSourceId] The Permanent Object that provides the Next Packrun for this Reject Bin Scale
  * @property {?number} [packrunGroup] The Packrun Group this Reject Bin Scale is a part of
  * @property {Object[]} [sources] An Array of Sources that deliver Fruit to this Reject Bin Scale
- * @property {?number} [autoPackrunChange] The Auto Packrun Change Configuration for this Reject Bin Scale
+ * @property {?{delay: ?number}} [autoPackrunChange] The Auto Packrun Change Configuration for this Reject Bin Scale
+ * @property {?boolean} [supportsLiveWeighing] Whether this Reject Bin Scale supports Live Weighing
+ * @property {?number} [autoWeighingStartThreshold] The Minimum Weight Change Required to Automatically Start Live Weighing
+ * @property {?number} [autoWeighingStartDelay] The Delay in Milliseconds before Auto Live Weighing would Start
+ * @property {?number} [autoWeighingFinishThreshold] The Minimum Weight Change Required to Automatically Finish Live Weighing
+ * @property {?number} [autoWeighingFinishDelay] The Delay in Milliseconds before Auto Live Weighing would Finish
+ * @property {?number} [manualInterventionMaximumDuration] The Maximum Duration in Milliseconds before a Manual Intervention would end
+ * @property {?number} [liveWeighingIncreaseTolerance] The Maximum Weight Increase allowed within a single Live Weighing Update Interval
+ * @property {?number} [liveWeighingDecreaseTolerance] The Maximum Weight Decrease allowed within a single Live Weighing Update Interval
+ * @property {?number} [liveWeighingUpdateInterval] The Interval in Milliseconds between Live Weighing Updates
+ * @property {?boolean} [liveWeighingUsesStableStatus] Whether the Loadcell Stable Status is used to ignore Changes during Live Weighing
+ * @property {?number} [incorrectOperationTolerance] The Maximum Weight Change allowed while Live Weighing before an Incorrect Operation is Logged
  * @property {?Object} [freshPackIntegration] The FreshPack Integration Configuration for this Reject Bin Scale
  * @memberof Controllers.Packhouse.Site
  */

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

@@ -641,9 +641,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} [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} [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
  * @property {Array<ShiftHourlyEntryController.CustomQualityDataItem>} [customQualityData] An Array of Custom Quality Data Items for this Hour
  * @property {number} [totalBinsTipped] The Total Number of Bins Tipped for this Hour
  * @property {number} [binsTippedTarget] The Target Number of Bins to Tip for this Hour
@@ -652,10 +654,15 @@ 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} [averageCostPerTray] The Average Cost per Tray Equivalent for this Hour
+ * @property {?number} [averageCostPerTrayTarget] The Average Cost per Tray Equivalent Target 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
  * @property {?string} [secondaryIssueCategory] The Secondary Issue Category for this Hourly Entry
  * @property {?string} [secondaryIssueTag] The Secondary Issue Tag for this Hourly Entry
+ * @property {?number} [secondaryIssuePercentage] A Percentage between 0% and 100% indicating how much the Secondary Issue impacted Throughput for this Hourly Entry
  * @property {?string} [nextHourFocus] An Optional Focus for the Next Hour
  * @property {?number} [satisfactionRating] An Optional Rating between 1 and 10 on how Satisfied the Line Manager was with this Hour
  * @property {string} [status] The Status of this Hourly Entry
@@ -673,9 +680,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} [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} [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
  * @property {Array<ShiftHourlyEntryController.CustomQualityDataItem>} [customQualityData] An Array of Custom Quality Data Items for this Hour
  * @property {number} [totalBinsTipped] The Total Number of Bins Tipped for this Hour
  * @property {number} [binsTippedTarget] The Target Number of Bins to Tip for this Hour
@@ -684,10 +693,15 @@ 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} [averageCostPerTray] The Average Cost per Tray Equivalent for this Hour
+ * @property {?number} [averageCostPerTrayTarget] The Average Cost per Tray Equivalent Target 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
  * @property {?string} [secondaryIssueCategory] The Secondary Issue Category for this Hourly Entry
  * @property {?string} [secondaryIssueTag] The Secondary Issue Tag for this Hourly Entry
+ * @property {?number} [secondaryIssuePercentage] A Percentage between 0% and 100% indicating how much the Secondary Issue impacted Throughput for this Hourly Entry
  * @property {?string} [nextHourFocus] An Optional Focus for the Next Hour
  * @property {?number} [satisfactionRating] An Optional Rating between 1 and 10 on how Satisfied the Line Manager was with this Hour
  * @property {string} [status] The Status of this Hourly Entry
@@ -713,5 +727,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
  * @memberof Controllers.Packhouse.Site
  */