@ricado/api-client 2.3.17 → 2.3.18

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

@@ -161,11 +161,11 @@ export default RejectBinScaleController;
  * @typedef {Object} RejectBinScaleController.CreateData
  * @property {?number} [rtuId] The RTU this Reject Bin Scale belongs to
  * @property {string} name The Name of this Reject Bin Scale
- * @property {Object} points The Points used by this Reject Bin Scale
+ * @property {{weighButton: ?number, packrunButton: ?number, manualInterventionButton: ?number, clearIndicator: ?number, busyIndicator: ?number, packrunIndicator: ?number, manualInterventionIndicator: ?number, sirenControl: ?number, scaleTareRequest: ?number, scaleClearTareRequest: ?number, scaleZeroRequest: ?number, scaleStableStatus: number, scaleWeight: ?number, scaleNetWeight: ?number, scaleGrossWeight: ?number, scaleTareWeight: ?number, targetGrossWeight: ?number, status: number, currentPackrunId: number, nextPackrunId: number, currentPackrunName: number, nextPackrunName: number, incorrectOperationStatus: ?number, currentPackrunIncorrectOperationsCount: ?number, totalIncorrectOperationsCount: ?number, manualInterventionStatus: ?number, currentPackrunManualInterventionsCount: ?number, totalManualInterventionsCount: ?number, currentPackrunBinsWeighedCount: number, totalBinsWeighedCount: number}} points The Points used by this Reject Bin Scale
  * @property {string} packingLineId The Packing Line that owns this Reject Bin Scale
  * @property {?string} [packrunSourceId] The Permanent Object that provides the Next Packrun for this Reject Bin Scale
  * @property {?number} [packrunGroup] The Packrun Group this Reject Bin Scale is a part of
- * @property {Object[]} [sources] An Array of Sources that deliver Fruit to this Reject Bin Scale
+ * @property {RejectBinScaleController.SortingTableSource|RejectBinScaleController.BeltSource|RejectBinScaleController.SizerOutletSource[]} [sources] An Array of Sources that deliver Fruit to this Reject Bin Scale
  * @property {?{delay: ?number}} [autoPackrunChange] The Auto Packrun Change Configuration for this Reject Bin Scale
  * @property {?boolean} [supportsLiveWeighing] Whether this Reject Bin Scale supports Live Weighing
  * @property {?number} [autoWeighingStartThreshold] The Minimum Weight Change Required to Automatically Start Live Weighing
@@ -178,7 +178,7 @@ export default RejectBinScaleController;
  * @property {?number} [liveWeighingUpdateInterval] The Interval in Milliseconds between Live Weighing Updates
  * @property {?boolean} [liveWeighingUsesStableStatus] Whether the Loadcell Stable Status is used to ignore Changes during Live Weighing
  * @property {?number} [incorrectOperationTolerance] The Maximum Weight Change allowed while Live Weighing before an Incorrect Operation is Logged
- * @property {?Object} [freshPackIntegration] The FreshPack Integration Configuration for this Reject Bin Scale
+ * @property {?RejectBinScaleController.FreshPackBinScaleIntegration} [freshPackIntegration] The FreshPack Integration Configuration for this Reject Bin Scale
  * @memberof Controllers.Packhouse.Site
  */
 
@@ -187,11 +187,11 @@ export default RejectBinScaleController;
  * 
  * @typedef {Object} RejectBinScaleController.UpdateData
  * @property {string} [name] The Name of this Reject Bin Scale
- * @property {Object} [points] The Points used by this Reject Bin Scale
+ * @property {{weighButton: ?number, packrunButton: ?number, manualInterventionButton: ?number, clearIndicator: ?number, busyIndicator: ?number, packrunIndicator: ?number, manualInterventionIndicator: ?number, sirenControl: ?number, scaleTareRequest: ?number, scaleClearTareRequest: ?number, scaleZeroRequest: ?number, scaleStableStatus: number, scaleWeight: ?number, scaleNetWeight: ?number, scaleGrossWeight: ?number, scaleTareWeight: ?number, targetGrossWeight: ?number, status: number, currentPackrunId: number, nextPackrunId: number, currentPackrunName: number, nextPackrunName: number, incorrectOperationStatus: ?number, currentPackrunIncorrectOperationsCount: ?number, totalIncorrectOperationsCount: ?number, manualInterventionStatus: ?number, currentPackrunManualInterventionsCount: ?number, totalManualInterventionsCount: ?number, currentPackrunBinsWeighedCount: number, totalBinsWeighedCount: number}} [points] The Points used by this Reject Bin Scale
  * @property {string} [packingLineId] The Packing Line that owns this Reject Bin Scale
  * @property {?string} [packrunSourceId] The Permanent Object that provides the Next Packrun for this Reject Bin Scale
  * @property {?number} [packrunGroup] The Packrun Group this Reject Bin Scale is a part of
- * @property {Object[]} [sources] An Array of Sources that deliver Fruit to this Reject Bin Scale
+ * @property {RejectBinScaleController.SortingTableSource|RejectBinScaleController.BeltSource|RejectBinScaleController.SizerOutletSource[]} [sources] An Array of Sources that deliver Fruit to this Reject Bin Scale
  * @property {?{delay: ?number}} [autoPackrunChange] The Auto Packrun Change Configuration for this Reject Bin Scale
  * @property {?boolean} [supportsLiveWeighing] Whether this Reject Bin Scale supports Live Weighing
  * @property {?number} [autoWeighingStartThreshold] The Minimum Weight Change Required to Automatically Start Live Weighing
@@ -204,6 +204,52 @@ export default RejectBinScaleController;
  * @property {?number} [liveWeighingUpdateInterval] The Interval in Milliseconds between Live Weighing Updates
  * @property {?boolean} [liveWeighingUsesStableStatus] Whether the Loadcell Stable Status is used to ignore Changes during Live Weighing
  * @property {?number} [incorrectOperationTolerance] The Maximum Weight Change allowed while Live Weighing before an Incorrect Operation is Logged
- * @property {?Object} [freshPackIntegration] The FreshPack Integration Configuration for this Reject Bin Scale
+ * @property {?RejectBinScaleController.FreshPackBinScaleIntegration} [freshPackIntegration] The FreshPack Integration Configuration for this Reject Bin Scale
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **SortingTableSource** Type
+ * 
+ * @typedef {Object} RejectBinScaleController.SortingTableSource
+ * @property {string} type Type of this Reject Bin Scale Source
+ * @property {string} sortingTableId ID of the Sorting Table Object
+ * @property {string} classType The Default Class Type of this Reject Bin Scale Source
+ * @property {Array<{varietyId: string, classType: string}>} varietyClassTypes An Array of Varieties and Class Types to override the Default Class Type
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **BeltSource** Type
+ * 
+ * @typedef {Object} RejectBinScaleController.BeltSource
+ * @property {string} type Type of this Reject Bin Scale Source
+ * @property {?string} beltName Name of the Belt
+ * @property {string} classType The Default Class Type of this Reject Bin Scale Source
+ * @property {Array<{varietyId: string, classType: string}>} varietyClassTypes An Array of Varieties and Class Types to override the Default Class Type
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **SizerOutletSource** Type
+ * 
+ * @typedef {Object} RejectBinScaleController.SizerOutletSource
+ * @property {string} type Type of this Reject Bin Scale Source
+ * @property {string} sizerId ID of the Sizer Object
+ * @property {number} outletNumber Outlet Number of the Sizer Outlet
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **FreshPackBinScaleIntegration** Type
+ * 
+ * @typedef {Object} RejectBinScaleController.FreshPackBinScaleIntegration
+ * @property {Object} points The Points used by this FreshPack Bin Scale Integration
+ * @property {boolean} enabled Whether this FreshPack Bin Scale Integration is Enabled
+ * @property {number} materialGroupId The FreshPack Material Group ID to be used for Multi-Grower Bins from this Reject Bin Scale
+ * @property {number} binTypeId The FreshPack Bin Type ID to be used for Multi-Grower Bins from this Reject Bin Scale
+ * @property {?number} printerGroupId The FreshPack Printer Group ID to be used when Printing Multi-Grower Bin Cards for this Reject Bin Scale
+ * @property {boolean} binCardPrintingEnabled Whether Bin Card Printing is Enabled
+ * @property {boolean} [useWindowsDriverApi] Whether Bin Card Printing should use the Specialized FreshPack Windows Driver API
  * @memberof Controllers.Packhouse.Site
  */

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

@@ -972,8 +972,8 @@ export default RejectBinWeightController;
  * @property {Date} [createdTimestamp] When this Reject Bin Weight was Created
  * @property {?string} [packrunId] The Packrun this Reject Weight is associated with
  * @property {number} netWeight The Net Weight Captured by the Reject Bin Scale
- * @property {Object[]} [sources] The Source Weights that make up the Net Weight
- * @property {Object[]} freshPackMultiGrowerBinWeights The Multi-Grower Bin Weights that will be submitted to FreshPack
+ * @property {RejectBinWeightController.SortingTableSource|RejectBinWeightController.BeltSource|RejectBinWeightController.SizerOutletSource|RejectBinWeightController.MixedSource[]} [sources] The Source Weights that make up the Net Weight
+ * @property {Array<RejectBinWeightController.FreshPackMultiGrowerBinWeight>} freshPackMultiGrowerBinWeights The Multi-Grower Bin Weights that will be submitted to FreshPack
  * @memberof Controllers.Packhouse.Site
  */
 
@@ -985,8 +985,8 @@ export default RejectBinWeightController;
  * @property {Date} [createdTimestamp] When this Reject Bin Weight was Created
  * @property {?string} [packrunId] The Packrun this Reject Weight is associated with
  * @property {number} [netWeight] The Net Weight Captured by the Reject Bin Scale
- * @property {Object[]} [sources] The Source Weights that make up the Net Weight
- * @property {Object[]} [freshPackMultiGrowerBinWeights] The Multi-Grower Bin Weights that will be submitted to FreshPack
+ * @property {RejectBinWeightController.SortingTableSource|RejectBinWeightController.BeltSource|RejectBinWeightController.SizerOutletSource|RejectBinWeightController.MixedSource[]} [sources] The Source Weights that make up the Net Weight
+ * @property {Array<RejectBinWeightController.FreshPackMultiGrowerBinWeight>} [freshPackMultiGrowerBinWeights] The Multi-Grower Bin Weights that will be submitted to FreshPack
  * @memberof Controllers.Packhouse.Site
  */
 
@@ -1010,4 +1010,70 @@ export default RejectBinWeightController;
  * @property {?Date} createdTimestamp When the Comment was Created
  * @property {?Date} updatedTimestamp When the Comment was last Updated
  * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **SortingTableSource** Type
+ * 
+ * @typedef {Object} RejectBinWeightController.SortingTableSource
+ * @property {string} type Type of this Reject Bin Source
+ * @property {string} sortingTableId ID of the Sorting Table Object
+ * @property {?string} sortingTableName Name of the Sorting Table
+ * @property {Array<{classType: string, weight: number, fruitCount: ?number}>} weights An Array of Weights by Class Type for this Reject Bin Source
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **BeltSource** Type
+ * 
+ * @typedef {Object} RejectBinWeightController.BeltSource
+ * @property {string} type Type of this Reject Bin Source
+ * @property {?string} beltName Name of the Belt
+ * @property {Array<{classType: string, weight: number, fruitCount: ?number}>} weights An Array of Weights by Class Type for this Reject Bin Source
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **SizerOutletSource** Type
+ * 
+ * @typedef {Object} RejectBinWeightController.SizerOutletSource
+ * @property {string} type Type of this Reject Bin Source
+ * @property {string} sizerId ID of the Sizer Object
+ * @property {?string} sizerName Name of the Sizer
+ * @property {number} outletNumber Outlet Number of the Sizer Outlet
+ * @property {?string} outletName Name of the Sizer Outlet
+ * @property {Array<{classType: string, weight: number, fruitCount: ?number}>} weights An Array of Weights by Class Type for this Reject Bin Source
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **MixedSource** Type
+ * 
+ * @typedef {Object} RejectBinWeightController.MixedSource
+ * @property {string} type Type of this Reject Bin Source
+ * @property {string[]} mixedNames An Array of Mixed Source Names
+ * @property {Array<{classType: string, weight: number, fruitCount: ?number}>} weights An Array of Weights by Class Type for this Reject Bin Source
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * Results from Interacting with the FreshPack API to Send Multi-Grower Bin Weights
+ * 
+ * @typedef {Object} RejectBinWeightController.BinWeightApiStatus
+ * @property {number} requestCount Number of Requests made to the FreshPack API
+ * @property {?Date} requestTimestamp Timestamp of the last Request made to the FreshPack API
+ * @property {?number} responseCode Response Code from the last FreshPack API Request
+ * @property {?string} responseMessage Response Message from the last FreshPack API Request
+ * @property {boolean} completed Whether Interaction with the FreshPack API has been Completed
+ * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **FreshPackMultiGrowerBinWeight** Type
+ * 
+ * @typedef {Object} RejectBinWeightController.FreshPackMultiGrowerBinWeight
+ * @property {string} classType The Class Type of this Multi-Grower Bin Weight
+ * @property {number} weight The Net Weight in Kilograms of this Multi-Grower Bin Weight
+ * @property {?RejectBinWeightController.BinWeightApiStatus} weightApi Results from Interacting with the FreshPack API to Send Multi-Grower Bin Weights
+ * @memberof Controllers.Packhouse.Site
  */

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

@@ -1074,7 +1074,7 @@ export default ShiftController;
  * A **ShiftAreaNote** Type
  * 
  * @typedef {Object} ShiftController.ShiftAreaNote
- * @property {string} area The Area this Notes applies to
+ * @property {string} area The Area this Note applies to
  * @property {Date} timestamp The Timestamp when this Note was Created
  * @property {string} content The Content for this Note
  * @memberof Controllers.Packhouse.Site

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

@@ -987,6 +987,8 @@ export default ShiftHourlyEntryController;
  * @property {?number} [averageManningTarget] The Average Target Number of People that should be working for this Hour
  * @property {?number} [averageClass1ManningTarget] The Average Target Number of People that should be working in all Areas except Class 2 for this Hour
  * @property {?number} [averageClass2ManningTarget] The Average Target Number of People that should be working in the Class 2 Area for this Hour
+ * @property {?Array<ShiftHourlyEntryController.ManningTeam>} [manningTeams] An Array of Manning Teams and their Headcounts for this Hour. Only Applies when *manningUsesTeams* is *true*
+ * @property {?boolean} [manningUsesTeams] Whether Manning is tracked at the Team Level for this Hour
  * @property {?number} [averageCostPerManningUnit] The Average Cost per Person working in all Areas for this Hour
  * @property {?number} [layeredTrayPercentage] The Actual Percentage of Total Tray Equivalents that are Layered for this Hour
  * @property {?number} [layeredTrayPercentageTarget] The Target Percentage of Total Tray Equivalents that should be Layered for this Hour
@@ -1029,6 +1031,8 @@ export default ShiftHourlyEntryController;
  * @property {?number} [averageManningTarget] The Average Target Number of People that should be working for this Hour
  * @property {?number} [averageClass1ManningTarget] The Average Target Number of People that should be working in all Areas except Class 2 for this Hour
  * @property {?number} [averageClass2ManningTarget] The Average Target Number of People that should be working in the Class 2 Area for this Hour
+ * @property {?Array<ShiftHourlyEntryController.ManningTeam>} [manningTeams] An Array of Manning Teams and their Headcounts for this Hour. Only Applies when *manningUsesTeams* is *true*
+ * @property {?boolean} [manningUsesTeams] Whether Manning is tracked at the Team Level for this Hour
  * @property {?number} [averageCostPerManningUnit] The Average Cost per Person working in all Areas for this Hour
  * @property {?number} [layeredTrayPercentage] The Actual Percentage of Total Tray Equivalents that are Layered for this Hour
  * @property {?number} [layeredTrayPercentageTarget] The Target Percentage of Total Tray Equivalents that should be Layered for this Hour
@@ -1080,6 +1084,17 @@ export default ShiftHourlyEntryController;
  * @memberof Controllers.Packhouse.Site
  */
 
+/**
+ * A **ManningTeam** Type
+ * 
+ * @typedef {Object} ShiftHourlyEntryController.ManningTeam
+ * @property {string} id ID of the Team
+ * @property {string} name Name of the Team
+ * @property {number} headcount Total Number of People Working in this Team
+ * @property {string} group The Group this Team is associated with
+ * @memberof Controllers.Packhouse.Site
+ */
+
 /**
  * A **CustomQualityDataItem** Type
  * 

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

@@ -446,7 +446,7 @@ export default SoftSortBeltController;
  * @typedef {Object} SoftSortBeltController.CreateData
  * @property {?number} [rtuId] The RTU this Soft Sort Belt belongs to
  * @property {string} name The Name of this Soft Sort Belt
- * @property {Object} points The Points used by this Soft Sort Belt
+ * @property {{runAuto: number, slowMode: ?number, stopMode: number}} points The Points used by this Soft Sort Belt
  * @property {string} packingLineId The Packing Line that owns this Soft Sort Belt
  * @memberof Controllers.Packhouse.Site
  */
@@ -456,7 +456,7 @@ export default SoftSortBeltController;
  * 
  * @typedef {Object} SoftSortBeltController.UpdateData
  * @property {string} [name] The Name of this Soft Sort Belt
- * @property {Object} [points] The Points used by this Soft Sort Belt
+ * @property {{runAuto: number, slowMode: ?number, stopMode: number}} [points] The Points used by this Soft Sort Belt
  * @property {string} [packingLineId] The Packing Line that owns this Soft Sort Belt
  * @memberof Controllers.Packhouse.Site
  */

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

@@ -978,7 +978,7 @@ export default SoftSortPackrunSummaryController;
  * @property {?Date} [eventsFinalizedTimestamp] Whether the Soft-Sort Events Data for this Summary has been Finalized
  * @property {?boolean} [eventsAccurate] Whether the Soft-Sort Events for this Summary are considered accurate or not
  * @property {?string} [eventsNotAccurateReason] A Reason for why the Events for this Summary are not accurate. Applies when `eventsAccurate` is false
- * @property {?Object} [freshPackSoftSortApi] The FreshPack Soft-Sort API Data
+ * @property {?SoftSortPackrunSummaryController.SoftSortApiStatus} [freshPackSoftSortApi] Results from Interacting with the FreshPack API to Send Soft-Sort Events Data
  * @memberof Controllers.Packhouse.Site
  */
 
@@ -995,7 +995,7 @@ export default SoftSortPackrunSummaryController;
  * @property {?Date} [eventsFinalizedTimestamp] Whether the Soft-Sort Events Data for this Summary has been Finalized
  * @property {?boolean} [eventsAccurate] Whether the Soft-Sort Events for this Summary are considered accurate or not
  * @property {?string} [eventsNotAccurateReason] A Reason for why the Events for this Summary are not accurate. Applies when `eventsAccurate` is false
- * @property {?Object} [freshPackSoftSortApi] The FreshPack Soft-Sort API Data
+ * @property {?SoftSortPackrunSummaryController.SoftSortApiStatus} [freshPackSoftSortApi] Results from Interacting with the FreshPack API to Send Soft-Sort Events Data
  * @memberof Controllers.Packhouse.Site
  */
 
@@ -1019,4 +1019,16 @@ export default SoftSortPackrunSummaryController;
  * @property {?Date} createdTimestamp When the Comment was Created
  * @property {?Date} updatedTimestamp When the Comment was last Updated
  * @memberof Controllers.Packhouse.Site
+ */
+
+/**
+ * A **SoftSortApiStatus** Type
+ * 
+ * @typedef {Object} SoftSortPackrunSummaryController.SoftSortApiStatus
+ * @property {number} requestCount Number of Requests made to the FreshPack API
+ * @property {?Date} requestTimestamp Timestamp of the last Request made to the FreshPack API
+ * @property {?number} responseCode Response Code from the last FreshPack API Request
+ * @property {?string} responseMessage Response Message from the last FreshPack API Request
+ * @property {boolean} completed Whether Interaction with the FreshPack API has been Completed
+ * @memberof Controllers.Packhouse.Site
  */

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

@@ -7,10 +7,12 @@
 /**
  * @namespace Controllers.Packhouse.Site
  */
+import BinTipBarcodeScannerController from './BinTipBarcodeScannerController';
 import BinTipBinCardController from './BinTipBinCardController';
 import BinTipBinController from './BinTipBinController';
 import BinTipWeightController from './BinTipWeightController';
 import CompacSizerBatchController from './CompacSizerBatchController';
+import CompacSizerBinWeightController from './CompacSizerBinWeightController';
 import CompacSizerController from './CompacSizerController';
 import CompacSizerOutletProductChangeController from './CompacSizerOutletProductChangeController';
 import CompacSizerOutletTypeChangeController from './CompacSizerOutletTypeChangeController';
@@ -41,10 +43,12 @@ import SoftSortPackrunSummaryController from './SoftSortPackrunSummaryController
 import VarietyController from './VarietyController';
 
 const Site = {
+    BinTipBarcodeScannerController,
     BinTipBinCardController,
     BinTipBinController,
     BinTipWeightController,
     CompacSizerBatchController,
+    CompacSizerBinWeightController,
     CompacSizerController,
     CompacSizerOutletProductChangeController,
     CompacSizerOutletTypeChangeController,

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

@@ -0,0 +1,252 @@
+/**
+ * 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
+ * 
+ * @class
+ * @hideconstructor
+ * @extends BaseModel
+ */
+class BinTipBarcodeScannerModel extends BaseModel
+{
+    /**
+     * BinTipBarcodeScannerModel Constructor
+     * 
+     * @protected
+     * @param {number} siteId The Site ID associated with this Bin Tip Barcode Scanner
+     */
+    constructor(siteId)
+    {
+        super();
+        
+        /**
+         * The Bin Tip Barcode Scanner ID
+         * 
+         * @type {string}
+         * @public
+         */
+        this.id = "";
+        
+        /**
+         * The RTU this Bin Tip Barcode Scanner Belt belongs to
+         * 
+         * @type {?number}
+         * @public
+         */
+        this.rtuId = null;
+        
+        /**
+         * The Name of this Bin Tip Barcode Scanner
+         * 
+         * @type {string}
+         * @public
+         */
+        this.name = "";
+        
+        /**
+         * The Points used by this Bin Tip Barcode Scanner
+         * 
+         * @type {{scannerErrorBeepRequest: number, restartServiceRequest: number}}
+         * @public
+         */
+        this.points = (function(){
+            let pointsDefaultValue = {};
+            
+            pointsDefaultValue.scannerErrorBeepRequest = 0;
+            
+            pointsDefaultValue.restartServiceRequest = 0;
+            
+            return pointsDefaultValue;
+        }());
+        
+        /**
+         * The Bin Tip that owns this Barcode Scanner
+         * 
+         * @type {string}
+         * @public
+         */
+        this.binTipId = "";
+        
+        /**
+         * Whether the Bin Tip Barcode Scanner has been deleted
+         * 
+         * @type {boolean}
+         * @public
+         */
+        this.deleted = false;
+        
+        /**
+         * When the Bin Tip Barcode Scanner was last updated
+         * 
+         * @type {Date}
+         * @public
+         */
+        this.updateTimestamp = new Date();
+        
+        /**
+         * The Site ID associated with this Bin Tip Barcode Scanner
+         * 
+         * @type {number}
+         * @public
+         */
+        this.siteId = siteId;
+    }
+
+    /**
+     * Create a new **BinTipBarcodeScannerModel** 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
+     * @return {BinTipBarcodeScannerModel}
+     */
+    static fromJSON(json, siteId)
+    {
+        let model = new BinTipBarcodeScannerModel(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('rtuId' in jsonObject)
+        {
+            model.rtuId = (function(){
+                if(jsonObject['rtuId'] === null)
+                {
+                    return null;
+                }
+        
+                if(typeof jsonObject['rtuId'] !== 'number')
+                {
+                    return Number.isInteger(Number(jsonObject['rtuId'])) ? Number(jsonObject['rtuId']) : Math.floor(Number(jsonObject['rtuId']));
+                }
+        
+                return Number.isInteger(jsonObject['rtuId']) ? jsonObject['rtuId'] : Math.floor(jsonObject['rtuId']);
+            }());
+        }
+        
+        if('name' in jsonObject)
+        {
+            model.name = (function(){
+                if(typeof jsonObject['name'] !== 'string')
+                {
+                    return String(jsonObject['name']);
+                }
+        
+                return jsonObject['name'];
+            }());
+        }
+        
+        if('points' in jsonObject)
+        {
+            model.points = (function(){
+                let pointsObject = {};
+                
+                if(typeof jsonObject['points'] === 'object' && 'scannerErrorBeepRequest' in jsonObject['points'])
+                {
+                    pointsObject.scannerErrorBeepRequest = (function(){
+                        if(typeof jsonObject['points'].scannerErrorBeepRequest !== 'number')
+                        {
+                            return Number.isInteger(Number(jsonObject['points'].scannerErrorBeepRequest)) ? Number(jsonObject['points'].scannerErrorBeepRequest) : Math.floor(Number(jsonObject['points'].scannerErrorBeepRequest));
+                        }
+        
+                        return Number.isInteger(jsonObject['points'].scannerErrorBeepRequest) ? jsonObject['points'].scannerErrorBeepRequest : Math.floor(jsonObject['points'].scannerErrorBeepRequest);
+                    }());
+                }
+                else
+                {
+                    pointsObject.scannerErrorBeepRequest = 0;
+                }
+                
+                if(typeof jsonObject['points'] === 'object' && 'restartServiceRequest' in jsonObject['points'])
+                {
+                    pointsObject.restartServiceRequest = (function(){
+                        if(typeof jsonObject['points'].restartServiceRequest !== 'number')
+                        {
+                            return Number.isInteger(Number(jsonObject['points'].restartServiceRequest)) ? Number(jsonObject['points'].restartServiceRequest) : Math.floor(Number(jsonObject['points'].restartServiceRequest));
+                        }
+        
+                        return Number.isInteger(jsonObject['points'].restartServiceRequest) ? jsonObject['points'].restartServiceRequest : Math.floor(jsonObject['points'].restartServiceRequest);
+                    }());
+                }
+                else
+                {
+                    pointsObject.restartServiceRequest = 0;
+                }
+        
+                return pointsObject;
+            }());
+        }
+        
+        if('binTipId' in jsonObject)
+        {
+            model.binTipId = (function(){
+                if(typeof jsonObject['binTipId'] !== 'string')
+                {
+                    return String(jsonObject['binTipId']);
+                }
+        
+                return jsonObject['binTipId'];
+            }());
+        }
+        
+        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 BinTipBarcodeScannerModel;