@ricado/api-client 2.3.11 → 2.3.12

package/lib/index.d.ts

@@ -3158,6 +3158,7 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site' {
         export { ShiftFocusMeetingController };
         export { ShiftHourlyEntryController };
         export { ShiftQualitySummaryController };
+        export { ShiftSummaryReportController };
         export { ShiftTaskController };
         export { SoftSortBeltController };
         export { SoftSortPackrunSummaryController };
@@ -3190,6 +3191,7 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site' {
     import ShiftFocusMeetingController from "@ricado/api-client/Controllers/Packhouse/Site/ShiftFocusMeetingController";
     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";
     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";
@@ -4761,6 +4763,7 @@ declare module '@ricado/api-client/Models/Packhouse/Site' {
         export { ShiftHourlyEntryModel };
         export { ShiftModel };
         export { ShiftQualitySummaryModel };
+        export { ShiftSummaryReportModel };
         export { ShiftTaskModel };
         export { SoftSortBeltModel };
         export { SoftSortPackrunSummaryModel };
@@ -4793,6 +4796,7 @@ declare module '@ricado/api-client/Models/Packhouse/Site' {
     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";
+    import ShiftSummaryReportModel from "@ricado/api-client/Models/Packhouse/Site/ShiftSummaryReportModel";
     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";
@@ -13363,6 +13367,320 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/ShiftQualitySummar
     import ShiftQualitySummaryModel from "@ricado/api-client/Models/Packhouse/Site/ShiftQualitySummaryModel";
 }
 
+declare module '@ricado/api-client/Controllers/Packhouse/Site/ShiftSummaryReportController' {
+    export default ShiftSummaryReportController;
+    /**
+        * Controller Class for Shift Summary Reports
+        *
+        * @class
+        */
+    class ShiftSummaryReportController {
+            /**
+                * Retrieve a Shift Summary Report [GET /packhouse/sites/{siteId}/shift-summary-reports/{id}]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Shift Summary Report ID
+                * @return {Promise<ShiftSummaryReportModel>}
+                */
+            static getOne(siteId: number, id: string): Promise<ShiftSummaryReportModel>;
+            /**
+                * Update a Shift Summary Report [PATCH /packhouse/sites/{siteId}/shift-summary-reports/{id}]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Shift Summary Report ID
+                * @param {ShiftSummaryReportController.UpdateData} updateData The Shift Summary Report Update Data
+                * @return {Promise<ShiftSummaryReportModel>}
+                */
+            static update(siteId: number, id: string, updateData: ShiftSummaryReportController.UpdateData): Promise<ShiftSummaryReportModel>;
+            /**
+                * Delete a Shift Summary Report [DELETE /packhouse/sites/{siteId}/shift-summary-reports/{id}]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Shift Summary Report ID
+                * @return {Promise<boolean>}
+                */
+            static delete(siteId: number, id: string): Promise<boolean>;
+            /**
+                * Retrieve Comments [GET /packhouse/sites/{siteId}/shift-summary-reports/{id}/comments]
+                *
+                * Retrieves Comments for a Shift Summary Report
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Shift Summary Report ID
+                * @return {Promise<Array<ShiftSummaryReportController.CommentItem>>}
+                */
+            static getComments(siteId: number, id: string): Promise<Array<ShiftSummaryReportController.CommentItem>>;
+            /**
+                * Create a Comment [POST /packhouse/sites/{siteId}/shift-summary-reports/{id}/comments]
+                *
+                * Create a Comment for a Shift Summary Report
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Shift Summary Report ID
+                * @param {string} content The Content of the New Comment
+                * @return {Promise<ShiftSummaryReportController.CommentItem>}
+                */
+            static createComment(siteId: number, id: string, content: string): Promise<ShiftSummaryReportController.CommentItem>;
+            /**
+                * Retrieve a Comment [GET /packhouse/sites/{siteId}/shift-summary-reports/{id}/comments/{commentId}]
+                *
+                * Retrieves Comments for a Shift Summary Report
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Shift Summary Report ID
+                * @param {string} commentId The Comment ID
+                * @return {Promise<ShiftSummaryReportController.CommentItem>}
+                */
+            static getOneComment(siteId: number, id: string, commentId: string): Promise<ShiftSummaryReportController.CommentItem>;
+            /**
+                * Update a Comment [PATCH /packhouse/sites/{siteId}/shift-summary-reports/{id}/comments/{commentId}]
+                *
+                * Update a Comment for a Shift Summary Report
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Shift Summary Report ID
+                * @param {string} commentId The Comment ID
+                * @param {string} content The Updated Content for the Comment
+                * @return {Promise<ShiftSummaryReportController.CommentItem>}
+                */
+            static updateOneComment(siteId: number, id: string, commentId: string, content: string): Promise<ShiftSummaryReportController.CommentItem>;
+            /**
+                * Delete a Comment [DELETE /packhouse/sites/{siteId}/shift-summary-reports/{id}/comments/{commentId}]
+                *
+                * Delete a Comment for a Shift Summary Report
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Shift Summary Report ID
+                * @param {string} commentId The Comment ID
+                * @return {Promise<boolean>}
+                */
+            static deleteOneComment(siteId: number, id: string, commentId: string): Promise<boolean>;
+            /**
+                * List all Shift Summary Reports [GET /packhouse/sites/{siteId}/shift-summary-reports]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {ShiftSummaryReportController.GetAllQueryParameters} [queryParameters] The Optional Query Parameters
+                * @return {Promise<ShiftSummaryReportModel[]>}
+                */
+            static getAll(siteId: number, queryParameters?: ShiftSummaryReportController.GetAllQueryParameters | undefined): Promise<ShiftSummaryReportModel[]>;
+            /**
+                * Create a Shift Summary Report [POST /packhouse/sites/{siteId}/shift-summary-reports]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {ShiftSummaryReportController.CreateData} createData The Shift Summary Report Create Data
+                * @return {Promise<ShiftSummaryReportModel>}
+                */
+            static create(siteId: number, createData: ShiftSummaryReportController.CreateData): Promise<ShiftSummaryReportModel>;
+    }
+    namespace ShiftSummaryReportController {
+            /**
+                * The Optional Query Parameters for the getAll Function
+                */
+            export type GetAllQueryParameters = {
+                    /**
+                        * The Packing Line ID this Summary Report is associated with
+                        */
+                    packingLineId?: string;
+                    /**
+                        * The Shift ID this Summary Report relates to
+                        */
+                    shiftId?: string;
+                    /**
+                        * Whether the Report is in the process of being Emailed
+                        */
+                    status?: string;
+                    /**
+                        * Filter by the Timestamp when Summary Reports were Created. Results Greater than or Equal to Timestamp
+                        */
+                    createdTimestampBegin?: Date;
+                    /**
+                        * Filter by the Timestamp when Summary Reports were Created. Results Less than or Equal to Timestamp
+                        */
+                    createdTimestampEnd?: Date;
+                    /**
+                        * Filter by the Timestamp when Summary Reports were last Updated. Results Greater than or Equal to Timestamp
+                        */
+                    updateTimestampBegin?: Date;
+                    /**
+                        * Filter by the Timestamp when Summary Reports were last Updated. Results Less than or Equal to Timestamp
+                        */
+                    updateTimestampEnd?: Date;
+            };
+            /**
+                * The Create Data for a Shift Summary Report
+                */
+            export type CreateData = {
+                    /**
+                        * The Packing Line ID this Summary Report is associated with
+                        */
+                    packingLineId: string;
+                    /**
+                        * The Shift ID this Summary Report relates to
+                        */
+                    shiftId?: string;
+                    /**
+                        * When this Summary Report was Created
+                        */
+                    createdTimestamp?: Date;
+                    /**
+                        * The Base64 Encoded PDF Report
+                        */
+                    pdfReportContent?: string | null;
+                    /**
+                        * The Filename that should be used with the PDF Report
+                        */
+                    pdfReportFileName: string | null;
+                    /**
+                        * The SendGrid API Status indicating progress when sending emails
+                        */
+                    sendGridApi?: SendGridApiResult | null;
+                    /**
+                        * Whether the Report is in the process of being Emailed
+                        */
+                    status: string;
+                    /**
+                        * An Array of Email Contacts that were sent this Summary Report
+                        */
+                    emailContacts?: EmailContact[];
+            };
+            /**
+                * The Update Data for a Shift Summary Report
+                */
+            export type UpdateData = {
+                    /**
+                        * The Packing Line ID this Summary Report is associated with
+                        */
+                    packingLineId?: string;
+                    /**
+                        * When this Summary Report was Created
+                        */
+                    createdTimestamp?: Date;
+                    /**
+                        * The Base64 Encoded PDF Report
+                        */
+                    pdfReportContent?: string | null;
+                    /**
+                        * The Filename that should be used with the PDF Report
+                        */
+                    pdfReportFileName?: string | null;
+                    /**
+                        * The SendGrid API Status indicating progress when sending emails
+                        */
+                    sendGridApi?: SendGridApiResult | null;
+                    /**
+                        * Whether the Report is in the process of being Emailed
+                        */
+                    status?: string;
+                    /**
+                        * An Array of Email Contacts that were sent this Summary Report
+                        */
+                    emailContacts?: EmailContact[];
+            };
+            /**
+                * 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 **SendGridApiResult** Type
+                */
+            export type SendGridApiResult = {
+                    /**
+                        * The Number of API Requests made to SendGrid
+                        */
+                    requestCount: number;
+                    /**
+                        * When the latest API Request was made
+                        */
+                    requestTimestamp: Date | null;
+                    /**
+                        * The HTTP Response Code received from the SendGrid API
+                        */
+                    responseCode: number | null;
+                    /**
+                        * The HTTP Response Message received from the SendGrid API
+                        */
+                    responseMessage: string | null;
+                    /**
+                        * Whether the sending of API Requests has been completed
+                        */
+                    completed: boolean;
+            };
+            /**
+                * A **EmailContact** Type
+                */
+            export type EmailContact = {
+                    /**
+                        * Email Address of the Contact
+                        */
+                    email: string;
+                    /**
+                        * First Name of the Contact
+                        */
+                    firstName: string;
+                    /**
+                        * Last Name of the Contact
+                        */
+                    lastName: string;
+            };
+    }
+    import ShiftSummaryReportModel from "@ricado/api-client/Models/Packhouse/Site/ShiftSummaryReportModel";
+}
+
 declare module '@ricado/api-client/Controllers/Packhouse/Site/ShiftTaskController' {
     export default ShiftTaskController;
     /**
@@ -18063,6 +18381,133 @@ declare module '@ricado/api-client/Models/Packhouse/Site/ShiftQualitySummaryMode
     import BaseModel from "@ricado/api-client/Models/BaseModel";
 }
 
+declare module '@ricado/api-client/Models/Packhouse/Site/ShiftSummaryReportModel' {
+    export default ShiftSummaryReportModel;
+    /**
+        * Model Class for a Shift Summary Report
+        *
+        * @class
+        * @hideconstructor
+        * @extends BaseModel
+        */
+    class ShiftSummaryReportModel extends BaseModel {
+            /**
+                * Create a new **ShiftSummaryReportModel** 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 Summary Report
+                * @return {ShiftSummaryReportModel}
+                */
+            static fromJSON(json: {
+                    [x: string]: any;
+            } | string, siteId: number): ShiftSummaryReportModel;
+            /**
+                * ShiftSummaryReportModel Constructor
+                *
+                * @protected
+                * @param {number} siteId The Site ID associated with this Shift Summary Report
+                */
+            protected constructor();
+            /**
+                * The Shift Summary Report ID
+                *
+                * @type {string}
+                * @public
+                */
+            id: string;
+            /**
+                * The Packing Line ID this Summary Report is associated with
+                *
+                * @type {string}
+                * @public
+                */
+            packingLineId: string;
+            /**
+                * The Shift ID this Summary Report relates to
+                *
+                * @type {string}
+                * @public
+                */
+            shiftId: string;
+            /**
+                * When this Summary Report was Created
+                *
+                * @type {Date}
+                * @public
+                */
+            createdTimestamp: Date;
+            /**
+                * The Base64 Encoded PDF Report
+                *
+                * @type {?string}
+                * @public
+                */
+            pdfReportContent: string | null;
+            /**
+                * The Filename that should be used with the PDF Report
+                *
+                * @type {?string}
+                * @public
+                */
+            pdfReportFileName: string | null;
+            /**
+                * The SendGrid API Status indicating progress when sending emails
+                *
+                * @type {?{requestCount: number, requestTimestamp: ?Date, responseCode: ?number, responseMessage: ?string, completed: boolean}}
+                * @public
+                */
+            sendGridApi: {
+                    requestCount: number;
+                    requestTimestamp: Date | null;
+                    responseCode: number | null;
+                    responseMessage: string | null;
+                    completed: boolean;
+            } | null;
+            /**
+                * Whether the Report is in the process of being Emailed
+                *
+                * @type {string}
+                * @public
+                */
+            status: string;
+            /**
+                * An Array of Email Contacts that were sent this Summary Report
+                *
+                * @type {Array<{email: string, firstName: string, lastName: string}>}
+                * @public
+                */
+            emailContacts: {
+                    email: string;
+                    firstName: string;
+                    lastName: string;
+            }[];
+            /**
+                * Whether the Shift Summary Report has been deleted
+                *
+                * @type {boolean}
+                * @public
+                */
+            deleted: boolean;
+            /**
+                * When the Shift Summary Report was last updated
+                *
+                * @type {Date}
+                * @public
+                */
+            updateTimestamp: Date;
+            /**
+                * The Site ID associated with this Shift Summary Report
+                *
+                * @type {number}
+                * @public
+                */
+            siteId: number;
+    }
+    import BaseModel from "@ricado/api-client/Models/BaseModel";
+}
+
 declare module '@ricado/api-client/Models/Packhouse/Site/ShiftTaskModel' {
     export default ShiftTaskModel;
     /**

package/package.json

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