@ricado/api-client 2.3.22 → 2.3.23

package/lib/index.d.ts

@@ -1575,7 +1575,7 @@ declare module '@ricado/api-client/Controllers/TokenController' {
                 * The user must have an account that has been created on RICADO. A valid Email Address and Password will be required.
                 *
                 * **API Key Authentication**
-                * A valid API Key and API Secret will be required. These can be created in the RICADO Developers App at developers.ricado.co.nz.
+                * A valid API Key and API Secret will be required. These can be created in the RICADO Admin App at admin.ricado.co.nz.
                 *
                 * @static
                 * @public
@@ -4338,6 +4338,7 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site' {
         export { RejectBinWeightController };
         export { ShiftController };
         export { ShiftFocusMeetingController };
+        export { ShiftGrowerChangeMeetingController };
         export { ShiftHourlyEntryController };
         export { ShiftQualitySummaryController };
         export { ShiftSummaryReportController };
@@ -4376,6 +4377,7 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site' {
     import RejectBinWeightController from "@ricado/api-client/Controllers/Packhouse/Site/RejectBinWeightController";
     import ShiftController from "@ricado/api-client/Controllers/Packhouse/Site/ShiftController";
     import ShiftFocusMeetingController from "@ricado/api-client/Controllers/Packhouse/Site/ShiftFocusMeetingController";
+    import ShiftGrowerChangeMeetingController from "@ricado/api-client/Controllers/Packhouse/Site/ShiftGrowerChangeMeetingController";
     import ShiftHourlyEntryController from "@ricado/api-client/Controllers/Packhouse/Site/ShiftHourlyEntryController";
     import ShiftQualitySummaryController from "@ricado/api-client/Controllers/Packhouse/Site/ShiftQualitySummaryController";
     import ShiftSummaryReportController from "@ricado/api-client/Controllers/Packhouse/Site/ShiftSummaryReportController";
@@ -5952,6 +5954,7 @@ declare module '@ricado/api-client/Models/Packhouse/Site' {
         export { RejectBinScaleModel };
         export { RejectBinWeightModel };
         export { ShiftFocusMeetingModel };
+        export { ShiftGrowerChangeMeetingModel };
         export { ShiftHourlyEntryModel };
         export { ShiftModel };
         export { ShiftQualitySummaryModel };
@@ -5990,6 +5993,7 @@ declare module '@ricado/api-client/Models/Packhouse/Site' {
     import RejectBinScaleModel from "@ricado/api-client/Models/Packhouse/Site/RejectBinScaleModel";
     import RejectBinWeightModel from "@ricado/api-client/Models/Packhouse/Site/RejectBinWeightModel";
     import ShiftFocusMeetingModel from "@ricado/api-client/Models/Packhouse/Site/ShiftFocusMeetingModel";
+    import ShiftGrowerChangeMeetingModel from "@ricado/api-client/Models/Packhouse/Site/ShiftGrowerChangeMeetingModel";
     import ShiftHourlyEntryModel from "@ricado/api-client/Models/Packhouse/Site/ShiftHourlyEntryModel";
     import ShiftModel from "@ricado/api-client/Models/Packhouse/Site/ShiftModel";
     import ShiftQualitySummaryModel from "@ricado/api-client/Models/Packhouse/Site/ShiftQualitySummaryModel";
@@ -17242,6 +17246,302 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/ShiftFocusMeetingC
     import ShiftFocusMeetingModel from "@ricado/api-client/Models/Packhouse/Site/ShiftFocusMeetingModel";
 }
 
+declare module '@ricado/api-client/Controllers/Packhouse/Site/ShiftGrowerChangeMeetingController' {
+    export default ShiftGrowerChangeMeetingController;
+    /**
+        * Controller Class for Shift Grower Change Meetings
+        *
+        * @class
+        */
+    class ShiftGrowerChangeMeetingController {
+            /**
+                * Retrieve a Shift Grower Change Meeting [GET /packhouse/sites/{siteId}/shift-grower-change-meetings/{id}]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Shift Grower Change Meeting ID
+                * @return {Promise<ShiftGrowerChangeMeetingModel>}
+                */
+            static getOne(siteId: number, id: string): Promise<ShiftGrowerChangeMeetingModel>;
+            /**
+                * Update a Shift Grower Change Meeting [PATCH /packhouse/sites/{siteId}/shift-grower-change-meetings/{id}]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Shift Grower Change Meeting ID
+                * @param {ShiftGrowerChangeMeetingController.UpdateData} updateData The Shift Grower Change Meeting Update Data
+                * @return {Promise<ShiftGrowerChangeMeetingModel>}
+                */
+            static update(siteId: number, id: string, updateData: ShiftGrowerChangeMeetingController.UpdateData): Promise<ShiftGrowerChangeMeetingModel>;
+            /**
+                * Delete a Shift Grower Change Meeting [DELETE /packhouse/sites/{siteId}/shift-grower-change-meetings/{id}]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Shift Grower Change Meeting ID
+                * @return {Promise<boolean>}
+                */
+            static delete(siteId: number, id: string): Promise<boolean>;
+            /**
+                * Retrieve Comments [GET /packhouse/sites/{siteId}/shift-grower-change-meetings/{id}/comments]
+                *
+                * Retrieves Comments for a Shift Grower Change Meeting
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Shift Grower Change Meeting ID
+                * @return {Promise<Array<ShiftGrowerChangeMeetingController.CommentItem>>}
+                */
+            static getComments(siteId: number, id: string): Promise<Array<ShiftGrowerChangeMeetingController.CommentItem>>;
+            /**
+                * Create a Comment [POST /packhouse/sites/{siteId}/shift-grower-change-meetings/{id}/comments]
+                *
+                * Create a Comment for a Shift Grower Change Meeting
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Shift Grower Change Meeting ID
+                * @param {string} content The Content of the New Comment
+                * @return {Promise<ShiftGrowerChangeMeetingController.CommentItem>}
+                */
+            static createComment(siteId: number, id: string, content: string): Promise<ShiftGrowerChangeMeetingController.CommentItem>;
+            /**
+                * Retrieve a Comment [GET /packhouse/sites/{siteId}/shift-grower-change-meetings/{id}/comments/{commentId}]
+                *
+                * Retrieves Comments for a Shift Grower Change Meeting
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Shift Grower Change Meeting ID
+                * @param {string} commentId The Comment ID
+                * @return {Promise<ShiftGrowerChangeMeetingController.CommentItem>}
+                */
+            static getOneComment(siteId: number, id: string, commentId: string): Promise<ShiftGrowerChangeMeetingController.CommentItem>;
+            /**
+                * Update a Comment [PATCH /packhouse/sites/{siteId}/shift-grower-change-meetings/{id}/comments/{commentId}]
+                *
+                * Update a Comment for a Shift Grower Change Meeting
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Shift Grower Change Meeting ID
+                * @param {string} commentId The Comment ID
+                * @param {string} content The Updated Content for the Comment
+                * @return {Promise<ShiftGrowerChangeMeetingController.CommentItem>}
+                */
+            static updateOneComment(siteId: number, id: string, commentId: string, content: string): Promise<ShiftGrowerChangeMeetingController.CommentItem>;
+            /**
+                * Delete a Comment [DELETE /packhouse/sites/{siteId}/shift-grower-change-meetings/{id}/comments/{commentId}]
+                *
+                * Delete a Comment for a Shift Grower Change Meeting
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Shift Grower Change Meeting ID
+                * @param {string} commentId The Comment ID
+                * @return {Promise<boolean>}
+                */
+            static deleteOneComment(siteId: number, id: string, commentId: string): Promise<boolean>;
+            /**
+                * List all Shift Grower Change Meetings [GET /packhouse/sites/{siteId}/shift-grower-change-meetings]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {ShiftGrowerChangeMeetingController.GetAllQueryParameters} [queryParameters] The Optional Query Parameters
+                * @return {Promise<ShiftGrowerChangeMeetingModel[]>}
+                */
+            static getAll(siteId: number, queryParameters?: ShiftGrowerChangeMeetingController.GetAllQueryParameters | undefined): Promise<ShiftGrowerChangeMeetingModel[]>;
+            /**
+                * Create a Shift Grower Change Meeting [POST /packhouse/sites/{siteId}/shift-grower-change-meetings]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {ShiftGrowerChangeMeetingController.CreateData} createData The Shift Grower Change Meeting Create Data
+                * @return {Promise<ShiftGrowerChangeMeetingModel>}
+                */
+            static create(siteId: number, createData: ShiftGrowerChangeMeetingController.CreateData): Promise<ShiftGrowerChangeMeetingModel>;
+    }
+    namespace ShiftGrowerChangeMeetingController {
+            /**
+                * The Optional Query Parameters for the getAll Function
+                */
+            export type GetAllQueryParameters = {
+                    /**
+                        * The Packing Line ID this Grower Change Meeting is associated with
+                        */
+                    packingLineId?: string;
+                    /**
+                        * The Shift ID this Grower Change Meeting is asssociated with
+                        */
+                    shiftId?: string;
+                    /**
+                        * The Packrun ID this Grower Change Meeting relates to
+                        */
+                    packrunId?: string;
+                    /**
+                        * Filter by the Timestamp when Grower Change Meetings were Created. Results Greater than or Equal to Timestamp
+                        */
+                    createdTimestampBegin?: Date;
+                    /**
+                        * Filter by the Timestamp when Grower Change Meetings were Created. Results Less than or Equal to Timestamp
+                        */
+                    createdTimestampEnd?: Date;
+                    /**
+                        * Filter by the Timestamp when Grower Change Meetings were Scheduled to Begin. Results Greater than or Equal to Timestamp
+                        */
+                    scheduledTimestampBegin?: Date;
+                    /**
+                        * Filter by the Timestamp when Grower Change Meetings were Scheduled to Begin. Results Less than or Equal to Timestamp
+                        */
+                    scheduledTimestampEnd?: Date;
+                    /**
+                        * Filter by the Timestamp when Grower Change Meetings were Started. Results Greater than or Equal to Timestamp
+                        */
+                    startTimestampBegin?: Date;
+                    /**
+                        * Filter by the Timestamp when Grower Change Meetings were Started. Results Less than or Equal to Timestamp
+                        */
+                    startTimestampEnd?: Date;
+                    /**
+                        * Filter by the Timestamp when Grower Change Meetings were Completed. Results Greater than or Equal to Timestamp
+                        */
+                    finishTimestampBegin?: Date;
+                    /**
+                        * Filter by the Timestamp when Grower Change Meetings were Completed. Results Less than or Equal to Timestamp
+                        */
+                    finishTimestampEnd?: Date;
+                    /**
+                        * Filter by the Timestamp when Grower Change Meetings were last Updated. Results Greater than or Equal to Timestamp
+                        */
+                    updateTimestampBegin?: Date;
+                    /**
+                        * Filter by the Timestamp when Grower Change Meetings were last Updated. Results Less than or Equal to Timestamp
+                        */
+                    updateTimestampEnd?: Date;
+            };
+            /**
+                * The Create Data for a Shift Grower Change Meeting
+                */
+            export type CreateData = {
+                    /**
+                        * The Packing Line ID this Grower Change Meeting is associated with
+                        */
+                    packingLineId: string;
+                    /**
+                        * The Shift ID this Grower Change Meeting is asssociated with
+                        */
+                    shiftId?: string;
+                    /**
+                        * When this Grower Change Meeting was Created
+                        */
+                    createdTimestamp?: Date;
+                    /**
+                        * When this Grower Change Meeting is Scheduled to Begin
+                        */
+                    scheduledTimestamp?: Date;
+                    /**
+                        * When this Grower Change Meeting was Started
+                        */
+                    startTimestamp?: Date | null;
+                    /**
+                        * When this Grower Change Meeting was Completed
+                        */
+                    finishTimestamp?: Date | null;
+                    /**
+                        * The Packrun ID this Grower Change Meeting relates to
+                        */
+                    packrunId: string;
+                    /**
+                        * An Optional Rating between 1 and 10 on how Useful the Grower Change Meeting was
+                        */
+                    usefulRating?: number | null;
+            };
+            /**
+                * The Update Data for a Shift Grower Change Meeting
+                */
+            export type UpdateData = {
+                    /**
+                        * The Packing Line ID this Grower Change Meeting is associated with
+                        */
+                    packingLineId?: string;
+                    /**
+                        * When this Grower Change Meeting was Created
+                        */
+                    createdTimestamp?: Date;
+                    /**
+                        * When this Grower Change Meeting is Scheduled to Begin
+                        */
+                    scheduledTimestamp?: Date;
+                    /**
+                        * When this Grower Change Meeting was Started
+                        */
+                    startTimestamp?: Date | null;
+                    /**
+                        * When this Grower Change Meeting was Completed
+                        */
+                    finishTimestamp?: Date | null;
+                    /**
+                        * The Packrun ID this Grower Change Meeting relates to
+                        */
+                    packrunId?: string;
+                    /**
+                        * An Optional Rating between 1 and 10 on how Useful the Grower Change Meeting was
+                        */
+                    usefulRating?: number | null;
+            };
+            /**
+                * 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 ShiftGrowerChangeMeetingModel from "@ricado/api-client/Models/Packhouse/Site/ShiftGrowerChangeMeetingModel";
+}
+
 declare module '@ricado/api-client/Controllers/Packhouse/Site/ShiftHourlyEntryController' {
     export default ShiftHourlyEntryController;
     /**
@@ -23865,6 +24165,130 @@ declare module '@ricado/api-client/Models/Packhouse/Site/ShiftFocusMeetingModel'
     import BaseModel from "@ricado/api-client/Models/BaseModel";
 }
 
+declare module '@ricado/api-client/Models/Packhouse/Site/ShiftGrowerChangeMeetingModel' {
+    export default ShiftGrowerChangeMeetingModel;
+    /**
+        * Model Class for a Shift Grower Change Meeting
+        *
+        * @class
+        * @hideconstructor
+        * @extends BaseModel
+        */
+    class ShiftGrowerChangeMeetingModel extends BaseModel {
+            /**
+                * Create a new **ShiftGrowerChangeMeetingModel** 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 Shift Grower Change Meeting
+                * @return {ShiftGrowerChangeMeetingModel}
+                */
+            static fromJSON(json: {
+                    [x: string]: any;
+            } | string, siteId: number): ShiftGrowerChangeMeetingModel;
+            /**
+                * ShiftGrowerChangeMeetingModel Constructor
+                *
+                * @protected
+                * @param {number} siteId The Site ID associated with this Shift Grower Change Meeting
+                */
+            protected constructor();
+            /**
+                * The Shift Grower Change Meeting ID
+                *
+                * @type {string}
+                * @public
+                */
+            id: string;
+            /**
+                * The Packing Line ID this Grower Change Meeting is associated with
+                *
+                * @type {string}
+                * @public
+                */
+            packingLineId: string;
+            /**
+                * The Shift ID this Grower Change Meeting is asssociated with
+                *
+                * @type {string}
+                * @public
+                */
+            shiftId: string;
+            /**
+                * When this Grower Change Meeting was Created
+                *
+                * @type {Date}
+                * @public
+                */
+            createdTimestamp: Date;
+            /**
+                * When this Grower Change Meeting is Scheduled to Begin
+                *
+                * @type {Date}
+                * @public
+                */
+            scheduledTimestamp: Date;
+            /**
+                * When this Grower Change Meeting was Started
+                *
+                * @type {?Date}
+                * @public
+                */
+            startTimestamp: Date | null;
+            /**
+                * When this Grower Change Meeting was Completed
+                *
+                * @type {?Date}
+                * @public
+                */
+            finishTimestamp: Date | null;
+            /**
+                * The Packrun ID this Grower Change Meeting relates to
+                *
+                * @type {string}
+                * @public
+                */
+            packrunId: string;
+            /**
+                * An Optional Rating between 1 and 10 on how Useful the Grower Change Meeting was
+                *
+                * @type {?number}
+                * @public
+                */
+            usefulRating: number | null;
+            /**
+                * The Status of this Grower Change Meeting
+                *
+                * @type {string}
+                * @public
+                */
+            status: string;
+            /**
+                * Whether the Shift Grower Change Meeting has been deleted
+                *
+                * @type {boolean}
+                * @public
+                */
+            deleted: boolean;
+            /**
+                * When the Shift Grower Change Meeting was last updated
+                *
+                * @type {Date}
+                * @public
+                */
+            updateTimestamp: Date;
+            /**
+                * The Site ID associated with this Shift Grower Change Meeting
+                *
+                * @type {number}
+                * @public
+                */
+            siteId: number;
+    }
+    import BaseModel from "@ricado/api-client/Models/BaseModel";
+}
+
 declare module '@ricado/api-client/Models/Packhouse/Site/ShiftHourlyEntryModel' {
     export default ShiftHourlyEntryModel;
     /**

package/package.json

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