@ricado/api-client 2.4.2 → 2.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (29) hide show
  1. package/dist/ricado.api.client.js +1 -1
  2. package/lib/Controllers/Lab/Site/FruitProfileController.js +10 -8
  3. package/lib/Controllers/Lab/Site/RackPositionController.js +2 -2
  4. package/lib/Controllers/Lab/Site/SampleController.js +7 -15
  5. package/lib/Controllers/Lab/Site/SampleResultController.js +29 -27
  6. package/lib/Controllers/Lab/Site/index.js +0 -3
  7. package/lib/Models/Lab/Site/FruitProfileModel.js +22 -4
  8. package/lib/Models/Lab/Site/RackPositionModel.js +67 -15
  9. package/lib/Models/Lab/Site/SampleModel.js +9 -75
  10. package/lib/Models/Lab/Site/SampleResultModel.js +45 -23
  11. package/lib/Models/Lab/Site/index.js +0 -3
  12. package/lib/PackageVersion.js +1 -1
  13. package/lib/index.d.ts +119 -309
  14. package/package.json +1 -1
  15. package/src/Controllers/Lab/Site/FruitProfileController.js +10 -8
  16. package/src/Controllers/Lab/Site/RackPositionController.js +2 -2
  17. package/src/Controllers/Lab/Site/SampleController.js +7 -15
  18. package/src/Controllers/Lab/Site/SampleResultController.js +29 -27
  19. package/src/Controllers/Lab/Site/index.js +0 -2
  20. package/src/Models/Lab/Site/FruitProfileModel.js +24 -4
  21. package/src/Models/Lab/Site/RackPositionModel.js +87 -15
  22. package/src/Models/Lab/Site/SampleModel.js +9 -84
  23. package/src/Models/Lab/Site/SampleResultModel.js +48 -23
  24. package/src/Models/Lab/Site/index.js +0 -2
  25. package/src/PackageVersion.js +1 -1
  26. package/lib/Controllers/Lab/Site/SampleFailureReasonController.js +0 -193
  27. package/lib/Models/Lab/Site/SampleFailureReasonModel.js +0 -195
  28. package/src/Controllers/Lab/Site/SampleFailureReasonController.js +0 -170
  29. package/src/Models/Lab/Site/SampleFailureReasonModel.js +0 -170
package/lib/index.d.ts CHANGED
@@ -3162,7 +3162,6 @@ declare module '@ricado/api-client/Controllers/Lab/Site' {
3162
3162
  export { RackController };
3163
3163
  export { RackPositionController };
3164
3164
  export { SampleController };
3165
- export { SampleFailureReasonController };
3166
3165
  export { SampleResultController };
3167
3166
  }
3168
3167
  import DehydratorController from "@ricado/api-client/Controllers/Lab/Site/DehydratorController";
@@ -3172,7 +3171,6 @@ declare module '@ricado/api-client/Controllers/Lab/Site' {
3172
3171
  import RackController from "@ricado/api-client/Controllers/Lab/Site/RackController";
3173
3172
  import RackPositionController from "@ricado/api-client/Controllers/Lab/Site/RackPositionController";
3174
3173
  import SampleController from "@ricado/api-client/Controllers/Lab/Site/SampleController";
3175
- import SampleFailureReasonController from "@ricado/api-client/Controllers/Lab/Site/SampleFailureReasonController";
3176
3174
  import SampleResultController from "@ricado/api-client/Controllers/Lab/Site/SampleResultController";
3177
3175
  }
3178
3176
 
@@ -6001,7 +5999,6 @@ declare module '@ricado/api-client/Models/Lab/Site' {
6001
5999
  export { ProbeCalibrationModel };
6002
6000
  export { RackModel };
6003
6001
  export { RackPositionModel };
6004
- export { SampleFailureReasonModel };
6005
6002
  export { SampleModel };
6006
6003
  export { SampleResultModel };
6007
6004
  }
@@ -6011,7 +6008,6 @@ declare module '@ricado/api-client/Models/Lab/Site' {
6011
6008
  import ProbeCalibrationModel from "@ricado/api-client/Models/Lab/Site/ProbeCalibrationModel";
6012
6009
  import RackModel from "@ricado/api-client/Models/Lab/Site/RackModel";
6013
6010
  import RackPositionModel from "@ricado/api-client/Models/Lab/Site/RackPositionModel";
6014
- import SampleFailureReasonModel from "@ricado/api-client/Models/Lab/Site/SampleFailureReasonModel";
6015
6011
  import SampleModel from "@ricado/api-client/Models/Lab/Site/SampleModel";
6016
6012
  import SampleResultModel from "@ricado/api-client/Models/Lab/Site/SampleResultModel";
6017
6013
  }
@@ -6915,19 +6911,23 @@ declare module '@ricado/api-client/Controllers/Lab/Site/FruitProfileController'
6915
6911
  */
6916
6912
  nominalWarmUpDuration: number;
6917
6913
  /**
6918
- * The Minimum Duration (in seconds) that a Sample should be within the Min and Max Target Temperatures be Successful
6914
+ * The Minimum Duration (in seconds) that a Sample should be within the Min and Max Target Temperatures to be Compliant
6919
6915
  */
6920
6916
  minimumWithinTargetDuration: number;
6921
6917
  /**
6922
- * The Maximum Duration (in seconds) that a Sample should be Dehydrated for before it Fails
6918
+ * The Minimum Duration (in seconds) that a Sample must be Dehydrated for to be Compliant
6919
+ */
6920
+ minimumTotalDuration: number;
6921
+ /**
6922
+ * The Maximum Duration (in seconds) that a Sample can be Dehydrated for before it is Considered Non-Compliant
6923
6923
  */
6924
6924
  maximumTotalDuration: number;
6925
6925
  /**
6926
- * The Minimum Target Temperature for a Sample to be Successful
6926
+ * The Minimum Target Temperature for a Sample to be Compliant
6927
6927
  */
6928
6928
  minimumTargetTemperature: number;
6929
6929
  /**
6930
- * The Maximum Target Temperature for a Sample to be Successful
6930
+ * The Maximum Target Temperature for a Sample to be Compliant
6931
6931
  */
6932
6932
  maximumTargetTemperature: number;
6933
6933
  };
@@ -6952,19 +6952,23 @@ declare module '@ricado/api-client/Controllers/Lab/Site/FruitProfileController'
6952
6952
  */
6953
6953
  nominalWarmUpDuration?: number;
6954
6954
  /**
6955
- * The Minimum Duration (in seconds) that a Sample should be within the Min and Max Target Temperatures be Successful
6955
+ * The Minimum Duration (in seconds) that a Sample should be within the Min and Max Target Temperatures to be Compliant
6956
6956
  */
6957
6957
  minimumWithinTargetDuration?: number;
6958
6958
  /**
6959
- * The Maximum Duration (in seconds) that a Sample should be Dehydrated for before it Fails
6959
+ * The Minimum Duration (in seconds) that a Sample must be Dehydrated for to be Compliant
6960
+ */
6961
+ minimumTotalDuration?: number;
6962
+ /**
6963
+ * The Maximum Duration (in seconds) that a Sample can be Dehydrated for before it is Considered Non-Compliant
6960
6964
  */
6961
6965
  maximumTotalDuration?: number;
6962
6966
  /**
6963
- * The Minimum Target Temperature for a Sample to be Successful
6967
+ * The Minimum Target Temperature for a Sample to be Compliant
6964
6968
  */
6965
6969
  minimumTargetTemperature?: number;
6966
6970
  /**
6967
- * The Maximum Target Temperature for a Sample to be Successful
6971
+ * The Maximum Target Temperature for a Sample to be Compliant
6968
6972
  */
6969
6973
  maximumTargetTemperature?: number;
6970
6974
  };
@@ -7717,16 +7721,20 @@ declare module '@ricado/api-client/Controllers/Lab/Site/RackPositionController'
7717
7721
  currentSampleId: number;
7718
7722
  currentSampleStatus: number;
7719
7723
  nextSampleId: number;
7724
+ loadCurrentSampleRequest: number;
7720
7725
  startCurrentSampleRequest: number;
7721
7726
  finishCurrentSampleRequest: number;
7727
+ unloadCurrentSampleRequest: number;
7722
7728
  currentSampleTotalDuration: number;
7723
7729
  currentSampleWarmUpDuration: number;
7730
+ currentSampleWarmUpRateOfChange: number;
7731
+ currentSampleWarmUpWarning: number;
7724
7732
  currentSampleWarmUpCompleted: number;
7725
7733
  currentSampleBelowTargetDuration: number;
7726
7734
  currentSampleAboveTargetDuration: number;
7727
7735
  currentSampleWithinTargetDuration: number;
7728
- currentSampleSuccessCriteriaMet: number;
7729
- currentSampleFailureCriteriaMet: number;
7736
+ currentSampleFinishCriteriaMet: number;
7737
+ currentSampleLatestUnloadTimestamp: number;
7730
7738
  };
7731
7739
  /**
7732
7740
  * The Lab that owns this Rack Position
@@ -7765,16 +7773,20 @@ declare module '@ricado/api-client/Controllers/Lab/Site/RackPositionController'
7765
7773
  currentSampleId: number;
7766
7774
  currentSampleStatus: number;
7767
7775
  nextSampleId: number;
7776
+ loadCurrentSampleRequest: number;
7768
7777
  startCurrentSampleRequest: number;
7769
7778
  finishCurrentSampleRequest: number;
7779
+ unloadCurrentSampleRequest: number;
7770
7780
  currentSampleTotalDuration: number;
7771
7781
  currentSampleWarmUpDuration: number;
7782
+ currentSampleWarmUpRateOfChange: number;
7783
+ currentSampleWarmUpWarning: number;
7772
7784
  currentSampleWarmUpCompleted: number;
7773
7785
  currentSampleBelowTargetDuration: number;
7774
7786
  currentSampleAboveTargetDuration: number;
7775
7787
  currentSampleWithinTargetDuration: number;
7776
- currentSampleSuccessCriteriaMet: number;
7777
- currentSampleFailureCriteriaMet: number;
7788
+ currentSampleFinishCriteriaMet: number;
7789
+ currentSampleLatestUnloadTimestamp: number;
7778
7790
  };
7779
7791
  /**
7780
7792
  * The Lab that owns this Rack Position
@@ -7964,17 +7976,13 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleController' {
7964
7976
  */
7965
7977
  createdSource?: string;
7966
7978
  /**
7967
- * ID of the User who Created this Sample. Only applies if the `createdSource` is 'User'
7968
- */
7969
- createdUserId?: string | null;
7970
- /**
7971
- * Name of the User who Created this Sample. Only applies if the `createdSource` is 'User'
7979
+ * Name of the User who Created this Sample
7972
7980
  */
7973
7981
  createdUserName?: string | null;
7974
7982
  /**
7975
- * ID of the User who Published this Sample
7983
+ * The Source that Published this Sample
7976
7984
  */
7977
- publishUserId?: string | null;
7985
+ publishSource?: string | null;
7978
7986
  /**
7979
7987
  * Name of the User who Published this Sample
7980
7988
  */
@@ -7991,14 +7999,6 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleController' {
7991
7999
  * The Dehydrator used for this Sample
7992
8000
  */
7993
8001
  dehydratorId?: string;
7994
- /**
7995
- * The Outcome of this Sample
7996
- */
7997
- outcome?: string | null;
7998
- /**
7999
- * A Sample Failure Reason ID if this Sample Failed
8000
- */
8001
- failureReasonId?: string | null;
8002
8002
  /**
8003
8003
  * The Sample Result ID asociated with this Sample
8004
8004
  */
@@ -8067,6 +8067,10 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleController' {
8067
8067
  * Filter by the Timestamp when Samples were last Updated. Results Less than or Equal to Timestamp
8068
8068
  */
8069
8069
  updateTimestampEnd?: Date;
8070
+ /**
8071
+ * Filter by Published State of a Sample. `true` = Published, `false` = Not Published
8072
+ */
8073
+ publishedState?: boolean;
8070
8074
  };
8071
8075
  /**
8072
8076
  * The Create Data for a Sample
@@ -8089,11 +8093,7 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleController' {
8089
8093
  */
8090
8094
  createdSource: string;
8091
8095
  /**
8092
- * ID of the User who Created this Sample. Only applies if the `createdSource` is 'User'
8093
- */
8094
- createdUserId?: string | null;
8095
- /**
8096
- * Name of the User who Created this Sample. Only applies if the `createdSource` is 'User'
8096
+ * Name of the User who Created this Sample
8097
8097
  */
8098
8098
  createdUserName?: string | null;
8099
8099
  /**
@@ -8121,9 +8121,9 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleController' {
8121
8121
  */
8122
8122
  publishTimestamp?: Date | null;
8123
8123
  /**
8124
- * ID of the User who Published this Sample
8124
+ * The Source that Published this Sample
8125
8125
  */
8126
- publishUserId?: string | null;
8126
+ publishSource?: string | null;
8127
8127
  /**
8128
8128
  * Name of the User who Published this Sample
8129
8129
  */
@@ -8140,14 +8140,6 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleController' {
8140
8140
  * The Dehydrator used for this Sample
8141
8141
  */
8142
8142
  dehydratorId: string;
8143
- /**
8144
- * The Outcome of this Sample
8145
- */
8146
- outcome?: string | null;
8147
- /**
8148
- * A Sample Failure Reason ID if this Sample Failed
8149
- */
8150
- failureReasonId?: string | null;
8151
8143
  /**
8152
8144
  * The Sample Result ID asociated with this Sample
8153
8145
  */
@@ -8170,11 +8162,7 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleController' {
8170
8162
  */
8171
8163
  createdSource?: string;
8172
8164
  /**
8173
- * ID of the User who Created this Sample. Only applies if the `createdSource` is 'User'
8174
- */
8175
- createdUserId?: string | null;
8176
- /**
8177
- * Name of the User who Created this Sample. Only applies if the `createdSource` is 'User'
8165
+ * Name of the User who Created this Sample
8178
8166
  */
8179
8167
  createdUserName?: string | null;
8180
8168
  /**
@@ -8202,9 +8190,9 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleController' {
8202
8190
  */
8203
8191
  publishTimestamp?: Date | null;
8204
8192
  /**
8205
- * ID of the User who Published this Sample
8193
+ * The Source that Published this Sample
8206
8194
  */
8207
- publishUserId?: string | null;
8195
+ publishSource?: string | null;
8208
8196
  /**
8209
8197
  * Name of the User who Published this Sample
8210
8198
  */
@@ -8221,14 +8209,6 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleController' {
8221
8209
  * The Dehydrator used for this Sample
8222
8210
  */
8223
8211
  dehydratorId?: string;
8224
- /**
8225
- * The Outcome of this Sample
8226
- */
8227
- outcome?: string | null;
8228
- /**
8229
- * A Sample Failure Reason ID if this Sample Failed
8230
- */
8231
- failureReasonId?: string | null;
8232
8212
  /**
8233
8213
  * The Sample Result ID asociated with this Sample
8234
8214
  */
@@ -8291,166 +8271,66 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleController' {
8291
8271
  import SampleResultModel from "@ricado/api-client/Models/Lab/Site/SampleResultModel";
8292
8272
  }
8293
8273
 
8294
- declare module '@ricado/api-client/Controllers/Lab/Site/SampleFailureReasonController' {
8295
- export default SampleFailureReasonController;
8296
- /**
8297
- * Controller Class for Sample Failure Reasons
8298
- *
8299
- * @class
8300
- */
8301
- class SampleFailureReasonController {
8302
- /**
8303
- * Retrieve a Sample Failure Reason [GET /lab/sites/{siteId}/sample-failure-reasons/{id}]
8304
- *
8305
- * @static
8306
- * @public
8307
- * @param {number} siteId The Site ID
8308
- * @param {string} id The Sample Failure Reason ID
8309
- * @return {Promise<SampleFailureReasonModel>}
8310
- */
8311
- static getOne(siteId: number, id: string): Promise<SampleFailureReasonModel>;
8312
- /**
8313
- * Update a Sample Failure Reason [PATCH /lab/sites/{siteId}/sample-failure-reasons/{id}]
8314
- *
8315
- * @static
8316
- * @public
8317
- * @param {number} siteId The Site ID
8318
- * @param {string} id The Sample Failure Reason ID
8319
- * @param {SampleFailureReasonController.UpdateData} updateData The Sample Failure Reason Update Data
8320
- * @return {Promise<SampleFailureReasonModel>}
8321
- */
8322
- static update(siteId: number, id: string, updateData: SampleFailureReasonController.UpdateData): Promise<SampleFailureReasonModel>;
8323
- /**
8324
- * Delete a Sample Failure Reason [DELETE /lab/sites/{siteId}/sample-failure-reasons/{id}]
8325
- *
8326
- * @static
8327
- * @public
8328
- * @param {number} siteId The Site ID
8329
- * @param {string} id The Sample Failure Reason ID
8330
- * @return {Promise<boolean>}
8331
- */
8332
- static delete(siteId: number, id: string): Promise<boolean>;
8333
- /**
8334
- * List all Sample Failure Reasons [GET /lab/sites/{siteId}/sample-failure-reasons]
8335
- *
8336
- * @static
8337
- * @public
8338
- * @param {number} siteId The Site ID
8339
- * @param {SampleFailureReasonController.GetAllQueryParameters} [queryParameters] The Optional Query Parameters
8340
- * @return {Promise<SampleFailureReasonModel[]>}
8341
- */
8342
- static getAll(siteId: number, queryParameters?: SampleFailureReasonController.GetAllQueryParameters | undefined): Promise<SampleFailureReasonModel[]>;
8343
- /**
8344
- * Create a Sample Failure Reason [POST /lab/sites/{siteId}/sample-failure-reasons]
8345
- *
8346
- * @static
8347
- * @public
8348
- * @param {number} siteId The Site ID
8349
- * @param {SampleFailureReasonController.CreateData} createData The Sample Failure Reason Create Data
8350
- * @return {Promise<SampleFailureReasonModel>}
8351
- */
8352
- static create(siteId: number, createData: SampleFailureReasonController.CreateData): Promise<SampleFailureReasonModel>;
8353
- }
8354
- namespace SampleFailureReasonController {
8355
- /**
8356
- * The Optional Query Parameters for the getAll Function
8357
- */
8358
- export type GetAllQueryParameters = {
8359
- /**
8360
- * The Sample Failure Reason Name
8361
- */
8362
- name?: string;
8363
- };
8364
- /**
8365
- * The Create Data for a Sample Failure Reason
8366
- */
8367
- export type CreateData = {
8368
- /**
8369
- * The Sample Failure Reason Name
8370
- */
8371
- name: string;
8372
- /**
8373
- * The Sample Failure Reason Description
8374
- */
8375
- description: string;
8376
- };
8377
- /**
8378
- * The Update Data for a Sample Failure Reason
8379
- */
8380
- export type UpdateData = {
8381
- /**
8382
- * The Sample Failure Reason Name
8383
- */
8384
- name?: string;
8385
- /**
8386
- * The Sample Failure Reason Description
8387
- */
8388
- description?: string;
8389
- };
8390
- }
8391
- import SampleFailureReasonModel from "@ricado/api-client/Models/Lab/Site/SampleFailureReasonModel";
8392
- }
8393
-
8394
8274
  declare module '@ricado/api-client/Controllers/Lab/Site/SampleResultController' {
8395
8275
  export default SampleResultController;
8396
8276
  /**
8397
- * Controller Class for Sample Resultss
8277
+ * Controller Class for Sample Results
8398
8278
  *
8399
8279
  * @class
8400
8280
  */
8401
8281
  class SampleResultController {
8402
8282
  /**
8403
- * Retrieve a Sample Results [GET /lab/sites/{siteId}/sample-results/{id}]
8283
+ * Retrieve a Sample Result [GET /lab/sites/{siteId}/sample-results/{id}]
8404
8284
  *
8405
8285
  * @static
8406
8286
  * @public
8407
8287
  * @param {number} siteId The Site ID
8408
- * @param {string} id The Sample Results ID
8288
+ * @param {string} id The Sample Result ID
8409
8289
  * @return {Promise<SampleResultModel>}
8410
8290
  */
8411
8291
  static getOne(siteId: number, id: string): Promise<SampleResultModel>;
8412
8292
  /**
8413
- * Update a Sample Results [PATCH /lab/sites/{siteId}/sample-results/{id}]
8293
+ * Update a Sample Result [PATCH /lab/sites/{siteId}/sample-results/{id}]
8414
8294
  *
8415
8295
  * @static
8416
8296
  * @public
8417
8297
  * @param {number} siteId The Site ID
8418
- * @param {string} id The Sample Results ID
8419
- * @param {SampleResultController.UpdateData} updateData The Sample Results Update Data
8298
+ * @param {string} id The Sample Result ID
8299
+ * @param {SampleResultController.UpdateData} updateData The Sample Result Update Data
8420
8300
  * @return {Promise<SampleResultModel>}
8421
8301
  */
8422
8302
  static update(siteId: number, id: string, updateData: SampleResultController.UpdateData): Promise<SampleResultModel>;
8423
8303
  /**
8424
- * Delete a Sample Results [DELETE /lab/sites/{siteId}/sample-results/{id}]
8304
+ * Delete a Sample Result [DELETE /lab/sites/{siteId}/sample-results/{id}]
8425
8305
  *
8426
8306
  * @static
8427
8307
  * @public
8428
8308
  * @param {number} siteId The Site ID
8429
- * @param {string} id The Sample Results ID
8309
+ * @param {string} id The Sample Result ID
8430
8310
  * @return {Promise<boolean>}
8431
8311
  */
8432
8312
  static delete(siteId: number, id: string): Promise<boolean>;
8433
8313
  /**
8434
8314
  * Retrieve Comments [GET /lab/sites/{siteId}/sample-results/{id}/comments]
8435
8315
  *
8436
- * Retrieves Comments for a Sample Results
8316
+ * Retrieves Comments for a Sample Result
8437
8317
  *
8438
8318
  * @static
8439
8319
  * @public
8440
8320
  * @param {number} siteId The Site ID
8441
- * @param {string} id The Sample Results ID
8321
+ * @param {string} id The Sample Result ID
8442
8322
  * @return {Promise<Array<SampleResultController.CommentItem>>}
8443
8323
  */
8444
8324
  static getComments(siteId: number, id: string): Promise<Array<SampleResultController.CommentItem>>;
8445
8325
  /**
8446
8326
  * Create a Comment [POST /lab/sites/{siteId}/sample-results/{id}/comments]
8447
8327
  *
8448
- * Create a Comment for a Sample Results
8328
+ * Create a Comment for a Sample Result
8449
8329
  *
8450
8330
  * @static
8451
8331
  * @public
8452
8332
  * @param {number} siteId The Site ID
8453
- * @param {string} id The Sample Results ID
8333
+ * @param {string} id The Sample Result ID
8454
8334
  * @param {string} content The Content of the New Comment
8455
8335
  * @return {Promise<SampleResultController.CommentItem>}
8456
8336
  */
@@ -8458,12 +8338,12 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleResultController'
8458
8338
  /**
8459
8339
  * Retrieve a Comment [GET /lab/sites/{siteId}/sample-results/{id}/comments/{commentId}]
8460
8340
  *
8461
- * Retrieves Comments for a Sample Results
8341
+ * Retrieves Comments for a Sample Result
8462
8342
  *
8463
8343
  * @static
8464
8344
  * @public
8465
8345
  * @param {number} siteId The Site ID
8466
- * @param {string} id The Sample Results ID
8346
+ * @param {string} id The Sample Result ID
8467
8347
  * @param {string} commentId The Comment ID
8468
8348
  * @return {Promise<SampleResultController.CommentItem>}
8469
8349
  */
@@ -8471,12 +8351,12 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleResultController'
8471
8351
  /**
8472
8352
  * Update a Comment [PATCH /lab/sites/{siteId}/sample-results/{id}/comments/{commentId}]
8473
8353
  *
8474
- * Update a Comment for a Sample Results
8354
+ * Update a Comment for a Sample Result
8475
8355
  *
8476
8356
  * @static
8477
8357
  * @public
8478
8358
  * @param {number} siteId The Site ID
8479
- * @param {string} id The Sample Results ID
8359
+ * @param {string} id The Sample Result ID
8480
8360
  * @param {string} commentId The Comment ID
8481
8361
  * @param {string} content The Updated Content for the Comment
8482
8362
  * @return {Promise<SampleResultController.CommentItem>}
@@ -8485,18 +8365,18 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleResultController'
8485
8365
  /**
8486
8366
  * Delete a Comment [DELETE /lab/sites/{siteId}/sample-results/{id}/comments/{commentId}]
8487
8367
  *
8488
- * Delete a Comment for a Sample Results
8368
+ * Delete a Comment for a Sample Result
8489
8369
  *
8490
8370
  * @static
8491
8371
  * @public
8492
8372
  * @param {number} siteId The Site ID
8493
- * @param {string} id The Sample Results ID
8373
+ * @param {string} id The Sample Result ID
8494
8374
  * @param {string} commentId The Comment ID
8495
8375
  * @return {Promise<boolean>}
8496
8376
  */
8497
8377
  static deleteOneComment(siteId: number, id: string, commentId: string): Promise<boolean>;
8498
8378
  /**
8499
- * List all Sample Resultss [GET /lab/sites/{siteId}/sample-results]
8379
+ * List all Sample Results [GET /lab/sites/{siteId}/sample-results]
8500
8380
  *
8501
8381
  * @static
8502
8382
  * @public
@@ -8506,12 +8386,12 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleResultController'
8506
8386
  */
8507
8387
  static getAll(siteId: number, queryParameters?: SampleResultController.GetAllQueryParameters | undefined): Promise<SampleResultModel[]>;
8508
8388
  /**
8509
- * Create a Sample Results [POST /lab/sites/{siteId}/sample-results]
8389
+ * Create a Sample Result [POST /lab/sites/{siteId}/sample-results]
8510
8390
  *
8511
8391
  * @static
8512
8392
  * @public
8513
8393
  * @param {number} siteId The Site ID
8514
- * @param {SampleResultController.CreateData} createData The Sample Results Create Data
8394
+ * @param {SampleResultController.CreateData} createData The Sample Result Create Data
8515
8395
  * @return {Promise<SampleResultModel>}
8516
8396
  */
8517
8397
  static create(siteId: number, createData: SampleResultController.CreateData): Promise<SampleResultModel>;
@@ -8539,7 +8419,7 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleResultController'
8539
8419
  createdTimestampEnd?: Date;
8540
8420
  };
8541
8421
  /**
8542
- * The Create Data for a Sample Results
8422
+ * The Create Data for a Sample Result
8543
8423
  */
8544
8424
  export type CreateData = {
8545
8425
  /**
@@ -8579,17 +8459,21 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleResultController'
8579
8459
  */
8580
8460
  withinTargetDuration: number;
8581
8461
  /**
8582
- * Timestamp of when the Success Criteria was Met for the Sample - `null` if not Met
8462
+ * Timestamp of when the Finish Criteria was Met for the Sample - `null` if not Met
8583
8463
  */
8584
- successCriteriaMetTimestamp?: Date | null;
8464
+ finishCriteriaMetTimestamp?: Date | null;
8585
8465
  /**
8586
- * Timestamp of when the Failure Criteria was Met for the Sample - `null` if not Met
8466
+ * Latest Possible Timestamp of when the Sample should have been Unloaded to remain Compliant
8587
8467
  */
8588
- failureCriteriaMetTimestamp?: Date | null;
8468
+ latestUnloadTimestamp?: Date | null;
8589
8469
  /**
8590
8470
  * The Average Temperature for the Total Duration of the Sample
8591
8471
  */
8592
8472
  totalAverageTemperature?: number | null;
8473
+ /**
8474
+ * The Average Temperature Rate-of-Change seen during the Warm Up process for the Sample
8475
+ */
8476
+ warmUpRateOfChangeTemperature?: number | null;
8593
8477
  /**
8594
8478
  * The Minimum Temperature seen Below the Temperature Target for the Sample
8595
8479
  */
@@ -8620,7 +8504,7 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleResultController'
8620
8504
  withinTargetAverageTemperature?: number | null;
8621
8505
  };
8622
8506
  /**
8623
- * The Update Data for a Sample Results
8507
+ * The Update Data for a Sample Result
8624
8508
  */
8625
8509
  export type UpdateData = {
8626
8510
  /**
@@ -8656,17 +8540,21 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleResultController'
8656
8540
  */
8657
8541
  withinTargetDuration?: number;
8658
8542
  /**
8659
- * Timestamp of when the Success Criteria was Met for the Sample - `null` if not Met
8543
+ * Timestamp of when the Finish Criteria was Met for the Sample - `null` if not Met
8660
8544
  */
8661
- successCriteriaMetTimestamp?: Date | null;
8545
+ finishCriteriaMetTimestamp?: Date | null;
8662
8546
  /**
8663
- * Timestamp of when the Failure Criteria was Met for the Sample - `null` if not Met
8547
+ * Latest Possible Timestamp of when the Sample should have been Unloaded to remain Compliant
8664
8548
  */
8665
- failureCriteriaMetTimestamp?: Date | null;
8549
+ latestUnloadTimestamp?: Date | null;
8666
8550
  /**
8667
8551
  * The Average Temperature for the Total Duration of the Sample
8668
8552
  */
8669
8553
  totalAverageTemperature?: number | null;
8554
+ /**
8555
+ * The Average Temperature Rate-of-Change seen during the Warm Up process for the Sample
8556
+ */
8557
+ warmUpRateOfChangeTemperature?: number | null;
8670
8558
  /**
8671
8559
  * The Minimum Temperature seen Below the Temperature Target for the Sample
8672
8560
  */
@@ -22482,28 +22370,35 @@ declare module '@ricado/api-client/Models/Lab/Site/FruitProfileModel' {
22482
22370
  */
22483
22371
  nominalWarmUpDuration: number;
22484
22372
  /**
22485
- * The Minimum Duration (in seconds) that a Sample should be within the Min and Max Target Temperatures be Successful
22373
+ * The Minimum Duration (in seconds) that a Sample should be within the Min and Max Target Temperatures to be Compliant
22486
22374
  *
22487
22375
  * @type {number}
22488
22376
  * @public
22489
22377
  */
22490
22378
  minimumWithinTargetDuration: number;
22491
22379
  /**
22492
- * The Maximum Duration (in seconds) that a Sample should be Dehydrated for before it Fails
22380
+ * The Minimum Duration (in seconds) that a Sample must be Dehydrated for to be Compliant
22381
+ *
22382
+ * @type {number}
22383
+ * @public
22384
+ */
22385
+ minimumTotalDuration: number;
22386
+ /**
22387
+ * The Maximum Duration (in seconds) that a Sample can be Dehydrated for before it is Considered Non-Compliant
22493
22388
  *
22494
22389
  * @type {number}
22495
22390
  * @public
22496
22391
  */
22497
22392
  maximumTotalDuration: number;
22498
22393
  /**
22499
- * The Minimum Target Temperature for a Sample to be Successful
22394
+ * The Minimum Target Temperature for a Sample to be Compliant
22500
22395
  *
22501
22396
  * @type {number}
22502
22397
  * @public
22503
22398
  */
22504
22399
  minimumTargetTemperature: number;
22505
22400
  /**
22506
- * The Maximum Target Temperature for a Sample to be Successful
22401
+ * The Maximum Target Temperature for a Sample to be Compliant
22507
22402
  *
22508
22403
  * @type {number}
22509
22404
  * @public
@@ -22944,7 +22839,7 @@ declare module '@ricado/api-client/Models/Lab/Site/RackPositionModel' {
22944
22839
  /**
22945
22840
  * The Points used by this Rack Position
22946
22841
  *
22947
- * @type {{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}}
22842
+ * @type {{pushButton: number, indicatorLight: number, temperature: number, calibrationOffset: number, disabled: number, currentSampleId: number, currentSampleStatus: number, nextSampleId: number, loadCurrentSampleRequest: number, startCurrentSampleRequest: number, finishCurrentSampleRequest: number, unloadCurrentSampleRequest: number, currentSampleTotalDuration: number, currentSampleWarmUpDuration: number, currentSampleWarmUpRateOfChange: number, currentSampleWarmUpWarning: number, currentSampleWarmUpCompleted: number, currentSampleBelowTargetDuration: number, currentSampleAboveTargetDuration: number, currentSampleWithinTargetDuration: number, currentSampleFinishCriteriaMet: number, currentSampleLatestUnloadTimestamp: number}}
22948
22843
  * @public
22949
22844
  */
22950
22845
  points: {
@@ -22956,16 +22851,20 @@ declare module '@ricado/api-client/Models/Lab/Site/RackPositionModel' {
22956
22851
  currentSampleId: number;
22957
22852
  currentSampleStatus: number;
22958
22853
  nextSampleId: number;
22854
+ loadCurrentSampleRequest: number;
22959
22855
  startCurrentSampleRequest: number;
22960
22856
  finishCurrentSampleRequest: number;
22857
+ unloadCurrentSampleRequest: number;
22961
22858
  currentSampleTotalDuration: number;
22962
22859
  currentSampleWarmUpDuration: number;
22860
+ currentSampleWarmUpRateOfChange: number;
22861
+ currentSampleWarmUpWarning: number;
22963
22862
  currentSampleWarmUpCompleted: number;
22964
22863
  currentSampleBelowTargetDuration: number;
22965
22864
  currentSampleAboveTargetDuration: number;
22966
22865
  currentSampleWithinTargetDuration: number;
22967
- currentSampleSuccessCriteriaMet: number;
22968
- currentSampleFailureCriteriaMet: number;
22866
+ currentSampleFinishCriteriaMet: number;
22867
+ currentSampleLatestUnloadTimestamp: number;
22969
22868
  };
22970
22869
  /**
22971
22870
  * The Lab that owns this Rack Position
@@ -23020,81 +22919,6 @@ declare module '@ricado/api-client/Models/Lab/Site/RackPositionModel' {
23020
22919
  import BaseModel from "@ricado/api-client/Models/BaseModel";
23021
22920
  }
23022
22921
 
23023
- declare module '@ricado/api-client/Models/Lab/Site/SampleFailureReasonModel' {
23024
- export default SampleFailureReasonModel;
23025
- /**
23026
- * Model Class for a Sample Failure Reason
23027
- *
23028
- * @class
23029
- * @hideconstructor
23030
- * @extends BaseModel
23031
- */
23032
- class SampleFailureReasonModel extends BaseModel {
23033
- /**
23034
- * Create a new **SampleFailureReasonModel** from a JSON Object or JSON String
23035
- *
23036
- * @static
23037
- * @public
23038
- * @param {Object<string, any>|string} json A JSON Object or JSON String
23039
- * @param {number} siteId The Site ID associated with this Sample Failure Reason
23040
- * @return {SampleFailureReasonModel}
23041
- */
23042
- static fromJSON(json: {
23043
- [x: string]: any;
23044
- } | string, siteId: number): SampleFailureReasonModel;
23045
- /**
23046
- * SampleFailureReasonModel Constructor
23047
- *
23048
- * @protected
23049
- * @param {number} siteId The Site ID associated with this Sample Failure Reason
23050
- */
23051
- protected constructor();
23052
- /**
23053
- * The Sample Failure Reason ID
23054
- *
23055
- * @type {string}
23056
- * @public
23057
- */
23058
- id: string;
23059
- /**
23060
- * The Sample Failure Reason Name
23061
- *
23062
- * @type {string}
23063
- * @public
23064
- */
23065
- name: string;
23066
- /**
23067
- * The Sample Failure Reason Description
23068
- *
23069
- * @type {string}
23070
- * @public
23071
- */
23072
- description: string;
23073
- /**
23074
- * Whether the Sample Failure Reason has been deleted
23075
- *
23076
- * @type {boolean}
23077
- * @public
23078
- */
23079
- deleted: boolean;
23080
- /**
23081
- * When the Sample Failure Reason was last updated
23082
- *
23083
- * @type {Date}
23084
- * @public
23085
- */
23086
- updateTimestamp: Date;
23087
- /**
23088
- * The Site ID associated with this Sample Failure Reason
23089
- *
23090
- * @type {number}
23091
- * @public
23092
- */
23093
- siteId: number;
23094
- }
23095
- import BaseModel from "@ricado/api-client/Models/BaseModel";
23096
- }
23097
-
23098
22922
  declare module '@ricado/api-client/Models/Lab/Site/SampleModel' {
23099
22923
  export default SampleModel;
23100
22924
  /**
@@ -23160,14 +22984,7 @@ declare module '@ricado/api-client/Models/Lab/Site/SampleModel' {
23160
22984
  */
23161
22985
  createdSource: string;
23162
22986
  /**
23163
- * ID of the User who Created this Sample. Only applies if the `createdSource` is 'User'
23164
- *
23165
- * @type {?string}
23166
- * @public
23167
- */
23168
- createdUserId: string | null;
23169
- /**
23170
- * Name of the User who Created this Sample. Only applies if the `createdSource` is 'User'
22987
+ * Name of the User who Created this Sample
23171
22988
  *
23172
22989
  * @type {?string}
23173
22990
  * @public
@@ -23216,12 +23033,12 @@ declare module '@ricado/api-client/Models/Lab/Site/SampleModel' {
23216
23033
  */
23217
23034
  publishTimestamp: Date | null;
23218
23035
  /**
23219
- * ID of the User who Published this Sample
23036
+ * The Source that Published this Sample
23220
23037
  *
23221
23038
  * @type {?string}
23222
23039
  * @public
23223
23040
  */
23224
- publishUserId: string | null;
23041
+ publishSource: string | null;
23225
23042
  /**
23226
23043
  * Name of the User who Published this Sample
23227
23044
  *
@@ -23250,20 +23067,6 @@ declare module '@ricado/api-client/Models/Lab/Site/SampleModel' {
23250
23067
  * @public
23251
23068
  */
23252
23069
  dehydratorId: string;
23253
- /**
23254
- * The Outcome of this Sample
23255
- *
23256
- * @type {?string}
23257
- * @public
23258
- */
23259
- outcome: string | null;
23260
- /**
23261
- * A Sample Failure Reason ID if this Sample Failed
23262
- *
23263
- * @type {?string}
23264
- * @public
23265
- */
23266
- failureReasonId: string | null;
23267
23070
  /**
23268
23071
  * The Sample Result ID asociated with this Sample
23269
23072
  *
@@ -23306,7 +23109,7 @@ declare module '@ricado/api-client/Models/Lab/Site/SampleModel' {
23306
23109
  declare module '@ricado/api-client/Models/Lab/Site/SampleResultModel' {
23307
23110
  export default SampleResultModel;
23308
23111
  /**
23309
- * Model Class for a Sample Results
23112
+ * Model Class for a Sample Result
23310
23113
  *
23311
23114
  * @class
23312
23115
  * @hideconstructor
@@ -23319,7 +23122,7 @@ declare module '@ricado/api-client/Models/Lab/Site/SampleResultModel' {
23319
23122
  * @static
23320
23123
  * @public
23321
23124
  * @param {Object<string, any>|string} json A JSON Object or JSON String
23322
- * @param {number} siteId The Site ID associated with this Sample Results
23125
+ * @param {number} siteId The Site ID associated with this Sample Result
23323
23126
  * @return {SampleResultModel}
23324
23127
  */
23325
23128
  static fromJSON(json: {
@@ -23329,11 +23132,11 @@ declare module '@ricado/api-client/Models/Lab/Site/SampleResultModel' {
23329
23132
  * SampleResultModel Constructor
23330
23133
  *
23331
23134
  * @protected
23332
- * @param {number} siteId The Site ID associated with this Sample Results
23135
+ * @param {number} siteId The Site ID associated with this Sample Result
23333
23136
  */
23334
23137
  protected constructor();
23335
23138
  /**
23336
- * The Sample Results ID
23139
+ * The Sample Result ID
23337
23140
  *
23338
23141
  * @type {string}
23339
23142
  * @public
@@ -23403,19 +23206,19 @@ declare module '@ricado/api-client/Models/Lab/Site/SampleResultModel' {
23403
23206
  */
23404
23207
  withinTargetDuration: number;
23405
23208
  /**
23406
- * Timestamp of when the Success Criteria was Met for the Sample - `null` if not Met
23209
+ * Timestamp of when the Finish Criteria was Met for the Sample - `null` if not Met
23407
23210
  *
23408
23211
  * @type {?Date}
23409
23212
  * @public
23410
23213
  */
23411
- successCriteriaMetTimestamp: Date | null;
23214
+ finishCriteriaMetTimestamp: Date | null;
23412
23215
  /**
23413
- * Timestamp of when the Failure Criteria was Met for the Sample - `null` if not Met
23216
+ * Latest Possible Timestamp of when the Sample should have been Unloaded to remain Compliant
23414
23217
  *
23415
23218
  * @type {?Date}
23416
23219
  * @public
23417
23220
  */
23418
- failureCriteriaMetTimestamp: Date | null;
23221
+ latestUnloadTimestamp: Date | null;
23419
23222
  /**
23420
23223
  * The Average Temperature for the Total Duration of the Sample
23421
23224
  *
@@ -23423,6 +23226,13 @@ declare module '@ricado/api-client/Models/Lab/Site/SampleResultModel' {
23423
23226
  * @public
23424
23227
  */
23425
23228
  totalAverageTemperature: number | null;
23229
+ /**
23230
+ * The Average Temperature Rate-of-Change seen during the Warm Up process for the Sample
23231
+ *
23232
+ * @type {?number}
23233
+ * @public
23234
+ */
23235
+ warmUpRateOfChangeTemperature: number | null;
23426
23236
  /**
23427
23237
  * The Minimum Temperature seen Below the Temperature Target for the Sample
23428
23238
  *
@@ -23473,21 +23283,21 @@ declare module '@ricado/api-client/Models/Lab/Site/SampleResultModel' {
23473
23283
  */
23474
23284
  withinTargetAverageTemperature: number | null;
23475
23285
  /**
23476
- * Whether the Sample Results has been deleted
23286
+ * Whether the Sample Result has been deleted
23477
23287
  *
23478
23288
  * @type {boolean}
23479
23289
  * @public
23480
23290
  */
23481
23291
  deleted: boolean;
23482
23292
  /**
23483
- * When the Sample Results was last updated
23293
+ * When the Sample Result was last updated
23484
23294
  *
23485
23295
  * @type {Date}
23486
23296
  * @public
23487
23297
  */
23488
23298
  updateTimestamp: Date;
23489
23299
  /**
23490
- * The Site ID associated with this Sample Results
23300
+ * The Site ID associated with this Sample Result
23491
23301
  *
23492
23302
  * @type {number}
23493
23303
  * @public