@ricado/api-client 2.4.0 → 2.4.1

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

@@ -32,58 +32,48 @@ var SampleController = /*#__PURE__*/function () {
   }
 
   _createClass(SampleController, null, [{
-    key: "getTemperatureData",
+    key: "getOne",
     value:
     /**
-     * Retrieve Temperature Data [GET /lab/sites/{siteId}/samples/{id}]
-     * 
-     * Retrieves Temperature Data for a Sample
+     * Retrieve a Sample [GET /lab/sites/{siteId}/samples/{id}]
      * 
      * @static
      * @public
      * @param {number} siteId The Site ID
      * @param {string} id The Sample ID
-     * @return {Promise<Array<SampleController.TemperatureDataItem>>}
+     * @return {Promise<SampleModel>}
      */
-    function getTemperatureData(siteId, id) {
+    function getOne(siteId, id) {
       return new Promise(function (resolve, reject) {
         _RequestHelper.default.getRequest("/lab/sites/".concat(siteId, "/samples/").concat(id)).then(function (result) {
           var resolveValue = function () {
-            if (Array.isArray(result) !== true) {
-              return [];
-            }
-
-            return result.map(function (resultItem) {
-              return function () {
-                var resultItemObject = {};
-
-                if (_typeof(resultItem) === 'object' && 'timestamp' in resultItem) {
-                  resultItemObject.timestamp = function () {
-                    if (typeof resultItem.timestamp !== 'string') {
-                      return new Date(String(resultItem.timestamp));
-                    }
-
-                    return new Date(resultItem.timestamp);
-                  }();
-                } else {
-                  resultItemObject.timestamp = new Date();
-                }
-
-                if (_typeof(resultItem) === 'object' && 'temperature' in resultItem) {
-                  resultItemObject.temperature = function () {
-                    if (typeof resultItem.temperature !== 'number') {
-                      return Number(resultItem.temperature);
-                    }
+            return _SampleModel.default.fromJSON(result, siteId);
+          }();
 
-                    return resultItem.temperature;
-                  }();
-                } else {
-                  resultItemObject.temperature = 0;
-                }
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
+    /**
+     * Update a Sample [PATCH /lab/sites/{siteId}/samples/{id}]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Sample ID
+     * @param {SampleController.UpdateData} updateData The Sample Update Data
+     * @return {Promise<SampleModel>}
+     */
 
-                return resultItemObject;
-              }();
-            });
+  }, {
+    key: "update",
+    value: function update(siteId, id, updateData) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.patchRequest("/lab/sites/".concat(siteId, "/samples/").concat(id), updateData).then(function (result) {
+          var resolveValue = function () {
+            return _SampleModel.default.fromJSON(result, siteId);
           }();
 
           resolve(resolveValue);
@@ -92,6 +82,27 @@ var SampleController = /*#__PURE__*/function () {
         });
       });
     }
+    /**
+     * Delete a Sample [DELETE /lab/sites/{siteId}/samples/{id}]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Sample ID
+     * @return {Promise<boolean>}
+     */
+
+  }, {
+    key: "delete",
+    value: function _delete(siteId, id) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.deleteRequest("/lab/sites/".concat(siteId, "/samples/").concat(id)).then(function (result) {
+          resolve(result !== null && result !== void 0 ? result : true);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
     /**
      * Retrieve Comments [GET /lab/sites/{siteId}/samples/{id}/comments]
      * 
@@ -771,6 +782,67 @@ var SampleController = /*#__PURE__*/function () {
         });
       });
     }
+    /**
+     * Retrieve Temperature Data [GET /lab/sites/{siteId}/samples/{id}/temperature-data]
+     * 
+     * Retrieves Temperature Data for a Sample
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Sample ID
+     * @return {Promise<Array<SampleController.TemperatureDataItem>>}
+     */
+
+  }, {
+    key: "getTemperatureData",
+    value: function getTemperatureData(siteId, id) {
+      return new Promise(function (resolve, reject) {
+        _RequestHelper.default.getRequest("/lab/sites/".concat(siteId, "/samples/").concat(id, "/temperature-data")).then(function (result) {
+          var resolveValue = function () {
+            if (Array.isArray(result) !== true) {
+              return [];
+            }
+
+            return result.map(function (resultItem) {
+              return function () {
+                var resultItemObject = {};
+
+                if (_typeof(resultItem) === 'object' && 'timestamp' in resultItem) {
+                  resultItemObject.timestamp = function () {
+                    if (typeof resultItem.timestamp !== 'string') {
+                      return new Date(String(resultItem.timestamp));
+                    }
+
+                    return new Date(resultItem.timestamp);
+                  }();
+                } else {
+                  resultItemObject.timestamp = new Date();
+                }
+
+                if (_typeof(resultItem) === 'object' && 'temperature' in resultItem) {
+                  resultItemObject.temperature = function () {
+                    if (typeof resultItem.temperature !== 'number') {
+                      return Number(resultItem.temperature);
+                    }
+
+                    return resultItem.temperature;
+                  }();
+                } else {
+                  resultItemObject.temperature = 0;
+                }
+
+                return resultItemObject;
+              }();
+            });
+          }();
+
+          resolve(resolveValue);
+        }).catch(function (error) {
+          return reject(error);
+        });
+      });
+    }
     /**
      * List all Samples [GET /lab/sites/{siteId}/samples]
      * 
@@ -894,11 +966,26 @@ var _default = SampleController;
  */
 
 /**
- * A **TemperatureDataItem** Type
+ * The Update Data for a Sample
  * 
- * @typedef {Object} SampleController.TemperatureDataItem
- * @property {Date} timestamp The Timestamp for the Temperature Value
- * @property {number} temperature The Temperature Value
+ * @typedef {Object} SampleController.UpdateData
+ * @property {string} [labId] The Lab ID this Sample is associated with
+ * @property {Date} [createdTimestamp] When this Sample was Created
+ * @property {string} [createdSource] The Source that Created this Sample
+ * @property {?string} [createdUserId] ID of the User who Created this Sample. Only applies if the `createdSource` is 'System'
+ * @property {?string} [createdUserName] Name of the User who Created this Sample. Only applies if the `createdSource` is 'System'
+ * @property {?Date} [scheduledTimestamp] Optional Scheduled Timestamp when this Sample should Begin
+ * @property {?Date} [startTimestamp] When this Sample was Started
+ * @property {?Date} [finishTimestamp] When this Sample was Finished
+ * @property {?Date} [publishTimestamp] When this Sample was Published
+ * @property {?string} [publishUserId] ID of the User who Published this Sample
+ * @property {?string} [publishUserName] Name of the User who Published this Sample
+ * @property {string} [fruitProfileId] The Fruit Profile for this Sample
+ * @property {string} [rackPositionId] The Rack Position used for this Sample
+ * @property {string} [dehydratorId] The Dehydrator used for this Sample
+ * @property {?string} [outcome] The Outcome of this Sample
+ * @property {?string} [failureReasonId] A Sample Failure Reason ID if this Sample Failed
+ * @property {?string} [resultId] The Sample Result ID asociated with this Sample
  * @memberof Controllers.Lab.Site
  */
 
@@ -924,4 +1011,13 @@ var _default = SampleController;
  * @memberof Controllers.Lab.Site
  */
 
+/**
+ * A **TemperatureDataItem** Type
+ * 
+ * @typedef {Object} SampleController.TemperatureDataItem
+ * @property {Date} timestamp The Timestamp for the Temperature Value
+ * @property {number} temperature The Temperature Value
+ * @memberof Controllers.Lab.Site
+ */
+
 exports.default = _default;

package/lib/PackageVersion.js

@@ -5,5 +5,5 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.version = void 0;
 // Generated by genversion.
-var version = '2.4.0';
+var version = '2.4.1';
 exports.version = version;

package/lib/index.d.ts

@@ -7511,17 +7511,36 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleController' {
         */
     class SampleController {
             /**
-                * Retrieve Temperature Data [GET /lab/sites/{siteId}/samples/{id}]
+                * Retrieve a Sample [GET /lab/sites/{siteId}/samples/{id}]
                 *
-                * Retrieves Temperature Data for a Sample
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Sample ID
+                * @return {Promise<SampleModel>}
+                */
+            static getOne(siteId: number, id: string): Promise<SampleModel>;
+            /**
+                * Update a Sample [PATCH /lab/sites/{siteId}/samples/{id}]
                 *
                 * @static
                 * @public
                 * @param {number} siteId The Site ID
                 * @param {string} id The Sample ID
-                * @return {Promise<Array<SampleController.TemperatureDataItem>>}
+                * @param {SampleController.UpdateData} updateData The Sample Update Data
+                * @return {Promise<SampleModel>}
                 */
-            static getTemperatureData(siteId: number, id: string): Promise<Array<SampleController.TemperatureDataItem>>;
+            static update(siteId: number, id: string, updateData: SampleController.UpdateData): Promise<SampleModel>;
+            /**
+                * Delete a Sample [DELETE /lab/sites/{siteId}/samples/{id}]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Sample ID
+                * @return {Promise<boolean>}
+                */
+            static delete(siteId: number, id: string): Promise<boolean>;
             /**
                 * Retrieve Comments [GET /lab/sites/{siteId}/samples/{id}/comments]
                 *
@@ -7599,6 +7618,18 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleController' {
                 * @return {Promise<SampleResultModel>}
                 */
             static getSampleResult(siteId: number, id: string): Promise<SampleResultModel>;
+            /**
+                * Retrieve Temperature Data [GET /lab/sites/{siteId}/samples/{id}/temperature-data]
+                *
+                * Retrieves Temperature Data for a Sample
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Sample ID
+                * @return {Promise<Array<SampleController.TemperatureDataItem>>}
+                */
+            static getTemperatureData(siteId: number, id: string): Promise<Array<SampleController.TemperatureDataItem>>;
             /**
                 * List all Samples [GET /lab/sites/{siteId}/samples]
                 *
@@ -7804,17 +7835,77 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleController' {
                     resultId?: string | null;
             };
             /**
-                * A **TemperatureDataItem** Type
+                * The Update Data for a Sample
                 */
-            export type TemperatureDataItem = {
+            export type UpdateData = {
                     /**
-                        * The Timestamp for the Temperature Value
+                        * The Lab ID this Sample is associated with
                         */
-                    timestamp: Date;
+                    labId?: string;
                     /**
-                        * The Temperature Value
+                        * When this Sample was Created
                         */
-                    temperature: number;
+                    createdTimestamp?: Date;
+                    /**
+                        * The Source that Created this Sample
+                        */
+                    createdSource?: string;
+                    /**
+                        * ID of the User who Created this Sample. Only applies if the `createdSource` is 'System'
+                        */
+                    createdUserId?: string | null;
+                    /**
+                        * Name of the User who Created this Sample. Only applies if the `createdSource` is 'System'
+                        */
+                    createdUserName?: string | null;
+                    /**
+                        * Optional Scheduled Timestamp when this Sample should Begin
+                        */
+                    scheduledTimestamp?: Date | null;
+                    /**
+                        * When this Sample was Started
+                        */
+                    startTimestamp?: Date | null;
+                    /**
+                        * When this Sample was Finished
+                        */
+                    finishTimestamp?: Date | null;
+                    /**
+                        * When this Sample was Published
+                        */
+                    publishTimestamp?: Date | null;
+                    /**
+                        * ID of the User who Published this Sample
+                        */
+                    publishUserId?: string | null;
+                    /**
+                        * Name of the User who Published this Sample
+                        */
+                    publishUserName?: string | null;
+                    /**
+                        * The Fruit Profile for this Sample
+                        */
+                    fruitProfileId?: string;
+                    /**
+                        * The Rack Position used for this Sample
+                        */
+                    rackPositionId?: string;
+                    /**
+                        * The Dehydrator used for this Sample
+                        */
+                    dehydratorId?: string;
+                    /**
+                        * The Outcome of this Sample
+                        */
+                    outcome?: string | null;
+                    /**
+                        * A Sample Failure Reason ID if this Sample Failed
+                        */
+                    failureReasonId?: string | null;
+                    /**
+                        * The Sample Result ID asociated with this Sample
+                        */
+                    resultId?: string | null;
             };
             /**
                 * A **UserAccount** Type
@@ -7855,9 +7946,22 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleController' {
                         */
                     updatedTimestamp: Date | null;
             };
+            /**
+                * A **TemperatureDataItem** Type
+                */
+            export type TemperatureDataItem = {
+                    /**
+                        * The Timestamp for the Temperature Value
+                        */
+                    timestamp: Date;
+                    /**
+                        * The Temperature Value
+                        */
+                    temperature: number;
+            };
     }
-    import SampleResultModel from "@ricado/api-client/Models/Lab/Site/SampleResultModel";
     import SampleModel from "@ricado/api-client/Models/Lab/Site/SampleModel";
+    import SampleResultModel from "@ricado/api-client/Models/Lab/Site/SampleResultModel";
 }
 
 declare module '@ricado/api-client/Controllers/Lab/Site/SampleFailureReasonController' {

package/package.json

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

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

@@ -16,66 +16,46 @@ import SampleResultModel from '../../../Models/Lab/Site/SampleResultModel';
 class SampleController
 {
     /**
-     * Retrieve Temperature Data [GET /lab/sites/{siteId}/samples/{id}]
-     * 
-     * Retrieves Temperature Data for a Sample
+     * Retrieve a Sample [GET /lab/sites/{siteId}/samples/{id}]
      * 
      * @static
      * @public
      * @param {number} siteId The Site ID
      * @param {string} id The Sample ID
-     * @return {Promise<Array<SampleController.TemperatureDataItem>>}
+     * @return {Promise<SampleModel>}
      */
-    static getTemperatureData(siteId, id)
+    static getOne(siteId, id)
     {
         return new Promise((resolve, reject) => {
             RequestHelper.getRequest(`/lab/sites/${siteId}/samples/${id}`)
             .then((result) => {
                 let resolveValue = (function(){
-                    if(Array.isArray(result) !== true)
-                    {
-                        return [];
-                    }
-                
-                    return result.map((resultItem) => {
-                        return (function(){
-                            let resultItemObject = {};
-                            
-                            if(typeof resultItem === 'object' && 'timestamp' in resultItem)
-                            {
-                                resultItemObject.timestamp = (function(){
-                                    if(typeof resultItem.timestamp !== 'string')
-                                    {
-                                        return new Date(String(resultItem.timestamp));
-                                    }
-                
-                                    return new Date(resultItem.timestamp);
-                                }());
-                            }
-                            else
-                            {
-                                resultItemObject.timestamp = new Date();
-                            }
-                            
-                            if(typeof resultItem === 'object' && 'temperature' in resultItem)
-                            {
-                                resultItemObject.temperature = (function(){
-                                    if(typeof resultItem.temperature !== 'number')
-                                    {
-                                        return Number(resultItem.temperature);
-                                    }
-                
-                                    return resultItem.temperature;
-                                }());
-                            }
-                            else
-                            {
-                                resultItemObject.temperature = 0;
-                            }
+                    return SampleModel.fromJSON(result, siteId);
+                }());
                 
-                            return resultItemObject;
-                        }());
-                    });
+                resolve(resolveValue);
+            })
+            .catch(error => reject(error));
+        });
+    }
+
+    /**
+     * Update a Sample [PATCH /lab/sites/{siteId}/samples/{id}]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Sample ID
+     * @param {SampleController.UpdateData} updateData The Sample Update Data
+     * @return {Promise<SampleModel>}
+     */
+    static update(siteId, id, updateData)
+    {
+        return new Promise((resolve, reject) => {
+            RequestHelper.patchRequest(`/lab/sites/${siteId}/samples/${id}`, updateData)
+            .then((result) => {
+                let resolveValue = (function(){
+                    return SampleModel.fromJSON(result, siteId);
                 }());
                 
                 resolve(resolveValue);
@@ -84,6 +64,26 @@ class SampleController
         });
     }
 
+    /**
+     * Delete a Sample [DELETE /lab/sites/{siteId}/samples/{id}]
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Sample ID
+     * @return {Promise<boolean>}
+     */
+    static delete(siteId, id)
+    {
+        return new Promise((resolve, reject) => {
+            RequestHelper.deleteRequest(`/lab/sites/${siteId}/samples/${id}`)
+            .then((result) => {
+                resolve(result ?? true);
+            })
+            .catch(error => reject(error));
+        });
+    }
+
     /**
      * Retrieve Comments [GET /lab/sites/{siteId}/samples/{id}/comments]
      * 
@@ -918,6 +918,75 @@ class SampleController
         });
     }
 
+    /**
+     * Retrieve Temperature Data [GET /lab/sites/{siteId}/samples/{id}/temperature-data]
+     * 
+     * Retrieves Temperature Data for a Sample
+     * 
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Sample ID
+     * @return {Promise<Array<SampleController.TemperatureDataItem>>}
+     */
+    static getTemperatureData(siteId, id)
+    {
+        return new Promise((resolve, reject) => {
+            RequestHelper.getRequest(`/lab/sites/${siteId}/samples/${id}/temperature-data`)
+            .then((result) => {
+                let resolveValue = (function(){
+                    if(Array.isArray(result) !== true)
+                    {
+                        return [];
+                    }
+                
+                    return result.map((resultItem) => {
+                        return (function(){
+                            let resultItemObject = {};
+                            
+                            if(typeof resultItem === 'object' && 'timestamp' in resultItem)
+                            {
+                                resultItemObject.timestamp = (function(){
+                                    if(typeof resultItem.timestamp !== 'string')
+                                    {
+                                        return new Date(String(resultItem.timestamp));
+                                    }
+                
+                                    return new Date(resultItem.timestamp);
+                                }());
+                            }
+                            else
+                            {
+                                resultItemObject.timestamp = new Date();
+                            }
+                            
+                            if(typeof resultItem === 'object' && 'temperature' in resultItem)
+                            {
+                                resultItemObject.temperature = (function(){
+                                    if(typeof resultItem.temperature !== 'number')
+                                    {
+                                        return Number(resultItem.temperature);
+                                    }
+                
+                                    return resultItem.temperature;
+                                }());
+                            }
+                            else
+                            {
+                                resultItemObject.temperature = 0;
+                            }
+                
+                            return resultItemObject;
+                        }());
+                    });
+                }());
+                
+                resolve(resolveValue);
+            })
+            .catch(error => reject(error));
+        });
+    }
+
     /**
      * List all Samples [GET /lab/sites/{siteId}/samples]
      * 
@@ -1036,11 +1105,26 @@ export default SampleController;
  */
 
 /**
- * A **TemperatureDataItem** Type
+ * The Update Data for a Sample
  * 
- * @typedef {Object} SampleController.TemperatureDataItem
- * @property {Date} timestamp The Timestamp for the Temperature Value
- * @property {number} temperature The Temperature Value
+ * @typedef {Object} SampleController.UpdateData
+ * @property {string} [labId] The Lab ID this Sample is associated with
+ * @property {Date} [createdTimestamp] When this Sample was Created
+ * @property {string} [createdSource] The Source that Created this Sample
+ * @property {?string} [createdUserId] ID of the User who Created this Sample. Only applies if the `createdSource` is 'System'
+ * @property {?string} [createdUserName] Name of the User who Created this Sample. Only applies if the `createdSource` is 'System'
+ * @property {?Date} [scheduledTimestamp] Optional Scheduled Timestamp when this Sample should Begin
+ * @property {?Date} [startTimestamp] When this Sample was Started
+ * @property {?Date} [finishTimestamp] When this Sample was Finished
+ * @property {?Date} [publishTimestamp] When this Sample was Published
+ * @property {?string} [publishUserId] ID of the User who Published this Sample
+ * @property {?string} [publishUserName] Name of the User who Published this Sample
+ * @property {string} [fruitProfileId] The Fruit Profile for this Sample
+ * @property {string} [rackPositionId] The Rack Position used for this Sample
+ * @property {string} [dehydratorId] The Dehydrator used for this Sample
+ * @property {?string} [outcome] The Outcome of this Sample
+ * @property {?string} [failureReasonId] A Sample Failure Reason ID if this Sample Failed
+ * @property {?string} [resultId] The Sample Result ID asociated with this Sample
  * @memberof Controllers.Lab.Site
  */
 
@@ -1064,4 +1148,13 @@ export default SampleController;
  * @property {?Date} createdTimestamp When the Comment was Created
  * @property {?Date} updatedTimestamp When the Comment was last Updated
  * @memberof Controllers.Lab.Site
+ */
+
+/**
+ * A **TemperatureDataItem** Type
+ * 
+ * @typedef {Object} SampleController.TemperatureDataItem
+ * @property {Date} timestamp The Timestamp for the Temperature Value
+ * @property {number} temperature The Temperature Value
+ * @memberof Controllers.Lab.Site
  */

package/src/PackageVersion.js

@@ -1,2 +1,2 @@
 // Generated by genversion.
-export const version = '2.4.0';
+export const version = '2.4.1';