@ricado/api-client 2.3.18 → 2.3.20

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/CompacSizerBinWeightModel.js

@@ -68,7 +68,7 @@ class CompacSizerBinWeightModel extends BaseModel
         /**
          * The Sources and Weights that make up this Bin Weight
          * 
-         * @type {{type: string, outletNumber: number, outletName: ?string, weights: Array<{classType: string, weight: number, fruitCount: ?number}>}|{type: string, weights: Array<{classType: string, weight: number, fruitCount: ?number}>}[]}
+         * @type {Array<{type: string, outletNumber: number, outletName: ?string, weights: Array<{classType: string, weight: number, fruitCount: ?number}>}|{type: string, weights: Array<{classType: string, weight: number, fruitCount: ?number}>}>}
          * @public
          */
         this.sources = [];

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

@@ -198,7 +198,7 @@ class CompacSizerModel extends BaseModel
         /**
          * An Array of Sources that deliver Fruit to this Compac Sizer
          * 
-         * @type {{type: string, riserId: string}|{type: string, sizerId: string, outletNumbers: number[]}[]}
+         * @type {Array<{type: string, riserId: string}|{type: string, sizerId: string, outletNumbers: number[]}>}
          * @public
          */
         this.sources = [];

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

@@ -160,7 +160,7 @@ class MAFSizerModel extends BaseModel
         /**
          * An Array of Sources that deliver Fruit to this MAF Sizer
          * 
-         * @type {{type: string, riserId: string}|{type: string, sizerId: string, outletNumbers: number[]}[]}
+         * @type {Array<{type: string, riserId: string}|{type: string, sizerId: string, outletNumbers: number[]}>}
          * @public
          */
         this.sources = [];

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

@@ -166,7 +166,7 @@ class PackingLineModel extends BaseModel
         /**
          * The Automation Object for this Packing Line
          * 
-         * @type {?{points: {controlMode: number, autoStartAllRequest: number, stopAllRequest: number, status: number, startWarningSiren: number, safetySystemHealthy: ?number}, autoControlGroups: Array<{id: string, name: string, points: {runControl: number, startRequest: number, stopRequest: number, status: number, disabled: number}, startDelay: ?number, userStartWithoutDependencies: boolean, startSequences: Array<{startDelay: number, startOrder: number, vsds: string[], contactors: string[], basicControls: Array<{points: {status: number, control: number}, name: string}>}>, downstreamDependencyGroups: string[], neighbourDependencyGroups: string[], shutdownAlarms: string[]}>, autoSpeedGroups: Array<{id: string, name: string, vsds: string[], points: {autoSetpoint: number, overrideSetpoint: number, overrideMode: number}, sectionId: string, displayOrder: number, supportsAutoMode: boolean}>, autoTargets: Array<{id: string, name: string, description: string, type: string, units: ?string, minValue: number, maxValue: number, points: {setpoint: number, actual: number}}>, vsds: Array<{id: string, displayOrder: number}>, contactors: Array<{id: string, displayOrder: number}>, basicControls: Array<{points: {status: number, control: number}, name: string, displayOrder: number}>, shutdownAlarms: string[], lightControls: Array<{name: string, points: {status: number, control: number}}>, infeedManagement: Array<{id: string, name: string, points: {infeedFruitPerMinuteTarget: number, infeedFruitPerMinuteActual: number, sizerFruitPerMinuteActual: number, sizerRecycleFruitPerMinute: number, riser1FruitPerMinuteActual: ?number, riser1LightsControlMode: ?number, riser1LightsManualControl: ?number, riser1LightsStatus: ?number, riser2FruitPerMinuteActual: ?number, riser2LightsControlMode: ?number, riser2LightsManualControl: ?number, riser2LightsStatus: ?number}, riserCount: number, displayOrder: number, riser1AutoControlGroupId: ?string, riser2AutoControlGroupId: ?string}>, autoSpeedSections: Array<{id: string, name: string, displayOrder: number, buttonControls: Array<{icon: string, name: string, type: string, points: {control: number, disable: number}, resetDelay: number, displayOrder: number}>, splitGroupId: ?string, splitGroupPosition: ?string}>, configurationGroups: Array<{id: string, name: string, sectionId: string, displayOrder: number, configurationPoints: {name: string, type: string, point: number}|{name: string, type: string, point: number, units: ?string, minValue: number, maxValue: number}[]}>, configurationSections: Array<{id: string, name: string, displayOrder: number}>, momentaryControlGroups: Array<{name: string, momentaryControls: Array<{name: string, points: Array<{name: string, point: number}>, displayOrder: number}>}>}}
+         * @type {?{points: {controlMode: number, autoStartAllRequest: number, stopAllRequest: number, status: number, startWarningSiren: number, safetySystemHealthy: ?number}, autoControlGroups: Array<{id: string, name: string, points: {runControl: number, startRequest: number, stopRequest: number, status: number, disabled: number}, startDelay: ?number, userStartWithoutDependencies: boolean, startSequences: Array<{startDelay: number, startOrder: number, vsds: string[], contactors: string[], basicControls: Array<{points: {status: number, control: number}, name: string}>}>, downstreamDependencyGroups: string[], neighbourDependencyGroups: string[], shutdownAlarms: string[]}>, autoSpeedGroups: Array<{id: string, name: string, vsds: string[], points: {autoSetpoint: number, overrideSetpoint: number, overrideMode: number}, sectionId: string, displayOrder: number, supportsAutoMode: boolean}>, autoTargets: Array<{id: string, name: string, description: string, type: string, units: ?string, minValue: number, maxValue: number, points: {setpoint: number, actual: number}}>, vsds: Array<{id: string, displayOrder: number}>, contactors: Array<{id: string, displayOrder: number}>, basicControls: Array<{points: {status: number, control: number}, name: string, displayOrder: number}>, shutdownAlarms: string[], lightControls: Array<{name: string, points: {status: number, control: number}}>, infeedManagement: Array<{id: string, name: string, points: {infeedFruitPerMinuteTarget: number, infeedFruitPerMinuteActual: number, sizerFruitPerMinuteActual: number, sizerRecycleFruitPerMinute: number, riser1FruitPerMinuteActual: ?number, riser1LightsControlMode: ?number, riser1LightsManualControl: ?number, riser1LightsStatus: ?number, riser2FruitPerMinuteActual: ?number, riser2LightsControlMode: ?number, riser2LightsManualControl: ?number, riser2LightsStatus: ?number}, riserCount: number, displayOrder: number, riser1AutoControlGroupId: ?string, riser2AutoControlGroupId: ?string}>, autoSpeedSections: Array<{id: string, name: string, displayOrder: number, buttonControls: Array<{icon: string, name: string, type: string, points: {control: number, disable: number}, resetDelay: number, displayOrder: number}>, splitGroupId: ?string, splitGroupPosition: ?string}>, configurationGroups: Array<{id: string, name: string, sectionId: string, displayOrder: number, configurationPoints: Array<{name: string, type: string, point: number}|{name: string, type: string, point: number, units: ?string, minValue: number, maxValue: number}>}>, configurationSections: Array<{id: string, name: string, displayOrder: number}>, momentaryControlGroups: Array<{name: string, momentaryControls: Array<{name: string, points: Array<{name: string, point: number}>, displayOrder: number}>}>}}
          * @public
          */
         this.automation = null;
@@ -198,7 +198,7 @@ class PackingLineModel extends BaseModel
         /**
          * The Advanced Packrun Management Configuration for this Packing Line
          * 
-         * @type {?{points: {startPackrunChangeRequest: number, cancelPackrunChangeRequest: number, advancePackrunChangeRequest: number, skipPackrunChangeStepRequest: number, packrunChangeCurrentStep: number, packrunChangeAutomationActionsEnabled: number}, steps: {index: number, type: string, title: string, subtitle: ?string, description: string, pointActions: Array<{trigger: string, pointId: number, value: any}>, autoControlGroupActions: Array<{trigger: string, groupId: string, action: string}>}|{index: number, type: string, sizerIds: string[]}|{index: number, type: string, sizerIds: string[]}|{index: number, type: string, sizerId: string}|{index: number, type: string, title: string, subtitle: ?string, description: string, actionType: string, trigger: string, actionReference: ?any}|{index: number, type: string, title: string, subtitle: ?string, description: string, actionType: string, trigger: string, actionReference: ?any}[], enabled: boolean}}
+         * @type {?{points: {startPackrunChangeRequest: number, cancelPackrunChangeRequest: number, advancePackrunChangeRequest: number, skipPackrunChangeStepRequest: number, packrunChangeCurrentStep: number, packrunChangeAutomationActionsEnabled: number}, steps: Array<{index: number, type: string, title: string, subtitle: ?string, description: string, pointActions: Array<{trigger: string, pointId: number, value: any}>, autoControlGroupActions: Array<{trigger: string, groupId: string, action: string}>}|{index: number, type: string, sizerIds: string[]}|{index: number, type: string, sizerIds: string[]}|{index: number, type: string, sizerId: string}|{index: number, type: string, title: string, subtitle: ?string, description: string, actionType: string, trigger: string, actionReference: ?any}|{index: number, type: string, title: string, subtitle: ?string, description: string, actionType: string, trigger: string, actionReference: ?any}>, enabled: boolean}}
          * @public
          */
         this.advancedPackrunManagement = null;

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

@@ -148,7 +148,7 @@ class RejectBinScaleModel extends BaseModel
         /**
          * An Array of Sources that deliver Fruit to this Reject Bin Scale
          * 
-         * @type {{type: string, sortingTableId: string, classType: string, varietyClassTypes: Array<{varietyId: string, classType: string}>}|{type: string, beltName: ?string, classType: string, varietyClassTypes: Array<{varietyId: string, classType: string}>}|{type: string, sizerId: string, outletNumber: number}[]}
+         * @type {Array<{type: string, sortingTableId: string, classType: string, varietyClassTypes: Array<{varietyId: string, classType: string}>}|{type: string, beltName: ?string, classType: string, varietyClassTypes: Array<{varietyId: string, classType: string}>}|{type: string, sizerId: string, outletNumber: number}>}
          * @public
          */
         this.sources = [];

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

@@ -76,7 +76,7 @@ class RejectBinWeightModel extends BaseModel
         /**
          * The Source Weights that make up the Net Weight
          * 
-         * @type {{type: string, sortingTableId: string, sortingTableName: ?string, weights: Array<{classType: string, weight: number, fruitCount: ?number}>}|{type: string, beltName: ?string, weights: Array<{classType: string, weight: number, fruitCount: ?number}>}|{type: string, sizerId: string, sizerName: ?string, outletNumber: number, outletName: ?string, weights: Array<{classType: string, weight: number, fruitCount: ?number}>}|{type: string, mixedNames: string[], weights: Array<{classType: string, weight: number, fruitCount: ?number}>}[]}
+         * @type {Array<{type: string, sortingTableId: string, sortingTableName: ?string, weights: Array<{classType: string, weight: number, fruitCount: ?number}>}|{type: string, beltName: ?string, weights: Array<{classType: string, weight: number, fruitCount: ?number}>}|{type: string, sizerId: string, sizerName: ?string, outletNumber: number, outletName: ?string, weights: Array<{classType: string, weight: number, fruitCount: ?number}>}|{type: string, mixedNames: string[], weights: Array<{classType: string, weight: number, fruitCount: ?number}>}>}
          * @public
          */
         this.sources = [];

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.18';
+export const version = '2.3.20';