addio-admin-sdk 1.7.141 → 1.7.143

package/dist/Interfaces/CashDrawers/index.d.ts

@@ -0,0 +1,37 @@
+export interface ICashDrawer {
+    readonly id: string;
+    readonly nickname: string;
+    readonly drawer_number?: number;
+    readonly active: boolean;
+}
+export interface ICashDrawerShift {
+    readonly id?: string;
+    readonly cash_drawer_id: string;
+    readonly opened_details: ICashDrawerShiftDetails;
+    readonly closed_details?: ICashDrawerShiftDetails;
+    readonly is_open: boolean;
+}
+interface ICashDrawerShiftDetails {
+    readonly date: Date;
+    readonly by_user: string;
+}
+export interface ICashDrawerInteraction {
+    readonly id?: string;
+    readonly date: Date;
+    readonly action: CashDrawerActionEnum;
+    readonly user: string;
+    readonly amount: number;
+    readonly cash_drawer_id: string;
+    readonly shift_id: string;
+    readonly reason?: string;
+}
+export declare enum CashDrawerActionEnum {
+    OPEN_SHIFT = "start_shift",
+    ORDER_CASH_IN = "order_cash_in",
+    ORDER_CASH_OUT = "order_cash_out",
+    MANUAL_CASH_IN = "manual_cash_in",
+    MANUAL_CASH_OUT = "manual_cash_out",
+    END_SHIFT = "end_shift"
+}
+export declare const getDefaultCashDrawer: () => ICashDrawer;
+export {};

package/dist/Interfaces/CashDrawers/index.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDefaultCashDrawer = exports.CashDrawerActionEnum = void 0;
+const uuid_1 = require("uuid");
+var CashDrawerActionEnum;
+(function (CashDrawerActionEnum) {
+    CashDrawerActionEnum["OPEN_SHIFT"] = "start_shift";
+    CashDrawerActionEnum["ORDER_CASH_IN"] = "order_cash_in";
+    CashDrawerActionEnum["ORDER_CASH_OUT"] = "order_cash_out";
+    CashDrawerActionEnum["MANUAL_CASH_IN"] = "manual_cash_in";
+    CashDrawerActionEnum["MANUAL_CASH_OUT"] = "manual_cash_out";
+    CashDrawerActionEnum["END_SHIFT"] = "end_shift";
+})(CashDrawerActionEnum = exports.CashDrawerActionEnum || (exports.CashDrawerActionEnum = {}));
+const getDefaultCashDrawer = () => ({
+    id: (0, uuid_1.v4)(),
+    nickname: '',
+    active: true
+});
+exports.getDefaultCashDrawer = getDefaultCashDrawer;
+//# sourceMappingURL=index.js.map

package/dist/Interfaces/CashDrawers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Interfaces/CashDrawers/index.ts"],"names":[],"mappings":";;;AAAA,+BAAyB;AAiCzB,IAAY,oBAOX;AAPD,WAAY,oBAAoB;IAC/B,kDAA0B,CAAA;IAC1B,uDAA+B,CAAA;IAC/B,yDAAiC,CAAA;IACjC,yDAAiC,CAAA;IACjC,2DAAmC,CAAA;IACnC,+CAAuB,CAAA;AACxB,CAAC,EAPW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAO/B;AAEM,MAAM,oBAAoB,GAAG,GAAgB,EAAE,CAAC,CAAC;IACvD,EAAE,EAAE,IAAA,SAAE,GAAE;IACR,QAAQ,EAAE,EAAE;IACZ,MAAM,EAAE,IAAI;CACZ,CAAC,CAAA;AAJW,QAAA,oBAAoB,wBAI/B"}

package/dist/Interfaces/Space/index.d.ts

@@ -9,6 +9,7 @@
 import Space from '../../lib/Space';
 import IAddress from '../Address';
 import { CustomPaymentTypeEnum, PaymentTypeEnum } from '../Cart';
+import { ICashDrawer } from '../CashDrawers';
 import { ISliderContent, ISliderOptions } from '../CMS';
 import { InventoryPriorityTypeEnum } from '../Inventory';
 import { IBankType } from '../PromiseToPurchase/BankType';
@@ -167,6 +168,7 @@ export default interface ISpace {
     readonly pos_settings?: {
         readonly auto_lock_delay?: number | null;
     };
+    readonly cash_drawers?: ICashDrawer[];
     readonly other?: {
         readonly auto_fill_title_with_image_name?: {
             readonly is_active: boolean;
@@ -358,11 +360,13 @@ export interface ISpaceOptions {
         readonly space_has_bookings?: boolean;
         readonly has_pos?: boolean;
         readonly allow_custom_prices_in_categories?: boolean;
+        readonly can_manage_cash_drawers?: boolean;
     };
     readonly pos?: {
         readonly has_custom_pos?: boolean;
         readonly is_public?: boolean;
         readonly can_put_carts_on_hold?: boolean;
+        readonly must_assign_cash_drawer?: boolean;
     };
     readonly booking?: {
         readonly set_store_for_booking_inventory_management?: boolean;

package/dist/Interfaces/Space/index.js

@@ -84,12 +84,14 @@ const getDefaultSpaceOptions = () => ({
         allow_refunds: false,
         space_has_bookings: false,
         has_pos: false,
-        allow_custom_prices_in_categories: false
+        allow_custom_prices_in_categories: false,
+        can_manage_cash_drawers: false
     },
     pos: {
         has_custom_pos: false,
         is_public: false,
-        can_put_carts_on_hold: false
+        can_put_carts_on_hold: false,
+        must_assign_cash_drawer: false
     },
     booking: {
         set_store_for_booking_inventory_management: false

package/dist/Interfaces/Space/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Interfaces/Space/index.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;;;AAIH,kCAAgE;AAMhE,gDAAqE;AAsSrE,uEAAuE;AACvE,IAAY,oBA2BX;AA3BD,WAAY,oBAAoB;IAC/B,mDAA2B,CAAA;IAC3B,0DAAkC,CAAA;IAClC,iDAAyB,CAAA;IACzB,+CAAuB,CAAA;IACvB,uCAAe,CAAA;IACf,yCAAiB,CAAA;IACjB,6CAAqB,CAAA;IACrB,+CAAuB,CAAA;IACvB,mDAA2B,CAAA;IAC3B,6CAAqB,CAAA;IACrB,qCAAa,CAAA;IACb,6CAAqB,CAAA;IACrB,yDAAiC,CAAA;IACjC,2CAAmB,CAAA;IACnB,2CAAmB,CAAA;IACnB,+DAAuC,CAAA;IACvC,yCAAiB,CAAA;IACjB,iDAAyB,CAAA;IACzB,uDAA+B,CAAA;IAC/B,2DAAmC,CAAA;IACnC,uDAA+B,CAAA;IAC/B,iDAAyB,CAAA;IACzB,iDAAyB,CAAA;IACzB,+DAAuC,CAAA;IACvC,uCAAe,CAAA;IACf,6EAAqD,CAAA;AACtD,CAAC,EA3BW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QA2B/B;AAED,IAAY,WAGX;AAHD,WAAY,WAAW;IACtB,gCAAiB,CAAA;IACjB,wCAAyB,CAAA;AAC1B,CAAC,EAHW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAGtB;AA+DM,MAAM,sBAAsB,GAAG,GAAkB,EAAE,CAAC,CAAC;IAC3D,QAAQ,EAAE;QACT,UAAU,EAAE,KAAK;QACjB,YAAY,EAAE,KAAK;QACnB,eAAe,EAAE,KAAK;QACtB,wCAAwC,EAAE,KAAK;QAC/C,yBAAyB,EAAE,KAAK;QAChC,wBAAwB,EAAE,KAAK;KAC/B;IACD,SAAS,EAAE;QACV,yBAAyB,EAAE,KAAK;QAChC,mBAAmB,EAAE,KAAK;QAC1B,sBAAsB,EAAE,KAAK;KAC7B;IACD,IAAI,EAAE;QACL,SAAS,EAAE,KAAK;QAChB,cAAc,EAAE,KAAK;KACrB;IACD,OAAO,EAAE;QACR,mBAAmB,EAAE,KAAK;QAC1B,qBAAqB,EAAE,KAAK;QAC5B,4BAA4B,EAAE,KAAK;QACnC,sBAAsB,EAAE,KAAK;QAC7B,uBAAuB,EAAE,KAAK;KAC9B;IACD,GAAG,EAAE;QACJ,sBAAsB,EAAE,KAAK;QAC7B,gBAAgB,EAAE,KAAK;QACvB,+BAA+B,EAAE,KAAK;QACtC,WAAW,EAAE,KAAK;KAClB;IACD,QAAQ,EAAE;QACT,eAAe,EAAE,KAAK;KACtB;IACD,QAAQ,EAAE;QACT,aAAa,EAAE,KAAK;QACpB,kBAAkB,EAAE,KAAK;QACzB,OAAO,EAAE,KAAK;QACd,iCAAiC,EAAE,KAAK;KACxC;IACD,GAAG,EAAE;QACJ,cAAc,EAAE,KAAK;QACrB,SAAS,EAAE,KAAK;QAChB,qBAAqB,EAAE,KAAK;KAC5B;IACD,OAAO,EAAE;QACR,0CAA0C,EAAE,KAAK;KACjD;IACD,iBAAiB,EAAE;QAClB,SAAS,EAAE,KAAK;QAChB,kCAAkC,EAAE,KAAK;QACzC,cAAc,EAAE,KAAK;QACrB,gCAAgC,EAAE,KAAK;QACvC,+BAA+B,EAAE,KAAK;QACtC,6BAA6B,EAAE,KAAK;KACpC;IACD,QAAQ,EAAE;QACT,mBAAmB,EAAE,KAAK;KAC1B;CACD,CAAC,CAAA;AA3DW,QAAA,sBAAsB,0BA2DjC;AAEK,MAAM,YAAY,GAAG,GAAW,EAAE,CAAC,CAAC;IAC1C,gBAAgB,EAAE,KAAK;IACvB,gBAAgB,EAAE,IAAI;IACtB,kBAAkB,EAAE,CAAC,KAAK,CAAC;IAC3B,iBAAiB,EAAE,EAAE;IACrB,gBAAgB,EAAE;QACjB,oBAAoB,EAAE,IAAI;QAC1B,MAAM,EAAE,MAAM;QACd,iBAAiB,EAAE,IAAI;QACvB,oBAAoB,EAAE,IAAI;QAC1B,kCAAkC,EAAE;YACnC,SAAS,EAAE,IAAI;YACf,MAAM,EAAE,EAAE;SACV;QACD,2CAA2C,EAAE;YAC5C,SAAS,EAAE,IAAI;YACf,MAAM,EAAE,EAAE;SACV;QACD,0BAA0B,EAAE;YAC3B,SAAS,EAAE,KAAK;YAChB,aAAa,EAAE,EAAE;YACjB,eAAe,EAAE,EAAE;YACnB,iBAAiB,EAAE,KAAK;SACxB;QACD,mCAAmC,EAAE;YACpC,SAAS,EAAE,KAAK;YAChB,MAAM,EAAE,EAAE;SACV;KACD;IACD,SAAS,EAAE,CAAC,IAAI,CAAC;IACjB,IAAI,EAAE,EAAE;IACR,GAAG,EAAE;QACJ,sBAAsB,EAAE,KAAK;QAC7B,OAAO,EAAE,EAAE;KACX;IACD,cAAc,EAAE,EAAE,YAAY,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,iBAAiB,EAAE,IAAI,EAAE;IACrG,iBAAiB,EAAE,CAAC,sBAAe,CAAC,MAAM,CAAC;IAC3C,iBAAiB,EAAE,EAAE;IACrB,qBAAqB,EAAE,EAAE;IACzB,mBAAmB,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE;IACpC,mBAAmB,EAAE,IAAI;IACzB,KAAK,EAAE;QACN,+BAA+B,EAAE;YAChC,SAAS,EAAE,KAAK;SAChB;KACD;CACD,CAAC,CAAA;AA9CW,QAAA,YAAY,gBA8CvB;AAEK,MAAM,uBAAuB,GAAG,CAAC,KAAY,EAAkB,EAAE,CAAC,CAAC;IACzE,IAAI,EAAE,EAAE;IACR,IAAI,EAAE,EAAE;IACR,OAAO,EAAE;QACR,6BAA6B,EAAE,KAAK;QACpC,2BAA2B,EAAE,KAAK;KAClC;IACD,SAAS,EAAE;QACV,wCAAwC,EAAE,KAAK;KAC/C;IACD,iBAAiB,EAAE,IAAA,oCAAsB,EAAC,KAAK,CAAC,WAAW,CAAC,SAAS,EAAE,CAAC;IACxE,uBAAuB,EAAE,IAAA,oCAAsB,EAAC,KAAK,CAAC,WAAW,CAAC,SAAS,EAAE,CAAC;IAC9E,wBAAwB,EAAE,IAAA,oCAAsB,EAAC,KAAK,CAAC,WAAW,CAAC,SAAS,EAAE,CAAC;CAC/E,CAAC,CAAA;AAbW,QAAA,uBAAuB,2BAalC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Interfaces/Space/index.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;;;AAIH,kCAAgE;AAOhE,gDAAqE;AAySrE,uEAAuE;AACvE,IAAY,oBA2BX;AA3BD,WAAY,oBAAoB;IAC/B,mDAA2B,CAAA;IAC3B,0DAAkC,CAAA;IAClC,iDAAyB,CAAA;IACzB,+CAAuB,CAAA;IACvB,uCAAe,CAAA;IACf,yCAAiB,CAAA;IACjB,6CAAqB,CAAA;IACrB,+CAAuB,CAAA;IACvB,mDAA2B,CAAA;IAC3B,6CAAqB,CAAA;IACrB,qCAAa,CAAA;IACb,6CAAqB,CAAA;IACrB,yDAAiC,CAAA;IACjC,2CAAmB,CAAA;IACnB,2CAAmB,CAAA;IACnB,+DAAuC,CAAA;IACvC,yCAAiB,CAAA;IACjB,iDAAyB,CAAA;IACzB,uDAA+B,CAAA;IAC/B,2DAAmC,CAAA;IACnC,uDAA+B,CAAA;IAC/B,iDAAyB,CAAA;IACzB,iDAAyB,CAAA;IACzB,+DAAuC,CAAA;IACvC,uCAAe,CAAA;IACf,6EAAqD,CAAA;AACtD,CAAC,EA3BW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QA2B/B;AAED,IAAY,WAGX;AAHD,WAAY,WAAW;IACtB,gCAAiB,CAAA;IACjB,wCAAyB,CAAA;AAC1B,CAAC,EAHW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAGtB;AAiEM,MAAM,sBAAsB,GAAG,GAAkB,EAAE,CAAC,CAAC;IAC3D,QAAQ,EAAE;QACT,UAAU,EAAE,KAAK;QACjB,YAAY,EAAE,KAAK;QACnB,eAAe,EAAE,KAAK;QACtB,wCAAwC,EAAE,KAAK;QAC/C,yBAAyB,EAAE,KAAK;QAChC,wBAAwB,EAAE,KAAK;KAC/B;IACD,SAAS,EAAE;QACV,yBAAyB,EAAE,KAAK;QAChC,mBAAmB,EAAE,KAAK;QAC1B,sBAAsB,EAAE,KAAK;KAC7B;IACD,IAAI,EAAE;QACL,SAAS,EAAE,KAAK;QAChB,cAAc,EAAE,KAAK;KACrB;IACD,OAAO,EAAE;QACR,mBAAmB,EAAE,KAAK;QAC1B,qBAAqB,EAAE,KAAK;QAC5B,4BAA4B,EAAE,KAAK;QACnC,sBAAsB,EAAE,KAAK;QAC7B,uBAAuB,EAAE,KAAK;KAC9B;IACD,GAAG,EAAE;QACJ,sBAAsB,EAAE,KAAK;QAC7B,gBAAgB,EAAE,KAAK;QACvB,+BAA+B,EAAE,KAAK;QACtC,WAAW,EAAE,KAAK;KAClB;IACD,QAAQ,EAAE;QACT,eAAe,EAAE,KAAK;KACtB;IACD,QAAQ,EAAE;QACT,aAAa,EAAE,KAAK;QACpB,kBAAkB,EAAE,KAAK;QACzB,OAAO,EAAE,KAAK;QACd,iCAAiC,EAAE,KAAK;QACxC,uBAAuB,EAAE,KAAK;KAC9B;IACD,GAAG,EAAE;QACJ,cAAc,EAAE,KAAK;QACrB,SAAS,EAAE,KAAK;QAChB,qBAAqB,EAAE,KAAK;QAC5B,uBAAuB,EAAE,KAAK;KAC9B;IACD,OAAO,EAAE;QACR,0CAA0C,EAAE,KAAK;KACjD;IACD,iBAAiB,EAAE;QAClB,SAAS,EAAE,KAAK;QAChB,kCAAkC,EAAE,KAAK;QACzC,cAAc,EAAE,KAAK;QACrB,gCAAgC,EAAE,KAAK;QACvC,+BAA+B,EAAE,KAAK;QACtC,6BAA6B,EAAE,KAAK;KACpC;IACD,QAAQ,EAAE;QACT,mBAAmB,EAAE,KAAK;KAC1B;CACD,CAAC,CAAA;AA7DW,QAAA,sBAAsB,0BA6DjC;AAEK,MAAM,YAAY,GAAG,GAAW,EAAE,CAAC,CAAC;IAC1C,gBAAgB,EAAE,KAAK;IACvB,gBAAgB,EAAE,IAAI;IACtB,kBAAkB,EAAE,CAAC,KAAK,CAAC;IAC3B,iBAAiB,EAAE,EAAE;IACrB,gBAAgB,EAAE;QACjB,oBAAoB,EAAE,IAAI;QAC1B,MAAM,EAAE,MAAM;QACd,iBAAiB,EAAE,IAAI;QACvB,oBAAoB,EAAE,IAAI;QAC1B,kCAAkC,EAAE;YACnC,SAAS,EAAE,IAAI;YACf,MAAM,EAAE,EAAE;SACV;QACD,2CAA2C,EAAE;YAC5C,SAAS,EAAE,IAAI;YACf,MAAM,EAAE,EAAE;SACV;QACD,0BAA0B,EAAE;YAC3B,SAAS,EAAE,KAAK;YAChB,aAAa,EAAE,EAAE;YACjB,eAAe,EAAE,EAAE;YACnB,iBAAiB,EAAE,KAAK;SACxB;QACD,mCAAmC,EAAE;YACpC,SAAS,EAAE,KAAK;YAChB,MAAM,EAAE,EAAE;SACV;KACD;IACD,SAAS,EAAE,CAAC,IAAI,CAAC;IACjB,IAAI,EAAE,EAAE;IACR,GAAG,EAAE;QACJ,sBAAsB,EAAE,KAAK;QAC7B,OAAO,EAAE,EAAE;KACX;IACD,cAAc,EAAE,EAAE,YAAY,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE,iBAAiB,EAAE,IAAI,EAAE;IACrG,iBAAiB,EAAE,CAAC,sBAAe,CAAC,MAAM,CAAC;IAC3C,iBAAiB,EAAE,EAAE;IACrB,qBAAqB,EAAE,EAAE;IACzB,mBAAmB,EAAE,EAAE,QAAQ,EAAE,CAAC,EAAE;IACpC,mBAAmB,EAAE,IAAI;IACzB,KAAK,EAAE;QACN,+BAA+B,EAAE;YAChC,SAAS,EAAE,KAAK;SAChB;KACD;CACD,CAAC,CAAA;AA9CW,QAAA,YAAY,gBA8CvB;AAEK,MAAM,uBAAuB,GAAG,CAAC,KAAY,EAAkB,EAAE,CAAC,CAAC;IACzE,IAAI,EAAE,EAAE;IACR,IAAI,EAAE,EAAE;IACR,OAAO,EAAE;QACR,6BAA6B,EAAE,KAAK;QACpC,2BAA2B,EAAE,KAAK;KAClC;IACD,SAAS,EAAE;QACV,wCAAwC,EAAE,KAAK;KAC/C;IACD,iBAAiB,EAAE,IAAA,oCAAsB,EAAC,KAAK,CAAC,WAAW,CAAC,SAAS,EAAE,CAAC;IACxE,uBAAuB,EAAE,IAAA,oCAAsB,EAAC,KAAK,CAAC,WAAW,CAAC,SAAS,EAAE,CAAC;IAC9E,wBAAwB,EAAE,IAAA,oCAAsB,EAAC,KAAK,CAAC,WAAW,CAAC,SAAS,EAAE,CAAC;CAC/E,CAAC,CAAA;AAbW,QAAA,uBAAuB,2BAalC"}

package/dist/lib/CashDrawerShift/index.d.ts

@@ -0,0 +1,83 @@
+import { CashDrawerActionEnum, ICashDrawerShift } from '../../Interfaces/CashDrawers';
+import { BaseServiceClass } from '../baseService';
+import Space from '../Space';
+export default class CashDrawerShift extends BaseServiceClass<ICashDrawerShift> {
+    private _space;
+    private _cashDrawerId;
+    constructor(space: Space, cashDrawerId: string, _data: ICashDrawerShift, _collection: {
+        path: string;
+    }, _user: string);
+    data: () => ICashDrawerShift;
+    save: (partialShift?: Partial<ICashDrawerShift>) => Promise<boolean>;
+    /**
+     * Delete function overriden so it can't be called though class
+     */
+    delete: () => Promise<boolean>;
+    /**
+     * Get cash drawer interaction string for specified action, in specified locale.
+     * @static
+     * @param action A streamlined enum of cash drawer actions -  supports all EXCEPT manual actions (MANUAL_CASH_IN and MANUAL_CASH_OUT)
+     * @param locale Optionnal. The local to use. Defaults to 'fr'.
+     * @param orderRef Optionnal. Order ref number to add to string. Only used in ORDER type actions, and defaults to 'ND' if undefined.
+     * @returns The translated string.
+     */
+    static getTranslatedGenericInteractionReason: (action: Exclude<CashDrawerActionEnum, CashDrawerActionEnum.MANUAL_CASH_IN | CashDrawerActionEnum.MANUAL_CASH_OUT>, locale: string | undefined, orderRef?: string) => string;
+    /**
+     * Create a new open shift entry, and save result to database. Also calls function to generate the corresponding interaction.
+     * @static
+     * @param amountInDrawer The cash amount in drawer on open.
+     * @param space Space obj instance.
+     * @param associatedDrawerId The cash drawer id associated to shift
+     * @param userEmail The user that initiated cash drawer opening.
+     * @throws If something goes wrong on save for new shift obj.
+     * @returns The newly generated CashDrawerShift instance.
+     */
+    static openShift: (amountInDrawer: number, space: Space, associatedDrawerId: string, userEmail: string) => Promise<CashDrawerShift>;
+    /**
+     * Generates a new CashDrawerInteraction with provided data and saves entry to database.
+     * @private
+     * @param type The action done on cash drawer
+     * @param amount The amount of cash "moved" with the interaction.
+     * @param options.reason The string reason for the interaction. Will either be generated string for all "normal" interactions, or a user generated string if a manual interaction.
+     * @throws If current shift data has no ID set (meaning it was never saved to database).
+     * @returns If the interaction was saved successfully.
+     */
+    private _saveNewInteraction;
+    /**
+     * Generate data needed to close the shift and update data in database. Also calls function to generate corresponding interaction.
+     * @param amountInDrawer The cash amount in drawer on close
+     * @param userEmail Optionnal. If user who initiated the close if different from the class initiating user. Defaults to value sent to constructor if undefined.
+     * @throws If shift is not currently "open".
+     * @throws If something goes wrong on saving Shift.
+     * @returns If close was successfull.
+     */
+    closeShift: (amountInDrawer: number, userEmail?: string) => Promise<boolean>;
+    /**
+     * Calls function to generate and save new interaction for cash added to drawer.
+     * @param amount The cash amount added to the drawer
+     * @param type The interaction type. Either 'from_order' or 'manual'
+     * @param options.reason The reason for the added cash interaction.
+     * @param options.userEmail Optionnal. If user who added cash to drawer is different from the class initiating user. Defaults to value sent to constructor if undefined.
+     * @throws If shift is not currently "open".
+     * @throws If something goes wrong on saving Shift.
+     * @returns If interaction was saved successfully or not
+     */
+    newCashIn: (amount: number, type: 'manual' | 'from_order', options: {
+        reason: string;
+        userEmail?: string;
+    }) => Promise<boolean>;
+    /**
+     * Calls function to generate and save new interaction for cash removed from drawer.
+     * @param amount The cash amount removed from the drawer
+     * @param type The interaction type. Either 'from_order' or 'manual'
+     * @param options.reason The reason for the removed cash interaction.
+     * @param options.userEmail Optionnal. If user who removed cash from drawer is different from the class initiating user. Defaults to value sent to constructor if undefined.
+     * @throws If shift is not currently "open".
+     * @throws If something goes wrong on saving Shift.
+     * @returns If interaction was saved successfully or not
+     */
+    newCashOut: (amount: number, type: 'manual' | 'from_order', options: {
+        reason: string;
+        userEmail?: string;
+    }) => Promise<boolean>;
+}

package/dist/lib/CashDrawerShift/index.js

@@ -0,0 +1,206 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+const CashDrawers_1 = require("../../Interfaces/CashDrawers");
+const DatabaseService_1 = __importDefault(require("../../services/database/DatabaseService"));
+const locale_1 = require("../../utils/locale");
+const baseService_1 = require("../baseService");
+class CashDrawerShift extends baseService_1.BaseServiceClass {
+    constructor(space, cashDrawerId, _data, _collection, _user) {
+        super(_data, _collection, _user);
+        // ---------------------------------------------------------------
+        // #region DEFAULT CLASS FUNCTIONS
+        this.data = () => this._data;
+        this.save = async (partialShift) => {
+            const superSave = await super.save(partialShift || {}, undefined, true, undefined, undefined, undefined, !!partialShift);
+            if (typeof superSave == 'string' && !this._data.id)
+                this._data = Object.assign(Object.assign({}, this._data), { id: superSave });
+            return !!superSave;
+        };
+        /**
+         * Delete function overriden so it can't be called though class
+         */
+        this.delete = async () => {
+            console.log("Can't delete a shift like this! Returning.");
+            return false;
+        };
+        // #endregion
+        // ---------------------------------------------------------------
+        // #region SPECIFIC FUNCTIONS
+        /**
+         * Generates a new CashDrawerInteraction with provided data and saves entry to database.
+         * @private
+         * @param type The action done on cash drawer
+         * @param amount The amount of cash "moved" with the interaction.
+         * @param options.reason The string reason for the interaction. Will either be generated string for all "normal" interactions, or a user generated string if a manual interaction.
+         * @throws If current shift data has no ID set (meaning it was never saved to database).
+         * @returns If the interaction was saved successfully.
+         */
+        this._saveNewInteraction = async (type, amount, options) => {
+            if (!this._data.id)
+                throw new Error("Shift was never saved to database, can't create new interaction! Returning.");
+            // Construct data from info provided and drawer + shift ids
+            const interactionData = {
+                cash_drawer_id: this._cashDrawerId,
+                shift_id: this._data.id,
+                date: new Date(),
+                action: type,
+                user: options.userEmail || this._user,
+                amount,
+                reason: options.reason
+            };
+            // Save new entry to database
+            const saved = await DatabaseService_1.default.addDocument(DatabaseService_1.default.asCollectionObject(this._space.getRef().path, this._space.getRef().id + '/cash_drawer_interactions').path, interactionData);
+            return !!saved;
+        };
+        /**
+         * Generate data needed to close the shift and update data in database. Also calls function to generate corresponding interaction.
+         * @param amountInDrawer The cash amount in drawer on close
+         * @param userEmail Optionnal. If user who initiated the close if different from the class initiating user. Defaults to value sent to constructor if undefined.
+         * @throws If shift is not currently "open".
+         * @throws If something goes wrong on saving Shift.
+         * @returns If close was successfull.
+         */
+        this.closeShift = async (amountInDrawer, userEmail) => {
+            if (!this._data.is_open)
+                throw new Error("Shift not opened, can't close! Returning.");
+            if (!!this._data.closed_details)
+                throw new Error('Shift already closed! Returning.');
+            // Save new data to close shift
+            const closed = await this.save({
+                id: this._data.id,
+                closed_details: { date: new Date(), by_user: userEmail || this._user },
+                is_open: false
+            });
+            // generate new entry in interactions collection with current info
+            try {
+                const spaceLocale = this._space.preferences.default.locale();
+                await this._saveNewInteraction(CashDrawers_1.CashDrawerActionEnum.END_SHIFT, amountInDrawer, {
+                    userEmail,
+                    reason: CashDrawerShift.getTranslatedGenericInteractionReason(CashDrawers_1.CashDrawerActionEnum.END_SHIFT, spaceLocale)
+                });
+            }
+            catch (e) {
+                console.log('error on creating interaction for shift close: ', e.toString());
+            }
+            return !!closed;
+        };
+        /**
+         * Calls function to generate and save new interaction for cash added to drawer.
+         * @param amount The cash amount added to the drawer
+         * @param type The interaction type. Either 'from_order' or 'manual'
+         * @param options.reason The reason for the added cash interaction.
+         * @param options.userEmail Optionnal. If user who added cash to drawer is different from the class initiating user. Defaults to value sent to constructor if undefined.
+         * @throws If shift is not currently "open".
+         * @throws If something goes wrong on saving Shift.
+         * @returns If interaction was saved successfully or not
+         */
+        this.newCashIn = async (amount, type, options) => {
+            if (!this._data.is_open)
+                throw new Error("Shift not opened, can't add cash! Returning.");
+            if (!!this._data.closed_details)
+                throw new Error("Shift already closed, can't add cash! Returning.");
+            let savedInteraction = false;
+            // generate new entry in interactions collection from provided info
+            try {
+                savedInteraction = await this._saveNewInteraction(type == 'manual' ? CashDrawers_1.CashDrawerActionEnum.MANUAL_CASH_IN : CashDrawers_1.CashDrawerActionEnum.ORDER_CASH_IN, amount, options);
+            }
+            catch (e) {
+                console.log('error on saving new cash in interaction: ', e.toString());
+            }
+            return savedInteraction;
+        };
+        /**
+         * Calls function to generate and save new interaction for cash removed from drawer.
+         * @param amount The cash amount removed from the drawer
+         * @param type The interaction type. Either 'from_order' or 'manual'
+         * @param options.reason The reason for the removed cash interaction.
+         * @param options.userEmail Optionnal. If user who removed cash from drawer is different from the class initiating user. Defaults to value sent to constructor if undefined.
+         * @throws If shift is not currently "open".
+         * @throws If something goes wrong on saving Shift.
+         * @returns If interaction was saved successfully or not
+         */
+        this.newCashOut = async (amount, type, options) => {
+            if (!this._data.is_open)
+                throw new Error("Shift not opened, can't remove cash! Returning.");
+            if (!!this._data.closed_details)
+                throw new Error("Shift already closed, can't remove cash! Returning.");
+            // generate new entry in interactions collection from provided info
+            let savedInteraction = false;
+            try {
+                savedInteraction = await this._saveNewInteraction(type == 'manual' ? CashDrawers_1.CashDrawerActionEnum.MANUAL_CASH_OUT : CashDrawers_1.CashDrawerActionEnum.ORDER_CASH_OUT, amount, options);
+            }
+            catch (e) {
+                console.log('error on saving new cash out interaction: ', e.toString());
+            }
+            return savedInteraction;
+        };
+        this._space = space;
+        this._cashDrawerId = cashDrawerId;
+    }
+}
+exports.default = CashDrawerShift;
+_a = CashDrawerShift;
+// #endregion
+// ---------------------------------------------------------------
+// #region STATIC FUNCTIONS
+/**
+ * Get cash drawer interaction string for specified action, in specified locale.
+ * @static
+ * @param action A streamlined enum of cash drawer actions -  supports all EXCEPT manual actions (MANUAL_CASH_IN and MANUAL_CASH_OUT)
+ * @param locale Optionnal. The local to use. Defaults to 'fr'.
+ * @param orderRef Optionnal. Order ref number to add to string. Only used in ORDER type actions, and defaults to 'ND' if undefined.
+ * @returns The translated string.
+ */
+CashDrawerShift.getTranslatedGenericInteractionReason = (action, locale, orderRef) => {
+    switch (action) {
+        case CashDrawers_1.CashDrawerActionEnum.OPEN_SHIFT:
+            return (0, locale_1.translateILang)({ fr: 'Ouverture de caisse/Début de chiffre', en: 'Drawer open/Shift start' }, locale);
+        case CashDrawers_1.CashDrawerActionEnum.END_SHIFT:
+            return (0, locale_1.translateILang)({ fr: 'Fermeture de caisse/Fin de chiffre', en: 'Drawer close/Shift end' }, locale);
+        case CashDrawers_1.CashDrawerActionEnum.ORDER_CASH_IN:
+            return (0, locale_1.translateILang)({ fr: 'Remboursement ou rachat pour la commande #{num}', en: 'Refund or buyback for order #{num}' }, locale, { num: orderRef || 'ND' });
+        case CashDrawers_1.CashDrawerActionEnum.ORDER_CASH_OUT:
+            return (0, locale_1.translateILang)({ fr: "Transaction d'achat pour la commande #{num}", en: 'Transaction for order #{num}' }, locale, { num: orderRef || 'ND' });
+        default:
+            return '';
+    }
+};
+/**
+ * Create a new open shift entry, and save result to database. Also calls function to generate the corresponding interaction.
+ * @static
+ * @param amountInDrawer The cash amount in drawer on open.
+ * @param space Space obj instance.
+ * @param associatedDrawerId The cash drawer id associated to shift
+ * @param userEmail The user that initiated cash drawer opening.
+ * @throws If something goes wrong on save for new shift obj.
+ * @returns The newly generated CashDrawerShift instance.
+ */
+CashDrawerShift.openShift = async (amountInDrawer, space, associatedDrawerId, userEmail) => {
+    // generate data for shift
+    const newShiftData = {
+        cash_drawer_id: associatedDrawerId,
+        opened_details: { date: new Date(), by_user: userEmail },
+        is_open: true
+    };
+    // construct obj and save to database
+    const newShiftObj = new CashDrawerShift(space, associatedDrawerId, newShiftData, DatabaseService_1.default.asCollectionObject(space.getRef().path, space.getRef().id + '/cash_drawer_shifts'), userEmail);
+    await newShiftObj.save();
+    // generate new entry in interactions collection with current info
+    try {
+        const spaceLocale = space.preferences.default.locale();
+        await newShiftObj._saveNewInteraction(CashDrawers_1.CashDrawerActionEnum.OPEN_SHIFT, amountInDrawer, {
+            userEmail,
+            reason: CashDrawerShift.getTranslatedGenericInteractionReason(CashDrawers_1.CashDrawerActionEnum.OPEN_SHIFT, spaceLocale)
+        });
+    }
+    catch (e) {
+        console.log('error on saving interaction for shift open: ', e.toString());
+    }
+    // return the instance created for furher operations
+    return newShiftObj;
+};
+//# sourceMappingURL=index.js.map

package/dist/lib/CashDrawerShift/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/lib/CashDrawerShift/index.ts"],"names":[],"mappings":";;;;;;AAAA,8DAA6G;AAC7G,8FAAqE;AACrE,+CAAmD;AACnD,gDAAiD;AAGjD,MAAqB,eAAgB,SAAQ,8BAAkC;IAI9E,YACC,KAAY,EACZ,YAAoB,EACpB,KAAuB,EACvB,WAA6B,EAC7B,KAAa;QAEb,KAAK,CAAC,KAAK,EAAE,WAAW,EAAE,KAAK,CAAC,CAAA;QAKjC,kEAAkE;QAClE,kCAAkC;QAC3B,SAAI,GAAG,GAAqB,EAAE,CAAC,IAAI,CAAC,KAAyB,CAAA;QAE7D,SAAI,GAAG,KAAK,EAAE,YAAwC,EAAoB,EAAE;YAClF,MAAM,SAAS,GAAG,MAAM,KAAK,CAAC,IAAI,CACjC,YAAY,IAAI,EAAE,EAClB,SAAS,EACT,IAAI,EACJ,SAAS,EACT,SAAS,EACT,SAAS,EACT,CAAC,CAAC,YAAY,CACd,CAAA;YAED,IAAI,OAAO,SAAS,IAAI,QAAQ,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;gBAAE,IAAI,CAAC,KAAK,mCAAQ,IAAI,CAAC,KAAK,KAAE,EAAE,EAAE,SAAS,GAAE,CAAA;YACjG,OAAO,CAAC,CAAC,SAAS,CAAA;QACnB,CAAC,CAAA;QAED;;WAEG;QACI,WAAM,GAAG,KAAK,IAAsB,EAAE;YAC5C,OAAO,CAAC,GAAG,CAAC,4CAA4C,CAAC,CAAA;YACzD,OAAO,KAAK,CAAA;QACb,CAAC,CAAA;QAyFD,aAAa;QAEb,kEAAkE;QAClE,6BAA6B;QAE7B;;;;;;;;WAQG;QACK,wBAAmB,GAAG,KAAK,EAClC,IAA0B,EAC1B,MAAc,EACd,OAA+C,EAC5B,EAAE;YACrB,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;gBAAE,MAAM,IAAI,KAAK,CAAC,6EAA6E,CAAC,CAAA;YAElH,2DAA2D;YAC3D,MAAM,eAAe,GAA2B;gBAC/C,cAAc,EAAE,IAAI,CAAC,aAAa;gBAClC,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE;gBACvB,IAAI,EAAE,IAAI,IAAI,EAAE;gBAChB,MAAM,EAAE,IAAI;gBACZ,IAAI,EAAE,OAAO,CAAC,SAAS,IAAI,IAAI,CAAC,KAAK;gBACrC,MAAM;gBACN,MAAM,EAAE,OAAO,CAAC,MAAM;aACtB,CAAA;YAED,6BAA6B;YAC7B,MAAM,KAAK,GAAG,MAAM,yBAAe,CAAC,WAAW,CAC9C,yBAAe,CAAC,kBAAkB,CACjC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,IAAI,EACzB,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,GAAG,2BAA2B,CACrD,CAAC,IAAI,EACN,eAAe,CACf,CAAA;YAED,OAAO,CAAC,CAAC,KAAK,CAAA;QACf,CAAC,CAAA;QAED;;;;;;;WAOG;QACI,eAAU,GAAG,KAAK,EAAE,cAAsB,EAAE,SAAkB,EAAoB,EAAE;YAC1F,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO;gBAAE,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAA;YACrF,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc;gBAAE,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAA;YAEpF,+BAA+B;YAC/B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC;gBAC9B,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,EAAE;gBACjB,cAAc,EAAE,EAAE,IAAI,EAAE,IAAI,IAAI,EAAE,EAAE,OAAO,EAAE,SAAS,IAAI,IAAI,CAAC,KAAK,EAAE;gBACtE,OAAO,EAAE,KAAK;aACd,CAAC,CAAA;YAEF,kEAAkE;YAClE,IAAI;gBACH,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,MAAM,EAAE,CAAA;gBAC5D,MAAM,IAAI,CAAC,mBAAmB,CAAC,kCAAoB,CAAC,SAAS,EAAE,cAAc,EAAE;oBAC9E,SAAS;oBACT,MAAM,EAAE,eAAe,CAAC,qCAAqC,CAAC,kCAAoB,CAAC,SAAS,EAAE,WAAW,CAAC;iBAC1G,CAAC,CAAA;aACF;YAAC,OAAO,CAAC,EAAE;gBACX,OAAO,CAAC,GAAG,CAAC,iDAAiD,EAAG,CAAW,CAAC,QAAQ,EAAE,CAAC,CAAA;aACvF;YAED,OAAO,CAAC,CAAC,MAAM,CAAA;QAChB,CAAC,CAAA;QAED;;;;;;;;;WASG;QACI,cAAS,GAAG,KAAK,EACvB,MAAc,EACd,IAA6B,EAC7B,OAA+C,EAC9C,EAAE;YACH,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO;gBAAE,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAA;YACxF,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc;gBAAE,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAA;YAEpG,IAAI,gBAAgB,GAAG,KAAK,CAAA;YAE5B,mEAAmE;YACnE,IAAI;gBACH,gBAAgB,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAChD,IAAI,IAAI,QAAQ,CAAC,CAAC,CAAC,kCAAoB,CAAC,cAAc,CAAC,CAAC,CAAC,kCAAoB,CAAC,aAAa,EAC3F,MAAM,EACN,OAAO,CACP,CAAA;aACD;YAAC,OAAO,CAAC,EAAE;gBACX,OAAO,CAAC,GAAG,CAAC,2CAA2C,EAAG,CAAW,CAAC,QAAQ,EAAE,CAAC,CAAA;aACjF;YAED,OAAO,gBAAgB,CAAA;QACxB,CAAC,CAAA;QAED;;;;;;;;;WASG;QACI,eAAU,GAAG,KAAK,EACxB,MAAc,EACd,IAA6B,EAC7B,OAA+C,EAC9C,EAAE;YACH,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO;gBAAE,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAA;YAC3F,IAAI,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc;gBAAE,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAA;YAEvG,mEAAmE;YACnE,IAAI,gBAAgB,GAAG,KAAK,CAAA;YAC5B,IAAI;gBACH,gBAAgB,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAChD,IAAI,IAAI,QAAQ,CAAC,CAAC,CAAC,kCAAoB,CAAC,eAAe,CAAC,CAAC,CAAC,kCAAoB,CAAC,cAAc,EAC7F,MAAM,EACN,OAAO,CACP,CAAA;aACD;YAAC,OAAO,CAAC,EAAE;gBACX,OAAO,CAAC,GAAG,CAAC,4CAA4C,EAAG,CAAW,CAAC,QAAQ,EAAE,CAAC,CAAA;aAClF;YAED,OAAO,gBAAgB,CAAA;QACxB,CAAC,CAAA;QApQA,IAAI,CAAC,MAAM,GAAG,KAAK,CAAA;QACnB,IAAI,CAAC,aAAa,GAAG,YAAY,CAAA;IAClC,CAAC;;AAdF,kCAmRC;;AAzOA,aAAa;AAEb,kEAAkE;AAClE,2BAA2B;AAE3B;;;;;;;GAOG;AACI,qDAAqC,GAAG,CAC9C,MAAiH,EACjH,MAA0B,EAC1B,QAAiB,EACR,EAAE;IACX,QAAQ,MAAM,EAAE;QACf,KAAK,kCAAoB,CAAC,UAAU;YACnC,OAAO,IAAA,uBAAc,EAAC,EAAE,EAAE,EAAE,sCAAsC,EAAE,EAAE,EAAE,yBAAyB,EAAE,EAAE,MAAM,CAAC,CAAA;QAC7G,KAAK,kCAAoB,CAAC,SAAS;YAClC,OAAO,IAAA,uBAAc,EAAC,EAAE,EAAE,EAAE,oCAAoC,EAAE,EAAE,EAAE,wBAAwB,EAAE,EAAE,MAAM,CAAC,CAAA;QAC1G,KAAK,kCAAoB,CAAC,aAAa;YACtC,OAAO,IAAA,uBAAc,EACpB,EAAE,EAAE,EAAE,iDAAiD,EAAE,EAAE,EAAE,oCAAoC,EAAE,EACnG,MAAM,EACN,EAAE,GAAG,EAAE,QAAQ,IAAI,IAAI,EAAE,CACzB,CAAA;QACF,KAAK,kCAAoB,CAAC,cAAc;YACvC,OAAO,IAAA,uBAAc,EACpB,EAAE,EAAE,EAAE,6CAA6C,EAAE,EAAE,EAAE,8BAA8B,EAAE,EACzF,MAAM,EACN,EAAE,GAAG,EAAE,QAAQ,IAAI,IAAI,EAAE,CACzB,CAAA;QAEF;YACC,OAAO,EAAE,CAAA;KACV;AACF,CAAC,CAAA;AAED;;;;;;;;;GASG;AACI,yBAAS,GAAG,KAAK,EACvB,cAAsB,EACtB,KAAY,EACZ,kBAA0B,EAC1B,SAAiB,EACU,EAAE;IAC7B,0BAA0B;IAC1B,MAAM,YAAY,GAAqB;QACtC,cAAc,EAAE,kBAAkB;QAClC,cAAc,EAAE,EAAE,IAAI,EAAE,IAAI,IAAI,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE;QACxD,OAAO,EAAE,IAAI;KACb,CAAA;IAED,qCAAqC;IACrC,MAAM,WAAW,GAAG,IAAI,eAAe,CACtC,KAAK,EACL,kBAAkB,EAClB,YAAY,EACZ,yBAAe,CAAC,kBAAkB,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,GAAG,qBAAqB,CAAC,EAClG,SAAS,CACT,CAAA;IACD,MAAM,WAAW,CAAC,IAAI,EAAE,CAAA;IAExB,kEAAkE;IAClE,IAAI;QACH,MAAM,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,MAAM,EAAE,CAAA;QACtD,MAAM,WAAW,CAAC,mBAAmB,CAAC,kCAAoB,CAAC,UAAU,EAAE,cAAc,EAAE;YACtF,SAAS;YACT,MAAM,EAAE,eAAe,CAAC,qCAAqC,CAAC,kCAAoB,CAAC,UAAU,EAAE,WAAW,CAAC;SAC3G,CAAC,CAAA;KACF;IAAC,OAAO,CAAC,EAAE;QACX,OAAO,CAAC,GAAG,CAAC,8CAA8C,EAAG,CAAW,CAAC,QAAQ,EAAE,CAAC,CAAA;KACpF;IAED,oDAAoD;IACpD,OAAO,WAAW,CAAA;AACnB,CAAC,CAAA"}

package/dist/lib/Space/index.d.ts

@@ -64,6 +64,8 @@ import { MenuPositionEnum } from '../../Interfaces/Menu';
 import Menu from '../../lib/Menu';
 import Note from '../Note';
 import { NoteTypeEnum } from '../../Interfaces/Note';
+import { CashDrawerActionEnum, ICashDrawer, ICashDrawerInteraction } from '../../Interfaces/CashDrawers';
+import CashDrawerShift from '../CashDrawerShift';
 /**
  * Class Space
  * A Space represent a company.
@@ -597,6 +599,63 @@ export default class Space {
      * Retourne tous les menus actifs
      */
     private _getAllActiveMenus;
+    /**
+     * Utils to check and return current space cash drawers. Throws an error if space does not has corresponding feature set, or if id provided and same id not found in current cash drawers.
+     * @param idToCheck Optionnal. Cart drawer id to check in current space data.
+     */
+    private _checkCurrentSpaceDataForCashDrawer;
+    /**
+     * Generates new cash drawer from data provided, and saves to cash_drawer array in Space data.
+     * @param data.nickname Nickname for cash drawer (required)
+     * @param data.drawerNumber Optionnal. Number for given cash drawer
+     * @throws If feature for cash drawers is not set in space_options
+     * @returns {ICashDrawer[]} Space's cash drawer array with newly added drawer at last index
+     */
+    private _createNewCashDrawer;
+    /**
+     * Updates existing cash drawer from data provided, and saves to cash_drawer array in Space data.
+     * @param id Id for the cash drawer to update
+     * @param data.nickname Nickname for cash drawer (required)
+     * @param data.drawerNumber Optionnal. Number for given cash drawer
+     * @throws If feature for cash drawers is not set in space_options
+     * @throws If same drawer id not found in current space data cash drawers.
+     * @returns Updated space cash drawer array
+     */
+    private _editCashDrawer;
+    /**
+     * Toggles active property for existing cash drawer, and saves to cash_drawer array in Space data.
+     * @param id Id for the cash drawer to toggle
+     * @throws If feature for cash drawers is not set in space_options
+     * @throws If same drawer id not found in current space data cash drawers.
+     * @returns Updated space cash drawer array
+     */
+    private _toggleCashDrawer;
+    /**
+     * Checks if an open shift is found for a corresponding cash drawer id.
+     * @param id The cash drawer id
+     * @returns If open shift found for drawer.
+     */
+    private _checkIfOpenShiftExistsForDrawer;
+    /**
+     * Fetch corresponding open shift for a given drawer ID.
+     * @param id Id for the cash drawer to search.
+     * @throws If feature for cash drawers is not set in space_options
+     * @throws If same drawer id not found in current space data cash drawers.
+     * @returns Found shift or undefined
+     */
+    private _getOpenShiftForDrawer;
+    /**
+     * Fetch all cash drawer interaction history entries for specified options. All options are optionnal.
+     * @param options.drawerId Specific cash drawer Id
+     * @param options.shiftId Specific shift Id
+     * @param options.action Specific action type
+     * @param options.userEmail Specific user email that generated interaction
+     * @param options.dates Specific dates to filter results. If options.dates if provided, start date is obligatory, and end date optionnal.
+     * @throws If feature for cash drawers is not set in space_options
+     * @throws If same drawer id not found in current space data cash drawers.
+     * @returns Array of corresponding Interaction history entries, ordered by oldest to newest. If not date provided in options, returns max 100 entries. Else returns all found.
+     */
+    private _getInteractionHistoryForDrawer;
     attributes: {
         get: (options?: IQueryOptions) => Promise<Attribute[]>;
         add: (attribute: IAttribute) => Promise<void>;
@@ -1044,6 +1103,29 @@ export default class Space {
         getActiveBySlug: (slug: MenuPositionEnum) => Promise<Menu | undefined>;
         getAllActive: () => Promise<Menu[]>;
     };
+    cashDrawers: {
+        create: (data: {
+            nickname: string;
+            drawerNumber?: number;
+        }) => Promise<ICashDrawer[]>;
+        edit: (id: string, data: {
+            nickname: string;
+            drawerNumber?: number;
+        }) => Promise<ICashDrawer[]>;
+        toggle: (id: string) => Promise<ICashDrawer[]>;
+        hasOpenShift: (drawerId: string) => Promise<boolean>;
+        getOpenShift: (drawerId: string) => Promise<CashDrawerShift | undefined>;
+        getInteractionHistory: (options?: {
+            drawerId?: string;
+            shiftId?: string;
+            action?: CashDrawerActionEnum;
+            userEmail?: string;
+            dates?: {
+                start: Date;
+                end?: Date;
+            };
+        }) => Promise<ICashDrawerInteraction[]>;
+    };
     /**
      * Get all space properties
      */