@ricado/api-client 2.7.6 → 2.7.8

package/package.json

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

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

@@ -159,7 +159,7 @@ export default PackingLineController;
  * @property {?number} [rtuId] The RTU this Packing Line belongs to
  * @property {string} name The Packing Line Name
  * @property {string} [shortName] A Short Name for the Packing Line Name. Typically used in Reports and Tables showing multiple Packing Lines
- * @property {{currentPackrunId: number, nextPackrunId: number, currentPackrunName: number, nextPackrunName: number, currentPackrunVarietyCode: number, startNextPackrunRequest: number, finishCurrentPackrunRequest: number, availablePackrunList: number, createFromAvailablePackrun: number, currentTimeBatch: number, createNewTimeBatchRequest: number, currentPackrunExportPercentage: number, currentPackrunRejectPercentage: number, currentPackrunFruitSizeSummary: number, currentPackrunTotalExportTrays: number, currentPackrunExportTraysPerBin: number, currentPackrunAverageExportFruitSize: number, currentPackrunTotalClass1LayeredTrays: number, currentPackrunTotalClass1BulkTrays: number, currentPackrunTotalClass2Trays: number, currentPackrunSoftSortEventsPerBin: number, serviceModeActive: number, serviceModeBeginRequest: number, serviceModeFinishRequest: number, serviceModeStartTimestamp: number, serviceModeMaximumDuration: number, disabled: ?number, currentPackrunRecentPackrunSummaries: number, currentPackrunHistoricalPackrunSummaries: number, nextPackrunRecentPackrunSummaries: number, nextPackrunHistoricalPackrunSummaries: number}} points The Points used by this Packing Line
+ * @property {{currentPackrunId: number, nextPackrunId: number, currentPackrunName: number, nextPackrunName: number, currentPackrunVarietyCode: number, startNextPackrunRequest: number, finishCurrentPackrunRequest: number, availablePackrunList: number, createFromAvailablePackrun: number, currentTimeBatch: number, createNewTimeBatchRequest: number, currentPackrunExportPercentage: number, currentPackrunRejectPercentage: number, currentPackrunFruitSizeSummary: number, currentPackrunTotalExportTrays: number, currentPackrunExportTraysPerBin: number, currentPackrunAverageExportFruitSize: number, currentPackrunTotalClass1LayeredTrays: number, currentPackrunTotalClass1BulkTrays: number, currentPackrunTotalClass2Trays: number, currentPackrunSoftSortEventsPerBin: number, serviceModeActive: number, serviceModeBeginRequest: number, serviceModeFinishRequest: number, serviceModeStartTimestamp: number, serviceModeMaximumDuration: number, disabled: ?number, currentPackrunRecentPackrunSummaries: number, currentPackrunHistoricalPackrunSummaries: number, nextPackrunRecentPackrunSummaries: number, nextPackrunHistoricalPackrunSummaries: number, averageSecondsPerBin: ?number, estimatedPackrunTimestamps: ?number}} points The Points used by this Packing Line
  * @property {Array<PackingLineController.SizerReference>} [sizers] The Sizer Objects that belong to this Packing Line
  * @property {Array<PackingLineController.BinTipReference>} [binTips] The Bin Tip Objects that belong to this this Packing Line
  * @property {Array<PackingLineController.RejectBinScaleReference>} [rejectBinScales] The Reject Bin Scale Objects that belong to this Packing Line
@@ -172,6 +172,7 @@ export default PackingLineController;
  * @property {?PackingLineController.MafIntegration} [mafIntegration] The MAF Integration Configuration for this Packing Line
  * @property {?PackingLineController.FreshPackIntegration} [freshPackIntegration] The FreshPack Integration Configuration for this Packing Line
  * @property {?PackingLineController.FreshQualityIntegration} [freshQualityIntegration] The FreshQuality Integration Configuration for this Packing Line
+ * @property {?PackingLineController.GrowerNotifications} [growerNotifications] The Optional Grower Notifications Configuration for this Packing Line
  * @memberof Controllers.Packhouse.Site
  */
 
@@ -181,7 +182,7 @@ export default PackingLineController;
  * @typedef {Object} PackingLineController.UpdateData
  * @property {string} [name] The Packing Line Name
  * @property {string} [shortName] A Short Name for the Packing Line Name. Typically used in Reports and Tables showing multiple Packing Lines
- * @property {{currentPackrunId: number, nextPackrunId: number, currentPackrunName: number, nextPackrunName: number, currentPackrunVarietyCode: number, startNextPackrunRequest: number, finishCurrentPackrunRequest: number, availablePackrunList: number, createFromAvailablePackrun: number, currentTimeBatch: number, createNewTimeBatchRequest: number, currentPackrunExportPercentage: number, currentPackrunRejectPercentage: number, currentPackrunFruitSizeSummary: number, currentPackrunTotalExportTrays: number, currentPackrunExportTraysPerBin: number, currentPackrunAverageExportFruitSize: number, currentPackrunTotalClass1LayeredTrays: number, currentPackrunTotalClass1BulkTrays: number, currentPackrunTotalClass2Trays: number, currentPackrunSoftSortEventsPerBin: number, serviceModeActive: number, serviceModeBeginRequest: number, serviceModeFinishRequest: number, serviceModeStartTimestamp: number, serviceModeMaximumDuration: number, disabled: ?number, currentPackrunRecentPackrunSummaries: number, currentPackrunHistoricalPackrunSummaries: number, nextPackrunRecentPackrunSummaries: number, nextPackrunHistoricalPackrunSummaries: number}} [points] The Points used by this Packing Line
+ * @property {{currentPackrunId: number, nextPackrunId: number, currentPackrunName: number, nextPackrunName: number, currentPackrunVarietyCode: number, startNextPackrunRequest: number, finishCurrentPackrunRequest: number, availablePackrunList: number, createFromAvailablePackrun: number, currentTimeBatch: number, createNewTimeBatchRequest: number, currentPackrunExportPercentage: number, currentPackrunRejectPercentage: number, currentPackrunFruitSizeSummary: number, currentPackrunTotalExportTrays: number, currentPackrunExportTraysPerBin: number, currentPackrunAverageExportFruitSize: number, currentPackrunTotalClass1LayeredTrays: number, currentPackrunTotalClass1BulkTrays: number, currentPackrunTotalClass2Trays: number, currentPackrunSoftSortEventsPerBin: number, serviceModeActive: number, serviceModeBeginRequest: number, serviceModeFinishRequest: number, serviceModeStartTimestamp: number, serviceModeMaximumDuration: number, disabled: ?number, currentPackrunRecentPackrunSummaries: number, currentPackrunHistoricalPackrunSummaries: number, nextPackrunRecentPackrunSummaries: number, nextPackrunHistoricalPackrunSummaries: number, averageSecondsPerBin: ?number, estimatedPackrunTimestamps: ?number}} [points] The Points used by this Packing Line
  * @property {Array<PackingLineController.SizerReference>} [sizers] The Sizer Objects that belong to this Packing Line
  * @property {Array<PackingLineController.BinTipReference>} [binTips] The Bin Tip Objects that belong to this this Packing Line
  * @property {Array<PackingLineController.RejectBinScaleReference>} [rejectBinScales] The Reject Bin Scale Objects that belong to this Packing Line
@@ -194,6 +195,7 @@ export default PackingLineController;
  * @property {?PackingLineController.MafIntegration} [mafIntegration] The MAF Integration Configuration for this Packing Line
  * @property {?PackingLineController.FreshPackIntegration} [freshPackIntegration] The FreshPack Integration Configuration for this Packing Line
  * @property {?PackingLineController.FreshQualityIntegration} [freshQualityIntegration] The FreshQuality Integration Configuration for this Packing Line
+ * @property {?PackingLineController.GrowerNotifications} [growerNotifications] The Optional Grower Notifications Configuration for this Packing Line
  * @memberof Controllers.Packhouse.Site
  */
 
@@ -494,7 +496,7 @@ export default PackingLineController;
  * A **ShiftManagement** Type
  * 
  * @typedef {Object} PackingLineController.ShiftManagement
- * @property {{currentShiftId: number, currentShiftStatus: number, currentShiftBreakActive: ?number, createNewDayShiftRequest: number, createNewNightShiftRequest: number, startCurrentShiftRequest: number, finishCurrentShiftRequest: number, currentFocusMeetingId: number, startFocusMeetingRequest: number, finishFocusMeetingRequest: number, currentGrowerChangeMeetingId: number, startGrowerChangeMeetingRequest: number, finishGrowerChangeMeetingRequest: number, shiftSchedules: number, currentShiftModifyHourlyEntryRequest: number, currentShiftClass1TraysPerHourTarget: number, currentShiftClass1TraysPerHourAdjustedTarget: number, currentShiftClass1TraysPerHour: number, currentShiftCostPerTrayTarget: number, currentShiftCostPerTrayAdjustedTarget: number, currentShiftCostPerTray: number, currentShiftManningTarget: number, currentShiftClass1Manning: number, currentShiftClass2Manning: number, currentShiftClass1ManningTarget: number, currentShiftClass2ManningTarget: number, currentShiftQualityR600IdealTarget: number, currentShiftQualityR600Ideal: number, currentShiftScorePercentage: number, currentShiftTotalBinsTipped: ?number, currentShiftTotalClass1Trays: ?number, currentShiftTotalClass2Trays: ?number, currentShiftTotalDowntimePercentage: ?number, currentShiftTotalDowntimeSeconds: ?number, currentShiftTotalLayeredTraysPercentage: ?number, currentShiftAverageClass1TraysPerHour: ?number, currentShiftAverageCostPerTray: ?number, currentShiftAverageClass1Manning: ?number, currentShiftAverageClass2Manning: ?number, currentShiftAverageQualityR600Ideal: ?number, currentShiftAverageScorePercentage: ?number, currentShiftProjectedTotalBinsTipped: ?number, class1TraysPerHourTargets: number, class1TraysPerHourAdjustments: number, costPerTrayTargets: number, manningTargets: number, qualityR600IdealTargets: number, layeredTrayPercentageTargets: number, class1PercentageTargets: ?number, costPerManningUnitHour: number, class1TraysPerHourScoreWeighting: number, costPerTrayScoreWeighting: number, qualityR600IdealScoreWeighting: number, summaryReportEmailContacts: number, currentShiftUpdateManningTeamsRequest: ?number, currentShiftUpdateManningTeamsTimestamp: ?number, manningTeams: ?number}} points The Points used for Shift Management
+ * @property {{currentShiftId: number, currentShiftStatus: number, currentShiftBreakActive: ?number, createNewDayShiftRequest: number, createNewNightShiftRequest: number, startCurrentShiftRequest: number, finishCurrentShiftRequest: number, currentFocusMeetingId: number, startFocusMeetingRequest: number, finishFocusMeetingRequest: number, currentGrowerChangeMeetingId: number, startGrowerChangeMeetingRequest: number, finishGrowerChangeMeetingRequest: number, shiftSchedules: number, currentShiftModifyHourlyEntryRequest: number, currentShiftClass1TraysPerHourTarget: number, currentShiftClass1TraysPerHourAdjustedTarget: number, currentShiftClass1TraysPerHour: number, currentShiftCostPerTrayTarget: number, currentShiftCostPerTrayAdjustedTarget: number, currentShiftCostPerTray: number, currentShiftManningTarget: number, currentShiftClass1Manning: number, currentShiftClass2Manning: number, currentShiftClass1ManningTarget: number, currentShiftClass2ManningTarget: number, currentShiftQualityR600IdealTarget: number, currentShiftQualityR600Ideal: number, currentShiftScorePercentage: number, currentShiftTotalBinsTipped: ?number, currentShiftTotalClass1Trays: ?number, currentShiftTotalClass2Trays: ?number, currentShiftTotalDowntimePercentage: ?number, currentShiftTotalDowntimeSeconds: ?number, currentShiftTotalLayeredTraysPercentage: ?number, currentShiftAverageClass1TraysPerHour: ?number, currentShiftAverageCostPerTray: ?number, currentShiftAverageClass1Manning: ?number, currentShiftAverageClass2Manning: ?number, currentShiftAverageQualityR600Ideal: ?number, currentShiftAverageScorePercentage: ?number, currentShiftProjectedTotalBinsTipped: ?number, class1TraysPerHourTargets: number, class1TraysPerHourAdjustments: number, costPerTrayTargets: number, manningTargets: number, qualityR600IdealTargets: number, layeredTrayPercentageTargets: number, class1PercentageTargets: ?number, costPerManningUnitHour: number, class1TraysPerHourScoreWeighting: number, costPerTrayScoreWeighting: number, qualityR600IdealScoreWeighting: number, summaryReportEmailContacts: number, currentShiftUpdateManningTeamsRequest: ?number, currentShiftUpdateManningTeamsTimestamp: ?number, manningTeams: ?number, packrunChangeDurationTargets: ?number, currentShiftDowntimeActive: ?number, currentShiftPackrunChangeActive: ?number, currentShiftPackrunChangeSecondsTarget: ?number, currentShiftPackrunChangeSecondsElapsed: ?number}} points The Points used for Shift Management
  * @property {Array<{id: string, name: string, type: string, points: {currentShiftCustomQualityTarget: number, currentShiftCustomQualityValue: number, currentShiftCustomQualityAverageValue: ?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
@@ -656,4 +658,13 @@ export default PackingLineController;
  * @property {number[]} maturityAreaSampleTypeIds An Array of FreshQuality Sample Type IDs that should be fetched for Maturity Area Samples on this Packing Line
  * @property {number[]} customSampleTypeIds An Array of FreshQuality Sample Type IDs that should be fetched for Custom Samples on this Packing Line
  * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **GrowerNotifications** Type
+ * 
+ * @typedef {Object} PackingLineController.GrowerNotifications
+ * @property {{packingSoonAutoNotificationEnabled: number, packingSoonAutoNotificationSeconds: number, packingTodayAutoNotificationEnabled: number, packingTodayAutoNotificationTime: number, sendPackingTodayNotificationRequest: number, packingTodayNotificationProcessed: number, externalContactsCommunicationStatus: number, externalContactsCommunicationLastAttempt: number, externalContactsCommunicationLastError: number}} points The Points used for Grower Notifications
+ * @property {boolean} enabled Whether the Grower Notifications Integration is Enabled on this Packing Line
+ * @memberof Controllers.Packhouse.Site
  */

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

@@ -3411,6 +3411,7 @@ export default PackrunController;
  * @property {?string} [freshPackProduceCode] The FreshPack Produce Code associated with this Packrun
  * @property {?number} [freshPackPackingScheduleId] The FreshPack Packing Schedule ID associated with this Packrun
  * @property {?number} [freshPackInitialTippedBins] The Number of Tipped Bins reported in FreshPack when this Packrun was Initially Created
+ * @property {?Date} [freshPackScheduledTimestamp] The FreshPack Scheduled Timestamp for this Packrun
  * @memberof Controllers.Packhouse.Site
  */
 
@@ -3437,6 +3438,7 @@ export default PackrunController;
  * @property {?string} [freshPackProduceCode] The FreshPack Produce Code associated with this Packrun
  * @property {?number} [freshPackPackingScheduleId] The FreshPack Packing Schedule ID associated with this Packrun
  * @property {?number} [freshPackInitialTippedBins] The Number of Tipped Bins reported in FreshPack when this Packrun was Initially Created
+ * @property {?Date} [freshPackScheduledTimestamp] The FreshPack Scheduled Timestamp for this Packrun
  * @memberof Controllers.Packhouse.Site
  */