@ricado/api-client 2.3.16 → 2.3.18

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.
Files changed (79) hide show
  1. package/dist/ricado.api.client.js +1 -1
  2. package/lib/Controllers/Packhouse/Integrations/ExternalShiftManagementController.js +76 -0
  3. package/lib/Controllers/Packhouse/Integrations/index.js +25 -0
  4. package/lib/Controllers/Packhouse/Site/BinTipBarcodeScannerController.js +198 -0
  5. package/lib/Controllers/Packhouse/Site/BinTipBinController.js +14 -2
  6. package/lib/Controllers/Packhouse/Site/CompacSizerBatchController.js +186 -2
  7. package/lib/Controllers/Packhouse/Site/CompacSizerBinWeightController.js +959 -0
  8. package/lib/Controllers/Packhouse/Site/CompacSizerController.js +89 -15
  9. package/lib/Controllers/Packhouse/Site/CompacSizerPackrunSummaryController.js +1 -1
  10. package/lib/Controllers/Packhouse/Site/FreshPackPackrunSummaryController.js +35 -4
  11. package/lib/Controllers/Packhouse/Site/MAFSizerController.js +101 -19
  12. package/lib/Controllers/Packhouse/Site/PackingLineController.js +435 -23
  13. package/lib/Controllers/Packhouse/Site/PackrunController.js +11 -2
  14. package/lib/Controllers/Packhouse/Site/RejectBinController.js +38 -2
  15. package/lib/Controllers/Packhouse/Site/RejectBinScaleController.js +52 -6
  16. package/lib/Controllers/Packhouse/Site/RejectBinWeightController.js +70 -4
  17. package/lib/Controllers/Packhouse/Site/ShiftController.js +1 -1
  18. package/lib/Controllers/Packhouse/Site/ShiftHourlyEntryController.js +15 -0
  19. package/lib/Controllers/Packhouse/Site/SoftSortBeltController.js +2 -2
  20. package/lib/Controllers/Packhouse/Site/SoftSortPackrunSummaryController.js +14 -2
  21. package/lib/Controllers/Packhouse/Site/index.js +6 -0
  22. package/lib/Controllers/Packhouse/index.js +5 -2
  23. package/lib/Models/Packhouse/Site/BinTipBarcodeScannerModel.js +263 -0
  24. package/lib/Models/Packhouse/Site/BinTipBinModel.js +75 -5
  25. package/lib/Models/Packhouse/Site/CompacSizerBatchModel.js +1276 -5
  26. package/lib/Models/Packhouse/Site/CompacSizerBinWeightModel.js +627 -0
  27. package/lib/Models/Packhouse/Site/CompacSizerModel.js +966 -72
  28. package/lib/Models/Packhouse/Site/FreshPackPackrunSummaryModel.js +260 -8
  29. package/lib/Models/Packhouse/Site/MAFSizerModel.js +660 -85
  30. package/lib/Models/Packhouse/Site/PackingLineModel.js +3860 -551
  31. package/lib/Models/Packhouse/Site/PackrunModel.js +26 -4
  32. package/lib/Models/Packhouse/Site/RejectBinModel.js +214 -4
  33. package/lib/Models/Packhouse/Site/RejectBinScaleModel.js +576 -14
  34. package/lib/Models/Packhouse/Site/RejectBinWeightModel.js +113 -9
  35. package/lib/Models/Packhouse/Site/ShiftHourlyEntryModel.js +98 -0
  36. package/lib/Models/Packhouse/Site/SoftSortBeltModel.js +50 -5
  37. package/lib/Models/Packhouse/Site/SoftSortPackrunSummaryModel.js +75 -5
  38. package/lib/Models/Packhouse/Site/index.js +6 -0
  39. package/lib/PackageVersion.js +1 -1
  40. package/lib/index.d.ts +6146 -2111
  41. package/package.json +1 -1
  42. package/src/Controllers/Packhouse/Integrations/ExternalShiftManagementController.js +58 -0
  43. package/src/Controllers/Packhouse/Integrations/index.js +16 -0
  44. package/src/Controllers/Packhouse/Site/BinTipBarcodeScannerController.js +175 -0
  45. package/src/Controllers/Packhouse/Site/BinTipBinController.js +14 -2
  46. package/src/Controllers/Packhouse/Site/CompacSizerBatchController.js +186 -2
  47. package/src/Controllers/Packhouse/Site/CompacSizerBinWeightController.js +1090 -0
  48. package/src/Controllers/Packhouse/Site/CompacSizerController.js +89 -15
  49. package/src/Controllers/Packhouse/Site/CompacSizerPackrunSummaryController.js +1 -1
  50. package/src/Controllers/Packhouse/Site/FreshPackPackrunSummaryController.js +35 -4
  51. package/src/Controllers/Packhouse/Site/MAFSizerController.js +101 -19
  52. package/src/Controllers/Packhouse/Site/PackingLineController.js +435 -23
  53. package/src/Controllers/Packhouse/Site/PackrunController.js +11 -2
  54. package/src/Controllers/Packhouse/Site/RejectBinController.js +38 -2
  55. package/src/Controllers/Packhouse/Site/RejectBinScaleController.js +52 -6
  56. package/src/Controllers/Packhouse/Site/RejectBinWeightController.js +70 -4
  57. package/src/Controllers/Packhouse/Site/ShiftController.js +1 -1
  58. package/src/Controllers/Packhouse/Site/ShiftHourlyEntryController.js +15 -0
  59. package/src/Controllers/Packhouse/Site/SoftSortBeltController.js +2 -2
  60. package/src/Controllers/Packhouse/Site/SoftSortPackrunSummaryController.js +14 -2
  61. package/src/Controllers/Packhouse/Site/index.js +4 -0
  62. package/src/Controllers/Packhouse/index.js +2 -0
  63. package/src/Models/Packhouse/Site/BinTipBarcodeScannerModel.js +252 -0
  64. package/src/Models/Packhouse/Site/BinTipBinModel.js +97 -5
  65. package/src/Models/Packhouse/Site/CompacSizerBatchModel.js +1682 -5
  66. package/src/Models/Packhouse/Site/CompacSizerBinWeightModel.js +715 -0
  67. package/src/Models/Packhouse/Site/CompacSizerModel.js +1319 -109
  68. package/src/Models/Packhouse/Site/FreshPackPackrunSummaryModel.js +339 -8
  69. package/src/Models/Packhouse/Site/MAFSizerModel.js +869 -92
  70. package/src/Models/Packhouse/Site/PackingLineModel.js +5086 -671
  71. package/src/Models/Packhouse/Site/PackrunModel.js +33 -4
  72. package/src/Models/Packhouse/Site/RejectBinModel.js +280 -4
  73. package/src/Models/Packhouse/Site/RejectBinScaleModel.js +775 -15
  74. package/src/Models/Packhouse/Site/RejectBinWeightModel.js +147 -10
  75. package/src/Models/Packhouse/Site/ShiftHourlyEntryModel.js +120 -0
  76. package/src/Models/Packhouse/Site/SoftSortBeltModel.js +65 -5
  77. package/src/Models/Packhouse/Site/SoftSortPackrunSummaryModel.js +97 -5
  78. package/src/Models/Packhouse/Site/index.js +4 -0
  79. package/src/PackageVersion.js +1 -1
@@ -149,8 +149,8 @@ export default CompacSizerController;
149
149
  * @typedef {Object} CompacSizerController.GetAllQueryParameters
150
150
  * @property {?number} [rtuId] The RTU this Compac Sizer belongs to
151
151
  * @property {string} [name] The Compac Sizer Name
152
- * @property {string} [sizerType] The Sizer Type
153
152
  * @property {string} [packingLineId] The Packing Line ID that manages this Compac Sizer
153
+ * @property {string} [sizerType] The Sizer Type
154
154
  * @memberof Controllers.Packhouse.Site
155
155
  */
156
156
 
@@ -160,15 +160,16 @@ export default CompacSizerController;
160
160
  * @typedef {Object} CompacSizerController.CreateData
161
161
  * @property {?number} [rtuId] The RTU this Compac Sizer belongs to
162
162
  * @property {string} name The Compac Sizer Name
163
- * @property {Object[]} [lanes] The Lanes defined for this Compac Sizer
164
- * @property {Object} points The Points used by this Compac Sizer
165
- * @property {Object[]} [outlets] The Outlets defined for this Compac Sizer
163
+ * @property {string} packingLineId The Packing Line ID that manages this Compac Sizer
166
164
  * @property {string} sizerType The Sizer Type
167
165
  * @property {number} [autoCreateBatchDelay] The Auto Create Batch Delay in Seconds for this Compac Sizer
168
- * @property {Object[]} [fruitSizes] The Fruit Sizes defined and handled by this Compac Sizer
169
- * @property {string} packingLineId The Packing Line ID that manages this Compac Sizer
170
- * @property {?Object} [freshPackIntegration] The FreshPack Integration Configuration for this Compac Sizer
171
- * @property {Object[]} [sources] An Array of Sources that deliver Fruit to this Compac Sizer
166
+ * @property {{currentBatchId: number, currentBatchName: number, currentBatchGrowerCode: number, currentBatchVarietyId: number, currentBatchVarietyName: number, currentBatchComments: number, currentBatchStartTimestamp: number, currentBatchLayoutId: number, currentBatchLayoutName: number, currentBatchSizingProfileName: ?number, currentBatchFruitSizeProfile: ?number, machineAverageFruitWeight: number, machineAverageFruitSize: number, machineCupFill: number, machineRecycledFruitPerMinute: number, machineTotalFruitPerMinute: number, machineDroppedFruitPerMinute: number, machinePackedFruitPerMinute: number, machineMissedFruitPerMinute: number, machineRejectFruitPerMinute: number, machineTraysPerHour: number, machineTraysPerHourTarget: ?number, machineTonnesPerHour: number, machineRodsPerMinute: number, machineIncomingFruitPerMinuteBySize: ?number, machineRecycleFruitPerMinuteBySize: ?number, machineLanesFruitPerMinuteBySize: ?number, machineLanesFruitPerMinuteByGrade: ?number, createNewBatchRequest: number, createBatchOnPackrunChange: number, createBatchOnTimeBatchChange: number, restartServiceRequest: number, outletGroupSummaries: number, varieties: number, packTypeOutletUtilizationTargets: number}} points The Points used by this Compac Sizer
167
+ * @property {Array<CompacSizerController.CompacSizerLane>} [lanes] The Lanes defined for this Compac Sizer
168
+ * @property {Array<CompacSizerController.CompacSizerFrame>} [frames] An Optional Array of Frames defined for this Compac Sizer
169
+ * @property {Array<CompacSizerController.CompacSizerOutlet>} [outlets] The Outlets defined for this Compac Sizer
170
+ * @property {Array<CompacSizerController.CompacSizerFruitSize>} [fruitSizes] The Fruit Sizes defined and handled by this Compac Sizer
171
+ * @property {?CompacSizerController.FreshPackCompacSizerIntegration} [freshPackIntegration] The FreshPack Integration Configuration for this Compac Sizer
172
+ * @property {CompacSizerController.RiserSource|CompacSizerController.SizerSource[]} [sources] An Array of Sources that deliver Fruit to this Compac Sizer
172
173
  * @memberof Controllers.Packhouse.Site
173
174
  */
174
175
 
@@ -177,14 +178,87 @@ export default CompacSizerController;
177
178
  *
178
179
  * @typedef {Object} CompacSizerController.UpdateData
179
180
  * @property {string} [name] The Compac Sizer Name
180
- * @property {Object[]} [lanes] The Lanes defined for this Compac Sizer
181
- * @property {Object} [points] The Points used by this Compac Sizer
182
- * @property {Object[]} [outlets] The Outlets defined for this Compac Sizer
181
+ * @property {string} [packingLineId] The Packing Line ID that manages this Compac Sizer
183
182
  * @property {string} [sizerType] The Sizer Type
184
183
  * @property {number} [autoCreateBatchDelay] The Auto Create Batch Delay in Seconds for this Compac Sizer
185
- * @property {Object[]} [fruitSizes] The Fruit Sizes defined and handled by this Compac Sizer
186
- * @property {string} [packingLineId] The Packing Line ID that manages this Compac Sizer
187
- * @property {?Object} [freshPackIntegration] The FreshPack Integration Configuration for this Compac Sizer
188
- * @property {Object[]} [sources] An Array of Sources that deliver Fruit to this Compac Sizer
184
+ * @property {{currentBatchId: number, currentBatchName: number, currentBatchGrowerCode: number, currentBatchVarietyId: number, currentBatchVarietyName: number, currentBatchComments: number, currentBatchStartTimestamp: number, currentBatchLayoutId: number, currentBatchLayoutName: number, currentBatchSizingProfileName: ?number, currentBatchFruitSizeProfile: ?number, machineAverageFruitWeight: number, machineAverageFruitSize: number, machineCupFill: number, machineRecycledFruitPerMinute: number, machineTotalFruitPerMinute: number, machineDroppedFruitPerMinute: number, machinePackedFruitPerMinute: number, machineMissedFruitPerMinute: number, machineRejectFruitPerMinute: number, machineTraysPerHour: number, machineTraysPerHourTarget: ?number, machineTonnesPerHour: number, machineRodsPerMinute: number, machineIncomingFruitPerMinuteBySize: ?number, machineRecycleFruitPerMinuteBySize: ?number, machineLanesFruitPerMinuteBySize: ?number, machineLanesFruitPerMinuteByGrade: ?number, createNewBatchRequest: number, createBatchOnPackrunChange: number, createBatchOnTimeBatchChange: number, restartServiceRequest: number, outletGroupSummaries: number, varieties: number, packTypeOutletUtilizationTargets: number}} [points] The Points used by this Compac Sizer
185
+ * @property {Array<CompacSizerController.CompacSizerLane>} [lanes] The Lanes defined for this Compac Sizer
186
+ * @property {Array<CompacSizerController.CompacSizerFrame>} [frames] An Optional Array of Frames defined for this Compac Sizer
187
+ * @property {Array<CompacSizerController.CompacSizerOutlet>} [outlets] The Outlets defined for this Compac Sizer
188
+ * @property {Array<CompacSizerController.CompacSizerFruitSize>} [fruitSizes] The Fruit Sizes defined and handled by this Compac Sizer
189
+ * @property {?CompacSizerController.FreshPackCompacSizerIntegration} [freshPackIntegration] The FreshPack Integration Configuration for this Compac Sizer
190
+ * @property {CompacSizerController.RiserSource|CompacSizerController.SizerSource[]} [sources] An Array of Sources that deliver Fruit to this Compac Sizer
191
+ * @memberof Controllers.Packhouse.Site
192
+ */
193
+
194
+ /**
195
+ * A **CompacSizerLane** Type
196
+ *
197
+ * @typedef {Object} CompacSizerController.CompacSizerLane
198
+ * @property {string} id Unique ID of this Lane
199
+ * @property {number} number The Lane Number
200
+ * @property {{cupFill: number}} points The Points used by this Lane
201
+ * @memberof Controllers.Packhouse.Site
202
+ */
203
+
204
+ /**
205
+ * A **CompacSizerFrame** Type
206
+ *
207
+ * @typedef {Object} CompacSizerController.CompacSizerFrame
208
+ * @property {number} number The Frame Number
209
+ * @property {number} startLane Lane Number where this Frame Begins
210
+ * @property {number} endLane Lane Number where this Frame Ends
211
+ * @property {{machineRodsPerMinute: number}} points The Points used by this Frame
212
+ * @memberof Controllers.Packhouse.Site
213
+ */
214
+
215
+ /**
216
+ * A **CompacSizerOutlet** Type
217
+ *
218
+ * @typedef {Object} CompacSizerController.CompacSizerOutlet
219
+ * @property {string} id Unique ID of this Outlet
220
+ * @property {number} number The Outlet Number
221
+ * @property {string} type The Outlet Type
222
+ * @property {{name: number, fruitPerMinute: number, productId: number, productName: number, utilization: number, status: number, pendingProductId: number, pendingProductName: number}} points The Points used by this Outlet
223
+ * @memberof Controllers.Packhouse.Site
224
+ */
225
+
226
+ /**
227
+ * A **CompacSizerFruitSize** Type
228
+ *
229
+ * @typedef {Object} CompacSizerController.CompacSizerFruitSize
230
+ * @property {string} fruitSize The Fruit Size
231
+ * @property {{incomingFruitPerMinute: number, recycledFruitPerMinute: number, allocatedFruitPerMinute: number}} points The Points used by this Fruit Size Configuration
232
+ * @memberof Controllers.Packhouse.Site
233
+ */
234
+
235
+ /**
236
+ * A **FreshPackCompacSizerIntegration** Type
237
+ *
238
+ * @typedef {Object} CompacSizerController.FreshPackCompacSizerIntegration
239
+ * @property {Object} points The Points used by this FreshPack Sizer Integration
240
+ * @property {boolean} enabled Whether this FreshPack Sizer Integration is Enabled
241
+ * @property {number} materialGroupId The FreshPack Material Group ID to be used for Multi-Grower Bins from this Sizer
242
+ * @property {number} binTypeId The FreshPack Bin Type ID to be used for Multi-Grower Bins from this Sizer
243
+ * @property {string[]} bulkWeightClassTypes An Array of Class Types that should be Sent to FreshPack as Bulk Weights in Multi-Grower Bins
244
+ * @memberof Controllers.Packhouse.Site
245
+ */
246
+
247
+ /**
248
+ * A **RiserSource** Type
249
+ *
250
+ * @typedef {Object} CompacSizerController.RiserSource
251
+ * @property {string} type The Source Type
252
+ * @property {string} riserId ID of the Riser Object
253
+ * @memberof Controllers.Packhouse.Site
254
+ */
255
+
256
+ /**
257
+ * A **SizerSource** Type
258
+ *
259
+ * @typedef {Object} CompacSizerController.SizerSource
260
+ * @property {string} type The Source Type
261
+ * @property {string} sizerId ID of the Sizer Object
262
+ * @property {number[]} outletNumbers An Array of Outlet Numbers on the Source Sizer that supply this Compac Sizer
189
263
  * @memberof Controllers.Packhouse.Site
190
264
  */
@@ -1058,7 +1058,7 @@ export default CompacSizerPackrunSummaryController;
1058
1058
  * @property {number} outletNumber The Outlet Number
1059
1059
  * @property {string} productId The new Product ID that has been assigned to the Outlet
1060
1060
  * @property {?string} productName The Name of the new Product that has been assigned to the Outlet
1061
- * @property {string} outletProductChangeId The ID of the associated *Compac Sizer Outlet Product Change*
1061
+ * @property {string} outletProductChangeId The ID of the associated Compac Sizer Outlet Product Change*
1062
1062
  * @memberof Controllers.Packhouse.Site
1063
1063
  */
1064
1064
 
@@ -971,8 +971,8 @@ export default FreshPackPackrunSummaryController;
971
971
  * @property {string} [packrunId] The Packrun ID this Summary is associated with
972
972
  * @property {Date} [createdTimestamp] When this Summary was Created
973
973
  * @property {?string} [timeBatchId] The Time Batch this Summary is associated with
974
- * @property {Object[]} [traySummaries] An Array of Tray Summary Data Objects for all Sizes and Class Types
975
- * @property {Object[]} [clearanceSummaries] An Array of Clearance Summary Data Objects for all Sizes
974
+ * @property {Array<FreshPackPackrunSummaryController.TraySummary>} [traySummaries] An Array of Tray Summary Data Objects for all Sizes and Class Types
975
+ * @property {Array<FreshPackPackrunSummaryController.ClearanceSummary>} [clearanceSummaries] An Array of Clearance Summary Data Objects for all Sizes
976
976
  * @memberof Controllers.Packhouse.Site
977
977
  */
978
978
 
@@ -983,8 +983,8 @@ export default FreshPackPackrunSummaryController;
983
983
  * @property {string} [packingLineId] The Packing Line ID this Summary is associated with
984
984
  * @property {Date} [createdTimestamp] When this Summary was Created
985
985
  * @property {?string} [timeBatchId] The Time Batch this Summary is associated with
986
- * @property {Object[]} [traySummaries] An Array of Tray Summary Data Objects for all Sizes and Class Types
987
- * @property {Object[]} [clearanceSummaries] An Array of Clearance Summary Data Objects for all Sizes
986
+ * @property {Array<FreshPackPackrunSummaryController.TraySummary>} [traySummaries] An Array of Tray Summary Data Objects for all Sizes and Class Types
987
+ * @property {Array<FreshPackPackrunSummaryController.ClearanceSummary>} [clearanceSummaries] An Array of Clearance Summary Data Objects for all Sizes
988
988
  * @memberof Controllers.Packhouse.Site
989
989
  */
990
990
 
@@ -1008,4 +1008,35 @@ export default FreshPackPackrunSummaryController;
1008
1008
  * @property {?Date} createdTimestamp When the Comment was Created
1009
1009
  * @property {?Date} updatedTimestamp When the Comment was last Updated
1010
1010
  * @memberof Controllers.Packhouse.Site
1011
+ */
1012
+
1013
+ /**
1014
+ * A **TraySummary** Type
1015
+ *
1016
+ * @typedef {Object} FreshPackPackrunSummaryController.TraySummary
1017
+ * @property {string} classType The Class Type of this Tray Summary
1018
+ * @property {?string} fruitSize The Fruit Size of this Tray Summary
1019
+ * @property {number} trayCount Total Number of Tray Equivalents
1020
+ * @property {number} averageTrayWeight Average Tray Weight in Kilograms
1021
+ * @property {number} weight The Total Fruit Weight in Kilograms for this Tray Summary
1022
+ * @memberof Controllers.Packhouse.Site
1023
+ */
1024
+
1025
+ /**
1026
+ * A **ClearanceSummary** Type
1027
+ *
1028
+ * @typedef {Object} FreshPackPackrunSummaryController.ClearanceSummary
1029
+ * @property {?string} fruitSize The Fruit Size of this Clearance Summary
1030
+ * @property {?string} tasteBand Taste Band (e.g. Y, T, M, R, L)
1031
+ * @property {?string} maturityProtocol The Maturity Protocol (since Harvesting) of this Fruit Size (e.g. A, B, C, N)
1032
+ * @property {?string} harvestProtocol The Protocol (at Harvest) of this Fruit Size
1033
+ * @property {?Date} clearanceDate When this Fruit Size met the Clearance Criteria. Will be `null` if this Fruit Size has not Cleared
1034
+ * @property {?Date} kiwiStartDate The Kiwi-Start Date for this Fruit Size
1035
+ * @property {?number} trayEstimate The Estimated Number of Tray Equivalents for this Fruit Size
1036
+ * @property {?Date} protocolADate Estimated or Actual Date when this Fruit Size will reach Protocol A Maturity
1037
+ * @property {?Date} protocolBDate Estimated or Actual Date when this Fruit Size will reach Protocol B Maturity
1038
+ * @property {?Date} protocolCDate Estimated or Actual Date when this Fruit Size will reach Protocol C Maturity
1039
+ * @property {?Date} protocolNDate Estimated or Actual Date when this Fruit Size will reach Protocol N Maturity
1040
+ * @property {?boolean} useNIRPacking Whether NIR Packing should be utilized for this Fruit Size
1041
+ * @memberof Controllers.Packhouse.Site
1011
1042
  */
@@ -149,8 +149,8 @@ export default MAFSizerController;
149
149
  * @typedef {Object} MAFSizerController.GetAllQueryParameters
150
150
  * @property {?number} [rtuId] The RTU this MAF Sizer belongs to
151
151
  * @property {string} [name] The MAF Sizer Name
152
- * @property {string} [sizerType] The Sizer Type
153
152
  * @property {string} [packingLineId] The Packing Line ID that manages this MAF Sizer
153
+ * @property {string} [sizerType] The Sizer Type
154
154
  * @memberof Controllers.Packhouse.Site
155
155
  */
156
156
 
@@ -160,17 +160,17 @@ export default MAFSizerController;
160
160
  * @typedef {Object} MAFSizerController.CreateData
161
161
  * @property {?number} [rtuId] The RTU this MAF Sizer belongs to
162
162
  * @property {string} name The MAF Sizer Name
163
- * @property {Object[]} [lanes] The Lanes defined for this MAF Sizer
164
- * @property {Object} points The Points used by this MAF Sizer
165
- * @property {Object[]} [outlets] The Outlets defined for this MAF Sizer
163
+ * @property {string} packingLineId The Packing Line ID that manages this MAF Sizer
166
164
  * @property {string} sizerType The Sizer Type
167
165
  * @property {number} [autoCreateBatchDelay] The Auto Create Batch Delay in Seconds for this MAF Sizer
168
- * @property {Object[]} [fruitSizes] The Fruit Sizes defined and handled by this MAF Sizer
169
- * @property {string} packingLineId The Packing Line ID that manages this MAF Sizer
170
- * @property {?Object} [freshPackIntegration] The FreshPack Integration Configuration for this MAF Sizer
171
- * @property {?Object} [mafIntegration] The MAF Integration Configuration for this MAF Sizer
172
- * @property {Object[]} [sources] An Array of Sources that deliver Fruit to this MAF Sizer
173
- * @property {Object[]} [articleClassTypes] An Array of Article to Class Type Maps for this MAF Sizer
166
+ * @property {{currentBatchId: number, currentBatchName: number, currentBatchGrowerCode: number, currentBatchGrowerName: number, currentBatchVarietyCode: number, currentBatchVarietyName: number, machineAverageFruitWeight: number, machineAverageFruitSize: number, machineCupFill: number, machineRecycledFruitPerMinute: number, machineTotalFruitPerMinute: number, machineTraysPerHour: number, machineTonnesPerHour: number, machineRodsPerMinute: number, outletGroupSummaries: number, packTypeOutletUtilizationTargets: number}} points The Points used by this MAF Sizer
167
+ * @property {Array<MAFSizerController.MAFSizerLane>} [lanes] The Lanes defined for this MAF Sizer
168
+ * @property {Array<MAFSizerController.MAFSizerOutlet>} [outlets] The Outlets defined for this MAF Sizer
169
+ * @property {Array<MAFSizerController.MAFSizerFruitSize>} [fruitSizes] The Fruit Sizes defined and handled by this MAF Sizer
170
+ * @property {?MAFSizerController.FreshPackMAFSizerIntegration} [freshPackIntegration] The FreshPack Integration Configuration for this MAF Sizer
171
+ * @property {?MAFSizerController.MAFSizerIntegration} [mafIntegration] The MAF Integration Configuration for this MAF Sizer
172
+ * @property {MAFSizerController.RiserSource|MAFSizerController.SizerSource[]} [sources] An Array of Sources that deliver Fruit to this MAF Sizer
173
+ * @property {Array<MAFSizerController.ArticleClassType>} [articleClassTypes] An Array of Article to Class Type Maps for this MAF Sizer
174
174
  * @memberof Controllers.Packhouse.Site
175
175
  */
176
176
 
@@ -179,16 +179,98 @@ export default MAFSizerController;
179
179
  *
180
180
  * @typedef {Object} MAFSizerController.UpdateData
181
181
  * @property {string} [name] The MAF Sizer Name
182
- * @property {Object[]} [lanes] The Lanes defined for this MAF Sizer
183
- * @property {Object} [points] The Points used by this MAF Sizer
184
- * @property {Object[]} [outlets] The Outlets defined for this MAF Sizer
182
+ * @property {string} [packingLineId] The Packing Line ID that manages this MAF Sizer
185
183
  * @property {string} [sizerType] The Sizer Type
186
184
  * @property {number} [autoCreateBatchDelay] The Auto Create Batch Delay in Seconds for this MAF Sizer
187
- * @property {Object[]} [fruitSizes] The Fruit Sizes defined and handled by this MAF Sizer
188
- * @property {string} [packingLineId] The Packing Line ID that manages this MAF Sizer
189
- * @property {?Object} [freshPackIntegration] The FreshPack Integration Configuration for this MAF Sizer
190
- * @property {?Object} [mafIntegration] The MAF Integration Configuration for this MAF Sizer
191
- * @property {Object[]} [sources] An Array of Sources that deliver Fruit to this MAF Sizer
192
- * @property {Object[]} [articleClassTypes] An Array of Article to Class Type Maps for this MAF Sizer
185
+ * @property {{currentBatchId: number, currentBatchName: number, currentBatchGrowerCode: number, currentBatchGrowerName: number, currentBatchVarietyCode: number, currentBatchVarietyName: number, machineAverageFruitWeight: number, machineAverageFruitSize: number, machineCupFill: number, machineRecycledFruitPerMinute: number, machineTotalFruitPerMinute: number, machineTraysPerHour: number, machineTonnesPerHour: number, machineRodsPerMinute: number, outletGroupSummaries: number, packTypeOutletUtilizationTargets: number}} [points] The Points used by this MAF Sizer
186
+ * @property {Array<MAFSizerController.MAFSizerLane>} [lanes] The Lanes defined for this MAF Sizer
187
+ * @property {Array<MAFSizerController.MAFSizerOutlet>} [outlets] The Outlets defined for this MAF Sizer
188
+ * @property {Array<MAFSizerController.MAFSizerFruitSize>} [fruitSizes] The Fruit Sizes defined and handled by this MAF Sizer
189
+ * @property {?MAFSizerController.FreshPackMAFSizerIntegration} [freshPackIntegration] The FreshPack Integration Configuration for this MAF Sizer
190
+ * @property {?MAFSizerController.MAFSizerIntegration} [mafIntegration] The MAF Integration Configuration for this MAF Sizer
191
+ * @property {MAFSizerController.RiserSource|MAFSizerController.SizerSource[]} [sources] An Array of Sources that deliver Fruit to this MAF Sizer
192
+ * @property {Array<MAFSizerController.ArticleClassType>} [articleClassTypes] An Array of Article to Class Type Maps for this MAF Sizer
193
+ * @memberof Controllers.Packhouse.Site
194
+ */
195
+
196
+ /**
197
+ * A **MAFSizerLane** Type
198
+ *
199
+ * @typedef {Object} MAFSizerController.MAFSizerLane
200
+ * @property {string} id Unique ID of this Lane
201
+ * @property {number} number The Lane Number
202
+ * @property {{cupFill: number}} points The Points used by this Lane
203
+ * @memberof Controllers.Packhouse.Site
204
+ */
205
+
206
+ /**
207
+ * A **MAFSizerOutlet** Type
208
+ *
209
+ * @typedef {Object} MAFSizerController.MAFSizerOutlet
210
+ * @property {string} id Unique ID of this Outlet
211
+ * @property {number} number The Outlet Number
212
+ * @property {string} type The Outlet Type
213
+ * @property {{name: number, fruitPerMinute: number, articleName: number, utilization: number}} points The Points used by this Outlet
214
+ * @memberof Controllers.Packhouse.Site
215
+ */
216
+
217
+ /**
218
+ * A **MAFSizerFruitSize** Type
219
+ *
220
+ * @typedef {Object} MAFSizerController.MAFSizerFruitSize
221
+ * @property {string} fruitSize The Fruit Size
222
+ * @property {{incomingFruitPerMinute: number, recycledFruitPerMinute: number, allocatedFruitPerMinute: number}} points The Points used by this Fruit Size Configuration
223
+ * @memberof Controllers.Packhouse.Site
224
+ */
225
+
226
+ /**
227
+ * A **FreshPackMAFSizerIntegration** Type
228
+ *
229
+ * @typedef {Object} MAFSizerController.FreshPackMAFSizerIntegration
230
+ * @property {Object} points The Points used by this FreshPack Sizer Integration
231
+ * @property {boolean} enabled Whether this FreshPack Sizer Integration is Enabled
232
+ * @property {number} materialGroupId The FreshPack Material Group ID to be used for Multi-Grower Bins from this Sizer
233
+ * @property {number} binTypeId The FreshPack Bin Type ID to be used for Multi-Grower Bins from this Sizer
234
+ * @property {string[]} bulkWeightClassTypes An Array of Class Types that should be Sent to FreshPack as Bulk Weights in Multi-Grower Bins
235
+ * @memberof Controllers.Packhouse.Site
236
+ */
237
+
238
+ /**
239
+ * A **MAFSizerIntegration** Type
240
+ *
241
+ * @typedef {Object} MAFSizerController.MAFSizerIntegration
242
+ * @property {{stopBatchRequired: number}} points The Points used by this MAF Sizer Integration
243
+ * @property {boolean} enabled Whether this MAF Sizer Integration is Enabled
244
+ * @property {number} sizerNumber The MAF Internal Number for this Sizer
245
+ * @property {string} dumpSizerName The MAF Internal Name of this Sizer when interacting with the MAF Dump API
246
+ * @property {string} statSizerName The MAF Internal Name of this Sizer when interacting with the MAF Sizer Stat API
247
+ * @memberof Controllers.Packhouse.Site
248
+ */
249
+
250
+ /**
251
+ * A **RiserSource** Type
252
+ *
253
+ * @typedef {Object} MAFSizerController.RiserSource
254
+ * @property {string} type The Source Type
255
+ * @property {string} riserId ID of the Riser Object
256
+ * @memberof Controllers.Packhouse.Site
257
+ */
258
+
259
+ /**
260
+ * A **SizerSource** Type
261
+ *
262
+ * @typedef {Object} MAFSizerController.SizerSource
263
+ * @property {string} type The Source Type
264
+ * @property {string} sizerId ID of the Sizer Object
265
+ * @property {number[]} outletNumbers An Array of Outlet Numbers on the Source Sizer that supply this MAF Sizer
266
+ * @memberof Controllers.Packhouse.Site
267
+ */
268
+
269
+ /**
270
+ * A **ArticleClassType** Type
271
+ *
272
+ * @typedef {Object} MAFSizerController.ArticleClassType
273
+ * @property {string} articleName Name of the MAF Sizer Article
274
+ * @property {string} classType The Class Type for this MAF Sizer Article
193
275
  * @memberof Controllers.Packhouse.Site
194
276
  */