@ricado/api-client 2.3.5 → 2.3.8

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

@@ -7,6 +7,7 @@
 /**
  * @namespace Controllers.Packhouse.Site
  */
+import BinTipBinCardController from './BinTipBinCardController';
 import BinTipBinController from './BinTipBinController';
 import BinTipWeightController from './BinTipWeightController';
 import CompacSizerBatchController from './CompacSizerBatchController';
@@ -31,9 +32,11 @@ import ShiftHourlyEntryController from './ShiftHourlyEntryController';
 import ShiftQualitySummaryController from './ShiftQualitySummaryController';
 import ShiftTaskController from './ShiftTaskController';
 import SoftSortBeltController from './SoftSortBeltController';
+import SoftSortPackrunSummaryController from './SoftSortPackrunSummaryController';
 import VarietyController from './VarietyController';
 
 const Site = {
+    BinTipBinCardController,
     BinTipBinController,
     BinTipWeightController,
     CompacSizerBatchController,
@@ -58,6 +61,7 @@ const Site = {
     ShiftQualitySummaryController,
     ShiftTaskController,
     SoftSortBeltController,
+    SoftSortPackrunSummaryController,
     VarietyController,
 };
 

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

@@ -0,0 +1,215 @@
+/**
+ * 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 Card
+ * 
+ * @class
+ * @hideconstructor
+ * @extends BaseModel
+ */
+class BinTipBinCardModel extends BaseModel
+{
+    /**
+     * BinTipBinCardModel Constructor
+     * 
+     * @protected
+     * @param {number} siteId The Site ID associated with this Bin Tip Bin Card
+     */
+    constructor(siteId)
+    {
+        super();
+        
+        /**
+         * The Bin Tip Bin Card ID
+         * 
+         * @type {string}
+         * @public
+         */
+        this.id = "";
+        
+        /**
+         * The Bin Tip ID associated with this Bin Card
+         * 
+         * @type {string}
+         * @public
+         */
+        this.binTipId = "";
+        
+        /**
+         * The Bin ID associated with this Bin Card
+         * 
+         * @type {string}
+         * @public
+         */
+        this.binTipBinId = "";
+        
+        /**
+         * When this Bin Card was Created
+         * 
+         * @type {Date}
+         * @public
+         */
+        this.createdTimestamp = new Date();
+        
+        /**
+         * A Base64 Encoded Image of the Bin Card
+         * 
+         * @type {?string}
+         * @public
+         */
+        this.image = null;
+        
+        /**
+         * Whether the Bin Tip Bin Card has been deleted
+         * 
+         * @type {boolean}
+         * @public
+         */
+        this.deleted = false;
+        
+        /**
+         * When the Bin Tip Bin Card was last updated
+         * 
+         * @type {Date}
+         * @public
+         */
+        this.updateTimestamp = new Date();
+        
+        /**
+         * The Site ID associated with this Bin Tip Bin Card
+         * 
+         * @type {number}
+         * @public
+         */
+        this.siteId = siteId;
+    }
+
+    /**
+     * Create a new **BinTipBinCardModel** 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 Card
+     * @return {BinTipBinCardModel}
+     */
+    static fromJSON(json, siteId)
+    {
+        let model = new BinTipBinCardModel(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('binTipBinId' in jsonObject)
+        {
+            model.binTipBinId = (function(){
+                if(typeof jsonObject['binTipBinId'] !== 'string')
+                {
+                    return String(jsonObject['binTipBinId']);
+                }
+        
+                return jsonObject['binTipBinId'];
+            }());
+        }
+        
+        if('createdTimestamp' in jsonObject)
+        {
+            model.createdTimestamp = (function(){
+                if(typeof jsonObject['createdTimestamp'] !== 'string')
+                {
+                    return new Date(String(jsonObject['createdTimestamp']));
+                }
+        
+                return new Date(jsonObject['createdTimestamp']);
+            }());
+        }
+        
+        if('image' in jsonObject)
+        {
+            model.image = (function(){
+                if(jsonObject['image'] === null)
+                {
+                    return null;
+                }
+        
+                if(typeof jsonObject['image'] !== 'string')
+                {
+                    return String(jsonObject['image']);
+                }
+        
+                return jsonObject['image'];
+            }());
+        }
+        
+        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 BinTipBinCardModel;

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

@@ -65,6 +65,14 @@ class BinTipBinModel extends BaseModel
          */
         this.binNumber = null;
         
+        /**
+         * The Source of the Bin Number
+         * 
+         * @type {?string}
+         * @public
+         */
+        this.binNumberSource = null;
+        
         /**
          * The Time Batch ID associated with this Bin
          * 
@@ -232,6 +240,23 @@ class BinTipBinModel extends BaseModel
             }());
         }
         
+        if('binNumberSource' in jsonObject)
+        {
+            model.binNumberSource = (function(){
+                if(jsonObject['binNumberSource'] === null)
+                {
+                    return null;
+                }
+        
+                if(typeof jsonObject['binNumberSource'] !== 'string')
+                {
+                    return String(jsonObject['binNumberSource']);
+                }
+        
+                return jsonObject['binNumberSource'];
+            }());
+        }
+        
         if('timeBatchId' in jsonObject)
         {
             model.timeBatchId = (function(){

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

@@ -0,0 +1,370 @@
+/**
+ * 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 Soft-Sort Packrun Summary
+ * 
+ * @class
+ * @hideconstructor
+ * @extends BaseModel
+ */
+class SoftSortPackrunSummaryModel extends BaseModel
+{
+    /**
+     * SoftSortPackrunSummaryModel Constructor
+     * 
+     * @protected
+     * @param {number} siteId The Site ID associated with this Soft-Sort Packrun Summary
+     */
+    constructor(siteId)
+    {
+        super();
+        
+        /**
+         * The Soft-Sort Packrun Summary ID
+         * 
+         * @type {string}
+         * @public
+         */
+        this.id = "";
+        
+        /**
+         * The Packing Line ID this Summary is associated with
+         * 
+         * @type {string}
+         * @public
+         */
+        this.packingLineId = "";
+        
+        /**
+         * The Packrun ID this Summary is associated with
+         * 
+         * @type {string}
+         * @public
+         */
+        this.packrunId = "";
+        
+        /**
+         * When this Summary was Created
+         * 
+         * @type {Date}
+         * @public
+         */
+        this.createdTimestamp = new Date();
+        
+        /**
+         * The Number of Soft-Sort Events per Bin Tipped
+         * 
+         * @type {number}
+         * @public
+         */
+        this.eventsPerBin = 0;
+        
+        /**
+         * The Number of Soft-Sort Events that occurred for the Packrun
+         * 
+         * @type {number}
+         * @public
+         */
+        this.totalEventsCount = 0;
+        
+        /**
+         * The Average Duration of Soft-Sort Events for the Packrun expressed in Seconds
+         * 
+         * @type {number}
+         * @public
+         */
+        this.averageEventsDuration = 0;
+        
+        /**
+         * The Total Duration of all Soft-Sort Events for the Packrun expressed in Seconds
+         * 
+         * @type {number}
+         * @public
+         */
+        this.totalEventsDuration = 0;
+        
+        /**
+         * Whether the Soft-Sort Events Data for this Summary has been Finalized
+         * 
+         * @type {?Date}
+         * @public
+         */
+        this.eventsFinalizedTimestamp = null;
+        
+        /**
+         * Whether the Soft-Sort Events for this Summary are considered accurate or not
+         * 
+         * @type {?boolean}
+         * @public
+         */
+        this.eventsAccurate = null;
+        
+        /**
+         * A Reason for why the Events for this Summary are not accurate. Applies when `eventsAccurate` is false
+         * 
+         * @type {?string}
+         * @public
+         */
+        this.eventsNotAccurateReason = null;
+        
+        /**
+         * The FreshPack Soft-Sort API Data
+         * 
+         * @type {?Object}
+         * @public
+         */
+        this.freshPackSoftSortApi = null;
+        
+        /**
+         * Whether the Soft-Sort Packrun Summary has been deleted
+         * 
+         * @type {boolean}
+         * @public
+         */
+        this.deleted = false;
+        
+        /**
+         * When the Soft-Sort Packrun Summary was last updated
+         * 
+         * @type {Date}
+         * @public
+         */
+        this.updateTimestamp = new Date();
+        
+        /**
+         * The Site ID associated with this Soft-Sort Packrun Summary
+         * 
+         * @type {number}
+         * @public
+         */
+        this.siteId = siteId;
+    }
+
+    /**
+     * Create a new **SoftSortPackrunSummaryModel** 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 Soft-Sort Packrun Summary
+     * @return {SoftSortPackrunSummaryModel}
+     */
+    static fromJSON(json, siteId)
+    {
+        let model = new SoftSortPackrunSummaryModel(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('packingLineId' in jsonObject)
+        {
+            model.packingLineId = (function(){
+                if(typeof jsonObject['packingLineId'] !== 'string')
+                {
+                    return String(jsonObject['packingLineId']);
+                }
+        
+                return jsonObject['packingLineId'];
+            }());
+        }
+        
+        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('eventsPerBin' in jsonObject)
+        {
+            model.eventsPerBin = (function(){
+                if(typeof jsonObject['eventsPerBin'] !== 'number')
+                {
+                    return Number(jsonObject['eventsPerBin']);
+                }
+        
+                return jsonObject['eventsPerBin'];
+            }());
+        }
+        
+        if('totalEventsCount' in jsonObject)
+        {
+            model.totalEventsCount = (function(){
+                if(typeof jsonObject['totalEventsCount'] !== 'number')
+                {
+                    return Number.isInteger(Number(jsonObject['totalEventsCount'])) ? Number(jsonObject['totalEventsCount']) : Math.floor(Number(jsonObject['totalEventsCount']));
+                }
+        
+                return Number.isInteger(jsonObject['totalEventsCount']) ? jsonObject['totalEventsCount'] : Math.floor(jsonObject['totalEventsCount']);
+            }());
+        }
+        
+        if('averageEventsDuration' in jsonObject)
+        {
+            model.averageEventsDuration = (function(){
+                if(typeof jsonObject['averageEventsDuration'] !== 'number')
+                {
+                    return Number(jsonObject['averageEventsDuration']);
+                }
+        
+                return jsonObject['averageEventsDuration'];
+            }());
+        }
+        
+        if('totalEventsDuration' in jsonObject)
+        {
+            model.totalEventsDuration = (function(){
+                if(typeof jsonObject['totalEventsDuration'] !== 'number')
+                {
+                    return Number(jsonObject['totalEventsDuration']);
+                }
+        
+                return jsonObject['totalEventsDuration'];
+            }());
+        }
+        
+        if('eventsFinalizedTimestamp' in jsonObject)
+        {
+            model.eventsFinalizedTimestamp = (function(){
+                if(jsonObject['eventsFinalizedTimestamp'] === null)
+                {
+                    return null;
+                }
+        
+                if(typeof jsonObject['eventsFinalizedTimestamp'] !== 'string')
+                {
+                    return new Date(String(jsonObject['eventsFinalizedTimestamp']));
+                }
+        
+                return new Date(jsonObject['eventsFinalizedTimestamp']);
+            }());
+        }
+        
+        if('eventsAccurate' in jsonObject)
+        {
+            model.eventsAccurate = (function(){
+                if(jsonObject['eventsAccurate'] === null)
+                {
+                    return null;
+                }
+        
+                if(typeof jsonObject['eventsAccurate'] !== 'boolean')
+                {
+                    return Boolean(jsonObject['eventsAccurate']);
+                }
+        
+                return jsonObject['eventsAccurate'];
+            }());
+        }
+        
+        if('eventsNotAccurateReason' in jsonObject)
+        {
+            model.eventsNotAccurateReason = (function(){
+                if(jsonObject['eventsNotAccurateReason'] === null)
+                {
+                    return null;
+                }
+        
+                if(typeof jsonObject['eventsNotAccurateReason'] !== 'string')
+                {
+                    return String(jsonObject['eventsNotAccurateReason']);
+                }
+        
+                return jsonObject['eventsNotAccurateReason'];
+            }());
+        }
+        
+        if('freshPackSoftSortApi' in jsonObject)
+        {
+            model.freshPackSoftSortApi = (function(){
+                if(jsonObject['freshPackSoftSortApi'] === null)
+                {
+                    return null;
+                }
+        
+                if(typeof jsonObject['freshPackSoftSortApi'] !== 'object')
+                {
+                    return Object(jsonObject['freshPackSoftSortApi']);
+                }
+        
+                return jsonObject['freshPackSoftSortApi'];
+            }());
+        }
+        
+        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 SoftSortPackrunSummaryModel;

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

@@ -7,6 +7,7 @@
 /**
  * @namespace Models.Packhouse.Site
  */
+import BinTipBinCardModel from './BinTipBinCardModel';
 import BinTipBinModel from './BinTipBinModel';
 import BinTipWeightModel from './BinTipWeightModel';
 import CompacSizerBatchModel from './CompacSizerBatchModel';
@@ -31,9 +32,11 @@ import ShiftModel from './ShiftModel';
 import ShiftQualitySummaryModel from './ShiftQualitySummaryModel';
 import ShiftTaskModel from './ShiftTaskModel';
 import SoftSortBeltModel from './SoftSortBeltModel';
+import SoftSortPackrunSummaryModel from './SoftSortPackrunSummaryModel';
 import VarietyModel from './VarietyModel';
 
 const Site = {
+    BinTipBinCardModel,
     BinTipBinModel,
     BinTipWeightModel,
     CompacSizerBatchModel,
@@ -58,6 +61,7 @@ const Site = {
     ShiftQualitySummaryModel,
     ShiftTaskModel,
     SoftSortBeltModel,
+    SoftSortPackrunSummaryModel,
     VarietyModel,
 };
 

package/src/PackageVersion.js

@@ -1,2 +1,2 @@
 // generated by genversion
-export const version = '2.3.5';
+export const version = '2.3.8';