addio-admin-sdk 1.7.102 → 1.7.104

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

@@ -64,6 +64,10 @@ import { MenuPositionEnum } from '../../Interfaces/Menu';
 import Menu from '../../lib/Menu';
 import Note from '../Note';
 import { NoteTypeEnum } from '../../Interfaces/Note';
+/**
+ * Class Space
+ * A Space represent a company.
+ */
 export default class Space {
     private _space_ref;
     private _user;
@@ -74,7 +78,14 @@ export default class Space {
     static getCurrentSpace: (childCollection: string, refUser: string) => Promise<Space>;
     static getCurrentSpaceWithRef: (childCollection: string, refUser: string) => Promise<Space>;
     initCurrencies: () => Promise<any>;
+    /**
+     * Create the actual space
+     */
     create: () => Promise<IDatabaseRef>;
+    /**
+     * Update current space with a partial space pass as parameters.
+     * @param updates Updates to be made on the space - Partial<Space>
+     */
     update: (updates: Partial<ISpace>) => Promise<boolean>;
     getDefaultTax: () => string | undefined;
     getCurrencies: () => ICurrencies | undefined;
@@ -132,11 +143,23 @@ export default class Space {
         details?: undefined;
     }>;
     private _fetchServices;
+    /**
+     * Fetch the external service for the name provided
+     * @param serviceName
+     * @param returnInactiveService Optionnal, defaults to false. Must be set if service should be returned even if it is inactive
+     */
     private _getSpecificServiceByName;
     private _getAllServicesByType;
     private _getServiceBySlug;
     private _setExternalServiceValues;
+    /**
+     * Check if external_value fields should be shown for space
+     */
     private _showExternalValueFieldsForSpace;
+    /**
+     * Get array of field data nesessary to show space's external_values per objet type
+     * @param objType The object type to check for external_values
+     */
     private _getExternalFieldsToShowForPageType;
     private _getAllTaxes;
     private _getTaxes;
@@ -157,10 +180,28 @@ export default class Space {
     _deleteCataloguesById: (ids: string[]) => Promise<boolean>;
     private _categoriesListener;
     private _getCategories;
+    /**
+     * Get full category tree
+     * @deprecated use new _getTreeNew function instead
+     * @param categories
+     * @param level
+     * @param parent
+     */
     private _getTree;
+    /**
+     * Get array of ordered categories
+     * @param categories
+     * @param parentID
+     */
     private _getTreeNew;
     private _getCategoryUrl;
     private _resetInventories;
+    /**
+     * Private function to save a bulk of document to a collection
+     * @param obj an array of documents
+     * @param collection the collection name where to save
+     * @returns the amount of save vs errors
+     */
     private _batchSaveCollection;
     private _batchSaveCategories;
     private _batchSaveBrands;
@@ -187,7 +228,17 @@ export default class Space {
     }) => Promise<void>;
     private _getExternalProductBySlug;
     private _getExternalProductsSlugToTry;
+    /**
+     * Fetch all options with - optionnal - query
+     * @param options Query options - optionnal
+     */
     private _getProducts;
+    /**
+     * Obtenir une partie des produits à partir de l'indentifiant fournis
+     * @param from le id du dernier document ou continuer ou undefine si on veut le premier
+     * @param limit la taille max à lire, idéalement 500 ou moins
+     * @returns la liste de produits récupéré
+     */
     private _getProductsPage;
     private _getAllProducts;
     fetchSizeBasedOnCategoryAndAttribute: (category: string, attribute?: string) => IPredefinedBox | IPredefinedBox[] | undefined;
@@ -209,8 +260,21 @@ export default class Space {
     private _getAllIndexedProducts;
     private _saveAllIndexedCategories;
     private _fetchIndexedVariations;
+    /**
+     * Finds indexed declination corresponding to parent slug and sku provided
+     * @param space
+     * @param parentSlug - The parent product slug (to search space indexed products)
+     * @param sku - The specific sku for the declination
+     * @param customPriceList - Optionnal. If provided, indexed decli is returned with adjusted prices from price list
+     */
     private _fetchIndexedDecliBySlugAndSku;
     private _getAllInventoryItems;
+    /**
+     * Obtenir une partie des inventaires à partir de l'indentifiant fournis
+     * @param from le id du dernier document ou continuer ou undefine si on veut le premier
+     * @param limit la taille max à lire, idéalement 500 ou moins
+     * @returns la liste de l'inventaires récupéré
+     */
     private _getInventoryPage;
     private _getAllInventoryItemsByPages;
     private _getInventoryItemsSnapshot;
@@ -256,6 +320,12 @@ export default class Space {
     private _invoicesListener;
     private _getUnknownCartItem;
     private _importInvoices;
+    /**
+     * Generate the next unique ID for a customers new promise to purchase. Recursive function : always checks if ID exists in database before returning ID.
+     * @param customerId - The customer for whom we're creating a new promise
+     * @param useNextSeason - If we should check the values for next season instead of current one
+     * @param idToIncrement - Optionnal. Only set when calling the function recursively.
+     */
     private _generateNewPromiseId;
     private _getNextInvoiceRef;
     private _incrementGeneralInvoiceRef;
@@ -295,15 +365,47 @@ export default class Space {
     private _batchCustomerAlertCreate;
     private _batchCustomersCreate;
     private _fetchIndexedCustomers;
+    /**
+     * Fetches and returns all promises to purchase associated with a customer ID.
+     * @param customerID - The customer ID to check
+     * @param onlyActive - Optionnal. If true, function only returns currently active promises
+     */
     private _getCustomerPromisesToPurchase;
+    /**
+     * For all possible bank types for space, checks all active promises for customer and returns an object containing currently active bank applicable.
+     * @param customerID - The customer ID to check
+     * @param promisesToCheck - Optionnal. If defined, uses provided array of promises instead of calling DB.
+     */
     private _getPossibleActiveBanksForCustomer;
     private _updateCustomerLastActivity;
+    /**
+     * Function that adjusts store and / or web inventories for a cart depending on it's state
+     * @param items an array of ICartItem objects through which we will loop to adjust their inventories
+     * @param cartState the state of the cart for which we are adjusting the inventory, this affects what inventory actions will be made
+     * @param cartType type of the cart
+     * @param options.currentStoreId the store at which we are doing the inventory manipulation
+     * @param options.onlyWeb if the inventory should only be adjusted for WEB or also for the current store
+     * @param options.fromStoreId the store at which the inventories were initially modified, it is only used in the context of a refund, where we might return items to a different store than where they were taken.
+     * @param options.associatedTransferForCart Optionnal. Array of TransferRequest objects associated to order (used in 'cancelled' cart state)
+     * @param options.previousItems Optionnal. Array of ICartItem corresponding to prevState in cart
+     * @param options.inventoryItemsDataToUse Optionnal. Array of inventoryItem data to use instead of calling Db twice.
+     * @param options.shouldCheckReservedQte Optionnal. If reserved quantities should be check for inventory or not
+     */
     private _ajustInventoryWithCart;
     private _checkIfSpaceHasMinInventoryOption;
     private _addTag;
     private _getAllTags;
     private _deleteAllTags;
+    /**
+     * Fetches user from database by unique ID.
+     * @param uid - The users unique ID (same as the email)
+     */
     private _getUser;
+    /**
+     * Fetches user from database by external ID
+     * @param externalID - The user's external ID
+     * @param userEmail - The user's email
+     */
     private _getUserByExternalID;
     private _disableUser;
     private _enableUser;
@@ -357,9 +459,20 @@ export default class Space {
     private _addBankType;
     private _updateBankType;
     private _getPromiseBankRules;
+    /**
+     * Synchronizes the customers with the list of promise to purchase.
+     * @param associations - Record dont la clé est l'id d'un customer et la valeur est un record de promesses d'achats avec leur id et leurs infos
+     */
     private _syncCustomerPromiseToPurchaseAssoc;
+    /**
+     * Retrieves and returns only the customers who have a PA.
+     */
     private _getAllWithActivePromises;
     private _getBanksUsedHistoryForCustomer;
+    /**
+     * Checks for currently active banks, and returns their available amount, as well as the ones for all previous PAs with same bank type.
+     * @param customerID
+     */
     private _getAvailableBankAmountsByBankType;
     private _getPromisesToPurchase;
     private _getPromiseToPurchaseEmails;
@@ -370,10 +483,26 @@ export default class Space {
     private _openSeasonPromisesToPurchase;
     private _endSeasonPromisesToPurchase;
     private _getEscompteItems;
+    /**
+     * Retrieves and returns all the carts containing a specific promise ID.
+     * @param promiseID - The ID to check
+     * @param options - Optionnal. Additionnal query options
+     */
     private _getPromiseAssociatedCarts;
     private _getBanksUsedHistory;
     private _getAvailableBankAmountForApplicableBanks;
+    /**
+     * Returns all available amounts for banks found in specific promise.
+     * @param promiseID The ID of the promise to check
+     * @param promiseObj Optionnal. If provided, saves a call to the DB.
+     */
     private _getAvailableBankAmountsForPromise;
+    /**
+     * Returns remaining amount and other info for a specific bank of a specific PA.
+     * @param promiseID - The promise to purchase ID
+     * @param bankID - The bank type ID
+     * @param promiseObj - Optionnal. If provided, removes one fetch from database
+     */
     private _getSpecificAvailableBankAmount;
     private _getJobs;
     private _jobsListener;
@@ -419,13 +548,53 @@ export default class Space {
     private _getFirstOrders;
     private _getAllDocuments;
     private _saveDocument;
+    /**
+     * Apply a credit change, the value is negative for a purchasse
+     * @param customerId The id of the customer
+     * @param creditSlug The credit *slug name as configured in the space
+     * @param amount The amount to add or remove
+     * @param comment The reason for this change
+     * @param user The user doing the action
+     * @returns
+     */
     private _modifyStoreCredit;
+    /**
+     * Get the latess credit amount for a customer
+     * @param customerId The customer ID
+     * @param creditSlug The slug of the credit to get
+     * @returns The amount
+     */
     private _getStoreCredit;
+    /**
+     * Get the full history of credit for a customer
+     * @param customerId The customer ID
+     * @param creditSlug The slug of the credit to get
+     * @returns A list of IStoreCreditHistory
+     */
     private _getStoreCreditHistory;
+    /**
+     * Validate if an amount can be deducted from the credit of a customer
+     * @param customerId The customer ID
+     * @param creditSlug The credit slug to verify
+     * @param amount The amount to deduct
+     * @returns True if the amount is less or equal to the customer credit
+     */
     private _validateCredit;
+    /**
+     * Get the space available credits
+     */
     private _getSpaceCredits;
+    /**
+     * Retourne tous les menus du space
+     */
     private _getMenus;
+    /**
+     * Retourne le menu actif pour un slug
+     */
     private _getActiveMenuBySlug;
+    /**
+     * Retourne tous les menus actifs
+     */
     private _getAllActiveMenus;
     attributes: {
         get: (options?: IQueryOptions) => Promise<Attribute[]>;
@@ -870,8 +1039,17 @@ export default class Space {
         getActiveBySlug: (slug: MenuPositionEnum) => Promise<Menu | undefined>;
         getAllActive: () => Promise<Menu[]>;
     };
+    /**
+     * Get all space properties
+     */
     data: () => ISpace;
+    /**
+     * Get the space name
+     */
     getName: () => string;
+    /**
+     * Get the space ID
+     */
     getId: () => string;
     isMultiPromo: () => boolean;
     private _getNotes;