addio-admin-sdk 1.7.144 → 1.7.145

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

@@ -1,49 +1,49 @@
-import { ICartReservedQuantities } from '../../Interfaces/CartReservedQuantities';
-import { BaseServiceClass } from '../baseService';
-export default class CartReservedQuantities extends BaseServiceClass<ICartReservedQuantities> {
-    private _space;
-    data: () => ICartReservedQuantities;
-    save(partial?: Partial<any>, _options?: any, saveToDatabase?: boolean, _update?: boolean, merge?: boolean, _beforeData?: any, onlyPartial?: boolean, noEvent?: boolean): Promise<boolean | string>;
-    private _getInventory;
-    /**
-     * Add a quantity to a SKU in the reservation list
-     * If the SKU is new, a new entry is added with the quantity
-     * else the quantity is added to the existing one
-     * @param sku The sku to add
-     * @param qty The quantity to add
-     * @param storeId The store id to use for reservation, undefined if web only
-     * @returns True if successfull, False if failled
-     */
-    addProduct: (sku: string, qty: number, storeId: string | undefined) => Promise<boolean>;
-    /**
-     * Remove a quantity from a SKU in the reservation list
-     * Remove the provided quantity from the list, if the amount reatch 0 the
-     * SKU is removed from the list
-     * @param sku The sku to remove
-     * @param qty The quantity to remove
-     * @param storeId The store id to use for reservation, undefined if web only
-     * @returns True if successfull, False if failled
-     */
-    removeProduct: (sku: string, qty: number, storeId: string | undefined) => Promise<boolean>;
-    /**
-     * Set a sku quantity in the reservation list
-     * The SKU will be added to the list if it's not in the list yet
-     * The value will be set to the provided quantity and the inventory
-     * will be adjusted accordingly
-     * @param sku The sku to set
-     * @param qty The quantity to set
-     * @param storeId The store id to use for reservation, undefined if web only
-     * @returns True if successfull
-     */
-    setProduct: (sku: string, qty: number, storeId: string | undefined) => Promise<boolean>;
-    /**
-     * Delete this document and release all reserved quantities
-     * @returns List of sku in error
-     */
-    deleteAndFreeInventory: (storeId: string | undefined) => Promise<string[]>;
-    /**
-     * Set last_update property with provided value
-     * @param newValue
-     */
-    setLastUpdate: (newValue: Date) => Promise<boolean>;
-}
+import { ICartReservedQuantities } from '../../Interfaces/CartReservedQuantities';
+import { BaseServiceClass } from '../baseService';
+export default class CartReservedQuantities extends BaseServiceClass<ICartReservedQuantities> {
+    private _space;
+    data: () => ICartReservedQuantities;
+    save(partial?: Partial<any>, _options?: any, saveToDatabase?: boolean, _update?: boolean, merge?: boolean, _beforeData?: any, onlyPartial?: boolean, noEvent?: boolean): Promise<boolean | string>;
+    private _getInventory;
+    /**
+     * Add a quantity to a SKU in the reservation list
+     * If the SKU is new, a new entry is added with the quantity
+     * else the quantity is added to the existing one
+     * @param sku The sku to add
+     * @param qty The quantity to add
+     * @param storeId The store id to use for reservation, undefined if web only
+     * @returns True if successfull, False if failled
+     */
+    addProduct: (sku: string, qty: number, storeId: string | undefined) => Promise<boolean>;
+    /**
+     * Remove a quantity from a SKU in the reservation list
+     * Remove the provided quantity from the list, if the amount reatch 0 the
+     * SKU is removed from the list
+     * @param sku The sku to remove
+     * @param qty The quantity to remove
+     * @param storeId The store id to use for reservation, undefined if web only
+     * @returns True if successfull, False if failled
+     */
+    removeProduct: (sku: string, qty: number, storeId: string | undefined) => Promise<boolean>;
+    /**
+     * Set a sku quantity in the reservation list
+     * The SKU will be added to the list if it's not in the list yet
+     * The value will be set to the provided quantity and the inventory
+     * will be adjusted accordingly
+     * @param sku The sku to set
+     * @param qty The quantity to set
+     * @param storeId The store id to use for reservation, undefined if web only
+     * @returns True if successfull
+     */
+    setProduct: (sku: string, qty: number, storeId: string | undefined) => Promise<boolean>;
+    /**
+     * Delete this document and release all reserved quantities
+     * @returns List of sku in error
+     */
+    deleteAndFreeInventory: (storeId: string | undefined) => Promise<string[]>;
+    /**
+     * Set last_update property with provided value
+     * @param newValue
+     */
+    setLastUpdate: (newValue: Date) => Promise<boolean>;
+}

package/dist/lib/CartReservedQuantities/index.js

@@ -1,160 +1,160 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const DatabaseService_1 = __importDefault(require("../../services/database/DatabaseService"));
-const baseService_1 = require("../baseService");
-const Inventory_1 = __importDefault(require("../Inventory"));
-const Space_1 = __importDefault(require("../Space"));
-class CartReservedQuantities extends baseService_1.BaseServiceClass {
-    constructor() {
-        super(...arguments);
-        this._space = undefined;
-        this.data = () => this._data;
-        this._getInventory = async (sku) => {
-            // create space object
-            if (!this._space)
-                this._space = await Space_1.default.getCurrentSpaceWithRef(this._collection.path, this._user);
-            const invData = await this._space.inventoryItems.getOne(sku);
-            if (!invData)
-                return;
-            const collectionPath = DatabaseService_1.default.addToPath(this._space.getRef().path, this._space.getRef().id + '/inventories');
-            return new Inventory_1.default(invData, { path: collectionPath }, this._user);
-        };
-        /**
-         * Add a quantity to a SKU in the reservation list
-         * If the SKU is new, a new entry is added with the quantity
-         * else the quantity is added to the existing one
-         * @param sku The sku to add
-         * @param qty The quantity to add
-         * @param storeId The store id to use for reservation, undefined if web only
-         * @returns True if successfull, False if failled
-         */
-        this.addProduct = async (sku, qty, storeId) => {
-            if (qty == 0)
-                return true;
-            const inventory = await this._getInventory(sku);
-            if (!inventory)
-                throw new Error('Inventory not found');
-            // reserve inventory
-            await inventory.handleReserveInventory(qty, storeId);
-            // add to this object
-            const item = this._data.items.find((i) => i.sku === sku);
-            if (item) {
-                item.qty += qty;
-            }
-            else {
-                this._data.items.push({ sku, qty });
-            }
-            // save
-            await this.save();
-            return true;
-        };
-        /**
-         * Remove a quantity from a SKU in the reservation list
-         * Remove the provided quantity from the list, if the amount reatch 0 the
-         * SKU is removed from the list
-         * @param sku The sku to remove
-         * @param qty The quantity to remove
-         * @param storeId The store id to use for reservation, undefined if web only
-         * @returns True if successfull, False if failled
-         */
-        this.removeProduct = async (sku, qty, storeId) => {
-            if (qty == 0)
-                return true;
-            const item = this._data.items.find((i) => i.sku === sku);
-            if (!item)
-                return false;
-            const inventory = await this._getInventory(sku);
-            if (!inventory)
-                throw new Error('Inventory not found');
-            const realQty = item.qty < qty ? item.qty : qty;
-            // unreserve inventory
-            await inventory.handleUnreserveInventory(realQty, storeId);
-            // remove from this object
-            item.qty -= realQty;
-            if (item.qty <= 0) {
-                // remove from array if <= 0
-                this._data = Object.assign(Object.assign({}, this._data), { items: this._data.items.filter((i) => i.sku !== sku) });
-            }
-            // save
-            await this.save();
-            return true;
-        };
-        /**
-         * Set a sku quantity in the reservation list
-         * The SKU will be added to the list if it's not in the list yet
-         * The value will be set to the provided quantity and the inventory
-         * will be adjusted accordingly
-         * @param sku The sku to set
-         * @param qty The quantity to set
-         * @param storeId The store id to use for reservation, undefined if web only
-         * @returns True if successfull
-         */
-        this.setProduct = async (sku, qty, storeId) => {
-            if (qty < 0)
-                throw new Error('Quantity cannot be negative');
-            const item = this._data.items.find((i) => i.sku === sku);
-            const inventory = await this._getInventory(sku);
-            if (!inventory)
-                throw new Error('Inventory not found');
-            const realQtyToReserve = item ? qty - item.qty : qty;
-            // process inventory changes
-            if (realQtyToReserve >= 0)
-                await inventory.handleReserveInventory(realQtyToReserve, storeId);
-            else
-                await inventory.handleUnreserveInventory(-realQtyToReserve, storeId);
-            // set new quantity
-            if (item) {
-                item.qty = qty;
-                if (item.qty <= 0) {
-                    // remove from array if <= 0
-                    this._data = Object.assign(Object.assign({}, this._data), { items: this._data.items.filter((i) => i.sku !== sku) });
-                }
-            }
-            else if (qty > 0)
-                this._data.items.push({ sku, qty });
-            // save
-            await this.save();
-            return true;
-        };
-        /**
-         * Delete this document and release all reserved quantities
-         * @returns List of sku in error
-         */
-        this.deleteAndFreeInventory = async (storeId) => {
-            const errors = [];
-            for (const item of this._data.items) {
-                try {
-                    const inventory = await this._getInventory(item.sku);
-                    if (!inventory)
-                        continue;
-                    await inventory.handleUnreserveInventory(item.qty, storeId);
-                }
-                catch (err) {
-                    errors.push(item.sku);
-                    console.log(err);
-                }
-            }
-            await this.delete();
-            return errors;
-        };
-        /**
-         * Set last_update property with provided value
-         * @param newValue
-         */
-        this.setLastUpdate = async (newValue) => {
-            const saved = await this.save({ id: this._data.id, last_update: newValue });
-            return !!saved;
-        };
-    }
-    async save(partial, _options, saveToDatabase = true, _update, merge = true, _beforeData, onlyPartial = false, noEvent = false) {
-        const id = await super.save(Object.assign(Object.assign({}, partial), { last_update: new Date().toISOString() }), _options, saveToDatabase, _update, merge, _beforeData, onlyPartial, noEvent);
-        if (typeof id === 'string')
-            this._data = Object.assign(Object.assign({}, this._data), { id: id });
-        return id;
-    }
-}
-exports.default = CartReservedQuantities;
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const DatabaseService_1 = __importDefault(require("../../services/database/DatabaseService"));
+const baseService_1 = require("../baseService");
+const Inventory_1 = __importDefault(require("../Inventory"));
+const Space_1 = __importDefault(require("../Space"));
+class CartReservedQuantities extends baseService_1.BaseServiceClass {
+    constructor() {
+        super(...arguments);
+        this._space = undefined;
+        this.data = () => this._data;
+        this._getInventory = async (sku) => {
+            // create space object
+            if (!this._space)
+                this._space = await Space_1.default.getCurrentSpaceWithRef(this._collection.path, this._user);
+            const invData = await this._space.inventoryItems.getOne(sku);
+            if (!invData)
+                return;
+            const collectionPath = DatabaseService_1.default.addToPath(this._space.getRef().path, this._space.getRef().id + '/inventories');
+            return new Inventory_1.default(invData, { path: collectionPath }, this._user);
+        };
+        /**
+         * Add a quantity to a SKU in the reservation list
+         * If the SKU is new, a new entry is added with the quantity
+         * else the quantity is added to the existing one
+         * @param sku The sku to add
+         * @param qty The quantity to add
+         * @param storeId The store id to use for reservation, undefined if web only
+         * @returns True if successfull, False if failled
+         */
+        this.addProduct = async (sku, qty, storeId) => {
+            if (qty == 0)
+                return true;
+            const inventory = await this._getInventory(sku);
+            if (!inventory)
+                throw new Error('Inventory not found');
+            // reserve inventory
+            await inventory.handleReserveInventory(qty, storeId);
+            // add to this object
+            const item = this._data.items.find((i) => i.sku === sku);
+            if (item) {
+                item.qty += qty;
+            }
+            else {
+                this._data.items.push({ sku, qty });
+            }
+            // save
+            await this.save();
+            return true;
+        };
+        /**
+         * Remove a quantity from a SKU in the reservation list
+         * Remove the provided quantity from the list, if the amount reatch 0 the
+         * SKU is removed from the list
+         * @param sku The sku to remove
+         * @param qty The quantity to remove
+         * @param storeId The store id to use for reservation, undefined if web only
+         * @returns True if successfull, False if failled
+         */
+        this.removeProduct = async (sku, qty, storeId) => {
+            if (qty == 0)
+                return true;
+            const item = this._data.items.find((i) => i.sku === sku);
+            if (!item)
+                return false;
+            const inventory = await this._getInventory(sku);
+            if (!inventory)
+                throw new Error('Inventory not found');
+            const realQty = item.qty < qty ? item.qty : qty;
+            // unreserve inventory
+            await inventory.handleUnreserveInventory(realQty, storeId);
+            // remove from this object
+            item.qty -= realQty;
+            if (item.qty <= 0) {
+                // remove from array if <= 0
+                this._data = Object.assign(Object.assign({}, this._data), { items: this._data.items.filter((i) => i.sku !== sku) });
+            }
+            // save
+            await this.save();
+            return true;
+        };
+        /**
+         * Set a sku quantity in the reservation list
+         * The SKU will be added to the list if it's not in the list yet
+         * The value will be set to the provided quantity and the inventory
+         * will be adjusted accordingly
+         * @param sku The sku to set
+         * @param qty The quantity to set
+         * @param storeId The store id to use for reservation, undefined if web only
+         * @returns True if successfull
+         */
+        this.setProduct = async (sku, qty, storeId) => {
+            if (qty < 0)
+                throw new Error('Quantity cannot be negative');
+            const item = this._data.items.find((i) => i.sku === sku);
+            const inventory = await this._getInventory(sku);
+            if (!inventory)
+                throw new Error('Inventory not found');
+            const realQtyToReserve = item ? qty - item.qty : qty;
+            // process inventory changes
+            if (realQtyToReserve >= 0)
+                await inventory.handleReserveInventory(realQtyToReserve, storeId);
+            else
+                await inventory.handleUnreserveInventory(-realQtyToReserve, storeId);
+            // set new quantity
+            if (item) {
+                item.qty = qty;
+                if (item.qty <= 0) {
+                    // remove from array if <= 0
+                    this._data = Object.assign(Object.assign({}, this._data), { items: this._data.items.filter((i) => i.sku !== sku) });
+                }
+            }
+            else if (qty > 0)
+                this._data.items.push({ sku, qty });
+            // save
+            await this.save();
+            return true;
+        };
+        /**
+         * Delete this document and release all reserved quantities
+         * @returns List of sku in error
+         */
+        this.deleteAndFreeInventory = async (storeId) => {
+            const errors = [];
+            for (const item of this._data.items) {
+                try {
+                    const inventory = await this._getInventory(item.sku);
+                    if (!inventory)
+                        continue;
+                    await inventory.handleUnreserveInventory(item.qty, storeId);
+                }
+                catch (err) {
+                    errors.push(item.sku);
+                    console.log(err);
+                }
+            }
+            await this.delete();
+            return errors;
+        };
+        /**
+         * Set last_update property with provided value
+         * @param newValue
+         */
+        this.setLastUpdate = async (newValue) => {
+            const saved = await this.save({ id: this._data.id, last_update: newValue });
+            return !!saved;
+        };
+    }
+    async save(partial, _options, saveToDatabase = true, _update, merge = true, _beforeData, onlyPartial = false, noEvent = false) {
+        const id = await super.save(Object.assign(Object.assign({}, partial), { last_update: new Date().toISOString() }), _options, saveToDatabase, _update, merge, _beforeData, onlyPartial, noEvent);
+        if (typeof id === 'string')
+            this._data = Object.assign(Object.assign({}, this._data), { id: id });
+        return id;
+    }
+}
+exports.default = CartReservedQuantities;
 //# sourceMappingURL=index.js.map

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

@@ -1,83 +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>;
-}
+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>;
+}