@ricado/api-client 2.4.2 → 2.5.1

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 (33) 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/LabController.js +5 -2
  4. package/lib/Controllers/Lab/Site/RackPositionController.js +2 -2
  5. package/lib/Controllers/Lab/Site/SampleController.js +7 -15
  6. package/lib/Controllers/Lab/Site/SampleResultController.js +29 -27
  7. package/lib/Controllers/Lab/Site/index.js +0 -3
  8. package/lib/Models/Lab/Site/FruitProfileModel.js +22 -4
  9. package/lib/Models/Lab/Site/LabModel.js +100 -11
  10. package/lib/Models/Lab/Site/RackPositionModel.js +67 -15
  11. package/lib/Models/Lab/Site/SampleModel.js +9 -75
  12. package/lib/Models/Lab/Site/SampleResultModel.js +45 -23
  13. package/lib/Models/Lab/Site/index.js +0 -3
  14. package/lib/PackageVersion.js +1 -1
  15. package/lib/index.d.ts +150 -315
  16. package/package.json +1 -1
  17. package/src/Controllers/Lab/Site/FruitProfileController.js +10 -8
  18. package/src/Controllers/Lab/Site/LabController.js +5 -2
  19. package/src/Controllers/Lab/Site/RackPositionController.js +2 -2
  20. package/src/Controllers/Lab/Site/SampleController.js +7 -15
  21. package/src/Controllers/Lab/Site/SampleResultController.js +29 -27
  22. package/src/Controllers/Lab/Site/index.js +0 -2
  23. package/src/Models/Lab/Site/FruitProfileModel.js +24 -4
  24. package/src/Models/Lab/Site/LabModel.js +132 -11
  25. package/src/Models/Lab/Site/RackPositionModel.js +87 -15
  26. package/src/Models/Lab/Site/SampleModel.js +9 -84
  27. package/src/Models/Lab/Site/SampleResultModel.js +48 -23
  28. package/src/Models/Lab/Site/index.js +0 -2
  29. package/src/PackageVersion.js +1 -1
  30. package/lib/Controllers/Lab/Site/SampleFailureReasonController.js +0 -193
  31. package/lib/Models/Lab/Site/SampleFailureReasonModel.js +0 -195
  32. package/src/Controllers/Lab/Site/SampleFailureReasonController.js +0 -170
  33. 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
  };
@@ -7128,15 +7132,32 @@ declare module '@ricado/api-client/Controllers/Lab/Site/LabController' {
7128
7132
  /**
7129
7133
  * The Points used for this Inspect Integration
7130
7134
  */
7131
- points: any;
7135
+ points: {
7136
+ sqlServerCommunicationStatus: number;
7137
+ sampleCreationEnabled: number;
7138
+ sampleSchedulingEnabled: number;
7139
+ samplePublishingEnabled: number;
7140
+ };
7132
7141
  /**
7133
7142
  * Whether the Inspect Integration is Enabled on this Lab
7134
7143
  */
7135
7144
  enabled: boolean;
7136
7145
  /**
7137
- * Base URL of the Inspect API
7146
+ * Name of the Lab referenced by Inspect
7138
7147
  */
7139
- apiBaseUrl: string;
7148
+ labName: string;
7149
+ /**
7150
+ * Host of the Inspect SQL Server
7151
+ */
7152
+ sqlServerHost: string;
7153
+ /**
7154
+ * Username for Authentication with the Inspect SQL Server
7155
+ */
7156
+ sqlServerUsername: string;
7157
+ /**
7158
+ * Password for Authentication with the Inspect SQL Server
7159
+ */
7160
+ sqlServerPassword: string;
7140
7161
  };
7141
7162
  }
7142
7163
  import LabModel from "@ricado/api-client/Models/Lab/Site/LabModel";
@@ -7717,16 +7738,20 @@ declare module '@ricado/api-client/Controllers/Lab/Site/RackPositionController'
7717
7738
  currentSampleId: number;
7718
7739
  currentSampleStatus: number;
7719
7740
  nextSampleId: number;
7741
+ loadCurrentSampleRequest: number;
7720
7742
  startCurrentSampleRequest: number;
7721
7743
  finishCurrentSampleRequest: number;
7744
+ unloadCurrentSampleRequest: number;
7722
7745
  currentSampleTotalDuration: number;
7723
7746
  currentSampleWarmUpDuration: number;
7747
+ currentSampleWarmUpRateOfChange: number;
7748
+ currentSampleWarmUpWarning: number;
7724
7749
  currentSampleWarmUpCompleted: number;
7725
7750
  currentSampleBelowTargetDuration: number;
7726
7751
  currentSampleAboveTargetDuration: number;
7727
7752
  currentSampleWithinTargetDuration: number;
7728
- currentSampleSuccessCriteriaMet: number;
7729
- currentSampleFailureCriteriaMet: number;
7753
+ currentSampleFinishCriteriaMet: number;
7754
+ currentSampleLatestUnloadTimestamp: number;
7730
7755
  };
7731
7756
  /**
7732
7757
  * The Lab that owns this Rack Position
@@ -7765,16 +7790,20 @@ declare module '@ricado/api-client/Controllers/Lab/Site/RackPositionController'
7765
7790
  currentSampleId: number;
7766
7791
  currentSampleStatus: number;
7767
7792
  nextSampleId: number;
7793
+ loadCurrentSampleRequest: number;
7768
7794
  startCurrentSampleRequest: number;
7769
7795
  finishCurrentSampleRequest: number;
7796
+ unloadCurrentSampleRequest: number;
7770
7797
  currentSampleTotalDuration: number;
7771
7798
  currentSampleWarmUpDuration: number;
7799
+ currentSampleWarmUpRateOfChange: number;
7800
+ currentSampleWarmUpWarning: number;
7772
7801
  currentSampleWarmUpCompleted: number;
7773
7802
  currentSampleBelowTargetDuration: number;
7774
7803
  currentSampleAboveTargetDuration: number;
7775
7804
  currentSampleWithinTargetDuration: number;
7776
- currentSampleSuccessCriteriaMet: number;
7777
- currentSampleFailureCriteriaMet: number;
7805
+ currentSampleFinishCriteriaMet: number;
7806
+ currentSampleLatestUnloadTimestamp: number;
7778
7807
  };
7779
7808
  /**
7780
7809
  * The Lab that owns this Rack Position
@@ -7964,17 +7993,13 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleController' {
7964
7993
  */
7965
7994
  createdSource?: string;
7966
7995
  /**
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'
7996
+ * Name of the User who Created this Sample
7972
7997
  */
7973
7998
  createdUserName?: string | null;
7974
7999
  /**
7975
- * ID of the User who Published this Sample
8000
+ * The Source that Published this Sample
7976
8001
  */
7977
- publishUserId?: string | null;
8002
+ publishSource?: string | null;
7978
8003
  /**
7979
8004
  * Name of the User who Published this Sample
7980
8005
  */
@@ -7991,14 +8016,6 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleController' {
7991
8016
  * The Dehydrator used for this Sample
7992
8017
  */
7993
8018
  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
8019
  /**
8003
8020
  * The Sample Result ID asociated with this Sample
8004
8021
  */
@@ -8067,6 +8084,10 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleController' {
8067
8084
  * Filter by the Timestamp when Samples were last Updated. Results Less than or Equal to Timestamp
8068
8085
  */
8069
8086
  updateTimestampEnd?: Date;
8087
+ /**
8088
+ * Filter by Published State of a Sample. `true` = Published, `false` = Not Published
8089
+ */
8090
+ publishedState?: boolean;
8070
8091
  };
8071
8092
  /**
8072
8093
  * The Create Data for a Sample
@@ -8089,11 +8110,7 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleController' {
8089
8110
  */
8090
8111
  createdSource: string;
8091
8112
  /**
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'
8113
+ * Name of the User who Created this Sample
8097
8114
  */
8098
8115
  createdUserName?: string | null;
8099
8116
  /**
@@ -8121,9 +8138,9 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleController' {
8121
8138
  */
8122
8139
  publishTimestamp?: Date | null;
8123
8140
  /**
8124
- * ID of the User who Published this Sample
8141
+ * The Source that Published this Sample
8125
8142
  */
8126
- publishUserId?: string | null;
8143
+ publishSource?: string | null;
8127
8144
  /**
8128
8145
  * Name of the User who Published this Sample
8129
8146
  */
@@ -8140,14 +8157,6 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleController' {
8140
8157
  * The Dehydrator used for this Sample
8141
8158
  */
8142
8159
  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
8160
  /**
8152
8161
  * The Sample Result ID asociated with this Sample
8153
8162
  */
@@ -8170,11 +8179,7 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleController' {
8170
8179
  */
8171
8180
  createdSource?: string;
8172
8181
  /**
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'
8182
+ * Name of the User who Created this Sample
8178
8183
  */
8179
8184
  createdUserName?: string | null;
8180
8185
  /**
@@ -8202,9 +8207,9 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleController' {
8202
8207
  */
8203
8208
  publishTimestamp?: Date | null;
8204
8209
  /**
8205
- * ID of the User who Published this Sample
8210
+ * The Source that Published this Sample
8206
8211
  */
8207
- publishUserId?: string | null;
8212
+ publishSource?: string | null;
8208
8213
  /**
8209
8214
  * Name of the User who Published this Sample
8210
8215
  */
@@ -8221,14 +8226,6 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleController' {
8221
8226
  * The Dehydrator used for this Sample
8222
8227
  */
8223
8228
  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
8229
  /**
8233
8230
  * The Sample Result ID asociated with this Sample
8234
8231
  */
@@ -8291,166 +8288,66 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleController' {
8291
8288
  import SampleResultModel from "@ricado/api-client/Models/Lab/Site/SampleResultModel";
8292
8289
  }
8293
8290
 
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
8291
  declare module '@ricado/api-client/Controllers/Lab/Site/SampleResultController' {
8395
8292
  export default SampleResultController;
8396
8293
  /**
8397
- * Controller Class for Sample Resultss
8294
+ * Controller Class for Sample Results
8398
8295
  *
8399
8296
  * @class
8400
8297
  */
8401
8298
  class SampleResultController {
8402
8299
  /**
8403
- * Retrieve a Sample Results [GET /lab/sites/{siteId}/sample-results/{id}]
8300
+ * Retrieve a Sample Result [GET /lab/sites/{siteId}/sample-results/{id}]
8404
8301
  *
8405
8302
  * @static
8406
8303
  * @public
8407
8304
  * @param {number} siteId The Site ID
8408
- * @param {string} id The Sample Results ID
8305
+ * @param {string} id The Sample Result ID
8409
8306
  * @return {Promise<SampleResultModel>}
8410
8307
  */
8411
8308
  static getOne(siteId: number, id: string): Promise<SampleResultModel>;
8412
8309
  /**
8413
- * Update a Sample Results [PATCH /lab/sites/{siteId}/sample-results/{id}]
8310
+ * Update a Sample Result [PATCH /lab/sites/{siteId}/sample-results/{id}]
8414
8311
  *
8415
8312
  * @static
8416
8313
  * @public
8417
8314
  * @param {number} siteId The Site ID
8418
- * @param {string} id The Sample Results ID
8419
- * @param {SampleResultController.UpdateData} updateData The Sample Results Update Data
8315
+ * @param {string} id The Sample Result ID
8316
+ * @param {SampleResultController.UpdateData} updateData The Sample Result Update Data
8420
8317
  * @return {Promise<SampleResultModel>}
8421
8318
  */
8422
8319
  static update(siteId: number, id: string, updateData: SampleResultController.UpdateData): Promise<SampleResultModel>;
8423
8320
  /**
8424
- * Delete a Sample Results [DELETE /lab/sites/{siteId}/sample-results/{id}]
8321
+ * Delete a Sample Result [DELETE /lab/sites/{siteId}/sample-results/{id}]
8425
8322
  *
8426
8323
  * @static
8427
8324
  * @public
8428
8325
  * @param {number} siteId The Site ID
8429
- * @param {string} id The Sample Results ID
8326
+ * @param {string} id The Sample Result ID
8430
8327
  * @return {Promise<boolean>}
8431
8328
  */
8432
8329
  static delete(siteId: number, id: string): Promise<boolean>;
8433
8330
  /**
8434
8331
  * Retrieve Comments [GET /lab/sites/{siteId}/sample-results/{id}/comments]
8435
8332
  *
8436
- * Retrieves Comments for a Sample Results
8333
+ * Retrieves Comments for a Sample Result
8437
8334
  *
8438
8335
  * @static
8439
8336
  * @public
8440
8337
  * @param {number} siteId The Site ID
8441
- * @param {string} id The Sample Results ID
8338
+ * @param {string} id The Sample Result ID
8442
8339
  * @return {Promise<Array<SampleResultController.CommentItem>>}
8443
8340
  */
8444
8341
  static getComments(siteId: number, id: string): Promise<Array<SampleResultController.CommentItem>>;
8445
8342
  /**
8446
8343
  * Create a Comment [POST /lab/sites/{siteId}/sample-results/{id}/comments]
8447
8344
  *
8448
- * Create a Comment for a Sample Results
8345
+ * Create a Comment for a Sample Result
8449
8346
  *
8450
8347
  * @static
8451
8348
  * @public
8452
8349
  * @param {number} siteId The Site ID
8453
- * @param {string} id The Sample Results ID
8350
+ * @param {string} id The Sample Result ID
8454
8351
  * @param {string} content The Content of the New Comment
8455
8352
  * @return {Promise<SampleResultController.CommentItem>}
8456
8353
  */
@@ -8458,12 +8355,12 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleResultController'
8458
8355
  /**
8459
8356
  * Retrieve a Comment [GET /lab/sites/{siteId}/sample-results/{id}/comments/{commentId}]
8460
8357
  *
8461
- * Retrieves Comments for a Sample Results
8358
+ * Retrieves Comments for a Sample Result
8462
8359
  *
8463
8360
  * @static
8464
8361
  * @public
8465
8362
  * @param {number} siteId The Site ID
8466
- * @param {string} id The Sample Results ID
8363
+ * @param {string} id The Sample Result ID
8467
8364
  * @param {string} commentId The Comment ID
8468
8365
  * @return {Promise<SampleResultController.CommentItem>}
8469
8366
  */
@@ -8471,12 +8368,12 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleResultController'
8471
8368
  /**
8472
8369
  * Update a Comment [PATCH /lab/sites/{siteId}/sample-results/{id}/comments/{commentId}]
8473
8370
  *
8474
- * Update a Comment for a Sample Results
8371
+ * Update a Comment for a Sample Result
8475
8372
  *
8476
8373
  * @static
8477
8374
  * @public
8478
8375
  * @param {number} siteId The Site ID
8479
- * @param {string} id The Sample Results ID
8376
+ * @param {string} id The Sample Result ID
8480
8377
  * @param {string} commentId The Comment ID
8481
8378
  * @param {string} content The Updated Content for the Comment
8482
8379
  * @return {Promise<SampleResultController.CommentItem>}
@@ -8485,18 +8382,18 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleResultController'
8485
8382
  /**
8486
8383
  * Delete a Comment [DELETE /lab/sites/{siteId}/sample-results/{id}/comments/{commentId}]
8487
8384
  *
8488
- * Delete a Comment for a Sample Results
8385
+ * Delete a Comment for a Sample Result
8489
8386
  *
8490
8387
  * @static
8491
8388
  * @public
8492
8389
  * @param {number} siteId The Site ID
8493
- * @param {string} id The Sample Results ID
8390
+ * @param {string} id The Sample Result ID
8494
8391
  * @param {string} commentId The Comment ID
8495
8392
  * @return {Promise<boolean>}
8496
8393
  */
8497
8394
  static deleteOneComment(siteId: number, id: string, commentId: string): Promise<boolean>;
8498
8395
  /**
8499
- * List all Sample Resultss [GET /lab/sites/{siteId}/sample-results]
8396
+ * List all Sample Results [GET /lab/sites/{siteId}/sample-results]
8500
8397
  *
8501
8398
  * @static
8502
8399
  * @public
@@ -8506,12 +8403,12 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleResultController'
8506
8403
  */
8507
8404
  static getAll(siteId: number, queryParameters?: SampleResultController.GetAllQueryParameters | undefined): Promise<SampleResultModel[]>;
8508
8405
  /**
8509
- * Create a Sample Results [POST /lab/sites/{siteId}/sample-results]
8406
+ * Create a Sample Result [POST /lab/sites/{siteId}/sample-results]
8510
8407
  *
8511
8408
  * @static
8512
8409
  * @public
8513
8410
  * @param {number} siteId The Site ID
8514
- * @param {SampleResultController.CreateData} createData The Sample Results Create Data
8411
+ * @param {SampleResultController.CreateData} createData The Sample Result Create Data
8515
8412
  * @return {Promise<SampleResultModel>}
8516
8413
  */
8517
8414
  static create(siteId: number, createData: SampleResultController.CreateData): Promise<SampleResultModel>;
@@ -8539,7 +8436,7 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleResultController'
8539
8436
  createdTimestampEnd?: Date;
8540
8437
  };
8541
8438
  /**
8542
- * The Create Data for a Sample Results
8439
+ * The Create Data for a Sample Result
8543
8440
  */
8544
8441
  export type CreateData = {
8545
8442
  /**
@@ -8579,17 +8476,21 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleResultController'
8579
8476
  */
8580
8477
  withinTargetDuration: number;
8581
8478
  /**
8582
- * Timestamp of when the Success Criteria was Met for the Sample - `null` if not Met
8479
+ * Timestamp of when the Finish Criteria was Met for the Sample - `null` if not Met
8583
8480
  */
8584
- successCriteriaMetTimestamp?: Date | null;
8481
+ finishCriteriaMetTimestamp?: Date | null;
8585
8482
  /**
8586
- * Timestamp of when the Failure Criteria was Met for the Sample - `null` if not Met
8483
+ * Latest Possible Timestamp of when the Sample should have been Unloaded to remain Compliant
8587
8484
  */
8588
- failureCriteriaMetTimestamp?: Date | null;
8485
+ latestUnloadTimestamp?: Date | null;
8589
8486
  /**
8590
8487
  * The Average Temperature for the Total Duration of the Sample
8591
8488
  */
8592
8489
  totalAverageTemperature?: number | null;
8490
+ /**
8491
+ * The Average Temperature Rate-of-Change seen during the Warm Up process for the Sample
8492
+ */
8493
+ warmUpRateOfChangeTemperature?: number | null;
8593
8494
  /**
8594
8495
  * The Minimum Temperature seen Below the Temperature Target for the Sample
8595
8496
  */
@@ -8620,7 +8521,7 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleResultController'
8620
8521
  withinTargetAverageTemperature?: number | null;
8621
8522
  };
8622
8523
  /**
8623
- * The Update Data for a Sample Results
8524
+ * The Update Data for a Sample Result
8624
8525
  */
8625
8526
  export type UpdateData = {
8626
8527
  /**
@@ -8656,17 +8557,21 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleResultController'
8656
8557
  */
8657
8558
  withinTargetDuration?: number;
8658
8559
  /**
8659
- * Timestamp of when the Success Criteria was Met for the Sample - `null` if not Met
8560
+ * Timestamp of when the Finish Criteria was Met for the Sample - `null` if not Met
8660
8561
  */
8661
- successCriteriaMetTimestamp?: Date | null;
8562
+ finishCriteriaMetTimestamp?: Date | null;
8662
8563
  /**
8663
- * Timestamp of when the Failure Criteria was Met for the Sample - `null` if not Met
8564
+ * Latest Possible Timestamp of when the Sample should have been Unloaded to remain Compliant
8664
8565
  */
8665
- failureCriteriaMetTimestamp?: Date | null;
8566
+ latestUnloadTimestamp?: Date | null;
8666
8567
  /**
8667
8568
  * The Average Temperature for the Total Duration of the Sample
8668
8569
  */
8669
8570
  totalAverageTemperature?: number | null;
8571
+ /**
8572
+ * The Average Temperature Rate-of-Change seen during the Warm Up process for the Sample
8573
+ */
8574
+ warmUpRateOfChangeTemperature?: number | null;
8670
8575
  /**
8671
8576
  * The Minimum Temperature seen Below the Temperature Target for the Sample
8672
8577
  */
@@ -22482,28 +22387,35 @@ declare module '@ricado/api-client/Models/Lab/Site/FruitProfileModel' {
22482
22387
  */
22483
22388
  nominalWarmUpDuration: number;
22484
22389
  /**
22485
- * The Minimum Duration (in seconds) that a Sample should be within the Min and Max Target Temperatures be Successful
22390
+ * The Minimum Duration (in seconds) that a Sample should be within the Min and Max Target Temperatures to be Compliant
22486
22391
  *
22487
22392
  * @type {number}
22488
22393
  * @public
22489
22394
  */
22490
22395
  minimumWithinTargetDuration: number;
22491
22396
  /**
22492
- * The Maximum Duration (in seconds) that a Sample should be Dehydrated for before it Fails
22397
+ * The Minimum Duration (in seconds) that a Sample must be Dehydrated for to be Compliant
22398
+ *
22399
+ * @type {number}
22400
+ * @public
22401
+ */
22402
+ minimumTotalDuration: number;
22403
+ /**
22404
+ * The Maximum Duration (in seconds) that a Sample can be Dehydrated for before it is Considered Non-Compliant
22493
22405
  *
22494
22406
  * @type {number}
22495
22407
  * @public
22496
22408
  */
22497
22409
  maximumTotalDuration: number;
22498
22410
  /**
22499
- * The Minimum Target Temperature for a Sample to be Successful
22411
+ * The Minimum Target Temperature for a Sample to be Compliant
22500
22412
  *
22501
22413
  * @type {number}
22502
22414
  * @public
22503
22415
  */
22504
22416
  minimumTargetTemperature: number;
22505
22417
  /**
22506
- * The Maximum Target Temperature for a Sample to be Successful
22418
+ * The Maximum Target Temperature for a Sample to be Compliant
22507
22419
  *
22508
22420
  * @type {number}
22509
22421
  * @public
@@ -22618,13 +22530,21 @@ declare module '@ricado/api-client/Models/Lab/Site/LabModel' {
22618
22530
  /**
22619
22531
  * The Inspect Integration Configuration for this Lab
22620
22532
  *
22621
- * @type {?{points: Object, enabled: boolean, apiBaseUrl: string}}
22533
+ * @type {?{points: {sqlServerCommunicationStatus: number, sampleCreationEnabled: number, sampleSchedulingEnabled: number, samplePublishingEnabled: number}, enabled: boolean, labName: string, sqlServerHost: string, sqlServerUsername: string, sqlServerPassword: string}}
22622
22534
  * @public
22623
22535
  */
22624
22536
  inspectIntegration: {
22625
- points: any;
22537
+ points: {
22538
+ sqlServerCommunicationStatus: number;
22539
+ sampleCreationEnabled: number;
22540
+ sampleSchedulingEnabled: number;
22541
+ samplePublishingEnabled: number;
22542
+ };
22626
22543
  enabled: boolean;
22627
- apiBaseUrl: string;
22544
+ labName: string;
22545
+ sqlServerHost: string;
22546
+ sqlServerUsername: string;
22547
+ sqlServerPassword: string;
22628
22548
  } | null;
22629
22549
  /**
22630
22550
  * Whether the Lab has been deleted
@@ -22944,7 +22864,7 @@ declare module '@ricado/api-client/Models/Lab/Site/RackPositionModel' {
22944
22864
  /**
22945
22865
  * The Points used by this Rack Position
22946
22866
  *
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}}
22867
+ * @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
22868
  * @public
22949
22869
  */
22950
22870
  points: {
@@ -22956,16 +22876,20 @@ declare module '@ricado/api-client/Models/Lab/Site/RackPositionModel' {
22956
22876
  currentSampleId: number;
22957
22877
  currentSampleStatus: number;
22958
22878
  nextSampleId: number;
22879
+ loadCurrentSampleRequest: number;
22959
22880
  startCurrentSampleRequest: number;
22960
22881
  finishCurrentSampleRequest: number;
22882
+ unloadCurrentSampleRequest: number;
22961
22883
  currentSampleTotalDuration: number;
22962
22884
  currentSampleWarmUpDuration: number;
22885
+ currentSampleWarmUpRateOfChange: number;
22886
+ currentSampleWarmUpWarning: number;
22963
22887
  currentSampleWarmUpCompleted: number;
22964
22888
  currentSampleBelowTargetDuration: number;
22965
22889
  currentSampleAboveTargetDuration: number;
22966
22890
  currentSampleWithinTargetDuration: number;
22967
- currentSampleSuccessCriteriaMet: number;
22968
- currentSampleFailureCriteriaMet: number;
22891
+ currentSampleFinishCriteriaMet: number;
22892
+ currentSampleLatestUnloadTimestamp: number;
22969
22893
  };
22970
22894
  /**
22971
22895
  * The Lab that owns this Rack Position
@@ -23020,81 +22944,6 @@ declare module '@ricado/api-client/Models/Lab/Site/RackPositionModel' {
23020
22944
  import BaseModel from "@ricado/api-client/Models/BaseModel";
23021
22945
  }
23022
22946
 
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
22947
  declare module '@ricado/api-client/Models/Lab/Site/SampleModel' {
23099
22948
  export default SampleModel;
23100
22949
  /**
@@ -23160,14 +23009,7 @@ declare module '@ricado/api-client/Models/Lab/Site/SampleModel' {
23160
23009
  */
23161
23010
  createdSource: string;
23162
23011
  /**
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'
23012
+ * Name of the User who Created this Sample
23171
23013
  *
23172
23014
  * @type {?string}
23173
23015
  * @public
@@ -23216,12 +23058,12 @@ declare module '@ricado/api-client/Models/Lab/Site/SampleModel' {
23216
23058
  */
23217
23059
  publishTimestamp: Date | null;
23218
23060
  /**
23219
- * ID of the User who Published this Sample
23061
+ * The Source that Published this Sample
23220
23062
  *
23221
23063
  * @type {?string}
23222
23064
  * @public
23223
23065
  */
23224
- publishUserId: string | null;
23066
+ publishSource: string | null;
23225
23067
  /**
23226
23068
  * Name of the User who Published this Sample
23227
23069
  *
@@ -23250,20 +23092,6 @@ declare module '@ricado/api-client/Models/Lab/Site/SampleModel' {
23250
23092
  * @public
23251
23093
  */
23252
23094
  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
23095
  /**
23268
23096
  * The Sample Result ID asociated with this Sample
23269
23097
  *
@@ -23306,7 +23134,7 @@ declare module '@ricado/api-client/Models/Lab/Site/SampleModel' {
23306
23134
  declare module '@ricado/api-client/Models/Lab/Site/SampleResultModel' {
23307
23135
  export default SampleResultModel;
23308
23136
  /**
23309
- * Model Class for a Sample Results
23137
+ * Model Class for a Sample Result
23310
23138
  *
23311
23139
  * @class
23312
23140
  * @hideconstructor
@@ -23319,7 +23147,7 @@ declare module '@ricado/api-client/Models/Lab/Site/SampleResultModel' {
23319
23147
  * @static
23320
23148
  * @public
23321
23149
  * @param {Object<string, any>|string} json A JSON Object or JSON String
23322
- * @param {number} siteId The Site ID associated with this Sample Results
23150
+ * @param {number} siteId The Site ID associated with this Sample Result
23323
23151
  * @return {SampleResultModel}
23324
23152
  */
23325
23153
  static fromJSON(json: {
@@ -23329,11 +23157,11 @@ declare module '@ricado/api-client/Models/Lab/Site/SampleResultModel' {
23329
23157
  * SampleResultModel Constructor
23330
23158
  *
23331
23159
  * @protected
23332
- * @param {number} siteId The Site ID associated with this Sample Results
23160
+ * @param {number} siteId The Site ID associated with this Sample Result
23333
23161
  */
23334
23162
  protected constructor();
23335
23163
  /**
23336
- * The Sample Results ID
23164
+ * The Sample Result ID
23337
23165
  *
23338
23166
  * @type {string}
23339
23167
  * @public
@@ -23403,19 +23231,19 @@ declare module '@ricado/api-client/Models/Lab/Site/SampleResultModel' {
23403
23231
  */
23404
23232
  withinTargetDuration: number;
23405
23233
  /**
23406
- * Timestamp of when the Success Criteria was Met for the Sample - `null` if not Met
23234
+ * Timestamp of when the Finish Criteria was Met for the Sample - `null` if not Met
23407
23235
  *
23408
23236
  * @type {?Date}
23409
23237
  * @public
23410
23238
  */
23411
- successCriteriaMetTimestamp: Date | null;
23239
+ finishCriteriaMetTimestamp: Date | null;
23412
23240
  /**
23413
- * Timestamp of when the Failure Criteria was Met for the Sample - `null` if not Met
23241
+ * Latest Possible Timestamp of when the Sample should have been Unloaded to remain Compliant
23414
23242
  *
23415
23243
  * @type {?Date}
23416
23244
  * @public
23417
23245
  */
23418
- failureCriteriaMetTimestamp: Date | null;
23246
+ latestUnloadTimestamp: Date | null;
23419
23247
  /**
23420
23248
  * The Average Temperature for the Total Duration of the Sample
23421
23249
  *
@@ -23423,6 +23251,13 @@ declare module '@ricado/api-client/Models/Lab/Site/SampleResultModel' {
23423
23251
  * @public
23424
23252
  */
23425
23253
  totalAverageTemperature: number | null;
23254
+ /**
23255
+ * The Average Temperature Rate-of-Change seen during the Warm Up process for the Sample
23256
+ *
23257
+ * @type {?number}
23258
+ * @public
23259
+ */
23260
+ warmUpRateOfChangeTemperature: number | null;
23426
23261
  /**
23427
23262
  * The Minimum Temperature seen Below the Temperature Target for the Sample
23428
23263
  *
@@ -23473,21 +23308,21 @@ declare module '@ricado/api-client/Models/Lab/Site/SampleResultModel' {
23473
23308
  */
23474
23309
  withinTargetAverageTemperature: number | null;
23475
23310
  /**
23476
- * Whether the Sample Results has been deleted
23311
+ * Whether the Sample Result has been deleted
23477
23312
  *
23478
23313
  * @type {boolean}
23479
23314
  * @public
23480
23315
  */
23481
23316
  deleted: boolean;
23482
23317
  /**
23483
- * When the Sample Results was last updated
23318
+ * When the Sample Result was last updated
23484
23319
  *
23485
23320
  * @type {Date}
23486
23321
  * @public
23487
23322
  */
23488
23323
  updateTimestamp: Date;
23489
23324
  /**
23490
- * The Site ID associated with this Sample Results
23325
+ * The Site ID associated with this Sample Result
23491
23326
  *
23492
23327
  * @type {number}
23493
23328
  * @public