addio-admin-sdk 1.7.157 → 1.7.158

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (577) hide show
  1. package/.babelrc +17 -17
  2. package/.env.dev +14 -14
  3. package/.github/workflows/run_unit_test.yaml +48 -48
  4. package/addio-sdk-doc.md +1473 -1473
  5. package/changelog.md +564 -564
  6. package/dist/Interfaces/Address/index.d.ts +21 -21
  7. package/dist/Interfaces/Address/index.js +16 -16
  8. package/dist/Interfaces/Algolia/index.d.ts +180 -180
  9. package/dist/Interfaces/Algolia/index.js +2 -2
  10. package/dist/Interfaces/Attachement/index.d.ts +5 -5
  11. package/dist/Interfaces/Attachement/index.js +2 -2
  12. package/dist/Interfaces/Attribute/index.d.ts +53 -53
  13. package/dist/Interfaces/Attribute/index.js +10 -10
  14. package/dist/Interfaces/BGJob/index.d.ts +56 -56
  15. package/dist/Interfaces/BGJob/index.js +25 -25
  16. package/dist/Interfaces/BaseClass/index.d.ts +8 -8
  17. package/dist/Interfaces/BaseClass/index.js +2 -2
  18. package/dist/Interfaces/Blog/IBlogArticle.d.ts +18 -18
  19. package/dist/Interfaces/Blog/IBlogArticle.js +2 -2
  20. package/dist/Interfaces/Blog/IBlogAuthor.d.ts +7 -7
  21. package/dist/Interfaces/Blog/IBlogAuthor.js +2 -2
  22. package/dist/Interfaces/Blog/IBlogCategory.d.ts +9 -9
  23. package/dist/Interfaces/Blog/IBlogCategory.js +2 -2
  24. package/dist/Interfaces/Blog/IBlogComment.d.ts +13 -13
  25. package/dist/Interfaces/Blog/IBlogComment.js +2 -2
  26. package/dist/Interfaces/Blog/IBlogKeywords.d.ts +9 -9
  27. package/dist/Interfaces/Blog/IBlogKeywords.js +2 -2
  28. package/dist/Interfaces/Booking/index.d.ts +74 -74
  29. package/dist/Interfaces/Booking/index.js +17 -17
  30. package/dist/Interfaces/Brand/index.d.ts +15 -15
  31. package/dist/Interfaces/Brand/index.js +2 -2
  32. package/dist/Interfaces/CMS/index.d.ts +28 -28
  33. package/dist/Interfaces/CMS/index.js +5 -5
  34. package/dist/Interfaces/Cart/IElavonPayload.d.ts +93 -93
  35. package/dist/Interfaces/Cart/IElavonPayload.js +17 -17
  36. package/dist/Interfaces/Cart/IMarketPayload.d.ts +12 -0
  37. package/dist/Interfaces/Cart/IMarketPayload.js +3 -0
  38. package/dist/Interfaces/Cart/IMarketPayload.js.map +1 -0
  39. package/dist/Interfaces/Cart/IPandaPayload.d.ts +64 -64
  40. package/dist/Interfaces/Cart/IPandaPayload.js +18 -18
  41. package/dist/Interfaces/Cart/IPaymentCard.d.ts +22 -22
  42. package/dist/Interfaces/Cart/IPaymentCard.js +44 -44
  43. package/dist/Interfaces/Cart/IPaypalPayload.d.ts +9 -9
  44. package/dist/Interfaces/Cart/IPaypalPayload.js +2 -2
  45. package/dist/Interfaces/Cart/IPaysafePayload.d.ts +72 -72
  46. package/dist/Interfaces/Cart/IPaysafePayload.js +2 -2
  47. package/dist/Interfaces/Cart/IStripePayload.d.ts +66 -66
  48. package/dist/Interfaces/Cart/IStripePayload.js +2 -2
  49. package/dist/Interfaces/Cart/index.d.ts +451 -447
  50. package/dist/Interfaces/Cart/index.js +216 -215
  51. package/dist/Interfaces/Cart/index.js.map +1 -1
  52. package/dist/Interfaces/CartReservedQuantities/index.d.ts +10 -10
  53. package/dist/Interfaces/CartReservedQuantities/index.js +2 -2
  54. package/dist/Interfaces/CashDrawers/index.d.ts +37 -37
  55. package/dist/Interfaces/CashDrawers/index.js +19 -19
  56. package/dist/Interfaces/Catalogue/index.d.ts +68 -68
  57. package/dist/Interfaces/Catalogue/index.js +37 -37
  58. package/dist/Interfaces/Category/index.d.ts +33 -33
  59. package/dist/Interfaces/Category/index.js +2 -2
  60. package/dist/Interfaces/Chart/index.d.ts +11 -11
  61. package/dist/Interfaces/Chart/index.js +2 -2
  62. package/dist/Interfaces/Class/index.d.ts +8 -8
  63. package/dist/Interfaces/Class/index.js +2 -2
  64. package/dist/Interfaces/Consent/index.d.ts +6 -6
  65. package/dist/Interfaces/Consent/index.js +2 -2
  66. package/dist/Interfaces/Context/IContextProps.d.ts +4 -4
  67. package/dist/Interfaces/Context/IContextProps.js +2 -2
  68. package/dist/Interfaces/Context/IContextState.d.ts +15 -15
  69. package/dist/Interfaces/Context/IContextState.js +2 -2
  70. package/dist/Interfaces/Customer/ICustomerBadge.d.ts +2 -2
  71. package/dist/Interfaces/Customer/ICustomerBadge.js +2 -2
  72. package/dist/Interfaces/Customer/ICustomerRating.d.ts +10 -10
  73. package/dist/Interfaces/Customer/ICustomerRating.js +2 -2
  74. package/dist/Interfaces/Customer/IStoreCredit.d.ts +13 -13
  75. package/dist/Interfaces/Customer/IStoreCredit.js +2 -2
  76. package/dist/Interfaces/Customer/index.d.ts +104 -104
  77. package/dist/Interfaces/Customer/index.js +148 -148
  78. package/dist/Interfaces/Declination/index.d.ts +117 -117
  79. package/dist/Interfaces/Declination/index.js +66 -66
  80. package/dist/Interfaces/Document/index.d.ts +8 -8
  81. package/dist/Interfaces/Document/index.js +2 -2
  82. package/dist/Interfaces/Elastic/index.d.ts +89 -89
  83. package/dist/Interfaces/Elastic/index.js +2 -2
  84. package/dist/Interfaces/Email/CustomGR/I3DPrintEmail.d.ts +11 -11
  85. package/dist/Interfaces/Email/CustomGR/I3DPrintEmail.js +2 -2
  86. package/dist/Interfaces/Email/CustomGR/IBorrowToolsEmail.d.ts +15 -15
  87. package/dist/Interfaces/Email/CustomGR/IBorrowToolsEmail.js +2 -2
  88. package/dist/Interfaces/Email/CustomGR/IPickupMaterialsEmail.d.ts +12 -12
  89. package/dist/Interfaces/Email/CustomGR/IPickupMaterialsEmail.js +2 -2
  90. package/dist/Interfaces/Email/CustomGR/IPreMeetingFormEmail.d.ts +36 -36
  91. package/dist/Interfaces/Email/CustomGR/IPreMeetingFormEmail.js +2 -2
  92. package/dist/Interfaces/Email/CustomGR/ISponsorRequestEmail.d.ts +12 -12
  93. package/dist/Interfaces/Email/CustomGR/ISponsorRequestEmail.js +2 -2
  94. package/dist/Interfaces/Email/CustomGR/ITransportEmail.d.ts +12 -12
  95. package/dist/Interfaces/Email/CustomGR/ITransportEmail.js +2 -2
  96. package/dist/Interfaces/Email/CustomGR/ITransportQuoteEmail.d.ts +12 -12
  97. package/dist/Interfaces/Email/CustomGR/ITransportQuoteEmail.js +2 -2
  98. package/dist/Interfaces/Email/CustomGR/IVegetalsEmail.d.ts +16 -16
  99. package/dist/Interfaces/Email/CustomGR/IVegetalsEmail.js +2 -2
  100. package/dist/Interfaces/Email/CustomGR/IWishlistEmail.d.ts +15 -15
  101. package/dist/Interfaces/Email/CustomGR/IWishlistEmail.js +2 -2
  102. package/dist/Interfaces/Email/IAbandonnedCartEmail.d.ts +29 -29
  103. package/dist/Interfaces/Email/IAbandonnedCartEmail.js +2 -2
  104. package/dist/Interfaces/Email/IAccountConfirmationEmail.d.ts +22 -22
  105. package/dist/Interfaces/Email/IAccountConfirmationEmail.js +2 -2
  106. package/dist/Interfaces/Email/IApplicationEmail.d.ts +19 -19
  107. package/dist/Interfaces/Email/IApplicationEmail.js +2 -2
  108. package/dist/Interfaces/Email/IBackInStockEmail.d.ts +21 -21
  109. package/dist/Interfaces/Email/IBackInStockEmail.js +2 -2
  110. package/dist/Interfaces/Email/IContactEmail.d.ts +20 -20
  111. package/dist/Interfaces/Email/IContactEmail.js +2 -2
  112. package/dist/Interfaces/Email/ICustomerBookingAdminEmail.d.ts +15 -15
  113. package/dist/Interfaces/Email/ICustomerBookingAdminEmail.js +2 -2
  114. package/dist/Interfaces/Email/ICustomerBookingEmail.d.ts +14 -14
  115. package/dist/Interfaces/Email/ICustomerBookingEmail.js +2 -2
  116. package/dist/Interfaces/Email/IEmail.d.ts +20 -20
  117. package/dist/Interfaces/Email/IEmail.js +60 -60
  118. package/dist/Interfaces/Email/IOrderConfirmationEmail.d.ts +47 -47
  119. package/dist/Interfaces/Email/IOrderConfirmationEmail.js +2 -2
  120. package/dist/Interfaces/Email/IPasswordResetEmail.d.ts +17 -17
  121. package/dist/Interfaces/Email/IPasswordResetEmail.js +2 -2
  122. package/dist/Interfaces/Email/IPhotoShootEmail.d.ts +14 -14
  123. package/dist/Interfaces/Email/IPhotoShootEmail.js +2 -2
  124. package/dist/Interfaces/Email/IPickupConfirmation.d.ts +23 -23
  125. package/dist/Interfaces/Email/IPickupConfirmation.js +2 -2
  126. package/dist/Interfaces/Email/IShippingConfirmation.d.ts +23 -23
  127. package/dist/Interfaces/Email/IShippingConfirmation.js +2 -2
  128. package/dist/Interfaces/Email/IWelcomeEmail.d.ts +19 -19
  129. package/dist/Interfaces/Email/IWelcomeEmail.js +2 -2
  130. package/dist/Interfaces/ExportSchema/index.d.ts +7 -7
  131. package/dist/Interfaces/ExportSchema/index.js +2 -2
  132. package/dist/Interfaces/ExternalService/BaseExternalService.d.ts +12 -12
  133. package/dist/Interfaces/ExternalService/BaseExternalService.js +2 -2
  134. package/dist/Interfaces/ExternalService/ExternalProductsService.d.ts +4 -4
  135. package/dist/Interfaces/ExternalService/ExternalProductsService.js +2 -2
  136. package/dist/Interfaces/ExternalService/index.d.ts +9 -9
  137. package/dist/Interfaces/ExternalService/index.js +2 -2
  138. package/dist/Interfaces/FirstOrderTracking/index.d.ts +5 -5
  139. package/dist/Interfaces/FirstOrderTracking/index.js +2 -2
  140. package/dist/Interfaces/G2/index.d.ts +556 -556
  141. package/dist/Interfaces/G2/index.js +38 -38
  142. package/dist/Interfaces/Indexed/Product/IIndexedLastSavedProduct.d.ts +20 -20
  143. package/dist/Interfaces/Indexed/Product/IIndexedLastSavedProduct.js +2 -2
  144. package/dist/Interfaces/Indexed/Product/index.d.ts +105 -105
  145. package/dist/Interfaces/Indexed/Product/index.js +253 -253
  146. package/dist/Interfaces/Inventory/index.d.ts +19 -19
  147. package/dist/Interfaces/Inventory/index.js +8 -8
  148. package/dist/Interfaces/Invoice/index.d.ts +4 -4
  149. package/dist/Interfaces/Invoice/index.js +2 -2
  150. package/dist/Interfaces/MarketplacePublication/MarketplaceOrderData.d.ts +3 -3
  151. package/dist/Interfaces/MarketplacePublication/MarketplaceOrderData.js +2 -2
  152. package/dist/Interfaces/MarketplacePublication/index.d.ts +23 -23
  153. package/dist/Interfaces/MarketplacePublication/index.js +22 -22
  154. package/dist/Interfaces/Menu/index.d.ts +40 -40
  155. package/dist/Interfaces/Menu/index.js +16 -16
  156. package/dist/Interfaces/Note/index.d.ts +10 -10
  157. package/dist/Interfaces/Note/index.js +7 -7
  158. package/dist/Interfaces/Operations/ICreatedBy.d.ts +6 -6
  159. package/dist/Interfaces/Operations/ICreatedBy.js +2 -2
  160. package/dist/Interfaces/Operations/IUpdate.d.ts +5 -5
  161. package/dist/Interfaces/Operations/IUpdate.js +2 -2
  162. package/dist/Interfaces/Order/index.d.ts +4 -4
  163. package/dist/Interfaces/Order/index.js +2 -2
  164. package/dist/Interfaces/Org/IRelUser.d.ts +9 -9
  165. package/dist/Interfaces/Org/IRelUser.js +2 -2
  166. package/dist/Interfaces/Org/index.d.ts +29 -29
  167. package/dist/Interfaces/Org/index.js +12 -12
  168. package/dist/Interfaces/Payment/index.d.ts +26 -26
  169. package/dist/Interfaces/Payment/index.js +14 -14
  170. package/dist/Interfaces/Product/IAttributeFamily.d.ts +6 -6
  171. package/dist/Interfaces/Product/IAttributeFamily.js +2 -2
  172. package/dist/Interfaces/Product/IImportProduct.d.ts +42 -42
  173. package/dist/Interfaces/Product/IImportProduct.js +882 -882
  174. package/dist/Interfaces/Product/IInventoryItem.d.ts +74 -74
  175. package/dist/Interfaces/Product/IInventoryItem.js +38 -38
  176. package/dist/Interfaces/Product/IPricing.d.ts +177 -177
  177. package/dist/Interfaces/Product/IPricing.js +180 -180
  178. package/dist/Interfaces/Product/index.d.ts +138 -138
  179. package/dist/Interfaces/Product/index.js +64 -64
  180. package/dist/Interfaces/ProductAttribute/index.d.ts +11 -11
  181. package/dist/Interfaces/ProductAttribute/index.js +2 -2
  182. package/dist/Interfaces/PromiseToPurchase/BankType.d.ts +41 -41
  183. package/dist/Interfaces/PromiseToPurchase/BankType.js +41 -41
  184. package/dist/Interfaces/PromiseToPurchase/IIndexedBankUsed.d.ts +33 -33
  185. package/dist/Interfaces/PromiseToPurchase/IIndexedBankUsed.js +15 -15
  186. package/dist/Interfaces/PromiseToPurchase/IIndexedCustomerPromiseToPurchase.d.ts +19 -19
  187. package/dist/Interfaces/PromiseToPurchase/IIndexedCustomerPromiseToPurchase.js +2 -2
  188. package/dist/Interfaces/PromiseToPurchase/index.d.ts +50 -50
  189. package/dist/Interfaces/PromiseToPurchase/index.js +13 -13
  190. package/dist/Interfaces/PurchaseOrder/index.d.ts +17 -17
  191. package/dist/Interfaces/PurchaseOrder/index.js +2 -2
  192. package/dist/Interfaces/Query/IBrandQueryOptions.d.ts +11 -11
  193. package/dist/Interfaces/Query/IBrandQueryOptions.js +2 -2
  194. package/dist/Interfaces/Query/ICategoryQueryOptions.d.ts +11 -11
  195. package/dist/Interfaces/Query/ICategoryQueryOptions.js +2 -2
  196. package/dist/Interfaces/Query/IProductQueryOptions.d.ts +16 -16
  197. package/dist/Interfaces/Query/IProductQueryOptions.js +2 -2
  198. package/dist/Interfaces/Quote/index.d.ts +5 -5
  199. package/dist/Interfaces/Quote/index.js +2 -2
  200. package/dist/Interfaces/Refunds/index.d.ts +106 -106
  201. package/dist/Interfaces/Refunds/index.js +2 -2
  202. package/dist/Interfaces/Rules/IDiscountRule.d.ts +155 -155
  203. package/dist/Interfaces/Rules/IDiscountRule.js +114 -114
  204. package/dist/Interfaces/Schedule/index.d.ts +48 -48
  205. package/dist/Interfaces/Schedule/index.js +2 -2
  206. package/dist/Interfaces/Services/IAddServiceResponse.d.ts +4 -4
  207. package/dist/Interfaces/Services/IAddServiceResponse.js +2 -2
  208. package/dist/Interfaces/Services/IService.d.ts +16 -16
  209. package/dist/Interfaces/Services/IService.js +2 -2
  210. package/dist/Interfaces/Services/IServiceSecret.d.ts +8 -8
  211. package/dist/Interfaces/Services/IServiceSecret.js +2 -2
  212. package/dist/Interfaces/Shipping/Shipstation/carriers.d.ts +10 -10
  213. package/dist/Interfaces/Shipping/Shipstation/carriers.js +2 -2
  214. package/dist/Interfaces/Shipping/Shipstation/order.d.ts +227 -227
  215. package/dist/Interfaces/Shipping/Shipstation/order.js +2 -2
  216. package/dist/Interfaces/Shipping/Shipstation/quote.d.ts +31 -31
  217. package/dist/Interfaces/Shipping/Shipstation/quote.js +2 -2
  218. package/dist/Interfaces/Shipping/Shiptime/order.d.ts +54 -54
  219. package/dist/Interfaces/Shipping/Shiptime/order.js +71 -71
  220. package/dist/Interfaces/Shipping/Shiptime/quote.d.ts +111 -111
  221. package/dist/Interfaces/Shipping/Shiptime/quote.js +2 -2
  222. package/dist/Interfaces/Slider/GR.d.ts +114 -114
  223. package/dist/Interfaces/Slider/GR.js +271 -271
  224. package/dist/Interfaces/Slider/index.d.ts +30 -30
  225. package/dist/Interfaces/Slider/index.js +2 -2
  226. package/dist/Interfaces/Space/IExternalService.d.ts +53 -53
  227. package/dist/Interfaces/Space/IExternalService.js +44 -44
  228. package/dist/Interfaces/Space/IMember.d.ts +16 -16
  229. package/dist/Interfaces/Space/IMember.js +9 -9
  230. package/dist/Interfaces/Space/index.d.ts +411 -411
  231. package/dist/Interfaces/Space/index.js +174 -174
  232. package/dist/Interfaces/Specials/gr.d.ts +61 -61
  233. package/dist/Interfaces/Specials/gr.js +2 -2
  234. package/dist/Interfaces/StockNotification/index.d.ts +7 -7
  235. package/dist/Interfaces/StockNotification/index.js +2 -2
  236. package/dist/Interfaces/Store/index.d.ts +63 -63
  237. package/dist/Interfaces/Store/index.js +27 -27
  238. package/dist/Interfaces/Supplier/ICommand.d.ts +11 -11
  239. package/dist/Interfaces/Supplier/ICommand.js +2 -2
  240. package/dist/Interfaces/Supplier/index.d.ts +36 -36
  241. package/dist/Interfaces/Supplier/index.js +24 -24
  242. package/dist/Interfaces/TCG/index.d.ts +169 -169
  243. package/dist/Interfaces/TCG/index.js +60 -60
  244. package/dist/Interfaces/Tag/index.d.ts +18 -18
  245. package/dist/Interfaces/Tag/index.js +2 -2
  246. package/dist/Interfaces/Tax/index.d.ts +13 -13
  247. package/dist/Interfaces/Tax/index.js +2 -2
  248. package/dist/Interfaces/TransferRequest/index.d.ts +103 -103
  249. package/dist/Interfaces/TransferRequest/index.js +46 -46
  250. package/dist/Interfaces/Translation/index.d.ts +8 -8
  251. package/dist/Interfaces/Translation/index.js +5 -5
  252. package/dist/Interfaces/Update/index.d.ts +10 -10
  253. package/dist/Interfaces/Update/index.js +2 -2
  254. package/dist/Interfaces/User/IUser.d.ts +65 -65
  255. package/dist/Interfaces/User/IUser.js +8 -8
  256. package/dist/Interfaces/Version/index.d.ts +11 -11
  257. package/dist/Interfaces/Version/index.js +2 -2
  258. package/dist/Interfaces/Wishlist/index.d.ts +7 -7
  259. package/dist/Interfaces/Wishlist/index.js +2 -2
  260. package/dist/constants/Interfaces/IBaseApi.d.ts +15 -15
  261. package/dist/constants/Interfaces/IBaseApi.js +2 -2
  262. package/dist/constants/Interfaces/IEndpointResult.d.ts +9 -9
  263. package/dist/constants/Interfaces/IEndpointResult.js +2 -2
  264. package/dist/constants/enums.d.ts +6 -6
  265. package/dist/constants/enums.js +10 -10
  266. package/dist/constants/services.d.ts +2 -2
  267. package/dist/constants/services.js +117 -117
  268. package/dist/constants/version.d.ts +2 -2
  269. package/dist/constants/version.js +5 -5
  270. package/dist/index.d.ts +50 -50
  271. package/dist/index.js +266 -266
  272. package/dist/lib/Attribute/index.d.ts +14 -14
  273. package/dist/lib/Attribute/index.js +186 -186
  274. package/dist/lib/BGJob/index.d.ts +9 -9
  275. package/dist/lib/BGJob/index.js +216 -216
  276. package/dist/lib/BackgroundWorker/index.d.ts +34 -34
  277. package/dist/lib/BackgroundWorker/index.js +59 -59
  278. package/dist/lib/Blog/BlogArticle.d.ts +5 -5
  279. package/dist/lib/Blog/BlogArticle.js +10 -10
  280. package/dist/lib/Blog/BlogAuthor.d.ts +5 -5
  281. package/dist/lib/Blog/BlogAuthor.js +10 -10
  282. package/dist/lib/Blog/BlogCategory.d.ts +5 -5
  283. package/dist/lib/Blog/BlogCategory.js +10 -10
  284. package/dist/lib/Blog/BlogKeyword.d.ts +5 -5
  285. package/dist/lib/Blog/BlogKeyword.js +10 -10
  286. package/dist/lib/Booking/index.d.ts +85 -85
  287. package/dist/lib/Booking/index.js +596 -596
  288. package/dist/lib/Brand/index.d.ts +26 -26
  289. package/dist/lib/Brand/index.js +131 -131
  290. package/dist/lib/Cart/index.d.ts +335 -335
  291. package/dist/lib/Cart/index.js +3981 -3981
  292. package/dist/lib/Cart/index.js.map +1 -1
  293. package/dist/lib/CartReservedQuantities/index.d.ts +49 -49
  294. package/dist/lib/CartReservedQuantities/index.js +159 -159
  295. package/dist/lib/CashDrawerShift/index.d.ts +84 -84
  296. package/dist/lib/CashDrawerShift/index.js +206 -206
  297. package/dist/lib/Catalogue/index.d.ts +15 -15
  298. package/dist/lib/Catalogue/index.js +78 -78
  299. package/dist/lib/Category/index.d.ts +34 -34
  300. package/dist/lib/Category/index.js +230 -230
  301. package/dist/lib/Class/index.d.ts +16 -16
  302. package/dist/lib/Class/index.js +66 -66
  303. package/dist/lib/Consent/index.d.ts +4 -4
  304. package/dist/lib/Consent/index.js +29 -29
  305. package/dist/lib/Customer/index.d.ts +30 -30
  306. package/dist/lib/Customer/index.js +92 -92
  307. package/dist/lib/Declination/index.d.ts +9 -9
  308. package/dist/lib/Declination/index.js +26 -26
  309. package/dist/lib/Discount/index.d.ts +27 -27
  310. package/dist/lib/Discount/index.js +493 -493
  311. package/dist/lib/ElasticSearch/index.d.ts +13 -13
  312. package/dist/lib/ElasticSearch/index.js +50 -50
  313. package/dist/lib/Elavon/index.d.ts +18 -18
  314. package/dist/lib/Elavon/index.js +135 -135
  315. package/dist/lib/Email/AbandonedCartEmail.d.ts +16 -16
  316. package/dist/lib/Email/AbandonedCartEmail.js +24 -24
  317. package/dist/lib/Email/AccountConfirmationEmail.d.ts +19 -19
  318. package/dist/lib/Email/AccountConfirmationEmail.js +30 -30
  319. package/dist/lib/Email/AdminOrderConfirmationEmail.d.ts +16 -16
  320. package/dist/lib/Email/AdminOrderConfirmationEmail.js +24 -24
  321. package/dist/lib/Email/ApplicationEmail.d.ts +16 -16
  322. package/dist/lib/Email/ApplicationEmail.js +24 -24
  323. package/dist/lib/Email/BackInStockEmail.d.ts +16 -16
  324. package/dist/lib/Email/BackInStockEmail.js +24 -24
  325. package/dist/lib/Email/ContactEmail.d.ts +16 -16
  326. package/dist/lib/Email/ContactEmail.js +24 -24
  327. package/dist/lib/Email/CustomerBookingAdminEmail.d.ts +16 -16
  328. package/dist/lib/Email/CustomerBookingAdminEmail.js +24 -24
  329. package/dist/lib/Email/CustomerBookingEmail.d.ts +16 -16
  330. package/dist/lib/Email/CustomerBookingEmail.js +24 -24
  331. package/dist/lib/Email/OrderConfirmationEmail.d.ts +16 -16
  332. package/dist/lib/Email/OrderConfirmationEmail.js +24 -24
  333. package/dist/lib/Email/OrderDenounciationEmail.d.ts +16 -16
  334. package/dist/lib/Email/OrderDenounciationEmail.js +24 -24
  335. package/dist/lib/Email/OrderSampleEmail.d.ts +16 -16
  336. package/dist/lib/Email/OrderSampleEmail.js +24 -24
  337. package/dist/lib/Email/OtherTypeEmails.d.ts +16 -16
  338. package/dist/lib/Email/OtherTypeEmails.js +27 -27
  339. package/dist/lib/Email/PasswordResetEmail.d.ts +16 -16
  340. package/dist/lib/Email/PasswordResetEmail.js +24 -24
  341. package/dist/lib/Email/PhotoShootEmail.d.ts +16 -16
  342. package/dist/lib/Email/PhotoShootEmail.js +24 -24
  343. package/dist/lib/Email/PickUpConfirmation.d.ts +16 -16
  344. package/dist/lib/Email/PickUpConfirmation.js +24 -24
  345. package/dist/lib/Email/ShippingConfirmation.d.ts +16 -16
  346. package/dist/lib/Email/ShippingConfirmation.js +24 -24
  347. package/dist/lib/Email/WelcomeEmail.d.ts +16 -16
  348. package/dist/lib/Email/WelcomeEmail.js +24 -24
  349. package/dist/lib/Email/index.d.ts +16 -16
  350. package/dist/lib/Email/index.js +31 -31
  351. package/dist/lib/ExternalService/Ebay.d.ts +74 -74
  352. package/dist/lib/ExternalService/Ebay.js +124 -124
  353. package/dist/lib/ExternalService/index.d.ts +5 -5
  354. package/dist/lib/ExternalService/index.js +10 -10
  355. package/dist/lib/FirstOrderTracking/index.d.ts +5 -5
  356. package/dist/lib/FirstOrderTracking/index.js +10 -10
  357. package/dist/lib/Indexed/IndexedCart.d.ts +13 -13
  358. package/dist/lib/Indexed/IndexedCart.js +91 -91
  359. package/dist/lib/Indexed/Product.d.ts +17 -17
  360. package/dist/lib/Indexed/Product.js +98 -98
  361. package/dist/lib/Inventory/index.d.ts +112 -112
  362. package/dist/lib/Inventory/index.js +492 -492
  363. package/dist/lib/Invoice/index.d.ts +16 -16
  364. package/dist/lib/Invoice/index.js +21 -21
  365. package/dist/lib/MarketplacePublication/index.d.ts +9 -9
  366. package/dist/lib/MarketplacePublication/index.js +426 -426
  367. package/dist/lib/Menu/index.d.ts +11 -11
  368. package/dist/lib/Menu/index.js +107 -107
  369. package/dist/lib/MongoDB/BaseAPI.d.ts +18 -18
  370. package/dist/lib/MongoDB/BaseAPI.js +200 -200
  371. package/dist/lib/Note/index.d.ts +4 -4
  372. package/dist/lib/Note/index.js +6 -6
  373. package/dist/lib/Order/index.d.ts +27 -27
  374. package/dist/lib/Order/index.js +56 -56
  375. package/dist/lib/Org/index.d.ts +68 -68
  376. package/dist/lib/Org/index.js +216 -216
  377. package/dist/lib/PandaPay/index.d.ts +16 -16
  378. package/dist/lib/PandaPay/index.js +176 -176
  379. package/dist/lib/Paysafe/index.d.ts +11 -11
  380. package/dist/lib/Paysafe/index.js +41 -41
  381. package/dist/lib/Product/index.d.ts +182 -182
  382. package/dist/lib/Product/index.js +847 -847
  383. package/dist/lib/ProductAttribute/index.d.ts +15 -15
  384. package/dist/lib/ProductAttribute/index.js +45 -45
  385. package/dist/lib/PromiseToPurchase/index.d.ts +109 -109
  386. package/dist/lib/PromiseToPurchase/index.js +343 -343
  387. package/dist/lib/PurchaseOrder/index.d.ts +20 -20
  388. package/dist/lib/PurchaseOrder/index.js +28 -28
  389. package/dist/lib/Queue/index.d.ts +40 -40
  390. package/dist/lib/Queue/index.js +254 -254
  391. package/dist/lib/Schedule/index.d.ts +5 -5
  392. package/dist/lib/Schedule/index.js +12 -12
  393. package/dist/lib/Service/Enum/ServiceEnum.d.ts +3 -3
  394. package/dist/lib/Service/Enum/ServiceEnum.js +7 -7
  395. package/dist/lib/Service/index.d.ts +13 -13
  396. package/dist/lib/Service/index.js +21 -21
  397. package/dist/lib/Shipment/index.d.ts +28 -28
  398. package/dist/lib/Shipment/index.js +370 -370
  399. package/dist/lib/Slider/index.d.ts +22 -22
  400. package/dist/lib/Slider/index.js +119 -119
  401. package/dist/lib/Space/index.d.ts +1172 -1172
  402. package/dist/lib/Space/index.js +5820 -5820
  403. package/dist/lib/StockNotification/index.d.ts +4 -4
  404. package/dist/lib/StockNotification/index.js +6 -6
  405. package/dist/lib/Store/index.d.ts +5 -5
  406. package/dist/lib/Store/index.js +12 -12
  407. package/dist/lib/Supplier/Command.d.ts +5 -5
  408. package/dist/lib/Supplier/Command.js +10 -10
  409. package/dist/lib/Supplier/index.d.ts +25 -25
  410. package/dist/lib/Supplier/index.js +27 -27
  411. package/dist/lib/Tags/index.d.ts +6 -6
  412. package/dist/lib/Tags/index.js +26 -26
  413. package/dist/lib/Tax/index.d.ts +8 -8
  414. package/dist/lib/Tax/index.js +54 -54
  415. package/dist/lib/TransferRequest/index.d.ts +290 -290
  416. package/dist/lib/TransferRequest/index.js +1026 -1026
  417. package/dist/lib/Update/index.d.ts +10 -10
  418. package/dist/lib/Update/index.js +22 -22
  419. package/dist/lib/User/index.d.ts +89 -89
  420. package/dist/lib/User/index.js +328 -328
  421. package/dist/lib/Wishlist/index.d.ts +5 -5
  422. package/dist/lib/Wishlist/index.js +10 -10
  423. package/dist/lib/base.d.ts +14 -14
  424. package/dist/lib/base.js +62 -62
  425. package/dist/lib/baseService.d.ts +17 -17
  426. package/dist/lib/baseService.js +69 -69
  427. package/dist/rules/GR/constants/data.d.ts +26 -26
  428. package/dist/rules/GR/constants/data.js +81 -81
  429. package/dist/rules/GR/constants/expedition.d.ts +4 -4
  430. package/dist/rules/GR/constants/expedition.js +9 -9
  431. package/dist/rules/GR/constants/products.d.ts +22 -22
  432. package/dist/rules/GR/constants/products.js +263 -263
  433. package/dist/rules/GR/interfaces/cart.d.ts +84 -84
  434. package/dist/rules/GR/interfaces/cart.js +41 -41
  435. package/dist/rules/GR/interfaces/data.d.ts +101 -101
  436. package/dist/rules/GR/interfaces/data.js +114 -114
  437. package/dist/rules/GR/interfaces/products.d.ts +61 -61
  438. package/dist/rules/GR/interfaces/products.js +10 -10
  439. package/dist/rules/GR/utils/cart.d.ts +95 -95
  440. package/dist/rules/GR/utils/cart.js +839 -839
  441. package/dist/rules/GR/utils/data.d.ts +3 -3
  442. package/dist/rules/GR/utils/data.js +28 -28
  443. package/dist/rules/GR/utils/expedition.d.ts +140 -140
  444. package/dist/rules/GR/utils/expedition.js +2016 -2016
  445. package/dist/rules/GR/utils/g2.d.ts +209 -209
  446. package/dist/rules/GR/utils/g2.js +1002 -1002
  447. package/dist/rules/GR/utils/invoices.d.ts +51 -51
  448. package/dist/rules/GR/utils/invoices.js +215 -215
  449. package/dist/rules/GR/utils/products.d.ts +277 -277
  450. package/dist/rules/GR/utils/products.js +1350 -1350
  451. package/dist/rules/GR/utils/upsells.d.ts +111 -111
  452. package/dist/rules/GR/utils/upsells.js +215 -215
  453. package/dist/services/database/BaseProvider.d.ts +29 -29
  454. package/dist/services/database/BaseProvider.js +28 -28
  455. package/dist/services/database/BatchUtils.d.ts +14 -14
  456. package/dist/services/database/BatchUtils.js +43 -43
  457. package/dist/services/database/Config.d.ts +2 -2
  458. package/dist/services/database/Config.js +5 -5
  459. package/dist/services/database/DatabaseService.d.ts +125 -125
  460. package/dist/services/database/DatabaseService.js +237 -237
  461. package/dist/services/database/FirebaseProvider.d.ts +17 -17
  462. package/dist/services/database/FirebaseProvider.js +235 -235
  463. package/dist/services/database/NotFirebaseProvider.d.ts +49 -49
  464. package/dist/services/database/NotFirebaseProvider.js +262 -262
  465. package/dist/services/g2/G2OrderSlip.d.ts +49 -49
  466. package/dist/services/g2/G2OrderSlip.js +228 -228
  467. package/dist/services/g2/utils.d.ts +19 -19
  468. package/dist/services/g2/utils.js +954 -954
  469. package/dist/services/logs/index.d.ts +23 -23
  470. package/dist/services/logs/index.js +66 -66
  471. package/dist/services/marketplace/BaseMarketServiceClass.d.ts +52 -52
  472. package/dist/services/marketplace/BaseMarketServiceClass.js +111 -111
  473. package/dist/services/marketplace/CardtraderServiceClass.d.ts +17 -17
  474. package/dist/services/marketplace/CardtraderServiceClass.js +139 -139
  475. package/dist/services/marketplace/utils.d.ts +14 -14
  476. package/dist/services/marketplace/utils.js +29 -29
  477. package/dist/services/products/BaseClass.d.ts +50 -50
  478. package/dist/services/products/BaseClass.js +66 -66
  479. package/dist/services/products/TCGService.d.ts +32 -32
  480. package/dist/services/products/TCGService.js +555 -555
  481. package/dist/services/products/utils.d.ts +31 -31
  482. package/dist/services/products/utils.js +144 -144
  483. package/dist/utils/algolia.d.ts +46 -46
  484. package/dist/utils/algolia.js +21 -21
  485. package/dist/utils/anonymisation.d.ts +54 -54
  486. package/dist/utils/anonymisation.js +280 -280
  487. package/dist/utils/array.d.ts +5 -5
  488. package/dist/utils/array.js +14 -14
  489. package/dist/utils/aws.d.ts +36 -36
  490. package/dist/utils/aws.js +154 -154
  491. package/dist/utils/booking.d.ts +30 -30
  492. package/dist/utils/booking.js +127 -127
  493. package/dist/utils/cart.d.ts +272 -272
  494. package/dist/utils/cart.js +1169 -1169
  495. package/dist/utils/categories.d.ts +2 -2
  496. package/dist/utils/categories.js +54 -54
  497. package/dist/utils/cmv.d.ts +10 -10
  498. package/dist/utils/cmv.js +107 -107
  499. package/dist/utils/console.d.ts +6 -6
  500. package/dist/utils/console.js +59 -59
  501. package/dist/utils/context.d.ts +20 -20
  502. package/dist/utils/context.js +61 -61
  503. package/dist/utils/currency.d.ts +6 -6
  504. package/dist/utils/currency.js +91 -91
  505. package/dist/utils/data.d.ts +31 -31
  506. package/dist/utils/data.js +296 -296
  507. package/dist/utils/date.d.ts +1 -1
  508. package/dist/utils/date.js +16 -16
  509. package/dist/utils/dimensions.d.ts +3 -3
  510. package/dist/utils/dimensions.js +16 -16
  511. package/dist/utils/discount.d.ts +174 -174
  512. package/dist/utils/discount.js +1118 -1118
  513. package/dist/utils/errors.d.ts +118 -118
  514. package/dist/utils/errors.js +123 -123
  515. package/dist/utils/file-admin.d.ts +8 -8
  516. package/dist/utils/file-admin.js +39 -39
  517. package/dist/utils/file.d.ts +39 -39
  518. package/dist/utils/file.js +208 -208
  519. package/dist/utils/firebase-admin.d.ts +11 -11
  520. package/dist/utils/firebase-admin.js +73 -73
  521. package/dist/utils/firebase.d.ts +58 -58
  522. package/dist/utils/firebase.js +148 -148
  523. package/dist/utils/import.d.ts +1 -1
  524. package/dist/utils/import.js +21 -21
  525. package/dist/utils/inventories.d.ts +101 -101
  526. package/dist/utils/inventories.js +467 -467
  527. package/dist/utils/locale.d.ts +24 -24
  528. package/dist/utils/locale.js +91 -89
  529. package/dist/utils/locale.js.map +1 -1
  530. package/dist/utils/mailchimp.d.ts +58 -58
  531. package/dist/utils/mailchimp.js +531 -531
  532. package/dist/utils/mathUtils.d.ts +17 -17
  533. package/dist/utils/mathUtils.js +324 -324
  534. package/dist/utils/mongodb.d.ts +1 -1
  535. package/dist/utils/mongodb.js +22 -22
  536. package/dist/utils/object.d.ts +32 -32
  537. package/dist/utils/object.js +133 -133
  538. package/dist/utils/payment.d.ts +10 -10
  539. package/dist/utils/payment.js +23 -23
  540. package/dist/utils/products.d.ts +39 -39
  541. package/dist/utils/products.js +195 -195
  542. package/dist/utils/promiseToPurchase.d.ts +88 -88
  543. package/dist/utils/promiseToPurchase.js +229 -229
  544. package/dist/utils/prosprsearch.d.ts +42 -42
  545. package/dist/utils/prosprsearch.js +216 -216
  546. package/dist/utils/refunds.d.ts +2 -2
  547. package/dist/utils/refunds.js +21 -21
  548. package/dist/utils/sdc.d.ts +10 -10
  549. package/dist/utils/sdc.js +1309 -1309
  550. package/dist/utils/searchIndexes.d.ts +58 -58
  551. package/dist/utils/searchIndexes.js +247 -247
  552. package/dist/utils/services.d.ts +42 -42
  553. package/dist/utils/services.js +409 -409
  554. package/dist/utils/shipment.d.ts +110 -110
  555. package/dist/utils/shipment.js +345 -345
  556. package/dist/utils/simpletexting.d.ts +2 -2
  557. package/dist/utils/simpletexting.js +45 -45
  558. package/dist/utils/sliders.d.ts +4 -4
  559. package/dist/utils/sliders.js +24 -24
  560. package/dist/utils/string.d.ts +16 -16
  561. package/dist/utils/string.js +192 -192
  562. package/dist/utils/tcgService.d.ts +81 -81
  563. package/dist/utils/tcgService.js +353 -353
  564. package/dist/utils/tools.d.ts +5 -5
  565. package/dist/utils/tools.js +13 -13
  566. package/dist/utils/transferRequests.d.ts +43 -43
  567. package/dist/utils/transferRequests.js +67 -67
  568. package/dist/utils/update.d.ts +7 -7
  569. package/dist/utils/update.js +137 -137
  570. package/dist/utils/weight.d.ts +3 -3
  571. package/dist/utils/weight.js +16 -16
  572. package/dist/utils/zones.d.ts +11 -11
  573. package/dist/utils/zones.js +218 -218
  574. package/package.json +107 -107
  575. package/publish.sh +143 -143
  576. package/readme.md +182 -182
  577. package/.env +0 -15
@@ -1,290 +1,290 @@
1
- /// <reference types="mocha" />
2
- import { IFilledDimensionUnits } from '../../Interfaces/Declination';
3
- import ITransferRequest, { ITransferProductWeight, ITransferProduct, TransferRequestStatusEnum, TransferRequestUpdateContextEnum } from '../../Interfaces/TransferRequest';
4
- import { BaseServiceClass } from '../baseService';
5
- import Space from '../Space';
6
- import { IQueryProps } from '../../Interfaces/Product';
7
- import { SearchResponse } from '@algolia/client-search';
8
- import Cart from '../Cart';
9
- import { IOrderInvoiceNumerotation } from '../../Interfaces/Space';
10
- type SaveTransferOptionsType = {
11
- readonly comment?: string | undefined;
12
- readonly user: string;
13
- readonly markAsCompleted?: boolean;
14
- readonly saveToDatabase?: boolean;
15
- readonly originalRequestProducts?: ITransferProduct[];
16
- readonly space?: Space | undefined;
17
- };
18
- export declare class TransferRequest extends BaseServiceClass<ITransferRequest> {
19
- private _listener;
20
- private prevProducts;
21
- private prevFromStore;
22
- private processData;
23
- constructor(_data: ITransferRequest, _collection: {
24
- path: string;
25
- }, _user: string);
26
- static fetch: ({ app, api, hpp, page, query, filters, indice, f, space, useProspr }: IQueryProps) => Promise<SearchResponse<ITransferRequest>>;
27
- static getStatusLabel: (status: TransferRequestStatusEnum) => "Initialisée" | "Ouverte" | "À préparer" | "En transit" | "Annulée" | "Reçue partiellement" | "Reçue";
28
- static checkIfTransferCanBeCancelled: (currentTransferStatus: TransferRequestStatusEnum, statusOrderObj: {
29
- [key: number]: TransferRequestStatusEnum[];
30
- }) => boolean;
31
- /**
32
- * Test if the transfer can be closed
33
- * @returns true if the status allow to close the transfer
34
- */
35
- checkIfTransferCanBeClosedManually: () => boolean;
36
- /**
37
- * Checks if provided status is included in "completed" transfer statuses list.
38
- * @param statusToCheck
39
- */
40
- static checkIfStatusCountsAsCompleted: (statusToCheck: TransferRequestStatusEnum) => boolean;
41
- static transferAllowAssignFromStore: (data: ITransferRequest) => boolean;
42
- transferAllowAssignFromStore: () => boolean;
43
- static transferAllowEditFromStore: (data: ITransferRequest) => boolean;
44
- transferAllowEditFromStore: () => boolean;
45
- /**
46
- * Test if the transfer allow adding products
47
- * @param data the request data to verify
48
- * @returns true if can add product
49
- */
50
- static transferAllowAddProductOnEdit: (data: ITransferRequest) => boolean;
51
- transferAllowAddProductOnEdit: () => boolean;
52
- /**
53
- * Test if the transfer allow deleteing products
54
- * @param data the request data to verify
55
- * @returns true if can delete product
56
- */
57
- static transferAllowProductDelete: (data: ITransferRequest) => boolean;
58
- transferAllowProductDelete: () => boolean;
59
- /**
60
- * Test if the transfer allow editing products
61
- * @param data the request data to verify
62
- * @returns true if can be edited
63
- */
64
- static transferAllowEditProductOnEdit: (data: ITransferRequest) => boolean;
65
- transferAllowEditProductOnEdit: () => boolean;
66
- /**
67
- * Test if the transfer allow deleteing products when editing (not changing status)
68
- * @param data the request data to verify
69
- * @returns {boolean} true if can delete product
70
- */
71
- static transferAllowDeleteProductOnEdit: (data: ITransferRequest) => boolean;
72
- transferAllowDeleteProductOnEdit: () => boolean;
73
- /**
74
- * Test if the transfer has reached a state where it should display weight
75
- * @param data the request data to verify
76
- * @returns {boolean}
77
- */
78
- static transferShouldDisplayWeight: (data: ITransferRequest) => boolean;
79
- transferShouldDisplayWeight: () => boolean;
80
- /**
81
- * Test if the transfer allows products to be updated without a status change
82
- * @param data the request data to verify
83
- * @returns {boolean}
84
- */
85
- static transferAllowsIndependantProductUpdate: (data: ITransferRequest) => boolean;
86
- transferAllowsIndependantProductUpdate: () => boolean;
87
- fetchAssociatedCart: () => Promise<Cart | undefined>;
88
- addProduct: (sku: string, parent_slug: string, qte: number, name: string, image?: string, other_units?: IFilledDimensionUnits[], weight?: ITransferProductWeight, count_in_pallet_total?: boolean) => boolean;
89
- editProduct: (sku: string, newQte: number) => boolean;
90
- deleteProduct: (sku: string) => boolean;
91
- data: () => ITransferRequest;
92
- isListening: () => boolean;
93
- killListener: () => boolean;
94
- listen: (callback?: () => void) => boolean;
95
- private _getTransferRef;
96
- save: (partial: Partial<ITransferRequest>, saveToDatabase?: boolean, merge?: boolean) => Promise<string | boolean>;
97
- /**
98
- * Validate the quantities set before submit
99
- * @param strictQty Tell if we should only allow equal quantity
100
- * @returns
101
- */
102
- validateBeforeSubmit: (strictQty?: boolean) => Promise<boolean>;
103
- /**
104
- * Strip out the validation qty field in products data
105
- * Do this before saving so the qte_validation doesnt get save in database
106
- * @param copyQte should copy validation qty to the actual qty
107
- */
108
- clearValidationQuantitiesFromProductData: (copyQte?: boolean) => void;
109
- /**
110
- * Add the validation quantities to the received amount
111
- */
112
- addValidationQuantitiesToReceivedQuantities: () => void;
113
- /**
114
- * Return the previous quantity received for the provided sku
115
- * @param sku the product sku to get
116
- * @returns
117
- */
118
- getPreviousReceivedQuantity: (sku: string) => number;
119
- /**
120
- * Return the original reuested quantity
121
- * @param sku the product sku to get
122
- * @returns
123
- */
124
- getOriginalRequestedQuantity: (sku: string) => number;
125
- /**
126
- * Get the quantity at the requested status
127
- * @param sku the product sku
128
- * @param status the status to look for
129
- * @returns the quantity at the specified status
130
- */
131
- getQuantityAtStatus: (sku: string, status: TransferRequestStatusEnum) => number;
132
- private getInventoryQuantitiesStillMissingForCartTransfer;
133
- private handleFreeTransitInventory;
134
- private handleChangeStoreInventory;
135
- /**
136
- * Update transfer's associated cart with new reserved quantities. Called when quantities received for transfer.
137
- */
138
- private handleUpdateAssociatedCartReservedQuantities;
139
- /**
140
- * Use provided update object to construct new products object for current transfer
141
- * @param updatesToDo The product updates to apply
142
- * @param updatesToDo.sku The product sku to update
143
- * @param updatesToDo.ajustementQte The quantity to ajust. Must be negative if quantity REMOVED, and positive if ADDED.
144
- */
145
- constructProductObjFromUpdates: (updatesToDo: {
146
- sku: string;
147
- ajustmentQte: number;
148
- }[]) => ITransferProduct[];
149
- /**
150
- * Will update content in transfer without triggering a status change, if current transfer status permits. Still adds entry to the transfer_updates array.
151
- * @param updatedContent.products The array of products to update product
152
- * @param updatedContent.fromStore The new from store slug value if changed
153
- * @param options Options to create the associated transfer_updates entry
154
- * @param cancelTransferIfAllProductsAtZero Optionnal. If transfer should be auto-cancelled if all products are now at 0 quantities
155
- */
156
- saveUpdatesToContentOnly: (updatedContent: {
157
- products?: ITransferProduct[];
158
- fromStore?: string;
159
- }, options: SaveTransferOptionsType, cancelTransferIfAllProductsAtZero?: boolean, updateContext?: TransferRequestUpdateContextEnum) => Promise<ITransferRequest>;
160
- /**
161
- * Change or set the draft property value
162
- * @param newVal The new value to assign
163
- */
164
- setDraftValue: (newVal: boolean) => void;
165
- /**
166
- * Change or set the associated_order property value
167
- * @param newVal The new value to assign
168
- */
169
- setAssociatedOrder: (newVal: string | null) => void;
170
- /**
171
- * Change or set the transport_ref property value
172
- * @param newVal The new value to assign
173
- * @param saveToDatabase Do we save the new value in the database
174
- */
175
- setTransportRef: (newVal: string, saveToDatabase?: boolean) => Promise<void>;
176
- /**
177
- * Set the original transfer id property value
178
- * @param newVal The new value to assign
179
- */
180
- setOriginalTransferId: (newVal: string | undefined) => Promise<void>;
181
- /**
182
- * Change the completed status to true and save to database
183
- */
184
- setAsCompleted: (user: string, comment?: string) => Promise<void>;
185
- changeStatus: (newStatus: TransferRequestStatusEnum, comment: string | undefined, user: string, saveToDatabase?: boolean, options?: {
186
- setAsCompleted?: boolean;
187
- originalRequestProducts?: ITransferProduct[];
188
- space?: Space | undefined;
189
- context?: TransferRequestUpdateContextEnum;
190
- }) => Promise<ITransferRequest>;
191
- /**
192
- * Generates updates array and saves transfer for the first time in the database.
193
- * @param currentUser
194
- * @param comment
195
- * @param saveToDatabase
196
- * @throws if transfer already has an ID or doesn't have a status set
197
- */
198
- saveNewTransfer: (currentUser: string, comment?: string, saveToDatabase?: boolean, skipRef?: boolean) => Promise<string | boolean>;
199
- /**
200
- * Get the total estimated weight by calculating each product's weigth times inventory quantity
201
- * @param unit the unit to return
202
- * @returns the weight in the requested unit
203
- */
204
- static getTotalWeight: (products: ITransferProduct[], unit?: 'pounds' | 'kilograms') => number;
205
- /**
206
- * Get the total calculated pallet quantities for all transfer items
207
- * @param items
208
- * @returns
209
- */
210
- static getTotalPalletQte: (items: ITransferProduct[]) => number;
211
- /**
212
- * Get the weight of a selected sku in this transfer
213
- * @param sku the product sku
214
- * @param unit the unit to return
215
- * @returns the weight in the requested unit
216
- */
217
- getProductWeight: (sku: string, unit?: 'pounds' | 'kilograms') => number;
218
- /**
219
- * Fetches applicable transfer status order object by checking space_options for current space.
220
- */
221
- private _getOrderObject;
222
- /**
223
- * Checks if provided "new" status follows current transfer status in the correct transfer status order for space.
224
- * @param statusToCheck
225
- */
226
- private _checkIfCanChangeToStatus;
227
- /**
228
- * Creates new entry for a status change, copies transfer_updates property and adds new entry to the start of copied array.
229
- * @param newStatus
230
- * @param user The email (or id) of Addio user that triggered the status change
231
- * @param comment The user added comment for status change (can be undefined)
232
- * @returns The copied array with the new value added.
233
- */
234
- private _generateNewTransferStatusUpdates;
235
- /**
236
- * Saves provided status to TransferRequest data. Also generates and saves new entry for `transfer_updates` array.
237
- * @param newStatus
238
- * @param options
239
- */
240
- private _saveNewStatus;
241
- /**
242
- * Checks update eligibility, then updates status to OPEN.
243
- * @param options
244
- */
245
- private _setAsOpen;
246
- /**
247
- * Checks update eligibility, then updates status to TO_BE_PREPARED.
248
- * @param options
249
- */
250
- private _setAsToBePrepared;
251
- /**
252
- * Checks update eligibility, then updates status to IN_TRANSIT. Also updates inventory for the origin store.
253
- * @param options
254
- */
255
- private _setAsInTransit;
256
- /**
257
- * Checks update eligibility, then updates status to RECEIVED. Also updates inventory for both stores.
258
- * @param options
259
- */
260
- private _setAsReceived;
261
- /**
262
- * Checks update eligibility, then updates status to RECEIVED_PARTIAL. Also updates inventory for both stores.
263
- * @param options
264
- * @todo Update inventory logic to deal with partially received quantities.
265
- */
266
- private _setAsReceivedPartially;
267
- /**
268
- * Checks if transfer can be cancelled, and if so, updates status to CANCELLED.
269
- * @param options
270
- */
271
- private _setAsCancelled;
272
- /**
273
- * Object regrouping all status change functions
274
- */
275
- updateToStatus: {
276
- open: (options: SaveTransferOptionsType) => Promise<void>;
277
- toBePrepared: (options: SaveTransferOptionsType) => Promise<void>;
278
- inTransit: (options: SaveTransferOptionsType) => Promise<void>;
279
- received: (options: SaveTransferOptionsType) => Promise<void>;
280
- receivedPartial: (options: SaveTransferOptionsType) => Promise<void>;
281
- cancelled: (options: SaveTransferOptionsType, context?: TransferRequestUpdateContextEnum) => Promise<void>;
282
- };
283
- /**
284
- * Get formatted ref string for the transfer.
285
- * @param spaceTransferSettings
286
- * @returns {string | undefined}
287
- */
288
- getFormattedRef: (spaceTransferSettings: IOrderInvoiceNumerotation | undefined) => string | undefined;
289
- }
290
- export {};
1
+ /// <reference types="mocha" />
2
+ import { IFilledDimensionUnits } from '../../Interfaces/Declination';
3
+ import ITransferRequest, { ITransferProductWeight, ITransferProduct, TransferRequestStatusEnum, TransferRequestUpdateContextEnum } from '../../Interfaces/TransferRequest';
4
+ import { BaseServiceClass } from '../baseService';
5
+ import Space from '../Space';
6
+ import { IQueryProps } from '../../Interfaces/Product';
7
+ import { SearchResponse } from '@algolia/client-search';
8
+ import Cart from '../Cart';
9
+ import { IOrderInvoiceNumerotation } from '../../Interfaces/Space';
10
+ type SaveTransferOptionsType = {
11
+ readonly comment?: string | undefined;
12
+ readonly user: string;
13
+ readonly markAsCompleted?: boolean;
14
+ readonly saveToDatabase?: boolean;
15
+ readonly originalRequestProducts?: ITransferProduct[];
16
+ readonly space?: Space | undefined;
17
+ };
18
+ export declare class TransferRequest extends BaseServiceClass<ITransferRequest> {
19
+ private _listener;
20
+ private prevProducts;
21
+ private prevFromStore;
22
+ private processData;
23
+ constructor(_data: ITransferRequest, _collection: {
24
+ path: string;
25
+ }, _user: string);
26
+ static fetch: ({ app, api, hpp, page, query, filters, indice, f, space, useProspr }: IQueryProps) => Promise<SearchResponse<ITransferRequest>>;
27
+ static getStatusLabel: (status: TransferRequestStatusEnum) => "Initialisée" | "Ouverte" | "À préparer" | "En transit" | "Annulée" | "Reçue partiellement" | "Reçue";
28
+ static checkIfTransferCanBeCancelled: (currentTransferStatus: TransferRequestStatusEnum, statusOrderObj: {
29
+ [key: number]: TransferRequestStatusEnum[];
30
+ }) => boolean;
31
+ /**
32
+ * Test if the transfer can be closed
33
+ * @returns true if the status allow to close the transfer
34
+ */
35
+ checkIfTransferCanBeClosedManually: () => boolean;
36
+ /**
37
+ * Checks if provided status is included in "completed" transfer statuses list.
38
+ * @param statusToCheck
39
+ */
40
+ static checkIfStatusCountsAsCompleted: (statusToCheck: TransferRequestStatusEnum) => boolean;
41
+ static transferAllowAssignFromStore: (data: ITransferRequest) => boolean;
42
+ transferAllowAssignFromStore: () => boolean;
43
+ static transferAllowEditFromStore: (data: ITransferRequest) => boolean;
44
+ transferAllowEditFromStore: () => boolean;
45
+ /**
46
+ * Test if the transfer allow adding products
47
+ * @param data the request data to verify
48
+ * @returns true if can add product
49
+ */
50
+ static transferAllowAddProductOnEdit: (data: ITransferRequest) => boolean;
51
+ transferAllowAddProductOnEdit: () => boolean;
52
+ /**
53
+ * Test if the transfer allow deleteing products
54
+ * @param data the request data to verify
55
+ * @returns true if can delete product
56
+ */
57
+ static transferAllowProductDelete: (data: ITransferRequest) => boolean;
58
+ transferAllowProductDelete: () => boolean;
59
+ /**
60
+ * Test if the transfer allow editing products
61
+ * @param data the request data to verify
62
+ * @returns true if can be edited
63
+ */
64
+ static transferAllowEditProductOnEdit: (data: ITransferRequest) => boolean;
65
+ transferAllowEditProductOnEdit: () => boolean;
66
+ /**
67
+ * Test if the transfer allow deleteing products when editing (not changing status)
68
+ * @param data the request data to verify
69
+ * @returns {boolean} true if can delete product
70
+ */
71
+ static transferAllowDeleteProductOnEdit: (data: ITransferRequest) => boolean;
72
+ transferAllowDeleteProductOnEdit: () => boolean;
73
+ /**
74
+ * Test if the transfer has reached a state where it should display weight
75
+ * @param data the request data to verify
76
+ * @returns {boolean}
77
+ */
78
+ static transferShouldDisplayWeight: (data: ITransferRequest) => boolean;
79
+ transferShouldDisplayWeight: () => boolean;
80
+ /**
81
+ * Test if the transfer allows products to be updated without a status change
82
+ * @param data the request data to verify
83
+ * @returns {boolean}
84
+ */
85
+ static transferAllowsIndependantProductUpdate: (data: ITransferRequest) => boolean;
86
+ transferAllowsIndependantProductUpdate: () => boolean;
87
+ fetchAssociatedCart: () => Promise<Cart | undefined>;
88
+ addProduct: (sku: string, parent_slug: string, qte: number, name: string, image?: string, other_units?: IFilledDimensionUnits[], weight?: ITransferProductWeight, count_in_pallet_total?: boolean) => boolean;
89
+ editProduct: (sku: string, newQte: number) => boolean;
90
+ deleteProduct: (sku: string) => boolean;
91
+ data: () => ITransferRequest;
92
+ isListening: () => boolean;
93
+ killListener: () => boolean;
94
+ listen: (callback?: () => void) => boolean;
95
+ private _getTransferRef;
96
+ save: (partial: Partial<ITransferRequest>, saveToDatabase?: boolean, merge?: boolean) => Promise<string | boolean>;
97
+ /**
98
+ * Validate the quantities set before submit
99
+ * @param strictQty Tell if we should only allow equal quantity
100
+ * @returns
101
+ */
102
+ validateBeforeSubmit: (strictQty?: boolean) => Promise<boolean>;
103
+ /**
104
+ * Strip out the validation qty field in products data
105
+ * Do this before saving so the qte_validation doesnt get save in database
106
+ * @param copyQte should copy validation qty to the actual qty
107
+ */
108
+ clearValidationQuantitiesFromProductData: (copyQte?: boolean) => void;
109
+ /**
110
+ * Add the validation quantities to the received amount
111
+ */
112
+ addValidationQuantitiesToReceivedQuantities: () => void;
113
+ /**
114
+ * Return the previous quantity received for the provided sku
115
+ * @param sku the product sku to get
116
+ * @returns
117
+ */
118
+ getPreviousReceivedQuantity: (sku: string) => number;
119
+ /**
120
+ * Return the original reuested quantity
121
+ * @param sku the product sku to get
122
+ * @returns
123
+ */
124
+ getOriginalRequestedQuantity: (sku: string) => number;
125
+ /**
126
+ * Get the quantity at the requested status
127
+ * @param sku the product sku
128
+ * @param status the status to look for
129
+ * @returns the quantity at the specified status
130
+ */
131
+ getQuantityAtStatus: (sku: string, status: TransferRequestStatusEnum) => number;
132
+ private getInventoryQuantitiesStillMissingForCartTransfer;
133
+ private handleFreeTransitInventory;
134
+ private handleChangeStoreInventory;
135
+ /**
136
+ * Update transfer's associated cart with new reserved quantities. Called when quantities received for transfer.
137
+ */
138
+ private handleUpdateAssociatedCartReservedQuantities;
139
+ /**
140
+ * Use provided update object to construct new products object for current transfer
141
+ * @param updatesToDo The product updates to apply
142
+ * @param updatesToDo.sku The product sku to update
143
+ * @param updatesToDo.ajustementQte The quantity to ajust. Must be negative if quantity REMOVED, and positive if ADDED.
144
+ */
145
+ constructProductObjFromUpdates: (updatesToDo: {
146
+ sku: string;
147
+ ajustmentQte: number;
148
+ }[]) => ITransferProduct[];
149
+ /**
150
+ * Will update content in transfer without triggering a status change, if current transfer status permits. Still adds entry to the transfer_updates array.
151
+ * @param updatedContent.products The array of products to update product
152
+ * @param updatedContent.fromStore The new from store slug value if changed
153
+ * @param options Options to create the associated transfer_updates entry
154
+ * @param cancelTransferIfAllProductsAtZero Optionnal. If transfer should be auto-cancelled if all products are now at 0 quantities
155
+ */
156
+ saveUpdatesToContentOnly: (updatedContent: {
157
+ products?: ITransferProduct[];
158
+ fromStore?: string;
159
+ }, options: SaveTransferOptionsType, cancelTransferIfAllProductsAtZero?: boolean, updateContext?: TransferRequestUpdateContextEnum) => Promise<ITransferRequest>;
160
+ /**
161
+ * Change or set the draft property value
162
+ * @param newVal The new value to assign
163
+ */
164
+ setDraftValue: (newVal: boolean) => void;
165
+ /**
166
+ * Change or set the associated_order property value
167
+ * @param newVal The new value to assign
168
+ */
169
+ setAssociatedOrder: (newVal: string | null) => void;
170
+ /**
171
+ * Change or set the transport_ref property value
172
+ * @param newVal The new value to assign
173
+ * @param saveToDatabase Do we save the new value in the database
174
+ */
175
+ setTransportRef: (newVal: string, saveToDatabase?: boolean) => Promise<void>;
176
+ /**
177
+ * Set the original transfer id property value
178
+ * @param newVal The new value to assign
179
+ */
180
+ setOriginalTransferId: (newVal: string | undefined) => Promise<void>;
181
+ /**
182
+ * Change the completed status to true and save to database
183
+ */
184
+ setAsCompleted: (user: string, comment?: string) => Promise<void>;
185
+ changeStatus: (newStatus: TransferRequestStatusEnum, comment: string | undefined, user: string, saveToDatabase?: boolean, options?: {
186
+ setAsCompleted?: boolean;
187
+ originalRequestProducts?: ITransferProduct[];
188
+ space?: Space | undefined;
189
+ context?: TransferRequestUpdateContextEnum;
190
+ }) => Promise<ITransferRequest>;
191
+ /**
192
+ * Generates updates array and saves transfer for the first time in the database.
193
+ * @param currentUser
194
+ * @param comment
195
+ * @param saveToDatabase
196
+ * @throws if transfer already has an ID or doesn't have a status set
197
+ */
198
+ saveNewTransfer: (currentUser: string, comment?: string, saveToDatabase?: boolean, skipRef?: boolean) => Promise<string | boolean>;
199
+ /**
200
+ * Get the total estimated weight by calculating each product's weigth times inventory quantity
201
+ * @param unit the unit to return
202
+ * @returns the weight in the requested unit
203
+ */
204
+ static getTotalWeight: (products: ITransferProduct[], unit?: 'pounds' | 'kilograms') => number;
205
+ /**
206
+ * Get the total calculated pallet quantities for all transfer items
207
+ * @param items
208
+ * @returns
209
+ */
210
+ static getTotalPalletQte: (items: ITransferProduct[]) => number;
211
+ /**
212
+ * Get the weight of a selected sku in this transfer
213
+ * @param sku the product sku
214
+ * @param unit the unit to return
215
+ * @returns the weight in the requested unit
216
+ */
217
+ getProductWeight: (sku: string, unit?: 'pounds' | 'kilograms') => number;
218
+ /**
219
+ * Fetches applicable transfer status order object by checking space_options for current space.
220
+ */
221
+ private _getOrderObject;
222
+ /**
223
+ * Checks if provided "new" status follows current transfer status in the correct transfer status order for space.
224
+ * @param statusToCheck
225
+ */
226
+ private _checkIfCanChangeToStatus;
227
+ /**
228
+ * Creates new entry for a status change, copies transfer_updates property and adds new entry to the start of copied array.
229
+ * @param newStatus
230
+ * @param user The email (or id) of Addio user that triggered the status change
231
+ * @param comment The user added comment for status change (can be undefined)
232
+ * @returns The copied array with the new value added.
233
+ */
234
+ private _generateNewTransferStatusUpdates;
235
+ /**
236
+ * Saves provided status to TransferRequest data. Also generates and saves new entry for `transfer_updates` array.
237
+ * @param newStatus
238
+ * @param options
239
+ */
240
+ private _saveNewStatus;
241
+ /**
242
+ * Checks update eligibility, then updates status to OPEN.
243
+ * @param options
244
+ */
245
+ private _setAsOpen;
246
+ /**
247
+ * Checks update eligibility, then updates status to TO_BE_PREPARED.
248
+ * @param options
249
+ */
250
+ private _setAsToBePrepared;
251
+ /**
252
+ * Checks update eligibility, then updates status to IN_TRANSIT. Also updates inventory for the origin store.
253
+ * @param options
254
+ */
255
+ private _setAsInTransit;
256
+ /**
257
+ * Checks update eligibility, then updates status to RECEIVED. Also updates inventory for both stores.
258
+ * @param options
259
+ */
260
+ private _setAsReceived;
261
+ /**
262
+ * Checks update eligibility, then updates status to RECEIVED_PARTIAL. Also updates inventory for both stores.
263
+ * @param options
264
+ * @todo Update inventory logic to deal with partially received quantities.
265
+ */
266
+ private _setAsReceivedPartially;
267
+ /**
268
+ * Checks if transfer can be cancelled, and if so, updates status to CANCELLED.
269
+ * @param options
270
+ */
271
+ private _setAsCancelled;
272
+ /**
273
+ * Object regrouping all status change functions
274
+ */
275
+ updateToStatus: {
276
+ open: (options: SaveTransferOptionsType) => Promise<void>;
277
+ toBePrepared: (options: SaveTransferOptionsType) => Promise<void>;
278
+ inTransit: (options: SaveTransferOptionsType) => Promise<void>;
279
+ received: (options: SaveTransferOptionsType) => Promise<void>;
280
+ receivedPartial: (options: SaveTransferOptionsType) => Promise<void>;
281
+ cancelled: (options: SaveTransferOptionsType, context?: TransferRequestUpdateContextEnum) => Promise<void>;
282
+ };
283
+ /**
284
+ * Get formatted ref string for the transfer.
285
+ * @param spaceTransferSettings
286
+ * @returns {string | undefined}
287
+ */
288
+ getFormattedRef: (spaceTransferSettings: IOrderInvoiceNumerotation | undefined) => string | undefined;
289
+ }
290
+ export {};