@ricado/api-client 2.4.1 → 2.4.2

package/lib/index.d.ts

@@ -3158,6 +3158,7 @@ declare module '@ricado/api-client/Controllers/Lab/Site' {
         export { DehydratorController };
         export { FruitProfileController };
         export { LabController };
+        export { ProbeCalibrationController };
         export { RackController };
         export { RackPositionController };
         export { SampleController };
@@ -3167,6 +3168,7 @@ declare module '@ricado/api-client/Controllers/Lab/Site' {
     import DehydratorController from "@ricado/api-client/Controllers/Lab/Site/DehydratorController";
     import FruitProfileController from "@ricado/api-client/Controllers/Lab/Site/FruitProfileController";
     import LabController from "@ricado/api-client/Controllers/Lab/Site/LabController";
+    import ProbeCalibrationController from "@ricado/api-client/Controllers/Lab/Site/ProbeCalibrationController";
     import RackController from "@ricado/api-client/Controllers/Lab/Site/RackController";
     import RackPositionController from "@ricado/api-client/Controllers/Lab/Site/RackPositionController";
     import SampleController from "@ricado/api-client/Controllers/Lab/Site/SampleController";
@@ -5996,6 +5998,7 @@ declare module '@ricado/api-client/Models/Lab/Site' {
         export { DehydratorModel };
         export { FruitProfileModel };
         export { LabModel };
+        export { ProbeCalibrationModel };
         export { RackModel };
         export { RackPositionModel };
         export { SampleFailureReasonModel };
@@ -6005,6 +6008,7 @@ declare module '@ricado/api-client/Models/Lab/Site' {
     import DehydratorModel from "@ricado/api-client/Models/Lab/Site/DehydratorModel";
     import FruitProfileModel from "@ricado/api-client/Models/Lab/Site/FruitProfileModel";
     import LabModel from "@ricado/api-client/Models/Lab/Site/LabModel";
+    import ProbeCalibrationModel from "@ricado/api-client/Models/Lab/Site/ProbeCalibrationModel";
     import RackModel from "@ricado/api-client/Models/Lab/Site/RackModel";
     import RackPositionModel from "@ricado/api-client/Models/Lab/Site/RackPositionModel";
     import SampleFailureReasonModel from "@ricado/api-client/Models/Lab/Site/SampleFailureReasonModel";
@@ -6897,7 +6901,7 @@ declare module '@ricado/api-client/Controllers/Lab/Site/FruitProfileController'
                     /**
                         * The Fruit Profile Name
                         */
-                    name?: string;
+                    name: string;
                     /**
                         * The Fruit Profile Description
                         */
@@ -6931,6 +6935,10 @@ declare module '@ricado/api-client/Controllers/Lab/Site/FruitProfileController'
                 * The Update Data for a Fruit Profile
                 */
             export type UpdateData = {
+                    /**
+                        * The Fruit Profile Name
+                        */
+                    name?: string;
                     /**
                         * The Fruit Profile Description
                         */
@@ -7134,6 +7142,293 @@ declare module '@ricado/api-client/Controllers/Lab/Site/LabController' {
     import LabModel from "@ricado/api-client/Models/Lab/Site/LabModel";
 }
 
+declare module '@ricado/api-client/Controllers/Lab/Site/ProbeCalibrationController' {
+    export default ProbeCalibrationController;
+    /**
+        * Controller Class for Probe Calibrations
+        *
+        * @class
+        */
+    class ProbeCalibrationController {
+            /**
+                * Retrieve a Probe Calibration [GET /lab/sites/{siteId}/probe-calibrations/{id}]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Probe Calibration ID
+                * @return {Promise<ProbeCalibrationModel>}
+                */
+            static getOne(siteId: number, id: string): Promise<ProbeCalibrationModel>;
+            /**
+                * Update a Probe Calibration [PATCH /lab/sites/{siteId}/probe-calibrations/{id}]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Probe Calibration ID
+                * @param {ProbeCalibrationController.UpdateData} updateData The Probe Calibration Update Data
+                * @return {Promise<ProbeCalibrationModel>}
+                */
+            static update(siteId: number, id: string, updateData: ProbeCalibrationController.UpdateData): Promise<ProbeCalibrationModel>;
+            /**
+                * Delete a Probe Calibration [DELETE /lab/sites/{siteId}/probe-calibrations/{id}]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Probe Calibration ID
+                * @return {Promise<boolean>}
+                */
+            static delete(siteId: number, id: string): Promise<boolean>;
+            /**
+                * Retrieve Comments [GET /lab/sites/{siteId}/probe-calibrations/{id}/comments]
+                *
+                * Retrieves Comments for a Probe Calibration
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Probe Calibration ID
+                * @return {Promise<Array<ProbeCalibrationController.CommentItem>>}
+                */
+            static getComments(siteId: number, id: string): Promise<Array<ProbeCalibrationController.CommentItem>>;
+            /**
+                * Create a Comment [POST /lab/sites/{siteId}/probe-calibrations/{id}/comments]
+                *
+                * Create a Comment for a Probe Calibration
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Probe Calibration ID
+                * @param {string} content The Content of the New Comment
+                * @return {Promise<ProbeCalibrationController.CommentItem>}
+                */
+            static createComment(siteId: number, id: string, content: string): Promise<ProbeCalibrationController.CommentItem>;
+            /**
+                * Retrieve a Comment [GET /lab/sites/{siteId}/probe-calibrations/{id}/comments/{commentId}]
+                *
+                * Retrieves Comments for a Probe Calibration
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Probe Calibration ID
+                * @param {string} commentId The Comment ID
+                * @return {Promise<ProbeCalibrationController.CommentItem>}
+                */
+            static getOneComment(siteId: number, id: string, commentId: string): Promise<ProbeCalibrationController.CommentItem>;
+            /**
+                * Update a Comment [PATCH /lab/sites/{siteId}/probe-calibrations/{id}/comments/{commentId}]
+                *
+                * Update a Comment for a Probe Calibration
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Probe Calibration ID
+                * @param {string} commentId The Comment ID
+                * @param {string} content The Updated Content for the Comment
+                * @return {Promise<ProbeCalibrationController.CommentItem>}
+                */
+            static updateOneComment(siteId: number, id: string, commentId: string, content: string): Promise<ProbeCalibrationController.CommentItem>;
+            /**
+                * Delete a Comment [DELETE /lab/sites/{siteId}/probe-calibrations/{id}/comments/{commentId}]
+                *
+                * Delete a Comment for a Probe Calibration
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Probe Calibration ID
+                * @param {string} commentId The Comment ID
+                * @return {Promise<boolean>}
+                */
+            static deleteOneComment(siteId: number, id: string, commentId: string): Promise<boolean>;
+            /**
+                * List all Probe Calibrations [GET /lab/sites/{siteId}/probe-calibrations]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {ProbeCalibrationController.GetAllQueryParameters} [queryParameters] The Optional Query Parameters
+                * @return {Promise<ProbeCalibrationModel[]>}
+                */
+            static getAll(siteId: number, queryParameters?: ProbeCalibrationController.GetAllQueryParameters | undefined): Promise<ProbeCalibrationModel[]>;
+            /**
+                * Create a Probe Calibration [POST /lab/sites/{siteId}/probe-calibrations]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {ProbeCalibrationController.CreateData} createData The Probe Calibration Create Data
+                * @return {Promise<ProbeCalibrationModel>}
+                */
+            static create(siteId: number, createData: ProbeCalibrationController.CreateData): Promise<ProbeCalibrationModel>;
+            /**
+                * Retrieve the Latest Probe Calibrations [GET /lab/sites/{siteId}/probe-calibrations/latest]
+                *
+                * Retrieves the Latest Probe Calibrations for all Rack Positions
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @return {Promise<ProbeCalibrationModel[]>}
+                */
+            static getLatestProbeCalibrations(siteId: number): Promise<ProbeCalibrationModel[]>;
+    }
+    namespace ProbeCalibrationController {
+            /**
+                * The Optional Query Parameters for the getAll Function
+                */
+            export type GetAllQueryParameters = {
+                    /**
+                        * The Rack Position ID this Probe Calibration is associated with
+                        */
+                    rackPositionId?: string;
+                    /**
+                        * ID of the User who Completed this Probe Calibration
+                        */
+                    userId?: string;
+                    /**
+                        * Name of the User who Completed this Probe Calibration
+                        */
+                    userName?: string;
+                    /**
+                        * Filter by the Timestamp when Probe Calibrations were Created. Results Greater than or Equal to Timestamp
+                        */
+                    createdTimestampBegin?: Date;
+                    /**
+                        * Filter by the Timestamp when Probe Calibrations were Created. Results Less than or Equal to Timestamp
+                        */
+                    createdTimestampEnd?: Date;
+                    /**
+                        * Filter by the Timestamp when Probe Calibrations were last Updated. Results Greater than or Equal to Timestamp
+                        */
+                    updateTimestampBegin?: Date;
+                    /**
+                        * Filter by the Timestamp when Probe Calibrations were last Updated. Results Less than or Equal to Timestamp
+                        */
+                    updateTimestampEnd?: Date;
+            };
+            /**
+                * The Create Data for a Probe Calibration
+                */
+            export type CreateData = {
+                    /**
+                        * The Rack Position ID this Probe Calibration is associated with
+                        */
+                    rackPositionId: string;
+                    /**
+                        * When this Probe Calibration was Created
+                        */
+                    createdTimestamp?: Date;
+                    /**
+                        * ID of the User who Completed this Probe Calibration
+                        */
+                    userId: string;
+                    /**
+                        * Name of the User who Completed this Probe Calibration
+                        */
+                    userName: string;
+                    /**
+                        * The Calibration Offset prior to this Probe Calibration being Created
+                        */
+                    preCalibrationOffset: number;
+                    /**
+                        * The Calibration Offset after this Probe Calibration was Created
+                        */
+                    postCalibrationOffset: number;
+                    /**
+                        * The Temperature Probe reading prior to this Probe Calibration being Created
+                        */
+                    preCalibrationTemperature: number;
+                    /**
+                        * The Temperature Probe reading after this Probe Calibration was Created
+                        */
+                    postCalibrationTemperature: number;
+            };
+            /**
+                * The Update Data for a Probe Calibration
+                */
+            export type UpdateData = {
+                    /**
+                        * The Rack Position ID this Probe Calibration is associated with
+                        */
+                    rackPositionId?: string;
+                    /**
+                        * When this Probe Calibration was Created
+                        */
+                    createdTimestamp?: Date;
+                    /**
+                        * ID of the User who Completed this Probe Calibration
+                        */
+                    userId?: string;
+                    /**
+                        * Name of the User who Completed this Probe Calibration
+                        */
+                    userName?: string;
+                    /**
+                        * The Calibration Offset prior to this Probe Calibration being Created
+                        */
+                    preCalibrationOffset?: number;
+                    /**
+                        * The Calibration Offset after this Probe Calibration was Created
+                        */
+                    postCalibrationOffset?: number;
+                    /**
+                        * The Temperature Probe reading prior to this Probe Calibration being Created
+                        */
+                    preCalibrationTemperature?: number;
+                    /**
+                        * The Temperature Probe reading after this Probe Calibration was Created
+                        */
+                    postCalibrationTemperature?: number;
+            };
+            /**
+                * A **UserAccount** Type
+                */
+            export type UserAccount = {
+                    /**
+                        * The User Account ID
+                        */
+                    id: string | null;
+                    /**
+                        * The User's First Name
+                        */
+                    firstName: string | null;
+                    /**
+                        * The User's Last Name
+                        */
+                    lastName: string | null;
+            };
+            /**
+                * A **CommentItem** Type
+                */
+            export type CommentItem = {
+                    /**
+                        * The Comment ID
+                        */
+                    id: string;
+                    userAccount: UserAccount;
+                    /**
+                        * The Content of the Comment
+                        */
+                    content: string | null;
+                    /**
+                        * When the Comment was Created
+                        */
+                    createdTimestamp: Date | null;
+                    /**
+                        * When the Comment was last Updated
+                        */
+                    updatedTimestamp: Date | null;
+            };
+    }
+    import ProbeCalibrationModel from "@ricado/api-client/Models/Lab/Site/ProbeCalibrationModel";
+}
+
 declare module '@ricado/api-client/Controllers/Lab/Site/RackController' {
     export default RackController;
     /**
@@ -7669,11 +7964,11 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleController' {
                         */
                     createdSource?: string;
                     /**
-                        * ID of the User who Created this Sample. Only applies if the `createdSource` is 'System'
+                        * ID of the User who Created this Sample. Only applies if the `createdSource` is 'User'
                         */
                     createdUserId?: string | null;
                     /**
-                        * Name of the User who Created this Sample. Only applies if the `createdSource` is 'System'
+                        * Name of the User who Created this Sample. Only applies if the `createdSource` is 'User'
                         */
                     createdUserName?: string | null;
                     /**
@@ -7724,6 +8019,14 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleController' {
                         * Filter by the Timestamp when Samples were Scheduled to Begin. Results Less than or Equal to Timestamp
                         */
                     scheduledTimestampEnd?: Date;
+                    /**
+                        * Filter by the Timestamp when Samples were Loaded. Results Greater than or Equal to Timestamp
+                        */
+                    loadedTimestampBegin?: Date;
+                    /**
+                        * Filter by the Timestamp when Samples were Loaded. Results Less than or Equal to Timestamp
+                        */
+                    loadedTimestampEnd?: Date;
                     /**
                         * Filter by the Timestamp when Samples were Started. Results Greater than or Equal to Timestamp
                         */
@@ -7740,6 +8043,14 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleController' {
                         * Filter by the Timestamp when Samples were Finished. Results Less than or Equal to Timestamp
                         */
                     finishTimestampEnd?: Date;
+                    /**
+                        * Filter by the Timestamp when Samples were Unloaded. Results Greater than or Equal to Timestamp
+                        */
+                    unloadedTimestampBegin?: Date;
+                    /**
+                        * Filter by the Timestamp when Samples were Unloaded. Results Less than or Equal to Timestamp
+                        */
+                    unloadedTimestampEnd?: Date;
                     /**
                         * Filter by the Timestamp when Samples were Published. Results Greater than or Equal to Timestamp
                         */
@@ -7778,17 +8089,21 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleController' {
                         */
                     createdSource: string;
                     /**
-                        * ID of the User who Created this Sample. Only applies if the `createdSource` is 'System'
+                        * ID of the User who Created this Sample. Only applies if the `createdSource` is 'User'
                         */
                     createdUserId?: string | null;
                     /**
-                        * Name of the User who Created this Sample. Only applies if the `createdSource` is 'System'
+                        * Name of the User who Created this Sample. Only applies if the `createdSource` is 'User'
                         */
                     createdUserName?: string | null;
                     /**
                         * Optional Scheduled Timestamp when this Sample should Begin
                         */
                     scheduledTimestamp?: Date | null;
+                    /**
+                        * When this Sample was Loaded into the Dehydrator
+                        */
+                    loadedTimestamp?: Date | null;
                     /**
                         * When this Sample was Started
                         */
@@ -7797,6 +8112,10 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleController' {
                         * When this Sample was Finished
                         */
                     finishTimestamp?: Date | null;
+                    /**
+                        * When this Sample was Unloaded from the Dehydrator
+                        */
+                    unloadedTimestamp?: Date | null;
                     /**
                         * When this Sample was Published
                         */
@@ -7851,17 +8170,21 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleController' {
                         */
                     createdSource?: string;
                     /**
-                        * ID of the User who Created this Sample. Only applies if the `createdSource` is 'System'
+                        * ID of the User who Created this Sample. Only applies if the `createdSource` is 'User'
                         */
                     createdUserId?: string | null;
                     /**
-                        * Name of the User who Created this Sample. Only applies if the `createdSource` is 'System'
+                        * Name of the User who Created this Sample. Only applies if the `createdSource` is 'User'
                         */
                     createdUserName?: string | null;
                     /**
                         * Optional Scheduled Timestamp when this Sample should Begin
                         */
                     scheduledTimestamp?: Date | null;
+                    /**
+                        * When this Sample was Loaded into the Dehydrator
+                        */
+                    loadedTimestamp?: Date | null;
                     /**
                         * When this Sample was Started
                         */
@@ -7870,6 +8193,10 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleController' {
                         * When this Sample was Finished
                         */
                     finishTimestamp?: Date | null;
+                    /**
+                        * When this Sample was Unloaded from the Dehydrator
+                        */
+                    unloadedTimestamp?: Date | null;
                     /**
                         * When this Sample was Published
                         */
@@ -8041,7 +8368,7 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleFailureReasonContr
                     /**
                         * The Sample Failure Reason Name
                         */
-                    name?: string;
+                    name: string;
                     /**
                         * The Sample Failure Reason Description
                         */
@@ -8051,6 +8378,10 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleFailureReasonContr
                 * The Update Data for a Sample Failure Reason
                 */
             export type UpdateData = {
+                    /**
+                        * The Sample Failure Reason Name
+                        */
+                    name?: string;
                     /**
                         * The Sample Failure Reason Description
                         */
@@ -22320,6 +22651,123 @@ declare module '@ricado/api-client/Models/Lab/Site/LabModel' {
     import BaseModel from "@ricado/api-client/Models/BaseModel";
 }
 
+declare module '@ricado/api-client/Models/Lab/Site/ProbeCalibrationModel' {
+    export default ProbeCalibrationModel;
+    /**
+        * Model Class for a Probe Calibration
+        *
+        * @class
+        * @hideconstructor
+        * @extends BaseModel
+        */
+    class ProbeCalibrationModel extends BaseModel {
+            /**
+                * Create a new **ProbeCalibrationModel** from a JSON Object or JSON String
+                *
+                * @static
+                * @public
+                * @param {Object<string, any>|string} json A JSON Object or JSON String
+                * @param {number} siteId The Site ID associated with this Probe Calibration
+                * @return {ProbeCalibrationModel}
+                */
+            static fromJSON(json: {
+                    [x: string]: any;
+            } | string, siteId: number): ProbeCalibrationModel;
+            /**
+                * ProbeCalibrationModel Constructor
+                *
+                * @protected
+                * @param {number} siteId The Site ID associated with this Probe Calibration
+                */
+            protected constructor();
+            /**
+                * The Probe Calibration ID
+                *
+                * @type {string}
+                * @public
+                */
+            id: string;
+            /**
+                * The Rack Position ID this Probe Calibration is associated with
+                *
+                * @type {string}
+                * @public
+                */
+            rackPositionId: string;
+            /**
+                * When this Probe Calibration was Created
+                *
+                * @type {Date}
+                * @public
+                */
+            createdTimestamp: Date;
+            /**
+                * ID of the User who Completed this Probe Calibration
+                *
+                * @type {string}
+                * @public
+                */
+            userId: string;
+            /**
+                * Name of the User who Completed this Probe Calibration
+                *
+                * @type {string}
+                * @public
+                */
+            userName: string;
+            /**
+                * The Calibration Offset prior to this Probe Calibration being Created
+                *
+                * @type {number}
+                * @public
+                */
+            preCalibrationOffset: number;
+            /**
+                * The Calibration Offset after this Probe Calibration was Created
+                *
+                * @type {number}
+                * @public
+                */
+            postCalibrationOffset: number;
+            /**
+                * The Temperature Probe reading prior to this Probe Calibration being Created
+                *
+                * @type {number}
+                * @public
+                */
+            preCalibrationTemperature: number;
+            /**
+                * The Temperature Probe reading after this Probe Calibration was Created
+                *
+                * @type {number}
+                * @public
+                */
+            postCalibrationTemperature: number;
+            /**
+                * Whether the Probe Calibration has been deleted
+                *
+                * @type {boolean}
+                * @public
+                */
+            deleted: boolean;
+            /**
+                * When the Probe Calibration was last updated
+                *
+                * @type {Date}
+                * @public
+                */
+            updateTimestamp: Date;
+            /**
+                * The Site ID associated with this Probe Calibration
+                *
+                * @type {number}
+                * @public
+                */
+            siteId: number;
+    }
+    import BaseModel from "@ricado/api-client/Models/BaseModel";
+}
+
 declare module '@ricado/api-client/Models/Lab/Site/RackModel' {
     export default RackModel;
     /**
@@ -22712,14 +23160,14 @@ declare module '@ricado/api-client/Models/Lab/Site/SampleModel' {
                 */
             createdSource: string;
             /**
-                * ID of the User who Created this Sample. Only applies if the `createdSource` is 'System'
+                * ID of the User who Created this Sample. Only applies if the `createdSource` is 'User'
                 *
                 * @type {?string}
                 * @public
                 */
             createdUserId: string | null;
             /**
-                * Name of the User who Created this Sample. Only applies if the `createdSource` is 'System'
+                * Name of the User who Created this Sample. Only applies if the `createdSource` is 'User'
                 *
                 * @type {?string}
                 * @public
@@ -22732,6 +23180,13 @@ declare module '@ricado/api-client/Models/Lab/Site/SampleModel' {
                 * @public
                 */
             scheduledTimestamp: Date | null;
+            /**
+                * When this Sample was Loaded into the Dehydrator
+                *
+                * @type {?Date}
+                * @public
+                */
+            loadedTimestamp: Date | null;
             /**
                 * When this Sample was Started
                 *
@@ -22746,6 +23201,13 @@ declare module '@ricado/api-client/Models/Lab/Site/SampleModel' {
                 * @public
                 */
             finishTimestamp: Date | null;
+            /**
+                * When this Sample was Unloaded from the Dehydrator
+                *
+                * @type {?Date}
+                * @public
+                */
+            unloadedTimestamp: Date | null;
             /**
                 * When this Sample was Published
                 *

package/package.json

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

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

@@ -155,7 +155,7 @@ export default FruitProfileController;
  * The Create Data for a Fruit Profile
  * 
  * @typedef {Object} FruitProfileController.CreateData
- * @property {string} [name] The Fruit Profile Name
+ * @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
@@ -170,6 +170,7 @@ export default FruitProfileController;
  * The Update Data for a Fruit Profile
  * 
  * @typedef {Object} FruitProfileController.UpdateData
+ * @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