@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
@@ -170,8 +170,8 @@ var _default = CompacSizerController;
170
170
  * @typedef {Object} CompacSizerController.GetAllQueryParameters
171
171
  * @property {?number} [rtuId] The RTU this Compac Sizer belongs to
172
172
  * @property {string} [name] The Compac Sizer Name
173
- * @property {string} [sizerType] The Sizer Type
174
173
  * @property {string} [packingLineId] The Packing Line ID that manages this Compac Sizer
174
+ * @property {string} [sizerType] The Sizer Type
175
175
  * @memberof Controllers.Packhouse.Site
176
176
  */
177
177
 
@@ -181,15 +181,16 @@ var _default = CompacSizerController;
181
181
  * @typedef {Object} CompacSizerController.CreateData
182
182
  * @property {?number} [rtuId] The RTU this Compac Sizer belongs to
183
183
  * @property {string} name The Compac Sizer Name
184
- * @property {Object[]} [lanes] The Lanes defined for this Compac Sizer
185
- * @property {Object} points The Points used by this Compac Sizer
186
- * @property {Object[]} [outlets] The Outlets defined for this Compac Sizer
184
+ * @property {string} packingLineId The Packing Line ID that manages this Compac Sizer
187
185
  * @property {string} sizerType The Sizer Type
188
186
  * @property {number} [autoCreateBatchDelay] The Auto Create Batch Delay in Seconds for this Compac Sizer
189
- * @property {Object[]} [fruitSizes] The Fruit Sizes defined and handled by this Compac Sizer
190
- * @property {string} packingLineId The Packing Line ID that manages this Compac Sizer
191
- * @property {?Object} [freshPackIntegration] The FreshPack Integration Configuration for this Compac Sizer
192
- * @property {Object[]} [sources] An Array of Sources that deliver Fruit to this Compac Sizer
187
+ * @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
188
+ * @property {Array<CompacSizerController.CompacSizerLane>} [lanes] The Lanes defined for this Compac Sizer
189
+ * @property {Array<CompacSizerController.CompacSizerFrame>} [frames] An Optional Array of Frames defined for this Compac Sizer
190
+ * @property {Array<CompacSizerController.CompacSizerOutlet>} [outlets] The Outlets defined for this Compac Sizer
191
+ * @property {Array<CompacSizerController.CompacSizerFruitSize>} [fruitSizes] The Fruit Sizes defined and handled by this Compac Sizer
192
+ * @property {?CompacSizerController.FreshPackCompacSizerIntegration} [freshPackIntegration] The FreshPack Integration Configuration for this Compac Sizer
193
+ * @property {CompacSizerController.RiserSource|CompacSizerController.SizerSource[]} [sources] An Array of Sources that deliver Fruit to this Compac Sizer
193
194
  * @memberof Controllers.Packhouse.Site
194
195
  */
195
196
 
@@ -198,15 +199,88 @@ var _default = CompacSizerController;
198
199
  *
199
200
  * @typedef {Object} CompacSizerController.UpdateData
200
201
  * @property {string} [name] The Compac Sizer Name
201
- * @property {Object[]} [lanes] The Lanes defined for this Compac Sizer
202
- * @property {Object} [points] The Points used by this Compac Sizer
203
- * @property {Object[]} [outlets] The Outlets defined for this Compac Sizer
202
+ * @property {string} [packingLineId] The Packing Line ID that manages this Compac Sizer
204
203
  * @property {string} [sizerType] The Sizer Type
205
204
  * @property {number} [autoCreateBatchDelay] The Auto Create Batch Delay in Seconds for this Compac Sizer
206
- * @property {Object[]} [fruitSizes] The Fruit Sizes defined and handled by this Compac Sizer
207
- * @property {string} [packingLineId] The Packing Line ID that manages this Compac Sizer
208
- * @property {?Object} [freshPackIntegration] The FreshPack Integration Configuration for this Compac Sizer
209
- * @property {Object[]} [sources] An Array of Sources that deliver Fruit to this Compac Sizer
205
+ * @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
206
+ * @property {Array<CompacSizerController.CompacSizerLane>} [lanes] The Lanes defined for this Compac Sizer
207
+ * @property {Array<CompacSizerController.CompacSizerFrame>} [frames] An Optional Array of Frames defined for this Compac Sizer
208
+ * @property {Array<CompacSizerController.CompacSizerOutlet>} [outlets] The Outlets defined for this Compac Sizer
209
+ * @property {Array<CompacSizerController.CompacSizerFruitSize>} [fruitSizes] The Fruit Sizes defined and handled by this Compac Sizer
210
+ * @property {?CompacSizerController.FreshPackCompacSizerIntegration} [freshPackIntegration] The FreshPack Integration Configuration for this Compac Sizer
211
+ * @property {CompacSizerController.RiserSource|CompacSizerController.SizerSource[]} [sources] An Array of Sources that deliver Fruit to this Compac Sizer
212
+ * @memberof Controllers.Packhouse.Site
213
+ */
214
+
215
+ /**
216
+ * A **CompacSizerLane** Type
217
+ *
218
+ * @typedef {Object} CompacSizerController.CompacSizerLane
219
+ * @property {string} id Unique ID of this Lane
220
+ * @property {number} number The Lane Number
221
+ * @property {{cupFill: number}} points The Points used by this Lane
222
+ * @memberof Controllers.Packhouse.Site
223
+ */
224
+
225
+ /**
226
+ * A **CompacSizerFrame** Type
227
+ *
228
+ * @typedef {Object} CompacSizerController.CompacSizerFrame
229
+ * @property {number} number The Frame Number
230
+ * @property {number} startLane Lane Number where this Frame Begins
231
+ * @property {number} endLane Lane Number where this Frame Ends
232
+ * @property {{machineRodsPerMinute: number}} points The Points used by this Frame
233
+ * @memberof Controllers.Packhouse.Site
234
+ */
235
+
236
+ /**
237
+ * A **CompacSizerOutlet** Type
238
+ *
239
+ * @typedef {Object} CompacSizerController.CompacSizerOutlet
240
+ * @property {string} id Unique ID of this Outlet
241
+ * @property {number} number The Outlet Number
242
+ * @property {string} type The Outlet Type
243
+ * @property {{name: number, fruitPerMinute: number, productId: number, productName: number, utilization: number, status: number, pendingProductId: number, pendingProductName: number}} points The Points used by this Outlet
244
+ * @memberof Controllers.Packhouse.Site
245
+ */
246
+
247
+ /**
248
+ * A **CompacSizerFruitSize** Type
249
+ *
250
+ * @typedef {Object} CompacSizerController.CompacSizerFruitSize
251
+ * @property {string} fruitSize The Fruit Size
252
+ * @property {{incomingFruitPerMinute: number, recycledFruitPerMinute: number, allocatedFruitPerMinute: number}} points The Points used by this Fruit Size Configuration
253
+ * @memberof Controllers.Packhouse.Site
254
+ */
255
+
256
+ /**
257
+ * A **FreshPackCompacSizerIntegration** Type
258
+ *
259
+ * @typedef {Object} CompacSizerController.FreshPackCompacSizerIntegration
260
+ * @property {Object} points The Points used by this FreshPack Sizer Integration
261
+ * @property {boolean} enabled Whether this FreshPack Sizer Integration is Enabled
262
+ * @property {number} materialGroupId The FreshPack Material Group ID to be used for Multi-Grower Bins from this Sizer
263
+ * @property {number} binTypeId The FreshPack Bin Type ID to be used for Multi-Grower Bins from this Sizer
264
+ * @property {string[]} bulkWeightClassTypes An Array of Class Types that should be Sent to FreshPack as Bulk Weights in Multi-Grower Bins
265
+ * @memberof Controllers.Packhouse.Site
266
+ */
267
+
268
+ /**
269
+ * A **RiserSource** Type
270
+ *
271
+ * @typedef {Object} CompacSizerController.RiserSource
272
+ * @property {string} type The Source Type
273
+ * @property {string} riserId ID of the Riser Object
274
+ * @memberof Controllers.Packhouse.Site
275
+ */
276
+
277
+ /**
278
+ * A **SizerSource** Type
279
+ *
280
+ * @typedef {Object} CompacSizerController.SizerSource
281
+ * @property {string} type The Source Type
282
+ * @property {string} sizerId ID of the Sizer Object
283
+ * @property {number[]} outletNumbers An Array of Outlet Numbers on the Source Sizer that supply this Compac Sizer
210
284
  * @memberof Controllers.Packhouse.Site
211
285
  */
212
286
 
@@ -925,7 +925,7 @@ var _default = CompacSizerPackrunSummaryController;
925
925
  * @property {number} outletNumber The Outlet Number
926
926
  * @property {string} productId The new Product ID that has been assigned to the Outlet
927
927
  * @property {?string} productName The Name of the new Product that has been assigned to the Outlet
928
- * @property {string} outletProductChangeId The ID of the associated *Compac Sizer Outlet Product Change*
928
+ * @property {string} outletProductChangeId The ID of the associated Compac Sizer Outlet Product Change*
929
929
  * @memberof Controllers.Packhouse.Site
930
930
  */
931
931
 
@@ -838,8 +838,8 @@ var _default = FreshPackPackrunSummaryController;
838
838
  * @property {string} [packrunId] The Packrun ID this Summary is associated with
839
839
  * @property {Date} [createdTimestamp] When this Summary was Created
840
840
  * @property {?string} [timeBatchId] The Time Batch this Summary is associated with
841
- * @property {Object[]} [traySummaries] An Array of Tray Summary Data Objects for all Sizes and Class Types
842
- * @property {Object[]} [clearanceSummaries] An Array of Clearance Summary Data Objects for all Sizes
841
+ * @property {Array<FreshPackPackrunSummaryController.TraySummary>} [traySummaries] An Array of Tray Summary Data Objects for all Sizes and Class Types
842
+ * @property {Array<FreshPackPackrunSummaryController.ClearanceSummary>} [clearanceSummaries] An Array of Clearance Summary Data Objects for all Sizes
843
843
  * @memberof Controllers.Packhouse.Site
844
844
  */
845
845
 
@@ -850,8 +850,8 @@ var _default = FreshPackPackrunSummaryController;
850
850
  * @property {string} [packingLineId] The Packing Line ID this Summary is associated with
851
851
  * @property {Date} [createdTimestamp] When this Summary was Created
852
852
  * @property {?string} [timeBatchId] The Time Batch this Summary is associated with
853
- * @property {Object[]} [traySummaries] An Array of Tray Summary Data Objects for all Sizes and Class Types
854
- * @property {Object[]} [clearanceSummaries] An Array of Clearance Summary Data Objects for all Sizes
853
+ * @property {Array<FreshPackPackrunSummaryController.TraySummary>} [traySummaries] An Array of Tray Summary Data Objects for all Sizes and Class Types
854
+ * @property {Array<FreshPackPackrunSummaryController.ClearanceSummary>} [clearanceSummaries] An Array of Clearance Summary Data Objects for all Sizes
855
855
  * @memberof Controllers.Packhouse.Site
856
856
  */
857
857
 
@@ -877,4 +877,35 @@ var _default = FreshPackPackrunSummaryController;
877
877
  * @memberof Controllers.Packhouse.Site
878
878
  */
879
879
 
880
+ /**
881
+ * A **TraySummary** Type
882
+ *
883
+ * @typedef {Object} FreshPackPackrunSummaryController.TraySummary
884
+ * @property {string} classType The Class Type of this Tray Summary
885
+ * @property {?string} fruitSize The Fruit Size of this Tray Summary
886
+ * @property {number} trayCount Total Number of Tray Equivalents
887
+ * @property {number} averageTrayWeight Average Tray Weight in Kilograms
888
+ * @property {number} weight The Total Fruit Weight in Kilograms for this Tray Summary
889
+ * @memberof Controllers.Packhouse.Site
890
+ */
891
+
892
+ /**
893
+ * A **ClearanceSummary** Type
894
+ *
895
+ * @typedef {Object} FreshPackPackrunSummaryController.ClearanceSummary
896
+ * @property {?string} fruitSize The Fruit Size of this Clearance Summary
897
+ * @property {?string} tasteBand Taste Band (e.g. Y, T, M, R, L)
898
+ * @property {?string} maturityProtocol The Maturity Protocol (since Harvesting) of this Fruit Size (e.g. A, B, C, N)
899
+ * @property {?string} harvestProtocol The Protocol (at Harvest) of this Fruit Size
900
+ * @property {?Date} clearanceDate When this Fruit Size met the Clearance Criteria. Will be `null` if this Fruit Size has not Cleared
901
+ * @property {?Date} kiwiStartDate The Kiwi-Start Date for this Fruit Size
902
+ * @property {?number} trayEstimate The Estimated Number of Tray Equivalents for this Fruit Size
903
+ * @property {?Date} protocolADate Estimated or Actual Date when this Fruit Size will reach Protocol A Maturity
904
+ * @property {?Date} protocolBDate Estimated or Actual Date when this Fruit Size will reach Protocol B Maturity
905
+ * @property {?Date} protocolCDate Estimated or Actual Date when this Fruit Size will reach Protocol C Maturity
906
+ * @property {?Date} protocolNDate Estimated or Actual Date when this Fruit Size will reach Protocol N Maturity
907
+ * @property {?boolean} useNIRPacking Whether NIR Packing should be utilized for this Fruit Size
908
+ * @memberof Controllers.Packhouse.Site
909
+ */
910
+
880
911
  exports.default = _default;
@@ -170,8 +170,8 @@ var _default = MAFSizerController;
170
170
  * @typedef {Object} MAFSizerController.GetAllQueryParameters
171
171
  * @property {?number} [rtuId] The RTU this MAF Sizer belongs to
172
172
  * @property {string} [name] The MAF Sizer Name
173
- * @property {string} [sizerType] The Sizer Type
174
173
  * @property {string} [packingLineId] The Packing Line ID that manages this MAF Sizer
174
+ * @property {string} [sizerType] The Sizer Type
175
175
  * @memberof Controllers.Packhouse.Site
176
176
  */
177
177
 
@@ -181,17 +181,17 @@ var _default = MAFSizerController;
181
181
  * @typedef {Object} MAFSizerController.CreateData
182
182
  * @property {?number} [rtuId] The RTU this MAF Sizer belongs to
183
183
  * @property {string} name The MAF Sizer Name
184
- * @property {Object[]} [lanes] The Lanes defined for this MAF Sizer
185
- * @property {Object} points The Points used by this MAF Sizer
186
- * @property {Object[]} [outlets] The Outlets defined for this MAF Sizer
184
+ * @property {string} packingLineId The Packing Line ID that manages this MAF Sizer
187
185
  * @property {string} sizerType The Sizer Type
188
186
  * @property {number} [autoCreateBatchDelay] The Auto Create Batch Delay in Seconds for this MAF Sizer
189
- * @property {Object[]} [fruitSizes] The Fruit Sizes defined and handled by this MAF Sizer
190
- * @property {string} packingLineId The Packing Line ID that manages this MAF Sizer
191
- * @property {?Object} [freshPackIntegration] The FreshPack Integration Configuration for this MAF Sizer
192
- * @property {?Object} [mafIntegration] The MAF Integration Configuration for this MAF Sizer
193
- * @property {Object[]} [sources] An Array of Sources that deliver Fruit to this MAF Sizer
194
- * @property {Object[]} [articleClassTypes] An Array of Article to Class Type Maps for this MAF Sizer
187
+ * @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
188
+ * @property {Array<MAFSizerController.MAFSizerLane>} [lanes] The Lanes defined for this MAF Sizer
189
+ * @property {Array<MAFSizerController.MAFSizerOutlet>} [outlets] The Outlets defined for this MAF Sizer
190
+ * @property {Array<MAFSizerController.MAFSizerFruitSize>} [fruitSizes] The Fruit Sizes defined and handled by this MAF Sizer
191
+ * @property {?MAFSizerController.FreshPackMAFSizerIntegration} [freshPackIntegration] The FreshPack Integration Configuration for this MAF Sizer
192
+ * @property {?MAFSizerController.MAFSizerIntegration} [mafIntegration] The MAF Integration Configuration for this MAF Sizer
193
+ * @property {MAFSizerController.RiserSource|MAFSizerController.SizerSource[]} [sources] An Array of Sources that deliver Fruit to this MAF Sizer
194
+ * @property {Array<MAFSizerController.ArticleClassType>} [articleClassTypes] An Array of Article to Class Type Maps for this MAF Sizer
195
195
  * @memberof Controllers.Packhouse.Site
196
196
  */
197
197
 
@@ -200,17 +200,99 @@ var _default = MAFSizerController;
200
200
  *
201
201
  * @typedef {Object} MAFSizerController.UpdateData
202
202
  * @property {string} [name] The MAF Sizer Name
203
- * @property {Object[]} [lanes] The Lanes defined for this MAF Sizer
204
- * @property {Object} [points] The Points used by this MAF Sizer
205
- * @property {Object[]} [outlets] The Outlets defined for this MAF Sizer
203
+ * @property {string} [packingLineId] The Packing Line ID that manages this MAF Sizer
206
204
  * @property {string} [sizerType] The Sizer Type
207
205
  * @property {number} [autoCreateBatchDelay] The Auto Create Batch Delay in Seconds for this MAF Sizer
208
- * @property {Object[]} [fruitSizes] The Fruit Sizes defined and handled by this MAF Sizer
209
- * @property {string} [packingLineId] The Packing Line ID that manages this MAF Sizer
210
- * @property {?Object} [freshPackIntegration] The FreshPack Integration Configuration for this MAF Sizer
211
- * @property {?Object} [mafIntegration] The MAF Integration Configuration for this MAF Sizer
212
- * @property {Object[]} [sources] An Array of Sources that deliver Fruit to this MAF Sizer
213
- * @property {Object[]} [articleClassTypes] An Array of Article to Class Type Maps for this MAF Sizer
206
+ * @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
207
+ * @property {Array<MAFSizerController.MAFSizerLane>} [lanes] The Lanes defined for this MAF Sizer
208
+ * @property {Array<MAFSizerController.MAFSizerOutlet>} [outlets] The Outlets defined for this MAF Sizer
209
+ * @property {Array<MAFSizerController.MAFSizerFruitSize>} [fruitSizes] The Fruit Sizes defined and handled by this MAF Sizer
210
+ * @property {?MAFSizerController.FreshPackMAFSizerIntegration} [freshPackIntegration] The FreshPack Integration Configuration for this MAF Sizer
211
+ * @property {?MAFSizerController.MAFSizerIntegration} [mafIntegration] The MAF Integration Configuration for this MAF Sizer
212
+ * @property {MAFSizerController.RiserSource|MAFSizerController.SizerSource[]} [sources] An Array of Sources that deliver Fruit to this MAF Sizer
213
+ * @property {Array<MAFSizerController.ArticleClassType>} [articleClassTypes] An Array of Article to Class Type Maps for this MAF Sizer
214
+ * @memberof Controllers.Packhouse.Site
215
+ */
216
+
217
+ /**
218
+ * A **MAFSizerLane** Type
219
+ *
220
+ * @typedef {Object} MAFSizerController.MAFSizerLane
221
+ * @property {string} id Unique ID of this Lane
222
+ * @property {number} number The Lane Number
223
+ * @property {{cupFill: number}} points The Points used by this Lane
224
+ * @memberof Controllers.Packhouse.Site
225
+ */
226
+
227
+ /**
228
+ * A **MAFSizerOutlet** Type
229
+ *
230
+ * @typedef {Object} MAFSizerController.MAFSizerOutlet
231
+ * @property {string} id Unique ID of this Outlet
232
+ * @property {number} number The Outlet Number
233
+ * @property {string} type The Outlet Type
234
+ * @property {{name: number, fruitPerMinute: number, articleName: number, utilization: number}} points The Points used by this Outlet
235
+ * @memberof Controllers.Packhouse.Site
236
+ */
237
+
238
+ /**
239
+ * A **MAFSizerFruitSize** Type
240
+ *
241
+ * @typedef {Object} MAFSizerController.MAFSizerFruitSize
242
+ * @property {string} fruitSize The Fruit Size
243
+ * @property {{incomingFruitPerMinute: number, recycledFruitPerMinute: number, allocatedFruitPerMinute: number}} points The Points used by this Fruit Size Configuration
244
+ * @memberof Controllers.Packhouse.Site
245
+ */
246
+
247
+ /**
248
+ * A **FreshPackMAFSizerIntegration** Type
249
+ *
250
+ * @typedef {Object} MAFSizerController.FreshPackMAFSizerIntegration
251
+ * @property {Object} points The Points used by this FreshPack Sizer Integration
252
+ * @property {boolean} enabled Whether this FreshPack Sizer Integration is Enabled
253
+ * @property {number} materialGroupId The FreshPack Material Group ID to be used for Multi-Grower Bins from this Sizer
254
+ * @property {number} binTypeId The FreshPack Bin Type ID to be used for Multi-Grower Bins from this Sizer
255
+ * @property {string[]} bulkWeightClassTypes An Array of Class Types that should be Sent to FreshPack as Bulk Weights in Multi-Grower Bins
256
+ * @memberof Controllers.Packhouse.Site
257
+ */
258
+
259
+ /**
260
+ * A **MAFSizerIntegration** Type
261
+ *
262
+ * @typedef {Object} MAFSizerController.MAFSizerIntegration
263
+ * @property {{stopBatchRequired: number}} points The Points used by this MAF Sizer Integration
264
+ * @property {boolean} enabled Whether this MAF Sizer Integration is Enabled
265
+ * @property {number} sizerNumber The MAF Internal Number for this Sizer
266
+ * @property {string} dumpSizerName The MAF Internal Name of this Sizer when interacting with the MAF Dump API
267
+ * @property {string} statSizerName The MAF Internal Name of this Sizer when interacting with the MAF Sizer Stat API
268
+ * @memberof Controllers.Packhouse.Site
269
+ */
270
+
271
+ /**
272
+ * A **RiserSource** Type
273
+ *
274
+ * @typedef {Object} MAFSizerController.RiserSource
275
+ * @property {string} type The Source Type
276
+ * @property {string} riserId ID of the Riser Object
277
+ * @memberof Controllers.Packhouse.Site
278
+ */
279
+
280
+ /**
281
+ * A **SizerSource** Type
282
+ *
283
+ * @typedef {Object} MAFSizerController.SizerSource
284
+ * @property {string} type The Source Type
285
+ * @property {string} sizerId ID of the Sizer Object
286
+ * @property {number[]} outletNumbers An Array of Outlet Numbers on the Source Sizer that supply this MAF Sizer
287
+ * @memberof Controllers.Packhouse.Site
288
+ */
289
+
290
+ /**
291
+ * A **ArticleClassType** Type
292
+ *
293
+ * @typedef {Object} MAFSizerController.ArticleClassType
294
+ * @property {string} articleName Name of the MAF Sizer Article
295
+ * @property {string} classType The Class Type for this MAF Sizer Article
214
296
  * @memberof Controllers.Packhouse.Site
215
297
  */
216
298