@ricado/api-client 2.1.0 → 2.1.1

package/lib/index.d.ts

@@ -3150,6 +3150,7 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site' {
         export { ShiftController };
         export { ShiftFocusMeetingController };
         export { ShiftHourlyEntryController };
+        export { SoftSortBeltController };
         export { VarietyController };
     }
     import BinTipWeightController from "@ricado/api-client/Controllers/Packhouse/Site/BinTipWeightController";
@@ -3171,6 +3172,7 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site' {
     import ShiftController from "@ricado/api-client/Controllers/Packhouse/Site/ShiftController";
     import ShiftFocusMeetingController from "@ricado/api-client/Controllers/Packhouse/Site/ShiftFocusMeetingController";
     import ShiftHourlyEntryController from "@ricado/api-client/Controllers/Packhouse/Site/ShiftHourlyEntryController";
+    import SoftSortBeltController from "@ricado/api-client/Controllers/Packhouse/Site/SoftSortBeltController";
     import VarietyController from "@ricado/api-client/Controllers/Packhouse/Site/VarietyController";
 }
 
@@ -4713,6 +4715,7 @@ declare module '@ricado/api-client/Models/Packhouse/Site' {
         export { ShiftFocusMeetingModel };
         export { ShiftHourlyEntryModel };
         export { ShiftModel };
+        export { SoftSortBeltModel };
         export { VarietyModel };
     }
     import BinTipWeightModel from "@ricado/api-client/Models/Packhouse/Site/BinTipWeightModel";
@@ -4734,6 +4737,7 @@ declare module '@ricado/api-client/Models/Packhouse/Site' {
     import ShiftFocusMeetingModel from "@ricado/api-client/Models/Packhouse/Site/ShiftFocusMeetingModel";
     import ShiftHourlyEntryModel from "@ricado/api-client/Models/Packhouse/Site/ShiftHourlyEntryModel";
     import ShiftModel from "@ricado/api-client/Models/Packhouse/Site/ShiftModel";
+    import SoftSortBeltModel from "@ricado/api-client/Models/Packhouse/Site/SoftSortBeltModel";
     import VarietyModel from "@ricado/api-client/Models/Packhouse/Site/VarietyModel";
 }
 
@@ -8943,7 +8947,53 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/RejectBinScaleCont
                     /**
                         * The Auto Packrun Change Configuration for this Reject Bin Scale
                         */
-                    autoPackrunChange?: number;
+                    autoPackrunChange?: {
+                            delay: number;
+                    };
+                    /**
+                        * Whether this Reject Bin Scale supports Live Weighing
+                        */
+                    supportsLiveWeighing?: boolean;
+                    /**
+                        * The Minimum Weight Change Required to Automatically Start Live Weighing
+                        */
+                    autoWeighingStartThreshold?: number;
+                    /**
+                        * The Delay in Milliseconds before Auto Live Weighing would Start
+                        */
+                    autoWeighingStartDelay?: number;
+                    /**
+                        * The Minimum Weight Change Required to Automatically Finish Live Weighing
+                        */
+                    autoWeighingFinishThreshold?: number;
+                    /**
+                        * The Delay in Milliseconds before Auto Live Weighing would Finish
+                        */
+                    autoWeighingFinishDelay?: number;
+                    /**
+                        * The Maximum Duration in Milliseconds before a Manual Intervention would end
+                        */
+                    manualInterventionMaximumDuration?: number;
+                    /**
+                        * The Maximum Weight Increase allowed within a single Live Weighing Update Interval
+                        */
+                    liveWeighingIncreaseTolerance?: number;
+                    /**
+                        * The Maximum Weight Decrease allowed within a single Live Weighing Update Interval
+                        */
+                    liveWeighingDecreaseTolerance?: number;
+                    /**
+                        * The Interval in Milliseconds between Live Weighing Updates
+                        */
+                    liveWeighingUpdateInterval?: number;
+                    /**
+                        * Whether the Loadcell Stable Status is used to ignore Changes during Live Weighing
+                        */
+                    liveWeighingUsesStableStatus?: boolean;
+                    /**
+                        * The Maximum Weight Change allowed while Live Weighing before an Incorrect Operation is Logged
+                        */
+                    incorrectOperationTolerance?: number;
                     /**
                         * The FreshPack Integration Configuration for this Reject Bin Scale
                         */
@@ -8980,7 +9030,53 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/RejectBinScaleCont
                     /**
                         * The Auto Packrun Change Configuration for this Reject Bin Scale
                         */
-                    autoPackrunChange?: number;
+                    autoPackrunChange?: {
+                            delay: number;
+                    };
+                    /**
+                        * Whether this Reject Bin Scale supports Live Weighing
+                        */
+                    supportsLiveWeighing?: boolean;
+                    /**
+                        * The Minimum Weight Change Required to Automatically Start Live Weighing
+                        */
+                    autoWeighingStartThreshold?: number;
+                    /**
+                        * The Delay in Milliseconds before Auto Live Weighing would Start
+                        */
+                    autoWeighingStartDelay?: number;
+                    /**
+                        * The Minimum Weight Change Required to Automatically Finish Live Weighing
+                        */
+                    autoWeighingFinishThreshold?: number;
+                    /**
+                        * The Delay in Milliseconds before Auto Live Weighing would Finish
+                        */
+                    autoWeighingFinishDelay?: number;
+                    /**
+                        * The Maximum Duration in Milliseconds before a Manual Intervention would end
+                        */
+                    manualInterventionMaximumDuration?: number;
+                    /**
+                        * The Maximum Weight Increase allowed within a single Live Weighing Update Interval
+                        */
+                    liveWeighingIncreaseTolerance?: number;
+                    /**
+                        * The Maximum Weight Decrease allowed within a single Live Weighing Update Interval
+                        */
+                    liveWeighingDecreaseTolerance?: number;
+                    /**
+                        * The Interval in Milliseconds between Live Weighing Updates
+                        */
+                    liveWeighingUpdateInterval?: number;
+                    /**
+                        * Whether the Loadcell Stable Status is used to ignore Changes during Live Weighing
+                        */
+                    liveWeighingUsesStableStatus?: boolean;
+                    /**
+                        * The Maximum Weight Change allowed while Live Weighing before an Incorrect Operation is Logged
+                        */
+                    incorrectOperationTolerance?: number;
                     /**
                         * The FreshPack Integration Configuration for this Reject Bin Scale
                         */
@@ -10343,6 +10439,210 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/ShiftHourlyEntryCo
     import ShiftHourlyEntryModel from "@ricado/api-client/Models/Packhouse/Site/ShiftHourlyEntryModel";
 }
 
+declare module '@ricado/api-client/Controllers/Packhouse/Site/SoftSortBeltController' {
+    export default SoftSortBeltController;
+    /**
+        * Controller Class for Soft Sort Belts
+        *
+        * @class
+        */
+    class SoftSortBeltController {
+            /**
+                * Retrieve a Soft Sort Belt [GET /packhouse/sites/{siteId}/soft-sort-belts/{id}]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Soft Sort Belt ID
+                * @return {Promise<SoftSortBeltModel>}
+                */
+            static getOne(siteId: number, id: string): Promise<SoftSortBeltModel>;
+            /**
+                * Update a Soft Sort Belt [PATCH /packhouse/sites/{siteId}/soft-sort-belts/{id}]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Soft Sort Belt ID
+                * @param {SoftSortBeltController.UpdateData} updateData The Soft Sort Belt Update Data
+                * @return {Promise<SoftSortBeltModel>}
+                */
+            static update(siteId: number, id: string, updateData: SoftSortBeltController.UpdateData): Promise<SoftSortBeltModel>;
+            /**
+                * Delete a Soft Sort Belt [DELETE /packhouse/sites/{siteId}/soft-sort-belts/{id}]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Soft Sort Belt ID
+                * @return {Promise<boolean>}
+                */
+            static delete(siteId: number, id: string): Promise<boolean>;
+            /**
+                * Retrieve the Events of a Soft Sort Belt [GET /packhouse/sites/{siteId}/soft-sort-belts/{id}/events]
+                *
+                * Retrieves Events for a Single Soft Sort Belt
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Soft Sort Belt ID
+                * @param {SoftSortBeltController.GetOneEventsQueryParameters} [queryParameters] The Optional Query Parameters
+                * @return {Promise<Array<SoftSortBeltController.SoftSortEventItem>>}
+                */
+            static getOneEvents(siteId: number, id: string, queryParameters?: SoftSortBeltController.GetOneEventsQueryParameters): Promise<Array<SoftSortBeltController.SoftSortEventItem>>;
+            /**
+                * List all Soft Sort Belts [GET /packhouse/sites/{siteId}/soft-sort-belts]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {SoftSortBeltController.GetAllQueryParameters} [queryParameters] The Optional Query Parameters
+                * @return {Promise<SoftSortBeltModel[]>}
+                */
+            static getAll(siteId: number, queryParameters?: SoftSortBeltController.GetAllQueryParameters): Promise<SoftSortBeltModel[]>;
+            /**
+                * Create a Soft Sort Belt [POST /packhouse/sites/{siteId}/soft-sort-belts]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {SoftSortBeltController.CreateData} createData The Soft Sort Belt Create Data
+                * @return {Promise<SoftSortBeltModel>}
+                */
+            static create(siteId: number, createData: SoftSortBeltController.CreateData): Promise<SoftSortBeltModel>;
+            /**
+                * Retrieve the Events of all Soft Sort Belts [GET /packhouse/sites/{siteId}/soft-sort-belts/events]
+                *
+                * Retrieves Events for all Soft Sort Belts
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {SoftSortBeltController.GetAllEventsQueryParameters} [queryParameters] The Optional Query Parameters
+                * @return {Promise<Array<SoftSortBeltController.SoftSortEventItem>>}
+                */
+            static getAllEvents(siteId: number, queryParameters?: SoftSortBeltController.GetAllEventsQueryParameters): Promise<Array<SoftSortBeltController.SoftSortEventItem>>;
+    }
+    namespace SoftSortBeltController {
+            /**
+                * The Optional Query Parameters for the getOneEvents Function
+                */
+            export type GetOneEventsQueryParameters = {
+                    /**
+                        * The Beginning Timestamp of the Soft-Sort Event Results. Defaults to 24 Hours ago
+                        */
+                    timestampBegin?: Date;
+                    /**
+                        * The End Timestamp of the Soft-Sort Event Results. Defaults to Now
+                        */
+                    timestampEnd?: Date;
+            };
+            /**
+                * The Optional Query Parameters for the getAll Function
+                */
+            export type GetAllQueryParameters = {
+                    /**
+                        * The RTU this Soft Sort Belt belongs to
+                        */
+                    rtuId?: number;
+                    /**
+                        * The Name of this Soft Sort Belt
+                        */
+                    name?: string;
+                    /**
+                        * The Packing Line that owns this Soft Sort Belt
+                        */
+                    packingLineId?: string;
+            };
+            /**
+                * The Optional Query Parameters for the getAllEvents Function
+                */
+            export type GetAllEventsQueryParameters = {
+                    /**
+                        * A List of Soft-Sort Belt IDs to Filter by
+                        */
+                    beltIds?: string[];
+                    /**
+                        * The Beginning Timestamp of the Soft-Sort Event Results. Defaults to 24 Hours ago
+                        */
+                    timestampBegin?: Date;
+                    /**
+                        * The End Timestamp of the Soft-Sort Event Results. Defaults to Now
+                        */
+                    timestampEnd?: Date;
+            };
+            /**
+                * The Create Data for a Soft Sort Belt
+                */
+            export type CreateData = {
+                    /**
+                        * The RTU this Soft Sort Belt belongs to
+                        */
+                    rtuId?: number;
+                    /**
+                        * The Name of this Soft Sort Belt
+                        */
+                    name: string;
+                    /**
+                        * The Points used by this Soft Sort Belt
+                        */
+                    points: any;
+                    /**
+                        * The Packing Line that owns this Soft Sort Belt
+                        */
+                    packingLineId: string;
+            };
+            /**
+                * The Update Data for a Soft Sort Belt
+                */
+            export type UpdateData = {
+                    /**
+                        * The Name of this Soft Sort Belt
+                        */
+                    name?: string;
+                    /**
+                        * The Points used by this Soft Sort Belt
+                        */
+                    points?: any;
+                    /**
+                        * The Packing Line that owns this Soft Sort Belt
+                        */
+                    packingLineId?: string;
+            };
+            /**
+                * A **SoftSortEventItem** Type
+                */
+            export type SoftSortEventItem = {
+                    /**
+                        * The Soft-Sort Belt ID
+                        */
+                    beltId: string;
+                    /**
+                        * The ID of the associated Packrun
+                        */
+                    packrunId: string;
+                    /**
+                        * The Name of the associated Packrun
+                        */
+                    packrunName: string;
+                    /**
+                        * When the Event Started
+                        */
+                    startTimestamp: Date;
+                    /**
+                        * When the Event Ended
+                        */
+                    endTimestamp: Date;
+                    /**
+                        * The Duration in Seconds of the Event
+                        */
+                    duration: number;
+            };
+    }
+    import SoftSortBeltModel from "@ricado/api-client/Models/Packhouse/Site/SoftSortBeltModel";
+}
+
 declare module '@ricado/api-client/Controllers/Packhouse/Site/VarietyController' {
     export default VarietyController;
     /**
@@ -12164,10 +12464,89 @@ declare module '@ricado/api-client/Models/Packhouse/Site/RejectBinScaleModel' {
             /**
                 * The Auto Packrun Change Configuration for this Reject Bin Scale
                 *
+                * @type {?{delay: ?number}}
+                * @public
+                */
+            autoPackrunChange: {
+                    delay: number | null;
+            };
+            /**
+                * Whether this Reject Bin Scale supports Live Weighing
+                *
+                * @type {?boolean}
+                * @public
+                */
+            supportsLiveWeighing: boolean | null;
+            /**
+                * The Minimum Weight Change Required to Automatically Start Live Weighing
+                *
                 * @type {?number}
                 * @public
                 */
-            autoPackrunChange: number | null;
+            autoWeighingStartThreshold: number | null;
+            /**
+                * The Delay in Milliseconds before Auto Live Weighing would Start
+                *
+                * @type {?number}
+                * @public
+                */
+            autoWeighingStartDelay: number | null;
+            /**
+                * The Minimum Weight Change Required to Automatically Finish Live Weighing
+                *
+                * @type {?number}
+                * @public
+                */
+            autoWeighingFinishThreshold: number | null;
+            /**
+                * The Delay in Milliseconds before Auto Live Weighing would Finish
+                *
+                * @type {?number}
+                * @public
+                */
+            autoWeighingFinishDelay: number | null;
+            /**
+                * The Maximum Duration in Milliseconds before a Manual Intervention would end
+                *
+                * @type {?number}
+                * @public
+                */
+            manualInterventionMaximumDuration: number | null;
+            /**
+                * The Maximum Weight Increase allowed within a single Live Weighing Update Interval
+                *
+                * @type {?number}
+                * @public
+                */
+            liveWeighingIncreaseTolerance: number | null;
+            /**
+                * The Maximum Weight Decrease allowed within a single Live Weighing Update Interval
+                *
+                * @type {?number}
+                * @public
+                */
+            liveWeighingDecreaseTolerance: number | null;
+            /**
+                * The Interval in Milliseconds between Live Weighing Updates
+                *
+                * @type {?number}
+                * @public
+                */
+            liveWeighingUpdateInterval: number | null;
+            /**
+                * Whether the Loadcell Stable Status is used to ignore Changes during Live Weighing
+                *
+                * @type {?boolean}
+                * @public
+                */
+            liveWeighingUsesStableStatus: boolean | null;
+            /**
+                * The Maximum Weight Change allowed while Live Weighing before an Incorrect Operation is Logged
+                *
+                * @type {?number}
+                * @public
+                */
+            incorrectOperationTolerance: number | null;
             /**
                 * The FreshPack Integration Configuration for this Reject Bin Scale
                 *
@@ -12925,6 +13304,95 @@ declare module '@ricado/api-client/Models/Packhouse/Site/ShiftModel' {
     import BaseModel from "@ricado/api-client/Models/BaseModel";
 }
 
+declare module '@ricado/api-client/Models/Packhouse/Site/SoftSortBeltModel' {
+    export default SoftSortBeltModel;
+    /**
+        * Model Class for a Soft Sort Belt
+        *
+        * @class
+        * @hideconstructor
+        * @extends BaseModel
+        */
+    class SoftSortBeltModel extends BaseModel {
+            /**
+                * Create a new **SoftSortBeltModel** from a JSON Object or JSON String
+                *
+                * @static
+                * @public
+                * @param {Object<string, any>|string} json A JSON Object or JSON String
+                * @param {number} siteId The Site ID associated with this Soft Sort Belt
+                * @return {SoftSortBeltModel}
+                */
+            static fromJSON(json: {
+                    [x: string]: any;
+            } | string, siteId: number): SoftSortBeltModel;
+            /**
+                * SoftSortBeltModel Constructor
+                *
+                * @protected
+                * @param {number} siteId The Site ID associated with this Soft Sort Belt
+                */
+            protected constructor();
+            /**
+                * The Soft Sort Belt ID
+                *
+                * @type {string}
+                * @public
+                */
+            id: string;
+            /**
+                * The RTU this Soft Sort Belt belongs to
+                *
+                * @type {?number}
+                * @public
+                */
+            rtuId: number | null;
+            /**
+                * The Name of this Soft Sort Belt
+                *
+                * @type {string}
+                * @public
+                */
+            name: string;
+            /**
+                * The Points used by this Soft Sort Belt
+                *
+                * @type {Object}
+                * @public
+                */
+            points: any;
+            /**
+                * The Packing Line that owns this Soft Sort Belt
+                *
+                * @type {string}
+                * @public
+                */
+            packingLineId: string;
+            /**
+                * Whether the Soft Sort Belt has been deleted
+                *
+                * @type {boolean}
+                * @public
+                */
+            deleted: boolean;
+            /**
+                * When the Soft Sort Belt was last updated
+                *
+                * @type {Date}
+                * @public
+                */
+            updateTimestamp: Date;
+            /**
+                * The Site ID associated with this Soft Sort Belt
+                *
+                * @type {number}
+                * @public
+                */
+            siteId: number;
+    }
+    import BaseModel from "@ricado/api-client/Models/BaseModel";
+}
+
 declare module '@ricado/api-client/Models/Packhouse/Site/VarietyModel' {
     export default VarietyModel;
     /**

package/package.json

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

package/src/Controllers/Packhouse/Site/RejectBinScaleController.js

@@ -166,7 +166,18 @@ export default RejectBinScaleController;
  * @property {?string} [packrunSourceId] The Permanent Object that provides the Next Packrun for this Reject Bin Scale
  * @property {?number} [packrunGroup] The Packrun Group this Reject Bin Scale is a part of
  * @property {Object[]} [sources] An Array of Sources that deliver Fruit to this Reject Bin Scale
- * @property {?number} [autoPackrunChange] The Auto Packrun Change Configuration for this Reject Bin Scale
+ * @property {?{delay: ?number}} [autoPackrunChange] The Auto Packrun Change Configuration for this Reject Bin Scale
+ * @property {?boolean} [supportsLiveWeighing] Whether this Reject Bin Scale supports Live Weighing
+ * @property {?number} [autoWeighingStartThreshold] The Minimum Weight Change Required to Automatically Start Live Weighing
+ * @property {?number} [autoWeighingStartDelay] The Delay in Milliseconds before Auto Live Weighing would Start
+ * @property {?number} [autoWeighingFinishThreshold] The Minimum Weight Change Required to Automatically Finish Live Weighing
+ * @property {?number} [autoWeighingFinishDelay] The Delay in Milliseconds before Auto Live Weighing would Finish
+ * @property {?number} [manualInterventionMaximumDuration] The Maximum Duration in Milliseconds before a Manual Intervention would end
+ * @property {?number} [liveWeighingIncreaseTolerance] The Maximum Weight Increase allowed within a single Live Weighing Update Interval
+ * @property {?number} [liveWeighingDecreaseTolerance] The Maximum Weight Decrease allowed within a single Live Weighing Update Interval
+ * @property {?number} [liveWeighingUpdateInterval] The Interval in Milliseconds between Live Weighing Updates
+ * @property {?boolean} [liveWeighingUsesStableStatus] Whether the Loadcell Stable Status is used to ignore Changes during Live Weighing
+ * @property {?number} [incorrectOperationTolerance] The Maximum Weight Change allowed while Live Weighing before an Incorrect Operation is Logged
  * @property {?Object} [freshPackIntegration] The FreshPack Integration Configuration for this Reject Bin Scale
  * @memberof Controllers.Packhouse.Site
  */
@@ -181,7 +192,18 @@ export default RejectBinScaleController;
  * @property {?string} [packrunSourceId] The Permanent Object that provides the Next Packrun for this Reject Bin Scale
  * @property {?number} [packrunGroup] The Packrun Group this Reject Bin Scale is a part of
  * @property {Object[]} [sources] An Array of Sources that deliver Fruit to this Reject Bin Scale
- * @property {?number} [autoPackrunChange] The Auto Packrun Change Configuration for this Reject Bin Scale
+ * @property {?{delay: ?number}} [autoPackrunChange] The Auto Packrun Change Configuration for this Reject Bin Scale
+ * @property {?boolean} [supportsLiveWeighing] Whether this Reject Bin Scale supports Live Weighing
+ * @property {?number} [autoWeighingStartThreshold] The Minimum Weight Change Required to Automatically Start Live Weighing
+ * @property {?number} [autoWeighingStartDelay] The Delay in Milliseconds before Auto Live Weighing would Start
+ * @property {?number} [autoWeighingFinishThreshold] The Minimum Weight Change Required to Automatically Finish Live Weighing
+ * @property {?number} [autoWeighingFinishDelay] The Delay in Milliseconds before Auto Live Weighing would Finish
+ * @property {?number} [manualInterventionMaximumDuration] The Maximum Duration in Milliseconds before a Manual Intervention would end
+ * @property {?number} [liveWeighingIncreaseTolerance] The Maximum Weight Increase allowed within a single Live Weighing Update Interval
+ * @property {?number} [liveWeighingDecreaseTolerance] The Maximum Weight Decrease allowed within a single Live Weighing Update Interval
+ * @property {?number} [liveWeighingUpdateInterval] The Interval in Milliseconds between Live Weighing Updates
+ * @property {?boolean} [liveWeighingUsesStableStatus] Whether the Loadcell Stable Status is used to ignore Changes during Live Weighing
+ * @property {?number} [incorrectOperationTolerance] The Maximum Weight Change allowed while Live Weighing before an Incorrect Operation is Logged
  * @property {?Object} [freshPackIntegration] The FreshPack Integration Configuration for this Reject Bin Scale
  * @memberof Controllers.Packhouse.Site
  */