@ricado/api-client 2.5.18 → 2.6.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/lib/index.d.ts CHANGED
@@ -14290,6 +14290,10 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/MAFSizerBatchContr
14290
14290
  * The Packrun ID associated with this Batch
14291
14291
  */
14292
14292
  packrunId?: string | null | undefined;
14293
+ /**
14294
+ * When the Final Update from the MAF Sizer Orphea Database has been Received
14295
+ */
14296
+ finalOrpheaUpdate?: Date | null | undefined;
14293
14297
  /**
14294
14298
  * An Array of Summary Data Objects for each Article
14295
14299
  */
@@ -14302,6 +14306,18 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/MAFSizerBatchContr
14302
14306
  * An Array of Summary Data Objects for each Fruit Size and Article
14303
14307
  */
14304
14308
  fruitSummaries?: FruitSummary[] | undefined;
14309
+ /**
14310
+ * An Array of Summary Data Objects for each Outlet by Fruit Size and Article
14311
+ */
14312
+ outletFruitSummaries?: OutletFruitSummary[] | undefined;
14313
+ /**
14314
+ * An Array of Size Names and Indexes
14315
+ */
14316
+ sizeNames?: SizeNameLookup[] | undefined;
14317
+ /**
14318
+ * An Array of Article Names and Indexes
14319
+ */
14320
+ articleNames?: ArticleNameLookup[] | undefined;
14305
14321
  };
14306
14322
  /**
14307
14323
  * The Update Data for a MAF Sizer Batch
@@ -14343,6 +14359,10 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/MAFSizerBatchContr
14343
14359
  * The Packrun ID associated with this Batch
14344
14360
  */
14345
14361
  packrunId?: string | null | undefined;
14362
+ /**
14363
+ * When the Final Update from the MAF Sizer Orphea Database has been Received
14364
+ */
14365
+ finalOrpheaUpdate?: Date | null | undefined;
14346
14366
  /**
14347
14367
  * An Array of Summary Data Objects for each Article
14348
14368
  */
@@ -14355,6 +14375,18 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/MAFSizerBatchContr
14355
14375
  * An Array of Summary Data Objects for each Fruit Size and Article
14356
14376
  */
14357
14377
  fruitSummaries?: FruitSummary[] | undefined;
14378
+ /**
14379
+ * An Array of Summary Data Objects for each Outlet by Fruit Size and Article
14380
+ */
14381
+ outletFruitSummaries?: OutletFruitSummary[] | undefined;
14382
+ /**
14383
+ * An Array of Size Names and Indexes
14384
+ */
14385
+ sizeNames?: SizeNameLookup[] | undefined;
14386
+ /**
14387
+ * An Array of Article Names and Indexes
14388
+ */
14389
+ articleNames?: ArticleNameLookup[] | undefined;
14358
14390
  };
14359
14391
  /**
14360
14392
  * A **UserAccount** Type
@@ -14399,6 +14431,10 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/MAFSizerBatchContr
14399
14431
  * A **ArticleSummary** Type
14400
14432
  */
14401
14433
  type ArticleSummary = {
14434
+ /**
14435
+ * The Article Index
14436
+ */
14437
+ index: number | null;
14402
14438
  /**
14403
14439
  * The Article Name
14404
14440
  */
@@ -14428,19 +14464,68 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/MAFSizerBatchContr
14428
14464
  * The Fruit Weight expressed in Kilograms
14429
14465
  */
14430
14466
  fruitWeight: number;
14467
+ /**
14468
+ * An Array of Article Indexes that have been Seen assigned to the Outlet
14469
+ */
14470
+ seenArticles: number[];
14471
+ /**
14472
+ * An Array of Article Indexes that have are Actively assigned to the Outlet
14473
+ */
14474
+ activeArticles: number[];
14431
14475
  };
14432
14476
  /**
14433
14477
  * A **FruitSummary** Type
14434
14478
  */
14435
14479
  type FruitSummary = {
14480
+ /**
14481
+ * The Size Index
14482
+ */
14483
+ sizeIndex: number;
14484
+ /**
14485
+ * The Size Name
14486
+ */
14487
+ sizeName: string;
14488
+ /**
14489
+ * The Article Index
14490
+ */
14491
+ articleIndex: number;
14436
14492
  /**
14437
14493
  * The Article Name
14438
14494
  */
14439
14495
  articleName: string;
14440
14496
  /**
14441
- * The Fruit Size
14497
+ * The Fruit Count
14442
14498
  */
14443
- fruitSize: string;
14499
+ fruitCount: number;
14500
+ /**
14501
+ * The Fruit Weight expressed in Kilograms
14502
+ */
14503
+ fruitWeight: number;
14504
+ };
14505
+ /**
14506
+ * A **OutletFruitSummary** Type
14507
+ */
14508
+ type OutletFruitSummary = {
14509
+ /**
14510
+ * The Outlet Number
14511
+ */
14512
+ outletNumber: number;
14513
+ /**
14514
+ * The Size Index
14515
+ */
14516
+ sizeIndex: number;
14517
+ /**
14518
+ * The Size Name
14519
+ */
14520
+ sizeName: string;
14521
+ /**
14522
+ * The Article Index
14523
+ */
14524
+ articleIndex: number;
14525
+ /**
14526
+ * The Article Name
14527
+ */
14528
+ articleName: string;
14444
14529
  /**
14445
14530
  * The Fruit Count
14446
14531
  */
@@ -14450,6 +14535,32 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/MAFSizerBatchContr
14450
14535
  */
14451
14536
  fruitWeight: number;
14452
14537
  };
14538
+ /**
14539
+ * A **SizeNameLookup** Type
14540
+ */
14541
+ type SizeNameLookup = {
14542
+ /**
14543
+ * The Size Index
14544
+ */
14545
+ index: number;
14546
+ /**
14547
+ * The Size Name
14548
+ */
14549
+ name: string;
14550
+ };
14551
+ /**
14552
+ * A **ArticleNameLookup** Type
14553
+ */
14554
+ type ArticleNameLookup = {
14555
+ /**
14556
+ * The Article Index
14557
+ */
14558
+ index: number;
14559
+ /**
14560
+ * The Article Name
14561
+ */
14562
+ name: string;
14563
+ };
14453
14564
  }
14454
14565
  import MAFSizerBatchModel from "@ricado/api-client/Models/Packhouse/Site/MAFSizerBatchModel";
14455
14566
  }
@@ -15274,6 +15385,10 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/MAFSizerPackrunSum
15274
15385
  * An Array of Packrun Summary Data Objects for each Class Type
15275
15386
  */
15276
15387
  classTypeSummaries?: ClassTypeSummary[] | undefined;
15388
+ /**
15389
+ * An Array of Packrun Summary Data Objects for each Outlet
15390
+ */
15391
+ outletSummaries?: OutletSummary[] | undefined;
15277
15392
  /**
15278
15393
  * An Array that contains the Articles initially Assigned to each Outlet
15279
15394
  */
@@ -15303,6 +15418,10 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/MAFSizerPackrunSum
15303
15418
  * An Array of Packrun Summary Data Objects for each Class Type
15304
15419
  */
15305
15420
  classTypeSummaries?: ClassTypeSummary[] | undefined;
15421
+ /**
15422
+ * An Array of Packrun Summary Data Objects for each Outlet
15423
+ */
15424
+ outletSummaries?: OutletSummary[] | undefined;
15306
15425
  /**
15307
15426
  * An Array that contains the Articles initially Assigned to each Outlet
15308
15427
  */
@@ -15389,6 +15508,56 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/MAFSizerPackrunSum
15389
15508
  */
15390
15509
  totals: ClassTypeTotal[];
15391
15510
  };
15511
+ /**
15512
+ * A **OutletTotal** Type
15513
+ */
15514
+ type OutletTotal = {
15515
+ /**
15516
+ * The Class Type
15517
+ */
15518
+ classType: string | null;
15519
+ /**
15520
+ * The Fruit Size
15521
+ */
15522
+ fruitSize: string;
15523
+ /**
15524
+ * The Pack Type
15525
+ */
15526
+ packType: string | null;
15527
+ /**
15528
+ * The Weight expressed in Kilograms
15529
+ */
15530
+ weight: number;
15531
+ /**
15532
+ * The Fruit Count
15533
+ */
15534
+ fruitCount: number;
15535
+ /**
15536
+ * The Number of Packs
15537
+ */
15538
+ packCount: number | null;
15539
+ };
15540
+ /**
15541
+ * A **OutletSummary** Type
15542
+ */
15543
+ type OutletSummary = {
15544
+ /**
15545
+ * The Outlet Name
15546
+ */
15547
+ name: string;
15548
+ /**
15549
+ * The Generic Outlet Type
15550
+ */
15551
+ type: string;
15552
+ /**
15553
+ * The Outlet Number
15554
+ */
15555
+ number: number;
15556
+ /**
15557
+ * An Array of Totals for the Outlet
15558
+ */
15559
+ totals: OutletTotal[];
15560
+ };
15392
15561
  /**
15393
15562
  * A **InitialOutletArticle** Type
15394
15563
  */
@@ -16894,6 +17063,7 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/PackingLineControl
16894
17063
  currentPackrunFutureStorageDefectsCount: number;
16895
17064
  currentPackrunRejectAnalysisSamples: number | null;
16896
17065
  currentPackrunMaturityAreaSamples: number | null;
17066
+ currentPackrunCustomSamples: number | null;
16897
17067
  sampleTypes: number | null;
16898
17068
  };
16899
17069
  /**
@@ -16924,6 +17094,10 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/PackingLineControl
16924
17094
  * An Array of FreshQuality Sample Type IDs that should be fetched for Maturity Area Samples on this Packing Line
16925
17095
  */
16926
17096
  maturityAreaSampleTypeIds: number[];
17097
+ /**
17098
+ * An Array of FreshQuality Sample Type IDs that should be fetched for Custom Samples on this Packing Line
17099
+ */
17100
+ customSampleTypeIds: number[];
16927
17101
  };
16928
17102
  }
16929
17103
  import PackingLineModel from "@ricado/api-client/Models/Packhouse/Site/PackingLineModel";
@@ -17445,6 +17619,14 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/PackrunController'
17445
17619
  * The Percentage of Total Fruit that was Recycled for the Batch
17446
17620
  */
17447
17621
  recyclePercentage: number;
17622
+ /**
17623
+ * The Incoming Fruit Count for the Batch
17624
+ */
17625
+ incomingFruitCount: number;
17626
+ /**
17627
+ * The Incoming Fruit Weight (kg) for the Batch
17628
+ */
17629
+ incomingFruitWeight: number;
17448
17630
  };
17449
17631
  /**
17450
17632
  * A **SizerItem** Type
@@ -17532,6 +17714,18 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/PackrunController'
17532
17714
  */
17533
17715
  compacSizers: any[];
17534
17716
  sizers: SizerItem[];
17717
+ /**
17718
+ * The IDs of the Sizers that directly receive Fruit from the Infeed
17719
+ */
17720
+ incomingSizerIds: string[];
17721
+ /**
17722
+ * The Incoming Fruit Count of all Incoming Sizers
17723
+ */
17724
+ incomingSizersFruitCount: number;
17725
+ /**
17726
+ * The Incoming Fruit Weight of all Incoming Sizers
17727
+ */
17728
+ incomingSizersFruitWeight: number;
17535
17729
  /**
17536
17730
  * The Reject Bin Summary for the Packrun
17537
17731
  */
@@ -26654,13 +26848,21 @@ declare module '@ricado/api-client/Models/Packhouse/Site/MAFSizerBatchModel' {
26654
26848
  * @public
26655
26849
  */
26656
26850
  packrunId: string | null;
26851
+ /**
26852
+ * When the Final Update from the MAF Sizer Orphea Database has been Received
26853
+ *
26854
+ * @type {?Date}
26855
+ * @public
26856
+ */
26857
+ finalOrpheaUpdate: Date | null;
26657
26858
  /**
26658
26859
  * An Array of Summary Data Objects for each Article
26659
26860
  *
26660
- * @type {Array<{name: string, fruitCount: number, fruitWeight: number}>}
26861
+ * @type {Array<{index: ?number, name: string, fruitCount: number, fruitWeight: number}>}
26661
26862
  * @public
26662
26863
  */
26663
26864
  articleSummaries: {
26865
+ index: number | null;
26664
26866
  name: string;
26665
26867
  fruitCount: number;
26666
26868
  fruitWeight: number;
@@ -26668,26 +26870,65 @@ declare module '@ricado/api-client/Models/Packhouse/Site/MAFSizerBatchModel' {
26668
26870
  /**
26669
26871
  * An Array of Summary Data Objects for each Outlet
26670
26872
  *
26671
- * @type {Array<{number: number, fruitCount: number, fruitWeight: number}>}
26873
+ * @type {Array<{number: number, fruitCount: number, fruitWeight: number, seenArticles: number[], activeArticles: number[]}>}
26672
26874
  * @public
26673
26875
  */
26674
26876
  outletSummaries: {
26675
26877
  number: number;
26676
26878
  fruitCount: number;
26677
26879
  fruitWeight: number;
26880
+ seenArticles: number[];
26881
+ activeArticles: number[];
26678
26882
  }[];
26679
26883
  /**
26680
26884
  * An Array of Summary Data Objects for each Fruit Size and Article
26681
26885
  *
26682
- * @type {Array<{articleName: string, fruitSize: string, fruitCount: number, fruitWeight: number}>}
26886
+ * @type {Array<{sizeIndex: number, sizeName: string, articleIndex: number, articleName: string, fruitCount: number, fruitWeight: number}>}
26683
26887
  * @public
26684
26888
  */
26685
26889
  fruitSummaries: {
26890
+ sizeIndex: number;
26891
+ sizeName: string;
26892
+ articleIndex: number;
26893
+ articleName: string;
26894
+ fruitCount: number;
26895
+ fruitWeight: number;
26896
+ }[];
26897
+ /**
26898
+ * An Array of Summary Data Objects for each Outlet by Fruit Size and Article
26899
+ *
26900
+ * @type {Array<{outletNumber: number, sizeIndex: number, sizeName: string, articleIndex: number, articleName: string, fruitCount: number, fruitWeight: number}>}
26901
+ * @public
26902
+ */
26903
+ outletFruitSummaries: {
26904
+ outletNumber: number;
26905
+ sizeIndex: number;
26906
+ sizeName: string;
26907
+ articleIndex: number;
26686
26908
  articleName: string;
26687
- fruitSize: string;
26688
26909
  fruitCount: number;
26689
26910
  fruitWeight: number;
26690
26911
  }[];
26912
+ /**
26913
+ * An Array of Size Names and Indexes
26914
+ *
26915
+ * @type {Array<{index: number, name: string}>}
26916
+ * @public
26917
+ */
26918
+ sizeNames: {
26919
+ index: number;
26920
+ name: string;
26921
+ }[];
26922
+ /**
26923
+ * An Array of Article Names and Indexes
26924
+ *
26925
+ * @type {Array<{index: number, name: string}>}
26926
+ * @public
26927
+ */
26928
+ articleNames: {
26929
+ index: number;
26930
+ name: string;
26931
+ }[];
26691
26932
  /**
26692
26933
  * Whether the MAF Sizer Batch has been deleted
26693
26934
  *
@@ -27112,6 +27353,25 @@ declare module '@ricado/api-client/Models/Packhouse/Site/MAFSizerPackrunSummaryM
27112
27353
  packCount: number | null;
27113
27354
  }[];
27114
27355
  }[];
27356
+ /**
27357
+ * An Array of Packrun Summary Data Objects for each Outlet
27358
+ *
27359
+ * @type {Array<{name: string, type: string, number: number, totals: Array<{classType: ?string, fruitSize: string, packType: ?string, weight: number, fruitCount: number, packCount: ?number}>}>}
27360
+ * @public
27361
+ */
27362
+ outletSummaries: {
27363
+ name: string;
27364
+ type: string;
27365
+ number: number;
27366
+ totals: {
27367
+ classType: string | null;
27368
+ fruitSize: string;
27369
+ packType: string | null;
27370
+ weight: number;
27371
+ fruitCount: number;
27372
+ packCount: number | null;
27373
+ }[];
27374
+ }[];
27115
27375
  /**
27116
27376
  * An Array that contains the Articles initially Assigned to each Outlet
27117
27377
  *
@@ -27813,7 +28073,7 @@ declare module '@ricado/api-client/Models/Packhouse/Site/PackingLineModel' {
27813
28073
  /**
27814
28074
  * The FreshQuality Integration Configuration for this Packing Line
27815
28075
  *
27816
- * @type {?{points: {currentPackrunSamples: number, apiCommunicationStatus: number, currentPackrunMajorPackingDefects: number, currentPackrunMinorPackingDefects: number, currentPackrunTotalPackingDefects: number, currentPackrunFutureStorageDefects: number, currentPackrunMajorPackingDefectsCount: number, currentPackrunMinorPackingDefectsCount: number, currentPackrunTotalPackingDefectsCount: number, currentPackrunFutureStorageDefectsCount: number, currentPackrunRejectAnalysisSamples: ?number, currentPackrunMaturityAreaSamples: ?number, sampleTypes: ?number}, enabled: boolean, username: string, password: string, apiBaseUrl: string, sampleTypeIds: number[], rejectAnalysisSampleTypeIds: number[], maturityAreaSampleTypeIds: number[]}}
28076
+ * @type {?{points: {currentPackrunSamples: number, apiCommunicationStatus: number, currentPackrunMajorPackingDefects: number, currentPackrunMinorPackingDefects: number, currentPackrunTotalPackingDefects: number, currentPackrunFutureStorageDefects: number, currentPackrunMajorPackingDefectsCount: number, currentPackrunMinorPackingDefectsCount: number, currentPackrunTotalPackingDefectsCount: number, currentPackrunFutureStorageDefectsCount: number, currentPackrunRejectAnalysisSamples: ?number, currentPackrunMaturityAreaSamples: ?number, currentPackrunCustomSamples: ?number, sampleTypes: ?number}, enabled: boolean, username: string, password: string, apiBaseUrl: string, sampleTypeIds: number[], rejectAnalysisSampleTypeIds: number[], maturityAreaSampleTypeIds: number[], customSampleTypeIds: number[]}}
27817
28077
  * @public
27818
28078
  */
27819
28079
  freshQualityIntegration: {
@@ -27830,6 +28090,7 @@ declare module '@ricado/api-client/Models/Packhouse/Site/PackingLineModel' {
27830
28090
  currentPackrunFutureStorageDefectsCount: number;
27831
28091
  currentPackrunRejectAnalysisSamples: number | null;
27832
28092
  currentPackrunMaturityAreaSamples: number | null;
28093
+ currentPackrunCustomSamples: number | null;
27833
28094
  sampleTypes: number | null;
27834
28095
  };
27835
28096
  enabled: boolean;
@@ -27839,6 +28100,7 @@ declare module '@ricado/api-client/Models/Packhouse/Site/PackingLineModel' {
27839
28100
  sampleTypeIds: number[];
27840
28101
  rejectAnalysisSampleTypeIds: number[];
27841
28102
  maturityAreaSampleTypeIds: number[];
28103
+ customSampleTypeIds: number[];
27842
28104
  } | null;
27843
28105
  /**
27844
28106
  * Whether the Packing Line has been deleted
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ricado/api-client",
3
- "version": "2.5.18",
3
+ "version": "2.6.1",
4
4
  "description": "RICADO Gen 4 API Client Library for NodeJS and Browsers",
5
5
  "author": {
6
6
  "name": "Ash Neilson"
@@ -978,9 +978,13 @@ export default MAFSizerBatchController;
978
978
  * @property {?string} [varietyName] The Variety Name
979
979
  * @property {number} totalWeight The Total Weight Processed for this Batch
980
980
  * @property {?string} [packrunId] The Packrun ID associated with this Batch
981
+ * @property {?Date} [finalOrpheaUpdate] When the Final Update from the MAF Sizer Orphea Database has been Received
981
982
  * @property {Array<MAFSizerBatchController.ArticleSummary>} [articleSummaries] An Array of Summary Data Objects for each Article
982
983
  * @property {Array<MAFSizerBatchController.OutletSummary>} [outletSummaries] An Array of Summary Data Objects for each Outlet
983
984
  * @property {Array<MAFSizerBatchController.FruitSummary>} [fruitSummaries] An Array of Summary Data Objects for each Fruit Size and Article
985
+ * @property {Array<MAFSizerBatchController.OutletFruitSummary>} [outletFruitSummaries] An Array of Summary Data Objects for each Outlet by Fruit Size and Article
986
+ * @property {Array<MAFSizerBatchController.SizeNameLookup>} [sizeNames] An Array of Size Names and Indexes
987
+ * @property {Array<MAFSizerBatchController.ArticleNameLookup>} [articleNames] An Array of Article Names and Indexes
984
988
  * @memberof Controllers.Packhouse.Site
985
989
  */
986
990
 
@@ -997,9 +1001,13 @@ export default MAFSizerBatchController;
997
1001
  * @property {?string} [varietyName] The Variety Name
998
1002
  * @property {number} [totalWeight] The Total Weight Processed for this Batch
999
1003
  * @property {?string} [packrunId] The Packrun ID associated with this Batch
1004
+ * @property {?Date} [finalOrpheaUpdate] When the Final Update from the MAF Sizer Orphea Database has been Received
1000
1005
  * @property {Array<MAFSizerBatchController.ArticleSummary>} [articleSummaries] An Array of Summary Data Objects for each Article
1001
1006
  * @property {Array<MAFSizerBatchController.OutletSummary>} [outletSummaries] An Array of Summary Data Objects for each Outlet
1002
1007
  * @property {Array<MAFSizerBatchController.FruitSummary>} [fruitSummaries] An Array of Summary Data Objects for each Fruit Size and Article
1008
+ * @property {Array<MAFSizerBatchController.OutletFruitSummary>} [outletFruitSummaries] An Array of Summary Data Objects for each Outlet by Fruit Size and Article
1009
+ * @property {Array<MAFSizerBatchController.SizeNameLookup>} [sizeNames] An Array of Size Names and Indexes
1010
+ * @property {Array<MAFSizerBatchController.ArticleNameLookup>} [articleNames] An Array of Article Names and Indexes
1003
1011
  * @memberof Controllers.Packhouse.Site
1004
1012
  */
1005
1013
 
@@ -1029,6 +1037,7 @@ export default MAFSizerBatchController;
1029
1037
  * A **ArticleSummary** Type
1030
1038
  *
1031
1039
  * @typedef {Object} MAFSizerBatchController.ArticleSummary
1040
+ * @property {?number} index The Article Index
1032
1041
  * @property {string} name The Article Name
1033
1042
  * @property {number} fruitCount The Fruit Count
1034
1043
  * @property {number} fruitWeight The Fruit Weight expressed in Kilograms
@@ -1042,6 +1051,8 @@ export default MAFSizerBatchController;
1042
1051
  * @property {number} number The Outlet Number
1043
1052
  * @property {number} fruitCount The Fruit Count
1044
1053
  * @property {number} fruitWeight The Fruit Weight expressed in Kilograms
1054
+ * @property {number[]} seenArticles An Array of Article Indexes that have been Seen assigned to the Outlet
1055
+ * @property {number[]} activeArticles An Array of Article Indexes that have are Actively assigned to the Outlet
1045
1056
  * @memberof Controllers.Packhouse.Site
1046
1057
  */
1047
1058
 
@@ -1049,9 +1060,43 @@ export default MAFSizerBatchController;
1049
1060
  * A **FruitSummary** Type
1050
1061
  *
1051
1062
  * @typedef {Object} MAFSizerBatchController.FruitSummary
1063
+ * @property {number} sizeIndex The Size Index
1064
+ * @property {string} sizeName The Size Name
1065
+ * @property {number} articleIndex The Article Index
1052
1066
  * @property {string} articleName The Article Name
1053
- * @property {string} fruitSize The Fruit Size
1054
1067
  * @property {number} fruitCount The Fruit Count
1055
1068
  * @property {number} fruitWeight The Fruit Weight expressed in Kilograms
1056
1069
  * @memberof Controllers.Packhouse.Site
1070
+ */
1071
+
1072
+ /**
1073
+ * A **OutletFruitSummary** Type
1074
+ *
1075
+ * @typedef {Object} MAFSizerBatchController.OutletFruitSummary
1076
+ * @property {number} outletNumber The Outlet Number
1077
+ * @property {number} sizeIndex The Size Index
1078
+ * @property {string} sizeName The Size Name
1079
+ * @property {number} articleIndex The Article Index
1080
+ * @property {string} articleName The Article Name
1081
+ * @property {number} fruitCount The Fruit Count
1082
+ * @property {number} fruitWeight The Fruit Weight expressed in Kilograms
1083
+ * @memberof Controllers.Packhouse.Site
1084
+ */
1085
+
1086
+ /**
1087
+ * A **SizeNameLookup** Type
1088
+ *
1089
+ * @typedef {Object} MAFSizerBatchController.SizeNameLookup
1090
+ * @property {number} index The Size Index
1091
+ * @property {string} name The Size Name
1092
+ * @memberof Controllers.Packhouse.Site
1093
+ */
1094
+
1095
+ /**
1096
+ * A **ArticleNameLookup** Type
1097
+ *
1098
+ * @typedef {Object} MAFSizerBatchController.ArticleNameLookup
1099
+ * @property {number} index The Article Index
1100
+ * @property {string} name The Article Name
1101
+ * @memberof Controllers.Packhouse.Site
1057
1102
  */
@@ -972,6 +972,7 @@ export default MAFSizerPackrunSummaryController;
972
972
  * @property {Date} [createdTimestamp] When this Summary was Created
973
973
  * @property {?string} [timeBatchId] The Time Batch this Summary is associated with
974
974
  * @property {Array<MAFSizerPackrunSummaryController.ClassTypeSummary>} [classTypeSummaries] An Array of Packrun Summary Data Objects for each Class Type
975
+ * @property {Array<MAFSizerPackrunSummaryController.OutletSummary>} [outletSummaries] An Array of Packrun Summary Data Objects for each Outlet
975
976
  * @property {Array<MAFSizerPackrunSummaryController.InitialOutletArticle>} [initialOutletArticles] An Array that contains the Articles initially Assigned to each Outlet
976
977
  * @property {Array<MAFSizerPackrunSummaryController.InitialOutletType>} [initialOutletTypes] An Array that contains the Types initially configured for each Outlet
977
978
  * @memberof Controllers.Packhouse.Site
@@ -985,6 +986,7 @@ export default MAFSizerPackrunSummaryController;
985
986
  * @property {Date} [createdTimestamp] When this Summary was Created
986
987
  * @property {?string} [timeBatchId] The Time Batch this Summary is associated with
987
988
  * @property {Array<MAFSizerPackrunSummaryController.ClassTypeSummary>} [classTypeSummaries] An Array of Packrun Summary Data Objects for each Class Type
989
+ * @property {Array<MAFSizerPackrunSummaryController.OutletSummary>} [outletSummaries] An Array of Packrun Summary Data Objects for each Outlet
988
990
  * @property {Array<MAFSizerPackrunSummaryController.InitialOutletArticle>} [initialOutletArticles] An Array that contains the Articles initially Assigned to each Outlet
989
991
  * @property {Array<MAFSizerPackrunSummaryController.InitialOutletType>} [initialOutletTypes] An Array that contains the Types initially configured for each Outlet
990
992
  * @memberof Controllers.Packhouse.Site
@@ -1033,6 +1035,30 @@ export default MAFSizerPackrunSummaryController;
1033
1035
  * @memberof Controllers.Packhouse.Site
1034
1036
  */
1035
1037
 
1038
+ /**
1039
+ * A **OutletTotal** Type
1040
+ *
1041
+ * @typedef {Object} MAFSizerPackrunSummaryController.OutletTotal
1042
+ * @property {?string} classType The Class Type
1043
+ * @property {string} fruitSize The Fruit Size
1044
+ * @property {?string} packType The Pack Type
1045
+ * @property {number} weight The Weight expressed in Kilograms
1046
+ * @property {number} fruitCount The Fruit Count
1047
+ * @property {?number} packCount The Number of Packs
1048
+ * @memberof Controllers.Packhouse.Site
1049
+ */
1050
+
1051
+ /**
1052
+ * A **OutletSummary** Type
1053
+ *
1054
+ * @typedef {Object} MAFSizerPackrunSummaryController.OutletSummary
1055
+ * @property {string} name The Outlet Name
1056
+ * @property {string} type The Generic Outlet Type
1057
+ * @property {number} number The Outlet Number
1058
+ * @property {Array<MAFSizerPackrunSummaryController.OutletTotal>} totals An Array of Totals for the Outlet
1059
+ * @memberof Controllers.Packhouse.Site
1060
+ */
1061
+
1036
1062
  /**
1037
1063
  * A **InitialOutletArticle** Type
1038
1064
  *
@@ -645,7 +645,7 @@ export default PackingLineController;
645
645
  * A **FreshQualityIntegration** Type
646
646
  *
647
647
  * @typedef {Object} PackingLineController.FreshQualityIntegration
648
- * @property {{currentPackrunSamples: number, apiCommunicationStatus: number, currentPackrunMajorPackingDefects: number, currentPackrunMinorPackingDefects: number, currentPackrunTotalPackingDefects: number, currentPackrunFutureStorageDefects: number, currentPackrunMajorPackingDefectsCount: number, currentPackrunMinorPackingDefectsCount: number, currentPackrunTotalPackingDefectsCount: number, currentPackrunFutureStorageDefectsCount: number, currentPackrunRejectAnalysisSamples: ?number, currentPackrunMaturityAreaSamples: ?number, sampleTypes: ?number}} points The Points used for this FreshQuality Integration
648
+ * @property {{currentPackrunSamples: number, apiCommunicationStatus: number, currentPackrunMajorPackingDefects: number, currentPackrunMinorPackingDefects: number, currentPackrunTotalPackingDefects: number, currentPackrunFutureStorageDefects: number, currentPackrunMajorPackingDefectsCount: number, currentPackrunMinorPackingDefectsCount: number, currentPackrunTotalPackingDefectsCount: number, currentPackrunFutureStorageDefectsCount: number, currentPackrunRejectAnalysisSamples: ?number, currentPackrunMaturityAreaSamples: ?number, currentPackrunCustomSamples: ?number, sampleTypes: ?number}} points The Points used for this FreshQuality Integration
649
649
  * @property {boolean} enabled Whether the FreshQuality Integration is Enabled on this Packing Line
650
650
  * @property {string} username Username for Authenticating with the FreshQuality API
651
651
  * @property {string} password Password for Authenticating with the FreshQuality API
@@ -653,5 +653,6 @@ export default PackingLineController;
653
653
  * @property {number[]} sampleTypeIds An Array of FreshQuality Sample Type IDs that are used for Class 1 R600 on this Packing Line
654
654
  * @property {number[]} rejectAnalysisSampleTypeIds An Array of FreshQuality Sample Type IDs that are used for Reject Analysis on this Packing Line
655
655
  * @property {number[]} maturityAreaSampleTypeIds An Array of FreshQuality Sample Type IDs that should be fetched for Maturity Area Samples on this Packing Line
656
+ * @property {number[]} customSampleTypeIds An Array of FreshQuality Sample Type IDs that should be fetched for Custom Samples on this Packing Line
656
657
  * @memberof Controllers.Packhouse.Site
657
658
  */