addio-admin-sdk 1.7.85 → 1.7.87

package/addio-sdk-doc.md

@@ -1,1473 +1,1473 @@
-## Classes
-
-<dl>
-<dt><a href="#Brand">Brand</a></dt>
-<dd><p>Brand class</p></dd>
-<dt><a href="#Catalogue">Catalogue</a></dt>
-<dd><p>Catalogue class</p></dd>
-<dt><a href="#Customer">Customer</a></dt>
-<dd><p>Customer class</p></dd>
-<dt><a href="#Discount">Discount</a></dt>
-<dd><p>Brand class</p></dd>
-<dt><del><a href="#Invoice">Invoice</a></del></dt>
-<dd></dd>
-<dt><del><a href="#Order">Order</a></del></dt>
-<dd></dd>
-<dt><a href="#Org">Org</a></dt>
-<dd><p>Class Org - Organization
-Represent an organization created by a user. An organization can have multiple space.</p></dd>
-<dt><a href="#Product">Product</a></dt>
-<dd><p>Product class</p></dd>
-<dt><a href="#PurchaseOrder">PurchaseOrder</a></dt>
-<dd><p>Brand class</p></dd>
-<dt><a href="#Service">Service</a></dt>
-<dd><p>Service class</p></dd>
-<dt><a href="#Space">Space</a></dt>
-<dd><p>Class Space
-A Space represent a company.</p></dd>
-<dt><a href="#User">User</a></dt>
-<dd><p>User class</p></dd>
-<dt><a href="#ProsprSearch">ProsprSearch</a></dt>
-<dd><p>À NOTER - Prospr est l'ancien nom du ecomm, est depuis devenu Addio.
-Il faudra éventuellement faire le refactoring nécessaire pour remplacer toutes les appelations,
-mais en attendant, c'est normal qu'il y ait les deux noms à différents endroits.</p></dd>
-</dl>
-
-## Members
-
-<dl>
-<dt><a href="#CustomerTypeEnum">CustomerTypeEnum</a></dt>
-<dd><p>ICustomer interface</p>
-<p>Représente un client (customer). Un client peut:</p>
-<ul>
-<li>Faire des recherches parmis les différents items du commerçant</li>
-<li>Afficher une fiche cliente</li>
-</ul></dd>
-<dt><a href="#getDefaultDiscountRule">getDefaultDiscountRule</a></dt>
-<dd><p>Exemple:</p>
-<p>Product = 5.00$</p>
-<p>Discount rule:
-quantity &gt;= 10 ? remove 2</p>
-<p>Result:
-If applied to cart:
-11 Product = (before) 55.00$ (after) 53.00$</p>
-<p>attribute color == red ? percent 10
-1 red Product = (before) 5.00$ (after) 4.50$</p>
-<p>attribute color == red ? percent -20
-1 red Product = (before) 5.00$ (after) 6.00$</p></dd>
-<dt><a href="#installationProductsSlugs">installationProductsSlugs</a></dt>
-<dd><p>Contains all necessary elements for extra questions if adding grass product to cart</p></dd>
-<dt><a href="#getConcreteCartInfo">getConcreteCartInfo</a></dt>
-<dd><ul>
-<li>Create the essential info needed when checking a grass type product for cart</li>
-</ul></dd>
-<dt><a href="#getMinDateOffset">getMinDateOffset</a></dt>
-<dd><p>compares date with blockedDates from DB and blocked days (currently hardcoded in function)</p></dd>
-<dt><a href="#shouldDisableDate">shouldDisableDate</a></dt>
-<dd><p>checks if type of cart corresponds to a blockedDates array and if array has dates defined</p></dd>
-<dt><a href="#installationFeePalletTier">installationFeePalletTier</a></dt>
-<dd><p>Calculates fees that should be applied to provided cart, and fetches them from database or fee array if provided.
-Returns the items to add, update and delete, as well as other cart info to set after fees.
-** Optimized version possible, where address zones and distance are calculated before and properties are sent directly to function
-** Optimized version reverted, logic found in commit here : [#2087b32](https://github.com/ciaoqc/gng-tb-admin-sdk/commit/2087b3207df9e5916a979b8bb255abc2a4c1dac6)</p></dd>
-<dt><a href="#applyFeesToCart">applyFeesToCart</a></dt>
-<dd><p>Checks if sample shipping fee should be removed from cart depending on cart items found in cart.
-** Optimized version possible using brand name instead of brand id, removing async check.
-** Optimized version reverted, logic found in commit here : [#2087b32](https://github.com/ciaoqc/gng-tb-admin-sdk/commit/2087b3207df9e5916a979b8bb255abc2a4c1dac6)</p></dd>
-<dt><a href="#calculateShippingForVrac">calculateShippingForVrac</a> ⇒</dt>
-<dd><p>checks if cart expired using the updated_at date stored in the shipping_payload</p></dd>
-<dt><a href="#transformG2CustomerToCustomer">transformG2CustomerToCustomer</a></dt>
-<dd><p>Verifies if customer exists in G2.</p></dd>
-<dt><a href="#checkIfCustomerExistsInG2">checkIfCustomerExistsInG2</a></dt>
-<dd><p>Updates customer in database with new info found in G2.</p></dd>
-<dt><a href="#getCustomPriceList">getCustomPriceList</a></dt>
-<dd><p>Get promise to purchase additionnal escompte equivalent from customPriceList for specific cart item</p></dd>
-<dt><a href="#getFittingUnits">getFittingUnits</a> ⇒</dt>
-<dd><p>Returns string corresponding to provided cart's type.</p></dd>
-<dt><a href="#getProductSellUnitLabel">getProductSellUnitLabel</a> ⇒ <code>string</code></dt>
-<dd><p>Returns the plural unit label for a specific slug</p></dd>
-<dt><a href="#getDescriptionString">getDescriptionString</a></dt>
-<dd><p>Returns rounded product quantities depending on current value, value of secondary input if existant and sale unit per command step ratio found in product.</p></dd>
-<dt><a href="#splitOnDashes">splitOnDashes</a> ⇒ <code>Array.&lt;string&gt;</code></dt>
-<dd><p>Get product name as array. Array created mostly by splitting name on dash symbol (and variations).</p></dd>
-<dt><a href="#getProdName">getProdName</a></dt>
-<dd><p>Function getParentProductCategoryGroup</p></dd>
-<dt><a href="#getParentProductCategoryGroup">getParentProductCategoryGroup</a></dt>
-<dd><p>Function getProductFormOptions - Returns all AttributeValues for product to construct options in add to cart form</p></dd>
-<dt><a href="#getProductFormOptions">getProductFormOptions</a> ⇒</dt>
-<dd><p>Checks if product is of type by checking TYPE attribute value. Works with indexed product or cart item.</p></dd>
-<dt><a href="#checkIfProductIsInstallation">checkIfProductIsInstallation</a></dt>
-<dd><p>Returns array of installation items found in provided array</p></dd>
-<dt><a href="#getAllInstallFromItems">getAllInstallFromItems</a></dt>
-<dd><ul>
-<li>Returns items with only one apparent grass product (used for detail customers).
-** FOR DISPLAY PURPOSES ONLY - Always save grass products separatly in ICart **</li>
-</ul></dd>
-<dt><a href="#getGrassSubQuestionsByType">getGrassSubQuestionsByType</a> ⇒</dt>
-<dd><p>For grass products. Over 1480pi2, if installation, quantities are rounded to rolls (10pi2) if pickup, and to half pal. if shipping</p></dd>
-<dt><a href="#handleGrassProductQtyRoundForShipping">handleGrassProductQtyRoundForShipping</a></dt>
-<dd><p>Returns rounded grass quantity depending on current qty, if customer selected installation and pallet unit (if defined)</p></dd>
-<dt><a href="#getConcreteQteText">getConcreteQteText</a></dt>
-<dd><p>returns all items in cart where attribute AVAILABILITY contains wanted type.</p></dd>
-<dt><a href="#getConcreteItemsByAvailability">getConcreteItemsByAvailability</a> ⇒</dt>
-<dd><p>Function getVracType - constructs vrac helper object is cart contains vrac or vrac associated items.</p></dd>
-<dt><a href="#fetchFeesBeforeCart">fetchFeesBeforeCart</a></dt>
-<dd><p>Check if pro custom promo info should be shown for customer for a specific product.</p></dd>
-<dt><a href="#calculateUpsellQte">calculateUpsellQte</a></dt>
-<dd><ul>
-<li>checks all upsells in product and returns those where associated quantities are found.</li>
-</ul></dd>
-<dt><a href="#getUpsellsToQuantify">getUpsellsToQuantify</a></dt>
-<dd><ul>
-<li>Returns upsell equivalence text</li>
-</ul></dd>
-<dt><a href="#getGeneralUpsellQteText">getGeneralUpsellQteText</a></dt>
-<dd><ul>
-<li>Returns quantity stinrg and upsell name to show in Upsell Quantity indicator</li>
-</ul></dd>
-<dt><a href="#checkIfCartContainsException">checkIfCartContainsException</a></dt>
-<dd><p>Function getCartItemsFromProdUpsells</p></dd>
-<dt><a href="#mockCustomPriceList">mockCustomPriceList</a></dt>
-<dd><p>Takes in a function and checks for error</p></dd>
-<dt><a href="#getRandomValue">getRandomValue</a> ⇒</dt>
-<dd><p>Get an object property value</p></dd>
-<dt><a href="#getObjectProperty">getObjectProperty</a> ⇒</dt>
-<dd><p>Set an object property to an anonymized value if it exists</p></dd>
-<dt><a href="#setObjectProperty">setObjectProperty</a> ⇒</dt>
-<dd><p>Anonymise the customer data if in test env</p></dd>
-<dt><a href="#getCurrentProvince">getCurrentProvince</a> ⇒</dt>
-<dd><p>Constructs and returns data for indexed cart (algolia or addio)</p></dd>
-<dt><a href="#getCartPromo">getCartPromo</a></dt>
-<dd><p>Check if current cart promos applied contain a promo_code type promotion</p></dd>
-<dt><a href="#shouldCheckPromoCode">shouldCheckPromoCode</a></dt>
-<dd><p>Check if a discount rule applies to a specific declination</p></dd>
-<dt><a href="#shouldApplyRuleToDeclination">shouldApplyRuleToDeclination</a></dt>
-<dd><p>Check if a specific rule of a discount rule is respected</p></dd>
-<dt><a href="#getResultRuleDetail">getResultRuleDetail</a></dt>
-<dd><p>Check if rule applied to product attributes is respected for specific declination attributes</p></dd>
-<dt><a href="#getCartPromoType">getCartPromoType</a></dt>
-<dd><p>Check if promo code can be applied to a specific cart</p></dd>
-<dt><a href="#checkPromoCodeEligibility">checkPromoCodeEligibility</a></dt>
-<dd><p>Returns tier pricing step that should be applied for provided quantity, or undefined if none should apply</p></dd>
-<dt><a href="#getTierPricingToApply">getTierPricingToApply</a></dt>
-<dd><p>Converts tier-pricing found in discount_rule to IIndexedTierPricing.</p></dd>
-<dt><a href="#applyTierPricing">applyTierPricing</a></dt>
-<dd><p>Calculate new discount_price object for cart item base on qte and tier_pricing</p></dd>
-<dt><a href="#getNewDiscountPriceFromTierPricing">getNewDiscountPriceFromTierPricing</a></dt>
-<dd><p>Get discounted price after applying discount rules to a provided price</p></dd>
-<dt><a href="#applyDiscountRulesOnProduct">applyDiscountRulesOnProduct</a></dt>
-<dd><p>Get result of discount rule discount on a provided amount</p></dd>
-<dt><a href="#applyDiscountToPrice">applyDiscountToPrice</a> ⇒</dt>
-<dd><p>Get sku(s) affected by a promo as an array of strings</p></dd>
-<dt><a href="#getSkuArrayForPromo">getSkuArrayForPromo</a> ⇒</dt>
-<dd><p>Returns a list of all skus where promo applied to specific products should apply. Check for both amount/percent_sku and amount/percent_category options.</p></dd>
-<dt><a href="#getResultAppliedDiscountSkus">getResultAppliedDiscountSkus</a> ⇒</dt>
-<dd><p>Creates array of all category level slugs for a cart item.</p></dd>
-<dt><a href="#getItemCategorySlugArray">getItemCategorySlugArray</a></dt>
-<dd><p>Apply all valid discounts found in a specific cart's discount_rules props to cart</p></dd>
-<dt><a href="#applyDiscountToCart">applyDiscountToCart</a></dt>
-<dd><p>Get the ICartPromoApplied object for a specified discount_rule. Only works for promos that do not apply to products of certain categories/skus.</p></dd>
-<dt><a href="#getStandardCartPromoFromDiscount">getStandardCartPromoFromDiscount</a> ⇒</dt>
-<dd><p>Calculates the cumulative subtotal for all service/fee type items in cart, including any applied promos. Usefull when calculating a promo's amount when all fees and services should be excluded.</p></dd>
-<dt><a href="#checkIfCouldApplyIncentivePromo">checkIfCouldApplyIncentivePromo</a></dt>
-<dd><p>Calculates amount to be removed for payment incentive type promos.</p></dd>
-<dt><a href="#getAfterTaxesPromosTotalAmount">getAfterTaxesPromosTotalAmount</a></dt>
-<dd><p>Returns cart_promos_applied corresponding to payment incentive, if found. Can also check in discount_rules if props provided</p></dd>
-<dt><a href="#getAfterTaxesPromoInCart">getAfterTaxesPromoInCart</a></dt>
-<dd><p>Returns the information regarding the payment incentive promo if found in cart's discount_rules</p></dd>
-<dt><a href="#unitShortDict">unitShortDict</a> ⇒ <code>ILang</code></dt>
-<dd><p>Returns the dictionnary containing the shortened version of unit labels in multiple languages</p></dd>
-<dt><a href="#getConvertedUnitQuantity">getConvertedUnitQuantity</a></dt>
-<dd><p>Constructs object with detailled inventory quantities by unit (based on other_units for product)</p></dd>
-<dt><a href="#getQty">getQty</a></dt>
-<dd><p>Calculates inventory unit quantity for function getQty</p></dd>
-<dt><a href="#recursiveCheckObject">recursiveCheckObject</a> ⇒</dt>
-<dd><p>Updates value of object by checking recursivly.</p></dd>
-<dt><a href="#getOrderedPromises">getOrderedPromises</a> ⇒</dt>
-<dd><p>Checks list of promises for applicable banks based on space bank types.</p></dd>
-<dt><a href="#checkForApplicableBanks">checkForApplicableBanks</a></dt>
-<dd><p>Returns if a promise is currently active. Promise is active if it is not archived, and if current date is same or after starting_date, and before ending_date (if defined).</p></dd>
-<dt><a href="#checkIfOtherBankOfSameTypeIsActive">checkIfOtherBankOfSameTypeIsActive</a></dt>
-<dd><p>Returns translated name for a provided bank type ID.</p></dd>
-<dt><a href="#getBankTypeName">getBankTypeName</a></dt>
-<dd><p>Calculates the remaining amount for a specific promise's bank</p></dd>
-<dt><a href="#getIndexedByCustomerPromiseValues">getIndexedByCustomerPromiseValues</a> ⇒</dt>
-<dd><p>Returns the most recently emptied bank of a given type</p></dd>
-<dt><a href="#getIndexServices">getIndexServices</a></dt>
-<dd><p>Save new entry objects to provided search index services</p></dd>
-<dt><a href="#saveNewEntryToIndex">saveNewEntryToIndex</a></dt>
-<dd><p>Save a partial object entry to provided search index services.</p></dd>
-<dt><a href="#partialSaveNewEntryToIndex">partialSaveNewEntryToIndex</a></dt>
-<dd><p>Returns an object with base info needed to call Algolia/AddioSearch with search query.</p></dd>
-<dt><a href="#getFetchInfoAlgoliaAddioSearch">getFetchInfoAlgoliaAddioSearch</a></dt>
-<dd><p>Fetch entries from either algolia or AddioSearch (prospr) for a provided index. Client-side only!</p></dd>
-<dt><a href="#fetchEntriesAlgoliaAddioSearch">fetchEntriesAlgoliaAddioSearch</a></dt>
-<dd><p>Returns search result from active search index service. Server-side friendly!</p></dd>
-</dl>
-
-## Constants
-
-<dl>
-<dt><a href="#isTestEnv">isTestEnv</a></dt>
-<dd><p>TBSDK - SDK Manager</p>
-<p>Client SDK to access TheBEAST eCommerce</p></dd>
-<dt><a href="#spaceInitData">spaceInitData</a></dt>
-<dd><p>Use this object to change which space is being tested!</p></dd>
-</dl>
-
-## Functions
-
-<dl>
-<dt><a href="#getMinDatePicker">getMinDatePicker()</a></dt>
-<dd><p>Sets the minimum shipping day for delivery</p></dd>
-<dt><a href="#getProductSellUnitLabel">getProductSellUnitLabel(otherUnits, locale, returnUnitForSlugs)</a> ⇒ <code>string</code></dt>
-<dd><p>Returns sell unit label in correct language for a specific product's other_units</p></dd>
-<dt><a href="#splitOnDashes">splitOnDashes(stringToSplit)</a> ⇒ <code>Array.&lt;string&gt;</code></dt>
-<dd></dd>
-<dt><a href="#getRandomValue">getRandomValue(val, type)</a> ⇒</dt>
-<dd><p>Replace a value with anonymized value</p></dd>
-<dt><a href="#getCartPromo">getCartPromo(cartData)</a></dt>
-<dd><p>Get formatted array of cart promos applied to a specific cart</p></dd>
-<dt><a href="#_checkRuleApplicationArray">_checkRuleApplicationArray(checkedRulesApplicationArray)</a> ⇒</dt>
-<dd><p>Checks if discount rule should be applied to cart based on each rule verification results.</p></dd>
-<dt><a href="#checkIfCouldApplyIncentivePromo">checkIfCouldApplyIncentivePromo(cartData, skipCheckFor)</a> ⇒</dt>
-<dd><p>Checks if an incentive discount could (in theory) by added to provided cart, by checking found incentive discount's rule array.</p></dd>
-<dt><a href="#getOrderedPromises">getOrderedPromises(promises)</a></dt>
-<dd><p>Get ordered array of promise data objects by starting date.</p></dd>
-<dt><a href="#getIndexServices">getIndexServices(space, partialIndexID)</a></dt>
-<dd><p>Returns objet with possible index service instances
-As of now, checks for Algolia and Addio Search</p></dd>
-</dl>
-
-<a name="Brand"></a>
-
-## Brand
-
-<p>Brand class</p>
-
-**Kind**: global class  
-<a name="Catalogue"></a>
-
-## Catalogue
-
-<p>Catalogue class</p>
-
-**Kind**: global class  
-<a name="Customer"></a>
-
-## Customer
-
-<p>Customer class</p>
-
-**Kind**: global class  
-<a name="Discount"></a>
-
-## Discount
-
-<p>Brand class</p>
-
-**Kind**: global class  
-<a name="Invoice"></a>
-
-## ~~Invoice~~
-
-**_Deprecated_**
-
-**Kind**: global class  
-<a name="Order"></a>
-
-## ~~Order~~
-
-**_Deprecated_**
-
-**Kind**: global class  
-<a name="Org"></a>
-
-## Org
-
-<p>Class Org - Organization
-Represent an organization created by a user. An organization can have multiple space.</p>
-
-**Kind**: global class  
-<a name="new_Org_new"></a>
-
-### new Org(org, org_ref, user)
-
-<p>Organization constructor</p>
-
-| Param   | Description                          |
-| ------- | ------------------------------------ |
-| org     | <p>Organization to construct</p>     |
-| org_ref | <p>Reference to the organization</p> |
-| user    | <p>Authfificated user</p>            |
-
-<a name="Product"></a>
-
-## Product
-
-<p>Product class</p>
-
-**Kind**: global class  
-<a name="PurchaseOrder"></a>
-
-## PurchaseOrder
-
-<p>Brand class</p>
-
-**Kind**: global class  
-<a name="Service"></a>
-
-## Service
-
-<p>Service class</p>
-
-**Kind**: global class  
-<a name="Service+add"></a>
-
-### service.add(newService) ⇒
-
-<p>Add a new service</p>
-
-**Kind**: instance method of [<code>Service</code>](#Service)  
-**Returns**: <p>IAddServiceResponse</p>
-
-| Param      | Description                          |
-| ---------- | ------------------------------------ |
-| newService | <p>IService: new service to add.</p> |
-
-<a name="Space"></a>
-
-## Space
-
-<p>Class Space
-A Space represent a company.</p>
-
-**Kind**: global class  
-<a name="User"></a>
-
-## User
-
-<p>User class</p>
-
-**Kind**: global class  
-<a name="new_User_new"></a>
-
-### new User(options, version, orgID)
-
-<p>Fetch user from database for current org</p>
-
-| Param   | Description                                                                                                                                          |
-| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
-| options | <p>Parameters for database query. Only one will be checked at a time, in order of &quot;importance&quot; : email &gt; username &gt; external_id.</p> |
-| version | <p>The app version to check</p>                                                                                                                      |
-| orgID   | <p>Optionnal, but must be provided if function is called from the backend (used to find user's organization).</p>                                    |
-
-<a name="ProsprSearch"></a>
-
-## ProsprSearch
-
-<p>À NOTER - Prospr est l'ancien nom du ecomm, est depuis devenu Addio.
-Il faudra éventuellement faire le refactoring nécessaire pour remplacer toutes les appelations,
-mais en attendant, c'est normal qu'il y ait les deux noms à différents endroits.</p>
-
-**Kind**: global class  
-<a name="CustomerTypeEnum"></a>
-
-## CustomerTypeEnum
-
-<p>ICustomer interface</p>
-<p>Représente un client (customer). Un client peut:</p>
-<ul>
-<li>Faire des recherches parmis les différents items du commerçant</li>
-<li>Afficher une fiche cliente</li>
-</ul>
-
-**Kind**: global variable  
-<a name="getDefaultDiscountRule"></a>
-
-## getDefaultDiscountRule
-
-<p>Exemple:</p>
-<p>Product = 5.00$</p>
-<p>Discount rule:
-quantity &gt;= 10 ? remove 2</p>
-<p>Result:
-If applied to cart:
-11 Product = (before) 55.00$ (after) 53.00$</p>
-<p>attribute color == red ? percent 10
-1 red Product = (before) 5.00$ (after) 4.50$</p>
-<p>attribute color == red ? percent -20
-1 red Product = (before) 5.00$ (after) 6.00$</p>
-
-**Kind**: global variable  
-<a name="installationProductsSlugs"></a>
-
-## installationProductsSlugs
-
-<p>Contains all necessary elements for extra questions if adding grass product to cart</p>
-
-**Kind**: global variable  
-<a name="getConcreteCartInfo"></a>
-
-## getConcreteCartInfo
-
-<ul>
-<li>Create the essential info needed when checking a grass type product for cart</li>
-</ul>
-
-**Kind**: global variable
-
-| Param |
-| ----- |
-| item  |
-
-<a name="getMinDateOffset"></a>
-
-## getMinDateOffset
-
-<p>compares date with blockedDates from DB and blocked days (currently hardcoded in function)</p>
-
-**Kind**: global variable
-
-| Param            | Description                  |
-| ---------------- | ---------------------------- |
-| date             | <p>Date to check</p>         |
-| blockedDates     | <p>Blocked dates from DB</p> |
-| expeditionMethod | <p>pickup or shipping</p>    |
-| cartData         |                              |
-
-<a name="shouldDisableDate"></a>
-
-## shouldDisableDate
-
-<p>checks if type of cart corresponds to a blockedDates array and if array has dates defined</p>
-
-**Kind**: global variable
-
-| Param        |
-| ------------ |
-| cartData     |
-| blockedDates |
-
-<a name="installationFeePalletTier"></a>
-
-## installationFeePalletTier
-
-<p>Calculates fees that should be applied to provided cart, and fetches them from database or fee array if provided.
-Returns the items to add, update and delete, as well as other cart info to set after fees.
-** Optimized version possible, where address zones and distance are calculated before and properties are sent directly to function
-** Optimized version reverted, logic found in commit here : [#2087b32](https://github.com/ciaoqc/gng-tb-admin-sdk/commit/2087b3207df9e5916a979b8bb255abc2a4c1dac6)</p>
-
-**Kind**: global variable
-
-| Param                       |
-| --------------------------- |
-| fetchProduct                |
-| getIfAddressIsInsideZones   |
-| getDistanceFromAddress      |
-| cart                        |
-| expeditionMethod            |
-| grassProduct                |
-| concreteOrder               |
-| cartContainsInstallation    |
-| cartContainsVrac            |
-| isPro                       |
-| addOnePalletToPickup        |
-| cartContainsSample          |
-| saveToShippingPayload       |
-| deliveryAddress             |
-| locale                      |
-| expeditionDate              |
-| equipmentPickupOnSite       |
-| cartContainsOnlyAccessories |
-| pickupStore                 |
-| allStores                   |
-| customPriceList             |
-| useFeeArray                 |
-
-<a name="applyFeesToCart"></a>
-
-## applyFeesToCart
-
-<p>Checks if sample shipping fee should be removed from cart depending on cart items found in cart.
-** Optimized version possible using brand name instead of brand id, removing async check.
-** Optimized version reverted, logic found in commit here : [#2087b32](https://github.com/ciaoqc/gng-tb-admin-sdk/commit/2087b3207df9e5916a979b8bb255abc2a4c1dac6)</p>
-
-**Kind**: global variable
-
-| Param        |
-| ------------ |
-| fetchProduct |
-| cart         |
-| locale       |
-| useFeeArray  |
-
-<a name="calculateShippingForVrac"></a>
-
-## calculateShippingForVrac ⇒
-
-<p>checks if cart expired using the updated_at date stored in the shipping_payload</p>
-
-**Kind**: global variable  
-**Returns**: <p>boolean</p>
-
-| Param         |
-| ------------- |
-| cartData      |
-| grassProduct  |
-| concreteOrder |
-| isPro         |
-| isSample      |
-
-<a name="transformG2CustomerToCustomer"></a>
-
-## transformG2CustomerToCustomer
-
-<p>Verifies if customer exists in G2.</p>
-
-**Kind**: global variable
-
-| Param      | Description                     |
-| ---------- | ------------------------------- |
-| customerID | <p>Customer ID for G2 fetch</p> |
-| space      | <p>Space Object</p>             |
-| org        | <p>Org Object</p>               |
-
-<a name="checkIfCustomerExistsInG2"></a>
-
-## checkIfCustomerExistsInG2
-
-<p>Updates customer in database with new info found in G2.</p>
-
-**Kind**: global variable
-
-| Param          | Description                                                                  |
-| -------------- | ---------------------------------------------------------------------------- |
-| customerID     | <p>Customer ID for G2 fetch</p>                                              |
-| space          | <p>Space Object</p>                                                          |
-| org            | <p>Org Object</p>                                                            |
-| addToDB        | <p>if updated customer should be saved to database (defaults to true)</p>    |
-| skipEmailCheck | <p>if check for unique email should be skiped or not (defaults to false)</p> |
-
-<a name="getCustomPriceList"></a>
-
-## getCustomPriceList
-
-<p>Get promise to purchase additionnal escompte equivalent from customPriceList for specific cart item</p>
-
-**Kind**: global variable
-
-| Param           | Description                                |
-| --------------- | ------------------------------------------ |
-| customPriceList | <p>The pro customers custom price list</p> |
-| item            | <p>The cart item to check</p>              |
-
-<a name="getFittingUnits"></a>
-
-## getFittingUnits ⇒
-
-<p>Returns string corresponding to provided cart's type.</p>
-
-**Kind**: global variable  
-**Returns**: <p>a string containing the order type</p>
-
-| Param    | Description                                                                 |
-| -------- | --------------------------------------------------------------------------- |
-| cartData | <p>Corresponding cart</p>                                                   |
-| frOnly   | <p>If true, forces french string,</p>                                       |
-| slugSafe | <p>If true, will always return a slug-safe string (with string_to_slug)</p> |
-
-<a name="getProductSellUnitLabel"></a>
-
-## getProductSellUnitLabel ⇒ <code>string</code>
-
-<p>Returns the plural unit label for a specific slug</p>
-
-**Kind**: global variable  
-**Returns**: <code>string</code> - <p>The plural unit label</p>
-
-| Param              | Type                                          | Description                                                                                       |
-| ------------------ | --------------------------------------------- | ------------------------------------------------------------------------------------------------- |
-| unitSlug           | <code>string</code>                           | <p>The slug of the unit for which we want to get the label</p>                                    |
-| locale             | <code>string</code> \| <code>undefined</code> | <p>The language in which we want to get the label</p>                                             |
-| returnUnitForSlugs | <code>Array.&lt;string&gt;</code>             | <p>The slugs for which we want to return a default value, in this case the unit slug for unit</p> |
-
-<a name="getDescriptionString"></a>
-
-## getDescriptionString
-
-<p>Returns rounded product quantities depending on current value, value of secondary input if existant and sale unit per command step ratio found in product.</p>
-
-**Kind**: global variable
-
-| Param                  | Type                                                                       | Description                                                                     |
-| ---------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
-| value                  | <code>number</code>                                                        | <p>Current quantity as entered by user in first input</p>                       |
-| otherUnits             | <code>Array.&lt;IFilledDimensionUnits&gt;</code> \| <code>undefined</code> | <p>FilledDimensionUnits found in product (possibly undefined)</p>               |
-| value2                 | <code>number</code> \| <code>undefined</code>                              | <p>Current quantity as entered by user in second input (possibly undefined)</p> |
-| targetIsSecondaryInput | <code>boolean</code>                                                       | <p>If action was triggered from secondary input (defaults to false)</p>         |
-
-<a name="splitOnDashes"></a>
-
-## splitOnDashes ⇒ <code>Array.&lt;string&gt;</code>
-
-<p>Get product name as array. Array created mostly by splitting name on dash symbol (and variations).</p>
-
-**Kind**: global variable  
-**Returns**: <code>Array.&lt;string&gt;</code> - <ul>
-
-<li>Position 0 is the &quot;commum section&quot; of the name, and position 1 should contain all specifics (ex. color, size, etc...)</li>
-</ul>
-
-| Param   | Type                                                                  |
-| ------- | --------------------------------------------------------------------- |
-| product | <code>IIndexedVariationAlgolia</code> \| <code>IIndexedProduct</code> |
-| locale  | <code>string</code> \| <code>undefined</code>                         |
-
-<a name="getProdName"></a>
-
-## getProdName
-
-<p>Function getParentProductCategoryGroup</p>
-
-**Kind**: global variable
-
-| Param | Description             |
-| ----- | ----------------------- |
-| prod  | <p>Product to check</p> |
-
-<a name="getParentProductCategoryGroup"></a>
-
-## getParentProductCategoryGroup
-
-<p>Function getProductFormOptions - Returns all AttributeValues for product to construct options in add to cart form</p>
-
-**Kind**: global variable
-
-| Param      | Description                                    |
-| ---------- | ---------------------------------------------- |
-| product    | <p>Product to check</p>                        |
-| attributes | <p>Array of IAttributes to fetch info from</p> |
-
-<a name="getProductFormOptions"></a>
-
-## getProductFormOptions ⇒
-
-<p>Checks if product is of type by checking TYPE attribute value. Works with indexed product or cart item.</p>
-
-**Kind**: global variable  
-**Returns**: <p>boolean</p>
-
-| Param            |
-| ---------------- |
-| product          |
-| type             |
-| excludeUndefined |
-
-<a name="checkIfProductIsInstallation"></a>
-
-## checkIfProductIsInstallation
-
-<p>Returns array of installation items found in provided array</p>
-
-**Kind**: global variable
-
-| Param | Description                                                 |
-| ----- | ----------------------------------------------------------- |
-| items | <p>Array of cart items or IIndexedDeclinations to check</p> |
-
-<a name="getAllInstallFromItems"></a>
-
-## getAllInstallFromItems
-
-<ul>
-<li>Returns items with only one apparent grass product (used for detail customers).
-** FOR DISPLAY PURPOSES ONLY - Always save grass products separatly in ICart **</li>
-</ul>
-
-**Kind**: global variable
-
-| Param          | Description                                                           |
-| -------------- | --------------------------------------------------------------------- |
-| recursiveItems | <p>ICartItems with subitems (object created for display purposes)</p> |
-
-<a name="getGrassSubQuestionsByType"></a>
-
-## getGrassSubQuestionsByType ⇒
-
-<p>For grass products. Over 1480pi2, if installation, quantities are rounded to rolls (10pi2) if pickup, and to half pal. if shipping</p>
-
-**Kind**: global variable  
-**Returns**: <p>quantity rounded to rolls with items to change or undefined</p>
-
-| Param        |
-| ------------ |
-| grassProduct |
-| cartData     |
-
-<a name="handleGrassProductQtyRoundForShipping"></a>
-
-## handleGrassProductQtyRoundForShipping
-
-<p>Returns rounded grass quantity depending on current qty, if customer selected installation and pallet unit (if defined)</p>
-
-**Kind**: global variable
-
-| Param      | Type                                                         | Description                                              |
-| ---------- | ------------------------------------------------------------ | -------------------------------------------------------- |
-| currentQte | <code>number</code>                                          | <p>Current quantity as entered by user in input</p>      |
-| isShipping | <code>boolean</code>                                         | <p>Whether customer has selected installation option</p> |
-| palUnit    | <code>IFilledDimensionUnits</code> \| <code>undefined</code> | <p>Pallet FilledDimensionUnit (possibly undefined)</p>   |
-
-<a name="getConcreteQteText"></a>
-
-## getConcreteQteText
-
-<p>returns all items in cart where attribute AVAILABILITY contains wanted type.</p>
-
-**Kind**: global variable
-
-| Param            |
-| ---------------- |
-| cartData         |
-| availabilityType |
-
-<a name="getConcreteItemsByAvailability"></a>
-
-## getConcreteItemsByAvailability ⇒
-
-<p>Function getVracType - constructs vrac helper object is cart contains vrac or vrac associated items.</p>
-
-**Kind**: global variable  
-**Returns**: <p>IVracType object containing vrac_type enum value and vrac_store_ids where vrac items are available</p>
-
-| Param                    |
-| ------------------------ |
-| stores                   |
-| cartData                 |
-| getInventoryItemCallback |
-
-<a name="fetchFeesBeforeCart"></a>
-
-## fetchFeesBeforeCart
-
-<p>Check if pro custom promo info should be shown for customer for a specific product.</p>
-
-**Kind**: global variable
-
-| Param          |
-| -------------- |
-| userData       |
-| isPro          |
-| product        |
-| customMinPrice |
-
-<a name="calculateUpsellQte"></a>
-
-## calculateUpsellQte
-
-<ul>
-<li>checks all upsells in product and returns those where associated quantities are found.</li>
-</ul>
-
-**Kind**: global variable
-
-| Param          | Description                                                                     |
-| -------------- | ------------------------------------------------------------------------------- |
-| upsellProducts | <p>All upsells in product</p>                                                   |
-| cartItems      | <p>All current cart items</p>                                                   |
-| checkQte       | <p>If all upsells should be checked for quantity</p>                            |
-| alwaysShow     | <p>If upsell should be considered even if it already exists in cart as item</p> |
-
-<a name="getUpsellsToQuantify"></a>
-
-## getUpsellsToQuantify
-
-<ul>
-<li>Returns upsell equivalence text</li>
-</ul>
-
-**Kind**: global variable
-
-| Param             | Description                                              |
-| ----------------- | -------------------------------------------------------- |
-| upsellsToQuantify | <p>All upsells to show in text</p>                       |
-| qte               | <p>Associated product quantity</p>                       |
-| specificProduct   | <p>If upsell shown is a specific products</p>            |
-| isMulti           | <p>If upsell if shared by more than one item in cart</p> |
-| locale            | <p>locale of string to return</p>                        |
-
-<a name="getGeneralUpsellQteText"></a>
-
-## getGeneralUpsellQteText
-
-<ul>
-<li>Returns quantity stinrg and upsell name to show in Upsell Quantity indicator</li>
-</ul>
-
-**Kind**: global variable
-
-| Param      | Description                                                 |
-| ---------- | ----------------------------------------------------------- |
-| upsell     | <p>Upsell to show qyantity for</p>                          |
-| productQte | <p>Quantity of associated product for ratio calculation</p> |
-| locale     | <p>locale of string to return</p>                           |
-
-<a name="checkIfCartContainsException"></a>
-
-## checkIfCartContainsException
-
-<p>Function getCartItemsFromProdUpsells</p>
-
-**Kind**: global variable
-
-| Param      | Type                                              | Description                                                                                  |
-| ---------- | ------------------------------------------------- | -------------------------------------------------------------------------------------------- |
-| qte        | <code>number</code>                               | <p>Quantity of product to which upsell is associated</p>                                     |
-| currentSku | <code>string</code>                               | <p>Sku of the declination selected by user for the product to which upsell is associated</p> |
-| prodUpsell | <code>Array.&lt;IProductRecommendation&gt;</code> | <p>Array of upsells found in product</p>                                                     |
-| getProduct |                                                   | <p>Callback function to fetch product from DB</p>                                            |
-| locale     | <code>string</code>                               | <p>locale for product fetch (defaults to 'fr')</p>                                           |
-
-<a name="mockCustomPriceList"></a>
-
-## mockCustomPriceList
-
-<p>Takes in a function and checks for error</p>
-
-**Kind**: global variable
-
-| Param   | Type                           | Description                                         |
-| ------- | ------------------------------ | --------------------------------------------------- |
-| method  | <code>function</code>          | <p>The function to check</p>                        |
-| params  | <code>Array.&lt;any&gt;</code> | <p>The array of function parameters</p>             |
-| message | <code>string</code>            | <p>Optional message to match with error message</p> |
-
-<a name="getRandomValue"></a>
-
-## getRandomValue ⇒
-
-<p>Get an object property value</p>
-
-**Kind**: global variable  
-**Returns**: <p>the property value</p>
-
-| Param | Description                            |
-| ----- | -------------------------------------- |
-| obj   | <p>The object to scan</p>              |
-| props | <p>The path of the property to get</p> |
-
-<a name="getObjectProperty"></a>
-
-## getObjectProperty ⇒
-
-<p>Set an object property to an anonymized value if it exists</p>
-
-**Kind**: global variable  
-**Returns**: <p>The object with the edited value</p>
-
-| Param | Description                                       |
-| ----- | ------------------------------------------------- |
-| obj   | <p>The object to look into</p>                    |
-| props | <p>The property path</p>                          |
-| type  | <p>The property type used to shuffle the data</p> |
-
-<a name="setObjectProperty"></a>
-
-## setObjectProperty ⇒
-
-<p>Anonymise the customer data if in test env</p>
-
-**Kind**: global variable  
-**Returns**: <p>The new customer data</p>
-
-| Param | Description              |
-| ----- | ------------------------ |
-| c     | <p>The customer data</p> |
-
-<a name="getCurrentProvince"></a>
-
-## getCurrentProvince ⇒
-
-<p>Constructs and returns data for indexed cart (algolia or addio)</p>
-
-**Kind**: global variable  
-**Returns**: <IIndexedCart>
-
-| Param                | Description                                                               |
-| -------------------- | ------------------------------------------------------------------------- |
-| cartData             | <p>Current cart data</p>                                                  |
-| space                | <p>Space object</p>                                                       |
-| setPaidAtIfUndefined | <p>Optionnal - If true, will set paid_at with current date</p>            |
-| customer             | <p>Optionnal - If defined, adds info based on customer to indexedCart</p> |
-
-<a name="getCartPromo"></a>
-
-## getCartPromo
-
-<p>Check if current cart promos applied contain a promo_code type promotion</p>
-
-**Kind**: global variable
-
-| Param    |
-| -------- |
-| cartData |
-
-<a name="shouldCheckPromoCode"></a>
-
-## shouldCheckPromoCode
-
-<p>Check if a discount rule applies to a specific declination</p>
-
-**Kind**: global variable
-
-| Param         | Description                       |
-| ------------- | --------------------------------- |
-| discount_rule | <p>The discount rule to check</p> |
-| declination   | <p>The declination to compare</p> |
-
-<a name="shouldApplyRuleToDeclination"></a>
-
-## shouldApplyRuleToDeclination
-
-<p>Check if a specific rule of a discount rule is respected</p>
-
-**Kind**: global variable
-
-| Param      | Description                                          |
-| ---------- | ---------------------------------------------------- |
-| ruleDetail | <p>The rule details object to check</p>              |
-| cartValue  | <p>The value to compare with rule specifications</p> |
-
-<a name="getResultRuleDetail"></a>
-
-## getResultRuleDetail
-
-<p>Check if rule applied to product attributes is respected for specific declination attributes</p>
-
-**Kind**: global variable
-
-| Param                    | Description                                   |
-| ------------------------ | --------------------------------------------- |
-| attributeAndValues       | <p>The rule details object to check</p>       |
-| arrDeclinationAttributes | <p>The declinations attributes to compare</p> |
-
-<a name="getCartPromoType"></a>
-
-## getCartPromoType
-
-<p>Check if promo code can be applied to a specific cart</p>
-
-**Kind**: global variable
-
-| Param     | Description                                       |
-| --------- | ------------------------------------------------- |
-| cart      | <p>The cart to check</p>                          |
-| promoCode | <p>The discount rule with promo code to check</p> |
-
-<a name="checkPromoCodeEligibility"></a>
-
-## checkPromoCodeEligibility
-
-<p>Returns tier pricing step that should be applied for provided quantity, or undefined if none should apply</p>
-
-**Kind**: global variable
-
-| Param              | Description                                    |
-| ------------------ | ---------------------------------------------- |
-| tierPricingToCheck | <p>the indexed tier-pricing array to check</p> |
-| qte                |                                                |
-
-<a name="getTierPricingToApply"></a>
-
-## getTierPricingToApply
-
-<p>Converts tier-pricing found in discount_rule to IIndexedTierPricing.</p>
-
-**Kind**: global variable
-
-| Param        | Description                                                                    |
-| ------------ | ------------------------------------------------------------------------------ |
-| discountRule | <p>the tier-pricing tier discountRule to check</p>                             |
-| price        | <p>declinations regular price from which tier-pricing result is calculated</p> |
-| space        |                                                                                |
-| decimals     | <p>the amount of decimals to show on tier-pricing result</p>                   |
-
-<a name="applyTierPricing"></a>
-
-## applyTierPricing
-
-<p>Calculate new discount_price object for cart item base on qte and tier_pricing</p>
-
-**Kind**: global variable
-
-| Param            | Description                                                                           |
-| ---------------- | ------------------------------------------------------------------------------------- |
-| item             | <p>the item to check</p>                                                              |
-| setOriginalPrice | <p>if original_amount should be set instead of discount_price.amount</p>              |
-| originalDecli    | <p>Optionnal. The IIndexedDeclination used to construct the cart item originally.</p> |
-
-<a name="getNewDiscountPriceFromTierPricing"></a>
-
-## getNewDiscountPriceFromTierPricing
-
-<p>Get discounted price after applying discount rules to a provided price</p>
-
-**Kind**: global variable
-
-| Param          | Description                                           |
-| -------------- | ----------------------------------------------------- |
-| discount_rules | <p>The discount rules to apply</p>                    |
-| amount         | <p>The initial amount on which to apply discounts</p> |
-| space          |                                                       |
-
-<a name="applyDiscountRulesOnProduct"></a>
-
-## applyDiscountRulesOnProduct
-
-<p>Get result of discount rule discount on a provided amount</p>
-
-**Kind**: global variable
-
-| Param             | Description                                     |
-| ----------------- | ----------------------------------------------- |
-| initial           | <p>The price on which to apply the discount</p> |
-| discountResultObj | <p>The discount rule result object</p>          |
-
-<a name="applyDiscountToPrice"></a>
-
-## applyDiscountToPrice ⇒
-
-<p>Get sku(s) affected by a promo as an array of strings</p>
-
-**Kind**: global variable  
-**Returns**: <p>And array of strings</p>
-
-| Param          | Description                                           |
-| -------------- | ----------------------------------------------------- |
-| valueToConvert | <p>The sku or sku array associated with the promo</p> |
-
-<a name="getSkuArrayForPromo"></a>
-
-## getSkuArrayForPromo ⇒
-
-<p>Returns a list of all skus where promo applied to specific products should apply. Check for both amount/percent_sku and amount/percent_category options.</p>
-
-**Kind**: global variable  
-**Returns**: <p>An array of strings</p>
-
-| Param        | Description                   |
-| ------------ | ----------------------------- |
-| cartItems    | <p>The current cart items</p> |
-| promoToCheck | <p>The promo to check</p>     |
-
-<a name="getResultAppliedDiscountSkus"></a>
-
-## getResultAppliedDiscountSkus ⇒
-
-<p>Creates array of all category level slugs for a cart item.</p>
-
-**Kind**: global variable  
-**Returns**: <p>An array of strings</p>
-
-| Param          | Description                                 |
-| -------------- | ------------------------------------------- |
-| itemCategories | <p>Value found in props cart.categories</p> |
-
-<a name="getItemCategorySlugArray"></a>
-
-## getItemCategorySlugArray
-
-<p>Apply all valid discounts found in a specific cart's discount_rules props to cart</p>
-
-**Kind**: global variable
-
-| Param         | Description                                                                       |
-| ------------- | --------------------------------------------------------------------------------- |
-| cart          | <p>The cart to check</p>                                                          |
-| isMultiPromo  |                                                                                   |
-| forceShipping | <p>If cart should be considered as a shipping cart, even if is_pickup is true</p> |
-
-<a name="applyDiscountToCart"></a>
-
-## applyDiscountToCart
-
-<p>Get the ICartPromoApplied object for a specified discount_rule. Only works for promos that do not apply to products of certain categories/skus.</p>
-
-**Kind**: global variable
-
-| Param |
-| -------getConvertedUnitQuantity
-| cart |
-| discount |
-
-<a name="getStandardCartPromoFromDiscount"></a>
-
-## getStandardCartPromoFromDiscount ⇒
-
-<p>Calculates the cumulative subtotal for all service/fee type items in cart, including any applied promos. Usefull when calculating a promo's amount when all fees and services should be excluded.</p>
-
-**Kind**: global variable  
-**Returns**: <p>A number</p>
-
-| Param                         | Description                                                                                                                                |
-| ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
-| cartData                      | <p>The cartData to check</p>                                                                                                               |
-| allCurrentAppliedToItemPromos | <p>All currently active cartPromos that apply to items in cart. Sent seperatly in case local state is different from current cartData.</p> |
-
-<a name="checkIfCouldApplyIncentivePromo"></a>
-
-## checkIfCouldApplyIncentivePromo
-
-<p>Calculates amount to be removed for payment incentive type promos.</p>
-
-**Kind**: global variable
-
-| Param              | Description                                                                                                |
-| ------------------ | ---------------------------------------------------------------------------------------------------------- |
-| cartData           |                                                                                                            |
-| checkDiscountRules | <p>Optionnal. If cart discount_rules should be checked if cart_promos_applied does not have promo yet.</p> |
-
-<a name="getAfterTaxesPromosTotalAmount"></a>
-
-## getAfterTaxesPromosTotalAmount
-
-<p>Returns cart_promos_applied corresponding to payment incentive, if found. Can also check in discount_rules if props provided</p>
-
-**Kind**: global variable
-
-| Param              | Description                                                                                                   |
-| ------------------ | ------------------------------------------------------------------------------------------------------------- |
-| cartData           |                                                                                                               |
-| checkDiscountRules | <p>Optionnal. If the function should check in cart discount_rules if nothing found in cart_promos_applied</p> |
-
-<a name="getAfterTaxesPromoInCart"></a>
-
-## getAfterTaxesPromoInCart
-
-<p>Returns the information regarding the payment incentive promo if found in cart's discount_rules</p>
-
-**Kind**: global variable
-
-| Param    |
-| -------- |
-| cartData |
-
-<a name="unitShortDict"></a>
-
-## unitShortDict ⇒ <code>ILang</code>
-
-<p>Returns the dictionnary containing the shortened version of unit labels in multiple languages</p>
-
-**Kind**: global variable  
-**Returns**: <code>ILang</code> - <p>The dictionnary containing the shortened unit label in multiple languages</p>
-
-| Param              | Type                              | Description                                                                                                           |
-| ------------------ | --------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
-| slug               | <code>string</code>               | <p>The slug for which we want to get the shortened dictionnary</p>                                                    |
-| returnUnitForSlugs | <code>Array.&lt;string&gt;</code> | <p>An array of slugs that we want to return a default dictionnary for, in this case the unit dictionnary for unit</p> |
-
-<a name="getConvertedUnitQuantity"></a>
-
-## getConvertedUnitQuantity
-
-<p>Constructs object with detailled inventory quantities by unit (based on other_units for product)</p>
-
-**Kind**: global variable
-
-| Param                 | Description      |
-| --------------------- | ---------------- |
-| other_units           |                  |
-| inventoryQuantity     |                  |
-| isGrass               |                  |
-| showNegativeInventory | <p>optionnal</p> |
-
-<a name="getQty"></a>
-
-## getQty
-
-<p>Calculates inventory unit quantity for function getQty</p>
-
-**Kind**: global variable
-
-| Param             |
-| ----------------- |
-| value             |
-| isUnitFittingUnit |
-| isNegativeQty     |
-
-<a name="recursiveCheckObject"></a>
-
-## recursiveCheckObject ⇒
-
-<p>Updates value of object by checking recursivly.</p>
-
-**Kind**: global variable  
-**Returns**: <p>updated object</p>
-
-| Param        | Description                                                                                                                                                                                                                |
-| ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| allValues    | <p>Full value object</p>                                                                                                                                                                                                   |
-| newValue     | <p>New value to update</p>                                                                                                                                                                                                 |
-| propsToCheck | <p>Full key string associated to value to update, with nested keys seperated by dots (.). If the value to update is nested in an array, use square brackets with index between (ex. first_key.second_key[2].third_key)</p> |
-
-<a name="getOrderedPromises"></a>
-
-## getOrderedPromises ⇒
-
-<p>Checks list of promises for applicable banks based on space bank types.</p>
-
-**Kind**: global variable  
-**Returns**: <p>An array of applicable banks. If no bank is active for a type, is not returned in array. If active bank of type is in a inactive promise, is returned with props pa_is_active: false.</p>
-
-| Param           | Description                                                  |
-| --------------- | ------------------------------------------------------------ |
-| promisesToCheck | <p>The promise list to check</p>                             |
-| possibleBanks   | <p>the possible bank types (usually found in space data)</p> |
-
-<a name="checkForApplicableBanks"></a>
-
-## checkForApplicableBanks
-
-<p>Returns if a promise is currently active. Promise is active if it is not archived, and if current date is same or after starting_date, and before ending_date (if defined).</p>
-
-**Kind**: global variable
-
-| Param   | Description                      |
-| ------- | -------------------------------- |
-| promise | <p>the promise data to check</p> |
-
-<a name="checkIfOtherBankOfSameTypeIsActive"></a>
-
-## checkIfOtherBankOfSameTypeIsActive
-
-<p>Returns translated name for a provided bank type ID.</p>
-
-**Kind**: global variable
-
-| Param        | Description                                      |
-| ------------ | ------------------------------------------------ |
-| allBankTypes | <p>The current bank types for space</p>          |
-| bankTypeID   | <p>The bank type ID for which we want a name</p> |
-| locale       | <p>Optionnal. Defaults to 'fr'</p>               |
-
-<a name="getBankTypeName"></a>
-
-## getBankTypeName
-
-<p>Calculates the remaining amount for a specific promise's bank</p>
-
-**Kind**: global variable
-
-| Param             | Description                                                                                    |
-| ----------------- | ---------------------------------------------------------------------------------------------- |
-| initialBankAmount | <p>the initial amount of the bank</p>                                                          |
-| bankHistory       | <p>array of all history entries for bank. Will be ordered by date before deducing amounts.</p> |
-
-<a name="getIndexedByCustomerPromiseValues"></a>
-
-## getIndexedByCustomerPromiseValues ⇒
-
-<p>Returns the most recently emptied bank of a given type</p>
-
-**Kind**: global variable  
-**Returns**: <p>An IBank with a promise_unique_id</p>
-
-| Param              | Description                                                   |
-| ------------------ | ------------------------------------------------------------- |
-| allCustomerPAsData | <p>the array of all promises to purchase we want to check</p> |
-| type               | <p>the bank_type_id to check</p>                              |
-| promiseUniqueID    | <p>the current promise unique id</p>                          |
-
-<a name="getIndexServices"></a>
-
-## getIndexServices
-
-<p>Save new entry objects to provided search index services</p>
-
-**Kind**: global variable
-
-| Param         | Description                                                     |
-| ------------- | --------------------------------------------------------------- |
-| services      | <p>the services to check for save</p>                           |
-| newEntry      | <p>the object to save</p>                                       |
-| processLogStr | <p>the string to add to the log shown with service response</p> |
-
-<a name="saveNewEntryToIndex"></a>
-
-## saveNewEntryToIndex
-
-<p>Save a partial object entry to provided search index services.</p>
-
-**Kind**: global variable
-
-| Param            | Description                                                                             |
-| ---------------- | --------------------------------------------------------------------------------------- |
-| services         | <p>the services to check for save</p>                                                   |
-| partialNewEntry  | <p>the object to save</p>                                                               |
-| processLogStr    | <p>the string to add to the log shown with service response</p>                         |
-| createIfNoExists | <p>= Optionnal. If should create entry if it does not already exist in search index</p> |
-
-<a name="partialSaveNewEntryToIndex"></a>
-
-## partialSaveNewEntryToIndex
-
-<p>Returns an object with base info needed to call Algolia/AddioSearch with search query.</p>
-
-**Kind**: global variable
-
-| Param |
-| ----- |
-| space |
-
-<a name="getFetchInfoAlgoliaAddioSearch"></a>
-
-## getFetchInfoAlgoliaAddioSearch
-
-<p>Fetch entries from either algolia or AddioSearch (prospr) for a provided index. Client-side only!</p>
-
-**Kind**: global variable
-
-| Param  |
-| ------ |
-| param0 |
-
-<a name="fetchEntriesAlgoliaAddioSearch"></a>
-
-## fetchEntriesAlgoliaAddioSearch
-
-<p>Returns search result from active search index service. Server-side friendly!</p>
-
-**Kind**: global variable
-
-| Param      | Description                                                                                            |
-| ---------- | ------------------------------------------------------------------------------------------------------ |
-| parameters | <p>Parsed parameters of IQueryProps. Space and indice must be provided, other props are optionnal.</p> |
-
-<a name="isTestEnv"></a>
-
-## isTestEnv
-
-<p>TBSDK - SDK Manager</p>
-<p>Client SDK to access TheBEAST eCommerce</p>
-
-**Kind**: global constant  
-<a name="spaceInitData"></a>
-
-## spaceInitData
-
-<p>Use this object to change which space is being tested!</p>
-
-**Kind**: global constant  
-<a name="getMinDatePicker"></a>
-
-## getMinDatePicker()
-
-<p>Sets the minimum shipping day for delivery</p>
-
-**Kind**: global function  
-<a name="getProductSellUnitLabel"></a>
-
-## getProductSellUnitLabel(otherUnits, locale, returnUnitForSlugs) ⇒ <code>string</code>
-
-<p>Returns sell unit label in correct language for a specific product's other_units</p>
-
-**Kind**: global function  
-**Returns**: <code>string</code> - <p>The sell unit label in the correct language</p>
-
-| Param              | Type                                                                       | Default                     | Description                                                       |
-| ------------------ | -------------------------------------------------------------------------- | --------------------------- | ----------------------------------------------------------------- |
-| otherUnits         | <code>Array.&lt;IFilledDimensionUnits&gt;</code> \| <code>undefined</code> |                             | <p>The unit array we have to check to get the sell unit</p>       |
-| locale             | <code>string</code> \| <code>undefined</code>                              | <code>&quot;fr&quot;</code> | <p>The language in which we want to return the label</p>          |
-| returnUnitForSlugs | <code>Array.&lt;string&gt;</code>                                          |                             | <p>An array of the slugs we want to return the unit label for</p> |
-
-<a name="splitOnDashes"></a>
-
-## splitOnDashes(stringToSplit) ⇒ <code>Array.&lt;string&gt;</code>
-
-**Kind**: global function
-
-| Param                              | Type                | Description                                                                                                                                            |
-| ---------------------------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| stringToSplit                      | <code>string</code> |                                                                                                                                                        |
-| dummyStringToReplace.currentValue, | <code>string</code> | <p>optionnal, default : '%%-%%'. Used to provide general replace values for a specific string. Is applied to both sections of the splitted string.</p> |
-| dummyStringToReplace.newValue,     | <code>string</code> | <p>optionnal, default : ' - '. Used to provide general replace values for a specific string. Is applied to both sections of the splitted string.</p>   |
-
-<a name="getRandomValue"></a>
-
-## getRandomValue(val, type) ⇒
-
-<p>Replace a value with anonymized value</p>
-
-**Kind**: global function  
-**Returns**: <p>the new value</p>
-
-| Param | Description               |
-| ----- | ------------------------- |
-| val   | <p>The original value</p> |
-| type  | <p>The type of data</p>   |
-
-<a name="getCartPromo"></a>
-
-## getCartPromo(cartData)
-
-<p>Get formatted array of cart promos applied to a specific cart</p>
-
-**Kind**: global function
-
-| Param    |
-| -------- |
-| cartData |
-
-<a name="_checkRuleApplicationArray"></a>
-
-## \_checkRuleApplicationArray(checkedRulesApplicationArray) ⇒
-
-<p>Checks if discount rule should be applied to cart based on each rule verification results.</p>
-
-**Kind**: global function  
-**Returns**: <p>A boolean</p>
-
-| Param                        | Description                                                                                            |
-| ---------------------------- | ------------------------------------------------------------------------------------------------------ |
-| checkedRulesApplicationArray | <p>Array where each position is a verified rule result (condition with passed of failed (boolean))</p> |
-
-<a name="checkIfCouldApplyIncentivePromo"></a>
-
-## checkIfCouldApplyIncentivePromo(cartData, skipCheckFor) ⇒
-
-<p>Checks if an incentive discount could (in theory) by added to provided cart, by checking found incentive discount's rule array.</p>
-
-**Kind**: global function  
-**Returns**: <p>a boolean</p>
-
-| Param        | Description                                                    |
-| ------------ | -------------------------------------------------------------- |
-| cartData     | <p>The cart to check (checks discount_rules for incentive)</p> |
-| skipCheckFor | <p>If certain rules should be ignore for check</p>             |
-
-<a name="getOrderedPromises"></a>
-
-## getOrderedPromises(promises)
-
-<p>Get ordered array of promise data objects by starting date.</p>
-
-**Kind**: global function
-
-| Param    |
-| -------- |
-| promises |
-
-<a name="getIndexServices"></a>
-
-## getIndexServices(space, partialIndexID)
-
-<p>Returns objet with possible index service instances
-As of now, checks for Algolia and Addio Search</p>
-
-**Kind**: global function
-
-| Param          | Description                                                                                                                                                              |
-| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| space          | <p>the spaceObj to check</p>                                                                                                                                             |
-| partialIndexID | <p>the partial index ID to consult for search, excluding the env. variable (prod* or test* will be added in function). \*\* Important to use index ID, not table ID!</p> |
+## Classes
+
+<dl>
+<dt><a href="#Brand">Brand</a></dt>
+<dd><p>Brand class</p></dd>
+<dt><a href="#Catalogue">Catalogue</a></dt>
+<dd><p>Catalogue class</p></dd>
+<dt><a href="#Customer">Customer</a></dt>
+<dd><p>Customer class</p></dd>
+<dt><a href="#Discount">Discount</a></dt>
+<dd><p>Brand class</p></dd>
+<dt><del><a href="#Invoice">Invoice</a></del></dt>
+<dd></dd>
+<dt><del><a href="#Order">Order</a></del></dt>
+<dd></dd>
+<dt><a href="#Org">Org</a></dt>
+<dd><p>Class Org - Organization
+Represent an organization created by a user. An organization can have multiple space.</p></dd>
+<dt><a href="#Product">Product</a></dt>
+<dd><p>Product class</p></dd>
+<dt><a href="#PurchaseOrder">PurchaseOrder</a></dt>
+<dd><p>Brand class</p></dd>
+<dt><a href="#Service">Service</a></dt>
+<dd><p>Service class</p></dd>
+<dt><a href="#Space">Space</a></dt>
+<dd><p>Class Space
+A Space represent a company.</p></dd>
+<dt><a href="#User">User</a></dt>
+<dd><p>User class</p></dd>
+<dt><a href="#ProsprSearch">ProsprSearch</a></dt>
+<dd><p>À NOTER - Prospr est l'ancien nom du ecomm, est depuis devenu Addio.
+Il faudra éventuellement faire le refactoring nécessaire pour remplacer toutes les appelations,
+mais en attendant, c'est normal qu'il y ait les deux noms à différents endroits.</p></dd>
+</dl>
+
+## Members
+
+<dl>
+<dt><a href="#CustomerTypeEnum">CustomerTypeEnum</a></dt>
+<dd><p>ICustomer interface</p>
+<p>Représente un client (customer). Un client peut:</p>
+<ul>
+<li>Faire des recherches parmis les différents items du commerçant</li>
+<li>Afficher une fiche cliente</li>
+</ul></dd>
+<dt><a href="#getDefaultDiscountRule">getDefaultDiscountRule</a></dt>
+<dd><p>Exemple:</p>
+<p>Product = 5.00$</p>
+<p>Discount rule:
+quantity &gt;= 10 ? remove 2</p>
+<p>Result:
+If applied to cart:
+11 Product = (before) 55.00$ (after) 53.00$</p>
+<p>attribute color == red ? percent 10
+1 red Product = (before) 5.00$ (after) 4.50$</p>
+<p>attribute color == red ? percent -20
+1 red Product = (before) 5.00$ (after) 6.00$</p></dd>
+<dt><a href="#installationProductsSlugs">installationProductsSlugs</a></dt>
+<dd><p>Contains all necessary elements for extra questions if adding grass product to cart</p></dd>
+<dt><a href="#getConcreteCartInfo">getConcreteCartInfo</a></dt>
+<dd><ul>
+<li>Create the essential info needed when checking a grass type product for cart</li>
+</ul></dd>
+<dt><a href="#getMinDateOffset">getMinDateOffset</a></dt>
+<dd><p>compares date with blockedDates from DB and blocked days (currently hardcoded in function)</p></dd>
+<dt><a href="#shouldDisableDate">shouldDisableDate</a></dt>
+<dd><p>checks if type of cart corresponds to a blockedDates array and if array has dates defined</p></dd>
+<dt><a href="#installationFeePalletTier">installationFeePalletTier</a></dt>
+<dd><p>Calculates fees that should be applied to provided cart, and fetches them from database or fee array if provided.
+Returns the items to add, update and delete, as well as other cart info to set after fees.
+** Optimized version possible, where address zones and distance are calculated before and properties are sent directly to function
+** Optimized version reverted, logic found in commit here : [#2087b32](https://github.com/ciaoqc/gng-tb-admin-sdk/commit/2087b3207df9e5916a979b8bb255abc2a4c1dac6)</p></dd>
+<dt><a href="#applyFeesToCart">applyFeesToCart</a></dt>
+<dd><p>Checks if sample shipping fee should be removed from cart depending on cart items found in cart.
+** Optimized version possible using brand name instead of brand id, removing async check.
+** Optimized version reverted, logic found in commit here : [#2087b32](https://github.com/ciaoqc/gng-tb-admin-sdk/commit/2087b3207df9e5916a979b8bb255abc2a4c1dac6)</p></dd>
+<dt><a href="#calculateShippingForVrac">calculateShippingForVrac</a> ⇒</dt>
+<dd><p>checks if cart expired using the updated_at date stored in the shipping_payload</p></dd>
+<dt><a href="#transformG2CustomerToCustomer">transformG2CustomerToCustomer</a></dt>
+<dd><p>Verifies if customer exists in G2.</p></dd>
+<dt><a href="#checkIfCustomerExistsInG2">checkIfCustomerExistsInG2</a></dt>
+<dd><p>Updates customer in database with new info found in G2.</p></dd>
+<dt><a href="#getCustomPriceList">getCustomPriceList</a></dt>
+<dd><p>Get promise to purchase additionnal escompte equivalent from customPriceList for specific cart item</p></dd>
+<dt><a href="#getFittingUnits">getFittingUnits</a> ⇒</dt>
+<dd><p>Returns string corresponding to provided cart's type.</p></dd>
+<dt><a href="#getProductSellUnitLabel">getProductSellUnitLabel</a> ⇒ <code>string</code></dt>
+<dd><p>Returns the plural unit label for a specific slug</p></dd>
+<dt><a href="#getDescriptionString">getDescriptionString</a></dt>
+<dd><p>Returns rounded product quantities depending on current value, value of secondary input if existant and sale unit per command step ratio found in product.</p></dd>
+<dt><a href="#splitOnDashes">splitOnDashes</a> ⇒ <code>Array.&lt;string&gt;</code></dt>
+<dd><p>Get product name as array. Array created mostly by splitting name on dash symbol (and variations).</p></dd>
+<dt><a href="#getProdName">getProdName</a></dt>
+<dd><p>Function getParentProductCategoryGroup</p></dd>
+<dt><a href="#getParentProductCategoryGroup">getParentProductCategoryGroup</a></dt>
+<dd><p>Function getProductFormOptions - Returns all AttributeValues for product to construct options in add to cart form</p></dd>
+<dt><a href="#getProductFormOptions">getProductFormOptions</a> ⇒</dt>
+<dd><p>Checks if product is of type by checking TYPE attribute value. Works with indexed product or cart item.</p></dd>
+<dt><a href="#checkIfProductIsInstallation">checkIfProductIsInstallation</a></dt>
+<dd><p>Returns array of installation items found in provided array</p></dd>
+<dt><a href="#getAllInstallFromItems">getAllInstallFromItems</a></dt>
+<dd><ul>
+<li>Returns items with only one apparent grass product (used for detail customers).
+** FOR DISPLAY PURPOSES ONLY - Always save grass products separatly in ICart **</li>
+</ul></dd>
+<dt><a href="#getGrassSubQuestionsByType">getGrassSubQuestionsByType</a> ⇒</dt>
+<dd><p>For grass products. Over 1480pi2, if installation, quantities are rounded to rolls (10pi2) if pickup, and to half pal. if shipping</p></dd>
+<dt><a href="#handleGrassProductQtyRoundForShipping">handleGrassProductQtyRoundForShipping</a></dt>
+<dd><p>Returns rounded grass quantity depending on current qty, if customer selected installation and pallet unit (if defined)</p></dd>
+<dt><a href="#getConcreteQteText">getConcreteQteText</a></dt>
+<dd><p>returns all items in cart where attribute AVAILABILITY contains wanted type.</p></dd>
+<dt><a href="#getConcreteItemsByAvailability">getConcreteItemsByAvailability</a> ⇒</dt>
+<dd><p>Function getVracType - constructs vrac helper object is cart contains vrac or vrac associated items.</p></dd>
+<dt><a href="#fetchFeesBeforeCart">fetchFeesBeforeCart</a></dt>
+<dd><p>Check if pro custom promo info should be shown for customer for a specific product.</p></dd>
+<dt><a href="#calculateUpsellQte">calculateUpsellQte</a></dt>
+<dd><ul>
+<li>checks all upsells in product and returns those where associated quantities are found.</li>
+</ul></dd>
+<dt><a href="#getUpsellsToQuantify">getUpsellsToQuantify</a></dt>
+<dd><ul>
+<li>Returns upsell equivalence text</li>
+</ul></dd>
+<dt><a href="#getGeneralUpsellQteText">getGeneralUpsellQteText</a></dt>
+<dd><ul>
+<li>Returns quantity stinrg and upsell name to show in Upsell Quantity indicator</li>
+</ul></dd>
+<dt><a href="#checkIfCartContainsException">checkIfCartContainsException</a></dt>
+<dd><p>Function getCartItemsFromProdUpsells</p></dd>
+<dt><a href="#mockCustomPriceList">mockCustomPriceList</a></dt>
+<dd><p>Takes in a function and checks for error</p></dd>
+<dt><a href="#getRandomValue">getRandomValue</a> ⇒</dt>
+<dd><p>Get an object property value</p></dd>
+<dt><a href="#getObjectProperty">getObjectProperty</a> ⇒</dt>
+<dd><p>Set an object property to an anonymized value if it exists</p></dd>
+<dt><a href="#setObjectProperty">setObjectProperty</a> ⇒</dt>
+<dd><p>Anonymise the customer data if in test env</p></dd>
+<dt><a href="#getCurrentProvince">getCurrentProvince</a> ⇒</dt>
+<dd><p>Constructs and returns data for indexed cart (algolia or addio)</p></dd>
+<dt><a href="#getCartPromo">getCartPromo</a></dt>
+<dd><p>Check if current cart promos applied contain a promo_code type promotion</p></dd>
+<dt><a href="#shouldCheckPromoCode">shouldCheckPromoCode</a></dt>
+<dd><p>Check if a discount rule applies to a specific declination</p></dd>
+<dt><a href="#shouldApplyRuleToDeclination">shouldApplyRuleToDeclination</a></dt>
+<dd><p>Check if a specific rule of a discount rule is respected</p></dd>
+<dt><a href="#getResultRuleDetail">getResultRuleDetail</a></dt>
+<dd><p>Check if rule applied to product attributes is respected for specific declination attributes</p></dd>
+<dt><a href="#getCartPromoType">getCartPromoType</a></dt>
+<dd><p>Check if promo code can be applied to a specific cart</p></dd>
+<dt><a href="#checkPromoCodeEligibility">checkPromoCodeEligibility</a></dt>
+<dd><p>Returns tier pricing step that should be applied for provided quantity, or undefined if none should apply</p></dd>
+<dt><a href="#getTierPricingToApply">getTierPricingToApply</a></dt>
+<dd><p>Converts tier-pricing found in discount_rule to IIndexedTierPricing.</p></dd>
+<dt><a href="#applyTierPricing">applyTierPricing</a></dt>
+<dd><p>Calculate new discount_price object for cart item base on qte and tier_pricing</p></dd>
+<dt><a href="#getNewDiscountPriceFromTierPricing">getNewDiscountPriceFromTierPricing</a></dt>
+<dd><p>Get discounted price after applying discount rules to a provided price</p></dd>
+<dt><a href="#applyDiscountRulesOnProduct">applyDiscountRulesOnProduct</a></dt>
+<dd><p>Get result of discount rule discount on a provided amount</p></dd>
+<dt><a href="#applyDiscountToPrice">applyDiscountToPrice</a> ⇒</dt>
+<dd><p>Get sku(s) affected by a promo as an array of strings</p></dd>
+<dt><a href="#getSkuArrayForPromo">getSkuArrayForPromo</a> ⇒</dt>
+<dd><p>Returns a list of all skus where promo applied to specific products should apply. Check for both amount/percent_sku and amount/percent_category options.</p></dd>
+<dt><a href="#getResultAppliedDiscountSkus">getResultAppliedDiscountSkus</a> ⇒</dt>
+<dd><p>Creates array of all category level slugs for a cart item.</p></dd>
+<dt><a href="#getItemCategorySlugArray">getItemCategorySlugArray</a></dt>
+<dd><p>Apply all valid discounts found in a specific cart's discount_rules props to cart</p></dd>
+<dt><a href="#applyDiscountToCart">applyDiscountToCart</a></dt>
+<dd><p>Get the ICartPromoApplied object for a specified discount_rule. Only works for promos that do not apply to products of certain categories/skus.</p></dd>
+<dt><a href="#getStandardCartPromoFromDiscount">getStandardCartPromoFromDiscount</a> ⇒</dt>
+<dd><p>Calculates the cumulative subtotal for all service/fee type items in cart, including any applied promos. Usefull when calculating a promo's amount when all fees and services should be excluded.</p></dd>
+<dt><a href="#checkIfCouldApplyIncentivePromo">checkIfCouldApplyIncentivePromo</a></dt>
+<dd><p>Calculates amount to be removed for payment incentive type promos.</p></dd>
+<dt><a href="#getAfterTaxesPromosTotalAmount">getAfterTaxesPromosTotalAmount</a></dt>
+<dd><p>Returns cart_promos_applied corresponding to payment incentive, if found. Can also check in discount_rules if props provided</p></dd>
+<dt><a href="#getAfterTaxesPromoInCart">getAfterTaxesPromoInCart</a></dt>
+<dd><p>Returns the information regarding the payment incentive promo if found in cart's discount_rules</p></dd>
+<dt><a href="#unitShortDict">unitShortDict</a> ⇒ <code>ILang</code></dt>
+<dd><p>Returns the dictionnary containing the shortened version of unit labels in multiple languages</p></dd>
+<dt><a href="#getConvertedUnitQuantity">getConvertedUnitQuantity</a></dt>
+<dd><p>Constructs object with detailled inventory quantities by unit (based on other_units for product)</p></dd>
+<dt><a href="#getQty">getQty</a></dt>
+<dd><p>Calculates inventory unit quantity for function getQty</p></dd>
+<dt><a href="#recursiveCheckObject">recursiveCheckObject</a> ⇒</dt>
+<dd><p>Updates value of object by checking recursivly.</p></dd>
+<dt><a href="#getOrderedPromises">getOrderedPromises</a> ⇒</dt>
+<dd><p>Checks list of promises for applicable banks based on space bank types.</p></dd>
+<dt><a href="#checkForApplicableBanks">checkForApplicableBanks</a></dt>
+<dd><p>Returns if a promise is currently active. Promise is active if it is not archived, and if current date is same or after starting_date, and before ending_date (if defined).</p></dd>
+<dt><a href="#checkIfOtherBankOfSameTypeIsActive">checkIfOtherBankOfSameTypeIsActive</a></dt>
+<dd><p>Returns translated name for a provided bank type ID.</p></dd>
+<dt><a href="#getBankTypeName">getBankTypeName</a></dt>
+<dd><p>Calculates the remaining amount for a specific promise's bank</p></dd>
+<dt><a href="#getIndexedByCustomerPromiseValues">getIndexedByCustomerPromiseValues</a> ⇒</dt>
+<dd><p>Returns the most recently emptied bank of a given type</p></dd>
+<dt><a href="#getIndexServices">getIndexServices</a></dt>
+<dd><p>Save new entry objects to provided search index services</p></dd>
+<dt><a href="#saveNewEntryToIndex">saveNewEntryToIndex</a></dt>
+<dd><p>Save a partial object entry to provided search index services.</p></dd>
+<dt><a href="#partialSaveNewEntryToIndex">partialSaveNewEntryToIndex</a></dt>
+<dd><p>Returns an object with base info needed to call Algolia/AddioSearch with search query.</p></dd>
+<dt><a href="#getFetchInfoAlgoliaAddioSearch">getFetchInfoAlgoliaAddioSearch</a></dt>
+<dd><p>Fetch entries from either algolia or AddioSearch (prospr) for a provided index. Client-side only!</p></dd>
+<dt><a href="#fetchEntriesAlgoliaAddioSearch">fetchEntriesAlgoliaAddioSearch</a></dt>
+<dd><p>Returns search result from active search index service. Server-side friendly!</p></dd>
+</dl>
+
+## Constants
+
+<dl>
+<dt><a href="#isTestEnv">isTestEnv</a></dt>
+<dd><p>TBSDK - SDK Manager</p>
+<p>Client SDK to access TheBEAST eCommerce</p></dd>
+<dt><a href="#spaceInitData">spaceInitData</a></dt>
+<dd><p>Use this object to change which space is being tested!</p></dd>
+</dl>
+
+## Functions
+
+<dl>
+<dt><a href="#getMinDatePicker">getMinDatePicker()</a></dt>
+<dd><p>Sets the minimum shipping day for delivery</p></dd>
+<dt><a href="#getProductSellUnitLabel">getProductSellUnitLabel(otherUnits, locale, returnUnitForSlugs)</a> ⇒ <code>string</code></dt>
+<dd><p>Returns sell unit label in correct language for a specific product's other_units</p></dd>
+<dt><a href="#splitOnDashes">splitOnDashes(stringToSplit)</a> ⇒ <code>Array.&lt;string&gt;</code></dt>
+<dd></dd>
+<dt><a href="#getRandomValue">getRandomValue(val, type)</a> ⇒</dt>
+<dd><p>Replace a value with anonymized value</p></dd>
+<dt><a href="#getCartPromo">getCartPromo(cartData)</a></dt>
+<dd><p>Get formatted array of cart promos applied to a specific cart</p></dd>
+<dt><a href="#_checkRuleApplicationArray">_checkRuleApplicationArray(checkedRulesApplicationArray)</a> ⇒</dt>
+<dd><p>Checks if discount rule should be applied to cart based on each rule verification results.</p></dd>
+<dt><a href="#checkIfCouldApplyIncentivePromo">checkIfCouldApplyIncentivePromo(cartData, skipCheckFor)</a> ⇒</dt>
+<dd><p>Checks if an incentive discount could (in theory) by added to provided cart, by checking found incentive discount's rule array.</p></dd>
+<dt><a href="#getOrderedPromises">getOrderedPromises(promises)</a></dt>
+<dd><p>Get ordered array of promise data objects by starting date.</p></dd>
+<dt><a href="#getIndexServices">getIndexServices(space, partialIndexID)</a></dt>
+<dd><p>Returns objet with possible index service instances
+As of now, checks for Algolia and Addio Search</p></dd>
+</dl>
+
+<a name="Brand"></a>
+
+## Brand
+
+<p>Brand class</p>
+
+**Kind**: global class  
+<a name="Catalogue"></a>
+
+## Catalogue
+
+<p>Catalogue class</p>
+
+**Kind**: global class  
+<a name="Customer"></a>
+
+## Customer
+
+<p>Customer class</p>
+
+**Kind**: global class  
+<a name="Discount"></a>
+
+## Discount
+
+<p>Brand class</p>
+
+**Kind**: global class  
+<a name="Invoice"></a>
+
+## ~~Invoice~~
+
+**_Deprecated_**
+
+**Kind**: global class  
+<a name="Order"></a>
+
+## ~~Order~~
+
+**_Deprecated_**
+
+**Kind**: global class  
+<a name="Org"></a>
+
+## Org
+
+<p>Class Org - Organization
+Represent an organization created by a user. An organization can have multiple space.</p>
+
+**Kind**: global class  
+<a name="new_Org_new"></a>
+
+### new Org(org, org_ref, user)
+
+<p>Organization constructor</p>
+
+| Param   | Description                          |
+| ------- | ------------------------------------ |
+| org     | <p>Organization to construct</p>     |
+| org_ref | <p>Reference to the organization</p> |
+| user    | <p>Authfificated user</p>            |
+
+<a name="Product"></a>
+
+## Product
+
+<p>Product class</p>
+
+**Kind**: global class  
+<a name="PurchaseOrder"></a>
+
+## PurchaseOrder
+
+<p>Brand class</p>
+
+**Kind**: global class  
+<a name="Service"></a>
+
+## Service
+
+<p>Service class</p>
+
+**Kind**: global class  
+<a name="Service+add"></a>
+
+### service.add(newService) ⇒
+
+<p>Add a new service</p>
+
+**Kind**: instance method of [<code>Service</code>](#Service)  
+**Returns**: <p>IAddServiceResponse</p>
+
+| Param      | Description                          |
+| ---------- | ------------------------------------ |
+| newService | <p>IService: new service to add.</p> |
+
+<a name="Space"></a>
+
+## Space
+
+<p>Class Space
+A Space represent a company.</p>
+
+**Kind**: global class  
+<a name="User"></a>
+
+## User
+
+<p>User class</p>
+
+**Kind**: global class  
+<a name="new_User_new"></a>
+
+### new User(options, version, orgID)
+
+<p>Fetch user from database for current org</p>
+
+| Param   | Description                                                                                                                                          |
+| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
+| options | <p>Parameters for database query. Only one will be checked at a time, in order of &quot;importance&quot; : email &gt; username &gt; external_id.</p> |
+| version | <p>The app version to check</p>                                                                                                                      |
+| orgID   | <p>Optionnal, but must be provided if function is called from the backend (used to find user's organization).</p>                                    |
+
+<a name="ProsprSearch"></a>
+
+## ProsprSearch
+
+<p>À NOTER - Prospr est l'ancien nom du ecomm, est depuis devenu Addio.
+Il faudra éventuellement faire le refactoring nécessaire pour remplacer toutes les appelations,
+mais en attendant, c'est normal qu'il y ait les deux noms à différents endroits.</p>
+
+**Kind**: global class  
+<a name="CustomerTypeEnum"></a>
+
+## CustomerTypeEnum
+
+<p>ICustomer interface</p>
+<p>Représente un client (customer). Un client peut:</p>
+<ul>
+<li>Faire des recherches parmis les différents items du commerçant</li>
+<li>Afficher une fiche cliente</li>
+</ul>
+
+**Kind**: global variable  
+<a name="getDefaultDiscountRule"></a>
+
+## getDefaultDiscountRule
+
+<p>Exemple:</p>
+<p>Product = 5.00$</p>
+<p>Discount rule:
+quantity &gt;= 10 ? remove 2</p>
+<p>Result:
+If applied to cart:
+11 Product = (before) 55.00$ (after) 53.00$</p>
+<p>attribute color == red ? percent 10
+1 red Product = (before) 5.00$ (after) 4.50$</p>
+<p>attribute color == red ? percent -20
+1 red Product = (before) 5.00$ (after) 6.00$</p>
+
+**Kind**: global variable  
+<a name="installationProductsSlugs"></a>
+
+## installationProductsSlugs
+
+<p>Contains all necessary elements for extra questions if adding grass product to cart</p>
+
+**Kind**: global variable  
+<a name="getConcreteCartInfo"></a>
+
+## getConcreteCartInfo
+
+<ul>
+<li>Create the essential info needed when checking a grass type product for cart</li>
+</ul>
+
+**Kind**: global variable
+
+| Param |
+| ----- |
+| item  |
+
+<a name="getMinDateOffset"></a>
+
+## getMinDateOffset
+
+<p>compares date with blockedDates from DB and blocked days (currently hardcoded in function)</p>
+
+**Kind**: global variable
+
+| Param            | Description                  |
+| ---------------- | ---------------------------- |
+| date             | <p>Date to check</p>         |
+| blockedDates     | <p>Blocked dates from DB</p> |
+| expeditionMethod | <p>pickup or shipping</p>    |
+| cartData         |                              |
+
+<a name="shouldDisableDate"></a>
+
+## shouldDisableDate
+
+<p>checks if type of cart corresponds to a blockedDates array and if array has dates defined</p>
+
+**Kind**: global variable
+
+| Param        |
+| ------------ |
+| cartData     |
+| blockedDates |
+
+<a name="installationFeePalletTier"></a>
+
+## installationFeePalletTier
+
+<p>Calculates fees that should be applied to provided cart, and fetches them from database or fee array if provided.
+Returns the items to add, update and delete, as well as other cart info to set after fees.
+** Optimized version possible, where address zones and distance are calculated before and properties are sent directly to function
+** Optimized version reverted, logic found in commit here : [#2087b32](https://github.com/ciaoqc/gng-tb-admin-sdk/commit/2087b3207df9e5916a979b8bb255abc2a4c1dac6)</p>
+
+**Kind**: global variable
+
+| Param                       |
+| --------------------------- |
+| fetchProduct                |
+| getIfAddressIsInsideZones   |
+| getDistanceFromAddress      |
+| cart                        |
+| expeditionMethod            |
+| grassProduct                |
+| concreteOrder               |
+| cartContainsInstallation    |
+| cartContainsVrac            |
+| isPro                       |
+| addOnePalletToPickup        |
+| cartContainsSample          |
+| saveToShippingPayload       |
+| deliveryAddress             |
+| locale                      |
+| expeditionDate              |
+| equipmentPickupOnSite       |
+| cartContainsOnlyAccessories |
+| pickupStore                 |
+| allStores                   |
+| customPriceList             |
+| useFeeArray                 |
+
+<a name="applyFeesToCart"></a>
+
+## applyFeesToCart
+
+<p>Checks if sample shipping fee should be removed from cart depending on cart items found in cart.
+** Optimized version possible using brand name instead of brand id, removing async check.
+** Optimized version reverted, logic found in commit here : [#2087b32](https://github.com/ciaoqc/gng-tb-admin-sdk/commit/2087b3207df9e5916a979b8bb255abc2a4c1dac6)</p>
+
+**Kind**: global variable
+
+| Param        |
+| ------------ |
+| fetchProduct |
+| cart         |
+| locale       |
+| useFeeArray  |
+
+<a name="calculateShippingForVrac"></a>
+
+## calculateShippingForVrac ⇒
+
+<p>checks if cart expired using the updated_at date stored in the shipping_payload</p>
+
+**Kind**: global variable  
+**Returns**: <p>boolean</p>
+
+| Param         |
+| ------------- |
+| cartData      |
+| grassProduct  |
+| concreteOrder |
+| isPro         |
+| isSample      |
+
+<a name="transformG2CustomerToCustomer"></a>
+
+## transformG2CustomerToCustomer
+
+<p>Verifies if customer exists in G2.</p>
+
+**Kind**: global variable
+
+| Param      | Description                     |
+| ---------- | ------------------------------- |
+| customerID | <p>Customer ID for G2 fetch</p> |
+| space      | <p>Space Object</p>             |
+| org        | <p>Org Object</p>               |
+
+<a name="checkIfCustomerExistsInG2"></a>
+
+## checkIfCustomerExistsInG2
+
+<p>Updates customer in database with new info found in G2.</p>
+
+**Kind**: global variable
+
+| Param          | Description                                                                  |
+| -------------- | ---------------------------------------------------------------------------- |
+| customerID     | <p>Customer ID for G2 fetch</p>                                              |
+| space          | <p>Space Object</p>                                                          |
+| org            | <p>Org Object</p>                                                            |
+| addToDB        | <p>if updated customer should be saved to database (defaults to true)</p>    |
+| skipEmailCheck | <p>if check for unique email should be skiped or not (defaults to false)</p> |
+
+<a name="getCustomPriceList"></a>
+
+## getCustomPriceList
+
+<p>Get promise to purchase additionnal escompte equivalent from customPriceList for specific cart item</p>
+
+**Kind**: global variable
+
+| Param           | Description                                |
+| --------------- | ------------------------------------------ |
+| customPriceList | <p>The pro customers custom price list</p> |
+| item            | <p>The cart item to check</p>              |
+
+<a name="getFittingUnits"></a>
+
+## getFittingUnits ⇒
+
+<p>Returns string corresponding to provided cart's type.</p>
+
+**Kind**: global variable  
+**Returns**: <p>a string containing the order type</p>
+
+| Param    | Description                                                                 |
+| -------- | --------------------------------------------------------------------------- |
+| cartData | <p>Corresponding cart</p>                                                   |
+| frOnly   | <p>If true, forces french string,</p>                                       |
+| slugSafe | <p>If true, will always return a slug-safe string (with string_to_slug)</p> |
+
+<a name="getProductSellUnitLabel"></a>
+
+## getProductSellUnitLabel ⇒ <code>string</code>
+
+<p>Returns the plural unit label for a specific slug</p>
+
+**Kind**: global variable  
+**Returns**: <code>string</code> - <p>The plural unit label</p>
+
+| Param              | Type                                          | Description                                                                                       |
+| ------------------ | --------------------------------------------- | ------------------------------------------------------------------------------------------------- |
+| unitSlug           | <code>string</code>                           | <p>The slug of the unit for which we want to get the label</p>                                    |
+| locale             | <code>string</code> \| <code>undefined</code> | <p>The language in which we want to get the label</p>                                             |
+| returnUnitForSlugs | <code>Array.&lt;string&gt;</code>             | <p>The slugs for which we want to return a default value, in this case the unit slug for unit</p> |
+
+<a name="getDescriptionString"></a>
+
+## getDescriptionString
+
+<p>Returns rounded product quantities depending on current value, value of secondary input if existant and sale unit per command step ratio found in product.</p>
+
+**Kind**: global variable
+
+| Param                  | Type                                                                       | Description                                                                     |
+| ---------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
+| value                  | <code>number</code>                                                        | <p>Current quantity as entered by user in first input</p>                       |
+| otherUnits             | <code>Array.&lt;IFilledDimensionUnits&gt;</code> \| <code>undefined</code> | <p>FilledDimensionUnits found in product (possibly undefined)</p>               |
+| value2                 | <code>number</code> \| <code>undefined</code>                              | <p>Current quantity as entered by user in second input (possibly undefined)</p> |
+| targetIsSecondaryInput | <code>boolean</code>                                                       | <p>If action was triggered from secondary input (defaults to false)</p>         |
+
+<a name="splitOnDashes"></a>
+
+## splitOnDashes ⇒ <code>Array.&lt;string&gt;</code>
+
+<p>Get product name as array. Array created mostly by splitting name on dash symbol (and variations).</p>
+
+**Kind**: global variable  
+**Returns**: <code>Array.&lt;string&gt;</code> - <ul>
+
+<li>Position 0 is the &quot;commum section&quot; of the name, and position 1 should contain all specifics (ex. color, size, etc...)</li>
+</ul>
+
+| Param   | Type                                                                  |
+| ------- | --------------------------------------------------------------------- |
+| product | <code>IIndexedVariationAlgolia</code> \| <code>IIndexedProduct</code> |
+| locale  | <code>string</code> \| <code>undefined</code>                         |
+
+<a name="getProdName"></a>
+
+## getProdName
+
+<p>Function getParentProductCategoryGroup</p>
+
+**Kind**: global variable
+
+| Param | Description             |
+| ----- | ----------------------- |
+| prod  | <p>Product to check</p> |
+
+<a name="getParentProductCategoryGroup"></a>
+
+## getParentProductCategoryGroup
+
+<p>Function getProductFormOptions - Returns all AttributeValues for product to construct options in add to cart form</p>
+
+**Kind**: global variable
+
+| Param      | Description                                    |
+| ---------- | ---------------------------------------------- |
+| product    | <p>Product to check</p>                        |
+| attributes | <p>Array of IAttributes to fetch info from</p> |
+
+<a name="getProductFormOptions"></a>
+
+## getProductFormOptions ⇒
+
+<p>Checks if product is of type by checking TYPE attribute value. Works with indexed product or cart item.</p>
+
+**Kind**: global variable  
+**Returns**: <p>boolean</p>
+
+| Param            |
+| ---------------- |
+| product          |
+| type             |
+| excludeUndefined |
+
+<a name="checkIfProductIsInstallation"></a>
+
+## checkIfProductIsInstallation
+
+<p>Returns array of installation items found in provided array</p>
+
+**Kind**: global variable
+
+| Param | Description                                                 |
+| ----- | ----------------------------------------------------------- |
+| items | <p>Array of cart items or IIndexedDeclinations to check</p> |
+
+<a name="getAllInstallFromItems"></a>
+
+## getAllInstallFromItems
+
+<ul>
+<li>Returns items with only one apparent grass product (used for detail customers).
+** FOR DISPLAY PURPOSES ONLY - Always save grass products separatly in ICart **</li>
+</ul>
+
+**Kind**: global variable
+
+| Param          | Description                                                           |
+| -------------- | --------------------------------------------------------------------- |
+| recursiveItems | <p>ICartItems with subitems (object created for display purposes)</p> |
+
+<a name="getGrassSubQuestionsByType"></a>
+
+## getGrassSubQuestionsByType ⇒
+
+<p>For grass products. Over 1480pi2, if installation, quantities are rounded to rolls (10pi2) if pickup, and to half pal. if shipping</p>
+
+**Kind**: global variable  
+**Returns**: <p>quantity rounded to rolls with items to change or undefined</p>
+
+| Param        |
+| ------------ |
+| grassProduct |
+| cartData     |
+
+<a name="handleGrassProductQtyRoundForShipping"></a>
+
+## handleGrassProductQtyRoundForShipping
+
+<p>Returns rounded grass quantity depending on current qty, if customer selected installation and pallet unit (if defined)</p>
+
+**Kind**: global variable
+
+| Param      | Type                                                         | Description                                              |
+| ---------- | ------------------------------------------------------------ | -------------------------------------------------------- |
+| currentQte | <code>number</code>                                          | <p>Current quantity as entered by user in input</p>      |
+| isShipping | <code>boolean</code>                                         | <p>Whether customer has selected installation option</p> |
+| palUnit    | <code>IFilledDimensionUnits</code> \| <code>undefined</code> | <p>Pallet FilledDimensionUnit (possibly undefined)</p>   |
+
+<a name="getConcreteQteText"></a>
+
+## getConcreteQteText
+
+<p>returns all items in cart where attribute AVAILABILITY contains wanted type.</p>
+
+**Kind**: global variable
+
+| Param            |
+| ---------------- |
+| cartData         |
+| availabilityType |
+
+<a name="getConcreteItemsByAvailability"></a>
+
+## getConcreteItemsByAvailability ⇒
+
+<p>Function getVracType - constructs vrac helper object is cart contains vrac or vrac associated items.</p>
+
+**Kind**: global variable  
+**Returns**: <p>IVracType object containing vrac_type enum value and vrac_store_ids where vrac items are available</p>
+
+| Param                    |
+| ------------------------ |
+| stores                   |
+| cartData                 |
+| getInventoryItemCallback |
+
+<a name="fetchFeesBeforeCart"></a>
+
+## fetchFeesBeforeCart
+
+<p>Check if pro custom promo info should be shown for customer for a specific product.</p>
+
+**Kind**: global variable
+
+| Param          |
+| -------------- |
+| userData       |
+| isPro          |
+| product        |
+| customMinPrice |
+
+<a name="calculateUpsellQte"></a>
+
+## calculateUpsellQte
+
+<ul>
+<li>checks all upsells in product and returns those where associated quantities are found.</li>
+</ul>
+
+**Kind**: global variable
+
+| Param          | Description                                                                     |
+| -------------- | ------------------------------------------------------------------------------- |
+| upsellProducts | <p>All upsells in product</p>                                                   |
+| cartItems      | <p>All current cart items</p>                                                   |
+| checkQte       | <p>If all upsells should be checked for quantity</p>                            |
+| alwaysShow     | <p>If upsell should be considered even if it already exists in cart as item</p> |
+
+<a name="getUpsellsToQuantify"></a>
+
+## getUpsellsToQuantify
+
+<ul>
+<li>Returns upsell equivalence text</li>
+</ul>
+
+**Kind**: global variable
+
+| Param             | Description                                              |
+| ----------------- | -------------------------------------------------------- |
+| upsellsToQuantify | <p>All upsells to show in text</p>                       |
+| qte               | <p>Associated product quantity</p>                       |
+| specificProduct   | <p>If upsell shown is a specific products</p>            |
+| isMulti           | <p>If upsell if shared by more than one item in cart</p> |
+| locale            | <p>locale of string to return</p>                        |
+
+<a name="getGeneralUpsellQteText"></a>
+
+## getGeneralUpsellQteText
+
+<ul>
+<li>Returns quantity stinrg and upsell name to show in Upsell Quantity indicator</li>
+</ul>
+
+**Kind**: global variable
+
+| Param      | Description                                                 |
+| ---------- | ----------------------------------------------------------- |
+| upsell     | <p>Upsell to show qyantity for</p>                          |
+| productQte | <p>Quantity of associated product for ratio calculation</p> |
+| locale     | <p>locale of string to return</p>                           |
+
+<a name="checkIfCartContainsException"></a>
+
+## checkIfCartContainsException
+
+<p>Function getCartItemsFromProdUpsells</p>
+
+**Kind**: global variable
+
+| Param      | Type                                              | Description                                                                                  |
+| ---------- | ------------------------------------------------- | -------------------------------------------------------------------------------------------- |
+| qte        | <code>number</code>                               | <p>Quantity of product to which upsell is associated</p>                                     |
+| currentSku | <code>string</code>                               | <p>Sku of the declination selected by user for the product to which upsell is associated</p> |
+| prodUpsell | <code>Array.&lt;IProductRecommendation&gt;</code> | <p>Array of upsells found in product</p>                                                     |
+| getProduct |                                                   | <p>Callback function to fetch product from DB</p>                                            |
+| locale     | <code>string</code>                               | <p>locale for product fetch (defaults to 'fr')</p>                                           |
+
+<a name="mockCustomPriceList"></a>
+
+## mockCustomPriceList
+
+<p>Takes in a function and checks for error</p>
+
+**Kind**: global variable
+
+| Param   | Type                           | Description                                         |
+| ------- | ------------------------------ | --------------------------------------------------- |
+| method  | <code>function</code>          | <p>The function to check</p>                        |
+| params  | <code>Array.&lt;any&gt;</code> | <p>The array of function parameters</p>             |
+| message | <code>string</code>            | <p>Optional message to match with error message</p> |
+
+<a name="getRandomValue"></a>
+
+## getRandomValue ⇒
+
+<p>Get an object property value</p>
+
+**Kind**: global variable  
+**Returns**: <p>the property value</p>
+
+| Param | Description                            |
+| ----- | -------------------------------------- |
+| obj   | <p>The object to scan</p>              |
+| props | <p>The path of the property to get</p> |
+
+<a name="getObjectProperty"></a>
+
+## getObjectProperty ⇒
+
+<p>Set an object property to an anonymized value if it exists</p>
+
+**Kind**: global variable  
+**Returns**: <p>The object with the edited value</p>
+
+| Param | Description                                       |
+| ----- | ------------------------------------------------- |
+| obj   | <p>The object to look into</p>                    |
+| props | <p>The property path</p>                          |
+| type  | <p>The property type used to shuffle the data</p> |
+
+<a name="setObjectProperty"></a>
+
+## setObjectProperty ⇒
+
+<p>Anonymise the customer data if in test env</p>
+
+**Kind**: global variable  
+**Returns**: <p>The new customer data</p>
+
+| Param | Description              |
+| ----- | ------------------------ |
+| c     | <p>The customer data</p> |
+
+<a name="getCurrentProvince"></a>
+
+## getCurrentProvince ⇒
+
+<p>Constructs and returns data for indexed cart (algolia or addio)</p>
+
+**Kind**: global variable  
+**Returns**: <IIndexedCart>
+
+| Param                | Description                                                               |
+| -------------------- | ------------------------------------------------------------------------- |
+| cartData             | <p>Current cart data</p>                                                  |
+| space                | <p>Space object</p>                                                       |
+| setPaidAtIfUndefined | <p>Optionnal - If true, will set paid_at with current date</p>            |
+| customer             | <p>Optionnal - If defined, adds info based on customer to indexedCart</p> |
+
+<a name="getCartPromo"></a>
+
+## getCartPromo
+
+<p>Check if current cart promos applied contain a promo_code type promotion</p>
+
+**Kind**: global variable
+
+| Param    |
+| -------- |
+| cartData |
+
+<a name="shouldCheckPromoCode"></a>
+
+## shouldCheckPromoCode
+
+<p>Check if a discount rule applies to a specific declination</p>
+
+**Kind**: global variable
+
+| Param         | Description                       |
+| ------------- | --------------------------------- |
+| discount_rule | <p>The discount rule to check</p> |
+| declination   | <p>The declination to compare</p> |
+
+<a name="shouldApplyRuleToDeclination"></a>
+
+## shouldApplyRuleToDeclination
+
+<p>Check if a specific rule of a discount rule is respected</p>
+
+**Kind**: global variable
+
+| Param      | Description                                          |
+| ---------- | ---------------------------------------------------- |
+| ruleDetail | <p>The rule details object to check</p>              |
+| cartValue  | <p>The value to compare with rule specifications</p> |
+
+<a name="getResultRuleDetail"></a>
+
+## getResultRuleDetail
+
+<p>Check if rule applied to product attributes is respected for specific declination attributes</p>
+
+**Kind**: global variable
+
+| Param                    | Description                                   |
+| ------------------------ | --------------------------------------------- |
+| attributeAndValues       | <p>The rule details object to check</p>       |
+| arrDeclinationAttributes | <p>The declinations attributes to compare</p> |
+
+<a name="getCartPromoType"></a>
+
+## getCartPromoType
+
+<p>Check if promo code can be applied to a specific cart</p>
+
+**Kind**: global variable
+
+| Param     | Description                                       |
+| --------- | ------------------------------------------------- |
+| cart      | <p>The cart to check</p>                          |
+| promoCode | <p>The discount rule with promo code to check</p> |
+
+<a name="checkPromoCodeEligibility"></a>
+
+## checkPromoCodeEligibility
+
+<p>Returns tier pricing step that should be applied for provided quantity, or undefined if none should apply</p>
+
+**Kind**: global variable
+
+| Param              | Description                                    |
+| ------------------ | ---------------------------------------------- |
+| tierPricingToCheck | <p>the indexed tier-pricing array to check</p> |
+| qte                |                                                |
+
+<a name="getTierPricingToApply"></a>
+
+## getTierPricingToApply
+
+<p>Converts tier-pricing found in discount_rule to IIndexedTierPricing.</p>
+
+**Kind**: global variable
+
+| Param        | Description                                                                    |
+| ------------ | ------------------------------------------------------------------------------ |
+| discountRule | <p>the tier-pricing tier discountRule to check</p>                             |
+| price        | <p>declinations regular price from which tier-pricing result is calculated</p> |
+| space        |                                                                                |
+| decimals     | <p>the amount of decimals to show on tier-pricing result</p>                   |
+
+<a name="applyTierPricing"></a>
+
+## applyTierPricing
+
+<p>Calculate new discount_price object for cart item base on qte and tier_pricing</p>
+
+**Kind**: global variable
+
+| Param            | Description                                                                           |
+| ---------------- | ------------------------------------------------------------------------------------- |
+| item             | <p>the item to check</p>                                                              |
+| setOriginalPrice | <p>if original_amount should be set instead of discount_price.amount</p>              |
+| originalDecli    | <p>Optionnal. The IIndexedDeclination used to construct the cart item originally.</p> |
+
+<a name="getNewDiscountPriceFromTierPricing"></a>
+
+## getNewDiscountPriceFromTierPricing
+
+<p>Get discounted price after applying discount rules to a provided price</p>
+
+**Kind**: global variable
+
+| Param          | Description                                           |
+| -------------- | ----------------------------------------------------- |
+| discount_rules | <p>The discount rules to apply</p>                    |
+| amount         | <p>The initial amount on which to apply discounts</p> |
+| space          |                                                       |
+
+<a name="applyDiscountRulesOnProduct"></a>
+
+## applyDiscountRulesOnProduct
+
+<p>Get result of discount rule discount on a provided amount</p>
+
+**Kind**: global variable
+
+| Param             | Description                                     |
+| ----------------- | ----------------------------------------------- |
+| initial           | <p>The price on which to apply the discount</p> |
+| discountResultObj | <p>The discount rule result object</p>          |
+
+<a name="applyDiscountToPrice"></a>
+
+## applyDiscountToPrice ⇒
+
+<p>Get sku(s) affected by a promo as an array of strings</p>
+
+**Kind**: global variable  
+**Returns**: <p>And array of strings</p>
+
+| Param          | Description                                           |
+| -------------- | ----------------------------------------------------- |
+| valueToConvert | <p>The sku or sku array associated with the promo</p> |
+
+<a name="getSkuArrayForPromo"></a>
+
+## getSkuArrayForPromo ⇒
+
+<p>Returns a list of all skus where promo applied to specific products should apply. Check for both amount/percent_sku and amount/percent_category options.</p>
+
+**Kind**: global variable  
+**Returns**: <p>An array of strings</p>
+
+| Param        | Description                   |
+| ------------ | ----------------------------- |
+| cartItems    | <p>The current cart items</p> |
+| promoToCheck | <p>The promo to check</p>     |
+
+<a name="getResultAppliedDiscountSkus"></a>
+
+## getResultAppliedDiscountSkus ⇒
+
+<p>Creates array of all category level slugs for a cart item.</p>
+
+**Kind**: global variable  
+**Returns**: <p>An array of strings</p>
+
+| Param          | Description                                 |
+| -------------- | ------------------------------------------- |
+| itemCategories | <p>Value found in props cart.categories</p> |
+
+<a name="getItemCategorySlugArray"></a>
+
+## getItemCategorySlugArray
+
+<p>Apply all valid discounts found in a specific cart's discount_rules props to cart</p>
+
+**Kind**: global variable
+
+| Param         | Description                                                                       |
+| ------------- | --------------------------------------------------------------------------------- |
+| cart          | <p>The cart to check</p>                                                          |
+| isMultiPromo  |                                                                                   |
+| forceShipping | <p>If cart should be considered as a shipping cart, even if is_pickup is true</p> |
+
+<a name="applyDiscountToCart"></a>
+
+## applyDiscountToCart
+
+<p>Get the ICartPromoApplied object for a specified discount_rule. Only works for promos that do not apply to products of certain categories/skus.</p>
+
+**Kind**: global variable
+
+| Param |
+| -------getConvertedUnitQuantity
+| cart |
+| discount |
+
+<a name="getStandardCartPromoFromDiscount"></a>
+
+## getStandardCartPromoFromDiscount ⇒
+
+<p>Calculates the cumulative subtotal for all service/fee type items in cart, including any applied promos. Usefull when calculating a promo's amount when all fees and services should be excluded.</p>
+
+**Kind**: global variable  
+**Returns**: <p>A number</p>
+
+| Param                         | Description                                                                                                                                |
+| ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
+| cartData                      | <p>The cartData to check</p>                                                                                                               |
+| allCurrentAppliedToItemPromos | <p>All currently active cartPromos that apply to items in cart. Sent seperatly in case local state is different from current cartData.</p> |
+
+<a name="checkIfCouldApplyIncentivePromo"></a>
+
+## checkIfCouldApplyIncentivePromo
+
+<p>Calculates amount to be removed for payment incentive type promos.</p>
+
+**Kind**: global variable
+
+| Param              | Description                                                                                                |
+| ------------------ | ---------------------------------------------------------------------------------------------------------- |
+| cartData           |                                                                                                            |
+| checkDiscountRules | <p>Optionnal. If cart discount_rules should be checked if cart_promos_applied does not have promo yet.</p> |
+
+<a name="getAfterTaxesPromosTotalAmount"></a>
+
+## getAfterTaxesPromosTotalAmount
+
+<p>Returns cart_promos_applied corresponding to payment incentive, if found. Can also check in discount_rules if props provided</p>
+
+**Kind**: global variable
+
+| Param              | Description                                                                                                   |
+| ------------------ | ------------------------------------------------------------------------------------------------------------- |
+| cartData           |                                                                                                               |
+| checkDiscountRules | <p>Optionnal. If the function should check in cart discount_rules if nothing found in cart_promos_applied</p> |
+
+<a name="getAfterTaxesPromoInCart"></a>
+
+## getAfterTaxesPromoInCart
+
+<p>Returns the information regarding the payment incentive promo if found in cart's discount_rules</p>
+
+**Kind**: global variable
+
+| Param    |
+| -------- |
+| cartData |
+
+<a name="unitShortDict"></a>
+
+## unitShortDict ⇒ <code>ILang</code>
+
+<p>Returns the dictionnary containing the shortened version of unit labels in multiple languages</p>
+
+**Kind**: global variable  
+**Returns**: <code>ILang</code> - <p>The dictionnary containing the shortened unit label in multiple languages</p>
+
+| Param              | Type                              | Description                                                                                                           |
+| ------------------ | --------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
+| slug               | <code>string</code>               | <p>The slug for which we want to get the shortened dictionnary</p>                                                    |
+| returnUnitForSlugs | <code>Array.&lt;string&gt;</code> | <p>An array of slugs that we want to return a default dictionnary for, in this case the unit dictionnary for unit</p> |
+
+<a name="getConvertedUnitQuantity"></a>
+
+## getConvertedUnitQuantity
+
+<p>Constructs object with detailled inventory quantities by unit (based on other_units for product)</p>
+
+**Kind**: global variable
+
+| Param                 | Description      |
+| --------------------- | ---------------- |
+| other_units           |                  |
+| inventoryQuantity     |                  |
+| isGrass               |                  |
+| showNegativeInventory | <p>optionnal</p> |
+
+<a name="getQty"></a>
+
+## getQty
+
+<p>Calculates inventory unit quantity for function getQty</p>
+
+**Kind**: global variable
+
+| Param             |
+| ----------------- |
+| value             |
+| isUnitFittingUnit |
+| isNegativeQty     |
+
+<a name="recursiveCheckObject"></a>
+
+## recursiveCheckObject ⇒
+
+<p>Updates value of object by checking recursivly.</p>
+
+**Kind**: global variable  
+**Returns**: <p>updated object</p>
+
+| Param        | Description                                                                                                                                                                                                                |
+| ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| allValues    | <p>Full value object</p>                                                                                                                                                                                                   |
+| newValue     | <p>New value to update</p>                                                                                                                                                                                                 |
+| propsToCheck | <p>Full key string associated to value to update, with nested keys seperated by dots (.). If the value to update is nested in an array, use square brackets with index between (ex. first_key.second_key[2].third_key)</p> |
+
+<a name="getOrderedPromises"></a>
+
+## getOrderedPromises ⇒
+
+<p>Checks list of promises for applicable banks based on space bank types.</p>
+
+**Kind**: global variable  
+**Returns**: <p>An array of applicable banks. If no bank is active for a type, is not returned in array. If active bank of type is in a inactive promise, is returned with props pa_is_active: false.</p>
+
+| Param           | Description                                                  |
+| --------------- | ------------------------------------------------------------ |
+| promisesToCheck | <p>The promise list to check</p>                             |
+| possibleBanks   | <p>the possible bank types (usually found in space data)</p> |
+
+<a name="checkForApplicableBanks"></a>
+
+## checkForApplicableBanks
+
+<p>Returns if a promise is currently active. Promise is active if it is not archived, and if current date is same or after starting_date, and before ending_date (if defined).</p>
+
+**Kind**: global variable
+
+| Param   | Description                      |
+| ------- | -------------------------------- |
+| promise | <p>the promise data to check</p> |
+
+<a name="checkIfOtherBankOfSameTypeIsActive"></a>
+
+## checkIfOtherBankOfSameTypeIsActive
+
+<p>Returns translated name for a provided bank type ID.</p>
+
+**Kind**: global variable
+
+| Param        | Description                                      |
+| ------------ | ------------------------------------------------ |
+| allBankTypes | <p>The current bank types for space</p>          |
+| bankTypeID   | <p>The bank type ID for which we want a name</p> |
+| locale       | <p>Optionnal. Defaults to 'fr'</p>               |
+
+<a name="getBankTypeName"></a>
+
+## getBankTypeName
+
+<p>Calculates the remaining amount for a specific promise's bank</p>
+
+**Kind**: global variable
+
+| Param             | Description                                                                                    |
+| ----------------- | ---------------------------------------------------------------------------------------------- |
+| initialBankAmount | <p>the initial amount of the bank</p>                                                          |
+| bankHistory       | <p>array of all history entries for bank. Will be ordered by date before deducing amounts.</p> |
+
+<a name="getIndexedByCustomerPromiseValues"></a>
+
+## getIndexedByCustomerPromiseValues ⇒
+
+<p>Returns the most recently emptied bank of a given type</p>
+
+**Kind**: global variable  
+**Returns**: <p>An IBank with a promise_unique_id</p>
+
+| Param              | Description                                                   |
+| ------------------ | ------------------------------------------------------------- |
+| allCustomerPAsData | <p>the array of all promises to purchase we want to check</p> |
+| type               | <p>the bank_type_id to check</p>                              |
+| promiseUniqueID    | <p>the current promise unique id</p>                          |
+
+<a name="getIndexServices"></a>
+
+## getIndexServices
+
+<p>Save new entry objects to provided search index services</p>
+
+**Kind**: global variable
+
+| Param         | Description                                                     |
+| ------------- | --------------------------------------------------------------- |
+| services      | <p>the services to check for save</p>                           |
+| newEntry      | <p>the object to save</p>                                       |
+| processLogStr | <p>the string to add to the log shown with service response</p> |
+
+<a name="saveNewEntryToIndex"></a>
+
+## saveNewEntryToIndex
+
+<p>Save a partial object entry to provided search index services.</p>
+
+**Kind**: global variable
+
+| Param            | Description                                                                             |
+| ---------------- | --------------------------------------------------------------------------------------- |
+| services         | <p>the services to check for save</p>                                                   |
+| partialNewEntry  | <p>the object to save</p>                                                               |
+| processLogStr    | <p>the string to add to the log shown with service response</p>                         |
+| createIfNoExists | <p>= Optionnal. If should create entry if it does not already exist in search index</p> |
+
+<a name="partialSaveNewEntryToIndex"></a>
+
+## partialSaveNewEntryToIndex
+
+<p>Returns an object with base info needed to call Algolia/AddioSearch with search query.</p>
+
+**Kind**: global variable
+
+| Param |
+| ----- |
+| space |
+
+<a name="getFetchInfoAlgoliaAddioSearch"></a>
+
+## getFetchInfoAlgoliaAddioSearch
+
+<p>Fetch entries from either algolia or AddioSearch (prospr) for a provided index. Client-side only!</p>
+
+**Kind**: global variable
+
+| Param  |
+| ------ |
+| param0 |
+
+<a name="fetchEntriesAlgoliaAddioSearch"></a>
+
+## fetchEntriesAlgoliaAddioSearch
+
+<p>Returns search result from active search index service. Server-side friendly!</p>
+
+**Kind**: global variable
+
+| Param      | Description                                                                                            |
+| ---------- | ------------------------------------------------------------------------------------------------------ |
+| parameters | <p>Parsed parameters of IQueryProps. Space and indice must be provided, other props are optionnal.</p> |
+
+<a name="isTestEnv"></a>
+
+## isTestEnv
+
+<p>TBSDK - SDK Manager</p>
+<p>Client SDK to access TheBEAST eCommerce</p>
+
+**Kind**: global constant  
+<a name="spaceInitData"></a>
+
+## spaceInitData
+
+<p>Use this object to change which space is being tested!</p>
+
+**Kind**: global constant  
+<a name="getMinDatePicker"></a>
+
+## getMinDatePicker()
+
+<p>Sets the minimum shipping day for delivery</p>
+
+**Kind**: global function  
+<a name="getProductSellUnitLabel"></a>
+
+## getProductSellUnitLabel(otherUnits, locale, returnUnitForSlugs) ⇒ <code>string</code>
+
+<p>Returns sell unit label in correct language for a specific product's other_units</p>
+
+**Kind**: global function  
+**Returns**: <code>string</code> - <p>The sell unit label in the correct language</p>
+
+| Param              | Type                                                                       | Default                     | Description                                                       |
+| ------------------ | -------------------------------------------------------------------------- | --------------------------- | ----------------------------------------------------------------- |
+| otherUnits         | <code>Array.&lt;IFilledDimensionUnits&gt;</code> \| <code>undefined</code> |                             | <p>The unit array we have to check to get the sell unit</p>       |
+| locale             | <code>string</code> \| <code>undefined</code>                              | <code>&quot;fr&quot;</code> | <p>The language in which we want to return the label</p>          |
+| returnUnitForSlugs | <code>Array.&lt;string&gt;</code>                                          |                             | <p>An array of the slugs we want to return the unit label for</p> |
+
+<a name="splitOnDashes"></a>
+
+## splitOnDashes(stringToSplit) ⇒ <code>Array.&lt;string&gt;</code>
+
+**Kind**: global function
+
+| Param                              | Type                | Description                                                                                                                                            |
+| ---------------------------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| stringToSplit                      | <code>string</code> |                                                                                                                                                        |
+| dummyStringToReplace.currentValue, | <code>string</code> | <p>optionnal, default : '%%-%%'. Used to provide general replace values for a specific string. Is applied to both sections of the splitted string.</p> |
+| dummyStringToReplace.newValue,     | <code>string</code> | <p>optionnal, default : ' - '. Used to provide general replace values for a specific string. Is applied to both sections of the splitted string.</p>   |
+
+<a name="getRandomValue"></a>
+
+## getRandomValue(val, type) ⇒
+
+<p>Replace a value with anonymized value</p>
+
+**Kind**: global function  
+**Returns**: <p>the new value</p>
+
+| Param | Description               |
+| ----- | ------------------------- |
+| val   | <p>The original value</p> |
+| type  | <p>The type of data</p>   |
+
+<a name="getCartPromo"></a>
+
+## getCartPromo(cartData)
+
+<p>Get formatted array of cart promos applied to a specific cart</p>
+
+**Kind**: global function
+
+| Param    |
+| -------- |
+| cartData |
+
+<a name="_checkRuleApplicationArray"></a>
+
+## \_checkRuleApplicationArray(checkedRulesApplicationArray) ⇒
+
+<p>Checks if discount rule should be applied to cart based on each rule verification results.</p>
+
+**Kind**: global function  
+**Returns**: <p>A boolean</p>
+
+| Param                        | Description                                                                                            |
+| ---------------------------- | ------------------------------------------------------------------------------------------------------ |
+| checkedRulesApplicationArray | <p>Array where each position is a verified rule result (condition with passed of failed (boolean))</p> |
+
+<a name="checkIfCouldApplyIncentivePromo"></a>
+
+## checkIfCouldApplyIncentivePromo(cartData, skipCheckFor) ⇒
+
+<p>Checks if an incentive discount could (in theory) by added to provided cart, by checking found incentive discount's rule array.</p>
+
+**Kind**: global function  
+**Returns**: <p>a boolean</p>
+
+| Param        | Description                                                    |
+| ------------ | -------------------------------------------------------------- |
+| cartData     | <p>The cart to check (checks discount_rules for incentive)</p> |
+| skipCheckFor | <p>If certain rules should be ignore for check</p>             |
+
+<a name="getOrderedPromises"></a>
+
+## getOrderedPromises(promises)
+
+<p>Get ordered array of promise data objects by starting date.</p>
+
+**Kind**: global function
+
+| Param    |
+| -------- |
+| promises |
+
+<a name="getIndexServices"></a>
+
+## getIndexServices(space, partialIndexID)
+
+<p>Returns objet with possible index service instances
+As of now, checks for Algolia and Addio Search</p>
+
+**Kind**: global function
+
+| Param          | Description                                                                                                                                                              |
+| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| space          | <p>the spaceObj to check</p>                                                                                                                                             |
+| partialIndexID | <p>the partial index ID to consult for search, excluding the env. variable (prod* or test* will be added in function). \*\* Important to use index ID, not table ID!</p> |