@ricado/api-client 2.7.10 → 2.8.0

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 (35) hide show
  1. package/dist/ricado.api.client.js +1 -1
  2. package/lib/Controllers/Lab/Site/FruitProfileController.js +10 -10
  3. package/lib/Controllers/Lab/Site/LabController.js +1 -1
  4. package/lib/Controllers/Packhouse/Site/CompacSizerController.js +2 -2
  5. package/lib/Controllers/Packhouse/Site/GrowingMethodController.js +1 -1
  6. package/lib/Controllers/Packhouse/Site/MAFSizerController.js +2 -2
  7. package/lib/Controllers/Packhouse/Site/PackingLineController.js +9 -5
  8. package/lib/Controllers/Packhouse/Site/ReemoonSizerController.js +2 -2
  9. package/lib/Controllers/Packhouse/Site/RejectBinScaleController.js +2 -2
  10. package/lib/Controllers/Packhouse/Site/VarietyController.js +2 -2
  11. package/lib/Models/Lab/Site/FruitProfileModel.js +4 -4
  12. package/lib/Models/Packhouse/Site/CompacSizerModel.js +1 -1
  13. package/lib/Models/Packhouse/Site/MAFSizerModel.js +1 -1
  14. package/lib/Models/Packhouse/Site/PackingLineModel.js +86 -4
  15. package/lib/Models/Packhouse/Site/ReemoonSizerModel.js +1 -1
  16. package/lib/Models/Packhouse/Site/RejectBinScaleModel.js +18 -1
  17. package/lib/PackageVersion.js +1 -1
  18. package/lib/index.d.ts +71 -36
  19. package/package.json +1 -1
  20. package/src/Controllers/Lab/Site/FruitProfileController.js +10 -10
  21. package/src/Controllers/Lab/Site/LabController.js +1 -1
  22. package/src/Controllers/Packhouse/Site/CompacSizerController.js +2 -2
  23. package/src/Controllers/Packhouse/Site/GrowingMethodController.js +1 -1
  24. package/src/Controllers/Packhouse/Site/MAFSizerController.js +2 -2
  25. package/src/Controllers/Packhouse/Site/PackingLineController.js +9 -5
  26. package/src/Controllers/Packhouse/Site/ReemoonSizerController.js +2 -2
  27. package/src/Controllers/Packhouse/Site/RejectBinScaleController.js +2 -2
  28. package/src/Controllers/Packhouse/Site/VarietyController.js +2 -2
  29. package/src/Models/Lab/Site/FruitProfileModel.js +4 -4
  30. package/src/Models/Packhouse/Site/CompacSizerModel.js +1 -1
  31. package/src/Models/Packhouse/Site/MAFSizerModel.js +1 -1
  32. package/src/Models/Packhouse/Site/PackingLineModel.js +117 -4
  33. package/src/Models/Packhouse/Site/ReemoonSizerModel.js +1 -1
  34. package/src/Models/Packhouse/Site/RejectBinScaleModel.js +24 -1
  35. package/src/PackageVersion.js +1 -1
package/lib/index.d.ts CHANGED
@@ -7076,11 +7076,11 @@ declare module '@ricado/api-client/Controllers/Lab/Site/FruitProfileController'
7076
7076
  /**
7077
7077
  * The Fruit Profile Description
7078
7078
  */
7079
- description: string;
7079
+ description?: string | undefined;
7080
7080
  /**
7081
7081
  * The Fruit Profile Image Source
7082
7082
  */
7083
- image: string;
7083
+ image?: string | undefined;
7084
7084
  /**
7085
7085
  * The Typical Warm Up Duration (in seconds) for a Sample to reach the Minimum Target Temperature
7086
7086
  */
@@ -7110,7 +7110,7 @@ declare module '@ricado/api-client/Controllers/Lab/Site/FruitProfileController'
7110
7110
  */
7111
7111
  warmUpStartExpectedTemperature: number;
7112
7112
  /**
7113
- * The Warm-Up Start Expected Rate of Change
7113
+ * The Warm-Up Start Expected Rate of Change: the minimum Temperature rise in Degrees Celsius over the trailing 10 minute window expected once the Sample reaches the Start Expected Temperature. A Warm Up Warning is raised when the measured Rate of Change falls below the Expected Rate for the current stage
7114
7114
  */
7115
7115
  warmUpStartExpectedRateOfChange: number;
7116
7116
  /**
@@ -7118,7 +7118,7 @@ declare module '@ricado/api-client/Controllers/Lab/Site/FruitProfileController'
7118
7118
  */
7119
7119
  warmUpStageTwoExpectedTemperature: number;
7120
7120
  /**
7121
- * The Warm-Up Stage Two Expected Rate of Change
7121
+ * The Warm-Up Stage Two Expected Rate of Change: the minimum Temperature rise in Degrees Celsius over the trailing 10 minute window expected once the Sample reaches the Stage Two Expected Temperature
7122
7122
  */
7123
7123
  warmUpStageTwoExpectedRateOfChange: number;
7124
7124
  /**
@@ -7126,7 +7126,7 @@ declare module '@ricado/api-client/Controllers/Lab/Site/FruitProfileController'
7126
7126
  */
7127
7127
  warmUpStageThreeExpectedTemperature: number;
7128
7128
  /**
7129
- * The Warm-Up Stage Three Expected Rate of Change
7129
+ * The Warm-Up Stage Three Expected Rate of Change: the minimum Temperature rise in Degrees Celsius over the trailing 10 minute window expected once the Sample reaches the Stage Three Expected Temperature
7130
7130
  */
7131
7131
  warmUpStageThreeExpectedRateOfChange: number;
7132
7132
  /**
@@ -7134,7 +7134,7 @@ declare module '@ricado/api-client/Controllers/Lab/Site/FruitProfileController'
7134
7134
  */
7135
7135
  warmUpEndExpectedTemperature: number;
7136
7136
  /**
7137
- * The Warm-Up End Expected Rate of Change
7137
+ * The Warm-Up End Expected Rate of Change: the minimum Temperature rise in Degrees Celsius over the trailing 10 minute window expected once the Sample reaches the End Expected Temperature
7138
7138
  */
7139
7139
  warmUpEndExpectedRateOfChange: number;
7140
7140
  };
@@ -7183,7 +7183,7 @@ declare module '@ricado/api-client/Controllers/Lab/Site/FruitProfileController'
7183
7183
  */
7184
7184
  warmUpStartExpectedTemperature?: number | undefined;
7185
7185
  /**
7186
- * The Warm-Up Start Expected Rate of Change
7186
+ * The Warm-Up Start Expected Rate of Change: the minimum Temperature rise in Degrees Celsius over the trailing 10 minute window expected once the Sample reaches the Start Expected Temperature. A Warm Up Warning is raised when the measured Rate of Change falls below the Expected Rate for the current stage
7187
7187
  */
7188
7188
  warmUpStartExpectedRateOfChange?: number | undefined;
7189
7189
  /**
@@ -7191,7 +7191,7 @@ declare module '@ricado/api-client/Controllers/Lab/Site/FruitProfileController'
7191
7191
  */
7192
7192
  warmUpStageTwoExpectedTemperature?: number | undefined;
7193
7193
  /**
7194
- * The Warm-Up Stage Two Expected Rate of Change
7194
+ * The Warm-Up Stage Two Expected Rate of Change: the minimum Temperature rise in Degrees Celsius over the trailing 10 minute window expected once the Sample reaches the Stage Two Expected Temperature
7195
7195
  */
7196
7196
  warmUpStageTwoExpectedRateOfChange?: number | undefined;
7197
7197
  /**
@@ -7199,7 +7199,7 @@ declare module '@ricado/api-client/Controllers/Lab/Site/FruitProfileController'
7199
7199
  */
7200
7200
  warmUpStageThreeExpectedTemperature?: number | undefined;
7201
7201
  /**
7202
- * The Warm-Up Stage Three Expected Rate of Change
7202
+ * The Warm-Up Stage Three Expected Rate of Change: the minimum Temperature rise in Degrees Celsius over the trailing 10 minute window expected once the Sample reaches the Stage Three Expected Temperature
7203
7203
  */
7204
7204
  warmUpStageThreeExpectedRateOfChange?: number | undefined;
7205
7205
  /**
@@ -7207,7 +7207,7 @@ declare module '@ricado/api-client/Controllers/Lab/Site/FruitProfileController'
7207
7207
  */
7208
7208
  warmUpEndExpectedTemperature?: number | undefined;
7209
7209
  /**
7210
- * The Warm-Up End Expected Rate of Change
7210
+ * The Warm-Up End Expected Rate of Change: the minimum Temperature rise in Degrees Celsius over the trailing 10 minute window expected once the Sample reaches the End Expected Temperature
7211
7211
  */
7212
7212
  warmUpEndExpectedRateOfChange?: number | undefined;
7213
7213
  };
@@ -7308,7 +7308,7 @@ declare module '@ricado/api-client/Controllers/Lab/Site/LabController' {
7308
7308
  /**
7309
7309
  * The Points used by this Lab
7310
7310
  */
7311
- points: any;
7311
+ points?: any;
7312
7312
  /**
7313
7313
  * The Rack Objects that belong to this Lab
7314
7314
  */
@@ -11288,7 +11288,7 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/CompacSizerControl
11288
11288
  */
11289
11289
  sizerType: string;
11290
11290
  /**
11291
- * The Auto Create Batch Delay in Seconds for this Compac Sizer
11291
+ * The Auto Create Batch Delay in Milliseconds for this Compac Sizer. Only honoured when greater than 1200 ms on a Packrun Change or 500 ms on a Time Batch Change, otherwise the RTU default delay applies
11292
11292
  */
11293
11293
  autoCreateBatchDelay?: number | undefined;
11294
11294
  /**
@@ -11376,7 +11376,7 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/CompacSizerControl
11376
11376
  */
11377
11377
  sizerType?: string | undefined;
11378
11378
  /**
11379
- * The Auto Create Batch Delay in Seconds for this Compac Sizer
11379
+ * The Auto Create Batch Delay in Milliseconds for this Compac Sizer. Only honoured when greater than 1200 ms on a Packrun Change or 500 ms on a Time Batch Change, otherwise the RTU default delay applies
11380
11380
  */
11381
11381
  autoCreateBatchDelay?: number | undefined;
11382
11382
  /**
@@ -14201,7 +14201,7 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/GrowingMethodContr
14201
14201
  /**
14202
14202
  * The Growing Method Description
14203
14203
  */
14204
- description: string;
14204
+ description?: string | undefined;
14205
14205
  };
14206
14206
  /**
14207
14207
  * The Update Data for a Growing Method
@@ -14797,7 +14797,7 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/MAFSizerController
14797
14797
  */
14798
14798
  sizerType: string;
14799
14799
  /**
14800
- * The Auto Create Batch Delay in Seconds for this MAF Sizer
14800
+ * The Auto Create Batch Delay in Milliseconds for this MAF Sizer. Only honoured when greater than 1200 ms on a Packrun Change or 500 ms on a Time Batch Change, otherwise the RTU default delay applies
14801
14801
  */
14802
14802
  autoCreateBatchDelay?: number | undefined;
14803
14803
  /**
@@ -14874,7 +14874,7 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/MAFSizerController
14874
14874
  */
14875
14875
  sizerType?: string | undefined;
14876
14876
  /**
14877
- * The Auto Create Batch Delay in Seconds for this MAF Sizer
14877
+ * The Auto Create Batch Delay in Milliseconds for this MAF Sizer. Only honoured when greater than 1200 ms on a Packrun Change or 500 ms on a Time Batch Change, otherwise the RTU default delay applies
14878
14878
  */
14879
14879
  autoCreateBatchDelay?: number | undefined;
14880
14880
  /**
@@ -16974,6 +16974,22 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/PackingLineControl
16974
16974
  * An Array of Sizer IDs to be included in this Step
16975
16975
  */
16976
16976
  sizerIds: string[];
16977
+ /**
16978
+ * Optional Boolean Point that reports whether Line Automation is running. While this Point is `false` the Auto Advance countdown is held
16979
+ */
16980
+ automationRunningPointId?: number | null | undefined;
16981
+ /**
16982
+ * Optional Integer Point the RTU counts down (in Milliseconds) before Auto Advancing to the next Step. Set to `autoAdvanceDelay` when this Step becomes Active
16983
+ */
16984
+ autoAdvanceTimeRemainingPointId?: number | null | undefined;
16985
+ /**
16986
+ * Optional Boolean Point that pauses the Auto Advance countdown while `true`. Reset to `false` when this Step becomes Active
16987
+ */
16988
+ autoAdvancePausedPointId?: number | null | undefined;
16989
+ /**
16990
+ * Optional Auto Advance Delay in Milliseconds written to the Time Remaining Point when this Step becomes Active. Auto Advance only occurs when both this and `autoAdvanceTimeRemainingPointId` are set
16991
+ */
16992
+ autoAdvanceDelay?: number | null | undefined;
16977
16993
  };
16978
16994
  /**
16979
16995
  * A **CreateSizerBatchesStep** Type
@@ -17040,7 +17056,7 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/PackingLineControl
17040
17056
  /**
17041
17057
  * When this Action should be performed. 'begin' performed once when this Step becomes Active. 'end' performed once when this Step is no longer Active. 'always' performed constantly while this Step is Active
17042
17058
  */
17043
- trigger: string;
17059
+ actionTrigger: string;
17044
17060
  /**
17045
17061
  * An Optional Reference for this Action (e.g. The Internal MAF Name of a Sizer or Numeric Sizer ID
17046
17062
  */
@@ -17077,7 +17093,7 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/PackingLineControl
17077
17093
  /**
17078
17094
  * When this Action should be performed. 'begin' performed once when this Step becomes Active. 'end' performed once when this Step is no longer Active. 'always' performed constantly while this Step is Active
17079
17095
  */
17080
- trigger: string;
17096
+ actionTrigger: string;
17081
17097
  /**
17082
17098
  * An Optional Reference for this Action (e.g. The Internal MAF Name of a Sizer or Numeric Sizer ID
17083
17099
  */
@@ -17121,6 +17137,10 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/PackingLineControl
17121
17137
  batchManagementLineName: number;
17122
17138
  batchManagementCurrentLot: number;
17123
17139
  batchManagementEndOfDay: number;
17140
+ batchManagementCurrentBatchName: number;
17141
+ batchManagementCurrentBatchTimeBatch: number;
17142
+ batchManagementCurrentBatchCreatedTimestamp: number;
17143
+ recentLotPackruns: number;
17124
17144
  skipBrushesSweepRequest: number;
17125
17145
  finishPackrunBeginRequest: number;
17126
17146
  finishPackrunCancelRequest: number;
@@ -17187,6 +17207,7 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/PackingLineControl
17187
17207
  activePackrunName: number | null;
17188
17208
  activeTimeBatch: number | null;
17189
17209
  classTypeMultiGrowerBinProductIds: number | null;
17210
+ packrunAutoImportEnabled: number | null;
17190
17211
  };
17191
17212
  /**
17192
17213
  * Whether the FreshPack Integration is Enabled on this Packing Line
@@ -17295,6 +17316,7 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/PackingLineControl
17295
17316
  externalContactsCommunicationStatus: number;
17296
17317
  externalContactsCommunicationLastAttempt: number;
17297
17318
  externalContactsCommunicationLastError: number;
17319
+ allowSmsMessagesOvernight: number;
17298
17320
  };
17299
17321
  /**
17300
17322
  * Whether the Grower Notifications Integration is Enabled on this Packing Line
@@ -19447,7 +19469,7 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/ReemoonSizerContro
19447
19469
  */
19448
19470
  sizerType: string;
19449
19471
  /**
19450
- * The Auto Create Batch Delay in Seconds for this Reemoon Sizer
19472
+ * The Auto Create Batch Delay in Milliseconds for this Reemoon Sizer. Only honoured when greater than 1200 ms on a Packrun Change or 500 ms on a Time Batch Change, otherwise the RTU default delay applies
19451
19473
  */
19452
19474
  autoCreateBatchDelay?: number | undefined;
19453
19475
  /**
@@ -19525,7 +19547,7 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/ReemoonSizerContro
19525
19547
  */
19526
19548
  sizerType?: string | undefined;
19527
19549
  /**
19528
- * The Auto Create Batch Delay in Seconds for this Reemoon Sizer
19550
+ * The Auto Create Batch Delay in Milliseconds for this Reemoon Sizer. Only honoured when greater than 1200 ms on a Packrun Change or 500 ms on a Time Batch Change, otherwise the RTU default delay applies
19529
19551
  */
19530
19552
  autoCreateBatchDelay?: number | undefined;
19531
19553
  /**
@@ -20795,6 +20817,7 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/RejectBinScaleCont
20795
20817
  currentLiveWeight: number | null;
20796
20818
  startLiveWeighingRequest: number | null;
20797
20819
  finishLiveWeighingRequest: number | null;
20820
+ resetErrorRequest: number | null;
20798
20821
  fruitDeliveryActive: number | null;
20799
20822
  status: number;
20800
20823
  currentPackrunId: number;
@@ -20917,6 +20940,7 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/RejectBinScaleCont
20917
20940
  currentLiveWeight: number | null;
20918
20941
  startLiveWeighingRequest: number | null;
20919
20942
  finishLiveWeighingRequest: number | null;
20943
+ resetErrorRequest: number | null;
20920
20944
  fruitDeliveryActive: number | null;
20921
20945
  status: number;
20922
20946
  currentPackrunId: number;
@@ -25301,11 +25325,11 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/VarietyController'
25301
25325
  /**
25302
25326
  * The Variety Description
25303
25327
  */
25304
- description: string;
25328
+ description?: string | undefined;
25305
25329
  /**
25306
25330
  * The Variety Image Source
25307
25331
  */
25308
- image: string;
25332
+ image?: string | undefined;
25309
25333
  /**
25310
25334
  * An Array of Fruit Sizes Defined for this Variety
25311
25335
  */
@@ -25543,7 +25567,7 @@ declare module '@ricado/api-client/Models/Lab/Site/FruitProfileModel' {
25543
25567
  */
25544
25568
  warmUpStartExpectedTemperature: number;
25545
25569
  /**
25546
- * The Warm-Up Start Expected Rate of Change
25570
+ * The Warm-Up Start Expected Rate of Change: the minimum Temperature rise in Degrees Celsius over the trailing 10 minute window expected once the Sample reaches the Start Expected Temperature. A Warm Up Warning is raised when the measured Rate of Change falls below the Expected Rate for the current stage
25547
25571
  *
25548
25572
  * @type {number}
25549
25573
  * @public
@@ -25557,7 +25581,7 @@ declare module '@ricado/api-client/Models/Lab/Site/FruitProfileModel' {
25557
25581
  */
25558
25582
  warmUpStageTwoExpectedTemperature: number;
25559
25583
  /**
25560
- * The Warm-Up Stage Two Expected Rate of Change
25584
+ * The Warm-Up Stage Two Expected Rate of Change: the minimum Temperature rise in Degrees Celsius over the trailing 10 minute window expected once the Sample reaches the Stage Two Expected Temperature
25561
25585
  *
25562
25586
  * @type {number}
25563
25587
  * @public
@@ -25571,7 +25595,7 @@ declare module '@ricado/api-client/Models/Lab/Site/FruitProfileModel' {
25571
25595
  */
25572
25596
  warmUpStageThreeExpectedTemperature: number;
25573
25597
  /**
25574
- * The Warm-Up Stage Three Expected Rate of Change
25598
+ * The Warm-Up Stage Three Expected Rate of Change: the minimum Temperature rise in Degrees Celsius over the trailing 10 minute window expected once the Sample reaches the Stage Three Expected Temperature
25575
25599
  *
25576
25600
  * @type {number}
25577
25601
  * @public
@@ -25585,7 +25609,7 @@ declare module '@ricado/api-client/Models/Lab/Site/FruitProfileModel' {
25585
25609
  */
25586
25610
  warmUpEndExpectedTemperature: number;
25587
25611
  /**
25588
- * The Warm-Up End Expected Rate of Change
25612
+ * The Warm-Up End Expected Rate of Change: the minimum Temperature rise in Degrees Celsius over the trailing 10 minute window expected once the Sample reaches the End Expected Temperature
25589
25613
  *
25590
25614
  * @type {number}
25591
25615
  * @public
@@ -27516,7 +27540,7 @@ declare module '@ricado/api-client/Models/Packhouse/Site/CompacSizerModel' {
27516
27540
  */
27517
27541
  sizerType: string;
27518
27542
  /**
27519
- * The Auto Create Batch Delay in Seconds for this Compac Sizer
27543
+ * The Auto Create Batch Delay in Milliseconds for this Compac Sizer. Only honoured when greater than 1200 ms on a Packrun Change or 500 ms on a Time Batch Change, otherwise the RTU default delay applies
27520
27544
  *
27521
27545
  * @type {number}
27522
27546
  * @public
@@ -29093,7 +29117,7 @@ declare module '@ricado/api-client/Models/Packhouse/Site/MAFSizerModel' {
29093
29117
  */
29094
29118
  sizerType: string;
29095
29119
  /**
29096
- * The Auto Create Batch Delay in Seconds for this MAF Sizer
29120
+ * The Auto Create Batch Delay in Milliseconds for this MAF Sizer. Only honoured when greater than 1200 ms on a Packrun Change or 500 ms on a Time Batch Change, otherwise the RTU default delay applies
29097
29121
  *
29098
29122
  * @type {number}
29099
29123
  * @public
@@ -30027,7 +30051,7 @@ declare module '@ricado/api-client/Models/Packhouse/Site/PackingLineModel' {
30027
30051
  /**
30028
30052
  * The Advanced Packrun Management Configuration for this Packing Line
30029
30053
  *
30030
- * @type {?{points: {startPackrunChangeRequest: number, cancelPackrunChangeRequest: number, advancePackrunChangeRequest: number, skipPackrunChangeStepRequest: number, packrunChangeCurrentStep: number, packrunChangeAutomationActionsEnabled: number}, steps: Array<{index: number, type: string, title: string, subtitle: ?string, description: string, pointActions: Array<{trigger: string, pointId: number, value: any}>, autoControlGroupActions: Array<{trigger: string, groupId: string, action: string}>}|{index: number, type: string, sizerIds: string[]}|{index: number, type: string, sizerIds: string[]}|{index: number, type: string, sizerId: string}|{index: number, type: string, title: string, subtitle: ?string, description: string, actionType: string, trigger: string, actionReference: ?any}|{index: number, type: string, title: string, subtitle: ?string, description: string, actionType: string, trigger: string, actionReference: ?any}>, enabled: boolean}}
30054
+ * @type {?{points: {startPackrunChangeRequest: number, cancelPackrunChangeRequest: number, advancePackrunChangeRequest: number, skipPackrunChangeStepRequest: number, packrunChangeCurrentStep: number, packrunChangeAutomationActionsEnabled: number}, steps: Array<{index: number, type: string, title: string, subtitle: ?string, description: string, pointActions: Array<{trigger: string, pointId: number, value: any}>, autoControlGroupActions: Array<{trigger: string, groupId: string, action: string}>}|{index: number, type: string, sizerIds: string[], automationRunningPointId: ?number, autoAdvanceTimeRemainingPointId: ?number, autoAdvancePausedPointId: ?number, autoAdvanceDelay: ?number}|{index: number, type: string, sizerIds: string[]}|{index: number, type: string, sizerId: string}|{index: number, type: string, title: string, subtitle: ?string, description: string, actionType: string, actionTrigger: string, actionReference: ?any}|{index: number, type: string, title: string, subtitle: ?string, description: string, actionType: string, actionTrigger: string, actionReference: ?any}>, enabled: boolean}}
30031
30055
  * @public
30032
30056
  */
30033
30057
  advancedPackrunManagement: {
@@ -30059,6 +30083,10 @@ declare module '@ricado/api-client/Models/Packhouse/Site/PackingLineModel' {
30059
30083
  index: number;
30060
30084
  type: string;
30061
30085
  sizerIds: string[];
30086
+ automationRunningPointId: number | null;
30087
+ autoAdvanceTimeRemainingPointId: number | null;
30088
+ autoAdvancePausedPointId: number | null;
30089
+ autoAdvanceDelay: number | null;
30062
30090
  } | {
30063
30091
  index: number;
30064
30092
  type: string;
@@ -30074,7 +30102,7 @@ declare module '@ricado/api-client/Models/Packhouse/Site/PackingLineModel' {
30074
30102
  subtitle: string | null;
30075
30103
  description: string;
30076
30104
  actionType: string;
30077
- trigger: string;
30105
+ actionTrigger: string;
30078
30106
  actionReference: any | null;
30079
30107
  } | {
30080
30108
  index: number;
@@ -30083,7 +30111,7 @@ declare module '@ricado/api-client/Models/Packhouse/Site/PackingLineModel' {
30083
30111
  subtitle: string | null;
30084
30112
  description: string;
30085
30113
  actionType: string;
30086
- trigger: string;
30114
+ actionTrigger: string;
30087
30115
  actionReference: any | null;
30088
30116
  })[];
30089
30117
  enabled: boolean;
@@ -30091,7 +30119,7 @@ declare module '@ricado/api-client/Models/Packhouse/Site/PackingLineModel' {
30091
30119
  /**
30092
30120
  * The MAF Integration Configuration for this Packing Line
30093
30121
  *
30094
- * @type {?{points: {apiCommunicationStatus: number, batchManagementStateNumber: number, batchManagementStateMessage: number, batchManagementLineName: number, batchManagementCurrentLot: number, batchManagementEndOfDay: number, skipBrushesSweepRequest: number, finishPackrunBeginRequest: number, finishPackrunCancelRequest: number, finishPackrunAdvanceRequest: number, finishPackrunSkipStepRequest: number, finishPackrunCurrentStep: number, timeBatchChangeBeginRequest: number, timeBatchChangeCancelRequest: number, timeBatchChangeAdvanceRequest: number, timeBatchChangeSkipStepRequest: number, timeBatchChangeCurrentStep: number}, enabled: boolean, tracAddress: string}}
30122
+ * @type {?{points: {apiCommunicationStatus: number, batchManagementStateNumber: number, batchManagementStateMessage: number, batchManagementLineName: number, batchManagementCurrentLot: number, batchManagementEndOfDay: number, batchManagementCurrentBatchName: number, batchManagementCurrentBatchTimeBatch: number, batchManagementCurrentBatchCreatedTimestamp: number, recentLotPackruns: number, skipBrushesSweepRequest: number, finishPackrunBeginRequest: number, finishPackrunCancelRequest: number, finishPackrunAdvanceRequest: number, finishPackrunSkipStepRequest: number, finishPackrunCurrentStep: number, timeBatchChangeBeginRequest: number, timeBatchChangeCancelRequest: number, timeBatchChangeAdvanceRequest: number, timeBatchChangeSkipStepRequest: number, timeBatchChangeCurrentStep: number}, enabled: boolean, tracAddress: string}}
30095
30123
  * @public
30096
30124
  */
30097
30125
  mafIntegration: {
@@ -30102,6 +30130,10 @@ declare module '@ricado/api-client/Models/Packhouse/Site/PackingLineModel' {
30102
30130
  batchManagementLineName: number;
30103
30131
  batchManagementCurrentLot: number;
30104
30132
  batchManagementEndOfDay: number;
30133
+ batchManagementCurrentBatchName: number;
30134
+ batchManagementCurrentBatchTimeBatch: number;
30135
+ batchManagementCurrentBatchCreatedTimestamp: number;
30136
+ recentLotPackruns: number;
30105
30137
  skipBrushesSweepRequest: number;
30106
30138
  finishPackrunBeginRequest: number;
30107
30139
  finishPackrunCancelRequest: number;
@@ -30120,7 +30152,7 @@ declare module '@ricado/api-client/Models/Packhouse/Site/PackingLineModel' {
30120
30152
  /**
30121
30153
  * The FreshPack Integration Configuration for this Packing Line
30122
30154
  *
30123
- * @type {?{points: {graders: number, binTypes: number, printerGroups: number, materialGroups: number, rejectCategories: number, productionFacilities: number, marketHolds: number, varieties: ?number, produces: ?number, growingMethods: ?number, fruitClasses: ?number, fruitSizes: ?number, packStyles: ?number, nssLabelTypes: ?number, multiGrowerBinProducts: ?number, apiCommunicationStatus: number, currentPackrunClearanceSummary: number, nextPackrunClearanceSummary: number, currentPackrunMarketHolds: ?number, nextPackrunMarketHolds: ?number, apiVersion: ?number, activePackrunName: ?number, activeTimeBatch: ?number, classTypeMultiGrowerBinProductIds: ?number}, enabled: boolean, graderIds: number[], apiBaseUrl: string, computerName: string, productionFacilityId: number, classTypeRejectCategoryIds: ?Array<{classType: string, rejectCategoryId: number}>, packrunSourceTrayClassTypes: ?string[]}}
30155
+ * @type {?{points: {graders: number, binTypes: number, printerGroups: number, materialGroups: number, rejectCategories: number, productionFacilities: number, marketHolds: number, varieties: ?number, produces: ?number, growingMethods: ?number, fruitClasses: ?number, fruitSizes: ?number, packStyles: ?number, nssLabelTypes: ?number, multiGrowerBinProducts: ?number, apiCommunicationStatus: number, currentPackrunClearanceSummary: number, nextPackrunClearanceSummary: number, currentPackrunMarketHolds: ?number, nextPackrunMarketHolds: ?number, apiVersion: ?number, activePackrunName: ?number, activeTimeBatch: ?number, classTypeMultiGrowerBinProductIds: ?number, packrunAutoImportEnabled: ?number}, enabled: boolean, graderIds: number[], apiBaseUrl: string, computerName: string, productionFacilityId: number, classTypeRejectCategoryIds: ?Array<{classType: string, rejectCategoryId: number}>, packrunSourceTrayClassTypes: ?string[]}}
30124
30156
  * @public
30125
30157
  */
30126
30158
  freshPackIntegration: {
@@ -30149,6 +30181,7 @@ declare module '@ricado/api-client/Models/Packhouse/Site/PackingLineModel' {
30149
30181
  activePackrunName: number | null;
30150
30182
  activeTimeBatch: number | null;
30151
30183
  classTypeMultiGrowerBinProductIds: number | null;
30184
+ packrunAutoImportEnabled: number | null;
30152
30185
  };
30153
30186
  enabled: boolean;
30154
30187
  graderIds: number[];
@@ -30198,7 +30231,7 @@ declare module '@ricado/api-client/Models/Packhouse/Site/PackingLineModel' {
30198
30231
  /**
30199
30232
  * The Optional Grower Notifications Configuration for this Packing Line
30200
30233
  *
30201
- * @type {?{points: {packingSoonAutoNotificationEnabled: number, packingSoonAutoNotificationSeconds: number, packingTodayAutoNotificationEnabled: number, packingTodayAutoNotificationTime: number, sendPackingTodayNotificationRequest: number, packingTodayNotificationProcessed: number, externalContactsCommunicationStatus: number, externalContactsCommunicationLastAttempt: number, externalContactsCommunicationLastError: number}, enabled: boolean}}
30234
+ * @type {?{points: {packingSoonAutoNotificationEnabled: number, packingSoonAutoNotificationSeconds: number, packingTodayAutoNotificationEnabled: number, packingTodayAutoNotificationTime: number, sendPackingTodayNotificationRequest: number, packingTodayNotificationProcessed: number, externalContactsCommunicationStatus: number, externalContactsCommunicationLastAttempt: number, externalContactsCommunicationLastError: number, allowSmsMessagesOvernight: number}, enabled: boolean}}
30202
30235
  * @public
30203
30236
  */
30204
30237
  growerNotifications: {
@@ -30212,6 +30245,7 @@ declare module '@ricado/api-client/Models/Packhouse/Site/PackingLineModel' {
30212
30245
  externalContactsCommunicationStatus: number;
30213
30246
  externalContactsCommunicationLastAttempt: number;
30214
30247
  externalContactsCommunicationLastError: number;
30248
+ allowSmsMessagesOvernight: number;
30215
30249
  };
30216
30250
  enabled: boolean;
30217
30251
  } | null;
@@ -30926,7 +30960,7 @@ declare module '@ricado/api-client/Models/Packhouse/Site/ReemoonSizerModel' {
30926
30960
  */
30927
30961
  sizerType: string;
30928
30962
  /**
30929
- * The Auto Create Batch Delay in Seconds for this Reemoon Sizer
30963
+ * The Auto Create Batch Delay in Milliseconds for this Reemoon Sizer. Only honoured when greater than 1200 ms on a Packrun Change or 500 ms on a Time Batch Change, otherwise the RTU default delay applies
30930
30964
  *
30931
30965
  * @type {number}
30932
30966
  * @public
@@ -31497,7 +31531,7 @@ declare module '@ricado/api-client/Models/Packhouse/Site/RejectBinScaleModel' {
31497
31531
  /**
31498
31532
  * The Points used by this Reject Bin Scale
31499
31533
  *
31500
- * @type {{weighButton: ?number, packrunButton: ?number, manualInterventionButton: ?number, clearIndicator: ?number, busyIndicator: ?number, packrunIndicator: ?number, manualInterventionIndicator: ?number, sirenControl: ?number, scaleTareRequest: ?number, scaleClearTareRequest: ?number, scaleZeroRequest: ?number, scaleStableStatus: number, scaleWeight: ?number, scaleNetWeight: ?number, scaleGrossWeight: ?number, scaleTareWeight: ?number, targetGrossWeight: ?number, currentLiveWeight: ?number, startLiveWeighingRequest: ?number, finishLiveWeighingRequest: ?number, fruitDeliveryActive: ?number, status: number, currentPackrunId: number, nextPackrunId: number, currentPackrunName: number, nextPackrunName: number, incorrectOperationStatus: ?number, currentPackrunIncorrectOperationsCount: ?number, totalIncorrectOperationsCount: ?number, manualInterventionStatus: ?number, currentPackrunManualInterventionsCount: ?number, totalManualInterventionsCount: ?number, currentPackrunBinsWeighedCount: number, totalBinsWeighedCount: number}}
31534
+ * @type {{weighButton: ?number, packrunButton: ?number, manualInterventionButton: ?number, clearIndicator: ?number, busyIndicator: ?number, packrunIndicator: ?number, manualInterventionIndicator: ?number, sirenControl: ?number, scaleTareRequest: ?number, scaleClearTareRequest: ?number, scaleZeroRequest: ?number, scaleStableStatus: number, scaleWeight: ?number, scaleNetWeight: ?number, scaleGrossWeight: ?number, scaleTareWeight: ?number, targetGrossWeight: ?number, currentLiveWeight: ?number, startLiveWeighingRequest: ?number, finishLiveWeighingRequest: ?number, resetErrorRequest: ?number, fruitDeliveryActive: ?number, status: number, currentPackrunId: number, nextPackrunId: number, currentPackrunName: number, nextPackrunName: number, incorrectOperationStatus: ?number, currentPackrunIncorrectOperationsCount: ?number, totalIncorrectOperationsCount: ?number, manualInterventionStatus: ?number, currentPackrunManualInterventionsCount: ?number, totalManualInterventionsCount: ?number, currentPackrunBinsWeighedCount: number, totalBinsWeighedCount: number}}
31501
31535
  * @public
31502
31536
  */
31503
31537
  points: {
@@ -31521,6 +31555,7 @@ declare module '@ricado/api-client/Models/Packhouse/Site/RejectBinScaleModel' {
31521
31555
  currentLiveWeight: number | null;
31522
31556
  startLiveWeighingRequest: number | null;
31523
31557
  finishLiveWeighingRequest: number | null;
31558
+ resetErrorRequest: number | null;
31524
31559
  fruitDeliveryActive: number | null;
31525
31560
  status: number;
31526
31561
  currentPackrunId: number;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ricado/api-client",
3
- "version": "2.7.10",
3
+ "version": "2.8.0",
4
4
  "description": "RICADO Gen 4 API Client Library for NodeJS and Browsers",
5
5
  "author": {
6
6
  "name": "Ash Neilson"
@@ -156,8 +156,8 @@ export default FruitProfileController;
156
156
  *
157
157
  * @typedef {Object} FruitProfileController.CreateData
158
158
  * @property {string} name The Fruit Profile Name
159
- * @property {string} description The Fruit Profile Description
160
- * @property {string} image The Fruit Profile Image Source
159
+ * @property {string} [description] The Fruit Profile Description
160
+ * @property {string} [image] The Fruit Profile Image Source
161
161
  * @property {number} nominalWarmUpDuration The Typical Warm Up Duration (in seconds) for a Sample to reach the Minimum Target Temperature
162
162
  * @property {number} minimumWithinTargetDuration The Minimum Duration (in seconds) that a Sample should be within the Min and Max Target Temperatures to be Compliant
163
163
  * @property {number} minimumTotalDuration The Minimum Duration (in seconds) that a Sample must be Dehydrated for to be Compliant
@@ -165,13 +165,13 @@ export default FruitProfileController;
165
165
  * @property {number} minimumTargetTemperature The Minimum Target Temperature for a Sample to be Compliant
166
166
  * @property {number} maximumTargetTemperature The Maximum Target Temperature for a Sample to be Compliant
167
167
  * @property {number} warmUpStartExpectedTemperature The Warm-Up Temperature for starting the Warm Up alerts
168
- * @property {number} warmUpStartExpectedRateOfChange The Warm-Up Start Expected Rate of Change
168
+ * @property {number} warmUpStartExpectedRateOfChange The Warm-Up Start Expected Rate of Change: the minimum Temperature rise in Degrees Celsius over the trailing 10 minute window expected once the Sample reaches the Start Expected Temperature. A Warm Up Warning is raised when the measured Rate of Change falls below the Expected Rate for the current stage
169
169
  * @property {number} warmUpStageTwoExpectedTemperature The Warm-Up Stage Two Expected Temperature
170
- * @property {number} warmUpStageTwoExpectedRateOfChange The Warm-Up Stage Two Expected Rate of Change
170
+ * @property {number} warmUpStageTwoExpectedRateOfChange The Warm-Up Stage Two Expected Rate of Change: the minimum Temperature rise in Degrees Celsius over the trailing 10 minute window expected once the Sample reaches the Stage Two Expected Temperature
171
171
  * @property {number} warmUpStageThreeExpectedTemperature The Warm-Up Stage Three Expected Temperature
172
- * @property {number} warmUpStageThreeExpectedRateOfChange The Warm-Up Stage Three Expected Rate of Change
172
+ * @property {number} warmUpStageThreeExpectedRateOfChange The Warm-Up Stage Three Expected Rate of Change: the minimum Temperature rise in Degrees Celsius over the trailing 10 minute window expected once the Sample reaches the Stage Three Expected Temperature
173
173
  * @property {number} warmUpEndExpectedTemperature The Warm-Up End Expected Temperature
174
- * @property {number} warmUpEndExpectedRateOfChange The Warm-Up End Expected Rate of Change
174
+ * @property {number} warmUpEndExpectedRateOfChange The Warm-Up End Expected Rate of Change: the minimum Temperature rise in Degrees Celsius over the trailing 10 minute window expected once the Sample reaches the End Expected Temperature
175
175
  * @memberof Controllers.Lab.Site
176
176
  */
177
177
 
@@ -189,12 +189,12 @@ export default FruitProfileController;
189
189
  * @property {number} [minimumTargetTemperature] The Minimum Target Temperature for a Sample to be Compliant
190
190
  * @property {number} [maximumTargetTemperature] The Maximum Target Temperature for a Sample to be Compliant
191
191
  * @property {number} [warmUpStartExpectedTemperature] The Warm-Up Temperature for starting the Warm Up alerts
192
- * @property {number} [warmUpStartExpectedRateOfChange] The Warm-Up Start Expected Rate of Change
192
+ * @property {number} [warmUpStartExpectedRateOfChange] The Warm-Up Start Expected Rate of Change: the minimum Temperature rise in Degrees Celsius over the trailing 10 minute window expected once the Sample reaches the Start Expected Temperature. A Warm Up Warning is raised when the measured Rate of Change falls below the Expected Rate for the current stage
193
193
  * @property {number} [warmUpStageTwoExpectedTemperature] The Warm-Up Stage Two Expected Temperature
194
- * @property {number} [warmUpStageTwoExpectedRateOfChange] The Warm-Up Stage Two Expected Rate of Change
194
+ * @property {number} [warmUpStageTwoExpectedRateOfChange] The Warm-Up Stage Two Expected Rate of Change: the minimum Temperature rise in Degrees Celsius over the trailing 10 minute window expected once the Sample reaches the Stage Two Expected Temperature
195
195
  * @property {number} [warmUpStageThreeExpectedTemperature] The Warm-Up Stage Three Expected Temperature
196
- * @property {number} [warmUpStageThreeExpectedRateOfChange] The Warm-Up Stage Three Expected Rate of Change
196
+ * @property {number} [warmUpStageThreeExpectedRateOfChange] The Warm-Up Stage Three Expected Rate of Change: the minimum Temperature rise in Degrees Celsius over the trailing 10 minute window expected once the Sample reaches the Stage Three Expected Temperature
197
197
  * @property {number} [warmUpEndExpectedTemperature] The Warm-Up End Expected Temperature
198
- * @property {number} [warmUpEndExpectedRateOfChange] The Warm-Up End Expected Rate of Change
198
+ * @property {number} [warmUpEndExpectedRateOfChange] The Warm-Up End Expected Rate of Change: the minimum Temperature rise in Degrees Celsius over the trailing 10 minute window expected once the Sample reaches the End Expected Temperature
199
199
  * @memberof Controllers.Lab.Site
200
200
  */
@@ -159,7 +159,7 @@ export default LabController;
159
159
  * @property {?number} [rtuId] The RTU this Lab belongs to
160
160
  * @property {string} name The Lab Name
161
161
  * @property {string} [shortName] A Short Name for the Lab Name. Typically used in Reports and Tables showing multiple Labs
162
- * @property {Object} points The Points used by this Lab
162
+ * @property {Object} [points] The Points used by this Lab
163
163
  * @property {Array<LabController.RackReference>} [racks] The Rack Objects that belong to this Lab
164
164
  * @property {string[]} [alarmGroups] The Alarm Groups that are used by this Lab
165
165
  * @property {?LabController.InspectIntegration} [inspectIntegration] The Inspect Integration Configuration for this Lab
@@ -162,7 +162,7 @@ export default CompacSizerController;
162
162
  * @property {string} name The Compac Sizer Name
163
163
  * @property {string} packingLineId The Packing Line ID that manages this Compac Sizer
164
164
  * @property {string} sizerType The Sizer Type
165
- * @property {number} [autoCreateBatchDelay] The Auto Create Batch Delay in Seconds for this Compac Sizer
165
+ * @property {number} [autoCreateBatchDelay] The Auto Create Batch Delay in Milliseconds for this Compac Sizer. Only honoured when greater than 1200 ms on a Packrun Change or 500 ms on a Time Batch Change, otherwise the RTU default delay applies
166
166
  * @property {{currentBatchId: number, currentBatchName: number, currentBatchGrowerCode: number, currentBatchVarietyId: number, currentBatchVarietyName: number, currentBatchComments: number, currentBatchStartTimestamp: number, currentBatchLayoutId: number, currentBatchLayoutName: number, currentBatchSizingProfileName: ?number, currentBatchFruitSizeProfile: ?number, currentBatchPackrunId: number, currentBatchPackrunName: 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, class1TraysPerHour: ?number}} points The Points used by this Compac Sizer
167
167
  * @property {Array<CompacSizerController.CompacSizerLane>} [lanes] The Lanes defined for this Compac Sizer
168
168
  * @property {Array<CompacSizerController.CompacSizerFrame>} [frames] An Optional Array of Frames defined for this Compac Sizer
@@ -180,7 +180,7 @@ export default CompacSizerController;
180
180
  * @property {string} [name] The Compac Sizer Name
181
181
  * @property {string} [packingLineId] The Packing Line ID that manages this Compac Sizer
182
182
  * @property {string} [sizerType] The Sizer Type
183
- * @property {number} [autoCreateBatchDelay] The Auto Create Batch Delay in Seconds for this Compac Sizer
183
+ * @property {number} [autoCreateBatchDelay] The Auto Create Batch Delay in Milliseconds for this Compac Sizer. Only honoured when greater than 1200 ms on a Packrun Change or 500 ms on a Time Batch Change, otherwise the RTU default delay applies
184
184
  * @property {{currentBatchId: number, currentBatchName: number, currentBatchGrowerCode: number, currentBatchVarietyId: number, currentBatchVarietyName: number, currentBatchComments: number, currentBatchStartTimestamp: number, currentBatchLayoutId: number, currentBatchLayoutName: number, currentBatchSizingProfileName: ?number, currentBatchFruitSizeProfile: ?number, currentBatchPackrunId: number, currentBatchPackrunName: 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, class1TraysPerHour: ?number}} [points] The Points used by this Compac Sizer
185
185
  * @property {Array<CompacSizerController.CompacSizerLane>} [lanes] The Lanes defined for this Compac Sizer
186
186
  * @property {Array<CompacSizerController.CompacSizerFrame>} [frames] An Optional Array of Frames defined for this Compac Sizer
@@ -158,7 +158,7 @@ export default GrowingMethodController;
158
158
  * @typedef {Object} GrowingMethodController.CreateData
159
159
  * @property {string} [code] The Growing Method Code
160
160
  * @property {string} name The Growing Method Name
161
- * @property {string} description The Growing Method Description
161
+ * @property {string} [description] The Growing Method Description
162
162
  * @memberof Controllers.Packhouse.Site
163
163
  */
164
164
 
@@ -162,7 +162,7 @@ export default MAFSizerController;
162
162
  * @property {string} name The MAF Sizer Name
163
163
  * @property {string} packingLineId The Packing Line ID that manages this MAF Sizer
164
164
  * @property {string} sizerType The Sizer Type
165
- * @property {number} [autoCreateBatchDelay] The Auto Create Batch Delay in Seconds for this MAF Sizer
165
+ * @property {number} [autoCreateBatchDelay] The Auto Create Batch Delay in Milliseconds for this MAF Sizer. Only honoured when greater than 1200 ms on a Packrun Change or 500 ms on a Time Batch Change, otherwise the RTU default delay applies
166
166
  * @property {{currentBatchId: number, currentBatchName: number, currentBatchGrowerCode: number, currentBatchGrowerName: number, currentBatchVarietyCode: number, currentBatchVarietyName: number, currentBatchPackrunId: number, currentBatchPackrunName: number, machineAverageFruitWeight: number, machineAverageFruitSize: number, machineCupFill: number, machineRecycledFruitPerMinute: number, machineTotalFruitPerMinute: number, machineTraysPerHour: number, machineTonnesPerHour: number, machineRodsPerMinute: number, outletGroupSummaries: number, packTypeOutletUtilizationTargets: number, class1TraysPerHour: ?number, createNewBatchRequest: ?number, createBatchOnPackrunChange: ?number, createBatchOnTimeBatchChange: ?number, restartServiceRequest: ?number}} points The Points used by this MAF Sizer
167
167
  * @property {Array<MAFSizerController.MAFSizerLane>} [lanes] The Lanes defined for this MAF Sizer
168
168
  * @property {Array<MAFSizerController.MAFSizerOutlet>} [outlets] The Outlets defined for this MAF Sizer
@@ -181,7 +181,7 @@ export default MAFSizerController;
181
181
  * @property {string} [name] The MAF Sizer Name
182
182
  * @property {string} [packingLineId] The Packing Line ID that manages this MAF Sizer
183
183
  * @property {string} [sizerType] The Sizer Type
184
- * @property {number} [autoCreateBatchDelay] The Auto Create Batch Delay in Seconds for this MAF Sizer
184
+ * @property {number} [autoCreateBatchDelay] The Auto Create Batch Delay in Milliseconds for this MAF Sizer. Only honoured when greater than 1200 ms on a Packrun Change or 500 ms on a Time Batch Change, otherwise the RTU default delay applies
185
185
  * @property {{currentBatchId: number, currentBatchName: number, currentBatchGrowerCode: number, currentBatchGrowerName: number, currentBatchVarietyCode: number, currentBatchVarietyName: number, currentBatchPackrunId: number, currentBatchPackrunName: number, machineAverageFruitWeight: number, machineAverageFruitSize: number, machineCupFill: number, machineRecycledFruitPerMinute: number, machineTotalFruitPerMinute: number, machineTraysPerHour: number, machineTonnesPerHour: number, machineRodsPerMinute: number, outletGroupSummaries: number, packTypeOutletUtilizationTargets: number, class1TraysPerHour: ?number, createNewBatchRequest: ?number, createBatchOnPackrunChange: ?number, createBatchOnTimeBatchChange: ?number, restartServiceRequest: ?number}} [points] The Points used by this MAF Sizer
186
186
  * @property {Array<MAFSizerController.MAFSizerLane>} [lanes] The Lanes defined for this MAF Sizer
187
187
  * @property {Array<MAFSizerController.MAFSizerOutlet>} [outlets] The Outlets defined for this MAF Sizer
@@ -546,6 +546,10 @@ export default PackingLineController;
546
546
  * @property {number} index An Index used to Order Steps and compare with the Current Step Point value
547
547
  * @property {string} type The Type of Step
548
548
  * @property {string[]} sizerIds An Array of Sizer IDs to be included in this Step
549
+ * @property {?number} [automationRunningPointId] Optional Boolean Point that reports whether Line Automation is running. While this Point is `false` the Auto Advance countdown is held
550
+ * @property {?number} [autoAdvanceTimeRemainingPointId] Optional Integer Point the RTU counts down (in Milliseconds) before Auto Advancing to the next Step. Set to `autoAdvanceDelay` when this Step becomes Active
551
+ * @property {?number} [autoAdvancePausedPointId] Optional Boolean Point that pauses the Auto Advance countdown while `true`. Reset to `false` when this Step becomes Active
552
+ * @property {?number} [autoAdvanceDelay] Optional Auto Advance Delay in Milliseconds written to the Time Remaining Point when this Step becomes Active. Auto Advance only occurs when both this and `autoAdvanceTimeRemainingPointId` are set
549
553
  * @memberof Controllers.Packhouse.Site
550
554
  */
551
555
 
@@ -579,7 +583,7 @@ export default PackingLineController;
579
583
  * @property {?string} subtitle An Optional Subtitle for this Auto MAF Action Step
580
584
  * @property {string} description A Description for this Auto MAF Action Step
581
585
  * @property {string} actionType Type of MAF Action to be performed
582
- * @property {string} trigger When this Action should be performed. 'begin' performed once when this Step becomes Active. 'end' performed once when this Step is no longer Active. 'always' performed constantly while this Step is Active
586
+ * @property {string} actionTrigger When this Action should be performed. 'begin' performed once when this Step becomes Active. 'end' performed once when this Step is no longer Active. 'always' performed constantly while this Step is Active
583
587
  * @property {?any} actionReference An Optional Reference for this Action (e.g. The Internal MAF Name of a Sizer or Numeric Sizer ID
584
588
  * @memberof Controllers.Packhouse.Site
585
589
  */
@@ -594,7 +598,7 @@ export default PackingLineController;
594
598
  * @property {?string} subtitle An Optional Subtitle for this Manual MAF Action Step
595
599
  * @property {string} description A Description for this Manual MAF Action Step
596
600
  * @property {string} actionType Type of MAF Action to be performed
597
- * @property {string} trigger When this Action should be performed. 'begin' performed once when this Step becomes Active. 'end' performed once when this Step is no longer Active. 'always' performed constantly while this Step is Active
601
+ * @property {string} actionTrigger When this Action should be performed. 'begin' performed once when this Step becomes Active. 'end' performed once when this Step is no longer Active. 'always' performed constantly while this Step is Active
598
602
  * @property {?any} actionReference An Optional Reference for this Action (e.g. The Internal MAF Name of a Sizer or Numeric Sizer ID
599
603
  * @memberof Controllers.Packhouse.Site
600
604
  */
@@ -613,7 +617,7 @@ export default PackingLineController;
613
617
  * A **MafIntegration** Type
614
618
  *
615
619
  * @typedef {Object} PackingLineController.MafIntegration
616
- * @property {{apiCommunicationStatus: number, batchManagementStateNumber: number, batchManagementStateMessage: number, batchManagementLineName: number, batchManagementCurrentLot: number, batchManagementEndOfDay: number, skipBrushesSweepRequest: number, finishPackrunBeginRequest: number, finishPackrunCancelRequest: number, finishPackrunAdvanceRequest: number, finishPackrunSkipStepRequest: number, finishPackrunCurrentStep: number, timeBatchChangeBeginRequest: number, timeBatchChangeCancelRequest: number, timeBatchChangeAdvanceRequest: number, timeBatchChangeSkipStepRequest: number, timeBatchChangeCurrentStep: number}} points The Points used for this MAF Integration
620
+ * @property {{apiCommunicationStatus: number, batchManagementStateNumber: number, batchManagementStateMessage: number, batchManagementLineName: number, batchManagementCurrentLot: number, batchManagementEndOfDay: number, batchManagementCurrentBatchName: number, batchManagementCurrentBatchTimeBatch: number, batchManagementCurrentBatchCreatedTimestamp: number, recentLotPackruns: number, skipBrushesSweepRequest: number, finishPackrunBeginRequest: number, finishPackrunCancelRequest: number, finishPackrunAdvanceRequest: number, finishPackrunSkipStepRequest: number, finishPackrunCurrentStep: number, timeBatchChangeBeginRequest: number, timeBatchChangeCancelRequest: number, timeBatchChangeAdvanceRequest: number, timeBatchChangeSkipStepRequest: number, timeBatchChangeCurrentStep: number}} points The Points used for this MAF Integration
617
621
  * @property {boolean} enabled Whether the MAF Integration is Enabled on this Packing Line
618
622
  * @property {string} tracAddress The IP Address or Server Name of the MAF TRAC PC
619
623
  * @memberof Controllers.Packhouse.Site
@@ -632,7 +636,7 @@ export default PackingLineController;
632
636
  * A **FreshPackIntegration** Type
633
637
  *
634
638
  * @typedef {Object} PackingLineController.FreshPackIntegration
635
- * @property {{graders: number, binTypes: number, printerGroups: number, materialGroups: number, rejectCategories: number, productionFacilities: number, marketHolds: number, varieties: ?number, produces: ?number, growingMethods: ?number, fruitClasses: ?number, fruitSizes: ?number, packStyles: ?number, nssLabelTypes: ?number, multiGrowerBinProducts: ?number, apiCommunicationStatus: number, currentPackrunClearanceSummary: number, nextPackrunClearanceSummary: number, currentPackrunMarketHolds: ?number, nextPackrunMarketHolds: ?number, apiVersion: ?number, activePackrunName: ?number, activeTimeBatch: ?number, classTypeMultiGrowerBinProductIds: ?number}} points The Points used for this FreshPack Integration
639
+ * @property {{graders: number, binTypes: number, printerGroups: number, materialGroups: number, rejectCategories: number, productionFacilities: number, marketHolds: number, varieties: ?number, produces: ?number, growingMethods: ?number, fruitClasses: ?number, fruitSizes: ?number, packStyles: ?number, nssLabelTypes: ?number, multiGrowerBinProducts: ?number, apiCommunicationStatus: number, currentPackrunClearanceSummary: number, nextPackrunClearanceSummary: number, currentPackrunMarketHolds: ?number, nextPackrunMarketHolds: ?number, apiVersion: ?number, activePackrunName: ?number, activeTimeBatch: ?number, classTypeMultiGrowerBinProductIds: ?number, packrunAutoImportEnabled: ?number}} points The Points used for this FreshPack Integration
636
640
  * @property {boolean} enabled Whether the FreshPack Integration is Enabled on this Packing Line
637
641
  * @property {number[]} graderIds An Array of FreshPack Grader IDs that relate to this Packing Line
638
642
  * @property {string} apiBaseUrl Base URL of the FreshPack Web Portal API
@@ -664,7 +668,7 @@ export default PackingLineController;
664
668
  * A **GrowerNotifications** Type
665
669
  *
666
670
  * @typedef {Object} PackingLineController.GrowerNotifications
667
- * @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
671
+ * @property {{packingSoonAutoNotificationEnabled: number, packingSoonAutoNotificationSeconds: number, packingTodayAutoNotificationEnabled: number, packingTodayAutoNotificationTime: number, sendPackingTodayNotificationRequest: number, packingTodayNotificationProcessed: number, externalContactsCommunicationStatus: number, externalContactsCommunicationLastAttempt: number, externalContactsCommunicationLastError: number, allowSmsMessagesOvernight: number}} points The Points used for Grower Notifications
668
672
  * @property {boolean} enabled Whether the Grower Notifications Integration is Enabled on this Packing Line
669
673
  * @memberof Controllers.Packhouse.Site
670
674
  */