@ricado/api-client 2.1.0 → 2.3.0

package/src/Models/CompanyModel.js

@@ -30,7 +30,7 @@ class CompanyModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.id = undefined;
+        this.id = "";
         
         /**
          * The Company Display Name
@@ -38,7 +38,7 @@ class CompanyModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.displayName = undefined;
+        this.displayName = "";
         
         /**
          * The Company Legal Name
@@ -46,7 +46,7 @@ class CompanyModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.legalName = undefined;
+        this.legalName = "";
         
         /**
          * Whether the Company has been deleted
@@ -54,7 +54,7 @@ class CompanyModel extends BaseModel
          * @type {boolean}
          * @public
          */
-        this.deleted = undefined;
+        this.deleted = false;
         
         /**
          * When the Company was last updated
@@ -62,7 +62,7 @@ class CompanyModel extends BaseModel
          * @type {Date}
          * @public
          */
-        this.updateTimestamp = undefined;
+        this.updateTimestamp = new Date();
     }
 
     /**

package/src/Models/FirebaseTokenModel.js

@@ -30,7 +30,7 @@ class FirebaseTokenModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.id = undefined;
+        this.id = "";
         
         /**
          * The Account this Firebase Token belongs to
@@ -38,7 +38,7 @@ class FirebaseTokenModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.accountId = undefined;
+        this.accountId = "";
         
         /**
          * The Firebase Token
@@ -46,7 +46,7 @@ class FirebaseTokenModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.token = undefined;
+        this.token = "";
         
         /**
          * Whether the Firebase Token should receive Notifications
@@ -54,7 +54,7 @@ class FirebaseTokenModel extends BaseModel
          * @type {boolean}
          * @public
          */
-        this.enabled = undefined;
+        this.enabled = false;
         
         /**
          * The Device Name
@@ -62,7 +62,7 @@ class FirebaseTokenModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.deviceName = undefined;
+        this.deviceName = "";
         
         /**
          * The Device Platform
@@ -70,7 +70,7 @@ class FirebaseTokenModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.devicePlatform = undefined;
+        this.devicePlatform = "";
         
         /**
          * Whether the Firebase Token has been deleted
@@ -78,7 +78,7 @@ class FirebaseTokenModel extends BaseModel
          * @type {boolean}
          * @public
          */
-        this.deleted = undefined;
+        this.deleted = false;
         
         /**
          * When the Firebase Token was last updated
@@ -86,7 +86,7 @@ class FirebaseTokenModel extends BaseModel
          * @type {Date}
          * @public
          */
-        this.updateTimestamp = undefined;
+        this.updateTimestamp = new Date();
     }
 
     /**

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 = "";
+        
+        /**
+         * The Bin Tip ID associated with this Bin
+         * 
+         * @type {string}
+         * @public
+         */
+        this.binTipId = "";
+        
+        /**
+         * The Packrun ID associated with this Bin
+         * 
+         * @type {string}
+         * @public
+         */
+        this.packrunId = "";
+        
+        /**
+         * When this Bin was Created
+         * 
+         * @type {Date}
+         * @public
+         */
+        this.createdTimestamp = new Date();
+        
+        /**
+         * A 10-Digit Bin Number made up of a Bin Lot (4-Digits) and a Unique Number (6-Digits)
+         * 
+         * @type {?string}
+         * @public
+         */
+        this.binNumber = null;
+        
+        /**
+         * The Time Batch ID associated with this Bin
+         * 
+         * @type {?string}
+         * @public
+         */
+        this.timeBatchId = null;
+        
+        /**
+         * The Full Weight for this Bin
+         * 
+         * @type {?number}
+         * @public
+         */
+        this.fullWeight = null;
+        
+        /**
+         * The Empty Weight for this Bin
+         * 
+         * @type {?number}
+         * @public
+         */
+        this.emptyWeight = null;
+        
+        /**
+         * The `BinTipWeight` ID as the Source for the Full Weight of this Bin
+         * 
+         * @type {?string}
+         * @public
+         */
+        this.fullBinWeightId = null;
+        
+        /**
+         * The `BinTipWeight` ID as the Source for the Empty Weight of this Bin
+         * 
+         * @type {?string}
+         * @public
+         */
+        this.emptyBinWeightId = null;
+        
+        /**
+         * The FreshPack Field Bin Weight API Data
+         * 
+         * @type {?Object}
+         * @public
+         */
+        this.freshPackFieldBinWeightApi = null;
+        
+        /**
+         * Whether the Bin Tip Bin has been deleted
+         * 
+         * @type {boolean}
+         * @public
+         */
+        this.deleted = false;
+        
+        /**
+         * When the Bin Tip Bin was last updated
+         * 
+         * @type {Date}
+         * @public
+         */
+        this.updateTimestamp = new Date();
+        
+        /**
+         * 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

@@ -31,7 +31,7 @@ class BinTipWeightModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.id = undefined;
+        this.id = "";
         
         /**
          * The Bin Tip ID associated with this Bin Weight
@@ -39,7 +39,7 @@ class BinTipWeightModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.binTipId = undefined;
+        this.binTipId = "";
         
         /**
          * The Packrun ID associated with this Bin Weight
@@ -47,7 +47,7 @@ class BinTipWeightModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.packrunId = undefined;
+        this.packrunId = "";
         
         /**
          * When this Bin Weight was Created
@@ -55,7 +55,7 @@ class BinTipWeightModel extends BaseModel
          * @type {Date}
          * @public
          */
-        this.createdTimestamp = undefined;
+        this.createdTimestamp = new Date();
         
         /**
          * The Bin Weight Type
@@ -63,7 +63,7 @@ class BinTipWeightModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.weightType = undefined;
+        this.weightType = "";
         
         /**
          * The Bin Weight
@@ -71,7 +71,7 @@ class BinTipWeightModel extends BaseModel
          * @type {number}
          * @public
          */
-        this.weight = undefined;
+        this.weight = 0;
         
         /**
          * The Bin Scale ID associated with this Bin Weight
@@ -79,7 +79,7 @@ class BinTipWeightModel extends BaseModel
          * @type {?string}
          * @public
          */
-        this.binScaleId = undefined;
+        this.binScaleId = null;
         
         /**
          * Whether the Bin Tip Weight has been deleted
@@ -87,7 +87,7 @@ class BinTipWeightModel extends BaseModel
          * @type {boolean}
          * @public
          */
-        this.deleted = undefined;
+        this.deleted = false;
         
         /**
          * When the Bin Tip Weight was last updated
@@ -95,7 +95,7 @@ class BinTipWeightModel extends BaseModel
          * @type {Date}
          * @public
          */
-        this.updateTimestamp = undefined;
+        this.updateTimestamp = new Date();
         
         /**
          * The Site ID associated with this Bin Tip Weight

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

@@ -31,7 +31,7 @@ class CompacSizerBatchModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.id = undefined;
+        this.id = "";
         
         /**
          * The Compac Sizer ID this Batch is associated with
@@ -39,7 +39,7 @@ class CompacSizerBatchModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.compacSizerId = undefined;
+        this.compacSizerId = "";
         
         /**
          * The Numeric Compac Batch ID
@@ -47,7 +47,7 @@ class CompacSizerBatchModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.batchId = undefined;
+        this.batchId = "";
         
         /**
          * When this Batch was Created
@@ -55,7 +55,7 @@ class CompacSizerBatchModel extends BaseModel
          * @type {Date}
          * @public
          */
-        this.createdTimestamp = undefined;
+        this.createdTimestamp = new Date();
         
         /**
          * The Packrun ID associated with this Batch
@@ -63,7 +63,7 @@ class CompacSizerBatchModel extends BaseModel
          * @type {?string}
          * @public
          */
-        this.packrunId = undefined;
+        this.packrunId = null;
         
         /**
          * The Compac Sizer Batch Data
@@ -71,7 +71,7 @@ class CompacSizerBatchModel extends BaseModel
          * @type {Object}
          * @public
          */
-        this.batch = undefined;
+        this.batch = {}
         
         /**
          * Whether the Compac Sizer Batch has been deleted
@@ -79,7 +79,7 @@ class CompacSizerBatchModel extends BaseModel
          * @type {boolean}
          * @public
          */
-        this.deleted = undefined;
+        this.deleted = false;
         
         /**
          * When the Compac Sizer Batch was last updated
@@ -87,7 +87,7 @@ class CompacSizerBatchModel extends BaseModel
          * @type {Date}
          * @public
          */
-        this.updateTimestamp = undefined;
+        this.updateTimestamp = new Date();
         
         /**
          * The Site ID associated with this Compac Sizer Batch