@ricado/api-client 2.7.6 → 2.7.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/ricado.api.client.js +1 -1
- package/lib/Controllers/Packhouse/Site/PackingLineController.js +14 -3
- package/lib/Controllers/Packhouse/Site/PackrunController.js +2 -0
- package/lib/Controllers/Packhouse/Site/PackrunGrowerNotificationController.js +940 -0
- package/lib/Controllers/Packhouse/Site/index.js +3 -0
- package/lib/Models/Packhouse/Site/PackingLineModel.js +283 -2
- package/lib/Models/Packhouse/Site/PackrunGrowerNotificationModel.js +669 -0
- package/lib/Models/Packhouse/Site/PackrunModel.js +22 -0
- package/lib/Models/Packhouse/Site/index.js +3 -0
- package/lib/PackageVersion.js +1 -1
- package/lib/index.d.ts +635 -2
- package/package.json +1 -1
- package/src/Controllers/Packhouse/Site/PackingLineController.js +14 -3
- package/src/Controllers/Packhouse/Site/PackrunController.js +2 -0
- package/src/Controllers/Packhouse/Site/PackrunGrowerNotificationController.js +1071 -0
- package/src/Controllers/Packhouse/Site/index.js +2 -0
- package/src/Models/Packhouse/Site/PackingLineModel.js +380 -2
- package/src/Models/Packhouse/Site/PackrunGrowerNotificationModel.js +763 -0
- package/src/Models/Packhouse/Site/PackrunModel.js +25 -0
- package/src/Models/Packhouse/Site/index.js +2 -0
- package/src/PackageVersion.js +1 -1
|
@@ -180,7 +180,7 @@ var _default = PackingLineController;
|
|
|
180
180
|
* @property {?number} [rtuId] The RTU this Packing Line belongs to
|
|
181
181
|
* @property {string} name The Packing Line Name
|
|
182
182
|
* @property {string} [shortName] A Short Name for the Packing Line Name. Typically used in Reports and Tables showing multiple Packing Lines
|
|
183
|
-
* @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
|
|
183
|
+
* @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
|
|
184
184
|
* @property {Array<PackingLineController.SizerReference>} [sizers] The Sizer Objects that belong to this Packing Line
|
|
185
185
|
* @property {Array<PackingLineController.BinTipReference>} [binTips] The Bin Tip Objects that belong to this this Packing Line
|
|
186
186
|
* @property {Array<PackingLineController.RejectBinScaleReference>} [rejectBinScales] The Reject Bin Scale Objects that belong to this Packing Line
|
|
@@ -193,6 +193,7 @@ var _default = PackingLineController;
|
|
|
193
193
|
* @property {?PackingLineController.MafIntegration} [mafIntegration] The MAF Integration Configuration for this Packing Line
|
|
194
194
|
* @property {?PackingLineController.FreshPackIntegration} [freshPackIntegration] The FreshPack Integration Configuration for this Packing Line
|
|
195
195
|
* @property {?PackingLineController.FreshQualityIntegration} [freshQualityIntegration] The FreshQuality Integration Configuration for this Packing Line
|
|
196
|
+
* @property {?PackingLineController.GrowerNotifications} [growerNotifications] The Optional Grower Notifications Configuration for this Packing Line
|
|
196
197
|
* @memberof Controllers.Packhouse.Site
|
|
197
198
|
*/
|
|
198
199
|
|
|
@@ -202,7 +203,7 @@ var _default = PackingLineController;
|
|
|
202
203
|
* @typedef {Object} PackingLineController.UpdateData
|
|
203
204
|
* @property {string} [name] The Packing Line Name
|
|
204
205
|
* @property {string} [shortName] A Short Name for the Packing Line Name. Typically used in Reports and Tables showing multiple Packing Lines
|
|
205
|
-
* @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
|
|
206
|
+
* @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
|
|
206
207
|
* @property {Array<PackingLineController.SizerReference>} [sizers] The Sizer Objects that belong to this Packing Line
|
|
207
208
|
* @property {Array<PackingLineController.BinTipReference>} [binTips] The Bin Tip Objects that belong to this this Packing Line
|
|
208
209
|
* @property {Array<PackingLineController.RejectBinScaleReference>} [rejectBinScales] The Reject Bin Scale Objects that belong to this Packing Line
|
|
@@ -215,6 +216,7 @@ var _default = PackingLineController;
|
|
|
215
216
|
* @property {?PackingLineController.MafIntegration} [mafIntegration] The MAF Integration Configuration for this Packing Line
|
|
216
217
|
* @property {?PackingLineController.FreshPackIntegration} [freshPackIntegration] The FreshPack Integration Configuration for this Packing Line
|
|
217
218
|
* @property {?PackingLineController.FreshQualityIntegration} [freshQualityIntegration] The FreshQuality Integration Configuration for this Packing Line
|
|
219
|
+
* @property {?PackingLineController.GrowerNotifications} [growerNotifications] The Optional Grower Notifications Configuration for this Packing Line
|
|
218
220
|
* @memberof Controllers.Packhouse.Site
|
|
219
221
|
*/
|
|
220
222
|
|
|
@@ -515,7 +517,7 @@ var _default = PackingLineController;
|
|
|
515
517
|
* A **ShiftManagement** Type
|
|
516
518
|
*
|
|
517
519
|
* @typedef {Object} PackingLineController.ShiftManagement
|
|
518
|
-
* @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
|
|
520
|
+
* @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
|
|
519
521
|
* @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
|
|
520
522
|
* @property {boolean} enabled Whether Shift Management is Enabled on this Packing Line
|
|
521
523
|
* @property {Array<PackingLineController.ShiftTaskDefinition>} taskDefinitions An Array of Shift Task Types for this Packing Line
|
|
@@ -679,4 +681,13 @@ var _default = PackingLineController;
|
|
|
679
681
|
* @memberof Controllers.Packhouse.Site
|
|
680
682
|
*/
|
|
681
683
|
|
|
684
|
+
/**
|
|
685
|
+
* A **GrowerNotifications** Type
|
|
686
|
+
*
|
|
687
|
+
* @typedef {Object} PackingLineController.GrowerNotifications
|
|
688
|
+
* @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
|
|
689
|
+
* @property {boolean} enabled Whether the Grower Notifications Integration is Enabled on this Packing Line
|
|
690
|
+
* @memberof Controllers.Packhouse.Site
|
|
691
|
+
*/
|
|
692
|
+
|
|
682
693
|
exports.default = _default;
|
|
@@ -2739,6 +2739,7 @@ var _default = PackrunController;
|
|
|
2739
2739
|
* @property {?string} [freshPackProduceCode] The FreshPack Produce Code associated with this Packrun
|
|
2740
2740
|
* @property {?number} [freshPackPackingScheduleId] The FreshPack Packing Schedule ID associated with this Packrun
|
|
2741
2741
|
* @property {?number} [freshPackInitialTippedBins] The Number of Tipped Bins reported in FreshPack when this Packrun was Initially Created
|
|
2742
|
+
* @property {?Date} [freshPackScheduledTimestamp] The FreshPack Scheduled Timestamp for this Packrun
|
|
2742
2743
|
* @memberof Controllers.Packhouse.Site
|
|
2743
2744
|
*/
|
|
2744
2745
|
|
|
@@ -2765,6 +2766,7 @@ var _default = PackrunController;
|
|
|
2765
2766
|
* @property {?string} [freshPackProduceCode] The FreshPack Produce Code associated with this Packrun
|
|
2766
2767
|
* @property {?number} [freshPackPackingScheduleId] The FreshPack Packing Schedule ID associated with this Packrun
|
|
2767
2768
|
* @property {?number} [freshPackInitialTippedBins] The Number of Tipped Bins reported in FreshPack when this Packrun was Initially Created
|
|
2769
|
+
* @property {?Date} [freshPackScheduledTimestamp] The FreshPack Scheduled Timestamp for this Packrun
|
|
2768
2770
|
* @memberof Controllers.Packhouse.Site
|
|
2769
2771
|
*/
|
|
2770
2772
|
|