@ricado/api-client 2.3.19 → 2.3.20

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

@@ -49,29 +49,57 @@ class BinTipBarcodeScannerModel extends BaseModel
          */
         this.name = "";
         
+        /**
+         * The Bin Tip that owns this Barcode Scanner
+         * 
+         * @type {string}
+         * @public
+         */
+        this.binTipId = "";
+        
         /**
          * The Points used by this Bin Tip Barcode Scanner
          * 
-         * @type {{scannerErrorBeepRequest: number, restartServiceRequest: number}}
+         * @type {{scannerCommunicationStatus: number, scannerChargingStatus: number, scannerChargingTimeRemaining: number, scannerBatteryTemperature: number, scannerBatteryPercentage: number, scannerBatteryCurrent: number, scannerBatteryVoltage: number, scannerErrorBeepRequest: number, serviceCommunicationStatus: number, serviceCommunicationLatency: number, restartServiceRequest: number, recentScanResults: number}}
          * @public
          */
         this.points = (function(){
             let pointsDefaultValue = {};
             
+            pointsDefaultValue.scannerCommunicationStatus = 0;
+            
+            pointsDefaultValue.scannerChargingStatus = 0;
+            
+            pointsDefaultValue.scannerChargingTimeRemaining = 0;
+            
+            pointsDefaultValue.scannerBatteryTemperature = 0;
+            
+            pointsDefaultValue.scannerBatteryPercentage = 0;
+            
+            pointsDefaultValue.scannerBatteryCurrent = 0;
+            
+            pointsDefaultValue.scannerBatteryVoltage = 0;
+            
             pointsDefaultValue.scannerErrorBeepRequest = 0;
             
+            pointsDefaultValue.serviceCommunicationStatus = 0;
+            
+            pointsDefaultValue.serviceCommunicationLatency = 0;
+            
             pointsDefaultValue.restartServiceRequest = 0;
             
+            pointsDefaultValue.recentScanResults = 0;
+            
             return pointsDefaultValue;
         }());
         
         /**
-         * The Bin Tip that owns this Barcode Scanner
+         * The Mode for this Bin Tip Barcode Scanner
          * 
          * @type {string}
          * @public
          */
-        this.binTipId = "";
+        this.mode = "";
         
         /**
          * Whether the Bin Tip Barcode Scanner has been deleted
@@ -168,11 +196,135 @@ class BinTipBarcodeScannerModel extends BaseModel
             }());
         }
         
+        if('binTipId' in jsonObject)
+        {
+            model.binTipId = (function(){
+                if(typeof jsonObject['binTipId'] !== 'string')
+                {
+                    return String(jsonObject['binTipId']);
+                }
+        
+                return jsonObject['binTipId'];
+            }());
+        }
+        
         if('points' in jsonObject)
         {
             model.points = (function(){
                 let pointsObject = {};
                 
+                if(typeof jsonObject['points'] === 'object' && 'scannerCommunicationStatus' in jsonObject['points'])
+                {
+                    pointsObject.scannerCommunicationStatus = (function(){
+                        if(typeof jsonObject['points'].scannerCommunicationStatus !== 'number')
+                        {
+                            return Number.isInteger(Number(jsonObject['points'].scannerCommunicationStatus)) ? Number(jsonObject['points'].scannerCommunicationStatus) : Math.floor(Number(jsonObject['points'].scannerCommunicationStatus));
+                        }
+        
+                        return Number.isInteger(jsonObject['points'].scannerCommunicationStatus) ? jsonObject['points'].scannerCommunicationStatus : Math.floor(jsonObject['points'].scannerCommunicationStatus);
+                    }());
+                }
+                else
+                {
+                    pointsObject.scannerCommunicationStatus = 0;
+                }
+                
+                if(typeof jsonObject['points'] === 'object' && 'scannerChargingStatus' in jsonObject['points'])
+                {
+                    pointsObject.scannerChargingStatus = (function(){
+                        if(typeof jsonObject['points'].scannerChargingStatus !== 'number')
+                        {
+                            return Number.isInteger(Number(jsonObject['points'].scannerChargingStatus)) ? Number(jsonObject['points'].scannerChargingStatus) : Math.floor(Number(jsonObject['points'].scannerChargingStatus));
+                        }
+        
+                        return Number.isInteger(jsonObject['points'].scannerChargingStatus) ? jsonObject['points'].scannerChargingStatus : Math.floor(jsonObject['points'].scannerChargingStatus);
+                    }());
+                }
+                else
+                {
+                    pointsObject.scannerChargingStatus = 0;
+                }
+                
+                if(typeof jsonObject['points'] === 'object' && 'scannerChargingTimeRemaining' in jsonObject['points'])
+                {
+                    pointsObject.scannerChargingTimeRemaining = (function(){
+                        if(typeof jsonObject['points'].scannerChargingTimeRemaining !== 'number')
+                        {
+                            return Number.isInteger(Number(jsonObject['points'].scannerChargingTimeRemaining)) ? Number(jsonObject['points'].scannerChargingTimeRemaining) : Math.floor(Number(jsonObject['points'].scannerChargingTimeRemaining));
+                        }
+        
+                        return Number.isInteger(jsonObject['points'].scannerChargingTimeRemaining) ? jsonObject['points'].scannerChargingTimeRemaining : Math.floor(jsonObject['points'].scannerChargingTimeRemaining);
+                    }());
+                }
+                else
+                {
+                    pointsObject.scannerChargingTimeRemaining = 0;
+                }
+                
+                if(typeof jsonObject['points'] === 'object' && 'scannerBatteryTemperature' in jsonObject['points'])
+                {
+                    pointsObject.scannerBatteryTemperature = (function(){
+                        if(typeof jsonObject['points'].scannerBatteryTemperature !== 'number')
+                        {
+                            return Number.isInteger(Number(jsonObject['points'].scannerBatteryTemperature)) ? Number(jsonObject['points'].scannerBatteryTemperature) : Math.floor(Number(jsonObject['points'].scannerBatteryTemperature));
+                        }
+        
+                        return Number.isInteger(jsonObject['points'].scannerBatteryTemperature) ? jsonObject['points'].scannerBatteryTemperature : Math.floor(jsonObject['points'].scannerBatteryTemperature);
+                    }());
+                }
+                else
+                {
+                    pointsObject.scannerBatteryTemperature = 0;
+                }
+                
+                if(typeof jsonObject['points'] === 'object' && 'scannerBatteryPercentage' in jsonObject['points'])
+                {
+                    pointsObject.scannerBatteryPercentage = (function(){
+                        if(typeof jsonObject['points'].scannerBatteryPercentage !== 'number')
+                        {
+                            return Number.isInteger(Number(jsonObject['points'].scannerBatteryPercentage)) ? Number(jsonObject['points'].scannerBatteryPercentage) : Math.floor(Number(jsonObject['points'].scannerBatteryPercentage));
+                        }
+        
+                        return Number.isInteger(jsonObject['points'].scannerBatteryPercentage) ? jsonObject['points'].scannerBatteryPercentage : Math.floor(jsonObject['points'].scannerBatteryPercentage);
+                    }());
+                }
+                else
+                {
+                    pointsObject.scannerBatteryPercentage = 0;
+                }
+                
+                if(typeof jsonObject['points'] === 'object' && 'scannerBatteryCurrent' in jsonObject['points'])
+                {
+                    pointsObject.scannerBatteryCurrent = (function(){
+                        if(typeof jsonObject['points'].scannerBatteryCurrent !== 'number')
+                        {
+                            return Number.isInteger(Number(jsonObject['points'].scannerBatteryCurrent)) ? Number(jsonObject['points'].scannerBatteryCurrent) : Math.floor(Number(jsonObject['points'].scannerBatteryCurrent));
+                        }
+        
+                        return Number.isInteger(jsonObject['points'].scannerBatteryCurrent) ? jsonObject['points'].scannerBatteryCurrent : Math.floor(jsonObject['points'].scannerBatteryCurrent);
+                    }());
+                }
+                else
+                {
+                    pointsObject.scannerBatteryCurrent = 0;
+                }
+                
+                if(typeof jsonObject['points'] === 'object' && 'scannerBatteryVoltage' in jsonObject['points'])
+                {
+                    pointsObject.scannerBatteryVoltage = (function(){
+                        if(typeof jsonObject['points'].scannerBatteryVoltage !== 'number')
+                        {
+                            return Number.isInteger(Number(jsonObject['points'].scannerBatteryVoltage)) ? Number(jsonObject['points'].scannerBatteryVoltage) : Math.floor(Number(jsonObject['points'].scannerBatteryVoltage));
+                        }
+        
+                        return Number.isInteger(jsonObject['points'].scannerBatteryVoltage) ? jsonObject['points'].scannerBatteryVoltage : Math.floor(jsonObject['points'].scannerBatteryVoltage);
+                    }());
+                }
+                else
+                {
+                    pointsObject.scannerBatteryVoltage = 0;
+                }
+                
                 if(typeof jsonObject['points'] === 'object' && 'scannerErrorBeepRequest' in jsonObject['points'])
                 {
                     pointsObject.scannerErrorBeepRequest = (function(){
@@ -189,6 +341,38 @@ class BinTipBarcodeScannerModel extends BaseModel
                     pointsObject.scannerErrorBeepRequest = 0;
                 }
                 
+                if(typeof jsonObject['points'] === 'object' && 'serviceCommunicationStatus' in jsonObject['points'])
+                {
+                    pointsObject.serviceCommunicationStatus = (function(){
+                        if(typeof jsonObject['points'].serviceCommunicationStatus !== 'number')
+                        {
+                            return Number.isInteger(Number(jsonObject['points'].serviceCommunicationStatus)) ? Number(jsonObject['points'].serviceCommunicationStatus) : Math.floor(Number(jsonObject['points'].serviceCommunicationStatus));
+                        }
+        
+                        return Number.isInteger(jsonObject['points'].serviceCommunicationStatus) ? jsonObject['points'].serviceCommunicationStatus : Math.floor(jsonObject['points'].serviceCommunicationStatus);
+                    }());
+                }
+                else
+                {
+                    pointsObject.serviceCommunicationStatus = 0;
+                }
+                
+                if(typeof jsonObject['points'] === 'object' && 'serviceCommunicationLatency' in jsonObject['points'])
+                {
+                    pointsObject.serviceCommunicationLatency = (function(){
+                        if(typeof jsonObject['points'].serviceCommunicationLatency !== 'number')
+                        {
+                            return Number.isInteger(Number(jsonObject['points'].serviceCommunicationLatency)) ? Number(jsonObject['points'].serviceCommunicationLatency) : Math.floor(Number(jsonObject['points'].serviceCommunicationLatency));
+                        }
+        
+                        return Number.isInteger(jsonObject['points'].serviceCommunicationLatency) ? jsonObject['points'].serviceCommunicationLatency : Math.floor(jsonObject['points'].serviceCommunicationLatency);
+                    }());
+                }
+                else
+                {
+                    pointsObject.serviceCommunicationLatency = 0;
+                }
+                
                 if(typeof jsonObject['points'] === 'object' && 'restartServiceRequest' in jsonObject['points'])
                 {
                     pointsObject.restartServiceRequest = (function(){
@@ -204,20 +388,36 @@ class BinTipBarcodeScannerModel extends BaseModel
                 {
                     pointsObject.restartServiceRequest = 0;
                 }
+                
+                if(typeof jsonObject['points'] === 'object' && 'recentScanResults' in jsonObject['points'])
+                {
+                    pointsObject.recentScanResults = (function(){
+                        if(typeof jsonObject['points'].recentScanResults !== 'number')
+                        {
+                            return Number.isInteger(Number(jsonObject['points'].recentScanResults)) ? Number(jsonObject['points'].recentScanResults) : Math.floor(Number(jsonObject['points'].recentScanResults));
+                        }
+        
+                        return Number.isInteger(jsonObject['points'].recentScanResults) ? jsonObject['points'].recentScanResults : Math.floor(jsonObject['points'].recentScanResults);
+                    }());
+                }
+                else
+                {
+                    pointsObject.recentScanResults = 0;
+                }
         
                 return pointsObject;
             }());
         }
         
-        if('binTipId' in jsonObject)
+        if('mode' in jsonObject)
         {
-            model.binTipId = (function(){
-                if(typeof jsonObject['binTipId'] !== 'string')
+            model.mode = (function(){
+                if(typeof jsonObject['mode'] !== 'string')
                 {
-                    return String(jsonObject['binTipId']);
+                    return String(jsonObject['mode']);
                 }
         
-                return jsonObject['binTipId'];
+                return jsonObject['mode'];
             }());
         }
         

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

@@ -0,0 +1,305 @@
+/**
+ * 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 Barcode Scanner Result
+ * 
+ * @class
+ * @hideconstructor
+ * @extends BaseModel
+ */
+class BinTipBarcodeScannerResultModel extends BaseModel
+{
+    /**
+     * BinTipBarcodeScannerResultModel Constructor
+     * 
+     * @protected
+     * @param {number} siteId The Site ID associated with this Bin Tip Barcode Scanner Result
+     */
+    constructor(siteId)
+    {
+        super();
+        
+        /**
+         * The Bin Tip Barcode Scanner Result ID
+         * 
+         * @type {string}
+         * @public
+         */
+        this.id = "";
+        
+        /**
+         * The Bin Tip Barcode Scanner ID associated with this Result
+         * 
+         * @type {string}
+         * @public
+         */
+        this.barcodeScannerId = "";
+        
+        /**
+         * A 10-Digit Bin Number made up of a Bin Lot (4-Digits) and a Unique Number (6-Digits)
+         * 
+         * @type {string}
+         * @public
+         */
+        this.binNumber = "";
+        
+        /**
+         * When this Barcode Scanner Result was Created
+         * 
+         * @type {Date}
+         * @public
+         */
+        this.createdTimestamp = new Date();
+        
+        /**
+         * The Type of this Barcode Scanner Result
+         * 
+         * @type {string}
+         * @public
+         */
+        this.type = "";
+        
+        /**
+         * The Packrun ID associated with this Barcode Scanner Result
+         * 
+         * @type {?string}
+         * @public
+         */
+        this.packrunId = null;
+        
+        /**
+         * Whether the Bin Number was Valid and could be matched with a Current or Scheduled Packrun
+         * 
+         * @type {boolean}
+         * @public
+         */
+        this.result = false;
+        
+        /**
+         * An Optional Message to accompany the Result. Typically only present when the Result is **false**
+         * 
+         * @type {?string}
+         * @public
+         */
+        this.resultMessage = null;
+        
+        /**
+         * The Bin Lot Code of this Barcode Scanner Result
+         * 
+         * @type {?string}
+         * @public
+         */
+        this.binLotCode = null;
+        
+        /**
+         * Whether the Bin Tip Barcode Scanner Result has been deleted
+         * 
+         * @type {boolean}
+         * @public
+         */
+        this.deleted = false;
+        
+        /**
+         * When the Bin Tip Barcode Scanner Result was last updated
+         * 
+         * @type {Date}
+         * @public
+         */
+        this.updateTimestamp = new Date();
+        
+        /**
+         * The Site ID associated with this Bin Tip Barcode Scanner Result
+         * 
+         * @type {number}
+         * @public
+         */
+        this.siteId = siteId;
+    }
+
+    /**
+     * Create a new **BinTipBarcodeScannerResultModel** 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 Barcode Scanner Result
+     * @return {BinTipBarcodeScannerResultModel}
+     */
+    static fromJSON(json, siteId)
+    {
+        let model = new BinTipBarcodeScannerResultModel(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('barcodeScannerId' in jsonObject)
+        {
+            model.barcodeScannerId = (function(){
+                if(typeof jsonObject['barcodeScannerId'] !== 'string')
+                {
+                    return String(jsonObject['barcodeScannerId']);
+                }
+        
+                return jsonObject['barcodeScannerId'];
+            }());
+        }
+        
+        if('binNumber' in jsonObject)
+        {
+            model.binNumber = (function(){
+                if(typeof jsonObject['binNumber'] !== 'string')
+                {
+                    return String(jsonObject['binNumber']);
+                }
+        
+                return jsonObject['binNumber'];
+            }());
+        }
+        
+        if('createdTimestamp' in jsonObject)
+        {
+            model.createdTimestamp = (function(){
+                if(typeof jsonObject['createdTimestamp'] !== 'string')
+                {
+                    return new Date(String(jsonObject['createdTimestamp']));
+                }
+        
+                return new Date(jsonObject['createdTimestamp']);
+            }());
+        }
+        
+        if('type' in jsonObject)
+        {
+            model.type = (function(){
+                if(typeof jsonObject['type'] !== 'string')
+                {
+                    return String(jsonObject['type']);
+                }
+        
+                return jsonObject['type'];
+            }());
+        }
+        
+        if('packrunId' in jsonObject)
+        {
+            model.packrunId = (function(){
+                if(jsonObject['packrunId'] === null)
+                {
+                    return null;
+                }
+        
+                if(typeof jsonObject['packrunId'] !== 'string')
+                {
+                    return String(jsonObject['packrunId']);
+                }
+        
+                return jsonObject['packrunId'];
+            }());
+        }
+        
+        if('result' in jsonObject)
+        {
+            model.result = (function(){
+                if(typeof jsonObject['result'] !== 'boolean')
+                {
+                    return Boolean(jsonObject['result']);
+                }
+        
+                return jsonObject['result'];
+            }());
+        }
+        
+        if('resultMessage' in jsonObject)
+        {
+            model.resultMessage = (function(){
+                if(jsonObject['resultMessage'] === null)
+                {
+                    return null;
+                }
+        
+                if(typeof jsonObject['resultMessage'] !== 'string')
+                {
+                    return String(jsonObject['resultMessage']);
+                }
+        
+                return jsonObject['resultMessage'];
+            }());
+        }
+        
+        if('binLotCode' in jsonObject)
+        {
+            model.binLotCode = (function(){
+                if(jsonObject['binLotCode'] === null)
+                {
+                    return null;
+                }
+        
+                if(typeof jsonObject['binLotCode'] !== 'string')
+                {
+                    return String(jsonObject['binLotCode']);
+                }
+        
+                return jsonObject['binLotCode'];
+            }());
+        }
+        
+        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 BinTipBarcodeScannerResultModel;

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

@@ -8,6 +8,7 @@
  * @namespace Models.Packhouse.Site
  */
 import BinTipBarcodeScannerModel from './BinTipBarcodeScannerModel';
+import BinTipBarcodeScannerResultModel from './BinTipBarcodeScannerResultModel';
 import BinTipBinCardModel from './BinTipBinCardModel';
 import BinTipBinModel from './BinTipBinModel';
 import BinTipWeightModel from './BinTipWeightModel';
@@ -44,6 +45,7 @@ import VarietyModel from './VarietyModel';
 
 const Site = {
     BinTipBarcodeScannerModel,
+    BinTipBarcodeScannerResultModel,
     BinTipBinCardModel,
     BinTipBinModel,
     BinTipWeightModel,

package/src/PackageVersion.js

@@ -1,2 +1,2 @@
 // Generated by genversion.
-export const version = '2.3.19';
+export const version = '2.3.20';