@ricado/api-client 2.4.1 → 2.5.0

package/package.json

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

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

@@ -155,14 +155,15 @@ 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
- * @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
+ * @property {number} minimumWithinTargetDuration The Minimum Duration (in seconds) that a Sample should be within the Min and Max Target Temperatures to be Compliant
+ * @property {number} minimumTotalDuration The Minimum Duration (in seconds) that a Sample must be Dehydrated for to be Compliant
+ * @property {number} maximumTotalDuration The Maximum Duration (in seconds) that a Sample can be Dehydrated for before it is Considered Non-Compliant
+ * @property {number} minimumTargetTemperature The Minimum Target Temperature for a Sample to be Compliant
+ * @property {number} maximumTargetTemperature The Maximum Target Temperature for a Sample to be Compliant
  * @memberof Controllers.Lab.Site
  */
 
@@ -170,12 +171,14 @@ 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
- * @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
+ * @property {number} [minimumWithinTargetDuration] The Minimum Duration (in seconds) that a Sample should be within the Min and Max Target Temperatures to be Compliant
+ * @property {number} [minimumTotalDuration] The Minimum Duration (in seconds) that a Sample must be Dehydrated for to be Compliant
+ * @property {number} [maximumTotalDuration] The Maximum Duration (in seconds) that a Sample can be Dehydrated for before it is Considered Non-Compliant
+ * @property {number} [minimumTargetTemperature] The Minimum Target Temperature for a Sample to be Compliant
+ * @property {number} [maximumTargetTemperature] The Maximum Target Temperature for a Sample to be Compliant
  * @memberof Controllers.Lab.Site
  */