@ricado/api-client 2.0.2 → 2.2.0

package/src/Controllers/Site/PermanentObjectController.js

@@ -29,7 +29,7 @@ class PermanentObjectController
             RequestHelper.getRequest(`/sites/${siteId}/permanent-objects/${id}`)
             .then((result) => {
                 let resolveValue = (function(){
-                    return PermanentObjectModel.fromJSON(result);
+                    return PermanentObjectModel.fromJSON(result, siteId);
                 }());
                 
                 resolve(resolveValue);
@@ -54,7 +54,7 @@ class PermanentObjectController
             RequestHelper.patchRequest(`/sites/${siteId}/permanent-objects/${id}`, updateData)
             .then((result) => {
                 let resolveValue = (function(){
-                    return PermanentObjectModel.fromJSON(result);
+                    return PermanentObjectModel.fromJSON(result, siteId);
                 }());
                 
                 resolve(resolveValue);
@@ -105,7 +105,7 @@ class PermanentObjectController
                 
                     return result.map((resultItem) => {
                         return (function(){
-                            return PermanentObjectModel.fromJSON(resultItem);
+                            return PermanentObjectModel.fromJSON(resultItem, siteId);
                         }());
                     });
                 }());
@@ -131,7 +131,7 @@ class PermanentObjectController
             RequestHelper.postRequest(`/sites/${siteId}/permanent-objects`, createData)
             .then((result) => {
                 let resolveValue = (function(){
-                    return PermanentObjectModel.fromJSON(result);
+                    return PermanentObjectModel.fromJSON(result, siteId);
                 }());
                 
                 resolve(resolveValue);

package/src/Controllers/Site/PermanentObjectDataController.js

@@ -29,7 +29,7 @@ class PermanentObjectDataController
             RequestHelper.getRequest(`/sites/${siteId}/permanent-object-data/${id}`)
             .then((result) => {
                 let resolveValue = (function(){
-                    return PermanentObjectDataModel.fromJSON(result);
+                    return PermanentObjectDataModel.fromJSON(result, siteId);
                 }());
                 
                 resolve(resolveValue);
@@ -54,7 +54,7 @@ class PermanentObjectDataController
             RequestHelper.patchRequest(`/sites/${siteId}/permanent-object-data/${id}`, updateData)
             .then((result) => {
                 let resolveValue = (function(){
-                    return PermanentObjectDataModel.fromJSON(result);
+                    return PermanentObjectDataModel.fromJSON(result, siteId);
                 }());
                 
                 resolve(resolveValue);
@@ -569,7 +569,7 @@ class PermanentObjectDataController
                 
                     return result.map((resultItem) => {
                         return (function(){
-                            return PermanentObjectDataModel.fromJSON(resultItem);
+                            return PermanentObjectDataModel.fromJSON(resultItem, siteId);
                         }());
                     });
                 }());
@@ -595,7 +595,7 @@ class PermanentObjectDataController
             RequestHelper.postRequest(`/sites/${siteId}/permanent-object-data`, createData)
             .then((result) => {
                 let resolveValue = (function(){
-                    return PermanentObjectDataModel.fromJSON(result);
+                    return PermanentObjectDataModel.fromJSON(result, siteId);
                 }());
                 
                 resolve(resolveValue);

package/src/Controllers/Site/PointController.js

@@ -348,7 +348,7 @@ class PointController
             RequestHelper.getRequest(`/sites/${siteId}/points/${id}`)
             .then((result) => {
                 let resolveValue = (function(){
-                    return PointModel.fromJSON(result);
+                    return PointModel.fromJSON(result, siteId);
                 }());
                 
                 resolve(resolveValue);
@@ -373,7 +373,7 @@ class PointController
             RequestHelper.patchRequest(`/sites/${siteId}/points/${id}`, updateData)
             .then((result) => {
                 let resolveValue = (function(){
-                    return PointModel.fromJSON(result);
+                    return PointModel.fromJSON(result, siteId);
                 }());
                 
                 resolve(resolveValue);
@@ -424,7 +424,7 @@ class PointController
                 
                     return result.map((resultItem) => {
                         return (function(){
-                            return PointModel.fromJSON(resultItem);
+                            return PointModel.fromJSON(resultItem, siteId);
                         }());
                     });
                 }());
@@ -450,7 +450,7 @@ class PointController
             RequestHelper.postRequest(`/sites/${siteId}/points`, createData)
             .then((result) => {
                 let resolveValue = (function(){
-                    return PointModel.fromJSON(result);
+                    return PointModel.fromJSON(result, siteId);
                 }());
                 
                 resolve(resolveValue);

package/src/Controllers/Site/TemporaryObjectController.js

@@ -29,7 +29,7 @@ class TemporaryObjectController
             RequestHelper.getRequest(`/sites/${siteId}/temporary-objects/${id}`)
             .then((result) => {
                 let resolveValue = (function(){
-                    return TemporaryObjectModel.fromJSON(result);
+                    return TemporaryObjectModel.fromJSON(result, siteId);
                 }());
                 
                 resolve(resolveValue);
@@ -54,7 +54,7 @@ class TemporaryObjectController
             RequestHelper.patchRequest(`/sites/${siteId}/temporary-objects/${id}`, updateData)
             .then((result) => {
                 let resolveValue = (function(){
-                    return TemporaryObjectModel.fromJSON(result);
+                    return TemporaryObjectModel.fromJSON(result, siteId);
                 }());
                 
                 resolve(resolveValue);
@@ -105,7 +105,7 @@ class TemporaryObjectController
                 
                     return result.map((resultItem) => {
                         return (function(){
-                            return TemporaryObjectModel.fromJSON(resultItem);
+                            return TemporaryObjectModel.fromJSON(resultItem, siteId);
                         }());
                     });
                 }());
@@ -131,7 +131,7 @@ class TemporaryObjectController
             RequestHelper.postRequest(`/sites/${siteId}/temporary-objects`, createData)
             .then((result) => {
                 let resolveValue = (function(){
-                    return TemporaryObjectModel.fromJSON(result);
+                    return TemporaryObjectModel.fromJSON(result, siteId);
                 }());
                 
                 resolve(resolveValue);

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

@@ -0,0 +1,365 @@
+/**
+ * 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
+ * 
+ * @class
+ * @hideconstructor
+ * @extends BaseModel
+ */
+class BinTipBinModel extends BaseModel
+{
+    /**
+     * BinTipBinModel Constructor
+     * 
+     * @protected
+     * @param {number} siteId The Site ID associated with this Bin Tip Bin
+     */
+    constructor(siteId)
+    {
+        super();
+        
+        /**
+         * The Bin Tip Bin ID
+         * 
+         * @type {string}
+         * @public
+         */
+        this.id = undefined;
+        
+        /**
+         * The Bin Tip ID associated with this Bin
+         * 
+         * @type {string}
+         * @public
+         */
+        this.binTipId = undefined;
+        
+        /**
+         * The Packrun ID associated with this Bin
+         * 
+         * @type {string}
+         * @public
+         */
+        this.packrunId = undefined;
+        
+        /**
+         * When this Bin was Created
+         * 
+         * @type {Date}
+         * @public
+         */
+        this.createdTimestamp = undefined;
+        
+        /**
+         * A 10-Digit Bin Number made up of a Bin Lot (4-Digits) and a Unique Number (6-Digits)
+         * 
+         * @type {?string}
+         * @public
+         */
+        this.binNumber = undefined;
+        
+        /**
+         * The Time Batch ID associated with this Bin
+         * 
+         * @type {?string}
+         * @public
+         */
+        this.timeBatchId = undefined;
+        
+        /**
+         * The Full Weight for this Bin
+         * 
+         * @type {?number}
+         * @public
+         */
+        this.fullWeight = undefined;
+        
+        /**
+         * The Empty Weight for this Bin
+         * 
+         * @type {?number}
+         * @public
+         */
+        this.emptyWeight = undefined;
+        
+        /**
+         * The `BinTipWeight` ID as the Source for the Full Weight of this Bin
+         * 
+         * @type {?string}
+         * @public
+         */
+        this.fullBinWeightId = undefined;
+        
+        /**
+         * The `BinTipWeight` ID as the Source for the Empty Weight of this Bin
+         * 
+         * @type {?string}
+         * @public
+         */
+        this.emptyBinWeightId = undefined;
+        
+        /**
+         * The FreshPack Field Bin Weight API Data
+         * 
+         * @type {?Object}
+         * @public
+         */
+        this.freshPackFieldBinWeightApi = undefined;
+        
+        /**
+         * Whether the Bin Tip Bin has been deleted
+         * 
+         * @type {boolean}
+         * @public
+         */
+        this.deleted = undefined;
+        
+        /**
+         * When the Bin Tip Bin was last updated
+         * 
+         * @type {Date}
+         * @public
+         */
+        this.updateTimestamp = undefined;
+        
+        /**
+         * The Site ID associated with this Bin Tip Bin
+         * 
+         * @type {number}
+         * @public
+         */
+        this.siteId = siteId;
+    }
+
+    /**
+     * Create a new **BinTipBinModel** 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
+     * @return {BinTipBinModel}
+     */
+    static fromJSON(json, siteId)
+    {
+        let model = new BinTipBinModel(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('packrunId' in jsonObject)
+        {
+            model.packrunId = (function(){
+                if(typeof jsonObject['packrunId'] !== 'string')
+                {
+                    return String(jsonObject['packrunId']);
+                }
+        
+                return jsonObject['packrunId'];
+            }());
+        }
+        
+        if('createdTimestamp' in jsonObject)
+        {
+            model.createdTimestamp = (function(){
+                if(typeof jsonObject['createdTimestamp'] !== 'string')
+                {
+                    return new Date(String(jsonObject['createdTimestamp']));
+                }
+        
+                return new Date(jsonObject['createdTimestamp']);
+            }());
+        }
+        
+        if('binNumber' in jsonObject)
+        {
+            model.binNumber = (function(){
+                if(jsonObject['binNumber'] === null)
+                {
+                    return null;
+                }
+        
+                if(typeof jsonObject['binNumber'] !== 'string')
+                {
+                    return String(jsonObject['binNumber']);
+                }
+        
+                return jsonObject['binNumber'];
+            }());
+        }
+        
+        if('timeBatchId' in jsonObject)
+        {
+            model.timeBatchId = (function(){
+                if(jsonObject['timeBatchId'] === null)
+                {
+                    return null;
+                }
+        
+                if(typeof jsonObject['timeBatchId'] !== 'string')
+                {
+                    return String(jsonObject['timeBatchId']);
+                }
+        
+                return jsonObject['timeBatchId'];
+            }());
+        }
+        
+        if('fullWeight' in jsonObject)
+        {
+            model.fullWeight = (function(){
+                if(jsonObject['fullWeight'] === null)
+                {
+                    return null;
+                }
+        
+                if(typeof jsonObject['fullWeight'] !== 'number')
+                {
+                    return Number(jsonObject['fullWeight']);
+                }
+        
+                return jsonObject['fullWeight'];
+            }());
+        }
+        
+        if('emptyWeight' in jsonObject)
+        {
+            model.emptyWeight = (function(){
+                if(jsonObject['emptyWeight'] === null)
+                {
+                    return null;
+                }
+        
+                if(typeof jsonObject['emptyWeight'] !== 'number')
+                {
+                    return Number(jsonObject['emptyWeight']);
+                }
+        
+                return jsonObject['emptyWeight'];
+            }());
+        }
+        
+        if('fullBinWeightId' in jsonObject)
+        {
+            model.fullBinWeightId = (function(){
+                if(jsonObject['fullBinWeightId'] === null)
+                {
+                    return null;
+                }
+        
+                if(typeof jsonObject['fullBinWeightId'] !== 'string')
+                {
+                    return String(jsonObject['fullBinWeightId']);
+                }
+        
+                return jsonObject['fullBinWeightId'];
+            }());
+        }
+        
+        if('emptyBinWeightId' in jsonObject)
+        {
+            model.emptyBinWeightId = (function(){
+                if(jsonObject['emptyBinWeightId'] === null)
+                {
+                    return null;
+                }
+        
+                if(typeof jsonObject['emptyBinWeightId'] !== 'string')
+                {
+                    return String(jsonObject['emptyBinWeightId']);
+                }
+        
+                return jsonObject['emptyBinWeightId'];
+            }());
+        }
+        
+        if('freshPackFieldBinWeightApi' in jsonObject)
+        {
+            model.freshPackFieldBinWeightApi = (function(){
+                if(jsonObject['freshPackFieldBinWeightApi'] === null)
+                {
+                    return null;
+                }
+        
+                if(typeof jsonObject['freshPackFieldBinWeightApi'] !== 'object')
+                {
+                    return Object(jsonObject['freshPackFieldBinWeightApi']);
+                }
+        
+                return jsonObject['freshPackFieldBinWeightApi'];
+            }());
+        }
+        
+        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 BinTipBinModel;

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

@@ -19,8 +19,9 @@ class BinTipWeightModel extends BaseModel
      * BinTipWeightModel Constructor
      * 
      * @protected
+     * @param {number} siteId The Site ID associated with this Bin Tip Weight
      */
-    constructor()
+    constructor(siteId)
     {
         super();
         
@@ -95,6 +96,14 @@ class BinTipWeightModel extends BaseModel
          * @public
          */
         this.updateTimestamp = undefined;
+        
+        /**
+         * The Site ID associated with this Bin Tip Weight
+         * 
+         * @type {number}
+         * @public
+         */
+        this.siteId = siteId;
     }
 
     /**
@@ -103,11 +112,12 @@ class BinTipWeightModel extends BaseModel
      * @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 Weight
      * @return {BinTipWeightModel}
      */
-    static fromJSON(json)
+    static fromJSON(json, siteId)
     {
-        let model = new BinTipWeightModel();
+        let model = new BinTipWeightModel(siteId);
         
         /**
          * The JSON Object

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

@@ -19,8 +19,9 @@ class CompacSizerBatchModel extends BaseModel
      * CompacSizerBatchModel Constructor
      * 
      * @protected
+     * @param {number} siteId The Site ID associated with this Compac Sizer Batch
      */
-    constructor()
+    constructor(siteId)
     {
         super();
         
@@ -87,6 +88,14 @@ class CompacSizerBatchModel extends BaseModel
          * @public
          */
         this.updateTimestamp = undefined;
+        
+        /**
+         * The Site ID associated with this Compac Sizer Batch
+         * 
+         * @type {number}
+         * @public
+         */
+        this.siteId = siteId;
     }
 
     /**
@@ -95,11 +104,12 @@ class CompacSizerBatchModel extends BaseModel
      * @static
      * @public
      * @param {Object<string, any>|string} json A JSON Object or JSON String
+     * @param {number} siteId The Site ID associated with this Compac Sizer Batch
      * @return {CompacSizerBatchModel}
      */
-    static fromJSON(json)
+    static fromJSON(json, siteId)
     {
-        let model = new CompacSizerBatchModel();
+        let model = new CompacSizerBatchModel(siteId);
         
         /**
          * The JSON Object

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

@@ -19,8 +19,9 @@ class CompacSizerModel extends BaseModel
      * CompacSizerModel Constructor
      * 
      * @protected
+     * @param {number} siteId The Site ID associated with this Compac Sizer
      */
-    constructor()
+    constructor(siteId)
     {
         super();
         
@@ -97,7 +98,7 @@ class CompacSizerModel extends BaseModel
         this.fruitSizes = undefined;
         
         /**
-         * The Packing Line ID this Compac Sizer belongs to
+         * The Packing Line ID that manages this Compac Sizer
          * 
          * @type {string}
          * @public
@@ -135,6 +136,14 @@ class CompacSizerModel extends BaseModel
          * @public
          */
         this.updateTimestamp = undefined;
+        
+        /**
+         * The Site ID associated with this Compac Sizer
+         * 
+         * @type {number}
+         * @public
+         */
+        this.siteId = siteId;
     }
 
     /**
@@ -143,11 +152,12 @@ class CompacSizerModel extends BaseModel
      * @static
      * @public
      * @param {Object<string, any>|string} json A JSON Object or JSON String
+     * @param {number} siteId The Site ID associated with this Compac Sizer
      * @return {CompacSizerModel}
      */
-    static fromJSON(json)
+    static fromJSON(json, siteId)
     {
-        let model = new CompacSizerModel();
+        let model = new CompacSizerModel(siteId);
         
         /**
          * The JSON Object

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

@@ -19,8 +19,9 @@ class CompacSizerOutletProductChangeModel extends BaseModel
      * CompacSizerOutletProductChangeModel Constructor
      * 
      * @protected
+     * @param {number} siteId The Site ID associated with this Compac Sizer Outlet Product Change
      */
-    constructor()
+    constructor(siteId)
     {
         super();
         
@@ -103,6 +104,14 @@ class CompacSizerOutletProductChangeModel extends BaseModel
          * @public
          */
         this.updateTimestamp = undefined;
+        
+        /**
+         * The Site ID associated with this Compac Sizer Outlet Product Change
+         * 
+         * @type {number}
+         * @public
+         */
+        this.siteId = siteId;
     }
 
     /**
@@ -111,11 +120,12 @@ class CompacSizerOutletProductChangeModel extends BaseModel
      * @static
      * @public
      * @param {Object<string, any>|string} json A JSON Object or JSON String
+     * @param {number} siteId The Site ID associated with this Compac Sizer Outlet Product Change
      * @return {CompacSizerOutletProductChangeModel}
      */
-    static fromJSON(json)
+    static fromJSON(json, siteId)
     {
-        let model = new CompacSizerOutletProductChangeModel();
+        let model = new CompacSizerOutletProductChangeModel(siteId);
         
         /**
          * The JSON Object