@ricado/api-client 2.3.5 → 2.3.6

package/lib/index.d.ts

@@ -3155,6 +3155,7 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site' {
         export { ShiftQualitySummaryController };
         export { ShiftTaskController };
         export { SoftSortBeltController };
+        export { SoftSortPackrunSummaryController };
         export { VarietyController };
     }
     import BinTipBinController from "@ricado/api-client/Controllers/Packhouse/Site/BinTipBinController";
@@ -3181,6 +3182,7 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site' {
     import ShiftQualitySummaryController from "@ricado/api-client/Controllers/Packhouse/Site/ShiftQualitySummaryController";
     import ShiftTaskController from "@ricado/api-client/Controllers/Packhouse/Site/ShiftTaskController";
     import SoftSortBeltController from "@ricado/api-client/Controllers/Packhouse/Site/SoftSortBeltController";
+    import SoftSortPackrunSummaryController from "@ricado/api-client/Controllers/Packhouse/Site/SoftSortPackrunSummaryController";
     import VarietyController from "@ricado/api-client/Controllers/Packhouse/Site/VarietyController";
 }
 
@@ -4746,6 +4748,7 @@ declare module '@ricado/api-client/Models/Packhouse/Site' {
         export { ShiftQualitySummaryModel };
         export { ShiftTaskModel };
         export { SoftSortBeltModel };
+        export { SoftSortPackrunSummaryModel };
         export { VarietyModel };
     }
     import BinTipBinModel from "@ricado/api-client/Models/Packhouse/Site/BinTipBinModel";
@@ -4772,6 +4775,7 @@ declare module '@ricado/api-client/Models/Packhouse/Site' {
     import ShiftQualitySummaryModel from "@ricado/api-client/Models/Packhouse/Site/ShiftQualitySummaryModel";
     import ShiftTaskModel from "@ricado/api-client/Models/Packhouse/Site/ShiftTaskModel";
     import SoftSortBeltModel from "@ricado/api-client/Models/Packhouse/Site/SoftSortBeltModel";
+    import SoftSortPackrunSummaryModel from "@ricado/api-client/Models/Packhouse/Site/SoftSortPackrunSummaryModel";
     import VarietyModel from "@ricado/api-client/Models/Packhouse/Site/VarietyModel";
 }
 
@@ -11683,6 +11687,10 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/ShiftQualitySummar
                         * The Shift ID this Quality Summary is asssociated with
                         */
                     shiftId?: string;
+                    /**
+                        * When this Quality Summary was Published
+                        */
+                    publishTimestamp?: Date | null;
                     /**
                         * The User ID of the Quality Manager for this Summary
                         */
@@ -12432,6 +12440,298 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/SoftSortBeltContro
     import SoftSortBeltModel from "@ricado/api-client/Models/Packhouse/Site/SoftSortBeltModel";
 }
 
+declare module '@ricado/api-client/Controllers/Packhouse/Site/SoftSortPackrunSummaryController' {
+    export default SoftSortPackrunSummaryController;
+    /**
+        * Controller Class for Soft-Sort Packrun Summaries
+        *
+        * @class
+        */
+    class SoftSortPackrunSummaryController {
+            /**
+                * Retrieve a Soft-Sort Packrun Summary [GET /packhouse/sites/{siteId}/softsort-packrun-summaries/{id}]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Soft-Sort Packrun Summary ID
+                * @return {Promise<SoftSortPackrunSummaryModel>}
+                */
+            static getOne(siteId: number, id: string): Promise<SoftSortPackrunSummaryModel>;
+            /**
+                * Update a Soft-Sort Packrun Summary [PATCH /packhouse/sites/{siteId}/softsort-packrun-summaries/{id}]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Soft-Sort Packrun Summary ID
+                * @param {SoftSortPackrunSummaryController.UpdateData} updateData The Soft-Sort Packrun Summary Update Data
+                * @return {Promise<SoftSortPackrunSummaryModel>}
+                */
+            static update(siteId: number, id: string, updateData: SoftSortPackrunSummaryController.UpdateData): Promise<SoftSortPackrunSummaryModel>;
+            /**
+                * Delete a Soft-Sort Packrun Summary [DELETE /packhouse/sites/{siteId}/softsort-packrun-summaries/{id}]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Soft-Sort Packrun Summary ID
+                * @return {Promise<boolean>}
+                */
+            static delete(siteId: number, id: string): Promise<boolean>;
+            /**
+                * Retrieve Comments [GET /packhouse/sites/{siteId}/softsort-packrun-summaries/{id}/comments]
+                *
+                * Retrieves Comments for a Soft-Sort Packrun Summary
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Soft-Sort Packrun Summary ID
+                * @return {Promise<Array<SoftSortPackrunSummaryController.CommentItem>>}
+                */
+            static getComments(siteId: number, id: string): Promise<Array<SoftSortPackrunSummaryController.CommentItem>>;
+            /**
+                * Create a Comment [POST /packhouse/sites/{siteId}/softsort-packrun-summaries/{id}/comments]
+                *
+                * Create a Comment for a Soft-Sort Packrun Summary
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Soft-Sort Packrun Summary ID
+                * @param {string} content The Content of the New Comment
+                * @return {Promise<SoftSortPackrunSummaryController.CommentItem>}
+                */
+            static createComment(siteId: number, id: string, content: string): Promise<SoftSortPackrunSummaryController.CommentItem>;
+            /**
+                * Retrieve a Comment [GET /packhouse/sites/{siteId}/softsort-packrun-summaries/{id}/comments/{commentId}]
+                *
+                * Retrieves Comments for a Soft-Sort Packrun Summary
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Soft-Sort Packrun Summary ID
+                * @param {string} commentId The Comment ID
+                * @return {Promise<SoftSortPackrunSummaryController.CommentItem>}
+                */
+            static getOneComment(siteId: number, id: string, commentId: string): Promise<SoftSortPackrunSummaryController.CommentItem>;
+            /**
+                * Update a Comment [PATCH /packhouse/sites/{siteId}/softsort-packrun-summaries/{id}/comments/{commentId}]
+                *
+                * Update a Comment for a Soft-Sort Packrun Summary
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Soft-Sort Packrun Summary ID
+                * @param {string} commentId The Comment ID
+                * @param {string} content The Updated Content for the Comment
+                * @return {Promise<SoftSortPackrunSummaryController.CommentItem>}
+                */
+            static updateOneComment(siteId: number, id: string, commentId: string, content: string): Promise<SoftSortPackrunSummaryController.CommentItem>;
+            /**
+                * Delete a Comment [DELETE /packhouse/sites/{siteId}/softsort-packrun-summaries/{id}/comments/{commentId}]
+                *
+                * Delete a Comment for a Soft-Sort Packrun Summary
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Soft-Sort Packrun Summary ID
+                * @param {string} commentId The Comment ID
+                * @return {Promise<boolean>}
+                */
+            static deleteOneComment(siteId: number, id: string, commentId: string): Promise<boolean>;
+            /**
+                * List all Soft-Sort Packrun Summaries [GET /packhouse/sites/{siteId}/softsort-packrun-summaries]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {SoftSortPackrunSummaryController.GetAllQueryParameters} [queryParameters] The Optional Query Parameters
+                * @return {Promise<SoftSortPackrunSummaryModel[]>}
+                */
+            static getAll(siteId: number, queryParameters?: SoftSortPackrunSummaryController.GetAllQueryParameters | undefined): Promise<SoftSortPackrunSummaryModel[]>;
+            /**
+                * Create a Soft-Sort Packrun Summary [POST /packhouse/sites/{siteId}/softsort-packrun-summaries]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {SoftSortPackrunSummaryController.CreateData} createData The Soft-Sort Packrun Summary Create Data
+                * @return {Promise<SoftSortPackrunSummaryModel>}
+                */
+            static create(siteId: number, createData: SoftSortPackrunSummaryController.CreateData): Promise<SoftSortPackrunSummaryModel>;
+    }
+    namespace SoftSortPackrunSummaryController {
+            /**
+                * The Optional Query Parameters for the getAll Function
+                */
+            export type GetAllQueryParameters = {
+                    /**
+                        * The Packing Line ID this Summary is associated with
+                        */
+                    packingLineId?: string;
+                    /**
+                        * The Packrun ID this Summary is associated with
+                        */
+                    packrunId?: string;
+                    /**
+                        * Whether the Soft-Sort Events Data for this Summary has been Finalized
+                        */
+                    eventsFinalizedTimestamp?: Date | null;
+                    /**
+                        * Whether the Soft-Sort Events for this Summary are considered accurate or not
+                        */
+                    eventsAccurate?: boolean | null;
+                    /**
+                        * Filter by the Timestamp when this Soft-Sort Packrun Summary was Created. Results Greater than or Equal to Timestamp
+                        */
+                    createdTimestampBegin?: Date;
+                    /**
+                        * Filter by the Timestamp when this Soft-Sort Packrun Summary was Created. Results Less than or Equal to Timestamp
+                        */
+                    createdTimestampEnd?: Date;
+            };
+            /**
+                * The Create Data for a Soft-Sort Packrun Summary
+                */
+            export type CreateData = {
+                    /**
+                        * The Packing Line ID this Summary is associated with
+                        */
+                    packingLineId: string;
+                    /**
+                        * The Packrun ID this Summary is associated with
+                        */
+                    packrunId?: string;
+                    /**
+                        * When this Summary was Created
+                        */
+                    createdTimestamp?: Date;
+                    /**
+                        * The Number of Soft-Sort Events per Bin Tipped
+                        */
+                    eventsPerBin: number;
+                    /**
+                        * The Number of Soft-Sort Events that occurred for the Packrun
+                        */
+                    totalEventsCount: number;
+                    /**
+                        * The Average Duration of Soft-Sort Events for the Packrun expressed in Seconds
+                        */
+                    averageEventsDuration: number;
+                    /**
+                        * The Total Duration of all Soft-Sort Events for the Packrun expressed in Seconds
+                        */
+                    totalEventsDuration: number;
+                    /**
+                        * Whether the Soft-Sort Events Data for this Summary has been Finalized
+                        */
+                    eventsFinalizedTimestamp?: Date | null;
+                    /**
+                        * Whether the Soft-Sort Events for this Summary are considered accurate or not
+                        */
+                    eventsAccurate?: boolean | null;
+                    /**
+                        * A Reason for why the Events for this Summary are not accurate. Applies when `eventsAccurate` is false
+                        */
+                    eventsNotAccurateReason?: string | null;
+                    /**
+                        * The FreshPack Soft-Sort API Data
+                        */
+                    freshPackSoftSortApi?: any;
+            };
+            /**
+                * The Update Data for a Soft-Sort Packrun Summary
+                */
+            export type UpdateData = {
+                    /**
+                        * The Packing Line ID this Summary is associated with
+                        */
+                    packingLineId?: string;
+                    /**
+                        * When this Summary was Created
+                        */
+                    createdTimestamp?: Date;
+                    /**
+                        * The Number of Soft-Sort Events per Bin Tipped
+                        */
+                    eventsPerBin?: number;
+                    /**
+                        * The Number of Soft-Sort Events that occurred for the Packrun
+                        */
+                    totalEventsCount?: number;
+                    /**
+                        * The Average Duration of Soft-Sort Events for the Packrun expressed in Seconds
+                        */
+                    averageEventsDuration?: number;
+                    /**
+                        * The Total Duration of all Soft-Sort Events for the Packrun expressed in Seconds
+                        */
+                    totalEventsDuration?: number;
+                    /**
+                        * Whether the Soft-Sort Events Data for this Summary has been Finalized
+                        */
+                    eventsFinalizedTimestamp?: Date | null;
+                    /**
+                        * Whether the Soft-Sort Events for this Summary are considered accurate or not
+                        */
+                    eventsAccurate?: boolean | null;
+                    /**
+                        * A Reason for why the Events for this Summary are not accurate. Applies when `eventsAccurate` is false
+                        */
+                    eventsNotAccurateReason?: string | null;
+                    /**
+                        * The FreshPack Soft-Sort API Data
+                        */
+                    freshPackSoftSortApi?: any;
+            };
+            /**
+                * A **UserAccount** Type
+                */
+            export type UserAccount = {
+                    /**
+                        * The User Account ID
+                        */
+                    id: string | null;
+                    /**
+                        * The User's First Name
+                        */
+                    firstName: string | null;
+                    /**
+                        * The User's Last Name
+                        */
+                    lastName: string | null;
+            };
+            /**
+                * A **CommentItem** Type
+                */
+            export type CommentItem = {
+                    /**
+                        * The Comment ID
+                        */
+                    id: string;
+                    userAccount: UserAccount;
+                    /**
+                        * The Content of the Comment
+                        */
+                    content: string | null;
+                    /**
+                        * When the Comment was Created
+                        */
+                    createdTimestamp: Date | null;
+                    /**
+                        * When the Comment was last Updated
+                        */
+                    updatedTimestamp: Date | null;
+            };
+    }
+    import SoftSortPackrunSummaryModel from "@ricado/api-client/Models/Packhouse/Site/SoftSortPackrunSummaryModel";
+}
+
 declare module '@ricado/api-client/Controllers/Packhouse/Site/VarietyController' {
     export default VarietyController;
     /**
@@ -15884,6 +16184,144 @@ declare module '@ricado/api-client/Models/Packhouse/Site/SoftSortBeltModel' {
     import BaseModel from "@ricado/api-client/Models/BaseModel";
 }
 
+declare module '@ricado/api-client/Models/Packhouse/Site/SoftSortPackrunSummaryModel' {
+    export default SoftSortPackrunSummaryModel;
+    /**
+        * Model Class for a Soft-Sort Packrun Summary
+        *
+        * @class
+        * @hideconstructor
+        * @extends BaseModel
+        */
+    class SoftSortPackrunSummaryModel extends BaseModel {
+            /**
+                * Create a new **SoftSortPackrunSummaryModel** 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 Packrun Summary
+                * @return {SoftSortPackrunSummaryModel}
+                */
+            static fromJSON(json: {
+                    [x: string]: any;
+            } | string, siteId: number): SoftSortPackrunSummaryModel;
+            /**
+                * SoftSortPackrunSummaryModel Constructor
+                *
+                * @protected
+                * @param {number} siteId The Site ID associated with this Soft-Sort Packrun Summary
+                */
+            protected constructor();
+            /**
+                * The Soft-Sort Packrun Summary ID
+                *
+                * @type {string}
+                * @public
+                */
+            id: string;
+            /**
+                * The Packing Line ID this Summary is associated with
+                *
+                * @type {string}
+                * @public
+                */
+            packingLineId: string;
+            /**
+                * The Packrun ID this Summary is associated with
+                *
+                * @type {string}
+                * @public
+                */
+            packrunId: string;
+            /**
+                * When this Summary was Created
+                *
+                * @type {Date}
+                * @public
+                */
+            createdTimestamp: Date;
+            /**
+                * The Number of Soft-Sort Events per Bin Tipped
+                *
+                * @type {number}
+                * @public
+                */
+            eventsPerBin: number;
+            /**
+                * The Number of Soft-Sort Events that occurred for the Packrun
+                *
+                * @type {number}
+                * @public
+                */
+            totalEventsCount: number;
+            /**
+                * The Average Duration of Soft-Sort Events for the Packrun expressed in Seconds
+                *
+                * @type {number}
+                * @public
+                */
+            averageEventsDuration: number;
+            /**
+                * The Total Duration of all Soft-Sort Events for the Packrun expressed in Seconds
+                *
+                * @type {number}
+                * @public
+                */
+            totalEventsDuration: number;
+            /**
+                * Whether the Soft-Sort Events Data for this Summary has been Finalized
+                *
+                * @type {?Date}
+                * @public
+                */
+            eventsFinalizedTimestamp: Date | null;
+            /**
+                * Whether the Soft-Sort Events for this Summary are considered accurate or not
+                *
+                * @type {?boolean}
+                * @public
+                */
+            eventsAccurate: boolean | null;
+            /**
+                * A Reason for why the Events for this Summary are not accurate. Applies when `eventsAccurate` is false
+                *
+                * @type {?string}
+                * @public
+                */
+            eventsNotAccurateReason: string | null;
+            /**
+                * The FreshPack Soft-Sort API Data
+                *
+                * @type {?Object}
+                * @public
+                */
+            freshPackSoftSortApi: any | null;
+            /**
+                * Whether the Soft-Sort Packrun Summary has been deleted
+                *
+                * @type {boolean}
+                * @public
+                */
+            deleted: boolean;
+            /**
+                * When the Soft-Sort Packrun Summary was last updated
+                *
+                * @type {Date}
+                * @public
+                */
+            updateTimestamp: Date;
+            /**
+                * The Site ID associated with this Soft-Sort Packrun Summary
+                *
+                * @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.3.5",
+    "version": "2.3.6",
     "description": "RICADO Gen 4 API Client Library for NodeJS and Browsers",
     "author": {
         "name": "Ash Neilson"

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

@@ -957,6 +957,7 @@ export default ShiftQualitySummaryController;
  * @typedef {Object} ShiftQualitySummaryController.GetAllQueryParameters
  * @property {string} [packingLineId] The Packing Line ID this Quality Summary is associated with
  * @property {string} [shiftId] The Shift ID this Quality Summary is asssociated with
+ * @property {?Date} [publishTimestamp] When this Quality Summary was Published
  * @property {string} [qualityManagerUserId] The User ID of the Quality Manager for this Summary
  * @property {string} [qualityManagerName] The Name of the Quality Manager for this Summary
  * @property {Date} [createdTimestampBegin] Filter by the Timestamp when Quality Summaries were Created. Results Greater than or Equal to Timestamp