@ricado/api-client 2.2.0 → 2.3.0

package/lib/index.js

@@ -111,7 +111,7 @@ function isDefined(variable) {
  * The JSON Web Token for all Authenticated API Calls
  * 
  * @private
- * @type {string}
+ * @type {string|undefined}
  */
 
 
@@ -516,13 +516,13 @@ function ping() {
 }
 /**
  * 
- * @param {string} jwt The JWT Token
+ * @param {string|undefined} jwt The JWT Token
  * @return {boolean}
  */
 
 
 function isJwtValid(jwt) {
-  if (jwt === null || typeof jwt !== 'string') {
+  if (jwt === null || jwt === undefined || typeof jwt !== 'string') {
     return false;
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ricado/api-client",
-    "version": "2.2.0",
+    "version": "2.3.0",
     "description": "RICADO Gen 4 API Client Library for NodeJS and Browsers",
     "author": {
         "name": "Ash Neilson"

package/src/DataItems/PointValueItem.js

@@ -25,7 +25,7 @@ class PointValueItem
          * @type {number}
          * @private
          */
-        this._id = undefined;
+        this._id = 0;
         
         /**
          * The Point Value
@@ -33,7 +33,7 @@ class PointValueItem
          * @type {any}
          * @private
          */
-        this._value = undefined;
+        this._value = null;
         
         /**
          * When the Point Value last changed
@@ -41,7 +41,7 @@ class PointValueItem
          * @type {Date}
          * @private
          */
-        this._timestamp = undefined;
+        this._timestamp = new Date();
     }
 
     /**

package/src/Models/AccountPolicyModel.js

@@ -30,7 +30,7 @@ class AccountPolicyModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.id = undefined;
+        this.id = "";
         
         /**
          * The Policy Name
@@ -38,7 +38,7 @@ class AccountPolicyModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.name = undefined;
+        this.name = "";
         
         /**
          * The Company this Policy belongs to
@@ -46,7 +46,7 @@ class AccountPolicyModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.companyId = undefined;
+        this.companyId = "";
         
         /**
          * The Resources this Policy provides
@@ -54,7 +54,7 @@ class AccountPolicyModel extends BaseModel
          * @type {Array<{id: any, type: string, actions: string[], permission: string}>}
          * @public
          */
-        this.resources = undefined;
+        this.resources = [];
         
         /**
          * The Rules this Policy provides
@@ -62,7 +62,7 @@ class AccountPolicyModel extends BaseModel
          * @type {Object[]}
          * @public
          */
-        this.rules = undefined;
+        this.rules = [];
         
         /**
          * Whether the Account Policy has been deleted
@@ -70,7 +70,7 @@ class AccountPolicyModel extends BaseModel
          * @type {boolean}
          * @public
          */
-        this.deleted = undefined;
+        this.deleted = false;
         
         /**
          * When the Account Policy was last updated
@@ -78,7 +78,7 @@ class AccountPolicyModel extends BaseModel
          * @type {Date}
          * @public
          */
-        this.updateTimestamp = undefined;
+        this.updateTimestamp = new Date();
     }
 
     /**

package/src/Models/ApiAccountModel.js

@@ -30,7 +30,7 @@ class ApiAccountModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.id = undefined;
+        this.id = "";
         
         /**
          * API Key
@@ -38,7 +38,7 @@ class ApiAccountModel extends BaseModel
          * @type {?string}
          * @public
          */
-        this.key = undefined;
+        this.key = null;
         
         /**
          * The API Account Name
@@ -46,7 +46,7 @@ class ApiAccountModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.name = undefined;
+        this.name = "";
         
         /**
          * The Company this API Account belongs to
@@ -54,7 +54,7 @@ class ApiAccountModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.companyId = undefined;
+        this.companyId = "";
         
         /**
          * The Policies that apply to this API Account
@@ -62,7 +62,7 @@ class ApiAccountModel extends BaseModel
          * @type {string[]}
          * @public
          */
-        this.policies = undefined;
+        this.policies = [];
         
         /**
          * Whether the API Account has been deleted
@@ -70,7 +70,7 @@ class ApiAccountModel extends BaseModel
          * @type {boolean}
          * @public
          */
-        this.deleted = undefined;
+        this.deleted = false;
         
         /**
          * When the API Account was last updated
@@ -78,7 +78,7 @@ class ApiAccountModel extends BaseModel
          * @type {Date}
          * @public
          */
-        this.updateTimestamp = undefined;
+        this.updateTimestamp = new Date();
     }
 
     /**

package/src/Models/CompanyModel.js

@@ -30,7 +30,7 @@ class CompanyModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.id = undefined;
+        this.id = "";
         
         /**
          * The Company Display Name
@@ -38,7 +38,7 @@ class CompanyModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.displayName = undefined;
+        this.displayName = "";
         
         /**
          * The Company Legal Name
@@ -46,7 +46,7 @@ class CompanyModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.legalName = undefined;
+        this.legalName = "";
         
         /**
          * Whether the Company has been deleted
@@ -54,7 +54,7 @@ class CompanyModel extends BaseModel
          * @type {boolean}
          * @public
          */
-        this.deleted = undefined;
+        this.deleted = false;
         
         /**
          * When the Company was last updated
@@ -62,7 +62,7 @@ class CompanyModel extends BaseModel
          * @type {Date}
          * @public
          */
-        this.updateTimestamp = undefined;
+        this.updateTimestamp = new Date();
     }
 
     /**

package/src/Models/FirebaseTokenModel.js

@@ -30,7 +30,7 @@ class FirebaseTokenModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.id = undefined;
+        this.id = "";
         
         /**
          * The Account this Firebase Token belongs to
@@ -38,7 +38,7 @@ class FirebaseTokenModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.accountId = undefined;
+        this.accountId = "";
         
         /**
          * The Firebase Token
@@ -46,7 +46,7 @@ class FirebaseTokenModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.token = undefined;
+        this.token = "";
         
         /**
          * Whether the Firebase Token should receive Notifications
@@ -54,7 +54,7 @@ class FirebaseTokenModel extends BaseModel
          * @type {boolean}
          * @public
          */
-        this.enabled = undefined;
+        this.enabled = false;
         
         /**
          * The Device Name
@@ -62,7 +62,7 @@ class FirebaseTokenModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.deviceName = undefined;
+        this.deviceName = "";
         
         /**
          * The Device Platform
@@ -70,7 +70,7 @@ class FirebaseTokenModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.devicePlatform = undefined;
+        this.devicePlatform = "";
         
         /**
          * Whether the Firebase Token has been deleted
@@ -78,7 +78,7 @@ class FirebaseTokenModel extends BaseModel
          * @type {boolean}
          * @public
          */
-        this.deleted = undefined;
+        this.deleted = false;
         
         /**
          * When the Firebase Token was last updated
@@ -86,7 +86,7 @@ class FirebaseTokenModel extends BaseModel
          * @type {Date}
          * @public
          */
-        this.updateTimestamp = undefined;
+        this.updateTimestamp = new Date();
     }
 
     /**

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

@@ -31,7 +31,7 @@ class BinTipBinModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.id = undefined;
+        this.id = "";
         
         /**
          * The Bin Tip ID associated with this Bin
@@ -39,7 +39,7 @@ class BinTipBinModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.binTipId = undefined;
+        this.binTipId = "";
         
         /**
          * The Packrun ID associated with this Bin
@@ -47,7 +47,7 @@ class BinTipBinModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.packrunId = undefined;
+        this.packrunId = "";
         
         /**
          * When this Bin was Created
@@ -55,7 +55,7 @@ class BinTipBinModel extends BaseModel
          * @type {Date}
          * @public
          */
-        this.createdTimestamp = undefined;
+        this.createdTimestamp = new Date();
         
         /**
          * A 10-Digit Bin Number made up of a Bin Lot (4-Digits) and a Unique Number (6-Digits)
@@ -63,7 +63,7 @@ class BinTipBinModel extends BaseModel
          * @type {?string}
          * @public
          */
-        this.binNumber = undefined;
+        this.binNumber = null;
         
         /**
          * The Time Batch ID associated with this Bin
@@ -71,7 +71,7 @@ class BinTipBinModel extends BaseModel
          * @type {?string}
          * @public
          */
-        this.timeBatchId = undefined;
+        this.timeBatchId = null;
         
         /**
          * The Full Weight for this Bin
@@ -79,7 +79,7 @@ class BinTipBinModel extends BaseModel
          * @type {?number}
          * @public
          */
-        this.fullWeight = undefined;
+        this.fullWeight = null;
         
         /**
          * The Empty Weight for this Bin
@@ -87,7 +87,7 @@ class BinTipBinModel extends BaseModel
          * @type {?number}
          * @public
          */
-        this.emptyWeight = undefined;
+        this.emptyWeight = null;
         
         /**
          * The `BinTipWeight` ID as the Source for the Full Weight of this Bin
@@ -95,7 +95,7 @@ class BinTipBinModel extends BaseModel
          * @type {?string}
          * @public
          */
-        this.fullBinWeightId = undefined;
+        this.fullBinWeightId = null;
         
         /**
          * The `BinTipWeight` ID as the Source for the Empty Weight of this Bin
@@ -103,7 +103,7 @@ class BinTipBinModel extends BaseModel
          * @type {?string}
          * @public
          */
-        this.emptyBinWeightId = undefined;
+        this.emptyBinWeightId = null;
         
         /**
          * The FreshPack Field Bin Weight API Data
@@ -111,7 +111,7 @@ class BinTipBinModel extends BaseModel
          * @type {?Object}
          * @public
          */
-        this.freshPackFieldBinWeightApi = undefined;
+        this.freshPackFieldBinWeightApi = null;
         
         /**
          * Whether the Bin Tip Bin has been deleted
@@ -119,7 +119,7 @@ class BinTipBinModel extends BaseModel
          * @type {boolean}
          * @public
          */
-        this.deleted = undefined;
+        this.deleted = false;
         
         /**
          * When the Bin Tip Bin was last updated
@@ -127,7 +127,7 @@ class BinTipBinModel extends BaseModel
          * @type {Date}
          * @public
          */
-        this.updateTimestamp = undefined;
+        this.updateTimestamp = new Date();
         
         /**
          * The Site ID associated with this Bin Tip Bin

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

@@ -31,7 +31,7 @@ class BinTipWeightModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.id = undefined;
+        this.id = "";
         
         /**
          * The Bin Tip ID associated with this Bin Weight
@@ -39,7 +39,7 @@ class BinTipWeightModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.binTipId = undefined;
+        this.binTipId = "";
         
         /**
          * The Packrun ID associated with this Bin Weight
@@ -47,7 +47,7 @@ class BinTipWeightModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.packrunId = undefined;
+        this.packrunId = "";
         
         /**
          * When this Bin Weight was Created
@@ -55,7 +55,7 @@ class BinTipWeightModel extends BaseModel
          * @type {Date}
          * @public
          */
-        this.createdTimestamp = undefined;
+        this.createdTimestamp = new Date();
         
         /**
          * The Bin Weight Type
@@ -63,7 +63,7 @@ class BinTipWeightModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.weightType = undefined;
+        this.weightType = "";
         
         /**
          * The Bin Weight
@@ -71,7 +71,7 @@ class BinTipWeightModel extends BaseModel
          * @type {number}
          * @public
          */
-        this.weight = undefined;
+        this.weight = 0;
         
         /**
          * The Bin Scale ID associated with this Bin Weight
@@ -79,7 +79,7 @@ class BinTipWeightModel extends BaseModel
          * @type {?string}
          * @public
          */
-        this.binScaleId = undefined;
+        this.binScaleId = null;
         
         /**
          * Whether the Bin Tip Weight has been deleted
@@ -87,7 +87,7 @@ class BinTipWeightModel extends BaseModel
          * @type {boolean}
          * @public
          */
-        this.deleted = undefined;
+        this.deleted = false;
         
         /**
          * When the Bin Tip Weight was last updated
@@ -95,7 +95,7 @@ class BinTipWeightModel extends BaseModel
          * @type {Date}
          * @public
          */
-        this.updateTimestamp = undefined;
+        this.updateTimestamp = new Date();
         
         /**
          * The Site ID associated with this Bin Tip Weight

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

@@ -31,7 +31,7 @@ class CompacSizerBatchModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.id = undefined;
+        this.id = "";
         
         /**
          * The Compac Sizer ID this Batch is associated with
@@ -39,7 +39,7 @@ class CompacSizerBatchModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.compacSizerId = undefined;
+        this.compacSizerId = "";
         
         /**
          * The Numeric Compac Batch ID
@@ -47,7 +47,7 @@ class CompacSizerBatchModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.batchId = undefined;
+        this.batchId = "";
         
         /**
          * When this Batch was Created
@@ -55,7 +55,7 @@ class CompacSizerBatchModel extends BaseModel
          * @type {Date}
          * @public
          */
-        this.createdTimestamp = undefined;
+        this.createdTimestamp = new Date();
         
         /**
          * The Packrun ID associated with this Batch
@@ -63,7 +63,7 @@ class CompacSizerBatchModel extends BaseModel
          * @type {?string}
          * @public
          */
-        this.packrunId = undefined;
+        this.packrunId = null;
         
         /**
          * The Compac Sizer Batch Data
@@ -71,7 +71,7 @@ class CompacSizerBatchModel extends BaseModel
          * @type {Object}
          * @public
          */
-        this.batch = undefined;
+        this.batch = {}
         
         /**
          * Whether the Compac Sizer Batch has been deleted
@@ -79,7 +79,7 @@ class CompacSizerBatchModel extends BaseModel
          * @type {boolean}
          * @public
          */
-        this.deleted = undefined;
+        this.deleted = false;
         
         /**
          * When the Compac Sizer Batch was last updated
@@ -87,7 +87,7 @@ class CompacSizerBatchModel extends BaseModel
          * @type {Date}
          * @public
          */
-        this.updateTimestamp = undefined;
+        this.updateTimestamp = new Date();
         
         /**
          * The Site ID associated with this Compac Sizer Batch

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

@@ -31,7 +31,7 @@ class CompacSizerModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.id = undefined;
+        this.id = "";
         
         /**
          * The RTU this Compac Sizer belongs to
@@ -39,7 +39,7 @@ class CompacSizerModel extends BaseModel
          * @type {?number}
          * @public
          */
-        this.rtuId = undefined;
+        this.rtuId = null;
         
         /**
          * The Compac Sizer Name
@@ -47,7 +47,7 @@ class CompacSizerModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.name = undefined;
+        this.name = "";
         
         /**
          * The Lanes defined for this Compac Sizer
@@ -55,7 +55,7 @@ class CompacSizerModel extends BaseModel
          * @type {Object[]}
          * @public
          */
-        this.lanes = undefined;
+        this.lanes = [];
         
         /**
          * The Points used by this Compac Sizer
@@ -63,7 +63,7 @@ class CompacSizerModel extends BaseModel
          * @type {Object}
          * @public
          */
-        this.points = undefined;
+        this.points = {}
         
         /**
          * The Outlets defined for this Compac Sizer
@@ -71,7 +71,7 @@ class CompacSizerModel extends BaseModel
          * @type {Object[]}
          * @public
          */
-        this.outlets = undefined;
+        this.outlets = [];
         
         /**
          * The Sizer Type
@@ -79,7 +79,7 @@ class CompacSizerModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.sizerType = undefined;
+        this.sizerType = "";
         
         /**
          * The Auto Create Batch Delay in Seconds for this Compac Sizer
@@ -87,7 +87,7 @@ class CompacSizerModel extends BaseModel
          * @type {number}
          * @public
          */
-        this.autoCreateBatchDelay = undefined;
+        this.autoCreateBatchDelay = 0;
         
         /**
          * The Fruit Sizes defined and handled by this Compac Sizer
@@ -95,7 +95,7 @@ class CompacSizerModel extends BaseModel
          * @type {Object[]}
          * @public
          */
-        this.fruitSizes = undefined;
+        this.fruitSizes = [];
         
         /**
          * The Packing Line ID that manages this Compac Sizer
@@ -103,7 +103,7 @@ class CompacSizerModel extends BaseModel
          * @type {string}
          * @public
          */
-        this.packingLineId = undefined;
+        this.packingLineId = "";
         
         /**
          * The FreshPack Integration Configuration for this Compac Sizer
@@ -111,7 +111,7 @@ class CompacSizerModel extends BaseModel
          * @type {?Object}
          * @public
          */
-        this.freshPackIntegration = undefined;
+        this.freshPackIntegration = null;
         
         /**
          * An Array of Sources that deliver Fruit to this Compac Sizer
@@ -119,7 +119,7 @@ class CompacSizerModel extends BaseModel
          * @type {Object[]}
          * @public
          */
-        this.sources = undefined;
+        this.sources = [];
         
         /**
          * Whether the Compac Sizer has been deleted
@@ -127,7 +127,7 @@ class CompacSizerModel extends BaseModel
          * @type {boolean}
          * @public
          */
-        this.deleted = undefined;
+        this.deleted = false;
         
         /**
          * When the Compac Sizer was last updated
@@ -135,7 +135,7 @@ class CompacSizerModel extends BaseModel
          * @type {Date}
          * @public
          */
-        this.updateTimestamp = undefined;
+        this.updateTimestamp = new Date();
         
         /**
          * The Site ID associated with this Compac Sizer