addio-admin-sdk 1.7.144 → 1.7.145

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 (575) hide show
  1. package/.babelrc +17 -17
  2. package/.claude/settings.local.json +7 -0
  3. package/.env +14 -0
  4. package/.env.dev +14 -14
  5. package/.github/workflows/run_unit_test.yaml +48 -48
  6. package/addio-sdk-doc.md +1473 -1473
  7. package/changelog.md +564 -564
  8. package/dist/Interfaces/Address/index.d.ts +21 -21
  9. package/dist/Interfaces/Address/index.js +16 -16
  10. package/dist/Interfaces/Algolia/index.d.ts +177 -177
  11. package/dist/Interfaces/Algolia/index.js +2 -2
  12. package/dist/Interfaces/Attachement/index.d.ts +5 -5
  13. package/dist/Interfaces/Attachement/index.js +2 -2
  14. package/dist/Interfaces/Attribute/index.d.ts +53 -53
  15. package/dist/Interfaces/Attribute/index.js +10 -10
  16. package/dist/Interfaces/BGJob/index.d.ts +56 -56
  17. package/dist/Interfaces/BGJob/index.js +25 -25
  18. package/dist/Interfaces/BaseClass/index.d.ts +8 -8
  19. package/dist/Interfaces/BaseClass/index.js +2 -2
  20. package/dist/Interfaces/Blog/IBlogArticle.d.ts +18 -18
  21. package/dist/Interfaces/Blog/IBlogArticle.js +2 -2
  22. package/dist/Interfaces/Blog/IBlogAuthor.d.ts +7 -7
  23. package/dist/Interfaces/Blog/IBlogAuthor.js +2 -2
  24. package/dist/Interfaces/Blog/IBlogCategory.d.ts +9 -9
  25. package/dist/Interfaces/Blog/IBlogCategory.js +2 -2
  26. package/dist/Interfaces/Blog/IBlogComment.d.ts +13 -13
  27. package/dist/Interfaces/Blog/IBlogComment.js +2 -2
  28. package/dist/Interfaces/Blog/IBlogKeywords.d.ts +9 -9
  29. package/dist/Interfaces/Blog/IBlogKeywords.js +2 -2
  30. package/dist/Interfaces/Booking/index.d.ts +74 -74
  31. package/dist/Interfaces/Booking/index.js +17 -17
  32. package/dist/Interfaces/Brand/index.d.ts +15 -15
  33. package/dist/Interfaces/Brand/index.js +2 -2
  34. package/dist/Interfaces/CMS/index.d.ts +28 -28
  35. package/dist/Interfaces/CMS/index.js +5 -5
  36. package/dist/Interfaces/Cart/IElavonPayload.d.ts +93 -93
  37. package/dist/Interfaces/Cart/IElavonPayload.js +17 -17
  38. package/dist/Interfaces/Cart/IPandaPayload.d.ts +64 -64
  39. package/dist/Interfaces/Cart/IPandaPayload.js +18 -18
  40. package/dist/Interfaces/Cart/IPaymentCard.d.ts +22 -22
  41. package/dist/Interfaces/Cart/IPaymentCard.js +44 -44
  42. package/dist/Interfaces/Cart/IPaypalPayload.d.ts +9 -9
  43. package/dist/Interfaces/Cart/IPaypalPayload.js +2 -2
  44. package/dist/Interfaces/Cart/IPaysafePayload.d.ts +72 -72
  45. package/dist/Interfaces/Cart/IPaysafePayload.js +2 -2
  46. package/dist/Interfaces/Cart/IStripePayload.d.ts +66 -66
  47. package/dist/Interfaces/Cart/IStripePayload.js +2 -2
  48. package/dist/Interfaces/Cart/index.d.ts +444 -444
  49. package/dist/Interfaces/Cart/index.js +197 -197
  50. package/dist/Interfaces/CartReservedQuantities/index.d.ts +10 -10
  51. package/dist/Interfaces/CartReservedQuantities/index.js +2 -2
  52. package/dist/Interfaces/CashDrawers/index.d.ts +37 -37
  53. package/dist/Interfaces/CashDrawers/index.js +19 -19
  54. package/dist/Interfaces/Catalogue/index.d.ts +68 -68
  55. package/dist/Interfaces/Catalogue/index.js +37 -37
  56. package/dist/Interfaces/Category/index.d.ts +33 -33
  57. package/dist/Interfaces/Category/index.js +2 -2
  58. package/dist/Interfaces/Chart/index.d.ts +11 -11
  59. package/dist/Interfaces/Chart/index.js +2 -2
  60. package/dist/Interfaces/Class/index.d.ts +8 -8
  61. package/dist/Interfaces/Class/index.js +2 -2
  62. package/dist/Interfaces/Consent/index.d.ts +6 -6
  63. package/dist/Interfaces/Consent/index.js +2 -2
  64. package/dist/Interfaces/Context/IContextProps.d.ts +4 -4
  65. package/dist/Interfaces/Context/IContextProps.js +2 -2
  66. package/dist/Interfaces/Context/IContextState.d.ts +15 -15
  67. package/dist/Interfaces/Context/IContextState.js +2 -2
  68. package/dist/Interfaces/Customer/ICustomerBadge.d.ts +2 -2
  69. package/dist/Interfaces/Customer/ICustomerBadge.js +2 -2
  70. package/dist/Interfaces/Customer/ICustomerRating.d.ts +10 -10
  71. package/dist/Interfaces/Customer/ICustomerRating.js +2 -2
  72. package/dist/Interfaces/Customer/IStoreCredit.d.ts +13 -13
  73. package/dist/Interfaces/Customer/IStoreCredit.js +2 -2
  74. package/dist/Interfaces/Customer/index.d.ts +104 -104
  75. package/dist/Interfaces/Customer/index.js +148 -148
  76. package/dist/Interfaces/Declination/index.d.ts +117 -117
  77. package/dist/Interfaces/Declination/index.js +66 -66
  78. package/dist/Interfaces/Document/index.d.ts +8 -8
  79. package/dist/Interfaces/Document/index.js +2 -2
  80. package/dist/Interfaces/Elastic/index.d.ts +89 -89
  81. package/dist/Interfaces/Elastic/index.js +2 -2
  82. package/dist/Interfaces/Email/CustomGR/I3DPrintEmail.d.ts +11 -11
  83. package/dist/Interfaces/Email/CustomGR/I3DPrintEmail.js +2 -2
  84. package/dist/Interfaces/Email/CustomGR/IBorrowToolsEmail.d.ts +15 -15
  85. package/dist/Interfaces/Email/CustomGR/IBorrowToolsEmail.js +2 -2
  86. package/dist/Interfaces/Email/CustomGR/IPickupMaterialsEmail.d.ts +12 -12
  87. package/dist/Interfaces/Email/CustomGR/IPickupMaterialsEmail.js +2 -2
  88. package/dist/Interfaces/Email/CustomGR/IPreMeetingFormEmail.d.ts +36 -36
  89. package/dist/Interfaces/Email/CustomGR/IPreMeetingFormEmail.js +2 -2
  90. package/dist/Interfaces/Email/CustomGR/ISponsorRequestEmail.d.ts +12 -12
  91. package/dist/Interfaces/Email/CustomGR/ISponsorRequestEmail.js +2 -2
  92. package/dist/Interfaces/Email/CustomGR/ITransportEmail.d.ts +12 -12
  93. package/dist/Interfaces/Email/CustomGR/ITransportEmail.js +2 -2
  94. package/dist/Interfaces/Email/CustomGR/ITransportQuoteEmail.d.ts +12 -12
  95. package/dist/Interfaces/Email/CustomGR/ITransportQuoteEmail.js +2 -2
  96. package/dist/Interfaces/Email/CustomGR/IVegetalsEmail.d.ts +16 -16
  97. package/dist/Interfaces/Email/CustomGR/IVegetalsEmail.js +2 -2
  98. package/dist/Interfaces/Email/CustomGR/IWishlistEmail.d.ts +15 -15
  99. package/dist/Interfaces/Email/CustomGR/IWishlistEmail.js +2 -2
  100. package/dist/Interfaces/Email/IAbandonnedCartEmail.d.ts +29 -29
  101. package/dist/Interfaces/Email/IAbandonnedCartEmail.js +2 -2
  102. package/dist/Interfaces/Email/IAccountConfirmationEmail.d.ts +22 -22
  103. package/dist/Interfaces/Email/IAccountConfirmationEmail.js +2 -2
  104. package/dist/Interfaces/Email/IApplicationEmail.d.ts +19 -19
  105. package/dist/Interfaces/Email/IApplicationEmail.js +2 -2
  106. package/dist/Interfaces/Email/IBackInStockEmail.d.ts +21 -21
  107. package/dist/Interfaces/Email/IBackInStockEmail.js +2 -2
  108. package/dist/Interfaces/Email/IContactEmail.d.ts +20 -20
  109. package/dist/Interfaces/Email/IContactEmail.js +2 -2
  110. package/dist/Interfaces/Email/ICustomerBookingAdminEmail.d.ts +15 -15
  111. package/dist/Interfaces/Email/ICustomerBookingAdminEmail.js +2 -2
  112. package/dist/Interfaces/Email/ICustomerBookingEmail.d.ts +14 -14
  113. package/dist/Interfaces/Email/ICustomerBookingEmail.js +2 -2
  114. package/dist/Interfaces/Email/IEmail.d.ts +20 -20
  115. package/dist/Interfaces/Email/IEmail.js +60 -60
  116. package/dist/Interfaces/Email/IOrderConfirmationEmail.d.ts +47 -47
  117. package/dist/Interfaces/Email/IOrderConfirmationEmail.js +2 -2
  118. package/dist/Interfaces/Email/IPasswordResetEmail.d.ts +17 -17
  119. package/dist/Interfaces/Email/IPasswordResetEmail.js +2 -2
  120. package/dist/Interfaces/Email/IPhotoShootEmail.d.ts +14 -14
  121. package/dist/Interfaces/Email/IPhotoShootEmail.js +2 -2
  122. package/dist/Interfaces/Email/IPickupConfirmation.d.ts +23 -23
  123. package/dist/Interfaces/Email/IPickupConfirmation.js +2 -2
  124. package/dist/Interfaces/Email/IShippingConfirmation.d.ts +23 -23
  125. package/dist/Interfaces/Email/IShippingConfirmation.js +2 -2
  126. package/dist/Interfaces/Email/IWelcomeEmail.d.ts +19 -19
  127. package/dist/Interfaces/Email/IWelcomeEmail.js +2 -2
  128. package/dist/Interfaces/ExportSchema/index.d.ts +7 -7
  129. package/dist/Interfaces/ExportSchema/index.js +2 -2
  130. package/dist/Interfaces/ExternalService/BaseExternalService.d.ts +12 -12
  131. package/dist/Interfaces/ExternalService/BaseExternalService.js +2 -2
  132. package/dist/Interfaces/ExternalService/ExternalProductsService.d.ts +4 -4
  133. package/dist/Interfaces/ExternalService/ExternalProductsService.js +2 -2
  134. package/dist/Interfaces/ExternalService/index.d.ts +9 -9
  135. package/dist/Interfaces/ExternalService/index.js +2 -2
  136. package/dist/Interfaces/FirstOrderTracking/index.d.ts +5 -5
  137. package/dist/Interfaces/FirstOrderTracking/index.js +2 -2
  138. package/dist/Interfaces/G2/index.d.ts +556 -556
  139. package/dist/Interfaces/G2/index.js +38 -38
  140. package/dist/Interfaces/Indexed/Product/IIndexedLastSavedProduct.d.ts +20 -20
  141. package/dist/Interfaces/Indexed/Product/IIndexedLastSavedProduct.js +2 -2
  142. package/dist/Interfaces/Indexed/Product/index.d.ts +105 -105
  143. package/dist/Interfaces/Indexed/Product/index.js +253 -253
  144. package/dist/Interfaces/Inventory/index.d.ts +19 -19
  145. package/dist/Interfaces/Inventory/index.js +8 -8
  146. package/dist/Interfaces/Invoice/index.d.ts +4 -4
  147. package/dist/Interfaces/Invoice/index.js +2 -2
  148. package/dist/Interfaces/MarketplacePublication/MarketplaceOrderData.d.ts +3 -3
  149. package/dist/Interfaces/MarketplacePublication/MarketplaceOrderData.js +2 -2
  150. package/dist/Interfaces/MarketplacePublication/index.d.ts +23 -23
  151. package/dist/Interfaces/MarketplacePublication/index.js +22 -22
  152. package/dist/Interfaces/Menu/index.d.ts +40 -40
  153. package/dist/Interfaces/Menu/index.js +16 -16
  154. package/dist/Interfaces/Note/index.d.ts +10 -10
  155. package/dist/Interfaces/Note/index.js +7 -7
  156. package/dist/Interfaces/Operations/ICreatedBy.d.ts +6 -6
  157. package/dist/Interfaces/Operations/ICreatedBy.js +2 -2
  158. package/dist/Interfaces/Operations/IUpdate.d.ts +5 -5
  159. package/dist/Interfaces/Operations/IUpdate.js +2 -2
  160. package/dist/Interfaces/Order/index.d.ts +4 -4
  161. package/dist/Interfaces/Order/index.js +2 -2
  162. package/dist/Interfaces/Org/IRelUser.d.ts +9 -9
  163. package/dist/Interfaces/Org/IRelUser.js +2 -2
  164. package/dist/Interfaces/Org/index.d.ts +29 -29
  165. package/dist/Interfaces/Org/index.js +12 -12
  166. package/dist/Interfaces/Payment/index.d.ts +26 -26
  167. package/dist/Interfaces/Payment/index.js +14 -14
  168. package/dist/Interfaces/Product/IAttributeFamily.d.ts +6 -6
  169. package/dist/Interfaces/Product/IAttributeFamily.js +2 -2
  170. package/dist/Interfaces/Product/IImportProduct.d.ts +42 -42
  171. package/dist/Interfaces/Product/IImportProduct.js +882 -882
  172. package/dist/Interfaces/Product/IInventoryItem.d.ts +74 -74
  173. package/dist/Interfaces/Product/IInventoryItem.js +38 -38
  174. package/dist/Interfaces/Product/IPricing.d.ts +177 -177
  175. package/dist/Interfaces/Product/IPricing.js +180 -180
  176. package/dist/Interfaces/Product/index.d.ts +138 -138
  177. package/dist/Interfaces/Product/index.js +64 -64
  178. package/dist/Interfaces/ProductAttribute/index.d.ts +11 -11
  179. package/dist/Interfaces/ProductAttribute/index.js +2 -2
  180. package/dist/Interfaces/PromiseToPurchase/BankType.d.ts +41 -41
  181. package/dist/Interfaces/PromiseToPurchase/BankType.js +41 -41
  182. package/dist/Interfaces/PromiseToPurchase/IIndexedBankUsed.d.ts +33 -33
  183. package/dist/Interfaces/PromiseToPurchase/IIndexedBankUsed.js +15 -15
  184. package/dist/Interfaces/PromiseToPurchase/IIndexedCustomerPromiseToPurchase.d.ts +19 -19
  185. package/dist/Interfaces/PromiseToPurchase/IIndexedCustomerPromiseToPurchase.js +2 -2
  186. package/dist/Interfaces/PromiseToPurchase/index.d.ts +50 -50
  187. package/dist/Interfaces/PromiseToPurchase/index.js +13 -13
  188. package/dist/Interfaces/PurchaseOrder/index.d.ts +17 -17
  189. package/dist/Interfaces/PurchaseOrder/index.js +2 -2
  190. package/dist/Interfaces/Query/IBrandQueryOptions.d.ts +11 -11
  191. package/dist/Interfaces/Query/IBrandQueryOptions.js +2 -2
  192. package/dist/Interfaces/Query/ICategoryQueryOptions.d.ts +11 -11
  193. package/dist/Interfaces/Query/ICategoryQueryOptions.js +2 -2
  194. package/dist/Interfaces/Query/IProductQueryOptions.d.ts +16 -16
  195. package/dist/Interfaces/Query/IProductQueryOptions.js +2 -2
  196. package/dist/Interfaces/Quote/index.d.ts +5 -5
  197. package/dist/Interfaces/Quote/index.js +2 -2
  198. package/dist/Interfaces/Refunds/index.d.ts +106 -106
  199. package/dist/Interfaces/Refunds/index.js +2 -2
  200. package/dist/Interfaces/Rules/IDiscountRule.d.ts +155 -155
  201. package/dist/Interfaces/Rules/IDiscountRule.js +114 -114
  202. package/dist/Interfaces/Schedule/index.d.ts +48 -48
  203. package/dist/Interfaces/Schedule/index.js +2 -2
  204. package/dist/Interfaces/Services/IAddServiceResponse.d.ts +4 -4
  205. package/dist/Interfaces/Services/IAddServiceResponse.js +2 -2
  206. package/dist/Interfaces/Services/IService.d.ts +16 -16
  207. package/dist/Interfaces/Services/IService.js +2 -2
  208. package/dist/Interfaces/Services/IServiceSecret.d.ts +8 -8
  209. package/dist/Interfaces/Services/IServiceSecret.js +2 -2
  210. package/dist/Interfaces/Shipping/Shipstation/carriers.d.ts +10 -10
  211. package/dist/Interfaces/Shipping/Shipstation/carriers.js +2 -2
  212. package/dist/Interfaces/Shipping/Shipstation/order.d.ts +227 -227
  213. package/dist/Interfaces/Shipping/Shipstation/order.js +2 -2
  214. package/dist/Interfaces/Shipping/Shipstation/quote.d.ts +31 -31
  215. package/dist/Interfaces/Shipping/Shipstation/quote.js +2 -2
  216. package/dist/Interfaces/Shipping/Shiptime/order.d.ts +54 -54
  217. package/dist/Interfaces/Shipping/Shiptime/order.js +71 -71
  218. package/dist/Interfaces/Shipping/Shiptime/quote.d.ts +111 -111
  219. package/dist/Interfaces/Shipping/Shiptime/quote.js +2 -2
  220. package/dist/Interfaces/Slider/GR.d.ts +114 -114
  221. package/dist/Interfaces/Slider/GR.js +271 -271
  222. package/dist/Interfaces/Slider/index.d.ts +30 -30
  223. package/dist/Interfaces/Slider/index.js +2 -2
  224. package/dist/Interfaces/Space/IExternalService.d.ts +53 -53
  225. package/dist/Interfaces/Space/IExternalService.js +44 -44
  226. package/dist/Interfaces/Space/IMember.d.ts +16 -16
  227. package/dist/Interfaces/Space/IMember.js +9 -9
  228. package/dist/Interfaces/Space/index.d.ts +407 -405
  229. package/dist/Interfaces/Space/index.js +174 -174
  230. package/dist/Interfaces/Space/index.js.map +1 -1
  231. package/dist/Interfaces/Specials/gr.d.ts +61 -61
  232. package/dist/Interfaces/Specials/gr.js +2 -2
  233. package/dist/Interfaces/StockNotification/index.d.ts +7 -7
  234. package/dist/Interfaces/StockNotification/index.js +2 -2
  235. package/dist/Interfaces/Store/index.d.ts +63 -63
  236. package/dist/Interfaces/Store/index.js +27 -27
  237. package/dist/Interfaces/Supplier/ICommand.d.ts +11 -11
  238. package/dist/Interfaces/Supplier/ICommand.js +2 -2
  239. package/dist/Interfaces/Supplier/index.d.ts +36 -36
  240. package/dist/Interfaces/Supplier/index.js +24 -24
  241. package/dist/Interfaces/TCG/index.d.ts +161 -161
  242. package/dist/Interfaces/TCG/index.js +54 -54
  243. package/dist/Interfaces/Tag/index.d.ts +18 -18
  244. package/dist/Interfaces/Tag/index.js +2 -2
  245. package/dist/Interfaces/Tax/index.d.ts +13 -13
  246. package/dist/Interfaces/Tax/index.js +2 -2
  247. package/dist/Interfaces/TransferRequest/index.d.ts +103 -103
  248. package/dist/Interfaces/TransferRequest/index.js +46 -46
  249. package/dist/Interfaces/Translation/index.d.ts +8 -8
  250. package/dist/Interfaces/Translation/index.js +5 -5
  251. package/dist/Interfaces/Update/index.d.ts +10 -10
  252. package/dist/Interfaces/Update/index.js +2 -2
  253. package/dist/Interfaces/User/IUser.d.ts +65 -65
  254. package/dist/Interfaces/User/IUser.js +8 -8
  255. package/dist/Interfaces/Version/index.d.ts +11 -11
  256. package/dist/Interfaces/Version/index.js +2 -2
  257. package/dist/Interfaces/Wishlist/index.d.ts +7 -7
  258. package/dist/Interfaces/Wishlist/index.js +2 -2
  259. package/dist/constants/Interfaces/IBaseApi.d.ts +15 -15
  260. package/dist/constants/Interfaces/IBaseApi.js +2 -2
  261. package/dist/constants/Interfaces/IEndpointResult.d.ts +9 -9
  262. package/dist/constants/Interfaces/IEndpointResult.js +2 -2
  263. package/dist/constants/enums.d.ts +6 -6
  264. package/dist/constants/enums.js +10 -10
  265. package/dist/constants/services.d.ts +2 -2
  266. package/dist/constants/services.js +117 -117
  267. package/dist/constants/version.d.ts +2 -2
  268. package/dist/constants/version.js +5 -5
  269. package/dist/index.d.ts +50 -50
  270. package/dist/index.js +266 -266
  271. package/dist/lib/Attribute/index.d.ts +14 -14
  272. package/dist/lib/Attribute/index.js +186 -186
  273. package/dist/lib/BGJob/index.d.ts +9 -9
  274. package/dist/lib/BGJob/index.js +216 -216
  275. package/dist/lib/BackgroundWorker/index.d.ts +34 -34
  276. package/dist/lib/BackgroundWorker/index.js +59 -59
  277. package/dist/lib/Blog/BlogArticle.d.ts +5 -5
  278. package/dist/lib/Blog/BlogArticle.js +10 -10
  279. package/dist/lib/Blog/BlogAuthor.d.ts +5 -5
  280. package/dist/lib/Blog/BlogAuthor.js +10 -10
  281. package/dist/lib/Blog/BlogCategory.d.ts +5 -5
  282. package/dist/lib/Blog/BlogCategory.js +10 -10
  283. package/dist/lib/Blog/BlogKeyword.d.ts +5 -5
  284. package/dist/lib/Blog/BlogKeyword.js +10 -10
  285. package/dist/lib/Booking/index.d.ts +85 -85
  286. package/dist/lib/Booking/index.js +596 -596
  287. package/dist/lib/Brand/index.d.ts +26 -26
  288. package/dist/lib/Brand/index.js +131 -131
  289. package/dist/lib/Cart/index.d.ts +335 -335
  290. package/dist/lib/Cart/index.js +3977 -3977
  291. package/dist/lib/CartReservedQuantities/index.d.ts +49 -49
  292. package/dist/lib/CartReservedQuantities/index.js +159 -159
  293. package/dist/lib/CashDrawerShift/index.d.ts +83 -83
  294. package/dist/lib/CashDrawerShift/index.js +205 -205
  295. package/dist/lib/Catalogue/index.d.ts +15 -15
  296. package/dist/lib/Catalogue/index.js +78 -78
  297. package/dist/lib/Category/index.d.ts +34 -34
  298. package/dist/lib/Category/index.js +230 -230
  299. package/dist/lib/Class/index.d.ts +16 -16
  300. package/dist/lib/Class/index.js +66 -66
  301. package/dist/lib/Consent/index.d.ts +4 -4
  302. package/dist/lib/Consent/index.js +29 -29
  303. package/dist/lib/Customer/index.d.ts +30 -30
  304. package/dist/lib/Customer/index.js +92 -92
  305. package/dist/lib/Declination/index.d.ts +9 -9
  306. package/dist/lib/Declination/index.js +26 -26
  307. package/dist/lib/Discount/index.d.ts +27 -27
  308. package/dist/lib/Discount/index.js +493 -493
  309. package/dist/lib/ElasticSearch/index.d.ts +13 -13
  310. package/dist/lib/ElasticSearch/index.js +50 -50
  311. package/dist/lib/Elavon/index.d.ts +18 -18
  312. package/dist/lib/Elavon/index.js +135 -135
  313. package/dist/lib/Email/AbandonedCartEmail.d.ts +16 -16
  314. package/dist/lib/Email/AbandonedCartEmail.js +24 -24
  315. package/dist/lib/Email/AccountConfirmationEmail.d.ts +19 -19
  316. package/dist/lib/Email/AccountConfirmationEmail.js +30 -30
  317. package/dist/lib/Email/AdminOrderConfirmationEmail.d.ts +16 -16
  318. package/dist/lib/Email/AdminOrderConfirmationEmail.js +24 -24
  319. package/dist/lib/Email/ApplicationEmail.d.ts +16 -16
  320. package/dist/lib/Email/ApplicationEmail.js +24 -24
  321. package/dist/lib/Email/BackInStockEmail.d.ts +16 -16
  322. package/dist/lib/Email/BackInStockEmail.js +24 -24
  323. package/dist/lib/Email/ContactEmail.d.ts +16 -16
  324. package/dist/lib/Email/ContactEmail.js +24 -24
  325. package/dist/lib/Email/CustomerBookingAdminEmail.d.ts +16 -16
  326. package/dist/lib/Email/CustomerBookingAdminEmail.js +24 -24
  327. package/dist/lib/Email/CustomerBookingEmail.d.ts +16 -16
  328. package/dist/lib/Email/CustomerBookingEmail.js +24 -24
  329. package/dist/lib/Email/OrderConfirmationEmail.d.ts +16 -16
  330. package/dist/lib/Email/OrderConfirmationEmail.js +24 -24
  331. package/dist/lib/Email/OrderDenounciationEmail.d.ts +16 -16
  332. package/dist/lib/Email/OrderDenounciationEmail.js +24 -24
  333. package/dist/lib/Email/OrderSampleEmail.d.ts +16 -16
  334. package/dist/lib/Email/OrderSampleEmail.js +24 -24
  335. package/dist/lib/Email/OtherTypeEmails.d.ts +16 -16
  336. package/dist/lib/Email/OtherTypeEmails.js +27 -27
  337. package/dist/lib/Email/PasswordResetEmail.d.ts +16 -16
  338. package/dist/lib/Email/PasswordResetEmail.js +24 -24
  339. package/dist/lib/Email/PhotoShootEmail.d.ts +16 -16
  340. package/dist/lib/Email/PhotoShootEmail.js +24 -24
  341. package/dist/lib/Email/PickUpConfirmation.d.ts +16 -16
  342. package/dist/lib/Email/PickUpConfirmation.js +24 -24
  343. package/dist/lib/Email/ShippingConfirmation.d.ts +16 -16
  344. package/dist/lib/Email/ShippingConfirmation.js +24 -24
  345. package/dist/lib/Email/WelcomeEmail.d.ts +16 -16
  346. package/dist/lib/Email/WelcomeEmail.js +24 -24
  347. package/dist/lib/Email/index.d.ts +16 -16
  348. package/dist/lib/Email/index.js +31 -31
  349. package/dist/lib/ExternalService/Ebay.d.ts +74 -74
  350. package/dist/lib/ExternalService/Ebay.js +124 -124
  351. package/dist/lib/ExternalService/index.d.ts +5 -5
  352. package/dist/lib/ExternalService/index.js +10 -10
  353. package/dist/lib/FirstOrderTracking/index.d.ts +5 -5
  354. package/dist/lib/FirstOrderTracking/index.js +10 -10
  355. package/dist/lib/Indexed/IndexedCart.d.ts +13 -13
  356. package/dist/lib/Indexed/IndexedCart.js +91 -91
  357. package/dist/lib/Indexed/Product.d.ts +17 -17
  358. package/dist/lib/Indexed/Product.js +98 -98
  359. package/dist/lib/Inventory/index.d.ts +112 -112
  360. package/dist/lib/Inventory/index.js +492 -492
  361. package/dist/lib/Invoice/index.d.ts +16 -16
  362. package/dist/lib/Invoice/index.js +21 -21
  363. package/dist/lib/MarketplacePublication/index.d.ts +9 -9
  364. package/dist/lib/MarketplacePublication/index.js +426 -426
  365. package/dist/lib/Menu/index.d.ts +11 -11
  366. package/dist/lib/Menu/index.js +107 -107
  367. package/dist/lib/MongoDB/BaseAPI.d.ts +18 -18
  368. package/dist/lib/MongoDB/BaseAPI.js +200 -200
  369. package/dist/lib/Note/index.d.ts +4 -4
  370. package/dist/lib/Note/index.js +6 -6
  371. package/dist/lib/Order/index.d.ts +27 -27
  372. package/dist/lib/Order/index.js +56 -56
  373. package/dist/lib/Org/index.d.ts +68 -68
  374. package/dist/lib/Org/index.js +216 -216
  375. package/dist/lib/PandaPay/index.d.ts +16 -16
  376. package/dist/lib/PandaPay/index.js +176 -176
  377. package/dist/lib/Paysafe/index.d.ts +11 -11
  378. package/dist/lib/Paysafe/index.js +41 -41
  379. package/dist/lib/Product/index.d.ts +182 -182
  380. package/dist/lib/Product/index.js +847 -847
  381. package/dist/lib/ProductAttribute/index.d.ts +15 -15
  382. package/dist/lib/ProductAttribute/index.js +45 -45
  383. package/dist/lib/PromiseToPurchase/index.d.ts +109 -109
  384. package/dist/lib/PromiseToPurchase/index.js +343 -343
  385. package/dist/lib/PurchaseOrder/index.d.ts +20 -20
  386. package/dist/lib/PurchaseOrder/index.js +28 -28
  387. package/dist/lib/Schedule/index.d.ts +5 -5
  388. package/dist/lib/Schedule/index.js +12 -12
  389. package/dist/lib/Service/Enum/ServiceEnum.d.ts +3 -3
  390. package/dist/lib/Service/Enum/ServiceEnum.js +7 -7
  391. package/dist/lib/Service/index.d.ts +13 -13
  392. package/dist/lib/Service/index.js +21 -21
  393. package/dist/lib/Shipment/index.d.ts +28 -28
  394. package/dist/lib/Shipment/index.js +370 -370
  395. package/dist/lib/Slider/index.d.ts +22 -22
  396. package/dist/lib/Slider/index.js +119 -119
  397. package/dist/lib/Space/index.d.ts +1150 -1150
  398. package/dist/lib/Space/index.js +5792 -5792
  399. package/dist/lib/StockNotification/index.d.ts +4 -4
  400. package/dist/lib/StockNotification/index.js +6 -6
  401. package/dist/lib/Store/index.d.ts +5 -5
  402. package/dist/lib/Store/index.js +12 -12
  403. package/dist/lib/Supplier/Command.d.ts +5 -5
  404. package/dist/lib/Supplier/Command.js +10 -10
  405. package/dist/lib/Supplier/index.d.ts +25 -25
  406. package/dist/lib/Supplier/index.js +27 -27
  407. package/dist/lib/Tags/index.d.ts +6 -6
  408. package/dist/lib/Tags/index.js +26 -26
  409. package/dist/lib/Tax/index.d.ts +8 -8
  410. package/dist/lib/Tax/index.js +54 -54
  411. package/dist/lib/TransferRequest/index.d.ts +290 -290
  412. package/dist/lib/TransferRequest/index.js +1026 -1026
  413. package/dist/lib/Update/index.d.ts +10 -10
  414. package/dist/lib/Update/index.js +22 -22
  415. package/dist/lib/User/index.d.ts +89 -89
  416. package/dist/lib/User/index.js +328 -328
  417. package/dist/lib/Wishlist/index.d.ts +5 -5
  418. package/dist/lib/Wishlist/index.js +10 -10
  419. package/dist/lib/base.d.ts +14 -14
  420. package/dist/lib/base.js +62 -62
  421. package/dist/lib/baseService.d.ts +17 -17
  422. package/dist/lib/baseService.js +69 -69
  423. package/dist/rules/GR/constants/data.d.ts +26 -26
  424. package/dist/rules/GR/constants/data.js +81 -81
  425. package/dist/rules/GR/constants/expedition.d.ts +4 -4
  426. package/dist/rules/GR/constants/expedition.js +9 -9
  427. package/dist/rules/GR/constants/products.d.ts +22 -22
  428. package/dist/rules/GR/constants/products.js +263 -263
  429. package/dist/rules/GR/interfaces/cart.d.ts +84 -84
  430. package/dist/rules/GR/interfaces/cart.js +41 -41
  431. package/dist/rules/GR/interfaces/data.d.ts +101 -101
  432. package/dist/rules/GR/interfaces/data.js +114 -114
  433. package/dist/rules/GR/interfaces/products.d.ts +61 -61
  434. package/dist/rules/GR/interfaces/products.js +10 -10
  435. package/dist/rules/GR/utils/cart.d.ts +95 -95
  436. package/dist/rules/GR/utils/cart.js +839 -836
  437. package/dist/rules/GR/utils/cart.js.map +1 -1
  438. package/dist/rules/GR/utils/data.d.ts +3 -3
  439. package/dist/rules/GR/utils/data.js +28 -28
  440. package/dist/rules/GR/utils/expedition.d.ts +140 -140
  441. package/dist/rules/GR/utils/expedition.js +2016 -2016
  442. package/dist/rules/GR/utils/g2.d.ts +209 -209
  443. package/dist/rules/GR/utils/g2.js +999 -999
  444. package/dist/rules/GR/utils/invoices.d.ts +51 -51
  445. package/dist/rules/GR/utils/invoices.js +215 -215
  446. package/dist/rules/GR/utils/products.d.ts +277 -277
  447. package/dist/rules/GR/utils/products.js +1350 -1350
  448. package/dist/rules/GR/utils/upsells.d.ts +111 -111
  449. package/dist/rules/GR/utils/upsells.js +215 -215
  450. package/dist/services/database/BaseProvider.d.ts +29 -29
  451. package/dist/services/database/BaseProvider.js +28 -28
  452. package/dist/services/database/BatchUtils.d.ts +14 -14
  453. package/dist/services/database/BatchUtils.js +43 -43
  454. package/dist/services/database/Config.d.ts +2 -2
  455. package/dist/services/database/Config.js +5 -5
  456. package/dist/services/database/DatabaseService.d.ts +125 -125
  457. package/dist/services/database/DatabaseService.js +237 -237
  458. package/dist/services/database/FirebaseProvider.d.ts +17 -17
  459. package/dist/services/database/FirebaseProvider.js +235 -235
  460. package/dist/services/database/NotFirebaseProvider.d.ts +49 -49
  461. package/dist/services/database/NotFirebaseProvider.js +262 -262
  462. package/dist/services/g2/G2OrderSlip.d.ts +49 -49
  463. package/dist/services/g2/G2OrderSlip.js +228 -228
  464. package/dist/services/g2/utils.d.ts +19 -19
  465. package/dist/services/g2/utils.js +953 -953
  466. package/dist/services/logs/index.d.ts +23 -23
  467. package/dist/services/logs/index.js +66 -66
  468. package/dist/services/marketplace/BaseMarketServiceClass.d.ts +52 -52
  469. package/dist/services/marketplace/BaseMarketServiceClass.js +111 -111
  470. package/dist/services/marketplace/CardtraderServiceClass.d.ts +17 -17
  471. package/dist/services/marketplace/CardtraderServiceClass.js +139 -139
  472. package/dist/services/marketplace/utils.d.ts +14 -14
  473. package/dist/services/marketplace/utils.js +29 -29
  474. package/dist/services/products/BaseClass.d.ts +50 -50
  475. package/dist/services/products/BaseClass.js +66 -66
  476. package/dist/services/products/TCGService.d.ts +32 -32
  477. package/dist/services/products/TCGService.js +555 -555
  478. package/dist/services/products/utils.d.ts +31 -31
  479. package/dist/services/products/utils.js +144 -144
  480. package/dist/utils/algolia.d.ts +46 -46
  481. package/dist/utils/algolia.js +21 -21
  482. package/dist/utils/anonymisation.d.ts +54 -54
  483. package/dist/utils/anonymisation.js +280 -280
  484. package/dist/utils/array.d.ts +5 -5
  485. package/dist/utils/array.js +14 -14
  486. package/dist/utils/aws.d.ts +36 -36
  487. package/dist/utils/aws.js +154 -154
  488. package/dist/utils/booking.d.ts +30 -30
  489. package/dist/utils/booking.js +127 -127
  490. package/dist/utils/cart.d.ts +259 -259
  491. package/dist/utils/cart.js +1145 -1145
  492. package/dist/utils/categories.d.ts +2 -2
  493. package/dist/utils/categories.js +54 -54
  494. package/dist/utils/cmv.d.ts +10 -10
  495. package/dist/utils/cmv.js +107 -107
  496. package/dist/utils/console.d.ts +6 -6
  497. package/dist/utils/console.js +59 -59
  498. package/dist/utils/context.d.ts +20 -20
  499. package/dist/utils/context.js +61 -61
  500. package/dist/utils/currency.d.ts +6 -6
  501. package/dist/utils/currency.js +91 -91
  502. package/dist/utils/data.d.ts +31 -31
  503. package/dist/utils/data.js +296 -296
  504. package/dist/utils/date.d.ts +1 -1
  505. package/dist/utils/date.js +16 -16
  506. package/dist/utils/dimensions.d.ts +3 -3
  507. package/dist/utils/dimensions.js +16 -16
  508. package/dist/utils/discount.d.ts +164 -164
  509. package/dist/utils/discount.js +1111 -1111
  510. package/dist/utils/errors.d.ts +113 -113
  511. package/dist/utils/errors.js +113 -113
  512. package/dist/utils/file-admin.d.ts +8 -8
  513. package/dist/utils/file-admin.js +39 -39
  514. package/dist/utils/file.d.ts +39 -39
  515. package/dist/utils/file.js +208 -208
  516. package/dist/utils/firebase-admin.d.ts +11 -11
  517. package/dist/utils/firebase-admin.js +73 -73
  518. package/dist/utils/firebase.d.ts +58 -58
  519. package/dist/utils/firebase.js +148 -148
  520. package/dist/utils/import.d.ts +1 -1
  521. package/dist/utils/import.js +21 -21
  522. package/dist/utils/inventories.d.ts +101 -101
  523. package/dist/utils/inventories.js +467 -467
  524. package/dist/utils/locale.d.ts +24 -24
  525. package/dist/utils/locale.js +89 -89
  526. package/dist/utils/mailchimp.d.ts +58 -58
  527. package/dist/utils/mailchimp.js +531 -531
  528. package/dist/utils/mathUtils.d.ts +17 -17
  529. package/dist/utils/mathUtils.js +324 -324
  530. package/dist/utils/mongodb.d.ts +1 -1
  531. package/dist/utils/mongodb.js +22 -22
  532. package/dist/utils/object.d.ts +32 -32
  533. package/dist/utils/object.js +133 -133
  534. package/dist/utils/payment.d.ts +10 -10
  535. package/dist/utils/payment.js +23 -23
  536. package/dist/utils/products.d.ts +39 -39
  537. package/dist/utils/products.js +195 -195
  538. package/dist/utils/promiseToPurchase.d.ts +88 -88
  539. package/dist/utils/promiseToPurchase.js +229 -229
  540. package/dist/utils/prosprsearch.d.ts +42 -42
  541. package/dist/utils/prosprsearch.js +216 -216
  542. package/dist/utils/refunds.d.ts +2 -2
  543. package/dist/utils/refunds.js +21 -21
  544. package/dist/utils/sdc.d.ts +10 -10
  545. package/dist/utils/sdc.js +1309 -1309
  546. package/dist/utils/searchIndexes.d.ts +58 -58
  547. package/dist/utils/searchIndexes.js +247 -247
  548. package/dist/utils/services.d.ts +42 -42
  549. package/dist/utils/services.js +409 -409
  550. package/dist/utils/shipment.d.ts +110 -110
  551. package/dist/utils/shipment.js +345 -345
  552. package/dist/utils/simpletexting.d.ts +2 -2
  553. package/dist/utils/simpletexting.js +45 -45
  554. package/dist/utils/sliders.d.ts +4 -4
  555. package/dist/utils/sliders.js +24 -24
  556. package/dist/utils/string.d.ts +16 -16
  557. package/dist/utils/string.js +192 -192
  558. package/dist/utils/tcgService.d.ts +74 -74
  559. package/dist/utils/tcgService.js +308 -308
  560. package/dist/utils/tools.d.ts +5 -5
  561. package/dist/utils/tools.js +13 -13
  562. package/dist/utils/transferRequests.d.ts +43 -43
  563. package/dist/utils/transferRequests.js +67 -67
  564. package/dist/utils/update.d.ts +7 -7
  565. package/dist/utils/update.js +137 -137
  566. package/dist/utils/weight.d.ts +3 -3
  567. package/dist/utils/weight.js +16 -16
  568. package/dist/utils/zones.d.ts +11 -11
  569. package/dist/utils/zones.js +218 -218
  570. package/package.json +107 -107
  571. package/publish.sh +143 -143
  572. package/readme.md +182 -182
  573. package/dist/lib/Queue/index.d.ts +0 -40
  574. package/dist/lib/Queue/index.js +0 -255
  575. package/dist/lib/Queue/index.js.map +0 -1
@@ -1,405 +1,407 @@
1
- /**
2
- * Space interface.
3
- *
4
- * @link ecomm.gitngin.com/wiki/interfaces/space
5
- * @file Interface of a Space. A space reprensent an selling entity.
6
- * @author Alexandre Hébert-Vincent.
7
- * @since 01-01-2020
8
- */
9
- import Space from '../../lib/Space';
10
- import IAddress from '../Address';
11
- import { CustomPaymentTypeEnum, PaymentTypeEnum } from '../Cart';
12
- import { ICashDrawer } from '../CashDrawers';
13
- import { ISliderContent, ISliderOptions } from '../CMS';
14
- import { InventoryPriorityTypeEnum } from '../Inventory';
15
- import { IBankType } from '../PromiseToPurchase/BankType';
16
- import { ISpaceSchedule } from '../Schedule';
17
- import IStore from '../Store';
18
- import ITranslation from '../Translation';
19
- import { IExternalServices } from './IExternalService';
20
- export default interface ISpace {
21
- readonly id?: string;
22
- readonly name: string;
23
- readonly use_supply_cycle?: boolean;
24
- readonly space_options?: ISpaceOptions;
25
- readonly default_currency: string;
26
- readonly enabled_currencies: string[];
27
- readonly emailTemplate?: {
28
- readonly [key: string]: any;
29
- readonly company_logo_href: string;
30
- readonly company_logo_src: ITranslation[];
31
- readonly company_logo_onwhite_src: ITranslation[];
32
- readonly email_communications_clients: string;
33
- readonly phone_communications_clients: string;
34
- readonly copyrights: ITranslation[];
35
- readonly address: string;
36
- readonly help_href: ITranslation[];
37
- readonly preferences_href: ITranslation[];
38
- readonly unsubscribe_href: string;
39
- readonly socialmedias_items?: [];
40
- };
41
- readonly cms: {
42
- readonly website_in_maintenance: boolean;
43
- readonly sliders: {
44
- readonly name: string;
45
- readonly slug: string;
46
- readonly content: ISliderContent[];
47
- }[];
48
- readonly hide_pro_prices?: boolean;
49
- readonly hide_pro_prices_history?: {
50
- start: Date;
51
- end?: Date;
52
- }[];
53
- readonly fixed_promo_banner?: IFixedPromoBanner;
54
- readonly available_menu_positions?: {
55
- name: string;
56
- slug: string;
57
- }[];
58
- };
59
- readonly models?: {
60
- readonly cms?: {
61
- readonly sliders: ISliderOptions;
62
- };
63
- readonly invoice_footer?: {
64
- readonly left: ITranslation[];
65
- readonly center: ITranslation[];
66
- readonly right: ITranslation[];
67
- };
68
- };
69
- readonly product_preferences: IProductPreferences;
70
- readonly external_services: IExternalServices[];
71
- readonly default_tax_family?: string;
72
- readonly url?: string;
73
- readonly languages: ('fr' | 'en')[];
74
- readonly default_language: string;
75
- readonly transport_preferences: {
76
- readonly pickup_base_cost?: number;
77
- readonly override_shipping_with_cost?: number;
78
- readonly add_percent_to_shipping_cost?: number;
79
- readonly add_amount_to_shipping_cost?: number;
80
- readonly default_departure_address?: IAddress & {
81
- readonly companyName: string;
82
- readonly email: string;
83
- readonly notify: boolean;
84
- readonly residential: boolean;
85
- readonly phone: string;
86
- };
87
- readonly pickup_is_disabled?: boolean;
88
- readonly shipping_is_disabled?: boolean;
89
- readonly predefined_boxes?: IPredefinedBox[];
90
- readonly predefined_products?: IPredefinedBox[];
91
- readonly predefined_envelops?: IPredefinedBox[];
92
- readonly dimension_units?: IDimensionUnit[];
93
- readonly limit_shipping_range?: IShippingRangeRestrictions;
94
- readonly limit_free_shipping_range?: IShippingRangeRestrictions | boolean;
95
- readonly default_unit?: {
96
- readonly weight: 'kilograms' | 'pounds';
97
- readonly measurments: 'centimeters' | 'inches';
98
- };
99
- readonly blocked_dates?: IBlockedDates[];
100
- readonly shipping_as_product?: boolean;
101
- };
102
- readonly payments_accepted: (PaymentTypeEnum | CustomPaymentTypeEnum)[];
103
- readonly deposit_amount?: number;
104
- readonly stores_warehouses: IStore[];
105
- readonly schedule?: ISpaceSchedule;
106
- readonly import_model?: IImportModelLine[];
107
- readonly customer_types?: string[];
108
- readonly customer_groups?: ICustomerGroup[];
109
- readonly invoice_settings: IOrderInvoiceNumerotation & {
110
- readonly inherit_order_number: boolean;
111
- readonly seperate_invoices_from_order?: boolean;
112
- readonly fast_order?: boolean;
113
- readonly numbered_by_store: {
114
- [store_id: string]: IOrderInvoiceNumerotation;
115
- } | null;
116
- readonly numbered_by_web_type: {
117
- [expedition_type: string]: IOrderInvoiceNumerotation;
118
- } | null;
119
- readonly send_invoice_on_creation_to_emails: {
120
- is_active: boolean;
121
- emails: string[];
122
- };
123
- readonly send_delivery_invoice_on_creation_to_emails?: {
124
- is_active: boolean;
125
- emails: string[];
126
- };
127
- readonly notify_on_cancel_or_modify?: {
128
- is_active: boolean;
129
- emails_pickup: string[];
130
- emails_delivery: string[];
131
- auto_email_pickup: boolean;
132
- };
133
- readonly notify_on_transfer_modified_by_cart?: {
134
- is_active: boolean;
135
- emails: string[];
136
- };
137
- };
138
- readonly order_settings: IOrderInvoiceNumerotation & {
139
- readonly invoice_url?: {
140
- readonly [key: string]: string;
141
- };
142
- readonly numbered_by_store: {
143
- [store_id: string]: IOrderInvoiceNumerotation;
144
- } | null;
145
- };
146
- readonly admin_blog_url?: string;
147
- readonly is_saving_inventory: string | null;
148
- readonly g2_calls?: IG2Calls;
149
- readonly g2_price_fetch_active?: Date;
150
- readonly inventory_priority?: InventoryPriorityTypeEnum;
151
- readonly multipromo_aware?: boolean;
152
- readonly slack_channels_enabled?: {
153
- readonly channel_id: string;
154
- readonly team_id: string;
155
- readonly token: string;
156
- }[];
157
- readonly email_settings?: {
158
- readonly receivers?: {
159
- readonly type: string;
160
- readonly emails: string[];
161
- }[];
162
- };
163
- readonly bank_types?: IBankType[];
164
- readonly promise_to_purchase_emails?: string[];
165
- readonly promise_to_purchase_contingency?: number;
166
- readonly promise_to_purchase_seasons?: Record<string, ISeason>;
167
- readonly transfer_settings?: IOrderInvoiceNumerotation;
168
- readonly pos_settings?: {
169
- readonly auto_lock_delay?: number | null;
170
- };
171
- readonly cash_drawers?: ICashDrawer[];
172
- readonly other?: {
173
- readonly auto_fill_title_with_image_name?: {
174
- readonly is_active: boolean;
175
- readonly mode?: 'image' | 'product';
176
- };
177
- };
178
- store_credits?: IStoreCreditEntry[];
179
- }
180
- export interface IStoreCreditEntry {
181
- credit_slug: string;
182
- name: ITranslation[];
183
- }
184
- export interface IBucketDocument {
185
- metadata: any;
186
- path: string;
187
- name: string;
188
- }
189
- export interface ISeason {
190
- readonly opened: ISeasonInfo | null;
191
- readonly ended: ISeasonInfo | null;
192
- readonly closed: ISeasonInfo | null;
193
- }
194
- export interface ISeasonInfo {
195
- readonly date: Date;
196
- readonly by_user: string;
197
- }
198
- export interface IOrderInvoiceNumerotation {
199
- readonly prefix?: string;
200
- readonly suffix?: string;
201
- readonly increment_by?: number;
202
- readonly start_at?: number;
203
- }
204
- export interface IProductPreferences {
205
- readonly auto_sku_regex?: string;
206
- readonly documents?: boolean;
207
- readonly panel_descriptions?: boolean;
208
- readonly decimals: number;
209
- readonly allow_negative_prices?: boolean;
210
- readonly product_upsells?: boolean;
211
- readonly can_be_unsearchable?: boolean;
212
- readonly can_be_service?: boolean;
213
- readonly barcode_next?: string;
214
- readonly generate_barcode?: boolean;
215
- readonly product_equivalents?: boolean;
216
- }
217
- export interface IShippingRangeRestrictions {
218
- readonly limit_countries: string[];
219
- readonly limit_states: string[];
220
- }
221
- export interface IImportModelLine {
222
- readonly label: string;
223
- readonly key: string;
224
- }
225
- export interface IPredefinedBox {
226
- readonly name: string;
227
- readonly slug: string;
228
- readonly height: number;
229
- readonly width: number;
230
- readonly length: number;
231
- readonly dimension_unit?: 'inches' | 'centimeters';
232
- readonly weight?: number;
233
- readonly weight_unit?: 'kilograms' | 'pounds';
234
- readonly price?: number;
235
- readonly category_id?: string;
236
- readonly attribute?: string;
237
- readonly is_shipping_option?: boolean;
238
- readonly shipping_option_data?: {
239
- readonly carrier?: string;
240
- readonly service_name?: string;
241
- readonly order_min_price?: number;
242
- readonly max_weight?: number;
243
- readonly max_item_in_box?: number;
244
- readonly quote_id?: string;
245
- } | null;
246
- }
247
- export interface IDimensionUnit {
248
- readonly slug: string;
249
- readonly name: string;
250
- readonly use_for?: {
251
- readonly detailed_inventory_management?: boolean;
252
- readonly transfer_request_management?: boolean;
253
- };
254
- readonly specifics: {
255
- readonly should_round_to_one_unit_in_calculations?: boolean;
256
- };
257
- readonly name_translations?: ITranslation[];
258
- readonly short_name_translations?: ITranslation[];
259
- readonly plural_name_translations?: ITranslation[];
260
- }
261
- export interface ICurrencies {
262
- readonly base: string;
263
- readonly date: Date;
264
- readonly rates: {};
265
- }
266
- export interface ICustomerGroup {
267
- readonly name: ITranslation[];
268
- readonly slug: string;
269
- readonly validate?: boolean;
270
- readonly document_type?: ITranslation[];
271
- readonly regex?: string;
272
- readonly regex_exe?: string;
273
- readonly has_price?: boolean;
274
- readonly use_only_for_prices?: boolean;
275
- readonly show_first_in_prices?: boolean;
276
- readonly external_slug?: string;
277
- readonly external_price_list_slug?: string;
278
- readonly draft?: boolean;
279
- }
280
- export interface IG2Calls {
281
- readonly last_product_price_sync?: Date;
282
- readonly last_customer_sync?: Date;
283
- }
284
- export interface IBlockedDates {
285
- readonly cart_type: string;
286
- readonly dates?: {
287
- readonly start_date: Date | null;
288
- readonly end_date: Date | null;
289
- readonly unique_id: string;
290
- }[];
291
- }
292
- export declare enum spaceCollectionNames {
293
- DISCOUNTS = "discountRules",
294
- PURCHASE_ORDERS = "purchaseOrders",
295
- ATTR_FAMILIES = "classes",
296
- SUPPLIERS = "suppliers",
297
- CARTS = "carts",
298
- ORDERS = "orders",
299
- INVOICES = "invoices",
300
- CUSTOMERS = "customers",
301
- INVENTORIES = "inventories",
302
- PRODUCTS = "products",
303
- TAGS = "tags",
304
- BOOKINGS = "bookings",
305
- PROMISES = "promises_to_purchase",
306
- BG_JOBS = "bg_jobs",
307
- SLIDERS = "sliders",
308
- EXTERNAL_SERVICES = "external_services",
309
- BRANDS = "brands",
310
- CATEGORIES = "categories",
311
- BLOG_ARTICLES = "blog_articles",
312
- BLOG_CATEGORIES = "blog_categories",
313
- BLOG_KEYWORDS = "blog_keywords",
314
- CATALOGUES = "catalogues",
315
- ATTRIBUTES = "attributes",
316
- TRANSFER_REQUESTS = "transfer_requests",
317
- NOTES = "notes",
318
- CART_RESERVED_QUANTITIES = "cart_reserved_quantities"
319
- }
320
- export declare enum POSTypeEnum {
321
- PUBLIC = "public",
322
- ADMIN_ONLY = "admin_only"
323
- }
324
- export interface ISpaceOptions {
325
- readonly products: {
326
- readonly last_saved: boolean;
327
- readonly use_keywords?: boolean;
328
- readonly save_cost_price?: boolean;
329
- readonly can_exclude_declis_from_cost_calulations?: boolean;
330
- readonly index_extra_info_in_decli?: boolean;
331
- readonly product_can_have_presale?: boolean;
332
- };
333
- readonly inventory?: {
334
- readonly minimum_inventory_per_sku: boolean;
335
- readonly bulk_inventory_edit?: boolean;
336
- readonly reserve_on_add_to_cart?: boolean;
337
- };
338
- readonly tags: {
339
- readonly available: boolean;
340
- readonly auto_generated: boolean;
341
- };
342
- readonly payment: {
343
- readonly promise_to_purchase: boolean;
344
- readonly save_multiple_paid_by: boolean;
345
- readonly online_payments_are_deposits: boolean;
346
- readonly has_payment_incentives: boolean;
347
- readonly space_has_store_credits?: boolean;
348
- };
349
- readonly cms?: {
350
- readonly has_fixed_promo_banner?: boolean;
351
- readonly can_edit_sliders?: boolean;
352
- readonly can_set_detailed_store_schedule?: boolean;
353
- readonly custom_menu?: boolean;
354
- };
355
- readonly security?: {
356
- readonly no_nip_from_pos?: boolean;
357
- };
358
- readonly features?: {
359
- readonly allow_refunds?: boolean;
360
- readonly space_has_bookings?: boolean;
361
- readonly has_pos?: boolean;
362
- readonly allow_custom_prices_in_categories?: boolean;
363
- readonly can_manage_cash_drawers?: boolean;
364
- };
365
- readonly pos?: {
366
- readonly has_custom_pos?: boolean;
367
- readonly is_public?: boolean;
368
- readonly can_put_carts_on_hold?: boolean;
369
- readonly must_assign_cash_drawer?: boolean;
370
- };
371
- readonly booking?: {
372
- readonly set_store_for_booking_inventory_management?: boolean;
373
- };
374
- readonly transfer_requests?: {
375
- readonly available?: boolean;
376
- readonly associate_origin_store_at_creation?: boolean;
377
- readonly dont_limit_qty?: boolean;
378
- readonly transfer_list_show_total_pal_qte?: boolean;
379
- readonly transfer_list_show_total_weight?: boolean;
380
- readonly allow_transfer_when_out_stock?: boolean;
381
- };
382
- readonly invoices?: {
383
- readonly print_small_invoice?: boolean;
384
- };
385
- }
386
- export declare const getDefaultSpaceOptions: () => ISpaceOptions;
387
- export declare const defaultSpace: () => ISpace;
388
- export declare const getDefaultDimensionUnit: (space: Space) => IDimensionUnit;
389
- export interface IFixedPromoBanner {
390
- readonly content: ITranslation[];
391
- readonly is_active: boolean;
392
- readonly background_color?: string;
393
- readonly text_color?: string;
394
- readonly active_between_dates?: {
395
- start: Date;
396
- end: Date;
397
- }[];
398
- }
399
- export interface IShippingServiceZone {
400
- description: string;
401
- polygon: string;
402
- base_fee: number;
403
- slug: string;
404
- name: string;
405
- }
1
+ /**
2
+ * Space interface.
3
+ *
4
+ * @link ecomm.gitngin.com/wiki/interfaces/space
5
+ * @file Interface of a Space. A space reprensent an selling entity.
6
+ * @author Alexandre Hébert-Vincent.
7
+ * @since 01-01-2020
8
+ */
9
+ import Space from '../../lib/Space';
10
+ import IAddress from '../Address';
11
+ import { CustomPaymentTypeEnum, PaymentTypeEnum } from '../Cart';
12
+ import { CartGeneralTypeEnum } from '../../rules/GR/interfaces/cart';
13
+ import { ICashDrawer } from '../CashDrawers';
14
+ import { ISliderContent, ISliderOptions } from '../CMS';
15
+ import { InventoryPriorityTypeEnum } from '../Inventory';
16
+ import { IBankType } from '../PromiseToPurchase/BankType';
17
+ import { ISpaceSchedule } from '../Schedule';
18
+ import IStore from '../Store';
19
+ import ITranslation from '../Translation';
20
+ import { IExternalServices } from './IExternalService';
21
+ export default interface ISpace {
22
+ readonly id?: string;
23
+ readonly name: string;
24
+ readonly use_supply_cycle?: boolean;
25
+ readonly space_options?: ISpaceOptions;
26
+ readonly default_currency: string;
27
+ readonly enabled_currencies: string[];
28
+ readonly emailTemplate?: {
29
+ readonly [key: string]: any;
30
+ readonly company_logo_href: string;
31
+ readonly company_logo_src: ITranslation[];
32
+ readonly company_logo_onwhite_src: ITranslation[];
33
+ readonly email_communications_clients: string;
34
+ readonly phone_communications_clients: string;
35
+ readonly copyrights: ITranslation[];
36
+ readonly address: string;
37
+ readonly help_href: ITranslation[];
38
+ readonly preferences_href: ITranslation[];
39
+ readonly unsubscribe_href: string;
40
+ readonly socialmedias_items?: [];
41
+ };
42
+ readonly cms: {
43
+ readonly website_in_maintenance: boolean;
44
+ readonly sliders: {
45
+ readonly name: string;
46
+ readonly slug: string;
47
+ readonly content: ISliderContent[];
48
+ }[];
49
+ readonly hide_pro_prices?: boolean;
50
+ readonly hide_pro_prices_history?: {
51
+ start: Date;
52
+ end?: Date;
53
+ }[];
54
+ readonly fixed_promo_banner?: IFixedPromoBanner;
55
+ readonly available_menu_positions?: {
56
+ name: string;
57
+ slug: string;
58
+ }[];
59
+ };
60
+ readonly models?: {
61
+ readonly cms?: {
62
+ readonly sliders: ISliderOptions;
63
+ };
64
+ readonly invoice_footer?: {
65
+ readonly left: ITranslation[];
66
+ readonly center: ITranslation[];
67
+ readonly right: ITranslation[];
68
+ };
69
+ };
70
+ readonly product_preferences: IProductPreferences;
71
+ readonly external_services: IExternalServices[];
72
+ readonly default_tax_family?: string;
73
+ readonly url?: string;
74
+ readonly languages: ('fr' | 'en')[];
75
+ readonly default_language: string;
76
+ readonly transport_preferences: {
77
+ readonly pickup_base_cost?: number;
78
+ readonly override_shipping_with_cost?: number;
79
+ readonly add_percent_to_shipping_cost?: number;
80
+ readonly add_amount_to_shipping_cost?: number;
81
+ readonly default_departure_address?: IAddress & {
82
+ readonly companyName: string;
83
+ readonly email: string;
84
+ readonly notify: boolean;
85
+ readonly residential: boolean;
86
+ readonly phone: string;
87
+ };
88
+ readonly pickup_is_disabled?: boolean;
89
+ readonly shipping_is_disabled?: boolean;
90
+ readonly predefined_boxes?: IPredefinedBox[];
91
+ readonly predefined_products?: IPredefinedBox[];
92
+ readonly predefined_envelops?: IPredefinedBox[];
93
+ readonly dimension_units?: IDimensionUnit[];
94
+ readonly limit_shipping_range?: IShippingRangeRestrictions;
95
+ readonly limit_free_shipping_range?: IShippingRangeRestrictions | boolean;
96
+ readonly default_unit?: {
97
+ readonly weight: 'kilograms' | 'pounds';
98
+ readonly measurments: 'centimeters' | 'inches';
99
+ };
100
+ readonly blocked_dates?: IBlockedDates[];
101
+ readonly shipping_as_product?: boolean;
102
+ };
103
+ readonly payments_accepted: (PaymentTypeEnum | CustomPaymentTypeEnum)[];
104
+ readonly deposit_amount?: number;
105
+ readonly stores_warehouses: IStore[];
106
+ readonly schedule?: ISpaceSchedule;
107
+ readonly import_model?: IImportModelLine[];
108
+ readonly customer_types?: string[];
109
+ readonly customer_groups?: ICustomerGroup[];
110
+ readonly invoice_settings: IOrderInvoiceNumerotation & {
111
+ readonly inherit_order_number: boolean;
112
+ readonly seperate_invoices_from_order?: boolean;
113
+ readonly fast_order?: boolean;
114
+ readonly numbered_by_store: {
115
+ [store_id: string]: IOrderInvoiceNumerotation;
116
+ } | null;
117
+ readonly numbered_by_web_type: {
118
+ [expedition_type: string]: IOrderInvoiceNumerotation;
119
+ } | null;
120
+ readonly send_invoice_on_creation_to_emails: {
121
+ is_active: boolean;
122
+ emails: string[];
123
+ };
124
+ readonly send_delivery_invoice_on_creation_to_emails?: {
125
+ is_active: boolean;
126
+ emails: string[];
127
+ };
128
+ readonly notify_on_cancel_or_modify?: {
129
+ is_active: boolean;
130
+ emails_pickup: string[];
131
+ emails_delivery: string[];
132
+ emails_delivery_by_cart_type?: Partial<Record<CartGeneralTypeEnum, string[]>>;
133
+ auto_email_pickup: boolean;
134
+ };
135
+ readonly notify_on_transfer_modified_by_cart?: {
136
+ is_active: boolean;
137
+ emails: string[];
138
+ };
139
+ };
140
+ readonly order_settings: IOrderInvoiceNumerotation & {
141
+ readonly invoice_url?: {
142
+ readonly [key: string]: string;
143
+ };
144
+ readonly numbered_by_store: {
145
+ [store_id: string]: IOrderInvoiceNumerotation;
146
+ } | null;
147
+ };
148
+ readonly admin_blog_url?: string;
149
+ readonly is_saving_inventory: string | null;
150
+ readonly g2_calls?: IG2Calls;
151
+ readonly g2_price_fetch_active?: Date;
152
+ readonly inventory_priority?: InventoryPriorityTypeEnum;
153
+ readonly multipromo_aware?: boolean;
154
+ readonly slack_channels_enabled?: {
155
+ readonly channel_id: string;
156
+ readonly team_id: string;
157
+ readonly token: string;
158
+ }[];
159
+ readonly email_settings?: {
160
+ readonly receivers?: {
161
+ readonly type: string;
162
+ readonly emails: string[];
163
+ }[];
164
+ };
165
+ readonly bank_types?: IBankType[];
166
+ readonly promise_to_purchase_emails?: string[];
167
+ readonly promise_to_purchase_contingency?: number;
168
+ readonly promise_to_purchase_seasons?: Record<string, ISeason>;
169
+ readonly transfer_settings?: IOrderInvoiceNumerotation;
170
+ readonly pos_settings?: {
171
+ readonly auto_lock_delay?: number | null;
172
+ };
173
+ readonly cash_drawers?: ICashDrawer[];
174
+ readonly other?: {
175
+ readonly auto_fill_title_with_image_name?: {
176
+ readonly is_active: boolean;
177
+ readonly mode?: 'image' | 'product';
178
+ };
179
+ };
180
+ store_credits?: IStoreCreditEntry[];
181
+ }
182
+ export interface IStoreCreditEntry {
183
+ credit_slug: string;
184
+ name: ITranslation[];
185
+ }
186
+ export interface IBucketDocument {
187
+ metadata: any;
188
+ path: string;
189
+ name: string;
190
+ }
191
+ export interface ISeason {
192
+ readonly opened: ISeasonInfo | null;
193
+ readonly ended: ISeasonInfo | null;
194
+ readonly closed: ISeasonInfo | null;
195
+ }
196
+ export interface ISeasonInfo {
197
+ readonly date: Date;
198
+ readonly by_user: string;
199
+ }
200
+ export interface IOrderInvoiceNumerotation {
201
+ readonly prefix?: string;
202
+ readonly suffix?: string;
203
+ readonly increment_by?: number;
204
+ readonly start_at?: number;
205
+ }
206
+ export interface IProductPreferences {
207
+ readonly auto_sku_regex?: string;
208
+ readonly documents?: boolean;
209
+ readonly panel_descriptions?: boolean;
210
+ readonly decimals: number;
211
+ readonly allow_negative_prices?: boolean;
212
+ readonly product_upsells?: boolean;
213
+ readonly can_be_unsearchable?: boolean;
214
+ readonly can_be_service?: boolean;
215
+ readonly barcode_next?: string;
216
+ readonly generate_barcode?: boolean;
217
+ readonly product_equivalents?: boolean;
218
+ }
219
+ export interface IShippingRangeRestrictions {
220
+ readonly limit_countries: string[];
221
+ readonly limit_states: string[];
222
+ }
223
+ export interface IImportModelLine {
224
+ readonly label: string;
225
+ readonly key: string;
226
+ }
227
+ export interface IPredefinedBox {
228
+ readonly name: string;
229
+ readonly slug: string;
230
+ readonly height: number;
231
+ readonly width: number;
232
+ readonly length: number;
233
+ readonly dimension_unit?: 'inches' | 'centimeters';
234
+ readonly weight?: number;
235
+ readonly weight_unit?: 'kilograms' | 'pounds';
236
+ readonly price?: number;
237
+ readonly category_id?: string;
238
+ readonly attribute?: string;
239
+ readonly is_shipping_option?: boolean;
240
+ readonly shipping_option_data?: {
241
+ readonly carrier?: string;
242
+ readonly service_name?: string;
243
+ readonly order_min_price?: number;
244
+ readonly max_weight?: number;
245
+ readonly max_item_in_box?: number;
246
+ readonly quote_id?: string;
247
+ } | null;
248
+ }
249
+ export interface IDimensionUnit {
250
+ readonly slug: string;
251
+ readonly name: string;
252
+ readonly use_for?: {
253
+ readonly detailed_inventory_management?: boolean;
254
+ readonly transfer_request_management?: boolean;
255
+ };
256
+ readonly specifics: {
257
+ readonly should_round_to_one_unit_in_calculations?: boolean;
258
+ };
259
+ readonly name_translations?: ITranslation[];
260
+ readonly short_name_translations?: ITranslation[];
261
+ readonly plural_name_translations?: ITranslation[];
262
+ }
263
+ export interface ICurrencies {
264
+ readonly base: string;
265
+ readonly date: Date;
266
+ readonly rates: {};
267
+ }
268
+ export interface ICustomerGroup {
269
+ readonly name: ITranslation[];
270
+ readonly slug: string;
271
+ readonly validate?: boolean;
272
+ readonly document_type?: ITranslation[];
273
+ readonly regex?: string;
274
+ readonly regex_exe?: string;
275
+ readonly has_price?: boolean;
276
+ readonly use_only_for_prices?: boolean;
277
+ readonly show_first_in_prices?: boolean;
278
+ readonly external_slug?: string;
279
+ readonly external_price_list_slug?: string;
280
+ readonly draft?: boolean;
281
+ }
282
+ export interface IG2Calls {
283
+ readonly last_product_price_sync?: Date;
284
+ readonly last_customer_sync?: Date;
285
+ }
286
+ export interface IBlockedDates {
287
+ readonly cart_type: string;
288
+ readonly dates?: {
289
+ readonly start_date: Date | null;
290
+ readonly end_date: Date | null;
291
+ readonly unique_id: string;
292
+ }[];
293
+ }
294
+ export declare enum spaceCollectionNames {
295
+ DISCOUNTS = "discountRules",
296
+ PURCHASE_ORDERS = "purchaseOrders",
297
+ ATTR_FAMILIES = "classes",
298
+ SUPPLIERS = "suppliers",
299
+ CARTS = "carts",
300
+ ORDERS = "orders",
301
+ INVOICES = "invoices",
302
+ CUSTOMERS = "customers",
303
+ INVENTORIES = "inventories",
304
+ PRODUCTS = "products",
305
+ TAGS = "tags",
306
+ BOOKINGS = "bookings",
307
+ PROMISES = "promises_to_purchase",
308
+ BG_JOBS = "bg_jobs",
309
+ SLIDERS = "sliders",
310
+ EXTERNAL_SERVICES = "external_services",
311
+ BRANDS = "brands",
312
+ CATEGORIES = "categories",
313
+ BLOG_ARTICLES = "blog_articles",
314
+ BLOG_CATEGORIES = "blog_categories",
315
+ BLOG_KEYWORDS = "blog_keywords",
316
+ CATALOGUES = "catalogues",
317
+ ATTRIBUTES = "attributes",
318
+ TRANSFER_REQUESTS = "transfer_requests",
319
+ NOTES = "notes",
320
+ CART_RESERVED_QUANTITIES = "cart_reserved_quantities"
321
+ }
322
+ export declare enum POSTypeEnum {
323
+ PUBLIC = "public",
324
+ ADMIN_ONLY = "admin_only"
325
+ }
326
+ export interface ISpaceOptions {
327
+ readonly products: {
328
+ readonly last_saved: boolean;
329
+ readonly use_keywords?: boolean;
330
+ readonly save_cost_price?: boolean;
331
+ readonly can_exclude_declis_from_cost_calulations?: boolean;
332
+ readonly index_extra_info_in_decli?: boolean;
333
+ readonly product_can_have_presale?: boolean;
334
+ };
335
+ readonly inventory?: {
336
+ readonly minimum_inventory_per_sku: boolean;
337
+ readonly bulk_inventory_edit?: boolean;
338
+ readonly reserve_on_add_to_cart?: boolean;
339
+ };
340
+ readonly tags: {
341
+ readonly available: boolean;
342
+ readonly auto_generated: boolean;
343
+ };
344
+ readonly payment: {
345
+ readonly promise_to_purchase: boolean;
346
+ readonly save_multiple_paid_by: boolean;
347
+ readonly online_payments_are_deposits: boolean;
348
+ readonly has_payment_incentives: boolean;
349
+ readonly space_has_store_credits?: boolean;
350
+ };
351
+ readonly cms?: {
352
+ readonly has_fixed_promo_banner?: boolean;
353
+ readonly can_edit_sliders?: boolean;
354
+ readonly can_set_detailed_store_schedule?: boolean;
355
+ readonly custom_menu?: boolean;
356
+ };
357
+ readonly security?: {
358
+ readonly no_nip_from_pos?: boolean;
359
+ };
360
+ readonly features?: {
361
+ readonly allow_refunds?: boolean;
362
+ readonly space_has_bookings?: boolean;
363
+ readonly has_pos?: boolean;
364
+ readonly allow_custom_prices_in_categories?: boolean;
365
+ readonly can_manage_cash_drawers?: boolean;
366
+ };
367
+ readonly pos?: {
368
+ readonly has_custom_pos?: boolean;
369
+ readonly is_public?: boolean;
370
+ readonly can_put_carts_on_hold?: boolean;
371
+ readonly must_assign_cash_drawer?: boolean;
372
+ };
373
+ readonly booking?: {
374
+ readonly set_store_for_booking_inventory_management?: boolean;
375
+ };
376
+ readonly transfer_requests?: {
377
+ readonly available?: boolean;
378
+ readonly associate_origin_store_at_creation?: boolean;
379
+ readonly dont_limit_qty?: boolean;
380
+ readonly transfer_list_show_total_pal_qte?: boolean;
381
+ readonly transfer_list_show_total_weight?: boolean;
382
+ readonly allow_transfer_when_out_stock?: boolean;
383
+ };
384
+ readonly invoices?: {
385
+ readonly print_small_invoice?: boolean;
386
+ };
387
+ }
388
+ export declare const getDefaultSpaceOptions: () => ISpaceOptions;
389
+ export declare const defaultSpace: () => ISpace;
390
+ export declare const getDefaultDimensionUnit: (space: Space) => IDimensionUnit;
391
+ export interface IFixedPromoBanner {
392
+ readonly content: ITranslation[];
393
+ readonly is_active: boolean;
394
+ readonly background_color?: string;
395
+ readonly text_color?: string;
396
+ readonly active_between_dates?: {
397
+ start: Date;
398
+ end: Date;
399
+ }[];
400
+ }
401
+ export interface IShippingServiceZone {
402
+ description: string;
403
+ polygon: string;
404
+ base_fee: number;
405
+ slug: string;
406
+ name: string;
407
+ }