@ricado/api-client 2.3.27 → 2.4.0

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

@@ -0,0 +1,222 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _RequestHelper = _interopRequireDefault(require("../../../RequestHelper"));
+
+var _RackModel = _interopRequireDefault(require("../../../Models/Lab/Site/RackModel"));
+
+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 Racks
+ * 
+ * @class
+ */
+var RackController = /*#__PURE__*/function () {
+  function RackController() {
+    _classCallCheck(this, RackController);
+  }
+
+  _createClass(RackController, null, [{
+    key: "getOne",
+    value:
+    /**
+     * Retrieve a Rack [GET /lab/sites/{siteId}/racks/{id}]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Rack ID
+     * @return {Promise<RackModel>}
+     */
+    function getOne(siteId, id) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.getRequest("/lab/sites/".concat(siteId, "/racks/").concat(id)).then(function (result) {
+          var resolveValue = function () {
+            return _RackModel.default.fromJSON(result, siteId);
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+    /**
+     * Update a Rack [PATCH /lab/sites/{siteId}/racks/{id}]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Rack ID
+     * @param {RackController.UpdateData} updateData The Rack Update Data
+     * @return {Promise<RackModel>}
+     */
+
+  }, {
+    key: "update",
+    value: function update(siteId, id, updateData) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.patchRequest("/lab/sites/".concat(siteId, "/racks/").concat(id), updateData).then(function (result) {
+          var resolveValue = function () {
+            return _RackModel.default.fromJSON(result, siteId);
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+    /**
+     * Delete a Rack [DELETE /lab/sites/{siteId}/racks/{id}]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Rack ID
+     * @return {Promise<boolean>}
+     */
+
+  }, {
+    key: "delete",
+    value: function _delete(siteId, id) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.deleteRequest("/lab/sites/".concat(siteId, "/racks/").concat(id)).then(function (result) {
+          resolve(result !== null && result !== void 0 ? result : true);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+    /**
+     * List all Racks [GET /lab/sites/{siteId}/racks]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {RackController.GetAllQueryParameters} [queryParameters] The Optional Query Parameters
+     * @return {Promise<RackModel[]>}
+     */
+
+  }, {
+    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, "/racks"), queryParameters).then(function (result) {
+          var resolveValue = function () {
+            if (Array.isArray(result) !== true) {
+              return [];
+            }
+
+            return result.map(function (resultItem) {
+              return function () {
+                return _RackModel.default.fromJSON(resultItem, siteId);
+              }();
+            });
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+    /**
+     * Create a Rack [POST /lab/sites/{siteId}/racks]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {RackController.CreateData} createData The Rack Create Data
+     * @return {Promise<RackModel>}
+     */
+
+  }, {
+    key: "create",
+    value: function create(siteId, createData) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.postRequest("/lab/sites/".concat(siteId, "/racks"), createData).then(function (result) {
+          var resolveValue = function () {
+            return _RackModel.default.fromJSON(result, siteId);
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+  }]);
+
+  return RackController;
+}();
+
+var _default = RackController;
+/**
+ * The Optional Query Parameters for the getAll Function
+ * 
+ * @typedef {Object} RackController.GetAllQueryParameters
+ * @property {?number} [rtuId] The RTU this Rack belongs to
+ * @property {string} [name] The Name of this Rack
+ * @property {string} [labId] The Lab that owns this Rack
+ * @memberof Controllers.Lab.Site
+ */
+
+/**
+ * The Create Data for a Rack
+ * 
+ * @typedef {Object} RackController.CreateData
+ * @property {?number} [rtuId] The RTU this Rack belongs to
+ * @property {string} name The Name of this Rack
+ * @property {{disabled: number}} points The Points used by this Rack
+ * @property {string} labId The Lab that owns this Rack
+ * @property {Array<RackController.VerticalLevel>} [verticalLevels] The Vertical Levels Defined for this Rack
+ * @property {boolean} [invertVerticalLevels] Whether the Vertical Levels for this Rack should be Inverted. By Default, Vertical Levels go from the Lowest Level upwards
+ * @property {Array<RackController.HorizontalPosition>} [horizontalPositions] The Horizontal Positions defined for this Rack
+ * @property {boolean} [invertHorizontalPositions] Whether the Horizontal Positions for this Rack should be Inverted. By Default, Horizontal Positions go from Left to Right
+ * @memberof Controllers.Lab.Site
+ */
+
+/**
+ * The Update Data for a Rack
+ * 
+ * @typedef {Object} RackController.UpdateData
+ * @property {string} [name] The Name of this Rack
+ * @property {{disabled: number}} [points] The Points used by this Rack
+ * @property {string} [labId] The Lab that owns this Rack
+ * @property {Array<RackController.VerticalLevel>} [verticalLevels] The Vertical Levels Defined for this Rack
+ * @property {boolean} [invertVerticalLevels] Whether the Vertical Levels for this Rack should be Inverted. By Default, Vertical Levels go from the Lowest Level upwards
+ * @property {Array<RackController.HorizontalPosition>} [horizontalPositions] The Horizontal Positions defined for this Rack
+ * @property {boolean} [invertHorizontalPositions] Whether the Horizontal Positions for this Rack should be Inverted. By Default, Horizontal Positions go from Left to Right
+ * @memberof Controllers.Lab.Site
+ */
+
+/**
+ * A **VerticalLevel** Type
+ * 
+ * @typedef {Object} RackController.VerticalLevel
+ * @property {string} name A Name for this Vertical Level
+ * @memberof Controllers.Lab.Site
+ */
+
+/**
+ * A **HorizontalPosition** Type
+ * 
+ * @typedef {Object} RackController.HorizontalPosition
+ * @property {string} name A Name for this Horizontal Position
+ * @memberof Controllers.Lab.Site
+ */
+
+exports.default = _default;

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

@@ -0,0 +1,207 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _RequestHelper = _interopRequireDefault(require("../../../RequestHelper"));
+
+var _RackPositionModel = _interopRequireDefault(require("../../../Models/Lab/Site/RackPositionModel"));
+
+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 Rack Positions
+ * 
+ * @class
+ */
+var RackPositionController = /*#__PURE__*/function () {
+  function RackPositionController() {
+    _classCallCheck(this, RackPositionController);
+  }
+
+  _createClass(RackPositionController, null, [{
+    key: "getOne",
+    value:
+    /**
+     * Retrieve a Rack Position [GET /lab/sites/{siteId}/rack-positions/{id}]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Rack Position ID
+     * @return {Promise<RackPositionModel>}
+     */
+    function getOne(siteId, id) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.getRequest("/lab/sites/".concat(siteId, "/rack-positions/").concat(id)).then(function (result) {
+          var resolveValue = function () {
+            return _RackPositionModel.default.fromJSON(result, siteId);
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+    /**
+     * Update a Rack Position [PATCH /lab/sites/{siteId}/rack-positions/{id}]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Rack Position ID
+     * @param {RackPositionController.UpdateData} updateData The Rack Position Update Data
+     * @return {Promise<RackPositionModel>}
+     */
+
+  }, {
+    key: "update",
+    value: function update(siteId, id, updateData) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.patchRequest("/lab/sites/".concat(siteId, "/rack-positions/").concat(id), updateData).then(function (result) {
+          var resolveValue = function () {
+            return _RackPositionModel.default.fromJSON(result, siteId);
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+    /**
+     * Delete a Rack Position [DELETE /lab/sites/{siteId}/rack-positions/{id}]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Rack Position ID
+     * @return {Promise<boolean>}
+     */
+
+  }, {
+    key: "delete",
+    value: function _delete(siteId, id) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.deleteRequest("/lab/sites/".concat(siteId, "/rack-positions/").concat(id)).then(function (result) {
+          resolve(result !== null && result !== void 0 ? result : true);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+    /**
+     * List all Rack Positions [GET /lab/sites/{siteId}/rack-positions]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {RackPositionController.GetAllQueryParameters} [queryParameters] The Optional Query Parameters
+     * @return {Promise<RackPositionModel[]>}
+     */
+
+  }, {
+    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, "/rack-positions"), queryParameters).then(function (result) {
+          var resolveValue = function () {
+            if (Array.isArray(result) !== true) {
+              return [];
+            }
+
+            return result.map(function (resultItem) {
+              return function () {
+                return _RackPositionModel.default.fromJSON(resultItem, siteId);
+              }();
+            });
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+    /**
+     * Create a Rack Position [POST /lab/sites/{siteId}/rack-positions]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {RackPositionController.CreateData} createData The Rack Position Create Data
+     * @return {Promise<RackPositionModel>}
+     */
+
+  }, {
+    key: "create",
+    value: function create(siteId, createData) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.postRequest("/lab/sites/".concat(siteId, "/rack-positions"), createData).then(function (result) {
+          var resolveValue = function () {
+            return _RackPositionModel.default.fromJSON(result, siteId);
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+  }]);
+
+  return RackPositionController;
+}();
+
+var _default = RackPositionController;
+/**
+ * The Optional Query Parameters for the getAll Function
+ * 
+ * @typedef {Object} RackPositionController.GetAllQueryParameters
+ * @property {?number} [rtuId] The RTU this Rack Position belongs to
+ * @property {string} [name] The Name of this Rack Position
+ * @property {string} [labId] The Lab that owns this Rack Position
+ * @property {string} [rackId] The Rack associated with this Rack Position
+ * @property {number} [verticalLevelIndex] The Index of the Vertical Level in the Rack where this Position resides
+ * @property {number} [horizontalPositionIndex] The Index of the Horizontal Position in the Rack where this Position resides
+ * @memberof Controllers.Lab.Site
+ */
+
+/**
+ * The Create Data for a Rack Position
+ * 
+ * @typedef {Object} RackPositionController.CreateData
+ * @property {?number} [rtuId] The RTU this Rack Position belongs to
+ * @property {string} name The Name of this Rack Position
+ * @property {{pushButton: number, indicatorLight: number, temperature: number, calibrationOffset: number, disabled: number, currentSampleId: number, currentSampleStatus: number, nextSampleId: number, startCurrentSampleRequest: number, finishCurrentSampleRequest: number, currentSampleTotalDuration: number, currentSampleWarmUpDuration: number, currentSampleWarmUpCompleted: number, currentSampleBelowTargetDuration: number, currentSampleAboveTargetDuration: number, currentSampleWithinTargetDuration: number, currentSampleSuccessCriteriaMet: number, currentSampleFailureCriteriaMet: number}} points The Points used by this Rack Position
+ * @property {string} labId The Lab that owns this Rack Position
+ * @property {string} rackId The Rack associated with this Rack Position
+ * @property {number} verticalLevelIndex The Index of the Vertical Level in the Rack where this Position resides
+ * @property {number} horizontalPositionIndex The Index of the Horizontal Position in the Rack where this Position resides
+ * @memberof Controllers.Lab.Site
+ */
+
+/**
+ * The Update Data for a Rack Position
+ * 
+ * @typedef {Object} RackPositionController.UpdateData
+ * @property {string} [name] The Name of this Rack Position
+ * @property {{pushButton: number, indicatorLight: number, temperature: number, calibrationOffset: number, disabled: number, currentSampleId: number, currentSampleStatus: number, nextSampleId: number, startCurrentSampleRequest: number, finishCurrentSampleRequest: number, currentSampleTotalDuration: number, currentSampleWarmUpDuration: number, currentSampleWarmUpCompleted: number, currentSampleBelowTargetDuration: number, currentSampleAboveTargetDuration: number, currentSampleWithinTargetDuration: number, currentSampleSuccessCriteriaMet: number, currentSampleFailureCriteriaMet: number}} [points] The Points used by this Rack Position
+ * @property {string} [labId] The Lab that owns this Rack Position
+ * @property {string} [rackId] The Rack associated with this Rack Position
+ * @property {number} [verticalLevelIndex] The Index of the Vertical Level in the Rack where this Position resides
+ * @property {number} [horizontalPositionIndex] The Index of the Horizontal Position in the Rack where this Position resides
+ * @memberof Controllers.Lab.Site
+ */
+
+exports.default = _default;