npm - @ricado/api-client - Versions diffs - 2.3.19 → 2.3.21 - Mend

@ricado/api-client 2.3.19 → 2.3.21

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (17) hide show

package/lib/index.d.ts CHANGED Viewed

@@ -4309,6 +4309,7 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site' {
     export default Site;
     namespace Site {
         export { BinTipBarcodeScannerController };
+        export { BinTipBarcodeScannerResultController };
         export { BinTipBinCardController };
         export { BinTipBinController };
         export { BinTipWeightController };
@@ -4344,6 +4345,7 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site' {
         export { VarietyController };
     }
     import BinTipBarcodeScannerController from "@ricado/api-client/Controllers/Packhouse/Site/BinTipBarcodeScannerController";
+    import BinTipBarcodeScannerResultController from "@ricado/api-client/Controllers/Packhouse/Site/BinTipBarcodeScannerResultController";
     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";
@@ -5918,6 +5920,7 @@ declare module '@ricado/api-client/Models/Packhouse/Site' {
     export default Site;
     namespace Site {
         export { BinTipBarcodeScannerModel };
+        export { BinTipBarcodeScannerResultModel };
         export { BinTipBinCardModel };
         export { BinTipBinModel };
         export { BinTipWeightModel };
@@ -5953,6 +5956,7 @@ declare module '@ricado/api-client/Models/Packhouse/Site' {
         export { VarietyModel };
     }
     import BinTipBarcodeScannerModel from "@ricado/api-client/Models/Packhouse/Site/BinTipBarcodeScannerModel";
+    import BinTipBarcodeScannerResultModel from "@ricado/api-client/Models/Packhouse/Site/BinTipBarcodeScannerResultModel";
     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";
@@ -6736,17 +6740,31 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/BinTipBarcodeScann
                         * The Name of this Bin Tip Barcode Scanner
                         */
                     name: string;
+                    /**
+                        * The Bin Tip that owns this Barcode Scanner
+                        */
+                    binTipId: string;
                     /**
                         * The Points used by this Bin Tip Barcode Scanner
                         */
                     points: {
+                            scannerCommunicationStatus: number;
+                            scannerChargingStatus: number;
+                            scannerChargingTimeRemaining: number;
+                            scannerBatteryTemperature: number;
+                            scannerBatteryPercentage: number;
+                            scannerBatteryCurrent: number;
+                            scannerBatteryVoltage: number;
                             scannerErrorBeepRequest: number;
+                            serviceCommunicationStatus: number;
+                            serviceCommunicationLatency: number;
                             restartServiceRequest: number;
+                            recentScanResults: number;
                     };
                     /**
-                        * The Bin Tip that owns this Barcode Scanner
+                        * The Mode for this Bin Tip Barcode Scanner
                         */
-                    binTipId: string;
+                    mode: string;
             };
             /**
                 * The Update Data for a Bin Tip Barcode Scanner
@@ -6756,22 +6774,192 @@ declare module '@ricado/api-client/Controllers/Packhouse/Site/BinTipBarcodeScann
                         * The Name of this Bin Tip Barcode Scanner
                         */
                     name?: string;
+                    /**
+                        * The Bin Tip that owns this Barcode Scanner
+                        */
+                    binTipId?: string;
                     /**
                         * The Points used by this Bin Tip Barcode Scanner
                         */
                     points?: {
+                            scannerCommunicationStatus: number;
+                            scannerChargingStatus: number;
+                            scannerChargingTimeRemaining: number;
+                            scannerBatteryTemperature: number;
+                            scannerBatteryPercentage: number;
+                            scannerBatteryCurrent: number;
+                            scannerBatteryVoltage: number;
                             scannerErrorBeepRequest: number;
+                            serviceCommunicationStatus: number;
+                            serviceCommunicationLatency: number;
                             restartServiceRequest: number;
+                            recentScanResults: number;
                     };
                     /**
-                        * The Bin Tip that owns this Barcode Scanner
+                        * The Mode for this Bin Tip Barcode Scanner
                         */
-                    binTipId?: string;
+                    mode?: string;
             };
     }
     import BinTipBarcodeScannerModel from "@ricado/api-client/Models/Packhouse/Site/BinTipBarcodeScannerModel";
 }
+declare module '@ricado/api-client/Controllers/Packhouse/Site/BinTipBarcodeScannerResultController' {
+    export default BinTipBarcodeScannerResultController;
+    /**
+        * Controller Class for Bin Tip Barcode Scanner Results
+        *
+        * @class
+        */
+    class BinTipBarcodeScannerResultController {
+            /**
+                * Retrieve a Bin Tip Barcode Scanner Result [GET /packhouse/sites/{siteId}/bin-tip-barcode-scanner-results/{id}]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Bin Tip Barcode Scanner Result ID
+                * @return {Promise<BinTipBarcodeScannerResultModel>}
+                */
+            static getOne(siteId: number, id: string): Promise<BinTipBarcodeScannerResultModel>;
+            /**
+                * Update a Bin Tip Barcode Scanner Result [PATCH /packhouse/sites/{siteId}/bin-tip-barcode-scanner-results/{id}]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Bin Tip Barcode Scanner Result ID
+                * @param {BinTipBarcodeScannerResultController.UpdateData} updateData The Bin Tip Barcode Scanner Result Update Data
+                * @return {Promise<BinTipBarcodeScannerResultModel>}
+                */
+            static update(siteId: number, id: string, updateData: BinTipBarcodeScannerResultController.UpdateData): Promise<BinTipBarcodeScannerResultModel>;
+            /**
+                * Delete a Bin Tip Barcode Scanner Result [DELETE /packhouse/sites/{siteId}/bin-tip-barcode-scanner-results/{id}]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {string} id The Bin Tip Barcode Scanner Result ID
+                * @return {Promise<boolean>}
+                */
+            static delete(siteId: number, id: string): Promise<boolean>;
+            /**
+                * List all Bin Tip Barcode Scanner Results [GET /packhouse/sites/{siteId}/bin-tip-barcode-scanner-results]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {BinTipBarcodeScannerResultController.GetAllQueryParameters} [queryParameters] The Optional Query Parameters
+                * @return {Promise<BinTipBarcodeScannerResultModel[]>}
+                */
+            static getAll(siteId: number, queryParameters?: BinTipBarcodeScannerResultController.GetAllQueryParameters | undefined): Promise<BinTipBarcodeScannerResultModel[]>;
+            /**
+                * Create a Bin Tip Barcode Scanner Result [POST /packhouse/sites/{siteId}/bin-tip-barcode-scanner-results]
+                *
+                * @static
+                * @public
+                * @param {number} siteId The Site ID
+                * @param {BinTipBarcodeScannerResultController.CreateData} createData The Bin Tip Barcode Scanner Result Create Data
+                * @return {Promise<BinTipBarcodeScannerResultModel>}
+                */
+            static create(siteId: number, createData: BinTipBarcodeScannerResultController.CreateData): Promise<BinTipBarcodeScannerResultModel>;
+    }
+    namespace BinTipBarcodeScannerResultController {
+            /**
+                * The Optional Query Parameters for the getAll Function
+                */
+            export type GetAllQueryParameters = {
+                    /**
+                        * The Bin Tip Barcode Scanner ID associated with this Result
+                        */
+                    barcodeScannerId?: string;
+                    /**
+                        * A 10-Digit Bin Number made up of a Bin Lot (4-Digits) and a Unique Number (6-Digits)
+                        */
+                    binNumber?: string;
+                    /**
+                        * The Mode of the Barcode Scanner when creating this Barcode Scanner Result
+                        */
+                    scanMode?: string;
+                    /**
+                        * The Packrun ID associated with this Barcode Scanner Result
+                        */
+                    packrunId?: string | null;
+                    /**
+                        * Filter by the Timestamp when this Barcode Scanner Result was Created. Results Greater than or Equal to Timestamp
+                        */
+                    createdTimestampBegin?: Date;
+                    /**
+                        * Filter by the Timestamp when this Barcode Scanner Result was Created. Results Less than or Equal to Timestamp
+                        */
+                    createdTimestampEnd?: Date;
+            };
+            /**
+                * The Create Data for a Bin Tip Barcode Scanner Result
+                */
+            export type CreateData = {
+                    /**
+                        * The Bin Tip Barcode Scanner ID associated with this Result
+                        */
+                    barcodeScannerId: string;
+                    /**
+                        * A 10-Digit Bin Number made up of a Bin Lot (4-Digits) and a Unique Number (6-Digits)
+                        */
+                    binNumber?: string;
+                    /**
+                        * When this Barcode Scanner Result was Created
+                        */
+                    createdTimestamp?: Date;
+                    /**
+                        * The Mode of the Barcode Scanner when creating this Barcode Scanner Result
+                        */
+                    scanMode: string;
+                    /**
+                        * The Packrun ID associated with this Barcode Scanner Result
+                        */
+                    packrunId?: string | null;
+                    /**
+                        * Whether the Bin Number was Valid and could be matched with a Current or Scheduled Packrun
+                        */
+                    result: boolean;
+                    /**
+                        * An Optional Message to accompany the Result. Typically only present when the Result is **false**
+                        */
+                    resultMessage: string | null;
+            };
+            /**
+                * The Update Data for a Bin Tip Barcode Scanner Result
+                */
+            export type UpdateData = {
+                    /**
+                        * The Bin Tip Barcode Scanner ID associated with this Result
+                        */
+                    barcodeScannerId?: string;
+                    /**
+                        * When this Barcode Scanner Result was Created
+                        */
+                    createdTimestamp?: Date;
+                    /**
+                        * The Mode of the Barcode Scanner when creating this Barcode Scanner Result
+                        */
+                    scanMode?: string;
+                    /**
+                        * The Packrun ID associated with this Barcode Scanner Result
+                        */
+                    packrunId?: string | null;
+                    /**
+                        * Whether the Bin Number was Valid and could be matched with a Current or Scheduled Packrun
+                        */
+                    result?: boolean;
+                    /**
+                        * An Optional Message to accompany the Result. Typically only present when the Result is **false**
+                        */
+                    resultMessage?: string | null;
+            };
+    }
+    import BinTipBarcodeScannerResultModel from "@ricado/api-client/Models/Packhouse/Site/BinTipBarcodeScannerResultModel";
+}
 declare module '@ricado/api-client/Controllers/Packhouse/Site/BinTipBinCardController' {
     export default BinTipBinCardController;
     /**
@@ -18844,23 +19032,40 @@ declare module '@ricado/api-client/Models/Packhouse/Site/BinTipBarcodeScannerMod
                 * @public
                 */
             name: string;
+            /**
+                * The Bin Tip that owns this Barcode Scanner
+                *
+                * @type {string}
+                * @public
+                */
+            binTipId: string;
             /**
                 * The Points used by this Bin Tip Barcode Scanner
                 *
-                * @type {{scannerErrorBeepRequest: number, restartServiceRequest: number}}
+                * @type {{scannerCommunicationStatus: number, scannerChargingStatus: number, scannerChargingTimeRemaining: number, scannerBatteryTemperature: number, scannerBatteryPercentage: number, scannerBatteryCurrent: number, scannerBatteryVoltage: number, scannerErrorBeepRequest: number, serviceCommunicationStatus: number, serviceCommunicationLatency: number, restartServiceRequest: number, recentScanResults: number}}
                 * @public
                 */
             points: {
+                    scannerCommunicationStatus: number;
+                    scannerChargingStatus: number;
+                    scannerChargingTimeRemaining: number;
+                    scannerBatteryTemperature: number;
+                    scannerBatteryPercentage: number;
+                    scannerBatteryCurrent: number;
+                    scannerBatteryVoltage: number;
                     scannerErrorBeepRequest: number;
+                    serviceCommunicationStatus: number;
+                    serviceCommunicationLatency: number;
                     restartServiceRequest: number;
+                    recentScanResults: number;
             };
             /**
-                * The Bin Tip that owns this Barcode Scanner
+                * The Mode for this Bin Tip Barcode Scanner
                 *
                 * @type {string}
                 * @public
                 */
-            binTipId: string;
+            mode: string;
             /**
                 * Whether the Bin Tip Barcode Scanner has been deleted
                 *
@@ -18886,6 +19091,123 @@ declare module '@ricado/api-client/Models/Packhouse/Site/BinTipBarcodeScannerMod
     import BaseModel from "@ricado/api-client/Models/BaseModel";
 }
+declare module '@ricado/api-client/Models/Packhouse/Site/BinTipBarcodeScannerResultModel' {
+    export default BinTipBarcodeScannerResultModel;
+    /**
+        * Model Class for a Bin Tip Barcode Scanner Result
+        *
+        * @class
+        * @hideconstructor
+        * @extends BaseModel
+        */
+    class BinTipBarcodeScannerResultModel extends BaseModel {
+            /**
+                * Create a new **BinTipBarcodeScannerResultModel** 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 Barcode Scanner Result
+                * @return {BinTipBarcodeScannerResultModel}
+                */
+            static fromJSON(json: {
+                    [x: string]: any;
+            } | string, siteId: number): BinTipBarcodeScannerResultModel;
+            /**
+                * BinTipBarcodeScannerResultModel Constructor
+                *
+                * @protected
+                * @param {number} siteId The Site ID associated with this Bin Tip Barcode Scanner Result
+                */
+            protected constructor();
+            /**
+                * The Bin Tip Barcode Scanner Result ID
+                *
+                * @type {string}
+                * @public
+                */
+            id: string;
+            /**
+                * The Bin Tip Barcode Scanner ID associated with this Result
+                *
+                * @type {string}
+                * @public
+                */
+            barcodeScannerId: string;
+            /**
+                * A 10-Digit Bin Number made up of a Bin Lot (4-Digits) and a Unique Number (6-Digits)
+                *
+                * @type {string}
+                * @public
+                */
+            binNumber: string;
+            /**
+                * When this Barcode Scanner Result was Created
+                *
+                * @type {Date}
+                * @public
+                */
+            createdTimestamp: Date;
+            /**
+                * The Mode of the Barcode Scanner when creating this Barcode Scanner Result
+                *
+                * @type {string}
+                * @public
+                */
+            scanMode: string;
+            /**
+                * The Packrun ID associated with this Barcode Scanner Result
+                *
+                * @type {?string}
+                * @public
+                */
+            packrunId: string | null;
+            /**
+                * Whether the Bin Number was Valid and could be matched with a Current or Scheduled Packrun
+                *
+                * @type {boolean}
+                * @public
+                */
+            result: boolean;
+            /**
+                * An Optional Message to accompany the Result. Typically only present when the Result is **false**
+                *
+                * @type {?string}
+                * @public
+                */
+            resultMessage: string | null;
+            /**
+                * The Bin Lot Code of this Barcode Scanner Result
+                *
+                * @type {?string}
+                * @public
+                */
+            binLotCode: string | null;
+            /**
+                * Whether the Bin Tip Barcode Scanner Result has been deleted
+                *
+                * @type {boolean}
+                * @public
+                */
+            deleted: boolean;
+            /**
+                * When the Bin Tip Barcode Scanner Result was last updated
+                *
+                * @type {Date}
+                * @public
+                */
+            updateTimestamp: Date;
+            /**
+                * The Site ID associated with this Bin Tip Barcode Scanner Result
+                *
+                * @type {number}
+                * @public
+                */
+            siteId: number;
+    }
+    import BaseModel from "@ricado/api-client/Models/BaseModel";
+}
 declare module '@ricado/api-client/Models/Packhouse/Site/BinTipBinCardModel' {
     export default BinTipBinCardModel;
     /**

package/package.json CHANGED Viewed

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

package/src/Controllers/Packhouse/Site/BinTipBarcodeScannerController.js CHANGED Viewed

@@ -159,8 +159,9 @@ export default BinTipBarcodeScannerController;
  * @typedef {Object} BinTipBarcodeScannerController.CreateData
  * @property {?number} [rtuId] The RTU this Bin Tip Barcode Scanner Belt belongs to
  * @property {string} name The Name of this Bin Tip Barcode Scanner
- * @property {{scannerErrorBeepRequest: number, restartServiceRequest: number}} points The Points used by this Bin Tip Barcode Scanner
  * @property {string} binTipId The Bin Tip that owns this Barcode Scanner
+ * @property {{scannerCommunicationStatus: number, scannerChargingStatus: number, scannerChargingTimeRemaining: number, scannerBatteryTemperature: number, scannerBatteryPercentage: number, scannerBatteryCurrent: number, scannerBatteryVoltage: number, scannerErrorBeepRequest: number, serviceCommunicationStatus: number, serviceCommunicationLatency: number, restartServiceRequest: number, recentScanResults: number}} points The Points used by this Bin Tip Barcode Scanner
+ * @property {string} mode The Mode for this Bin Tip Barcode Scanner
  * @memberof Controllers.Packhouse.Site
  */
@@ -169,7 +170,8 @@ export default BinTipBarcodeScannerController;
  *
  * @typedef {Object} BinTipBarcodeScannerController.UpdateData
  * @property {string} [name] The Name of this Bin Tip Barcode Scanner
- * @property {{scannerErrorBeepRequest: number, restartServiceRequest: number}} [points] The Points used by this Bin Tip Barcode Scanner
  * @property {string} [binTipId] The Bin Tip that owns this Barcode Scanner
+ * @property {{scannerCommunicationStatus: number, scannerChargingStatus: number, scannerChargingTimeRemaining: number, scannerBatteryTemperature: number, scannerBatteryPercentage: number, scannerBatteryCurrent: number, scannerBatteryVoltage: number, scannerErrorBeepRequest: number, serviceCommunicationStatus: number, serviceCommunicationLatency: number, restartServiceRequest: number, recentScanResults: number}} [points] The Points used by this Bin Tip Barcode Scanner
+ * @property {string} [mode] The Mode for this Bin Tip Barcode Scanner
  * @memberof Controllers.Packhouse.Site
  */

package/src/Controllers/Packhouse/Site/BinTipBarcodeScannerResultController.js ADDED Viewed

@@ -0,0 +1,184 @@
+/**
+ * File Auto-Generated by the RICADO Gen 4 PHP API Project
+ *
+ * Do Not Edit this File Manually!
+ */
+import RequestHelper from '../../../RequestHelper';
+import BinTipBarcodeScannerResultModel from '../../../Models/Packhouse/Site/BinTipBarcodeScannerResultModel';
+/**
+ * Controller Class for Bin Tip Barcode Scanner Results
+ *
+ * @class
+ */
+class BinTipBarcodeScannerResultController
+{
+    /**
+     * Retrieve a Bin Tip Barcode Scanner Result [GET /packhouse/sites/{siteId}/bin-tip-barcode-scanner-results/{id}]
+     *
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Bin Tip Barcode Scanner Result ID
+     * @return {Promise<BinTipBarcodeScannerResultModel>}
+     */
+    static getOne(siteId, id)
+    {
+        return new Promise((resolve, reject) => {
+            RequestHelper.getRequest(`/packhouse/sites/${siteId}/bin-tip-barcode-scanner-results/${id}`)
+            .then((result) => {
+                let resolveValue = (function(){
+                    return BinTipBarcodeScannerResultModel.fromJSON(result, siteId);
+                }());
+                resolve(resolveValue);
+            })
+            .catch(error => reject(error));
+        });
+    }
+    /**
+     * Update a Bin Tip Barcode Scanner Result [PATCH /packhouse/sites/{siteId}/bin-tip-barcode-scanner-results/{id}]
+     *
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Bin Tip Barcode Scanner Result ID
+     * @param {BinTipBarcodeScannerResultController.UpdateData} updateData The Bin Tip Barcode Scanner Result Update Data
+     * @return {Promise<BinTipBarcodeScannerResultModel>}
+     */
+    static update(siteId, id, updateData)
+    {
+        return new Promise((resolve, reject) => {
+            RequestHelper.patchRequest(`/packhouse/sites/${siteId}/bin-tip-barcode-scanner-results/${id}`, updateData)
+            .then((result) => {
+                let resolveValue = (function(){
+                    return BinTipBarcodeScannerResultModel.fromJSON(result, siteId);
+                }());
+                resolve(resolveValue);
+            })
+            .catch(error => reject(error));
+        });
+    }
+    /**
+     * Delete a Bin Tip Barcode Scanner Result [DELETE /packhouse/sites/{siteId}/bin-tip-barcode-scanner-results/{id}]
+     *
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {string} id The Bin Tip Barcode Scanner Result ID
+     * @return {Promise<boolean>}
+     */
+    static delete(siteId, id)
+    {
+        return new Promise((resolve, reject) => {
+            RequestHelper.deleteRequest(`/packhouse/sites/${siteId}/bin-tip-barcode-scanner-results/${id}`)
+            .then((result) => {
+                resolve(result ?? true);
+            })
+            .catch(error => reject(error));
+        });
+    }
+    /**
+     * List all Bin Tip Barcode Scanner Results [GET /packhouse/sites/{siteId}/bin-tip-barcode-scanner-results]
+     *
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {BinTipBarcodeScannerResultController.GetAllQueryParameters} [queryParameters] The Optional Query Parameters
+     * @return {Promise<BinTipBarcodeScannerResultModel[]>}
+     */
+    static getAll(siteId, queryParameters = {})
+    {
+        return new Promise((resolve, reject) => {
+            RequestHelper.getRequest(`/packhouse/sites/${siteId}/bin-tip-barcode-scanner-results`, queryParameters)
+            .then((result) => {
+                let resolveValue = (function(){
+                    if(Array.isArray(result) !== true)
+                    {
+                        return [];
+                    }
+                    return result.map((resultItem) => {
+                        return (function(){
+                            return BinTipBarcodeScannerResultModel.fromJSON(resultItem, siteId);
+                        }());
+                    });
+                }());
+                resolve(resolveValue);
+            })
+            .catch(error => reject(error));
+        });
+    }
+    /**
+     * Create a Bin Tip Barcode Scanner Result [POST /packhouse/sites/{siteId}/bin-tip-barcode-scanner-results]
+     *
+     * @static
+     * @public
+     * @param {number} siteId The Site ID
+     * @param {BinTipBarcodeScannerResultController.CreateData} createData The Bin Tip Barcode Scanner Result Create Data
+     * @return {Promise<BinTipBarcodeScannerResultModel>}
+     */
+    static create(siteId, createData)
+    {
+        return new Promise((resolve, reject) => {
+            RequestHelper.postRequest(`/packhouse/sites/${siteId}/bin-tip-barcode-scanner-results`, createData)
+            .then((result) => {
+                let resolveValue = (function(){
+                    return BinTipBarcodeScannerResultModel.fromJSON(result, siteId);
+                }());
+                resolve(resolveValue);
+            })
+            .catch(error => reject(error));
+        });
+    }
+}
+export default BinTipBarcodeScannerResultController;
+/**
+ * The Optional Query Parameters for the getAll Function
+ *
+ * @typedef {Object} BinTipBarcodeScannerResultController.GetAllQueryParameters
+ * @property {string} [barcodeScannerId] The Bin Tip Barcode Scanner ID associated with this Result
+ * @property {string} [binNumber] A 10-Digit Bin Number made up of a Bin Lot (4-Digits) and a Unique Number (6-Digits)
+ * @property {string} [scanMode] The Mode of the Barcode Scanner when creating this Barcode Scanner Result
+ * @property {?string} [packrunId] The Packrun ID associated with this Barcode Scanner Result
+ * @property {Date} [createdTimestampBegin] Filter by the Timestamp when this Barcode Scanner Result was Created. Results Greater than or Equal to Timestamp
+ * @property {Date} [createdTimestampEnd] Filter by the Timestamp when this Barcode Scanner Result was Created. Results Less than or Equal to Timestamp
+ * @memberof Controllers.Packhouse.Site
+ */
+/**
+ * The Create Data for a Bin Tip Barcode Scanner Result
+ *
+ * @typedef {Object} BinTipBarcodeScannerResultController.CreateData
+ * @property {string} barcodeScannerId The Bin Tip Barcode Scanner ID associated with this Result
+ * @property {string} [binNumber] A 10-Digit Bin Number made up of a Bin Lot (4-Digits) and a Unique Number (6-Digits)
+ * @property {Date} [createdTimestamp] When this Barcode Scanner Result was Created
+ * @property {string} scanMode The Mode of the Barcode Scanner when creating this Barcode Scanner Result
+ * @property {?string} [packrunId] The Packrun ID associated with this Barcode Scanner Result
+ * @property {boolean} result Whether the Bin Number was Valid and could be matched with a Current or Scheduled Packrun
+ * @property {?string} resultMessage An Optional Message to accompany the Result. Typically only present when the Result is **false**
+ * @memberof Controllers.Packhouse.Site
+ */
+/**
+ * The Update Data for a Bin Tip Barcode Scanner Result
+ *
+ * @typedef {Object} BinTipBarcodeScannerResultController.UpdateData
+ * @property {string} [barcodeScannerId] The Bin Tip Barcode Scanner ID associated with this Result
+ * @property {Date} [createdTimestamp] When this Barcode Scanner Result was Created
+ * @property {string} [scanMode] The Mode of the Barcode Scanner when creating this Barcode Scanner Result
+ * @property {?string} [packrunId] The Packrun ID associated with this Barcode Scanner Result
+ * @property {boolean} [result] Whether the Bin Number was Valid and could be matched with a Current or Scheduled Packrun
+ * @property {?string} [resultMessage] An Optional Message to accompany the Result. Typically only present when the Result is **false**
+ * @memberof Controllers.Packhouse.Site
+ */

package/src/Controllers/Packhouse/Site/index.js CHANGED Viewed

@@ -8,6 +8,7 @@
  * @namespace Controllers.Packhouse.Site
  */
 import BinTipBarcodeScannerController from './BinTipBarcodeScannerController';
+import BinTipBarcodeScannerResultController from './BinTipBarcodeScannerResultController';
 import BinTipBinCardController from './BinTipBinCardController';
 import BinTipBinController from './BinTipBinController';
 import BinTipWeightController from './BinTipWeightController';
@@ -44,6 +45,7 @@ import VarietyController from './VarietyController';
 const Site = {
     BinTipBarcodeScannerController,
+    BinTipBarcodeScannerResultController,
     BinTipBinCardController,
     BinTipBinController,
     BinTipWeightController,