@ricado/api-client 2.7.0 → 2.7.2

package/lib/Controllers/Packhouse/Site/MAFSizerController.js

@@ -293,6 +293,7 @@ var _default = MAFSizerController;
  * @typedef {Object} MAFSizerController.ArticleClassType
  * @property {string} articleName Name of the MAF Sizer Article
  * @property {string} classType The Class Type for this MAF Sizer Article
+ * @property {string} matchType The Match Type used when Evaluating the Product Name
  * @memberof Controllers.Packhouse.Site
  */
 

package/lib/Controllers/Packhouse/Site/PackrunController.js

@@ -1460,6 +1460,72 @@ var PackrunController = /*#__PURE__*/function () {
               resultObject.classTypeTotals = [];
             }
 
+            if (_typeof(result) === 'object' && 'classTypeFruitSizeTotals' in result) {
+              resultObject.classTypeFruitSizeTotals = function () {
+                if (Array.isArray(result.classTypeFruitSizeTotals) !== true) {
+                  return [];
+                }
+
+                return result.classTypeFruitSizeTotals.map(function (classTypeFruitSizeTotalsItem) {
+                  return function () {
+                    var classTypeFruitSizeTotalsItemObject = {};
+
+                    if (_typeof(classTypeFruitSizeTotalsItem) === 'object' && 'classType' in classTypeFruitSizeTotalsItem) {
+                      classTypeFruitSizeTotalsItemObject.classType = function () {
+                        if (typeof classTypeFruitSizeTotalsItem.classType !== 'string') {
+                          return String(classTypeFruitSizeTotalsItem.classType);
+                        }
+
+                        return classTypeFruitSizeTotalsItem.classType;
+                      }();
+                    } else {
+                      classTypeFruitSizeTotalsItemObject.classType = "";
+                    }
+
+                    if (_typeof(classTypeFruitSizeTotalsItem) === 'object' && 'fruitSize' in classTypeFruitSizeTotalsItem) {
+                      classTypeFruitSizeTotalsItemObject.fruitSize = function () {
+                        if (typeof classTypeFruitSizeTotalsItem.fruitSize !== 'string') {
+                          return String(classTypeFruitSizeTotalsItem.fruitSize);
+                        }
+
+                        return classTypeFruitSizeTotalsItem.fruitSize;
+                      }();
+                    } else {
+                      classTypeFruitSizeTotalsItemObject.fruitSize = "";
+                    }
+
+                    if (_typeof(classTypeFruitSizeTotalsItem) === 'object' && 'fruitCount' in classTypeFruitSizeTotalsItem) {
+                      classTypeFruitSizeTotalsItemObject.fruitCount = function () {
+                        if (typeof classTypeFruitSizeTotalsItem.fruitCount !== 'number') {
+                          return Number.isInteger(Number(classTypeFruitSizeTotalsItem.fruitCount)) ? Number(classTypeFruitSizeTotalsItem.fruitCount) : Math.floor(Number(classTypeFruitSizeTotalsItem.fruitCount));
+                        }
+
+                        return Number.isInteger(classTypeFruitSizeTotalsItem.fruitCount) ? classTypeFruitSizeTotalsItem.fruitCount : Math.floor(classTypeFruitSizeTotalsItem.fruitCount);
+                      }();
+                    } else {
+                      classTypeFruitSizeTotalsItemObject.fruitCount = 0;
+                    }
+
+                    if (_typeof(classTypeFruitSizeTotalsItem) === 'object' && 'fruitWeight' in classTypeFruitSizeTotalsItem) {
+                      classTypeFruitSizeTotalsItemObject.fruitWeight = function () {
+                        if (typeof classTypeFruitSizeTotalsItem.fruitWeight !== 'number') {
+                          return Number(classTypeFruitSizeTotalsItem.fruitWeight);
+                        }
+
+                        return classTypeFruitSizeTotalsItem.fruitWeight;
+                      }();
+                    } else {
+                      classTypeFruitSizeTotalsItemObject.fruitWeight = 0;
+                    }
+
+                    return classTypeFruitSizeTotalsItemObject;
+                  }();
+                });
+              }();
+            } else {
+              resultObject.classTypeFruitSizeTotals = [];
+            }
+
             if (_typeof(result) === 'object' && 'class1SizerSummary' in result) {
               resultObject.class1SizerSummary = function () {
                 if (Array.isArray(result.class1SizerSummary) !== true) {
@@ -2483,6 +2549,136 @@ var PackrunController = /*#__PURE__*/function () {
             return _PackrunModel.default.fromJSON(result, siteId);
           }();
 
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+    /**
+     * Retrieve Tipped Bins for all Packruns [GET /packhouse/sites/{siteId}/packruns/tippedBins]
+     * 
+     * Retrieves the Tipped Bins for all Packruns
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {Date} createdTimestampBegin Filter by the Timestamp when Packruns were Created. Results Greater than or Equal to Timestamp
+     * @param {Date} createdTimestampEnd Filter by the Timestamp when Packruns were Created. Results Less than or Equal to Timestamp
+     * @return {Promise<Array<PackrunController.PackrunTippedBinsItem>>}
+     */
+
+  }, {
+    key: "getAllTippedBins",
+    value: function getAllTippedBins(siteId, createdTimestampBegin, createdTimestampEnd) {
+      return new Promise(function (resolve, reject) {
+        var queryParameters = {};
+
+        _RequestHelper.default.getRequest("/packhouse/sites/".concat(siteId, "/packruns/tippedBins"), Object.assign(queryParameters, {
+          createdTimestampBegin: createdTimestampBegin,
+          createdTimestampEnd: createdTimestampEnd
+        })).then(function (result) {
+          var resolveValue = function () {
+            if (Array.isArray(result) !== true) {
+              return [];
+            }
+
+            return result.map(function (resultItem) {
+              return function () {
+                var resultItemObject = {};
+
+                if (_typeof(resultItem) === 'object' && 'packrunId' in resultItem) {
+                  resultItemObject.packrunId = function () {
+                    if (typeof resultItem.packrunId !== 'string') {
+                      return String(resultItem.packrunId);
+                    }
+
+                    return resultItem.packrunId;
+                  }();
+                } else {
+                  resultItemObject.packrunId = "";
+                }
+
+                if (_typeof(resultItem) === 'object' && 'tippedBins' in resultItem) {
+                  resultItemObject.tippedBins = function () {
+                    if (typeof resultItem.tippedBins !== 'number') {
+                      return Number.isInteger(Number(resultItem.tippedBins)) ? Number(resultItem.tippedBins) : Math.floor(Number(resultItem.tippedBins));
+                    }
+
+                    return Number.isInteger(resultItem.tippedBins) ? resultItem.tippedBins : Math.floor(resultItem.tippedBins);
+                  }();
+                } else {
+                  resultItemObject.tippedBins = 0;
+                }
+
+                return resultItemObject;
+              }();
+            });
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+    /**
+     * Retrieve Tipped Bins for specified Packruns [POST /packhouse/sites/{siteId}/packruns/tippedBins]
+     * 
+     * Retrieves the Tipped Bins for specified Packruns
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string[]} packrunIds An Array of Packrun IDs to Fetch Tipped Bins for
+     * @return {Promise<Array<PackrunController.PackrunTippedBinsItem>>}
+     */
+
+  }, {
+    key: "getSpecificTippedBins",
+    value: function getSpecificTippedBins(siteId, packrunIds) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.postRequest("/packhouse/sites/".concat(siteId, "/packruns/tippedBins"), {
+          packrunIds: packrunIds
+        }).then(function (result) {
+          var resolveValue = function () {
+            if (Array.isArray(result) !== true) {
+              return [];
+            }
+
+            return result.map(function (resultItem) {
+              return function () {
+                var resultItemObject = {};
+
+                if (_typeof(resultItem) === 'object' && 'packrunId' in resultItem) {
+                  resultItemObject.packrunId = function () {
+                    if (typeof resultItem.packrunId !== 'string') {
+                      return String(resultItem.packrunId);
+                    }
+
+                    return resultItem.packrunId;
+                  }();
+                } else {
+                  resultItemObject.packrunId = "";
+                }
+
+                if (_typeof(resultItem) === 'object' && 'tippedBins' in resultItem) {
+                  resultItemObject.tippedBins = function () {
+                    if (typeof resultItem.tippedBins !== 'number') {
+                      return Number.isInteger(Number(resultItem.tippedBins)) ? Number(resultItem.tippedBins) : Math.floor(Number(resultItem.tippedBins));
+                    }
+
+                    return Number.isInteger(resultItem.tippedBins) ? resultItem.tippedBins : Math.floor(resultItem.tippedBins);
+                  }();
+                } else {
+                  resultItemObject.tippedBins = 0;
+                }
+
+                return resultItemObject;
+              }();
+            });
+          }();
+
           resolve(resolveValue);
         }).catch(function (error) {
           return reject(error);
@@ -2654,6 +2850,17 @@ var _default = PackrunController;
  * @memberof Controllers.Packhouse.Site
  */
 
+/**
+ * A **ClassTypeFruitSizeTotalItem** Type
+ * 
+ * @typedef {Object} PackrunController.ClassTypeFruitSizeTotalItem
+ * @property {string} classType The Class Type
+ * @property {string} fruitSize The Fruit Size
+ * @property {number} fruitCount The Fruit Count
+ * @property {number} fruitWeight The Fruit Weight
+ * @memberof Controllers.Packhouse.Site
+ */
+
 /**
  * A **PackrunSummaryReport** Type
  * 
@@ -2681,6 +2888,7 @@ var _default = PackrunController;
  * @property {Object} rejectBinSummary The Reject Bin Summary for the Packrun
  * @property {Object} binTipSummary The Bin Tip Summary for the Packrun
  * @property {Object[]} classTypeTotals An Array of Totals for each Class Type within the Packrun
+ * @property {Array<PackrunController.ClassTypeFruitSizeTotalItem>} classTypeFruitSizeTotals An Array of Totals for each Class Type by Fruit Size within the Packrun
  * @property {Object[]} class1SizerSummary An Array of Class 1 Fruit Summaries by Size for all Sizers within the Packrun
  * @property {number} class1TotalTrays The Total Class 1 Trays for this Packrun
  * @property {number} class1AverageTrayWeight The Average Class 1 Tray Weight for this Packrun
@@ -2770,6 +2978,15 @@ var _default = PackrunController;
  * @memberof Controllers.Packhouse.Site
  */
 
+/**
+ * A **PackrunTippedBinsItem** Type
+ * 
+ * @typedef {Object} PackrunController.PackrunTippedBinsItem
+ * @property {string} packrunId The Packrun ID
+ * @property {number} tippedBins The Total Tipped Bins for the Packrun
+ * @memberof Controllers.Packhouse.Site
+ */
+
 /**
  * A **TimeBatch** Type
  * 

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

@@ -189,7 +189,7 @@ var MAFSizerModel = /*#__PURE__*/function (_BaseModel) {
     /**
      * An Array of Article to Class Type Maps for this MAF Sizer
      * 
-     * @type {Array<{articleName: string, classType: string}>}
+     * @type {Array<{articleName: string, classType: string, matchType: string}>}
      * @public
      */
 
@@ -1094,6 +1094,18 @@ var MAFSizerModel = /*#__PURE__*/function (_BaseModel) {
                 articleClassTypesItemObject.classType = "";
               }
 
+              if (_typeof(articleClassTypesItem) === 'object' && 'matchType' in articleClassTypesItem) {
+                articleClassTypesItemObject.matchType = function () {
+                  if (typeof articleClassTypesItem.matchType !== 'string') {
+                    return String(articleClassTypesItem.matchType);
+                  }
+
+                  return articleClassTypesItem.matchType;
+                }();
+              } else {
+                articleClassTypesItemObject.matchType = "";
+              }
+
               return articleClassTypesItemObject;
             }();
           });

package/lib/PackageVersion.js

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

package/lib/index.d.ts

@@ -14977,6 +14977,10 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/MAFSizerController
                         * The Class Type for this MAF Sizer Article
                         */
                     classType: string;
+                    /**
+                        * The Match Type used when Evaluating the Product Name
+                        */
+                    matchType: string;
             };
     }
     import MAFSizerModel from "@ricado/api-client/Models/Packhouse/Site/MAFSizerModel";
@@ -17279,6 +17283,31 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/PackrunController'
                 * @return {Promise<PackrunModel>}
                 */
             static create(siteId: number, createData: PackrunController.CreateData): Promise<PackrunModel>;
+            /**
+                * Retrieve Tipped Bins for all Packruns [GET /packhouse/sites/{siteId}/packruns/tippedBins]
+                *
+                * Retrieves the Tipped Bins for all Packruns
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {Date} createdTimestampBegin Filter by the Timestamp when Packruns were Created. Results Greater than or Equal to Timestamp
+                * @param {Date} createdTimestampEnd Filter by the Timestamp when Packruns were Created. Results Less than or Equal to Timestamp
+                * @return {Promise<Array<PackrunController.PackrunTippedBinsItem>>}
+                */
+            static getAllTippedBins(siteId: number, createdTimestampBegin: Date, createdTimestampEnd: Date): Promise<Array<PackrunController.PackrunTippedBinsItem>>;
+            /**
+                * Retrieve Tipped Bins for specified Packruns [POST /packhouse/sites/{siteId}/packruns/tippedBins]
+                *
+                * Retrieves the Tipped Bins for specified Packruns
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string[]} packrunIds An Array of Packrun IDs to Fetch Tipped Bins for
+                * @return {Promise<Array<PackrunController.PackrunTippedBinsItem>>}
+                */
+            static getSpecificTippedBins(siteId: number, packrunIds: string[]): Promise<Array<PackrunController.PackrunTippedBinsItem>>;
     }
     namespace PackrunController {
             /**
@@ -17661,6 +17690,27 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/PackrunController'
                         */
                     batchSummaries: SizerBatchSummaryItem[];
             };
+            /**
+                * A **ClassTypeFruitSizeTotalItem** Type
+                */
+            type ClassTypeFruitSizeTotalItem = {
+                    /**
+                        * The Class Type
+                        */
+                    classType: string;
+                    /**
+                        * The Fruit Size
+                        */
+                    fruitSize: string;
+                    /**
+                        * The Fruit Count
+                        */
+                    fruitCount: number;
+                    /**
+                        * The Fruit Weight
+                        */
+                    fruitWeight: number;
+            };
             /**
                 * A **PackrunSummaryReport** Type
                 */
@@ -17754,6 +17804,10 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/PackrunController'
                         * An Array of Totals for each Class Type within the Packrun
                         */
                     classTypeTotals: any[];
+                    /**
+                        * An Array of Totals for each Class Type by Fruit Size within the Packrun
+                        */
+                    classTypeFruitSizeTotals: ClassTypeFruitSizeTotalItem[];
                     /**
                         * An Array of Class 1 Fruit Summaries by Size for all Sizers within the Packrun
                         */
@@ -18007,6 +18061,19 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/PackrunController'
                         */
                     classTypeTotals: ClassTypePercentageItem[];
             };
+            /**
+                * A **PackrunTippedBinsItem** Type
+                */
+            type PackrunTippedBinsItem = {
+                    /**
+                        * The Packrun ID
+                        */
+                    packrunId: string;
+                    /**
+                        * The Total Tipped Bins for the Packrun
+                        */
+                    tippedBins: number;
+            };
             /**
                 * A **TimeBatch** Type
                 */
@@ -28501,12 +28568,13 @@ declare module '@ricado/api-client/Models/Packhouse/Site/MAFSizerModel' {
             /**
                 * An Array of Article to Class Type Maps for this MAF Sizer
                 *
-                * @type {Array<{articleName: string, classType: string}>}
+                * @type {Array<{articleName: string, classType: string, matchType: string}>}
                 * @public
                 */
             articleClassTypes: {
                     articleName: string;
                     classType: string;
+                    matchType: string;
             }[];
             /**
                 * Whether the MAF Sizer has been deleted

package/package.json

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

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

@@ -272,5 +272,6 @@ export default MAFSizerController;
  * @typedef {Object} MAFSizerController.ArticleClassType
  * @property {string} articleName Name of the MAF Sizer Article
  * @property {string} classType The Class Type for this MAF Sizer Article
+ * @property {string} matchType The Match Type used when Evaluating the Product Name
  * @memberof Controllers.Packhouse.Site
  */