@ricado/api-client 2.5.16 → 2.6.0

package/lib/index.d.ts

@@ -6984,6 +6984,38 @@ declare module '@ricado/api-client/Controllers/Lab/Site/FruitProfileController'
                         * The Maximum Target Temperature for a Sample to be Compliant
                         */
                     maximumTargetTemperature: number;
+                    /**
+                        * The Warm-Up Temperature for starting the Warm Up alerts
+                        */
+                    warmUpStartExpectedTemperature: number;
+                    /**
+                        * The Warm-Up Start Expected Rate of Change
+                        */
+                    warmUpStartExpectedRateOfChange: number;
+                    /**
+                        * The Warm-Up Stage Two Expected Temperature
+                        */
+                    warmUpStageTwoExpectedTemperature: number;
+                    /**
+                        * The Warm-Up Stage Two Expected Rate of Change
+                        */
+                    warmUpStageTwoExpectedRateOfChange: number;
+                    /**
+                        * The Warm-Up Stage Three Expected Temperature
+                        */
+                    warmUpStageThreeExpectedTemperature: number;
+                    /**
+                        * The Warm-Up Stage Three Expected Rate of Change
+                        */
+                    warmUpStageThreeExpectedRateOfChange: number;
+                    /**
+                        * The Warm-Up End Expected Temperature
+                        */
+                    warmUpEndExpectedTemperature: number;
+                    /**
+                        * The Warm-Up End Expected Rate of Change
+                        */
+                    warmUpEndExpectedRateOfChange: number;
             };
             /**
                 * The Update Data for a Fruit Profile
@@ -7025,6 +7057,38 @@ declare module '@ricado/api-client/Controllers/Lab/Site/FruitProfileController'
                         * The Maximum Target Temperature for a Sample to be Compliant
                         */
                     maximumTargetTemperature?: number | undefined;
+                    /**
+                        * The Warm-Up Temperature for starting the Warm Up alerts
+                        */
+                    warmUpStartExpectedTemperature?: number | undefined;
+                    /**
+                        * The Warm-Up Start Expected Rate of Change
+                        */
+                    warmUpStartExpectedRateOfChange?: number | undefined;
+                    /**
+                        * The Warm-Up Stage Two Expected Temperature
+                        */
+                    warmUpStageTwoExpectedTemperature?: number | undefined;
+                    /**
+                        * The Warm-Up Stage Two Expected Rate of Change
+                        */
+                    warmUpStageTwoExpectedRateOfChange?: number | undefined;
+                    /**
+                        * The Warm-Up Stage Three Expected Temperature
+                        */
+                    warmUpStageThreeExpectedTemperature?: number | undefined;
+                    /**
+                        * The Warm-Up Stage Three Expected Rate of Change
+                        */
+                    warmUpStageThreeExpectedRateOfChange?: number | undefined;
+                    /**
+                        * The Warm-Up End Expected Temperature
+                        */
+                    warmUpEndExpectedTemperature?: number | undefined;
+                    /**
+                        * The Warm-Up End Expected Rate of Change
+                        */
+                    warmUpEndExpectedRateOfChange?: number | undefined;
             };
     }
     import FruitProfileModel from "@ricado/api-client/Models/Lab/Site/FruitProfileModel";
@@ -8176,6 +8240,10 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleController' {
                         * Optional Scheduled Timestamp when this Sample should Begin
                         */
                     scheduledTimestamp?: Date | null | undefined;
+                    /**
+                        * Optional When the Schedule was received from Inspect
+                        */
+                    scheduleReceivedTimestamp?: Date | null | undefined;
                     /**
                         * When this Sample was Loaded into the Dehydrator
                         */
@@ -8220,6 +8288,18 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleController' {
                         * The Sample Result ID asociated with this Sample
                         */
                     resultId?: string | null | undefined;
+                    /**
+                        * Optional the BlindedSampleID Reference defined in RadfordsInspect
+                        */
+                    blindedSampleID?: string | null | undefined;
+                    /**
+                        * Optional the Sample Short Description defined in RadfordsInspect
+                        */
+                    shortDescription?: string | null | undefined;
+                    /**
+                        * Optional the Sample Description defined in RadfordsInspect
+                        */
+                    sampleDescription?: string | null | undefined;
             };
             /**
                 * The Update Data for a Sample
@@ -8245,6 +8325,10 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleController' {
                         * Optional Scheduled Timestamp when this Sample should Begin
                         */
                     scheduledTimestamp?: Date | null | undefined;
+                    /**
+                        * Optional When the Schedule was received from Inspect
+                        */
+                    scheduleReceivedTimestamp?: Date | null | undefined;
                     /**
                         * When this Sample was Loaded into the Dehydrator
                         */
@@ -8289,6 +8373,18 @@ declare module '@ricado/api-client/Controllers/Lab/Site/SampleController' {
                         * The Sample Result ID asociated with this Sample
                         */
                     resultId?: string | null | undefined;
+                    /**
+                        * Optional the BlindedSampleID Reference defined in RadfordsInspect
+                        */
+                    blindedSampleID?: string | null | undefined;
+                    /**
+                        * Optional the Sample Short Description defined in RadfordsInspect
+                        */
+                    shortDescription?: string | null | undefined;
+                    /**
+                        * Optional the Sample Description defined in RadfordsInspect
+                        */
+                    sampleDescription?: string | null | undefined;
             };
             /**
                 * A **UserAccount** Type
@@ -14194,6 +14290,10 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/MAFSizerBatchContr
                         * The Packrun ID associated with this Batch
                         */
                     packrunId?: string | null | undefined;
+                    /**
+                        * When the Final Update from the MAF Sizer Orphea Database has been Received
+                        */
+                    finalOrpheaUpdate?: Date | null | undefined;
                     /**
                         * An Array of Summary Data Objects for each Article
                         */
@@ -14206,6 +14306,18 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/MAFSizerBatchContr
                         * An Array of Summary Data Objects for each Fruit Size and Article
                         */
                     fruitSummaries?: FruitSummary[] | undefined;
+                    /**
+                        * An Array of Summary Data Objects for each Outlet by Fruit Size and Article
+                        */
+                    outletFruitSummaries?: OutletFruitSummary[] | undefined;
+                    /**
+                        * An Array of Size Names and Indexes
+                        */
+                    sizeNames?: SizeNameLookup[] | undefined;
+                    /**
+                        * An Array of Article Names and Indexes
+                        */
+                    articleNames?: ArticleNameLookup[] | undefined;
             };
             /**
                 * The Update Data for a MAF Sizer Batch
@@ -14247,6 +14359,10 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/MAFSizerBatchContr
                         * The Packrun ID associated with this Batch
                         */
                     packrunId?: string | null | undefined;
+                    /**
+                        * When the Final Update from the MAF Sizer Orphea Database has been Received
+                        */
+                    finalOrpheaUpdate?: Date | null | undefined;
                     /**
                         * An Array of Summary Data Objects for each Article
                         */
@@ -14259,6 +14375,18 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/MAFSizerBatchContr
                         * An Array of Summary Data Objects for each Fruit Size and Article
                         */
                     fruitSummaries?: FruitSummary[] | undefined;
+                    /**
+                        * An Array of Summary Data Objects for each Outlet by Fruit Size and Article
+                        */
+                    outletFruitSummaries?: OutletFruitSummary[] | undefined;
+                    /**
+                        * An Array of Size Names and Indexes
+                        */
+                    sizeNames?: SizeNameLookup[] | undefined;
+                    /**
+                        * An Array of Article Names and Indexes
+                        */
+                    articleNames?: ArticleNameLookup[] | undefined;
             };
             /**
                 * A **UserAccount** Type
@@ -14303,6 +14431,10 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/MAFSizerBatchContr
                 * A **ArticleSummary** Type
                 */
             type ArticleSummary = {
+                    /**
+                        * The Article Index
+                        */
+                    index: number | null;
                     /**
                         * The Article Name
                         */
@@ -14332,19 +14464,68 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/MAFSizerBatchContr
                         * The Fruit Weight expressed in Kilograms
                         */
                     fruitWeight: number;
+                    /**
+                        * An Array of Article Indexes that have been Seen assigned to the Outlet
+                        */
+                    seenArticles: number[];
+                    /**
+                        * An Array of Article Indexes that have are Actively assigned to the Outlet
+                        */
+                    activeArticles: number[];
             };
             /**
                 * A **FruitSummary** Type
                 */
             type FruitSummary = {
+                    /**
+                        * The Size Index
+                        */
+                    sizeIndex: number;
+                    /**
+                        * The Size Name
+                        */
+                    sizeName: string;
+                    /**
+                        * The Article Index
+                        */
+                    articleIndex: number;
                     /**
                         * The Article Name
                         */
                     articleName: string;
                     /**
-                        * The Fruit Size
+                        * The Fruit Count
                         */
-                    fruitSize: string;
+                    fruitCount: number;
+                    /**
+                        * The Fruit Weight expressed in Kilograms
+                        */
+                    fruitWeight: number;
+            };
+            /**
+                * A **OutletFruitSummary** Type
+                */
+            type OutletFruitSummary = {
+                    /**
+                        * The Outlet Number
+                        */
+                    outletNumber: number;
+                    /**
+                        * The Size Index
+                        */
+                    sizeIndex: number;
+                    /**
+                        * The Size Name
+                        */
+                    sizeName: string;
+                    /**
+                        * The Article Index
+                        */
+                    articleIndex: number;
+                    /**
+                        * The Article Name
+                        */
+                    articleName: string;
                     /**
                         * The Fruit Count
                         */
@@ -14354,6 +14535,32 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/MAFSizerBatchContr
                         */
                     fruitWeight: number;
             };
+            /**
+                * A **SizeNameLookup** Type
+                */
+            type SizeNameLookup = {
+                    /**
+                        * The Size Index
+                        */
+                    index: number;
+                    /**
+                        * The Size Name
+                        */
+                    name: string;
+            };
+            /**
+                * A **ArticleNameLookup** Type
+                */
+            type ArticleNameLookup = {
+                    /**
+                        * The Article Index
+                        */
+                    index: number;
+                    /**
+                        * The Article Name
+                        */
+                    name: string;
+            };
     }
     import MAFSizerBatchModel from "@ricado/api-client/Models/Packhouse/Site/MAFSizerBatchModel";
 }
@@ -15178,6 +15385,10 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/MAFSizerPackrunSum
                         * An Array of Packrun Summary Data Objects for each Class Type
                         */
                     classTypeSummaries?: ClassTypeSummary[] | undefined;
+                    /**
+                        * An Array of Packrun Summary Data Objects for each Outlet
+                        */
+                    outletSummaries?: OutletSummary[] | undefined;
                     /**
                         * An Array that contains the Articles initially Assigned to each Outlet
                         */
@@ -15207,6 +15418,10 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/MAFSizerPackrunSum
                         * An Array of Packrun Summary Data Objects for each Class Type
                         */
                     classTypeSummaries?: ClassTypeSummary[] | undefined;
+                    /**
+                        * An Array of Packrun Summary Data Objects for each Outlet
+                        */
+                    outletSummaries?: OutletSummary[] | undefined;
                     /**
                         * An Array that contains the Articles initially Assigned to each Outlet
                         */
@@ -15293,6 +15508,56 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/MAFSizerPackrunSum
                         */
                     totals: ClassTypeTotal[];
             };
+            /**
+                * A **OutletTotal** Type
+                */
+            type OutletTotal = {
+                    /**
+                        * The Class Type
+                        */
+                    classType: string | null;
+                    /**
+                        * The Fruit Size
+                        */
+                    fruitSize: string;
+                    /**
+                        * The Pack Type
+                        */
+                    packType: string | null;
+                    /**
+                        * The Weight expressed in Kilograms
+                        */
+                    weight: number;
+                    /**
+                        * The Fruit Count
+                        */
+                    fruitCount: number;
+                    /**
+                        * The Number of Packs
+                        */
+                    packCount: number | null;
+            };
+            /**
+                * A **OutletSummary** Type
+                */
+            type OutletSummary = {
+                    /**
+                        * The Outlet Name
+                        */
+                    name: string;
+                    /**
+                        * The Generic Outlet Type
+                        */
+                    type: string;
+                    /**
+                        * The Outlet Number
+                        */
+                    number: number;
+                    /**
+                        * An Array of Totals for the Outlet
+                        */
+                    totals: OutletTotal[];
+            };
             /**
                 * A **InitialOutletArticle** Type
                 */
@@ -17349,6 +17614,14 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/PackrunController'
                         * The Percentage of Total Fruit that was Recycled for the Batch
                         */
                     recyclePercentage: number;
+                    /**
+                        * The Incoming Fruit Count for the Batch
+                        */
+                    incomingFruitCount: number;
+                    /**
+                        * The Incoming Fruit Weight (kg) for the Batch
+                        */
+                    incomingFruitWeight: number;
             };
             /**
                 * A **SizerItem** Type
@@ -17436,6 +17709,18 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/PackrunController'
                         */
                     compacSizers: any[];
                     sizers: SizerItem[];
+                    /**
+                        * The IDs of the Sizers that directly receive Fruit from the Infeed
+                        */
+                    incomingSizerIds: string[];
+                    /**
+                        * The Incoming Fruit Count of all Incoming Sizers
+                        */
+                    incomingSizersFruitCount: number;
+                    /**
+                        * The Incoming Fruit Weight of all Incoming Sizers
+                        */
+                    incomingSizersFruitWeight: number;
                     /**
                         * The Reject Bin Summary for the Packrun
                         */
@@ -23188,6 +23473,62 @@ declare module '@ricado/api-client/Models/Lab/Site/FruitProfileModel' {
                 * @public
                 */
             maximumTargetTemperature: number;
+            /**
+                * The Warm-Up Temperature for starting the Warm Up alerts
+                *
+                * @type {number}
+                * @public
+                */
+            warmUpStartExpectedTemperature: number;
+            /**
+                * The Warm-Up Start Expected Rate of Change
+                *
+                * @type {number}
+                * @public
+                */
+            warmUpStartExpectedRateOfChange: number;
+            /**
+                * The Warm-Up Stage Two Expected Temperature
+                *
+                * @type {number}
+                * @public
+                */
+            warmUpStageTwoExpectedTemperature: number;
+            /**
+                * The Warm-Up Stage Two Expected Rate of Change
+                *
+                * @type {number}
+                * @public
+                */
+            warmUpStageTwoExpectedRateOfChange: number;
+            /**
+                * The Warm-Up Stage Three Expected Temperature
+                *
+                * @type {number}
+                * @public
+                */
+            warmUpStageThreeExpectedTemperature: number;
+            /**
+                * The Warm-Up Stage Three Expected Rate of Change
+                *
+                * @type {number}
+                * @public
+                */
+            warmUpStageThreeExpectedRateOfChange: number;
+            /**
+                * The Warm-Up End Expected Temperature
+                *
+                * @type {number}
+                * @public
+                */
+            warmUpEndExpectedTemperature: number;
+            /**
+                * The Warm-Up End Expected Rate of Change
+                *
+                * @type {number}
+                * @public
+                */
+            warmUpEndExpectedRateOfChange: number;
             /**
                 * Whether the Fruit Profile has been deleted
                 *
@@ -23792,6 +24133,13 @@ declare module '@ricado/api-client/Models/Lab/Site/SampleModel' {
                 * @public
                 */
             scheduledTimestamp: Date | null;
+            /**
+                * Optional When the Schedule was received from Inspect
+                *
+                * @type {?Date}
+                * @public
+                */
+            scheduleReceivedTimestamp: Date | null;
             /**
                 * When this Sample was Loaded into the Dehydrator
                 *
@@ -23869,6 +24217,27 @@ declare module '@ricado/api-client/Models/Lab/Site/SampleModel' {
                 * @public
                 */
             resultId: string | null;
+            /**
+                * Optional the BlindedSampleID Reference defined in RadfordsInspect
+                *
+                * @type {?string}
+                * @public
+                */
+            blindedSampleID: string | null;
+            /**
+                * Optional the Sample Short Description defined in RadfordsInspect
+                *
+                * @type {?string}
+                * @public
+                */
+            shortDescription: string | null;
+            /**
+                * Optional the Sample Description defined in RadfordsInspect
+                *
+                * @type {?string}
+                * @public
+                */
+            sampleDescription: string | null;
             /**
                 * The Status of this Sample
                 *
@@ -26474,13 +26843,21 @@ declare module '@ricado/api-client/Models/Packhouse/Site/MAFSizerBatchModel' {
                 * @public
                 */
             packrunId: string | null;
+            /**
+                * When the Final Update from the MAF Sizer Orphea Database has been Received
+                *
+                * @type {?Date}
+                * @public
+                */
+            finalOrpheaUpdate: Date | null;
             /**
                 * An Array of Summary Data Objects for each Article
                 *
-                * @type {Array<{name: string, fruitCount: number, fruitWeight: number}>}
+                * @type {Array<{index: ?number, name: string, fruitCount: number, fruitWeight: number}>}
                 * @public
                 */
             articleSummaries: {
+                    index: number | null;
                     name: string;
                     fruitCount: number;
                     fruitWeight: number;
@@ -26488,26 +26865,65 @@ declare module '@ricado/api-client/Models/Packhouse/Site/MAFSizerBatchModel' {
             /**
                 * An Array of Summary Data Objects for each Outlet
                 *
-                * @type {Array<{number: number, fruitCount: number, fruitWeight: number}>}
+                * @type {Array<{number: number, fruitCount: number, fruitWeight: number, seenArticles: number[], activeArticles: number[]}>}
                 * @public
                 */
             outletSummaries: {
                     number: number;
                     fruitCount: number;
                     fruitWeight: number;
+                    seenArticles: number[];
+                    activeArticles: number[];
             }[];
             /**
                 * An Array of Summary Data Objects for each Fruit Size and Article
                 *
-                * @type {Array<{articleName: string, fruitSize: string, fruitCount: number, fruitWeight: number}>}
+                * @type {Array<{sizeIndex: number, sizeName: string, articleIndex: number, articleName: string, fruitCount: number, fruitWeight: number}>}
                 * @public
                 */
             fruitSummaries: {
+                    sizeIndex: number;
+                    sizeName: string;
+                    articleIndex: number;
                     articleName: string;
-                    fruitSize: string;
                     fruitCount: number;
                     fruitWeight: number;
             }[];
+            /**
+                * An Array of Summary Data Objects for each Outlet by Fruit Size and Article
+                *
+                * @type {Array<{outletNumber: number, sizeIndex: number, sizeName: string, articleIndex: number, articleName: string, fruitCount: number, fruitWeight: number}>}
+                * @public
+                */
+            outletFruitSummaries: {
+                    outletNumber: number;
+                    sizeIndex: number;
+                    sizeName: string;
+                    articleIndex: number;
+                    articleName: string;
+                    fruitCount: number;
+                    fruitWeight: number;
+            }[];
+            /**
+                * An Array of Size Names and Indexes
+                *
+                * @type {Array<{index: number, name: string}>}
+                * @public
+                */
+            sizeNames: {
+                    index: number;
+                    name: string;
+            }[];
+            /**
+                * An Array of Article Names and Indexes
+                *
+                * @type {Array<{index: number, name: string}>}
+                * @public
+                */
+            articleNames: {
+                    index: number;
+                    name: string;
+            }[];
             /**
                 * Whether the MAF Sizer Batch has been deleted
                 *
@@ -26932,6 +27348,25 @@ declare module '@ricado/api-client/Models/Packhouse/Site/MAFSizerPackrunSummaryM
                             packCount: number | null;
                     }[];
             }[];
+            /**
+                * An Array of Packrun Summary Data Objects for each Outlet
+                *
+                * @type {Array<{name: string, type: string, number: number, totals: Array<{classType: ?string, fruitSize: string, packType: ?string, weight: number, fruitCount: number, packCount: ?number}>}>}
+                * @public
+                */
+            outletSummaries: {
+                    name: string;
+                    type: string;
+                    number: number;
+                    totals: {
+                            classType: string | null;
+                            fruitSize: string;
+                            packType: string | null;
+                            weight: number;
+                            fruitCount: number;
+                            packCount: number | null;
+                    }[];
+            }[];
             /**
                 * An Array that contains the Articles initially Assigned to each Outlet
                 *

package/package.json

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

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

@@ -164,6 +164,14 @@ export default FruitProfileController;
  * @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
+ * @property {number} warmUpStartExpectedTemperature The Warm-Up Temperature for starting the Warm Up alerts
+ * @property {number} warmUpStartExpectedRateOfChange The Warm-Up Start Expected Rate of Change
+ * @property {number} warmUpStageTwoExpectedTemperature The Warm-Up Stage Two Expected Temperature
+ * @property {number} warmUpStageTwoExpectedRateOfChange The Warm-Up Stage Two Expected Rate of Change
+ * @property {number} warmUpStageThreeExpectedTemperature The Warm-Up Stage Three Expected Temperature
+ * @property {number} warmUpStageThreeExpectedRateOfChange The Warm-Up Stage Three Expected Rate of Change
+ * @property {number} warmUpEndExpectedTemperature The Warm-Up End Expected Temperature
+ * @property {number} warmUpEndExpectedRateOfChange The Warm-Up End Expected Rate of Change
  * @memberof Controllers.Lab.Site
  */
 
@@ -180,5 +188,13 @@ export default FruitProfileController;
  * @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
+ * @property {number} [warmUpStartExpectedTemperature] The Warm-Up Temperature for starting the Warm Up alerts
+ * @property {number} [warmUpStartExpectedRateOfChange] The Warm-Up Start Expected Rate of Change
+ * @property {number} [warmUpStageTwoExpectedTemperature] The Warm-Up Stage Two Expected Temperature
+ * @property {number} [warmUpStageTwoExpectedRateOfChange] The Warm-Up Stage Two Expected Rate of Change
+ * @property {number} [warmUpStageThreeExpectedTemperature] The Warm-Up Stage Three Expected Temperature
+ * @property {number} [warmUpStageThreeExpectedRateOfChange] The Warm-Up Stage Three Expected Rate of Change
+ * @property {number} [warmUpEndExpectedTemperature] The Warm-Up End Expected Temperature
+ * @property {number} [warmUpEndExpectedRateOfChange] The Warm-Up End Expected Rate of Change
  * @memberof Controllers.Lab.Site
  */