@ricado/api-client 1.4.1 → 2.1.0

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

@@ -4,16 +4,16 @@
  * Do Not Edit this File Manually!
  */
 
-import BaseSiteModel from '../../../Models/Site/BaseSiteModel';
+import BaseModel from '../../../Models/BaseModel';
 
 /**
  * Model Class for a Shift
  * 
  * @class
  * @hideconstructor
- * @extends BaseSiteModel
+ * @extends BaseModel
  */
-class ShiftModel extends BaseSiteModel
+class ShiftModel extends BaseModel
 {
     /**
      * ShiftModel Constructor
@@ -29,412 +29,161 @@ class ShiftModel extends BaseSiteModel
          * The Shift ID
          * 
          * @type {string}
-         * @private
+         * @public
          */
-        this._id = undefined;
+        this.id = undefined;
         
         /**
          * The Packing Line ID this Shift is associated with
          * 
          * @type {string}
-         * @private
+         * @public
          */
-        this._packingLineId = undefined;
+        this.packingLineId = undefined;
         
         /**
          * When this Shift was Created
          * 
          * @type {Date}
-         * @private
+         * @public
          */
-        this._createdTimestamp = undefined;
+        this.createdTimestamp = undefined;
         
         /**
          * The Type of Shift
          * 
          * @type {string}
-         * @private
+         * @public
          */
-        this._type = undefined;
+        this.type = undefined;
         
         /**
          * The Name of the Line Manager for this Shift
          * 
          * @type {?string}
-         * @private
+         * @public
          */
-        this._lineManagerName = undefined;
+        this.lineManagerName = undefined;
         
         /**
          * The Target Number of Bins to Tip for this Shift
          * 
          * @type {?number}
-         * @private
+         * @public
          */
-        this._binsTippedTarget = undefined;
+        this.binsTippedTarget = undefined;
         
         /**
          * *DEPRECATED* The Initial Number of People working in all Areas except Class 2 for this Hour
          * 
          * @type {?number}
-         * @private
+         * @public
          */
-        this._initialClass1Manning = undefined;
+        this.initialClass1Manning = undefined;
         
         /**
          * *DEPRECATED* The Initial Number of People working in the Class 2 Area for this Hour
          * 
          * @type {?number}
-         * @private
+         * @public
          */
-        this._initialClass2Manning = undefined;
+        this.initialClass2Manning = undefined;
         
         /**
          * When this Shift was Ready for Packing
          * 
          * @type {?Date}
-         * @private
+         * @public
          */
-        this._readyTimestamp = undefined;
+        this.readyTimestamp = undefined;
         
         /**
          * When this Shift was Started
          * 
          * @type {?Date}
-         * @private
+         * @public
          */
-        this._startTimestamp = undefined;
+        this.startTimestamp = undefined;
         
         /**
          * When this Shift was Finished
          * 
          * @type {?Date}
-         * @private
+         * @public
          */
-        this._finishTimestamp = undefined;
+        this.finishTimestamp = undefined;
         
         /**
          * When this Shift was Published
          * 
          * @type {?Date}
-         * @private
+         * @public
          */
-        this._publishTimestamp = undefined;
+        this.publishTimestamp = undefined;
         
         /**
          * An Optional Rating between 1 and 10 on how Satisfied the Line Manager was with this Shift
          * 
          * @type {?number}
-         * @private
+         * @public
          */
-        this._satisfactionRating = undefined;
+        this.satisfactionRating = undefined;
         
         /**
          * *DEPRECATED* An Optional Array of Handover Notes for this Shift
          * 
          * @type {Array<{area: string, noteContent: string}>}
-         * @private
+         * @public
          */
-        this._handoverNotes = undefined;
+        this.handoverNotes = undefined;
         
         /**
          * An Optional Array of Notes for this Shift
          * 
          * @type {Array<{area: string, timestamp: Date, content: string}>}
-         * @private
+         * @public
          */
-        this._areaNotes = undefined;
+        this.areaNotes = undefined;
         
         /**
          * The Schedule for this Shift
          * 
          * @type {{startTime: string, endTime: string, breaks: Array<{startTime: string, endTime: string}>}}
-         * @private
+         * @public
          */
-        this._schedule = undefined;
+        this.schedule = undefined;
         
         /**
          * The Status of this Shift
          * 
          * @type {string}
-         * @private
+         * @public
          */
-        this._status = undefined;
+        this.status = undefined;
         
         /**
          * Whether the Shift has been deleted
          * 
          * @type {boolean}
-         * @private
+         * @public
          */
-        this._deleted = undefined;
+        this.deleted = undefined;
         
         /**
          * When the Shift was last updated
          * 
          * @type {Date}
-         * @private
+         * @public
          */
-        this._updateTimestamp = undefined;
+        this.updateTimestamp = undefined;
         
         /**
          * The Site ID associated with this Shift
          * 
          * @type {number}
-         * @private
+         * @public
          */
-        this._siteId = siteId;
-    }
-
-    /**
-     * The Shift ID
-     * 
-     * @public
-     * @type {string}
-     */
-    get id()
-    {
-        return this._id;
-    }
-
-    /**
-     * The Packing Line ID this Shift is associated with
-     * 
-     * @public
-     * @type {string}
-     */
-    get packingLineId()
-    {
-        return this._packingLineId;
-    }
-
-    /**
-     * When this Shift was Created
-     * 
-     * @public
-     * @type {Date}
-     */
-    get createdTimestamp()
-    {
-        return this._createdTimestamp;
-    }
-
-    /**
-     * The Type of Shift
-     * 
-     * @public
-     * @type {string}
-     */
-    get type()
-    {
-        return this._type;
-    }
-
-    /**
-     * The Name of the Line Manager for this Shift
-     * 
-     * @public
-     * @type {?string}
-     */
-    get lineManagerName()
-    {
-        return this._lineManagerName;
-    }
-
-    /**
-     * The Target Number of Bins to Tip for this Shift
-     * 
-     * @public
-     * @type {?number}
-     */
-    get binsTippedTarget()
-    {
-        return this._binsTippedTarget;
-    }
-
-    /**
-     * *DEPRECATED* The Initial Number of People working in all Areas except Class 2 for this Hour
-     * 
-     * @public
-     * @type {?number}
-     */
-    get initialClass1Manning()
-    {
-        return this._initialClass1Manning;
-    }
-
-    /**
-     * *DEPRECATED* The Initial Number of People working in the Class 2 Area for this Hour
-     * 
-     * @public
-     * @type {?number}
-     */
-    get initialClass2Manning()
-    {
-        return this._initialClass2Manning;
-    }
-
-    /**
-     * When this Shift was Ready for Packing
-     * 
-     * @public
-     * @type {?Date}
-     */
-    get readyTimestamp()
-    {
-        return this._readyTimestamp;
-    }
-
-    /**
-     * When this Shift was Started
-     * 
-     * @public
-     * @type {?Date}
-     */
-    get startTimestamp()
-    {
-        return this._startTimestamp;
-    }
-
-    /**
-     * When this Shift was Finished
-     * 
-     * @public
-     * @type {?Date}
-     */
-    get finishTimestamp()
-    {
-        return this._finishTimestamp;
-    }
-
-    /**
-     * When this Shift was Published
-     * 
-     * @public
-     * @type {?Date}
-     */
-    get publishTimestamp()
-    {
-        return this._publishTimestamp;
-    }
-
-    /**
-     * An Optional Rating between 1 and 10 on how Satisfied the Line Manager was with this Shift
-     * 
-     * @public
-     * @type {?number}
-     */
-    get satisfactionRating()
-    {
-        return this._satisfactionRating;
-    }
-
-    /**
-     * *DEPRECATED* An Optional Array of Handover Notes for this Shift
-     * 
-     * @public
-     * @type {Array<{area: string, noteContent: string}>}
-     */
-    get handoverNotes()
-    {
-        return this._handoverNotes;
-    }
-
-    /**
-     * An Optional Array of Notes for this Shift
-     * 
-     * @public
-     * @type {Array<{area: string, timestamp: Date, content: string}>}
-     */
-    get areaNotes()
-    {
-        return this._areaNotes;
-    }
-
-    /**
-     * The Schedule for this Shift
-     * 
-     * @public
-     * @type {{startTime: string, endTime: string, breaks: Array<{startTime: string, endTime: string}>}}
-     */
-    get schedule()
-    {
-        return this._schedule;
-    }
-
-    /**
-     * The Status of this Shift
-     * 
-     * @public
-     * @type {string}
-     */
-    get status()
-    {
-        return this._status;
-    }
-
-    /**
-     * Whether the Shift has been deleted
-     * 
-     * @public
-     * @type {boolean}
-     */
-    get deleted()
-    {
-        return this._deleted;
-    }
-
-    /**
-     * When the Shift was last updated
-     * 
-     * @public
-     * @type {Date}
-     */
-    get updateTimestamp()
-    {
-        return this._updateTimestamp;
-    }
-
-    /**
-     * The Site ID associated with this Shift
-     * 
-     * @public
-     * @type {number}
-     */
-    get siteId()
-    {
-        return this._siteId;
-    }
-
-    /**
-     * Convert this **ShiftModel** to a JSON Object
-     * 
-     * @public
-     * @return {Object<string, any>}
-     */
-    toJSON()
-    {
-        return {
-            id: this._id,
-            packingLineId: this._packingLineId,
-            createdTimestamp: this._createdTimestamp,
-            type: this._type,
-            lineManagerName: this._lineManagerName,
-            binsTippedTarget: this._binsTippedTarget,
-            initialClass1Manning: this._initialClass1Manning,
-            initialClass2Manning: this._initialClass2Manning,
-            readyTimestamp: this._readyTimestamp,
-            startTimestamp: this._startTimestamp,
-            finishTimestamp: this._finishTimestamp,
-            publishTimestamp: this._publishTimestamp,
-            satisfactionRating: this._satisfactionRating,
-            handoverNotes: this._handoverNotes,
-            areaNotes: this._areaNotes,
-            schedule: this._schedule,
-            status: this._status,
-            deleted: this._deleted,
-            updateTimestamp: this._updateTimestamp
-        };
+        this.siteId = siteId;
     }
 
     /**
@@ -468,7 +217,7 @@ class ShiftModel extends BaseSiteModel
         
         if('id' in jsonObject)
         {
-            model._id = (function(){
+            model.id = (function(){
                 if(typeof jsonObject['id'] !== 'string')
                 {
                     return String(jsonObject['id']);
@@ -480,7 +229,7 @@ class ShiftModel extends BaseSiteModel
         
         if('packingLineId' in jsonObject)
         {
-            model._packingLineId = (function(){
+            model.packingLineId = (function(){
                 if(typeof jsonObject['packingLineId'] !== 'string')
                 {
                     return String(jsonObject['packingLineId']);
@@ -492,7 +241,7 @@ class ShiftModel extends BaseSiteModel
         
         if('createdTimestamp' in jsonObject)
         {
-            model._createdTimestamp = (function(){
+            model.createdTimestamp = (function(){
                 if(typeof jsonObject['createdTimestamp'] !== 'string')
                 {
                     return new Date(String(jsonObject['createdTimestamp']));
@@ -504,7 +253,7 @@ class ShiftModel extends BaseSiteModel
         
         if('type' in jsonObject)
         {
-            model._type = (function(){
+            model.type = (function(){
                 if(typeof jsonObject['type'] !== 'string')
                 {
                     return String(jsonObject['type']);
@@ -516,7 +265,7 @@ class ShiftModel extends BaseSiteModel
         
         if('lineManagerName' in jsonObject)
         {
-            model._lineManagerName = (function(){
+            model.lineManagerName = (function(){
                 if(jsonObject['lineManagerName'] === null)
                 {
                     return null;
@@ -533,7 +282,7 @@ class ShiftModel extends BaseSiteModel
         
         if('binsTippedTarget' in jsonObject)
         {
-            model._binsTippedTarget = (function(){
+            model.binsTippedTarget = (function(){
                 if(jsonObject['binsTippedTarget'] === null)
                 {
                     return null;
@@ -550,7 +299,7 @@ class ShiftModel extends BaseSiteModel
         
         if('initialClass1Manning' in jsonObject)
         {
-            model._initialClass1Manning = (function(){
+            model.initialClass1Manning = (function(){
                 if(jsonObject['initialClass1Manning'] === null)
                 {
                     return null;
@@ -567,7 +316,7 @@ class ShiftModel extends BaseSiteModel
         
         if('initialClass2Manning' in jsonObject)
         {
-            model._initialClass2Manning = (function(){
+            model.initialClass2Manning = (function(){
                 if(jsonObject['initialClass2Manning'] === null)
                 {
                     return null;
@@ -584,7 +333,7 @@ class ShiftModel extends BaseSiteModel
         
         if('readyTimestamp' in jsonObject)
         {
-            model._readyTimestamp = (function(){
+            model.readyTimestamp = (function(){
                 if(jsonObject['readyTimestamp'] === null)
                 {
                     return null;
@@ -601,7 +350,7 @@ class ShiftModel extends BaseSiteModel
         
         if('startTimestamp' in jsonObject)
         {
-            model._startTimestamp = (function(){
+            model.startTimestamp = (function(){
                 if(jsonObject['startTimestamp'] === null)
                 {
                     return null;
@@ -618,7 +367,7 @@ class ShiftModel extends BaseSiteModel
         
         if('finishTimestamp' in jsonObject)
         {
-            model._finishTimestamp = (function(){
+            model.finishTimestamp = (function(){
                 if(jsonObject['finishTimestamp'] === null)
                 {
                     return null;
@@ -635,7 +384,7 @@ class ShiftModel extends BaseSiteModel
         
         if('publishTimestamp' in jsonObject)
         {
-            model._publishTimestamp = (function(){
+            model.publishTimestamp = (function(){
                 if(jsonObject['publishTimestamp'] === null)
                 {
                     return null;
@@ -652,7 +401,7 @@ class ShiftModel extends BaseSiteModel
         
         if('satisfactionRating' in jsonObject)
         {
-            model._satisfactionRating = (function(){
+            model.satisfactionRating = (function(){
                 if(jsonObject['satisfactionRating'] === null)
                 {
                     return null;
@@ -669,7 +418,7 @@ class ShiftModel extends BaseSiteModel
         
         if('handoverNotes' in jsonObject)
         {
-            model._handoverNotes = (function(){
+            model.handoverNotes = (function(){
                 if(Array.isArray(jsonObject['handoverNotes']) !== true)
                 {
                     return [];
@@ -719,7 +468,7 @@ class ShiftModel extends BaseSiteModel
         
         if('areaNotes' in jsonObject)
         {
-            model._areaNotes = (function(){
+            model.areaNotes = (function(){
                 if(Array.isArray(jsonObject['areaNotes']) !== true)
                 {
                     return [];
@@ -785,7 +534,7 @@ class ShiftModel extends BaseSiteModel
         
         if('schedule' in jsonObject)
         {
-            model._schedule = (function(){
+            model.schedule = (function(){
                 let scheduleObject = {};
                 
                 if(typeof jsonObject['schedule'] === 'object' && 'startTime' in jsonObject['schedule'])
@@ -880,7 +629,7 @@ class ShiftModel extends BaseSiteModel
         
         if('status' in jsonObject)
         {
-            model._status = (function(){
+            model.status = (function(){
                 if(typeof jsonObject['status'] !== 'string')
                 {
                     return String(jsonObject['status']);
@@ -892,7 +641,7 @@ class ShiftModel extends BaseSiteModel
         
         if('deleted' in jsonObject)
         {
-            model._deleted = (function(){
+            model.deleted = (function(){
                 if(typeof jsonObject['deleted'] !== 'boolean')
                 {
                     return Boolean(jsonObject['deleted']);
@@ -904,7 +653,7 @@ class ShiftModel extends BaseSiteModel
         
         if('updateTimestamp' in jsonObject)
         {
-            model._updateTimestamp = (function(){
+            model.updateTimestamp = (function(){
                 if(typeof jsonObject['updateTimestamp'] !== 'string')
                 {
                     return new Date(String(jsonObject['updateTimestamp']));