@ricado/api-client 2.1.1 → 2.3.1

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

@@ -0,0 +1,369 @@
+/**
+ * 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 Shift Task
+ * 
+ * @class
+ * @hideconstructor
+ * @extends BaseModel
+ */
+class ShiftTaskModel extends BaseModel
+{
+    /**
+     * ShiftTaskModel Constructor
+     * 
+     * @protected
+     * @param {number} siteId The Site ID associated with this Shift Task
+     */
+    constructor(siteId)
+    {
+        super();
+        
+        /**
+         * The Shift Task ID
+         * 
+         * @type {string}
+         * @public
+         */
+        this.id = "";
+        
+        /**
+         * The Packing Line ID this Task is associated with
+         * 
+         * @type {string}
+         * @public
+         */
+        this.packingLineId = "";
+        
+        /**
+         * The Shift ID this Task is asssociated with
+         * 
+         * @type {string}
+         * @public
+         */
+        this.shiftId = "";
+        
+        /**
+         * When this Task was Created
+         * 
+         * @type {Date}
+         * @public
+         */
+        this.createdTimestamp = new Date();
+        
+        /**
+         * When this Task was Completed
+         * 
+         * @type {?Date}
+         * @public
+         */
+        this.completedTimestamp = null;
+        
+        /**
+         * The User ID of the Author for this Task
+         * 
+         * @type {?string}
+         * @public
+         */
+        this.authorUserId = null;
+        
+        /**
+         * The Name of the Author for this Task
+         * 
+         * @type {string}
+         * @public
+         */
+        this.authorName = "";
+        
+        /**
+         * The Task Type
+         * 
+         * @type {string}
+         * @public
+         */
+        this.type = "";
+        
+        /**
+         * An Array of Tag IDs for this Task
+         * 
+         * @type {string[]}
+         * @public
+         */
+        this.tags = [];
+        
+        /**
+         * The Title of this Task
+         * 
+         * @type {string}
+         * @public
+         */
+        this.title = "";
+        
+        /**
+         * The Content of this Task
+         * 
+         * @type {string}
+         * @public
+         */
+        this.content = "";
+        
+        /**
+         * The Status of this Task
+         * 
+         * @type {string}
+         * @public
+         */
+        this.status = "";
+        
+        /**
+         * Whether the Shift Task has been deleted
+         * 
+         * @type {boolean}
+         * @public
+         */
+        this.deleted = false;
+        
+        /**
+         * When the Shift Task was last updated
+         * 
+         * @type {Date}
+         * @public
+         */
+        this.updateTimestamp = new Date();
+        
+        /**
+         * The Site ID associated with this Shift Task
+         * 
+         * @type {number}
+         * @public
+         */
+        this.siteId = siteId;
+    }
+
+    /**
+     * Create a new **ShiftTaskModel** 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 Shift Task
+     * @return {ShiftTaskModel}
+     */
+    static fromJSON(json, siteId)
+    {
+        let model = new ShiftTaskModel(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('shiftId' in jsonObject)
+        {
+            model.shiftId = (function(){
+                if(typeof jsonObject['shiftId'] !== 'string')
+                {
+                    return String(jsonObject['shiftId']);
+                }
+        
+                return jsonObject['shiftId'];
+            }());
+        }
+        
+        if('createdTimestamp' in jsonObject)
+        {
+            model.createdTimestamp = (function(){
+                if(typeof jsonObject['createdTimestamp'] !== 'string')
+                {
+                    return new Date(String(jsonObject['createdTimestamp']));
+                }
+        
+                return new Date(jsonObject['createdTimestamp']);
+            }());
+        }
+        
+        if('completedTimestamp' in jsonObject)
+        {
+            model.completedTimestamp = (function(){
+                if(jsonObject['completedTimestamp'] === null)
+                {
+                    return null;
+                }
+        
+                if(typeof jsonObject['completedTimestamp'] !== 'string')
+                {
+                    return new Date(String(jsonObject['completedTimestamp']));
+                }
+        
+                return new Date(jsonObject['completedTimestamp']);
+            }());
+        }
+        
+        if('authorUserId' in jsonObject)
+        {
+            model.authorUserId = (function(){
+                if(jsonObject['authorUserId'] === null)
+                {
+                    return null;
+                }
+        
+                if(typeof jsonObject['authorUserId'] !== 'string')
+                {
+                    return String(jsonObject['authorUserId']);
+                }
+        
+                return jsonObject['authorUserId'];
+            }());
+        }
+        
+        if('authorName' in jsonObject)
+        {
+            model.authorName = (function(){
+                if(typeof jsonObject['authorName'] !== 'string')
+                {
+                    return String(jsonObject['authorName']);
+                }
+        
+                return jsonObject['authorName'];
+            }());
+        }
+        
+        if('type' in jsonObject)
+        {
+            model.type = (function(){
+                if(typeof jsonObject['type'] !== 'string')
+                {
+                    return String(jsonObject['type']);
+                }
+        
+                return jsonObject['type'];
+            }());
+        }
+        
+        if('tags' in jsonObject)
+        {
+            model.tags = (function(){
+                if(Array.isArray(jsonObject['tags']) !== true)
+                {
+                    return [];
+                }
+        
+                return jsonObject['tags'].map((tagsItem) => {
+                    return (function(){
+                        if(typeof tagsItem !== 'string')
+                        {
+                            return String(tagsItem);
+                        }
+        
+                        return tagsItem;
+                    }());
+                });
+            }());
+        }
+        
+        if('title' in jsonObject)
+        {
+            model.title = (function(){
+                if(typeof jsonObject['title'] !== 'string')
+                {
+                    return String(jsonObject['title']);
+                }
+        
+                return jsonObject['title'];
+            }());
+        }
+        
+        if('content' in jsonObject)
+        {
+            model.content = (function(){
+                if(typeof jsonObject['content'] !== 'string')
+                {
+                    return String(jsonObject['content']);
+                }
+        
+                return jsonObject['content'];
+            }());
+        }
+        
+        if('status' in jsonObject)
+        {
+            model.status = (function(){
+                if(typeof jsonObject['status'] !== 'string')
+                {
+                    return String(jsonObject['status']);
+                }
+        
+                return jsonObject['status'];
+            }());
+        }
+        
+        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 ShiftTaskModel;

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

@@ -31,7 +31,7 @@ class SoftSortBeltModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.id = undefined;
+        this.id = "";
         
         /**
          * The RTU this Soft Sort Belt belongs to
@@ -39,7 +39,7 @@ class SoftSortBeltModel extends BaseModel
          * @type {?number}
          * @public
          */
-        this.rtuId = undefined;
+        this.rtuId = null;
         
         /**
          * The Name of this Soft Sort Belt
@@ -47,7 +47,7 @@ class SoftSortBeltModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.name = undefined;
+        this.name = "";
         
         /**
          * The Points used by this Soft Sort Belt
@@ -55,7 +55,7 @@ class SoftSortBeltModel extends BaseModel
          * @type {Object}
          * @public
          */
-        this.points = undefined;
+        this.points = {}
         
         /**
          * The Packing Line that owns this Soft Sort Belt
@@ -63,7 +63,7 @@ class SoftSortBeltModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.packingLineId = undefined;
+        this.packingLineId = "";
         
         /**
          * Whether the Soft Sort Belt has been deleted
@@ -71,7 +71,7 @@ class SoftSortBeltModel extends BaseModel
          * @type {boolean}
          * @public
          */
-        this.deleted = undefined;
+        this.deleted = false;
         
         /**
          * When the Soft Sort Belt was last updated
@@ -79,7 +79,7 @@ class SoftSortBeltModel extends BaseModel
          * @type {Date}
          * @public
          */
-        this.updateTimestamp = undefined;
+        this.updateTimestamp = new Date();
         
         /**
          * The Site ID associated with this Soft Sort Belt

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

@@ -31,7 +31,7 @@ class VarietyModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.id = undefined;
+        this.id = "";
         
         /**
          * The Variety Code
@@ -39,7 +39,7 @@ class VarietyModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.code = undefined;
+        this.code = "";
         
         /**
          * The Variety Name
@@ -47,7 +47,7 @@ class VarietyModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.name = undefined;
+        this.name = "";
         
         /**
          * The Variety Description
@@ -55,7 +55,7 @@ class VarietyModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.description = undefined;
+        this.description = "";
         
         /**
          * The Variety Image Source
@@ -63,7 +63,7 @@ class VarietyModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.image = undefined;
+        this.image = "";
         
         /**
          * An Array of Fruit Sizes Defined for this Variety
@@ -71,7 +71,7 @@ class VarietyModel extends BaseModel
          * @type {Array<{size: string}>}
          * @public
          */
-        this.fruitSizes = undefined;
+        this.fruitSizes = [];
         
         /**
          * Whether the Variety has been deleted
@@ -79,7 +79,7 @@ class VarietyModel extends BaseModel
          * @type {boolean}
          * @public
          */
-        this.deleted = undefined;
+        this.deleted = false;
         
         /**
          * When the Variety was last updated
@@ -87,7 +87,7 @@ class VarietyModel extends BaseModel
          * @type {Date}
          * @public
          */
-        this.updateTimestamp = undefined;
+        this.updateTimestamp = new Date();
         
         /**
          * The Site ID associated with this Variety

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

@@ -7,6 +7,7 @@
 /**
  * @namespace Models.Packhouse.Site
  */
+import BinTipBinModel from './BinTipBinModel';
 import BinTipWeightModel from './BinTipWeightModel';
 import CompacSizerBatchModel from './CompacSizerBatchModel';
 import CompacSizerModel from './CompacSizerModel';
@@ -16,6 +17,7 @@ import CompacSizerOutletTypeModel from './CompacSizerOutletTypeModel';
 import CompacSizerPackrunSummaryModel from './CompacSizerPackrunSummaryModel';
 import DowntimeEventModel from './DowntimeEventModel';
 import FreshPackPackrunSummaryModel from './FreshPackPackrunSummaryModel';
+import FreshQualityPackrunSummaryModel from './FreshQualityPackrunSummaryModel';
 import GrowingMethodModel from './GrowingMethodModel';
 import PackTypeModel from './PackTypeModel';
 import PackingLineModel from './PackingLineModel';
@@ -26,10 +28,13 @@ import RejectBinWeightModel from './RejectBinWeightModel';
 import ShiftFocusMeetingModel from './ShiftFocusMeetingModel';
 import ShiftHourlyEntryModel from './ShiftHourlyEntryModel';
 import ShiftModel from './ShiftModel';
+import ShiftQualitySummaryModel from './ShiftQualitySummaryModel';
+import ShiftTaskModel from './ShiftTaskModel';
 import SoftSortBeltModel from './SoftSortBeltModel';
 import VarietyModel from './VarietyModel';
 
 const Site = {
+    BinTipBinModel,
     BinTipWeightModel,
     CompacSizerBatchModel,
     CompacSizerModel,
@@ -39,6 +44,7 @@ const Site = {
     CompacSizerPackrunSummaryModel,
     DowntimeEventModel,
     FreshPackPackrunSummaryModel,
+    FreshQualityPackrunSummaryModel,
     GrowingMethodModel,
     PackTypeModel,
     PackingLineModel,
@@ -49,6 +55,8 @@ const Site = {
     ShiftFocusMeetingModel,
     ShiftHourlyEntryModel,
     ShiftModel,
+    ShiftQualitySummaryModel,
+    ShiftTaskModel,
     SoftSortBeltModel,
     VarietyModel,
 };

package/src/Models/RTUModel.js

@@ -30,7 +30,7 @@ class RTUModel extends BaseModel
          * @type {number}
          * @public
          */
-        this.id = undefined;
+        this.id = 0;
         
         /**
          * The Site this RTU belongs to
@@ -38,7 +38,7 @@ class RTUModel extends BaseModel
          * @type {number}
          * @public
          */
-        this.siteId = undefined;
+        this.siteId = 0;
         
         /**
          * The RTU Name
@@ -46,7 +46,7 @@ class RTUModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.name = undefined;
+        this.name = "";
         
         /**
          * Whether the RTU is Enabled
@@ -54,7 +54,7 @@ class RTUModel extends BaseModel
          * @type {boolean}
          * @public
          */
-        this.enabled = undefined;
+        this.enabled = false;
         
         /**
          * Whether the RTU has been deleted
@@ -62,7 +62,7 @@ class RTUModel extends BaseModel
          * @type {boolean}
          * @public
          */
-        this.deleted = undefined;
+        this.deleted = false;
         
         /**
          * When the RTU was last updated
@@ -70,7 +70,7 @@ class RTUModel extends BaseModel
          * @type {Date}
          * @public
          */
-        this.updateTimestamp = undefined;
+        this.updateTimestamp = new Date();
     }
 
     /**

package/src/Models/RTUPluginModel.js

@@ -30,7 +30,7 @@ class RTUPluginModel extends BaseModel
          * @type {number}
          * @public
          */
-        this.id = undefined;
+        this.id = 0;
         
         /**
          * The Plugin Name
@@ -38,7 +38,7 @@ class RTUPluginModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.name = undefined;
+        this.name = "";
         
         /**
          * The Company this RTU Plugin belongs to
@@ -46,7 +46,7 @@ class RTUPluginModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.companyId = undefined;
+        this.companyId = "";
         
         /**
          * Whether the RTU Plugin has been deleted
@@ -54,7 +54,7 @@ class RTUPluginModel extends BaseModel
          * @type {boolean}
          * @public
          */
-        this.deleted = undefined;
+        this.deleted = false;
         
         /**
          * When the RTU Plugin was last updated
@@ -62,7 +62,7 @@ class RTUPluginModel extends BaseModel
          * @type {Date}
          * @public
          */
-        this.updateTimestamp = undefined;
+        this.updateTimestamp = new Date();
     }
 
     /**

package/src/Models/Site/AlarmGroupModel.js

@@ -31,7 +31,7 @@ class AlarmGroupModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.id = undefined;
+        this.id = "";
         
         /**
          * The RTU this Alarm Group belongs to
@@ -39,7 +39,7 @@ class AlarmGroupModel extends BaseModel
          * @type {?number}
          * @public
          */
-        this.rtuId = undefined;
+        this.rtuId = null;
         
         /**
          * The Alarm Group Name
@@ -47,7 +47,7 @@ class AlarmGroupModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.name = undefined;
+        this.name = "";
         
         /**
          * The Boolean Point used to Reset this Alarm Group
@@ -55,7 +55,7 @@ class AlarmGroupModel extends BaseModel
          * @type {number}
          * @public
          */
-        this.resetPoint = undefined;
+        this.resetPoint = 0;
         
         /**
          * An Array of Points and the States to be Written when this Alarm Group is Reset
@@ -63,7 +63,7 @@ class AlarmGroupModel extends BaseModel
          * @type {Array<{point: number, value: boolean}>}
          * @public
          */
-        this.externalResetPoints = undefined;
+        this.externalResetPoints = [];
         
         /**
          * Whether the Alarm Group has been deleted
@@ -71,7 +71,7 @@ class AlarmGroupModel extends BaseModel
          * @type {boolean}
          * @public
          */
-        this.deleted = undefined;
+        this.deleted = false;
         
         /**
          * When the Alarm Group was last updated
@@ -79,7 +79,7 @@ class AlarmGroupModel extends BaseModel
          * @type {Date}
          * @public
          */
-        this.updateTimestamp = undefined;
+        this.updateTimestamp = new Date();
         
         /**
          * The Site ID associated with this Alarm Group