addio-admin-sdk 1.7.167 → 1.7.169

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

@@ -1,15 +1,15 @@
-import IProductAttribute from '../../Interfaces/ProductAttribute';
-import Attribute from '../Attribute';
-export default class ProductAttribute {
-    private _product_attribute;
-    private _attributes_collection;
-    private _user;
-    constructor(product_attribute: IProductAttribute, attributes_collection: string, user: string);
-    data: () => IProductAttribute;
-    save: (partialProductAttribute?: Partial<IProductAttribute>) => Promise<boolean | string>;
-    delete: () => Promise<boolean>;
-    private _getAttribute;
-    attribute: {
-        get: () => Promise<Attribute | undefined>;
-    };
-}
+import IProductAttribute from '../../Interfaces/ProductAttribute';
+import Attribute from '../Attribute';
+export default class ProductAttribute {
+    private _product_attribute;
+    private _attributes_collection;
+    private _user;
+    constructor(product_attribute: IProductAttribute, attributes_collection: string, user: string);
+    data: () => IProductAttribute;
+    save: (partialProductAttribute?: Partial<IProductAttribute>) => Promise<boolean | string>;
+    delete: () => Promise<boolean>;
+    private _getAttribute;
+    attribute: {
+        get: () => Promise<Attribute | undefined>;
+    };
+}

package/dist/lib/ProductAttribute/index.js

@@ -1,46 +1,46 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const console_1 = require("../../utils/console");
-const Attribute_1 = __importDefault(require("../Attribute"));
-const DatabaseService_1 = __importDefault(require("../../services/database/DatabaseService"));
-const moment_1 = __importDefault(require("moment"));
-class ProductAttribute {
-    constructor(product_attribute, attributes_collection, user) {
-        this.data = () => this._product_attribute;
-        this.save = async (partialProductAttribute) => {
-            var _a;
-            this._product_attribute = Object.assign(Object.assign({}, this._product_attribute), partialProductAttribute);
-            return await DatabaseService_1.default.saveDocument(this._attributes_collection, (_a = this._product_attribute.id) !== null && _a !== void 0 ? _a : '', (0, moment_1.default)().unix(), this._product_attribute, { merge: false });
-        };
-        this.delete = async () => {
-            var _a;
-            return await DatabaseService_1.default.deleteDocument(this._attributes_collection, (_a = this._product_attribute.id) !== null && _a !== void 0 ? _a : '');
-        };
-        this._getAttribute = async () => {
-            if (DatabaseService_1.default.getPathParent(this._attributes_collection) == '/')
-                throw new Error(`Can't retrieve attribute's collection`);
-            const _attribute = await DatabaseService_1.default.getDocument(DatabaseService_1.default.addToPath(DatabaseService_1.default.getPathParent(this._attributes_collection), 'attributes'), this._product_attribute.attribute_id);
-            if (!_attribute.exists || !!!_attribute.data)
-                throw new Error(`Can't retrieve attribute by ref ${this._product_attribute.attribute_id}`);
-            try {
-                return new Attribute_1.default(_attribute.data, {
-                    path: DatabaseService_1.default.addToPath(DatabaseService_1.default.getPathParent(this._attributes_collection), 'attributes')
-                }, this._user);
-            }
-            catch (error) {
-                (0, console_1.errorMessage)(`Error while accessing attribute: ${error}`);
-            }
-        };
-        this.attribute = {
-            get: this._getAttribute
-        };
-        this._product_attribute = product_attribute;
-        this._attributes_collection = attributes_collection;
-        this._user = user;
-    }
-}
-exports.default = ProductAttribute;
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const console_1 = require("../../utils/console");
+const Attribute_1 = __importDefault(require("../Attribute"));
+const DatabaseService_1 = __importDefault(require("../../services/database/DatabaseService"));
+const moment_1 = __importDefault(require("moment"));
+class ProductAttribute {
+    constructor(product_attribute, attributes_collection, user) {
+        this.data = () => this._product_attribute;
+        this.save = async (partialProductAttribute) => {
+            var _a;
+            this._product_attribute = Object.assign(Object.assign({}, this._product_attribute), partialProductAttribute);
+            return await DatabaseService_1.default.saveDocument(this._attributes_collection, (_a = this._product_attribute.id) !== null && _a !== void 0 ? _a : '', (0, moment_1.default)().unix(), this._product_attribute, { merge: false });
+        };
+        this.delete = async () => {
+            var _a;
+            return await DatabaseService_1.default.deleteDocument(this._attributes_collection, (_a = this._product_attribute.id) !== null && _a !== void 0 ? _a : '');
+        };
+        this._getAttribute = async () => {
+            if (DatabaseService_1.default.getPathParent(this._attributes_collection) == '/')
+                throw new Error(`Can't retrieve attribute's collection`);
+            const _attribute = await DatabaseService_1.default.getDocument(DatabaseService_1.default.addToPath(DatabaseService_1.default.getPathParent(this._attributes_collection), 'attributes'), this._product_attribute.attribute_id);
+            if (!_attribute.exists || !!!_attribute.data)
+                throw new Error(`Can't retrieve attribute by ref ${this._product_attribute.attribute_id}`);
+            try {
+                return new Attribute_1.default(_attribute.data, {
+                    path: DatabaseService_1.default.addToPath(DatabaseService_1.default.getPathParent(this._attributes_collection), 'attributes')
+                }, this._user);
+            }
+            catch (error) {
+                (0, console_1.errorMessage)(`Error while accessing attribute: ${error}`);
+            }
+        };
+        this.attribute = {
+            get: this._getAttribute
+        };
+        this._product_attribute = product_attribute;
+        this._attributes_collection = attributes_collection;
+        this._user = user;
+    }
+}
+exports.default = ProductAttribute;
 //# sourceMappingURL=index.js.map

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

@@ -1,109 +1,109 @@
-import { ICustomPriceItem } from '../../Interfaces/G2';
-import Cart from '../../lib/Cart';
-import IPromiseToPurchase, { IBank, IBankAdjustment } from '../../Interfaces/PromiseToPurchase';
-import { IBankRule } from '../../Interfaces/PromiseToPurchase/BankType';
-import Space from '../Space';
-import { IApplicablePromiseBank, IBankUsed } from '../../Interfaces/Cart';
-import IQueryOptions from '../../Interfaces/Query/IProductQueryOptions';
-import { IQueryProps } from '../../Interfaces/Product';
-import { SearchResponse } from '@algolia/client-search';
-import IIndexedCustomerPromiseToPurchase from '../../Interfaces/PromiseToPurchase/IIndexedCustomerPromiseToPurchase';
-import IIndexedBankUsed from '../../Interfaces/PromiseToPurchase/IIndexedBankUsed';
-import { BaseServiceClass } from '../baseService';
-export default class PromiseToPurchase extends BaseServiceClass<IPromiseToPurchase> {
-    data: () => IPromiseToPurchase;
-    /**
-     * @deprecated a promise to purchase cannot be deleted.
-     */
-    delete: () => Promise<boolean>;
-    static fetch: ({ app, api, hpp, page, query, filters, indice, f, space, useProspr }: IQueryProps) => Promise<SearchResponse<IIndexedCustomerPromiseToPurchase>>;
-    /**
-     *
-     * @param space
-     * @param hpp
-     * @param page
-     * @param query
-     * @param filters
-     * @param indice
-     * @param f
-     * @param useProspr
-     */
-    static fetchHistory: ({ app, api, hpp, page, query, filters, indice, f, useProspr }: IQueryProps) => Promise<SearchResponse<IIndexedBankUsed> | undefined>;
-    /**
-     * Save the changes to a promise to purchase
-     * @param partial the partial containing the changes
-     * @param saveToDatabase whether or not the changes should be persisted
-     * @param options.noEvent whether to trigger onWritePromise or not
-     */
-    save: (partial?: Partial<IPromiseToPurchase>, saveToDatabase?: boolean, noEvent?: boolean) => Promise<boolean | string>;
-    /**
-     * Returns a bank object.
-     * @param bankTypeId
-     */
-    getBank(bankTypeId: string): IBank | undefined;
-    /**
-     * Adjust the amount remaining in a bank and adds an entry in the bank adjustments history.
-     * @param adjustment the adjustment entry
-     * @param bankTypeId the bank type id to be updated
-     * @param bankNowEmpty Optionnal. If set, will set bank as inactive
-     */
-    adjustAmountLeftInPromise: (adjustment: Omit<IBankAdjustment, 'issued_by'>, bankTypeId: string, bankNowEmpty?: boolean) => Promise<boolean>;
-    /**
-     * Returns all the rules for a bank.
-     */
-    getRulesForAllBanks: () => Promise<{
-        type_id: string;
-        version: number;
-        rules: IBankRule[];
-    }[] | undefined>;
-    /**
-     * Retrieves the default settings to build an empty promise to purchase so that it can be edited.
-     */
-    constructDefaultPromiseToPurchase: (space: Space, customer_id?: string) => Promise<void>;
-    /**
-     * Retrieves and returns all the carts using a this promise to purchase.
-     * @param options the query options.
-     */
-    getAssociatedCarts: (options?: IQueryOptions) => Promise<Cart[]>;
-    /**
-     * Returns calculated remaining amounts for each bank
-     * @param actualCart the cart that we are trying to pay
-     * @param applicableBanks the banks that could be applied for user on cart
-     * @param applicableBanksHistory list of history entries for applicable banks
-     * @param space the Space obj
-     * @returns an array of banks used
-     */
-    static calculateRemainingAmounts: (actualCart: Cart, applicableBanks: IApplicablePromiseBank[], applicableBanksHistory: IIndexedBankUsed[], space: Space) => Promise<IBankUsed[]>;
-    /**
-     * Function isValid
-     * @description checks if a promise to purchase can be used based on the presence of a custom price list and the validity of the ending and starting date
-     * @param customPriceList the custom price list
-     * @param checkDate the date to use for checking validity
-     * @returns true if valid, false if not
-     */
-    isValid: (customPriceList: string | ICustomPriceItem[] | undefined, checkDate?: Date) => boolean;
-    static getDefaultPromiseToPurchase: (customerId: string) => IPromiseToPurchase;
-    /**
-     * Disables empty banks for a specific customer's promise to purchase.
-     * If the disabled banks were the last active banks of the PA, disable the PA
-     * @async
-     * @param {{ [bankId: string]: number; }} bankIDsWithRemainingAmounts - The bank IDs to disable.
-     */
-    disableEmptyPABanks: (bankIDsWithRemainingAmounts: {
-        [bankId: string]: number;
-    }) => Promise<void>;
-    /**
-     * Function deactivate
-     * @description deactivates the promise
-     * @param save save to database?
-     */
-    deactivate: (save?: boolean) => Promise<void>;
-    /**
-     * Function activate
-     * @description activates the promise from a given date
-     * @param newDate the date of starting validity
-     * @param save save to database?
-     */
-    activate: (newDate?: Date, save?: boolean) => Promise<void>;
-    archive: (save?: boolean) => Promise<void>;
-}
+import { ICustomPriceItem } from '../../Interfaces/G2';
+import Cart from '../../lib/Cart';
+import IPromiseToPurchase, { IBank, IBankAdjustment } from '../../Interfaces/PromiseToPurchase';
+import { IBankRule } from '../../Interfaces/PromiseToPurchase/BankType';
+import Space from '../Space';
+import { IApplicablePromiseBank, IBankUsed } from '../../Interfaces/Cart';
+import IQueryOptions from '../../Interfaces/Query/IProductQueryOptions';
+import { IQueryProps } from '../../Interfaces/Product';
+import { SearchResponse } from '@algolia/client-search';
+import IIndexedCustomerPromiseToPurchase from '../../Interfaces/PromiseToPurchase/IIndexedCustomerPromiseToPurchase';
+import IIndexedBankUsed from '../../Interfaces/PromiseToPurchase/IIndexedBankUsed';
+import { BaseServiceClass } from '../baseService';
+export default class PromiseToPurchase extends BaseServiceClass<IPromiseToPurchase> {
+    data: () => IPromiseToPurchase;
+    /**
+     * @deprecated a promise to purchase cannot be deleted.
+     */
+    delete: () => Promise<boolean>;
+    static fetch: ({ app, api, hpp, page, query, filters, indice, f, space, useProspr }: IQueryProps) => Promise<SearchResponse<IIndexedCustomerPromiseToPurchase>>;
+    /**
+     *
+     * @param space
+     * @param hpp
+     * @param page
+     * @param query
+     * @param filters
+     * @param indice
+     * @param f
+     * @param useProspr
+     */
+    static fetchHistory: ({ app, api, hpp, page, query, filters, indice, f, useProspr }: IQueryProps) => Promise<SearchResponse<IIndexedBankUsed> | undefined>;
+    /**
+     * Save the changes to a promise to purchase
+     * @param partial the partial containing the changes
+     * @param saveToDatabase whether or not the changes should be persisted
+     * @param options.noEvent whether to trigger onWritePromise or not
+     */
+    save: (partial?: Partial<IPromiseToPurchase>, saveToDatabase?: boolean, noEvent?: boolean) => Promise<boolean | string>;
+    /**
+     * Returns a bank object.
+     * @param bankTypeId
+     */
+    getBank(bankTypeId: string): IBank | undefined;
+    /**
+     * Adjust the amount remaining in a bank and adds an entry in the bank adjustments history.
+     * @param adjustment the adjustment entry
+     * @param bankTypeId the bank type id to be updated
+     * @param bankNowEmpty Optionnal. If set, will set bank as inactive
+     */
+    adjustAmountLeftInPromise: (adjustment: Omit<IBankAdjustment, 'issued_by'>, bankTypeId: string, bankNowEmpty?: boolean) => Promise<boolean>;
+    /**
+     * Returns all the rules for a bank.
+     */
+    getRulesForAllBanks: () => Promise<{
+        type_id: string;
+        version: number;
+        rules: IBankRule[];
+    }[] | undefined>;
+    /**
+     * Retrieves the default settings to build an empty promise to purchase so that it can be edited.
+     */
+    constructDefaultPromiseToPurchase: (space: Space, customer_id?: string) => Promise<void>;
+    /**
+     * Retrieves and returns all the carts using a this promise to purchase.
+     * @param options the query options.
+     */
+    getAssociatedCarts: (options?: IQueryOptions) => Promise<Cart[]>;
+    /**
+     * Returns calculated remaining amounts for each bank
+     * @param actualCart the cart that we are trying to pay
+     * @param applicableBanks the banks that could be applied for user on cart
+     * @param applicableBanksHistory list of history entries for applicable banks
+     * @param space the Space obj
+     * @returns an array of banks used
+     */
+    static calculateRemainingAmounts: (actualCart: Cart, applicableBanks: IApplicablePromiseBank[], applicableBanksHistory: IIndexedBankUsed[], space: Space) => Promise<IBankUsed[]>;
+    /**
+     * Function isValid
+     * @description checks if a promise to purchase can be used based on the presence of a custom price list and the validity of the ending and starting date
+     * @param customPriceList the custom price list
+     * @param checkDate the date to use for checking validity
+     * @returns true if valid, false if not
+     */
+    isValid: (customPriceList: string | ICustomPriceItem[] | undefined, checkDate?: Date) => boolean;
+    static getDefaultPromiseToPurchase: (customerId: string) => IPromiseToPurchase;
+    /**
+     * Disables empty banks for a specific customer's promise to purchase.
+     * If the disabled banks were the last active banks of the PA, disable the PA
+     * @async
+     * @param {{ [bankId: string]: number; }} bankIDsWithRemainingAmounts - The bank IDs to disable.
+     */
+    disableEmptyPABanks: (bankIDsWithRemainingAmounts: {
+        [bankId: string]: number;
+    }) => Promise<void>;
+    /**
+     * Function deactivate
+     * @description deactivates the promise
+     * @param save save to database?
+     */
+    deactivate: (save?: boolean) => Promise<void>;
+    /**
+     * Function activate
+     * @description activates the promise from a given date
+     * @param newDate the date of starting validity
+     * @param save save to database?
+     */
+    activate: (newDate?: Date, save?: boolean) => Promise<void>;
+    archive: (save?: boolean) => Promise<void>;
+}