@ricado/api-client 2.3.28 → 2.4.0

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

@@ -0,0 +1,198 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _RequestHelper = _interopRequireDefault(require("../../../RequestHelper"));
+
+var _DehydratorModel = _interopRequireDefault(require("../../../Models/Lab/Site/DehydratorModel"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
+
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+
+/**
+ * Controller Class for Dehydrators
+ * 
+ * @class
+ */
+var DehydratorController = /*#__PURE__*/function () {
+  function DehydratorController() {
+    _classCallCheck(this, DehydratorController);
+  }
+
+  _createClass(DehydratorController, null, [{
+    key: "getOne",
+    value:
+    /**
+     * 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>}
+     */
+    function getOne(siteId, id) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.getRequest("/lab/sites/".concat(siteId, "/dehydrators/").concat(id)).then(function (result) {
+          var resolveValue = function () {
+            return _DehydratorModel.default.fromJSON(result, siteId);
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return 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>}
+     */
+
+  }, {
+    key: "update",
+    value: function update(siteId, id, updateData) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.patchRequest("/lab/sites/".concat(siteId, "/dehydrators/").concat(id), updateData).then(function (result) {
+          var resolveValue = function () {
+            return _DehydratorModel.default.fromJSON(result, siteId);
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return 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>}
+     */
+
+  }, {
+    key: "delete",
+    value: function _delete(siteId, id) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.deleteRequest("/lab/sites/".concat(siteId, "/dehydrators/").concat(id)).then(function (result) {
+          resolve(result !== null && result !== void 0 ? result : true);
+        }).catch(function (error) {
+          return 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[]>}
+     */
+
+  }, {
+    key: "getAll",
+    value: function getAll(siteId) {
+      var queryParameters = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.getRequest("/lab/sites/".concat(siteId, "/dehydrators"), queryParameters).then(function (result) {
+          var resolveValue = function () {
+            if (Array.isArray(result) !== true) {
+              return [];
+            }
+
+            return result.map(function (resultItem) {
+              return function () {
+                return _DehydratorModel.default.fromJSON(resultItem, siteId);
+              }();
+            });
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return 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>}
+     */
+
+  }, {
+    key: "create",
+    value: function create(siteId, createData) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.postRequest("/lab/sites/".concat(siteId, "/dehydrators"), createData).then(function (result) {
+          var resolveValue = function () {
+            return _DehydratorModel.default.fromJSON(result, siteId);
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+  }]);
+
+  return DehydratorController;
+}();
+
+var _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
+ */
+
+exports.default = _default;

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

@@ -0,0 +1,204 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _RequestHelper = _interopRequireDefault(require("../../../RequestHelper"));
+
+var _FruitProfileModel = _interopRequireDefault(require("../../../Models/Lab/Site/FruitProfileModel"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
+
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+
+/**
+ * Controller Class for Fruit Profiles
+ * 
+ * @class
+ */
+var FruitProfileController = /*#__PURE__*/function () {
+  function FruitProfileController() {
+    _classCallCheck(this, FruitProfileController);
+  }
+
+  _createClass(FruitProfileController, null, [{
+    key: "getOne",
+    value:
+    /**
+     * 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>}
+     */
+    function getOne(siteId, id) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.getRequest("/lab/sites/".concat(siteId, "/fruit-profiles/").concat(id)).then(function (result) {
+          var resolveValue = function () {
+            return _FruitProfileModel.default.fromJSON(result, siteId);
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return 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>}
+     */
+
+  }, {
+    key: "update",
+    value: function update(siteId, id, updateData) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.patchRequest("/lab/sites/".concat(siteId, "/fruit-profiles/").concat(id), updateData).then(function (result) {
+          var resolveValue = function () {
+            return _FruitProfileModel.default.fromJSON(result, siteId);
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return 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>}
+     */
+
+  }, {
+    key: "delete",
+    value: function _delete(siteId, id) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.deleteRequest("/lab/sites/".concat(siteId, "/fruit-profiles/").concat(id)).then(function (result) {
+          resolve(result !== null && result !== void 0 ? result : true);
+        }).catch(function (error) {
+          return 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[]>}
+     */
+
+  }, {
+    key: "getAll",
+    value: function getAll(siteId) {
+      var queryParameters = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.getRequest("/lab/sites/".concat(siteId, "/fruit-profiles"), queryParameters).then(function (result) {
+          var resolveValue = function () {
+            if (Array.isArray(result) !== true) {
+              return [];
+            }
+
+            return result.map(function (resultItem) {
+              return function () {
+                return _FruitProfileModel.default.fromJSON(resultItem, siteId);
+              }();
+            });
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return 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>}
+     */
+
+  }, {
+    key: "create",
+    value: function create(siteId, createData) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.postRequest("/lab/sites/".concat(siteId, "/fruit-profiles"), createData).then(function (result) {
+          var resolveValue = function () {
+            return _FruitProfileModel.default.fromJSON(result, siteId);
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+  }]);
+
+  return FruitProfileController;
+}();
+
+var _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
+ */
+
+exports.default = _default;

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

@@ -0,0 +1,222 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _RequestHelper = _interopRequireDefault(require("../../../RequestHelper"));
+
+var _LabModel = _interopRequireDefault(require("../../../Models/Lab/Site/LabModel"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
+
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+
+/**
+ * Controller Class for Labs
+ * 
+ * @class
+ */
+var LabController = /*#__PURE__*/function () {
+  function LabController() {
+    _classCallCheck(this, LabController);
+  }
+
+  _createClass(LabController, null, [{
+    key: "getOne",
+    value:
+    /**
+     * 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>}
+     */
+    function getOne(siteId, id) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.getRequest("/lab/sites/".concat(siteId, "/labs/").concat(id)).then(function (result) {
+          var resolveValue = function () {
+            return _LabModel.default.fromJSON(result, siteId);
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return 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>}
+     */
+
+  }, {
+    key: "update",
+    value: function update(siteId, id, updateData) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.patchRequest("/lab/sites/".concat(siteId, "/labs/").concat(id), updateData).then(function (result) {
+          var resolveValue = function () {
+            return _LabModel.default.fromJSON(result, siteId);
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return 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>}
+     */
+
+  }, {
+    key: "delete",
+    value: function _delete(siteId, id) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.deleteRequest("/lab/sites/".concat(siteId, "/labs/").concat(id)).then(function (result) {
+          resolve(result !== null && result !== void 0 ? result : true);
+        }).catch(function (error) {
+          return 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[]>}
+     */
+
+  }, {
+    key: "getAll",
+    value: function getAll(siteId) {
+      var queryParameters = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.getRequest("/lab/sites/".concat(siteId, "/labs"), queryParameters).then(function (result) {
+          var resolveValue = function () {
+            if (Array.isArray(result) !== true) {
+              return [];
+            }
+
+            return result.map(function (resultItem) {
+              return function () {
+                return _LabModel.default.fromJSON(resultItem, siteId);
+              }();
+            });
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return 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>}
+     */
+
+  }, {
+    key: "create",
+    value: function create(siteId, createData) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.postRequest("/lab/sites/".concat(siteId, "/labs"), createData).then(function (result) {
+          var resolveValue = function () {
+            return _LabModel.default.fromJSON(result, siteId);
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+  }]);
+
+  return LabController;
+}();
+
+var _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
+ */
+
+exports.default = _default;