@ricado/api-client 2.3.6 → 2.3.9

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

@@ -957,6 +957,8 @@ export default BinTipBinController;
  * @typedef {Object} BinTipBinController.GetAllQueryParameters
  * @property {string} [binTipId] The Bin Tip ID associated with this Bin
  * @property {string} [packrunId] The Packrun ID associated with this Bin
+ * @property {?string} [binNumber] A 10-Digit Bin Number made up of a Bin Lot (4-Digits) and a Unique Number (6-Digits)
+ * @property {?string} [binNumberSource] The Source of the Bin Number
  * @property {?string} [fullBinWeightId] The `BinTipWeight` ID as the Source for the Full Weight of this Bin
  * @property {?string} [emptyBinWeightId] The `BinTipWeight` ID as the Source for the Empty Weight of this Bin
  * @property {Date} [createdTimestampBegin] Filter by the Timestamp when this Bin was Created. Results Greater than or Equal to Timestamp
@@ -972,6 +974,7 @@ export default BinTipBinController;
  * @property {string} [packrunId] The Packrun ID associated with this Bin
  * @property {Date} [createdTimestamp] When this Bin was Created
  * @property {?string} [binNumber] A 10-Digit Bin Number made up of a Bin Lot (4-Digits) and a Unique Number (6-Digits)
+ * @property {?string} [binNumberSource] The Source of the Bin Number
  * @property {?string} [timeBatchId] The Time Batch ID associated with this Bin
  * @property {?number} [fullWeight] The Full Weight for this Bin
  * @property {?number} [emptyWeight] The Empty Weight for this Bin
@@ -988,6 +991,7 @@ export default BinTipBinController;
  * @property {string} [binTipId] The Bin Tip ID associated with this Bin
  * @property {Date} [createdTimestamp] When this Bin was Created
  * @property {?string} [binNumber] A 10-Digit Bin Number made up of a Bin Lot (4-Digits) and a Unique Number (6-Digits)
+ * @property {?string} [binNumberSource] The Source of the Bin Number
  * @property {?string} [timeBatchId] The Time Batch ID associated with this Bin
  * @property {?number} [fullWeight] The Full Weight for this Bin
  * @property {?number} [emptyWeight] The Empty Weight for this Bin

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

@@ -972,6 +972,7 @@ export default FreshPackPackrunSummaryController;
  * @property {Date} [createdTimestamp] When this Summary was Created
  * @property {?string} [timeBatchId] The Time Batch this Summary is associated with
  * @property {Object[]} [traySummaries] An Array of Tray Summary Data Objects for all Sizes and Class Types
+ * @property {Object[]} [clearanceSummaries] An Array of Clearance Summary Data Objects for all Sizes
  * @memberof Controllers.Packhouse.Site
  */
 
@@ -983,6 +984,7 @@ export default FreshPackPackrunSummaryController;
  * @property {Date} [createdTimestamp] When this Summary was Created
  * @property {?string} [timeBatchId] The Time Batch this Summary is associated with
  * @property {Object[]} [traySummaries] An Array of Tray Summary Data Objects for all Sizes and Class Types
+ * @property {Object[]} [clearanceSummaries] An Array of Clearance Summary Data Objects for all Sizes
  * @memberof Controllers.Packhouse.Site
  */
 

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

@@ -7,6 +7,7 @@
 /**
  * @namespace Controllers.Packhouse.Site
  */
+import BinTipBinCardController from './BinTipBinCardController';
 import BinTipBinController from './BinTipBinController';
 import BinTipWeightController from './BinTipWeightController';
 import CompacSizerBatchController from './CompacSizerBatchController';
@@ -35,6 +36,7 @@ import SoftSortPackrunSummaryController from './SoftSortPackrunSummaryController
 import VarietyController from './VarietyController';
 
 const Site = {
+    BinTipBinCardController,
     BinTipBinController,
     BinTipWeightController,
     CompacSizerBatchController,

package/src/Models/Packhouse/Site/BinTipBinCardModel.js

@@ -0,0 +1,215 @@
+/**
+ * File Auto-Generated by the RICADO Gen 4 PHP API Project
+ * 
+ * Do Not Edit this File Manually!
+ */
+
+import BaseModel from '../../../Models/BaseModel';
+
+/**
+ * Model Class for a Bin Tip Bin Card
+ * 
+ * @class
+ * @hideconstructor
+ * @extends BaseModel
+ */
+class BinTipBinCardModel extends BaseModel
+{
+    /**
+     * BinTipBinCardModel Constructor
+     * 
+     * @protected
+     * @param {number} siteId The Site ID associated with this Bin Tip Bin Card
+     */
+    constructor(siteId)
+    {
+        super();
+        
+        /**
+         * The Bin Tip Bin Card ID
+         * 
+         * @type {string}
+         * @public
+         */
+        this.id = "";
+        
+        /**
+         * The Bin Tip ID associated with this Bin Card
+         * 
+         * @type {string}
+         * @public
+         */
+        this.binTipId = "";
+        
+        /**
+         * The Bin ID associated with this Bin Card
+         * 
+         * @type {string}
+         * @public
+         */
+        this.binTipBinId = "";
+        
+        /**
+         * When this Bin Card was Created
+         * 
+         * @type {Date}
+         * @public
+         */
+        this.createdTimestamp = new Date();
+        
+        /**
+         * A Base64 Encoded Image of the Bin Card
+         * 
+         * @type {?string}
+         * @public
+         */
+        this.image = null;
+        
+        /**
+         * Whether the Bin Tip Bin Card has been deleted
+         * 
+         * @type {boolean}
+         * @public
+         */
+        this.deleted = false;
+        
+        /**
+         * When the Bin Tip Bin Card was last updated
+         * 
+         * @type {Date}
+         * @public
+         */
+        this.updateTimestamp = new Date();
+        
+        /**
+         * The Site ID associated with this Bin Tip Bin Card
+         * 
+         * @type {number}
+         * @public
+         */
+        this.siteId = siteId;
+    }
+
+    /**
+     * Create a new **BinTipBinCardModel** from a JSON Object or JSON String
+     * 
+     * @static
+     * @public
+     * @param {Object<string, any>|string} json A JSON Object or JSON String
+     * @param {number} siteId The Site ID associated with this Bin Tip Bin Card
+     * @return {BinTipBinCardModel}
+     */
+    static fromJSON(json, siteId)
+    {
+        let model = new BinTipBinCardModel(siteId);
+        
+        /**
+         * The JSON Object
+         * 
+         * @type {Object<string, any>}
+         */
+        let jsonObject = {};
+        
+        if(typeof json === 'string')
+        {
+            jsonObject = JSON.parse(json);
+        }
+        else if(typeof json === 'object')
+        {
+            jsonObject = json;
+        }
+        
+        if('id' in jsonObject)
+        {
+            model.id = (function(){
+                if(typeof jsonObject['id'] !== 'string')
+                {
+                    return String(jsonObject['id']);
+                }
+        
+                return jsonObject['id'];
+            }());
+        }
+        
+        if('binTipId' in jsonObject)
+        {
+            model.binTipId = (function(){
+                if(typeof jsonObject['binTipId'] !== 'string')
+                {
+                    return String(jsonObject['binTipId']);
+                }
+        
+                return jsonObject['binTipId'];
+            }());
+        }
+        
+        if('binTipBinId' in jsonObject)
+        {
+            model.binTipBinId = (function(){
+                if(typeof jsonObject['binTipBinId'] !== 'string')
+                {
+                    return String(jsonObject['binTipBinId']);
+                }
+        
+                return jsonObject['binTipBinId'];
+            }());
+        }
+        
+        if('createdTimestamp' in jsonObject)
+        {
+            model.createdTimestamp = (function(){
+                if(typeof jsonObject['createdTimestamp'] !== 'string')
+                {
+                    return new Date(String(jsonObject['createdTimestamp']));
+                }
+        
+                return new Date(jsonObject['createdTimestamp']);
+            }());
+        }
+        
+        if('image' in jsonObject)
+        {
+            model.image = (function(){
+                if(jsonObject['image'] === null)
+                {
+                    return null;
+                }
+        
+                if(typeof jsonObject['image'] !== 'string')
+                {
+                    return String(jsonObject['image']);
+                }
+        
+                return jsonObject['image'];
+            }());
+        }
+        
+        if('deleted' in jsonObject)
+        {
+            model.deleted = (function(){
+                if(typeof jsonObject['deleted'] !== 'boolean')
+                {
+                    return Boolean(jsonObject['deleted']);
+                }
+        
+                return jsonObject['deleted'];
+            }());
+        }
+        
+        if('updateTimestamp' in jsonObject)
+        {
+            model.updateTimestamp = (function(){
+                if(typeof jsonObject['updateTimestamp'] !== 'string')
+                {
+                    return new Date(String(jsonObject['updateTimestamp']));
+                }
+        
+                return new Date(jsonObject['updateTimestamp']);
+            }());
+        }
+        
+        return model;
+    }
+}
+
+export default BinTipBinCardModel;

package/src/Models/Packhouse/Site/BinTipBinModel.js

@@ -65,6 +65,14 @@ class BinTipBinModel extends BaseModel
          */
         this.binNumber = null;
         
+        /**
+         * The Source of the Bin Number
+         * 
+         * @type {?string}
+         * @public
+         */
+        this.binNumberSource = null;
+        
         /**
          * The Time Batch ID associated with this Bin
          * 
@@ -232,6 +240,23 @@ class BinTipBinModel extends BaseModel
             }());
         }
         
+        if('binNumberSource' in jsonObject)
+        {
+            model.binNumberSource = (function(){
+                if(jsonObject['binNumberSource'] === null)
+                {
+                    return null;
+                }
+        
+                if(typeof jsonObject['binNumberSource'] !== 'string')
+                {
+                    return String(jsonObject['binNumberSource']);
+                }
+        
+                return jsonObject['binNumberSource'];
+            }());
+        }
+        
         if('timeBatchId' in jsonObject)
         {
             model.timeBatchId = (function(){

package/src/Models/Packhouse/Site/FreshPackPackrunSummaryModel.js

@@ -73,6 +73,14 @@ class FreshPackPackrunSummaryModel extends BaseModel
          */
         this.traySummaries = [];
         
+        /**
+         * An Array of Clearance Summary Data Objects for all Sizes
+         * 
+         * @type {Object[]}
+         * @public
+         */
+        this.clearanceSummaries = [];
+        
         /**
          * Whether the FreshPack Packrun Summary has been deleted
          * 
@@ -213,6 +221,27 @@ class FreshPackPackrunSummaryModel extends BaseModel
             }());
         }
         
+        if('clearanceSummaries' in jsonObject)
+        {
+            model.clearanceSummaries = (function(){
+                if(Array.isArray(jsonObject['clearanceSummaries']) !== true)
+                {
+                    return [];
+                }
+        
+                return jsonObject['clearanceSummaries'].map((clearanceSummariesItem) => {
+                    return (function(){
+                        if(typeof clearanceSummariesItem !== 'object')
+                        {
+                            return Object(clearanceSummariesItem);
+                        }
+        
+                        return clearanceSummariesItem;
+                    }());
+                });
+            }());
+        }
+        
         if('deleted' in jsonObject)
         {
             model.deleted = (function(){

package/src/Models/Packhouse/Site/index.js

@@ -7,6 +7,7 @@
 /**
  * @namespace Models.Packhouse.Site
  */
+import BinTipBinCardModel from './BinTipBinCardModel';
 import BinTipBinModel from './BinTipBinModel';
 import BinTipWeightModel from './BinTipWeightModel';
 import CompacSizerBatchModel from './CompacSizerBatchModel';
@@ -35,6 +36,7 @@ import SoftSortPackrunSummaryModel from './SoftSortPackrunSummaryModel';
 import VarietyModel from './VarietyModel';
 
 const Site = {
+    BinTipBinCardModel,
     BinTipBinModel,
     BinTipWeightModel,
     CompacSizerBatchModel,

package/src/PackageVersion.js

@@ -1,2 +1,2 @@
 // generated by genversion
-export const version = '2.3.6';
+export const version = '2.3.9';