@ricado/api-client 2.5.18 → 2.6.0

package/lib/Models/Packhouse/Site/MAFSizerPackrunSummaryModel.js

@@ -103,6 +103,14 @@ var MAFSizerPackrunSummaryModel = /*#__PURE__*/function (_BaseModel) {
      */
 
     _this.classTypeSummaries = [];
+    /**
+     * An Array of Packrun Summary Data Objects for each Outlet
+     * 
+     * @type {Array<{name: string, type: string, number: number, totals: Array<{classType: ?string, fruitSize: string, packType: ?string, weight: number, fruitCount: number, packCount: ?number}>}>}
+     * @public
+     */
+
+    _this.outletSummaries = [];
     /**
      * An Array that contains the Articles initially Assigned to each Outlet
      * 
@@ -342,6 +350,160 @@ var MAFSizerPackrunSummaryModel = /*#__PURE__*/function (_BaseModel) {
         }();
       }
 
+      if ('outletSummaries' in jsonObject) {
+        model.outletSummaries = function () {
+          if (Array.isArray(jsonObject['outletSummaries']) !== true) {
+            return [];
+          }
+
+          return jsonObject['outletSummaries'].map(function (outletSummariesItem) {
+            return function () {
+              var outletSummariesItemObject = {};
+
+              if (_typeof(outletSummariesItem) === 'object' && 'name' in outletSummariesItem) {
+                outletSummariesItemObject.name = function () {
+                  if (typeof outletSummariesItem.name !== 'string') {
+                    return String(outletSummariesItem.name);
+                  }
+
+                  return outletSummariesItem.name;
+                }();
+              } else {
+                outletSummariesItemObject.name = "";
+              }
+
+              if (_typeof(outletSummariesItem) === 'object' && 'type' in outletSummariesItem) {
+                outletSummariesItemObject.type = function () {
+                  if (typeof outletSummariesItem.type !== 'string') {
+                    return String(outletSummariesItem.type);
+                  }
+
+                  return outletSummariesItem.type;
+                }();
+              } else {
+                outletSummariesItemObject.type = "";
+              }
+
+              if (_typeof(outletSummariesItem) === 'object' && 'number' in outletSummariesItem) {
+                outletSummariesItemObject.number = function () {
+                  if (typeof outletSummariesItem.number !== 'number') {
+                    return Number.isInteger(Number(outletSummariesItem.number)) ? Number(outletSummariesItem.number) : Math.floor(Number(outletSummariesItem.number));
+                  }
+
+                  return Number.isInteger(outletSummariesItem.number) ? outletSummariesItem.number : Math.floor(outletSummariesItem.number);
+                }();
+              } else {
+                outletSummariesItemObject.number = 0;
+              }
+
+              if (_typeof(outletSummariesItem) === 'object' && 'totals' in outletSummariesItem) {
+                outletSummariesItemObject.totals = function () {
+                  if (Array.isArray(outletSummariesItem.totals) !== true) {
+                    return [];
+                  }
+
+                  return outletSummariesItem.totals.map(function (totalsItem) {
+                    return function () {
+                      var totalsItemObject = {};
+
+                      if (_typeof(totalsItem) === 'object' && 'classType' in totalsItem) {
+                        totalsItemObject.classType = function () {
+                          if (totalsItem.classType === null) {
+                            return null;
+                          }
+
+                          if (typeof totalsItem.classType !== 'string') {
+                            return String(totalsItem.classType);
+                          }
+
+                          return totalsItem.classType;
+                        }();
+                      } else {
+                        totalsItemObject.classType = null;
+                      }
+
+                      if (_typeof(totalsItem) === 'object' && 'fruitSize' in totalsItem) {
+                        totalsItemObject.fruitSize = function () {
+                          if (typeof totalsItem.fruitSize !== 'string') {
+                            return String(totalsItem.fruitSize);
+                          }
+
+                          return totalsItem.fruitSize;
+                        }();
+                      } else {
+                        totalsItemObject.fruitSize = "";
+                      }
+
+                      if (_typeof(totalsItem) === 'object' && 'packType' in totalsItem) {
+                        totalsItemObject.packType = function () {
+                          if (totalsItem.packType === null) {
+                            return null;
+                          }
+
+                          if (typeof totalsItem.packType !== 'string') {
+                            return String(totalsItem.packType);
+                          }
+
+                          return totalsItem.packType;
+                        }();
+                      } else {
+                        totalsItemObject.packType = null;
+                      }
+
+                      if (_typeof(totalsItem) === 'object' && 'weight' in totalsItem) {
+                        totalsItemObject.weight = function () {
+                          if (typeof totalsItem.weight !== 'number') {
+                            return Number(totalsItem.weight);
+                          }
+
+                          return totalsItem.weight;
+                        }();
+                      } else {
+                        totalsItemObject.weight = 0;
+                      }
+
+                      if (_typeof(totalsItem) === 'object' && 'fruitCount' in totalsItem) {
+                        totalsItemObject.fruitCount = function () {
+                          if (typeof totalsItem.fruitCount !== 'number') {
+                            return Number.isInteger(Number(totalsItem.fruitCount)) ? Number(totalsItem.fruitCount) : Math.floor(Number(totalsItem.fruitCount));
+                          }
+
+                          return Number.isInteger(totalsItem.fruitCount) ? totalsItem.fruitCount : Math.floor(totalsItem.fruitCount);
+                        }();
+                      } else {
+                        totalsItemObject.fruitCount = 0;
+                      }
+
+                      if (_typeof(totalsItem) === 'object' && 'packCount' in totalsItem) {
+                        totalsItemObject.packCount = function () {
+                          if (totalsItem.packCount === null) {
+                            return null;
+                          }
+
+                          if (typeof totalsItem.packCount !== 'number') {
+                            return Number(totalsItem.packCount);
+                          }
+
+                          return totalsItem.packCount;
+                        }();
+                      } else {
+                        totalsItemObject.packCount = null;
+                      }
+
+                      return totalsItemObject;
+                    }();
+                  });
+                }();
+              } else {
+                outletSummariesItemObject.totals = [];
+              }
+
+              return outletSummariesItemObject;
+            }();
+          });
+        }();
+      }
+
       if ('initialOutletArticles' in jsonObject) {
         model.initialOutletArticles = function () {
           if (Array.isArray(jsonObject['initialOutletArticles']) !== true) {

package/lib/PackageVersion.js

@@ -5,5 +5,5 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.version = void 0;
 // Generated by genversion.
-var version = '2.5.18';
+var version = '2.6.0';
 exports.version = version;

package/lib/index.d.ts

@@ -14290,6 +14290,10 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/MAFSizerBatchContr
                         * The Packrun ID associated with this Batch
                         */
                     packrunId?: string | null | undefined;
+                    /**
+                        * When the Final Update from the MAF Sizer Orphea Database has been Received
+                        */
+                    finalOrpheaUpdate?: Date | null | undefined;
                     /**
                         * An Array of Summary Data Objects for each Article
                         */
@@ -14302,6 +14306,18 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/MAFSizerBatchContr
                         * An Array of Summary Data Objects for each Fruit Size and Article
                         */
                     fruitSummaries?: FruitSummary[] | undefined;
+                    /**
+                        * An Array of Summary Data Objects for each Outlet by Fruit Size and Article
+                        */
+                    outletFruitSummaries?: OutletFruitSummary[] | undefined;
+                    /**
+                        * An Array of Size Names and Indexes
+                        */
+                    sizeNames?: SizeNameLookup[] | undefined;
+                    /**
+                        * An Array of Article Names and Indexes
+                        */
+                    articleNames?: ArticleNameLookup[] | undefined;
             };
             /**
                 * The Update Data for a MAF Sizer Batch
@@ -14343,6 +14359,10 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/MAFSizerBatchContr
                         * The Packrun ID associated with this Batch
                         */
                     packrunId?: string | null | undefined;
+                    /**
+                        * When the Final Update from the MAF Sizer Orphea Database has been Received
+                        */
+                    finalOrpheaUpdate?: Date | null | undefined;
                     /**
                         * An Array of Summary Data Objects for each Article
                         */
@@ -14355,6 +14375,18 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/MAFSizerBatchContr
                         * An Array of Summary Data Objects for each Fruit Size and Article
                         */
                     fruitSummaries?: FruitSummary[] | undefined;
+                    /**
+                        * An Array of Summary Data Objects for each Outlet by Fruit Size and Article
+                        */
+                    outletFruitSummaries?: OutletFruitSummary[] | undefined;
+                    /**
+                        * An Array of Size Names and Indexes
+                        */
+                    sizeNames?: SizeNameLookup[] | undefined;
+                    /**
+                        * An Array of Article Names and Indexes
+                        */
+                    articleNames?: ArticleNameLookup[] | undefined;
             };
             /**
                 * A **UserAccount** Type
@@ -14399,6 +14431,10 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/MAFSizerBatchContr
                 * A **ArticleSummary** Type
                 */
             type ArticleSummary = {
+                    /**
+                        * The Article Index
+                        */
+                    index: number | null;
                     /**
                         * The Article Name
                         */
@@ -14428,19 +14464,68 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/MAFSizerBatchContr
                         * The Fruit Weight expressed in Kilograms
                         */
                     fruitWeight: number;
+                    /**
+                        * An Array of Article Indexes that have been Seen assigned to the Outlet
+                        */
+                    seenArticles: number[];
+                    /**
+                        * An Array of Article Indexes that have are Actively assigned to the Outlet
+                        */
+                    activeArticles: number[];
             };
             /**
                 * A **FruitSummary** Type
                 */
             type FruitSummary = {
+                    /**
+                        * The Size Index
+                        */
+                    sizeIndex: number;
+                    /**
+                        * The Size Name
+                        */
+                    sizeName: string;
+                    /**
+                        * The Article Index
+                        */
+                    articleIndex: number;
                     /**
                         * The Article Name
                         */
                     articleName: string;
                     /**
-                        * The Fruit Size
+                        * The Fruit Count
                         */
-                    fruitSize: string;
+                    fruitCount: number;
+                    /**
+                        * The Fruit Weight expressed in Kilograms
+                        */
+                    fruitWeight: number;
+            };
+            /**
+                * A **OutletFruitSummary** Type
+                */
+            type OutletFruitSummary = {
+                    /**
+                        * The Outlet Number
+                        */
+                    outletNumber: number;
+                    /**
+                        * The Size Index
+                        */
+                    sizeIndex: number;
+                    /**
+                        * The Size Name
+                        */
+                    sizeName: string;
+                    /**
+                        * The Article Index
+                        */
+                    articleIndex: number;
+                    /**
+                        * The Article Name
+                        */
+                    articleName: string;
                     /**
                         * The Fruit Count
                         */
@@ -14450,6 +14535,32 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/MAFSizerBatchContr
                         */
                     fruitWeight: number;
             };
+            /**
+                * A **SizeNameLookup** Type
+                */
+            type SizeNameLookup = {
+                    /**
+                        * The Size Index
+                        */
+                    index: number;
+                    /**
+                        * The Size Name
+                        */
+                    name: string;
+            };
+            /**
+                * A **ArticleNameLookup** Type
+                */
+            type ArticleNameLookup = {
+                    /**
+                        * The Article Index
+                        */
+                    index: number;
+                    /**
+                        * The Article Name
+                        */
+                    name: string;
+            };
     }
     import MAFSizerBatchModel from "@ricado/api-client/Models/Packhouse/Site/MAFSizerBatchModel";
 }
@@ -15274,6 +15385,10 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/MAFSizerPackrunSum
                         * An Array of Packrun Summary Data Objects for each Class Type
                         */
                     classTypeSummaries?: ClassTypeSummary[] | undefined;
+                    /**
+                        * An Array of Packrun Summary Data Objects for each Outlet
+                        */
+                    outletSummaries?: OutletSummary[] | undefined;
                     /**
                         * An Array that contains the Articles initially Assigned to each Outlet
                         */
@@ -15303,6 +15418,10 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/MAFSizerPackrunSum
                         * An Array of Packrun Summary Data Objects for each Class Type
                         */
                     classTypeSummaries?: ClassTypeSummary[] | undefined;
+                    /**
+                        * An Array of Packrun Summary Data Objects for each Outlet
+                        */
+                    outletSummaries?: OutletSummary[] | undefined;
                     /**
                         * An Array that contains the Articles initially Assigned to each Outlet
                         */
@@ -15389,6 +15508,56 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/MAFSizerPackrunSum
                         */
                     totals: ClassTypeTotal[];
             };
+            /**
+                * A **OutletTotal** Type
+                */
+            type OutletTotal = {
+                    /**
+                        * The Class Type
+                        */
+                    classType: string | null;
+                    /**
+                        * The Fruit Size
+                        */
+                    fruitSize: string;
+                    /**
+                        * The Pack Type
+                        */
+                    packType: string | null;
+                    /**
+                        * The Weight expressed in Kilograms
+                        */
+                    weight: number;
+                    /**
+                        * The Fruit Count
+                        */
+                    fruitCount: number;
+                    /**
+                        * The Number of Packs
+                        */
+                    packCount: number | null;
+            };
+            /**
+                * A **OutletSummary** Type
+                */
+            type OutletSummary = {
+                    /**
+                        * The Outlet Name
+                        */
+                    name: string;
+                    /**
+                        * The Generic Outlet Type
+                        */
+                    type: string;
+                    /**
+                        * The Outlet Number
+                        */
+                    number: number;
+                    /**
+                        * An Array of Totals for the Outlet
+                        */
+                    totals: OutletTotal[];
+            };
             /**
                 * A **InitialOutletArticle** Type
                 */
@@ -17445,6 +17614,14 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/PackrunController'
                         * The Percentage of Total Fruit that was Recycled for the Batch
                         */
                     recyclePercentage: number;
+                    /**
+                        * The Incoming Fruit Count for the Batch
+                        */
+                    incomingFruitCount: number;
+                    /**
+                        * The Incoming Fruit Weight (kg) for the Batch
+                        */
+                    incomingFruitWeight: number;
             };
             /**
                 * A **SizerItem** Type
@@ -17532,6 +17709,18 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/PackrunController'
                         */
                     compacSizers: any[];
                     sizers: SizerItem[];
+                    /**
+                        * The IDs of the Sizers that directly receive Fruit from the Infeed
+                        */
+                    incomingSizerIds: string[];
+                    /**
+                        * The Incoming Fruit Count of all Incoming Sizers
+                        */
+                    incomingSizersFruitCount: number;
+                    /**
+                        * The Incoming Fruit Weight of all Incoming Sizers
+                        */
+                    incomingSizersFruitWeight: number;
                     /**
                         * The Reject Bin Summary for the Packrun
                         */
@@ -26654,13 +26843,21 @@ declare module '@ricado/api-client/Models/Packhouse/Site/MAFSizerBatchModel' {
                 * @public
                 */
             packrunId: string | null;
+            /**
+                * When the Final Update from the MAF Sizer Orphea Database has been Received
+                *
+                * @type {?Date}
+                * @public
+                */
+            finalOrpheaUpdate: Date | null;
             /**
                 * An Array of Summary Data Objects for each Article
                 *
-                * @type {Array<{name: string, fruitCount: number, fruitWeight: number}>}
+                * @type {Array<{index: ?number, name: string, fruitCount: number, fruitWeight: number}>}
                 * @public
                 */
             articleSummaries: {
+                    index: number | null;
                     name: string;
                     fruitCount: number;
                     fruitWeight: number;
@@ -26668,26 +26865,65 @@ declare module '@ricado/api-client/Models/Packhouse/Site/MAFSizerBatchModel' {
             /**
                 * An Array of Summary Data Objects for each Outlet
                 *
-                * @type {Array<{number: number, fruitCount: number, fruitWeight: number}>}
+                * @type {Array<{number: number, fruitCount: number, fruitWeight: number, seenArticles: number[], activeArticles: number[]}>}
                 * @public
                 */
             outletSummaries: {
                     number: number;
                     fruitCount: number;
                     fruitWeight: number;
+                    seenArticles: number[];
+                    activeArticles: number[];
             }[];
             /**
                 * An Array of Summary Data Objects for each Fruit Size and Article
                 *
-                * @type {Array<{articleName: string, fruitSize: string, fruitCount: number, fruitWeight: number}>}
+                * @type {Array<{sizeIndex: number, sizeName: string, articleIndex: number, articleName: string, fruitCount: number, fruitWeight: number}>}
                 * @public
                 */
             fruitSummaries: {
+                    sizeIndex: number;
+                    sizeName: string;
+                    articleIndex: number;
+                    articleName: string;
+                    fruitCount: number;
+                    fruitWeight: number;
+            }[];
+            /**
+                * An Array of Summary Data Objects for each Outlet by Fruit Size and Article
+                *
+                * @type {Array<{outletNumber: number, sizeIndex: number, sizeName: string, articleIndex: number, articleName: string, fruitCount: number, fruitWeight: number}>}
+                * @public
+                */
+            outletFruitSummaries: {
+                    outletNumber: number;
+                    sizeIndex: number;
+                    sizeName: string;
+                    articleIndex: number;
                     articleName: string;
-                    fruitSize: string;
                     fruitCount: number;
                     fruitWeight: number;
             }[];
+            /**
+                * An Array of Size Names and Indexes
+                *
+                * @type {Array<{index: number, name: string}>}
+                * @public
+                */
+            sizeNames: {
+                    index: number;
+                    name: string;
+            }[];
+            /**
+                * An Array of Article Names and Indexes
+                *
+                * @type {Array<{index: number, name: string}>}
+                * @public
+                */
+            articleNames: {
+                    index: number;
+                    name: string;
+            }[];
             /**
                 * Whether the MAF Sizer Batch has been deleted
                 *
@@ -27112,6 +27348,25 @@ declare module '@ricado/api-client/Models/Packhouse/Site/MAFSizerPackrunSummaryM
                             packCount: number | null;
                     }[];
             }[];
+            /**
+                * An Array of Packrun Summary Data Objects for each Outlet
+                *
+                * @type {Array<{name: string, type: string, number: number, totals: Array<{classType: ?string, fruitSize: string, packType: ?string, weight: number, fruitCount: number, packCount: ?number}>}>}
+                * @public
+                */
+            outletSummaries: {
+                    name: string;
+                    type: string;
+                    number: number;
+                    totals: {
+                            classType: string | null;
+                            fruitSize: string;
+                            packType: string | null;
+                            weight: number;
+                            fruitCount: number;
+                            packCount: number | null;
+                    }[];
+            }[];
             /**
                 * An Array that contains the Articles initially Assigned to each Outlet
                 *

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ricado/api-client",
-    "version": "2.5.18",
+    "version": "2.6.0",
     "description": "RICADO Gen 4 API Client Library for NodeJS and Browsers",
     "author": {
         "name": "Ash Neilson"

package/src/Controllers/Packhouse/Site/MAFSizerBatchController.js

@@ -978,9 +978,13 @@ export default MAFSizerBatchController;
  * @property {?string} [varietyName] The Variety Name
  * @property {number} totalWeight The Total Weight Processed for this Batch
  * @property {?string} [packrunId] The Packrun ID associated with this Batch
+ * @property {?Date} [finalOrpheaUpdate] When the Final Update from the MAF Sizer Orphea Database has been Received
  * @property {Array<MAFSizerBatchController.ArticleSummary>} [articleSummaries] An Array of Summary Data Objects for each Article
  * @property {Array<MAFSizerBatchController.OutletSummary>} [outletSummaries] An Array of Summary Data Objects for each Outlet
  * @property {Array<MAFSizerBatchController.FruitSummary>} [fruitSummaries] An Array of Summary Data Objects for each Fruit Size and Article
+ * @property {Array<MAFSizerBatchController.OutletFruitSummary>} [outletFruitSummaries] An Array of Summary Data Objects for each Outlet by Fruit Size and Article
+ * @property {Array<MAFSizerBatchController.SizeNameLookup>} [sizeNames] An Array of Size Names and Indexes
+ * @property {Array<MAFSizerBatchController.ArticleNameLookup>} [articleNames] An Array of Article Names and Indexes
  * @memberof Controllers.Packhouse.Site
  */
 
@@ -997,9 +1001,13 @@ export default MAFSizerBatchController;
  * @property {?string} [varietyName] The Variety Name
  * @property {number} [totalWeight] The Total Weight Processed for this Batch
  * @property {?string} [packrunId] The Packrun ID associated with this Batch
+ * @property {?Date} [finalOrpheaUpdate] When the Final Update from the MAF Sizer Orphea Database has been Received
  * @property {Array<MAFSizerBatchController.ArticleSummary>} [articleSummaries] An Array of Summary Data Objects for each Article
  * @property {Array<MAFSizerBatchController.OutletSummary>} [outletSummaries] An Array of Summary Data Objects for each Outlet
  * @property {Array<MAFSizerBatchController.FruitSummary>} [fruitSummaries] An Array of Summary Data Objects for each Fruit Size and Article
+ * @property {Array<MAFSizerBatchController.OutletFruitSummary>} [outletFruitSummaries] An Array of Summary Data Objects for each Outlet by Fruit Size and Article
+ * @property {Array<MAFSizerBatchController.SizeNameLookup>} [sizeNames] An Array of Size Names and Indexes
+ * @property {Array<MAFSizerBatchController.ArticleNameLookup>} [articleNames] An Array of Article Names and Indexes
  * @memberof Controllers.Packhouse.Site
  */
 
@@ -1029,6 +1037,7 @@ export default MAFSizerBatchController;
  * A **ArticleSummary** Type
  * 
  * @typedef {Object} MAFSizerBatchController.ArticleSummary
+ * @property {?number} index The Article Index
  * @property {string} name The Article Name
  * @property {number} fruitCount The Fruit Count
  * @property {number} fruitWeight The Fruit Weight expressed in Kilograms
@@ -1042,6 +1051,8 @@ export default MAFSizerBatchController;
  * @property {number} number The Outlet Number
  * @property {number} fruitCount The Fruit Count
  * @property {number} fruitWeight The Fruit Weight expressed in Kilograms
+ * @property {number[]} seenArticles An Array of Article Indexes that have been Seen assigned to the Outlet
+ * @property {number[]} activeArticles An Array of Article Indexes that have are Actively assigned to the Outlet
  * @memberof Controllers.Packhouse.Site
  */
 
@@ -1049,9 +1060,43 @@ export default MAFSizerBatchController;
  * A **FruitSummary** Type
  * 
  * @typedef {Object} MAFSizerBatchController.FruitSummary
+ * @property {number} sizeIndex The Size Index
+ * @property {string} sizeName The Size Name
+ * @property {number} articleIndex The Article Index
  * @property {string} articleName The Article Name
- * @property {string} fruitSize The Fruit Size
  * @property {number} fruitCount The Fruit Count
  * @property {number} fruitWeight The Fruit Weight expressed in Kilograms
  * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **OutletFruitSummary** Type
+ * 
+ * @typedef {Object} MAFSizerBatchController.OutletFruitSummary
+ * @property {number} outletNumber The Outlet Number
+ * @property {number} sizeIndex The Size Index
+ * @property {string} sizeName The Size Name
+ * @property {number} articleIndex The Article Index
+ * @property {string} articleName The Article Name
+ * @property {number} fruitCount The Fruit Count
+ * @property {number} fruitWeight The Fruit Weight expressed in Kilograms
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **SizeNameLookup** Type
+ * 
+ * @typedef {Object} MAFSizerBatchController.SizeNameLookup
+ * @property {number} index The Size Index
+ * @property {string} name The Size Name
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **ArticleNameLookup** Type
+ * 
+ * @typedef {Object} MAFSizerBatchController.ArticleNameLookup
+ * @property {number} index The Article Index
+ * @property {string} name The Article Name
+ * @memberof Controllers.Packhouse.Site
  */