@ricado/api-client 2.3.6 → 2.3.9

package/lib/index.d.ts

@@ -3131,6 +3131,7 @@ declare module '@ricado/api-client/Models/Site' {
 declare module '@ricado/api-client/Controllers/Packhouse/Site' {
     export default Site;
     namespace Site {
+        export { BinTipBinCardController };
         export { BinTipBinController };
         export { BinTipWeightController };
         export { CompacSizerBatchController };
@@ -3158,6 +3159,7 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site' {
         export { SoftSortPackrunSummaryController };
         export { VarietyController };
     }
+    import BinTipBinCardController from "@ricado/api-client/Controllers/Packhouse/Site/BinTipBinCardController";
     import BinTipBinController from "@ricado/api-client/Controllers/Packhouse/Site/BinTipBinController";
     import BinTipWeightController from "@ricado/api-client/Controllers/Packhouse/Site/BinTipWeightController";
     import CompacSizerBatchController from "@ricado/api-client/Controllers/Packhouse/Site/CompacSizerBatchController";
@@ -4724,6 +4726,7 @@ declare module '@ricado/api-client/Controllers/Site/TemporaryObjectController' {
 declare module '@ricado/api-client/Models/Packhouse/Site' {
     export default Site;
     namespace Site {
+        export { BinTipBinCardModel };
         export { BinTipBinModel };
         export { BinTipWeightModel };
         export { CompacSizerBatchModel };
@@ -4751,6 +4754,7 @@ declare module '@ricado/api-client/Models/Packhouse/Site' {
         export { SoftSortPackrunSummaryModel };
         export { VarietyModel };
     }
+    import BinTipBinCardModel from "@ricado/api-client/Models/Packhouse/Site/BinTipBinCardModel";
     import BinTipBinModel from "@ricado/api-client/Models/Packhouse/Site/BinTipBinModel";
     import BinTipWeightModel from "@ricado/api-client/Models/Packhouse/Site/BinTipWeightModel";
     import CompacSizerBatchModel from "@ricado/api-client/Models/Packhouse/Site/CompacSizerBatchModel";
@@ -5379,6 +5383,234 @@ declare module '@ricado/api-client/Models/Site/TemporaryObjectModel' {
     import BaseModel from "@ricado/api-client/Models/BaseModel";
 }
 
+declare module '@ricado/api-client/Controllers/Packhouse/Site/BinTipBinCardController' {
+    export default BinTipBinCardController;
+    /**
+        * Controller Class for Bin Tip Bin Cards
+        *
+        * @class
+        */
+    class BinTipBinCardController {
+            /**
+                * Retrieve a Bin Tip Bin Card [GET /packhouse/sites/{siteId}/bin-tip-bin-cards/{id}]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Bin Tip Bin Card ID
+                * @return {Promise<BinTipBinCardModel>}
+                */
+            static getOne(siteId: number, id: string): Promise<BinTipBinCardModel>;
+            /**
+                * Update a Bin Tip Bin Card [PATCH /packhouse/sites/{siteId}/bin-tip-bin-cards/{id}]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Bin Tip Bin Card ID
+                * @param {BinTipBinCardController.UpdateData} updateData The Bin Tip Bin Card Update Data
+                * @return {Promise<BinTipBinCardModel>}
+                */
+            static update(siteId: number, id: string, updateData: BinTipBinCardController.UpdateData): Promise<BinTipBinCardModel>;
+            /**
+                * Delete a Bin Tip Bin Card [DELETE /packhouse/sites/{siteId}/bin-tip-bin-cards/{id}]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Bin Tip Bin Card ID
+                * @return {Promise<boolean>}
+                */
+            static delete(siteId: number, id: string): Promise<boolean>;
+            /**
+                * Retrieve Comments [GET /packhouse/sites/{siteId}/bin-tip-bin-cards/{id}/comments]
+                *
+                * Retrieves Comments for a Bin Tip Bin Card
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Bin Tip Bin Card ID
+                * @return {Promise<Array<BinTipBinCardController.CommentItem>>}
+                */
+            static getComments(siteId: number, id: string): Promise<Array<BinTipBinCardController.CommentItem>>;
+            /**
+                * Create a Comment [POST /packhouse/sites/{siteId}/bin-tip-bin-cards/{id}/comments]
+                *
+                * Create a Comment for a Bin Tip Bin Card
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Bin Tip Bin Card ID
+                * @param {string} content The Content of the New Comment
+                * @return {Promise<BinTipBinCardController.CommentItem>}
+                */
+            static createComment(siteId: number, id: string, content: string): Promise<BinTipBinCardController.CommentItem>;
+            /**
+                * Retrieve a Comment [GET /packhouse/sites/{siteId}/bin-tip-bin-cards/{id}/comments/{commentId}]
+                *
+                * Retrieves Comments for a Bin Tip Bin Card
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Bin Tip Bin Card ID
+                * @param {string} commentId The Comment ID
+                * @return {Promise<BinTipBinCardController.CommentItem>}
+                */
+            static getOneComment(siteId: number, id: string, commentId: string): Promise<BinTipBinCardController.CommentItem>;
+            /**
+                * Update a Comment [PATCH /packhouse/sites/{siteId}/bin-tip-bin-cards/{id}/comments/{commentId}]
+                *
+                * Update a Comment for a Bin Tip Bin Card
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Bin Tip Bin Card ID
+                * @param {string} commentId The Comment ID
+                * @param {string} content The Updated Content for the Comment
+                * @return {Promise<BinTipBinCardController.CommentItem>}
+                */
+            static updateOneComment(siteId: number, id: string, commentId: string, content: string): Promise<BinTipBinCardController.CommentItem>;
+            /**
+                * Delete a Comment [DELETE /packhouse/sites/{siteId}/bin-tip-bin-cards/{id}/comments/{commentId}]
+                *
+                * Delete a Comment for a Bin Tip Bin Card
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Bin Tip Bin Card ID
+                * @param {string} commentId The Comment ID
+                * @return {Promise<boolean>}
+                */
+            static deleteOneComment(siteId: number, id: string, commentId: string): Promise<boolean>;
+            /**
+                * List all Bin Tip Bin Cards [GET /packhouse/sites/{siteId}/bin-tip-bin-cards]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {BinTipBinCardController.GetAllQueryParameters} [queryParameters] The Optional Query Parameters
+                * @return {Promise<BinTipBinCardModel[]>}
+                */
+            static getAll(siteId: number, queryParameters?: BinTipBinCardController.GetAllQueryParameters | undefined): Promise<BinTipBinCardModel[]>;
+            /**
+                * Create a Bin Tip Bin Card [POST /packhouse/sites/{siteId}/bin-tip-bin-cards]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {BinTipBinCardController.CreateData} createData The Bin Tip Bin Card Create Data
+                * @return {Promise<BinTipBinCardModel>}
+                */
+            static create(siteId: number, createData: BinTipBinCardController.CreateData): Promise<BinTipBinCardModel>;
+    }
+    namespace BinTipBinCardController {
+            /**
+                * The Optional Query Parameters for the getAll Function
+                */
+            export type GetAllQueryParameters = {
+                    /**
+                        * The Bin Tip ID associated with this Bin Card
+                        */
+                    binTipId?: string;
+                    /**
+                        * The Bin ID associated with this Bin Card
+                        */
+                    binTipBinId?: string;
+                    /**
+                        * Filter by the Timestamp when this Bin Card was Created. Results Greater than or Equal to Timestamp
+                        */
+                    createdTimestampBegin?: Date;
+                    /**
+                        * Filter by the Timestamp when this Bin Card was Created. Results Less than or Equal to Timestamp
+                        */
+                    createdTimestampEnd?: Date;
+            };
+            /**
+                * The Create Data for a Bin Tip Bin Card
+                */
+            export type CreateData = {
+                    /**
+                        * The Bin Tip ID associated with this Bin Card
+                        */
+                    binTipId: string;
+                    /**
+                        * The Bin ID associated with this Bin Card
+                        */
+                    binTipBinId?: string;
+                    /**
+                        * When this Bin Card was Created
+                        */
+                    createdTimestamp?: Date;
+                    /**
+                        * A Base64 Encoded Image of the Bin Card
+                        */
+                    image?: string | null;
+            };
+            /**
+                * The Update Data for a Bin Tip Bin Card
+                */
+            export type UpdateData = {
+                    /**
+                        * The Bin Tip ID associated with this Bin Card
+                        */
+                    binTipId?: string;
+                    /**
+                        * When this Bin Card was Created
+                        */
+                    createdTimestamp?: Date;
+                    /**
+                        * A Base64 Encoded Image of the Bin Card
+                        */
+                    image?: string | 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 BinTipBinCardModel from "@ricado/api-client/Models/Packhouse/Site/BinTipBinCardModel";
+}
+
 declare module '@ricado/api-client/Controllers/Packhouse/Site/BinTipBinController' {
     export default BinTipBinController;
     /**
@@ -5517,6 +5749,14 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/BinTipBinControlle
                         * The Packrun ID associated with this Bin
                         */
                     packrunId?: string;
+                    /**
+                        * A 10-Digit Bin Number made up of a Bin Lot (4-Digits) and a Unique Number (6-Digits)
+                        */
+                    binNumber?: string | null;
+                    /**
+                        * The Source of the Bin Number
+                        */
+                    binNumberSource?: string | null;
                     /**
                         * The `BinTipWeight` ID as the Source for the Full Weight of this Bin
                         */
@@ -5554,6 +5794,10 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/BinTipBinControlle
                         * A 10-Digit Bin Number made up of a Bin Lot (4-Digits) and a Unique Number (6-Digits)
                         */
                     binNumber?: string | null;
+                    /**
+                        * The Source of the Bin Number
+                        */
+                    binNumberSource?: string | null;
                     /**
                         * The Time Batch ID associated with this Bin
                         */
@@ -5595,6 +5839,10 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/BinTipBinControlle
                         * A 10-Digit Bin Number made up of a Bin Lot (4-Digits) and a Unique Number (6-Digits)
                         */
                     binNumber?: string | null;
+                    /**
+                        * The Source of the Bin Number
+                        */
+                    binNumberSource?: string | null;
                     /**
                         * The Time Batch ID associated with this Bin
                         */
@@ -7856,6 +8104,10 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/FreshPackPackrunSu
                         * An Array of Tray Summary Data Objects for all Sizes and Class Types
                         */
                     traySummaries?: any[];
+                    /**
+                        * An Array of Clearance Summary Data Objects for all Sizes
+                        */
+                    clearanceSummaries?: any[];
             };
             /**
                 * The Update Data for a FreshPack Packrun Summary
@@ -7877,6 +8129,10 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/FreshPackPackrunSu
                         * An Array of Tray Summary Data Objects for all Sizes and Class Types
                         */
                     traySummaries?: any[];
+                    /**
+                        * An Array of Clearance Summary Data Objects for all Sizes
+                        */
+                    clearanceSummaries?: any[];
             };
             /**
                 * A **UserAccount** Type
@@ -12865,6 +13121,95 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/VarietyController'
     import VarietyModel from "@ricado/api-client/Models/Packhouse/Site/VarietyModel";
 }
 
+declare module '@ricado/api-client/Models/Packhouse/Site/BinTipBinCardModel' {
+    export default BinTipBinCardModel;
+    /**
+        * Model Class for a Bin Tip Bin Card
+        *
+        * @class
+        * @hideconstructor
+        * @extends BaseModel
+        */
+    class BinTipBinCardModel extends BaseModel {
+            /**
+                * Create a new **BinTipBinCardModel** 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 Bin Tip Bin Card
+                * @return {BinTipBinCardModel}
+                */
+            static fromJSON(json: {
+                    [x: string]: any;
+            } | string, siteId: number): BinTipBinCardModel;
+            /**
+                * BinTipBinCardModel Constructor
+                *
+                * @protected
+                * @param {number} siteId The Site ID associated with this Bin Tip Bin Card
+                */
+            protected constructor();
+            /**
+                * The Bin Tip Bin Card ID
+                *
+                * @type {string}
+                * @public
+                */
+            id: string;
+            /**
+                * The Bin Tip ID associated with this Bin Card
+                *
+                * @type {string}
+                * @public
+                */
+            binTipId: string;
+            /**
+                * The Bin ID associated with this Bin Card
+                *
+                * @type {string}
+                * @public
+                */
+            binTipBinId: string;
+            /**
+                * When this Bin Card was Created
+                *
+                * @type {Date}
+                * @public
+                */
+            createdTimestamp: Date;
+            /**
+                * A Base64 Encoded Image of the Bin Card
+                *
+                * @type {?string}
+                * @public
+                */
+            image: string | null;
+            /**
+                * Whether the Bin Tip Bin Card has been deleted
+                *
+                * @type {boolean}
+                * @public
+                */
+            deleted: boolean;
+            /**
+                * When the Bin Tip Bin Card was last updated
+                *
+                * @type {Date}
+                * @public
+                */
+            updateTimestamp: Date;
+            /**
+                * The Site ID associated with this Bin Tip Bin Card
+                *
+                * @type {number}
+                * @public
+                */
+            siteId: number;
+    }
+    import BaseModel from "@ricado/api-client/Models/BaseModel";
+}
+
 declare module '@ricado/api-client/Models/Packhouse/Site/BinTipBinModel' {
     export default BinTipBinModel;
     /**
@@ -12929,6 +13274,13 @@ declare module '@ricado/api-client/Models/Packhouse/Site/BinTipBinModel' {
                 * @public
                 */
             binNumber: string | null;
+            /**
+                * The Source of the Bin Number
+                *
+                * @type {?string}
+                * @public
+                */
+            binNumberSource: string | null;
             /**
                 * The Time Batch ID associated with this Bin
                 *
@@ -13984,6 +14336,13 @@ declare module '@ricado/api-client/Models/Packhouse/Site/FreshPackPackrunSummary
                 * @public
                 */
             traySummaries: any[];
+            /**
+                * An Array of Clearance Summary Data Objects for all Sizes
+                *
+                * @type {Object[]}
+                * @public
+                */
+            clearanceSummaries: any[];
             /**
                 * Whether the FreshPack Packrun Summary has been deleted
                 *

package/package.json

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