@ricado/api-client 2.3.24 → 2.3.25

package/lib/index.d.ts

@@ -4333,6 +4333,7 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site' {
         export { PackTypeController };
         export { PackingLineController };
         export { PackrunController };
+        export { PrePackSampleController };
         export { RejectBinController };
         export { RejectBinScaleController };
         export { RejectBinWeightController };
@@ -4372,6 +4373,7 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site' {
     import PackTypeController from "@ricado/api-client/Controllers/Packhouse/Site/PackTypeController";
     import PackingLineController from "@ricado/api-client/Controllers/Packhouse/Site/PackingLineController";
     import PackrunController from "@ricado/api-client/Controllers/Packhouse/Site/PackrunController";
+    import PrePackSampleController from "@ricado/api-client/Controllers/Packhouse/Site/PrePackSampleController";
     import RejectBinController from "@ricado/api-client/Controllers/Packhouse/Site/RejectBinController";
     import RejectBinScaleController from "@ricado/api-client/Controllers/Packhouse/Site/RejectBinScaleController";
     import RejectBinWeightController from "@ricado/api-client/Controllers/Packhouse/Site/RejectBinWeightController";
@@ -5950,6 +5952,7 @@ declare module '@ricado/api-client/Models/Packhouse/Site' {
         export { PackTypeModel };
         export { PackingLineModel };
         export { PackrunModel };
+        export { PrePackSampleModel };
         export { RejectBinModel };
         export { RejectBinScaleModel };
         export { RejectBinWeightModel };
@@ -5989,6 +5992,7 @@ declare module '@ricado/api-client/Models/Packhouse/Site' {
     import PackTypeModel from "@ricado/api-client/Models/Packhouse/Site/PackTypeModel";
     import PackingLineModel from "@ricado/api-client/Models/Packhouse/Site/PackingLineModel";
     import PackrunModel from "@ricado/api-client/Models/Packhouse/Site/PackrunModel";
+    import PrePackSampleModel from "@ricado/api-client/Models/Packhouse/Site/PrePackSampleModel";
     import RejectBinModel from "@ricado/api-client/Models/Packhouse/Site/RejectBinModel";
     import RejectBinScaleModel from "@ricado/api-client/Models/Packhouse/Site/RejectBinScaleModel";
     import RejectBinWeightModel from "@ricado/api-client/Models/Packhouse/Site/RejectBinWeightModel";
@@ -15372,6 +15376,291 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/PackrunController'
     import PackrunModel from "@ricado/api-client/Models/Packhouse/Site/PackrunModel";
 }
 
+declare module '@ricado/api-client/Controllers/Packhouse/Site/PrePackSampleController' {
+    export default PrePackSampleController;
+    /**
+        * Controller Class for Pre-Pack Samples
+        *
+        * @class
+        */
+    class PrePackSampleController {
+            /**
+                * Retrieve a Pre-Pack Sample [GET /packhouse/sites/{siteId}/prepack-samples/{id}]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Pre-Pack Sample ID
+                * @return {Promise<PrePackSampleModel>}
+                */
+            static getOne(siteId: number, id: string): Promise<PrePackSampleModel>;
+            /**
+                * Update a Pre-Pack Sample [PATCH /packhouse/sites/{siteId}/prepack-samples/{id}]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Pre-Pack Sample ID
+                * @param {PrePackSampleController.UpdateData} updateData The Pre-Pack Sample Update Data
+                * @return {Promise<PrePackSampleModel>}
+                */
+            static update(siteId: number, id: string, updateData: PrePackSampleController.UpdateData): Promise<PrePackSampleModel>;
+            /**
+                * Delete a Pre-Pack Sample [DELETE /packhouse/sites/{siteId}/prepack-samples/{id}]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Pre-Pack Sample ID
+                * @return {Promise<boolean>}
+                */
+            static delete(siteId: number, id: string): Promise<boolean>;
+            /**
+                * Retrieve Comments [GET /packhouse/sites/{siteId}/prepack-samples/{id}/comments]
+                *
+                * Retrieves Comments for a Pre-Pack Sample
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Pre-Pack Sample ID
+                * @return {Promise<Array<PrePackSampleController.CommentItem>>}
+                */
+            static getComments(siteId: number, id: string): Promise<Array<PrePackSampleController.CommentItem>>;
+            /**
+                * Create a Comment [POST /packhouse/sites/{siteId}/prepack-samples/{id}/comments]
+                *
+                * Create a Comment for a Pre-Pack Sample
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Pre-Pack Sample ID
+                * @param {string} content The Content of the New Comment
+                * @return {Promise<PrePackSampleController.CommentItem>}
+                */
+            static createComment(siteId: number, id: string, content: string): Promise<PrePackSampleController.CommentItem>;
+            /**
+                * Retrieve a Comment [GET /packhouse/sites/{siteId}/prepack-samples/{id}/comments/{commentId}]
+                *
+                * Retrieves Comments for a Pre-Pack Sample
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Pre-Pack Sample ID
+                * @param {string} commentId The Comment ID
+                * @return {Promise<PrePackSampleController.CommentItem>}
+                */
+            static getOneComment(siteId: number, id: string, commentId: string): Promise<PrePackSampleController.CommentItem>;
+            /**
+                * Update a Comment [PATCH /packhouse/sites/{siteId}/prepack-samples/{id}/comments/{commentId}]
+                *
+                * Update a Comment for a Pre-Pack Sample
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Pre-Pack Sample ID
+                * @param {string} commentId The Comment ID
+                * @param {string} content The Updated Content for the Comment
+                * @return {Promise<PrePackSampleController.CommentItem>}
+                */
+            static updateOneComment(siteId: number, id: string, commentId: string, content: string): Promise<PrePackSampleController.CommentItem>;
+            /**
+                * Delete a Comment [DELETE /packhouse/sites/{siteId}/prepack-samples/{id}/comments/{commentId}]
+                *
+                * Delete a Comment for a Pre-Pack Sample
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Pre-Pack Sample ID
+                * @param {string} commentId The Comment ID
+                * @return {Promise<boolean>}
+                */
+            static deleteOneComment(siteId: number, id: string, commentId: string): Promise<boolean>;
+            /**
+                * List all Pre-Pack Samples [GET /packhouse/sites/{siteId}/prepack-samples]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {PrePackSampleController.GetAllQueryParameters} [queryParameters] The Optional Query Parameters
+                * @return {Promise<PrePackSampleModel[]>}
+                */
+            static getAll(siteId: number, queryParameters?: PrePackSampleController.GetAllQueryParameters | undefined): Promise<PrePackSampleModel[]>;
+            /**
+                * Create a Pre-Pack Sample [POST /packhouse/sites/{siteId}/prepack-samples]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {PrePackSampleController.CreateData} createData The Pre-Pack Sample Create Data
+                * @return {Promise<PrePackSampleModel>}
+                */
+            static create(siteId: number, createData: PrePackSampleController.CreateData): Promise<PrePackSampleModel>;
+    }
+    namespace PrePackSampleController {
+            /**
+                * The Optional Query Parameters for the getAll Function
+                */
+            export type GetAllQueryParameters = {
+                    /**
+                        * The Packing Line ID this Sample is associated with
+                        */
+                    packingLineId?: string;
+                    /**
+                        * The Packrun ID this Sample is associated with
+                        */
+                    packrunId?: string;
+                    /**
+                        * The ID of the User who created this Pre-Pack Sample
+                        */
+                    userId?: string;
+                    /**
+                        * The Name of the User who created this Pre-Pack Sample
+                        */
+                    userName?: string;
+                    /**
+                        * Filter by the Timestamp when Pre-Pack Samples were Created. Results Greater than or Equal to Timestamp
+                        */
+                    createdTimestampBegin?: Date;
+                    /**
+                        * Filter by the Timestamp when Pre-Pack Samples were Created. Results Less than or Equal to Timestamp
+                        */
+                    createdTimestampEnd?: Date;
+                    /**
+                        * Filter by the Timestamp when Pre-Pack Samples were last Updated. Results Greater than or Equal to Timestamp
+                        */
+                    updateTimestampBegin?: Date;
+                    /**
+                        * Filter by the Timestamp when Pre-Pack Samples were last Updated. Results Less than or Equal to Timestamp
+                        */
+                    updateTimestampEnd?: Date;
+            };
+            /**
+                * The Create Data for a Pre-Pack Sample
+                */
+            export type CreateData = {
+                    /**
+                        * The Packing Line ID this Sample is associated with
+                        */
+                    packingLineId: string;
+                    /**
+                        * The Packrun ID this Sample is associated with
+                        */
+                    packrunId?: string;
+                    /**
+                        * When this Sample was Created
+                        */
+                    createdTimestamp?: Date;
+                    /**
+                        * The ID of the User who created this Pre-Pack Sample
+                        */
+                    userId: string;
+                    /**
+                        * The Name of the User who created this Pre-Pack Sample
+                        */
+                    userName: string;
+                    /**
+                        * An Array of Defects found in this Pre-Pack Sample
+                        */
+                    sampleDefects?: SampleDefect[];
+                    /**
+                        * The Total Number of Fruit Sampled in this Pre-Pack Sample
+                        */
+                    totalFruitSampled?: number;
+            };
+            /**
+                * The Update Data for a Pre-Pack Sample
+                */
+            export type UpdateData = {
+                    /**
+                        * The Packing Line ID this Sample is associated with
+                        */
+                    packingLineId?: string;
+                    /**
+                        * When this Sample was Created
+                        */
+                    createdTimestamp?: Date;
+                    /**
+                        * The ID of the User who created this Pre-Pack Sample
+                        */
+                    userId?: string;
+                    /**
+                        * The Name of the User who created this Pre-Pack Sample
+                        */
+                    userName?: string;
+                    /**
+                        * An Array of Defects found in this Pre-Pack Sample
+                        */
+                    sampleDefects?: SampleDefect[];
+                    /**
+                        * The Total Number of Fruit Sampled in this Pre-Pack Sample
+                        */
+                    totalFruitSampled?: number;
+            };
+            /**
+                * 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;
+            };
+            /**
+                * A **SampleDefect** Type
+                */
+            export type SampleDefect = {
+                    /**
+                        * A String ID for the Defect
+                        */
+                    id: string;
+                    /**
+                        * The Defect Name
+                        */
+                    name: string;
+                    /**
+                        * The Number of Fruit with this Defect
+                        */
+                    fruitCount: number;
+            };
+    }
+    import PrePackSampleModel from "@ricado/api-client/Models/Packhouse/Site/PrePackSampleModel";
+}
+
 declare module '@ricado/api-client/Controllers/Packhouse/Site/RejectBinController' {
     export default RejectBinController;
     /**
@@ -23508,6 +23797,120 @@ declare module '@ricado/api-client/Models/Packhouse/Site/PackrunModel' {
     import BaseModel from "@ricado/api-client/Models/BaseModel";
 }
 
+declare module '@ricado/api-client/Models/Packhouse/Site/PrePackSampleModel' {
+    export default PrePackSampleModel;
+    /**
+        * Model Class for a Pre-Pack Sample
+        *
+        * @class
+        * @hideconstructor
+        * @extends BaseModel
+        */
+    class PrePackSampleModel extends BaseModel {
+            /**
+                * Create a new **PrePackSampleModel** 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 Pre-Pack Sample
+                * @return {PrePackSampleModel}
+                */
+            static fromJSON(json: {
+                    [x: string]: any;
+            } | string, siteId: number): PrePackSampleModel;
+            /**
+                * PrePackSampleModel Constructor
+                *
+                * @protected
+                * @param {number} siteId The Site ID associated with this Pre-Pack Sample
+                */
+            protected constructor();
+            /**
+                * The Pre-Pack Sample ID
+                *
+                * @type {string}
+                * @public
+                */
+            id: string;
+            /**
+                * The Packing Line ID this Sample is associated with
+                *
+                * @type {string}
+                * @public
+                */
+            packingLineId: string;
+            /**
+                * The Packrun ID this Sample is associated with
+                *
+                * @type {string}
+                * @public
+                */
+            packrunId: string;
+            /**
+                * When this Sample was Created
+                *
+                * @type {Date}
+                * @public
+                */
+            createdTimestamp: Date;
+            /**
+                * The ID of the User who created this Pre-Pack Sample
+                *
+                * @type {string}
+                * @public
+                */
+            userId: string;
+            /**
+                * The Name of the User who created this Pre-Pack Sample
+                *
+                * @type {string}
+                * @public
+                */
+            userName: string;
+            /**
+                * An Array of Defects found in this Pre-Pack Sample
+                *
+                * @type {Array<{id: string, name: string, fruitCount: number}>}
+                * @public
+                */
+            sampleDefects: {
+                    id: string;
+                    name: string;
+                    fruitCount: number;
+            }[];
+            /**
+                * The Total Number of Fruit Sampled in this Pre-Pack Sample
+                *
+                * @type {number}
+                * @public
+                */
+            totalFruitSampled: number;
+            /**
+                * Whether the Pre-Pack Sample has been deleted
+                *
+                * @type {boolean}
+                * @public
+                */
+            deleted: boolean;
+            /**
+                * When the Pre-Pack Sample was last updated
+                *
+                * @type {Date}
+                * @public
+                */
+            updateTimestamp: Date;
+            /**
+                * The Site ID associated with this Pre-Pack Sample
+                *
+                * @type {number}
+                * @public
+                */
+            siteId: number;
+    }
+    import BaseModel from "@ricado/api-client/Models/BaseModel";
+}
+
 declare module '@ricado/api-client/Models/Packhouse/Site/RejectBinModel' {
     export default RejectBinModel;
     /**

package/package.json

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