@ricado/api-client 2.3.27 → 2.4.0

package/package.json

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

package/src/Controllers/Lab/Site/DehydratorController.js

@@ -0,0 +1,175 @@
+/**
+ * File Auto-Generated by the RICADO Gen 4 PHP API Project
+ * 
+ * Do Not Edit this File Manually!
+ */
+
+import RequestHelper from '../../../RequestHelper';
+import DehydratorModel from '../../../Models/Lab/Site/DehydratorModel';
+
+/**
+ * Controller Class for Dehydrators
+ * 
+ * @class
+ */
+class DehydratorController
+{
+    /**
+     * Retrieve a Dehydrator [GET /lab/sites/{siteId}/dehydrators/{id}]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Dehydrator ID
+     * @return {Promise<DehydratorModel>}
+     */
+    static getOne(siteId, id)
+    {
+        return new Promise((resolve, reject) => {
+            RequestHelper.getRequest(`/lab/sites/${siteId}/dehydrators/${id}`)
+            .then((result) => {
+                let resolveValue = (function(){
+                    return DehydratorModel.fromJSON(result, siteId);
+                }());
+                
+                resolve(resolveValue);
+            })
+            .catch(error => reject(error));
+        });
+    }
+
+    /**
+     * Update a Dehydrator [PATCH /lab/sites/{siteId}/dehydrators/{id}]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Dehydrator ID
+     * @param {DehydratorController.UpdateData} updateData The Dehydrator Update Data
+     * @return {Promise<DehydratorModel>}
+     */
+    static update(siteId, id, updateData)
+    {
+        return new Promise((resolve, reject) => {
+            RequestHelper.patchRequest(`/lab/sites/${siteId}/dehydrators/${id}`, updateData)
+            .then((result) => {
+                let resolveValue = (function(){
+                    return DehydratorModel.fromJSON(result, siteId);
+                }());
+                
+                resolve(resolveValue);
+            })
+            .catch(error => reject(error));
+        });
+    }
+
+    /**
+     * Delete a Dehydrator [DELETE /lab/sites/{siteId}/dehydrators/{id}]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Dehydrator ID
+     * @return {Promise<boolean>}
+     */
+    static delete(siteId, id)
+    {
+        return new Promise((resolve, reject) => {
+            RequestHelper.deleteRequest(`/lab/sites/${siteId}/dehydrators/${id}`)
+            .then((result) => {
+                resolve(result ?? true);
+            })
+            .catch(error => reject(error));
+        });
+    }
+
+    /**
+     * List all Dehydrators [GET /lab/sites/{siteId}/dehydrators]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {DehydratorController.GetAllQueryParameters} [queryParameters] The Optional Query Parameters
+     * @return {Promise<DehydratorModel[]>}
+     */
+    static getAll(siteId, queryParameters = {})
+    {
+        return new Promise((resolve, reject) => {
+            RequestHelper.getRequest(`/lab/sites/${siteId}/dehydrators`, queryParameters)
+            .then((result) => {
+                let resolveValue = (function(){
+                    if(Array.isArray(result) !== true)
+                    {
+                        return [];
+                    }
+                
+                    return result.map((resultItem) => {
+                        return (function(){
+                            return DehydratorModel.fromJSON(resultItem, siteId);
+                        }());
+                    });
+                }());
+                
+                resolve(resolveValue);
+            })
+            .catch(error => reject(error));
+        });
+    }
+
+    /**
+     * Create a Dehydrator [POST /lab/sites/{siteId}/dehydrators]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {DehydratorController.CreateData} createData The Dehydrator Create Data
+     * @return {Promise<DehydratorModel>}
+     */
+    static create(siteId, createData)
+    {
+        return new Promise((resolve, reject) => {
+            RequestHelper.postRequest(`/lab/sites/${siteId}/dehydrators`, createData)
+            .then((result) => {
+                let resolveValue = (function(){
+                    return DehydratorModel.fromJSON(result, siteId);
+                }());
+                
+                resolve(resolveValue);
+            })
+            .catch(error => reject(error));
+        });
+    }
+}
+
+export default DehydratorController;
+
+/**
+ * The Optional Query Parameters for the getAll Function
+ * 
+ * @typedef {Object} DehydratorController.GetAllQueryParameters
+ * @property {?number} [rtuId] The RTU this Dehydrator belongs to
+ * @property {string} [name] The Name of this Dehydrator
+ * @property {string} [labId] The Lab that owns this Dehydrator
+ * @memberof Controllers.Lab.Site
+ */
+
+/**
+ * The Create Data for a Dehydrator
+ * 
+ * @typedef {Object} DehydratorController.CreateData
+ * @property {?number} [rtuId] The RTU this Dehydrator belongs to
+ * @property {string} name The Name of this Dehydrator
+ * @property {{rackPositionId: number}} points The Points used by this Dehydrator
+ * @property {string} labId The Lab that owns this Dehydrator
+ * @memberof Controllers.Lab.Site
+ */
+
+/**
+ * The Update Data for a Dehydrator
+ * 
+ * @typedef {Object} DehydratorController.UpdateData
+ * @property {string} [name] The Name of this Dehydrator
+ * @property {{rackPositionId: number}} [points] The Points used by this Dehydrator
+ * @property {string} [labId] The Lab that owns this Dehydrator
+ * @memberof Controllers.Lab.Site
+ */

package/src/Controllers/Lab/Site/FruitProfileController.js

@@ -0,0 +1,181 @@
+/**
+ * File Auto-Generated by the RICADO Gen 4 PHP API Project
+ * 
+ * Do Not Edit this File Manually!
+ */
+
+import RequestHelper from '../../../RequestHelper';
+import FruitProfileModel from '../../../Models/Lab/Site/FruitProfileModel';
+
+/**
+ * Controller Class for Fruit Profiles
+ * 
+ * @class
+ */
+class FruitProfileController
+{
+    /**
+     * Retrieve a Fruit Profile [GET /lab/sites/{siteId}/fruit-profiles/{id}]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Fruit Profile ID
+     * @return {Promise<FruitProfileModel>}
+     */
+    static getOne(siteId, id)
+    {
+        return new Promise((resolve, reject) => {
+            RequestHelper.getRequest(`/lab/sites/${siteId}/fruit-profiles/${id}`)
+            .then((result) => {
+                let resolveValue = (function(){
+                    return FruitProfileModel.fromJSON(result, siteId);
+                }());
+                
+                resolve(resolveValue);
+            })
+            .catch(error => reject(error));
+        });
+    }
+
+    /**
+     * Update a Fruit Profile [PATCH /lab/sites/{siteId}/fruit-profiles/{id}]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Fruit Profile ID
+     * @param {FruitProfileController.UpdateData} updateData The Fruit Profile Update Data
+     * @return {Promise<FruitProfileModel>}
+     */
+    static update(siteId, id, updateData)
+    {
+        return new Promise((resolve, reject) => {
+            RequestHelper.patchRequest(`/lab/sites/${siteId}/fruit-profiles/${id}`, updateData)
+            .then((result) => {
+                let resolveValue = (function(){
+                    return FruitProfileModel.fromJSON(result, siteId);
+                }());
+                
+                resolve(resolveValue);
+            })
+            .catch(error => reject(error));
+        });
+    }
+
+    /**
+     * Delete a Fruit Profile [DELETE /lab/sites/{siteId}/fruit-profiles/{id}]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Fruit Profile ID
+     * @return {Promise<boolean>}
+     */
+    static delete(siteId, id)
+    {
+        return new Promise((resolve, reject) => {
+            RequestHelper.deleteRequest(`/lab/sites/${siteId}/fruit-profiles/${id}`)
+            .then((result) => {
+                resolve(result ?? true);
+            })
+            .catch(error => reject(error));
+        });
+    }
+
+    /**
+     * List all Fruit Profiles [GET /lab/sites/{siteId}/fruit-profiles]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {FruitProfileController.GetAllQueryParameters} [queryParameters] The Optional Query Parameters
+     * @return {Promise<FruitProfileModel[]>}
+     */
+    static getAll(siteId, queryParameters = {})
+    {
+        return new Promise((resolve, reject) => {
+            RequestHelper.getRequest(`/lab/sites/${siteId}/fruit-profiles`, queryParameters)
+            .then((result) => {
+                let resolveValue = (function(){
+                    if(Array.isArray(result) !== true)
+                    {
+                        return [];
+                    }
+                
+                    return result.map((resultItem) => {
+                        return (function(){
+                            return FruitProfileModel.fromJSON(resultItem, siteId);
+                        }());
+                    });
+                }());
+                
+                resolve(resolveValue);
+            })
+            .catch(error => reject(error));
+        });
+    }
+
+    /**
+     * Create a Fruit Profile [POST /lab/sites/{siteId}/fruit-profiles]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {FruitProfileController.CreateData} createData The Fruit Profile Create Data
+     * @return {Promise<FruitProfileModel>}
+     */
+    static create(siteId, createData)
+    {
+        return new Promise((resolve, reject) => {
+            RequestHelper.postRequest(`/lab/sites/${siteId}/fruit-profiles`, createData)
+            .then((result) => {
+                let resolveValue = (function(){
+                    return FruitProfileModel.fromJSON(result, siteId);
+                }());
+                
+                resolve(resolveValue);
+            })
+            .catch(error => reject(error));
+        });
+    }
+}
+
+export default FruitProfileController;
+
+/**
+ * The Optional Query Parameters for the getAll Function
+ * 
+ * @typedef {Object} FruitProfileController.GetAllQueryParameters
+ * @property {string} [name] The Fruit Profile Name
+ * @memberof Controllers.Lab.Site
+ */
+
+/**
+ * The Create Data for a Fruit Profile
+ * 
+ * @typedef {Object} FruitProfileController.CreateData
+ * @property {string} [name] The Fruit Profile Name
+ * @property {string} description The Fruit Profile Description
+ * @property {string} image The Fruit Profile Image Source
+ * @property {number} nominalWarmUpDuration The Typical Warm Up Duration (in seconds) for a Sample to reach the Minimum Target Temperature
+ * @property {number} minimumWithinTargetDuration The Minimum Duration (in seconds) that a Sample should be within the Min and Max Target Temperatures be Successful
+ * @property {number} maximumTotalDuration The Maximum Duration (in seconds) that a Sample should be Dehydrated for before it Fails
+ * @property {number} minimumTargetTemperature The Minimum Target Temperature for a Sample to be Successful
+ * @property {number} maximumTargetTemperature The Maximum Target Temperature for a Sample to be Successful
+ * @memberof Controllers.Lab.Site
+ */
+
+/**
+ * The Update Data for a Fruit Profile
+ * 
+ * @typedef {Object} FruitProfileController.UpdateData
+ * @property {string} [description] The Fruit Profile Description
+ * @property {string} [image] The Fruit Profile Image Source
+ * @property {number} [nominalWarmUpDuration] The Typical Warm Up Duration (in seconds) for a Sample to reach the Minimum Target Temperature
+ * @property {number} [minimumWithinTargetDuration] The Minimum Duration (in seconds) that a Sample should be within the Min and Max Target Temperatures be Successful
+ * @property {number} [maximumTotalDuration] The Maximum Duration (in seconds) that a Sample should be Dehydrated for before it Fails
+ * @property {number} [minimumTargetTemperature] The Minimum Target Temperature for a Sample to be Successful
+ * @property {number} [maximumTargetTemperature] The Maximum Target Temperature for a Sample to be Successful
+ * @memberof Controllers.Lab.Site
+ */

package/src/Controllers/Lab/Site/LabController.js

@@ -0,0 +1,199 @@
+/**
+ * File Auto-Generated by the RICADO Gen 4 PHP API Project
+ * 
+ * Do Not Edit this File Manually!
+ */
+
+import RequestHelper from '../../../RequestHelper';
+import LabModel from '../../../Models/Lab/Site/LabModel';
+
+/**
+ * Controller Class for Labs
+ * 
+ * @class
+ */
+class LabController
+{
+    /**
+     * Retrieve a Lab [GET /lab/sites/{siteId}/labs/{id}]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Lab ID
+     * @return {Promise<LabModel>}
+     */
+    static getOne(siteId, id)
+    {
+        return new Promise((resolve, reject) => {
+            RequestHelper.getRequest(`/lab/sites/${siteId}/labs/${id}`)
+            .then((result) => {
+                let resolveValue = (function(){
+                    return LabModel.fromJSON(result, siteId);
+                }());
+                
+                resolve(resolveValue);
+            })
+            .catch(error => reject(error));
+        });
+    }
+
+    /**
+     * Update a Lab [PATCH /lab/sites/{siteId}/labs/{id}]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Lab ID
+     * @param {LabController.UpdateData} updateData The Lab Update Data
+     * @return {Promise<LabModel>}
+     */
+    static update(siteId, id, updateData)
+    {
+        return new Promise((resolve, reject) => {
+            RequestHelper.patchRequest(`/lab/sites/${siteId}/labs/${id}`, updateData)
+            .then((result) => {
+                let resolveValue = (function(){
+                    return LabModel.fromJSON(result, siteId);
+                }());
+                
+                resolve(resolveValue);
+            })
+            .catch(error => reject(error));
+        });
+    }
+
+    /**
+     * Delete a Lab [DELETE /lab/sites/{siteId}/labs/{id}]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Lab ID
+     * @return {Promise<boolean>}
+     */
+    static delete(siteId, id)
+    {
+        return new Promise((resolve, reject) => {
+            RequestHelper.deleteRequest(`/lab/sites/${siteId}/labs/${id}`)
+            .then((result) => {
+                resolve(result ?? true);
+            })
+            .catch(error => reject(error));
+        });
+    }
+
+    /**
+     * List all Labs [GET /lab/sites/{siteId}/labs]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {LabController.GetAllQueryParameters} [queryParameters] The Optional Query Parameters
+     * @return {Promise<LabModel[]>}
+     */
+    static getAll(siteId, queryParameters = {})
+    {
+        return new Promise((resolve, reject) => {
+            RequestHelper.getRequest(`/lab/sites/${siteId}/labs`, queryParameters)
+            .then((result) => {
+                let resolveValue = (function(){
+                    if(Array.isArray(result) !== true)
+                    {
+                        return [];
+                    }
+                
+                    return result.map((resultItem) => {
+                        return (function(){
+                            return LabModel.fromJSON(resultItem, siteId);
+                        }());
+                    });
+                }());
+                
+                resolve(resolveValue);
+            })
+            .catch(error => reject(error));
+        });
+    }
+
+    /**
+     * Create a Lab [POST /lab/sites/{siteId}/labs]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {LabController.CreateData} createData The Lab Create Data
+     * @return {Promise<LabModel>}
+     */
+    static create(siteId, createData)
+    {
+        return new Promise((resolve, reject) => {
+            RequestHelper.postRequest(`/lab/sites/${siteId}/labs`, createData)
+            .then((result) => {
+                let resolveValue = (function(){
+                    return LabModel.fromJSON(result, siteId);
+                }());
+                
+                resolve(resolveValue);
+            })
+            .catch(error => reject(error));
+        });
+    }
+}
+
+export default LabController;
+
+/**
+ * The Optional Query Parameters for the getAll Function
+ * 
+ * @typedef {Object} LabController.GetAllQueryParameters
+ * @property {?number} [rtuId] The RTU this Lab belongs to
+ * @property {string} [name] The Lab Name
+ * @memberof Controllers.Lab.Site
+ */
+
+/**
+ * The Create Data for a Lab
+ * 
+ * @typedef {Object} LabController.CreateData
+ * @property {?number} [rtuId] The RTU this Lab belongs to
+ * @property {string} name The Lab Name
+ * @property {string} [shortName] A Short Name for the Lab Name. Typically used in Reports and Tables showing multiple Labs
+ * @property {Object} points The Points used by this Lab
+ * @property {Array<LabController.RackReference>} [racks] The Rack Objects that belong to this Lab
+ * @property {string[]} [alarmGroups] The Alarm Groups that are used by this Lab
+ * @property {?LabController.InspectIntegration} [inspectIntegration] The Inspect Integration Configuration for this Lab
+ * @memberof Controllers.Lab.Site
+ */
+
+/**
+ * The Update Data for a Lab
+ * 
+ * @typedef {Object} LabController.UpdateData
+ * @property {string} [name] The Lab Name
+ * @property {string} [shortName] A Short Name for the Lab Name. Typically used in Reports and Tables showing multiple Labs
+ * @property {Object} [points] The Points used by this Lab
+ * @property {Array<LabController.RackReference>} [racks] The Rack Objects that belong to this Lab
+ * @property {string[]} [alarmGroups] The Alarm Groups that are used by this Lab
+ * @property {?LabController.InspectIntegration} [inspectIntegration] The Inspect Integration Configuration for this Lab
+ * @memberof Controllers.Lab.Site
+ */
+
+/**
+ * A **RackReference** Type
+ * 
+ * @typedef {Object} LabController.RackReference
+ * @property {string} id ID of a Rack Object
+ * @property {number} displayOrder Display Order of the Rack
+ * @memberof Controllers.Lab.Site
+ */
+
+/**
+ * A **InspectIntegration** Type
+ * 
+ * @typedef {Object} LabController.InspectIntegration
+ * @property {Object} points The Points used for this Inspect Integration
+ * @property {boolean} enabled Whether the Inspect Integration is Enabled on this Lab
+ * @property {string} apiBaseUrl Base URL of the Inspect API
+ * @memberof Controllers.Lab.Site
+ */