ce-storefront 0.0.1 → 0.0.2

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 (375) hide show
  1. package/.devcontainer/README.md +5 -0
  2. package/README.md +89 -124
  3. package/docs/sdks/addresses/README.md +78 -0
  4. package/docs/sdks/analytics/README.md +5 -5
  5. package/docs/sdks/auth/README.md +16 -24
  6. package/docs/sdks/campaigns/README.md +1 -79
  7. package/docs/sdks/cestorefrontuser/README.md +850 -0
  8. package/docs/sdks/{common → coupons}/README.md +9 -9
  9. package/docs/sdks/customers/README.md +12 -15
  10. package/docs/sdks/{otp → newsletter}/README.md +10 -10
  11. package/docs/sdks/notificationpreferences/README.md +240 -0
  12. package/docs/sdks/offers/README.md +1 -152
  13. package/docs/sdks/orders/README.md +0 -73
  14. package/docs/sdks/products/README.md +228 -0
  15. package/docs/sdks/{recommended → promotions}/README.md +8 -9
  16. package/docs/sdks/returns/README.md +0 -160
  17. package/docs/sdks/reviews/README.md +5 -5
  18. package/docs/sdks/shipping/README.md +5 -5
  19. package/docs/sdks/user/README.md +1 -927
  20. package/docs/sdks/{countries → utils}/README.md +81 -8
  21. package/funcs/{analyticsTrackEvent.d.ts → analyticsTrack.d.ts} +2 -2
  22. package/funcs/analyticsTrack.d.ts.map +1 -0
  23. package/funcs/{analyticsTrackEvent.js → analyticsTrack.js} +3 -3
  24. package/funcs/analyticsTrack.js.map +1 -0
  25. package/funcs/{authOtpGenerate.d.ts → authGenerateOtp.d.ts} +2 -2
  26. package/funcs/{authOtpGenerate.d.ts.map → authGenerateOtp.d.ts.map} +1 -1
  27. package/funcs/{authOtpGenerate.js → authGenerateOtp.js} +3 -3
  28. package/funcs/{authOtpGenerate.js.map → authGenerateOtp.js.map} +1 -1
  29. package/funcs/{authTokenRefresh.d.ts → authRefreshToken.d.ts} +2 -2
  30. package/funcs/{authTokenRefresh.d.ts.map → authRefreshToken.d.ts.map} +1 -1
  31. package/funcs/{authTokenRefresh.js → authRefreshToken.js} +3 -3
  32. package/funcs/{authTokenRefresh.js.map → authRefreshToken.js.map} +1 -1
  33. package/funcs/{authGetUser.d.ts → authUserGet.d.ts} +2 -2
  34. package/funcs/{authGetUser.d.ts.map → authUserGet.d.ts.map} +1 -1
  35. package/funcs/{authGetUser.js → authUserGet.js} +3 -3
  36. package/funcs/{authGetUser.js.map → authUserGet.js.map} +1 -1
  37. package/funcs/{authUpdateUser.d.ts → authUserUpdate.d.ts} +2 -2
  38. package/funcs/{authUpdateUser.d.ts.map → authUserUpdate.d.ts.map} +1 -1
  39. package/funcs/{authUpdateUser.js → authUserUpdate.js} +3 -3
  40. package/funcs/{authUpdateUser.js.map → authUserUpdate.js.map} +1 -1
  41. package/funcs/{campaignsSubscribeNewsletter.d.ts → campaignsNewsletterSubscribe.d.ts} +2 -2
  42. package/funcs/{campaignsSubscribeNewsletter.d.ts.map → campaignsNewsletterSubscribe.d.ts.map} +1 -1
  43. package/funcs/{campaignsSubscribeNewsletter.js → campaignsNewsletterSubscribe.js} +3 -3
  44. package/funcs/{campaignsSubscribeNewsletter.js.map → campaignsNewsletterSubscribe.js.map} +1 -1
  45. package/funcs/{catalogProductsCrossSellList.d.ts → catalogProductsGetCrossSells.d.ts} +2 -2
  46. package/funcs/{catalogProductsCrossSellList.d.ts.map → catalogProductsGetCrossSells.d.ts.map} +1 -1
  47. package/funcs/{catalogProductsCrossSellList.js → catalogProductsGetCrossSells.js} +3 -3
  48. package/funcs/{catalogProductsCrossSellList.js.map → catalogProductsGetCrossSells.js.map} +1 -1
  49. package/funcs/{catalogProductsSimilarList.d.ts → catalogProductsGetSimilar.d.ts} +2 -2
  50. package/funcs/catalogProductsGetSimilar.d.ts.map +1 -0
  51. package/funcs/{catalogProductsSimilarList.js → catalogProductsGetSimilar.js} +3 -3
  52. package/funcs/catalogProductsGetSimilar.js.map +1 -0
  53. package/funcs/{catalogProductsUpSellList.d.ts → catalogProductsGetUpsells.d.ts} +2 -2
  54. package/funcs/{catalogProductsUpSellList.d.ts.map → catalogProductsGetUpsells.d.ts.map} +1 -1
  55. package/funcs/{catalogProductsUpSellList.js → catalogProductsGetUpsells.js} +3 -3
  56. package/funcs/{catalogProductsUpSellList.js.map → catalogProductsGetUpsells.js.map} +1 -1
  57. package/funcs/{commonCountriesGetPincodes.d.ts → customersAddressesList.d.ts} +4 -4
  58. package/funcs/customersAddressesList.d.ts.map +1 -0
  59. package/funcs/{customersGetAddresses.js → customersAddressesList.js} +3 -3
  60. package/funcs/customersAddressesList.js.map +1 -0
  61. package/funcs/{catalogProductsRecommendedList.d.ts → customersGetRecommendedProducts.d.ts} +2 -2
  62. package/funcs/customersGetRecommendedProducts.d.ts.map +1 -0
  63. package/funcs/{catalogProductsRecommendedList.js → customersGetRecommendedProducts.js} +3 -3
  64. package/funcs/customersGetRecommendedProducts.js.map +1 -0
  65. package/funcs/{customersReviewsGetAll.d.ts → customersReviewsList.d.ts} +2 -2
  66. package/funcs/customersReviewsList.d.ts.map +1 -0
  67. package/funcs/{customersReviewsGetAll.js → customersReviewsList.js} +3 -3
  68. package/funcs/customersReviewsList.js.map +1 -0
  69. package/funcs/{offersGetCoupons.d.ts → offersCouponsList.d.ts} +2 -2
  70. package/funcs/offersCouponsList.d.ts.map +1 -0
  71. package/funcs/{offersGetCoupons.js → offersCouponsList.js} +3 -3
  72. package/funcs/{ordersGetReturns.js.map → offersCouponsList.js.map} +1 -1
  73. package/funcs/{offersGetPromotions.d.ts → offersPromotionsList.d.ts} +2 -2
  74. package/funcs/offersPromotionsList.d.ts.map +1 -0
  75. package/funcs/{offersGetPromotions.js → offersPromotionsList.js} +3 -3
  76. package/funcs/offersPromotionsList.js.map +1 -0
  77. package/funcs/{shippingGetPincodeServiceability.d.ts → shippingCheckPincodeServiceability.d.ts} +2 -2
  78. package/funcs/shippingCheckPincodeServiceability.d.ts.map +1 -0
  79. package/funcs/{shippingGetPincodeServiceability.js → shippingCheckPincodeServiceability.js} +3 -3
  80. package/funcs/shippingCheckPincodeServiceability.js.map +1 -0
  81. package/funcs/{authUserCreateNotificationPreferences.d.ts → userNotificationPreferencesCreate.d.ts} +2 -2
  82. package/funcs/userNotificationPreferencesCreate.d.ts.map +1 -0
  83. package/funcs/{authUserCreateNotificationPreferences.js → userNotificationPreferencesCreate.js} +3 -3
  84. package/funcs/userNotificationPreferencesCreate.js.map +1 -0
  85. package/funcs/{authUserGetNotificationPreferences.d.ts → userNotificationPreferencesGet.d.ts} +2 -2
  86. package/funcs/userNotificationPreferencesGet.d.ts.map +1 -0
  87. package/funcs/{authUserGetNotificationPreferences.js → userNotificationPreferencesGet.js} +3 -3
  88. package/funcs/userNotificationPreferencesGet.js.map +1 -0
  89. package/funcs/{authUserUpdateNotificationPreferences.d.ts → userNotificationPreferencesUpdate.d.ts} +2 -2
  90. package/funcs/userNotificationPreferencesUpdate.d.ts.map +1 -0
  91. package/funcs/{authUserUpdateNotificationPreferences.js → userNotificationPreferencesUpdate.js} +3 -3
  92. package/funcs/userNotificationPreferencesUpdate.js.map +1 -0
  93. package/funcs/{commonGetCountries.d.ts → utilsGetCountries.d.ts} +2 -2
  94. package/funcs/utilsGetCountries.d.ts.map +1 -0
  95. package/funcs/{commonGetCountries.js → utilsGetCountries.js} +3 -3
  96. package/funcs/utilsGetCountries.js.map +1 -0
  97. package/funcs/{customersGetAddresses.d.ts → utilsGetPincodes.d.ts} +4 -4
  98. package/funcs/utilsGetPincodes.d.ts.map +1 -0
  99. package/funcs/{commonCountriesGetPincodes.js → utilsGetPincodes.js} +3 -3
  100. package/funcs/utilsGetPincodes.js.map +1 -0
  101. package/funcs/{commonCountriesGetStates.d.ts → utilsGetStates.d.ts} +2 -2
  102. package/funcs/utilsGetStates.d.ts.map +1 -0
  103. package/funcs/{commonCountriesGetStates.js → utilsGetStates.js} +3 -3
  104. package/funcs/utilsGetStates.js.map +1 -0
  105. package/lib/config.d.ts +4 -4
  106. package/lib/config.d.ts.map +1 -1
  107. package/lib/config.js +3 -8
  108. package/lib/config.js.map +1 -1
  109. package/models/components/cartitem.js +4 -4
  110. package/models/components/cartitem.js.map +1 -1
  111. package/models/components/index.d.ts +0 -1
  112. package/models/components/index.d.ts.map +1 -1
  113. package/models/components/index.js +0 -1
  114. package/models/components/index.js.map +1 -1
  115. package/models/components/orderreturnitem.d.ts +0 -31
  116. package/models/components/orderreturnitem.d.ts.map +1 -1
  117. package/models/components/orderreturnitem.js +1 -42
  118. package/models/components/orderreturnitem.js.map +1 -1
  119. package/models/components/productattribute.js +1 -1
  120. package/models/components/productattribute.js.map +1 -1
  121. package/models/components/productdetail.js +5 -5
  122. package/models/components/productdetail.js.map +1 -1
  123. package/models/components/productlist.js +5 -5
  124. package/models/components/productlist.js.map +1 -1
  125. package/models/components/productreview.js +1 -1
  126. package/models/components/productreview.js.map +1 -1
  127. package/models/components/productshipping.js +2 -2
  128. package/models/components/productshipping.js.map +1 -1
  129. package/models/components/productsubscription.js +1 -1
  130. package/models/components/productsubscription.js.map +1 -1
  131. package/models/components/skuinfo.js +4 -4
  132. package/models/components/skuinfo.js.map +1 -1
  133. package/models/errors/unauthorized.js +1 -1
  134. package/models/errors/unauthorized.js.map +1 -1
  135. package/models/operations/index.d.ts +0 -3
  136. package/models/operations/index.d.ts.map +1 -1
  137. package/models/operations/index.js +0 -3
  138. package/models/operations/index.js.map +1 -1
  139. package/models/operations/postcartitemid.js +1 -1
  140. package/models/operations/postcartitemid.js.map +1 -1
  141. package/package.json +5 -1
  142. package/sdk/addresses.d.ts +7 -0
  143. package/sdk/addresses.d.ts.map +1 -1
  144. package/sdk/addresses.js +10 -0
  145. package/sdk/addresses.js.map +1 -1
  146. package/sdk/analytics.d.ts +1 -1
  147. package/sdk/analytics.d.ts.map +1 -1
  148. package/sdk/analytics.js +3 -3
  149. package/sdk/analytics.js.map +1 -1
  150. package/sdk/auth.d.ts +8 -14
  151. package/sdk/auth.d.ts.map +1 -1
  152. package/sdk/auth.js +12 -22
  153. package/sdk/auth.js.map +1 -1
  154. package/sdk/campaigns.d.ts +4 -9
  155. package/sdk/campaigns.d.ts.map +1 -1
  156. package/sdk/campaigns.js +4 -10
  157. package/sdk/campaigns.js.map +1 -1
  158. package/sdk/cestorefrontuser.d.ts +82 -0
  159. package/sdk/cestorefrontuser.d.ts.map +1 -0
  160. package/sdk/cestorefrontuser.js +122 -0
  161. package/sdk/cestorefrontuser.js.map +1 -0
  162. package/sdk/coupons.d.ts +12 -0
  163. package/sdk/coupons.d.ts.map +1 -0
  164. package/sdk/coupons.js +22 -0
  165. package/sdk/coupons.js.map +1 -0
  166. package/sdk/customers.d.ts +3 -3
  167. package/sdk/customers.d.ts.map +1 -1
  168. package/sdk/customers.js +5 -5
  169. package/sdk/customers.js.map +1 -1
  170. package/sdk/newsletter.d.ts +12 -0
  171. package/sdk/newsletter.d.ts.map +1 -0
  172. package/sdk/newsletter.js +22 -0
  173. package/sdk/newsletter.js.map +1 -0
  174. package/sdk/notificationpreferences.d.ts +26 -0
  175. package/sdk/notificationpreferences.d.ts.map +1 -0
  176. package/sdk/notificationpreferences.js +42 -0
  177. package/sdk/notificationpreferences.js.map +1 -0
  178. package/sdk/offers.d.ts +7 -16
  179. package/sdk/offers.d.ts.map +1 -1
  180. package/sdk/offers.js +8 -19
  181. package/sdk/offers.js.map +1 -1
  182. package/sdk/orders.d.ts +0 -7
  183. package/sdk/orders.d.ts.map +1 -1
  184. package/sdk/orders.js +0 -10
  185. package/sdk/orders.js.map +1 -1
  186. package/sdk/products.d.ts +21 -12
  187. package/sdk/products.d.ts.map +1 -1
  188. package/sdk/products.js +30 -20
  189. package/sdk/products.js.map +1 -1
  190. package/sdk/promotions.d.ts +12 -0
  191. package/sdk/promotions.d.ts.map +1 -0
  192. package/sdk/promotions.js +22 -0
  193. package/sdk/promotions.js.map +1 -0
  194. package/sdk/returns.d.ts +0 -14
  195. package/sdk/returns.d.ts.map +1 -1
  196. package/sdk/returns.js +0 -20
  197. package/sdk/returns.js.map +1 -1
  198. package/sdk/reviews.d.ts +1 -1
  199. package/sdk/reviews.d.ts.map +1 -1
  200. package/sdk/reviews.js +3 -3
  201. package/sdk/reviews.js.map +1 -1
  202. package/sdk/sdk.d.ts +8 -5
  203. package/sdk/sdk.d.ts.map +1 -1
  204. package/sdk/sdk.js +12 -7
  205. package/sdk/sdk.js.map +1 -1
  206. package/sdk/shipping.d.ts +1 -1
  207. package/sdk/shipping.d.ts.map +1 -1
  208. package/sdk/shipping.js +3 -3
  209. package/sdk/shipping.js.map +1 -1
  210. package/sdk/user.d.ts +4 -86
  211. package/sdk/user.d.ts.map +1 -1
  212. package/sdk/user.js +4 -120
  213. package/sdk/user.js.map +1 -1
  214. package/sdk/{countries.d.ts → utils.d.ts} +9 -2
  215. package/sdk/utils.d.ts.map +1 -0
  216. package/sdk/utils.js +42 -0
  217. package/sdk/utils.js.map +1 -0
  218. package/src/funcs/{analyticsTrackEvent.ts → analyticsTrack.ts} +1 -1
  219. package/src/funcs/{authOtpGenerate.ts → authGenerateOtp.ts} +1 -1
  220. package/src/funcs/{authTokenRefresh.ts → authRefreshToken.ts} +1 -1
  221. package/src/funcs/{authGetUser.ts → authUserGet.ts} +1 -1
  222. package/src/funcs/{authUpdateUser.ts → authUserUpdate.ts} +1 -1
  223. package/src/funcs/{campaignsSubscribeNewsletter.ts → campaignsNewsletterSubscribe.ts} +1 -1
  224. package/src/funcs/{catalogProductsCrossSellList.ts → catalogProductsGetCrossSells.ts} +1 -1
  225. package/src/funcs/{catalogProductsSimilarList.ts → catalogProductsGetSimilar.ts} +1 -1
  226. package/src/funcs/{catalogProductsUpSellList.ts → catalogProductsGetUpsells.ts} +1 -1
  227. package/src/funcs/{customersGetAddresses.ts → customersAddressesList.ts} +1 -1
  228. package/src/funcs/{catalogProductsRecommendedList.ts → customersGetRecommendedProducts.ts} +1 -1
  229. package/src/funcs/{customersReviewsGetAll.ts → customersReviewsList.ts} +1 -1
  230. package/src/funcs/{offersGetCoupons.ts → offersCouponsList.ts} +1 -1
  231. package/src/funcs/{offersGetPromotions.ts → offersPromotionsList.ts} +1 -1
  232. package/src/funcs/{shippingGetPincodeServiceability.ts → shippingCheckPincodeServiceability.ts} +1 -1
  233. package/src/funcs/{authUserCreateNotificationPreferences.ts → userNotificationPreferencesCreate.ts} +1 -1
  234. package/src/funcs/{authUserGetNotificationPreferences.ts → userNotificationPreferencesGet.ts} +1 -1
  235. package/src/funcs/{authUserUpdateNotificationPreferences.ts → userNotificationPreferencesUpdate.ts} +1 -1
  236. package/src/funcs/{commonGetCountries.ts → utilsGetCountries.ts} +1 -1
  237. package/src/funcs/{commonCountriesGetPincodes.ts → utilsGetPincodes.ts} +1 -1
  238. package/src/funcs/{commonCountriesGetStates.ts → utilsGetStates.ts} +1 -1
  239. package/src/lib/config.ts +3 -8
  240. package/src/models/components/cartitem.ts +4 -4
  241. package/src/models/components/index.ts +0 -1
  242. package/src/models/components/orderreturnitem.ts +0 -70
  243. package/src/models/components/productattribute.ts +1 -1
  244. package/src/models/components/productdetail.ts +5 -5
  245. package/src/models/components/productlist.ts +5 -5
  246. package/src/models/components/productreview.ts +1 -1
  247. package/src/models/components/productshipping.ts +2 -2
  248. package/src/models/components/productsubscription.ts +1 -1
  249. package/src/models/components/skuinfo.ts +4 -4
  250. package/src/models/errors/unauthorized.ts +1 -1
  251. package/src/models/operations/index.ts +0 -3
  252. package/src/models/operations/postcartitemid.ts +1 -1
  253. package/src/sdk/addresses.ts +14 -0
  254. package/src/sdk/analytics.ts +3 -3
  255. package/src/sdk/auth.ts +18 -30
  256. package/src/sdk/campaigns.ts +5 -15
  257. package/src/sdk/cestorefrontuser.ts +160 -0
  258. package/src/sdk/coupons.ts +20 -0
  259. package/src/sdk/customers.ts +6 -7
  260. package/src/sdk/newsletter.ts +23 -0
  261. package/src/sdk/notificationpreferences.ts +51 -0
  262. package/src/sdk/offers.ts +9 -21
  263. package/src/sdk/orders.ts +0 -11
  264. package/src/sdk/products.ts +42 -24
  265. package/src/sdk/promotions.ts +20 -0
  266. package/src/sdk/returns.ts +0 -28
  267. package/src/sdk/reviews.ts +3 -3
  268. package/src/sdk/sdk.ts +15 -9
  269. package/src/sdk/shipping.ts +3 -3
  270. package/src/sdk/user.ts +5 -166
  271. package/src/sdk/{countries.ts → utils.ts} +18 -5
  272. package/docs/sdks/crosssell/README.md +0 -82
  273. package/docs/sdks/similar/README.md +0 -82
  274. package/docs/sdks/token/README.md +0 -80
  275. package/docs/sdks/upsell/README.md +0 -82
  276. package/funcs/analyticsTrackEvent.d.ts.map +0 -1
  277. package/funcs/analyticsTrackEvent.js.map +0 -1
  278. package/funcs/authUserCreateNotificationPreferences.d.ts.map +0 -1
  279. package/funcs/authUserCreateNotificationPreferences.js.map +0 -1
  280. package/funcs/authUserGetNotificationPreferences.d.ts.map +0 -1
  281. package/funcs/authUserGetNotificationPreferences.js.map +0 -1
  282. package/funcs/authUserUpdateNotificationPreferences.d.ts.map +0 -1
  283. package/funcs/authUserUpdateNotificationPreferences.js.map +0 -1
  284. package/funcs/catalogProductsRecommendedList.d.ts.map +0 -1
  285. package/funcs/catalogProductsRecommendedList.js.map +0 -1
  286. package/funcs/catalogProductsSimilarList.d.ts.map +0 -1
  287. package/funcs/catalogProductsSimilarList.js.map +0 -1
  288. package/funcs/commonCountriesGetPincodes.d.ts.map +0 -1
  289. package/funcs/commonCountriesGetPincodes.js.map +0 -1
  290. package/funcs/commonCountriesGetStates.d.ts.map +0 -1
  291. package/funcs/commonCountriesGetStates.js.map +0 -1
  292. package/funcs/commonGetCountries.d.ts.map +0 -1
  293. package/funcs/commonGetCountries.js.map +0 -1
  294. package/funcs/customersGetAddresses.d.ts.map +0 -1
  295. package/funcs/customersGetAddresses.js.map +0 -1
  296. package/funcs/customersReviewsGetAll.d.ts.map +0 -1
  297. package/funcs/customersReviewsGetAll.js.map +0 -1
  298. package/funcs/offersGetCoupons.d.ts.map +0 -1
  299. package/funcs/offersGetCoupons.js.map +0 -1
  300. package/funcs/offersGetPromotions.d.ts.map +0 -1
  301. package/funcs/offersGetPromotions.js.map +0 -1
  302. package/funcs/ordersGetReturns.d.ts +0 -15
  303. package/funcs/ordersGetReturns.d.ts.map +0 -1
  304. package/funcs/ordersGetReturns.js +0 -80
  305. package/funcs/ordersReturnsCreate.d.ts +0 -16
  306. package/funcs/ordersReturnsCreate.d.ts.map +0 -1
  307. package/funcs/ordersReturnsCreate.js +0 -101
  308. package/funcs/ordersReturnsCreate.js.map +0 -1
  309. package/funcs/ordersReturnsGet.d.ts +0 -15
  310. package/funcs/ordersReturnsGet.d.ts.map +0 -1
  311. package/funcs/ordersReturnsGet.js +0 -100
  312. package/funcs/ordersReturnsGet.js.map +0 -1
  313. package/funcs/shippingGetPincodeServiceability.d.ts.map +0 -1
  314. package/funcs/shippingGetPincodeServiceability.js.map +0 -1
  315. package/models/components/createorderreturn.d.ts +0 -29
  316. package/models/components/createorderreturn.d.ts.map +0 -1
  317. package/models/components/createorderreturn.js +0 -69
  318. package/models/components/createorderreturn.js.map +0 -1
  319. package/models/operations/getordersordernumberreturnreturnid.d.ts +0 -87
  320. package/models/operations/getordersordernumberreturnreturnid.d.ts.map +0 -1
  321. package/models/operations/getordersordernumberreturnreturnid.js +0 -122
  322. package/models/operations/getordersordernumberreturnreturnid.js.map +0 -1
  323. package/models/operations/getordersreturns.d.ts +0 -56
  324. package/models/operations/getordersreturns.d.ts.map +0 -1
  325. package/models/operations/getordersreturns.js +0 -74
  326. package/models/operations/getordersreturns.js.map +0 -1
  327. package/models/operations/postordersordernumberreturn.d.ts +0 -84
  328. package/models/operations/postordersordernumberreturn.d.ts.map +0 -1
  329. package/models/operations/postordersordernumberreturn.js +0 -122
  330. package/models/operations/postordersordernumberreturn.js.map +0 -1
  331. package/sdk/common.d.ts +0 -15
  332. package/sdk/common.d.ts.map +0 -1
  333. package/sdk/common.js +0 -27
  334. package/sdk/common.js.map +0 -1
  335. package/sdk/countries.d.ts.map +0 -1
  336. package/sdk/countries.js +0 -32
  337. package/sdk/countries.js.map +0 -1
  338. package/sdk/crosssell.d.ts +0 -12
  339. package/sdk/crosssell.d.ts.map +0 -1
  340. package/sdk/crosssell.js +0 -22
  341. package/sdk/crosssell.js.map +0 -1
  342. package/sdk/otp.d.ts +0 -12
  343. package/sdk/otp.d.ts.map +0 -1
  344. package/sdk/otp.js +0 -22
  345. package/sdk/otp.js.map +0 -1
  346. package/sdk/recommended.d.ts +0 -12
  347. package/sdk/recommended.d.ts.map +0 -1
  348. package/sdk/recommended.js +0 -22
  349. package/sdk/recommended.js.map +0 -1
  350. package/sdk/similar.d.ts +0 -12
  351. package/sdk/similar.d.ts.map +0 -1
  352. package/sdk/similar.js +0 -22
  353. package/sdk/similar.js.map +0 -1
  354. package/sdk/token.d.ts +0 -12
  355. package/sdk/token.d.ts.map +0 -1
  356. package/sdk/token.js +0 -22
  357. package/sdk/token.js.map +0 -1
  358. package/sdk/upsell.d.ts +0 -12
  359. package/sdk/upsell.d.ts.map +0 -1
  360. package/sdk/upsell.js +0 -22
  361. package/sdk/upsell.js.map +0 -1
  362. package/src/funcs/ordersGetReturns.ts +0 -103
  363. package/src/funcs/ordersReturnsCreate.ts +0 -139
  364. package/src/funcs/ordersReturnsGet.ts +0 -132
  365. package/src/models/components/createorderreturn.ts +0 -73
  366. package/src/models/operations/getordersordernumberreturnreturnid.ts +0 -174
  367. package/src/models/operations/getordersreturns.ts +0 -97
  368. package/src/models/operations/postordersordernumberreturn.ts +0 -171
  369. package/src/sdk/common.ts +0 -28
  370. package/src/sdk/crosssell.ts +0 -23
  371. package/src/sdk/otp.ts +0 -23
  372. package/src/sdk/recommended.ts +0 -20
  373. package/src/sdk/similar.ts +0 -23
  374. package/src/sdk/token.ts +0 -23
  375. package/src/sdk/upsell.ts +0 -23
@@ -0,0 +1,850 @@
1
+ # CeStorefrontUser
2
+ (*auth.user*)
3
+
4
+ ## Overview
5
+
6
+ ### Available Operations
7
+
8
+ * [get](#get) - Retrieve a user
9
+ * [update](#update) - Update a user
10
+ * [addProfileImage](#addprofileimage) - Add profile image
11
+ * [updateProfileImage](#updateprofileimage) - Update profile image
12
+ * [deleteProfileImage](#deleteprofileimage) - Delete profile image
13
+ * [getProfileImage](#getprofileimage) - Retrieve a profile image
14
+ * [deactivateAccount](#deactivateaccount) - Deactivate account
15
+ * [changePassword](#changepassword) - Change password
16
+ * [forgotPassword](#forgotpassword) - Forgot password
17
+ * [resetPassword](#resetpassword) - Reset password
18
+ * [logout](#logout) - Logout user
19
+
20
+ ## get
21
+
22
+ The Retrieve User API is designed to facilitate the retrieval of comprehensive user information from the system. A required parameter is a user-id of the user whose information needs to be retrieved.
23
+
24
+ ### Example Usage
25
+
26
+ ```typescript
27
+ import { CeStorefront } from "ce-storefront";
28
+
29
+ const ceStorefront = new CeStorefront({
30
+ authorization: "<YOUR_BEARER_TOKEN_HERE>",
31
+ });
32
+
33
+ async function run() {
34
+ const result = await ceStorefront.auth.user.get({
35
+ id: "<id>",
36
+ });
37
+
38
+ // Handle the result
39
+ console.log(result)
40
+ }
41
+
42
+ run();
43
+ ```
44
+
45
+ ### Standalone function
46
+
47
+ The standalone function version of this method:
48
+
49
+ ```typescript
50
+ import { CeStorefrontCore } from "ce-storefront/core.js";
51
+ import { authUserGet } from "ce-storefront/funcs/authUserGet.js";
52
+
53
+ // Use `CeStorefrontCore` for best tree-shaking performance.
54
+ // You can create one instance of it to use across an application.
55
+ const ceStorefront = new CeStorefrontCore({
56
+ authorization: "<YOUR_BEARER_TOKEN_HERE>",
57
+ });
58
+
59
+ async function run() {
60
+ const res = await authUserGet(ceStorefront, {
61
+ id: "<id>",
62
+ });
63
+
64
+ if (!res.ok) {
65
+ throw res.error;
66
+ }
67
+
68
+ const { value: result } = res;
69
+
70
+ // Handle the result
71
+ console.log(result)
72
+ }
73
+
74
+ run();
75
+ ```
76
+
77
+ ### Parameters
78
+
79
+ | Parameter | Type | Required | Description |
80
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
81
+ | `request` | [operations.GetAuthUserIdRequest](../../models/operations/getauthuseridrequest.md) | :heavy_check_mark: | The request object to use for the request. |
82
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
83
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
84
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
85
+
86
+ ### Response
87
+
88
+ **Promise\<[operations.GetAuthUserIdResponseBody](../../models/operations/getauthuseridresponsebody.md)\>**
89
+
90
+ ### Errors
91
+
92
+ | Error Object | Status Code | Content Type |
93
+ | --------------- | --------------- | --------------- |
94
+ | errors.SDKError | 4xx-5xx | */* |
95
+
96
+
97
+ ## update
98
+
99
+ The Update User API helps to efficiently modify and enhance user information within the system, ensuring that user profiles remain accurate and up-to-date. This API provides a secure and flexible mechanism for updating specific details while maintaining adherence to established conventions.
100
+
101
+ ### Example Usage
102
+
103
+ ```typescript
104
+ import { CeStorefront } from "ce-storefront";
105
+
106
+ const ceStorefront = new CeStorefront({
107
+ authorization: "<YOUR_BEARER_TOKEN_HERE>",
108
+ });
109
+
110
+ async function run() {
111
+ const result = await ceStorefront.auth.user.update({
112
+ id: "<id>",
113
+ });
114
+
115
+ // Handle the result
116
+ console.log(result)
117
+ }
118
+
119
+ run();
120
+ ```
121
+
122
+ ### Standalone function
123
+
124
+ The standalone function version of this method:
125
+
126
+ ```typescript
127
+ import { CeStorefrontCore } from "ce-storefront/core.js";
128
+ import { authUserUpdate } from "ce-storefront/funcs/authUserUpdate.js";
129
+
130
+ // Use `CeStorefrontCore` for best tree-shaking performance.
131
+ // You can create one instance of it to use across an application.
132
+ const ceStorefront = new CeStorefrontCore({
133
+ authorization: "<YOUR_BEARER_TOKEN_HERE>",
134
+ });
135
+
136
+ async function run() {
137
+ const res = await authUserUpdate(ceStorefront, {
138
+ id: "<id>",
139
+ });
140
+
141
+ if (!res.ok) {
142
+ throw res.error;
143
+ }
144
+
145
+ const { value: result } = res;
146
+
147
+ // Handle the result
148
+ console.log(result)
149
+ }
150
+
151
+ run();
152
+ ```
153
+
154
+ ### Parameters
155
+
156
+ | Parameter | Type | Required | Description |
157
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
158
+ | `request` | [operations.PutAuthUserIdRequest](../../models/operations/putauthuseridrequest.md) | :heavy_check_mark: | The request object to use for the request. |
159
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
160
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
161
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
162
+
163
+ ### Response
164
+
165
+ **Promise\<[operations.PutAuthUserIdResponseBody](../../models/operations/putauthuseridresponsebody.md)\>**
166
+
167
+ ### Errors
168
+
169
+ | Error Object | Status Code | Content Type |
170
+ | --------------- | --------------- | --------------- |
171
+ | errors.SDKError | 4xx-5xx | */* |
172
+
173
+
174
+ ## addProfileImage
175
+
176
+ The Profile Image API streamlines the process of uploading profile images associating with user accounts, offering a user-centric approach to visual identity customization. Upon success, the API responds with a confirmation message. In case of errors, clear error messages facilitate quick issue resolution. Overall, the Profile Image API enhances user engagement by seamlessly integrating personalized visual elements into digital platforms.
177
+
178
+ ### Example Usage
179
+
180
+ ```typescript
181
+ import { CeStorefront } from "ce-storefront";
182
+
183
+ const ceStorefront = new CeStorefront({
184
+ authorization: "<YOUR_BEARER_TOKEN_HERE>",
185
+ });
186
+
187
+ async function run() {
188
+ const result = await ceStorefront.auth.user.addProfileImage({
189
+ id: "<id>",
190
+ });
191
+
192
+ // Handle the result
193
+ console.log(result)
194
+ }
195
+
196
+ run();
197
+ ```
198
+
199
+ ### Standalone function
200
+
201
+ The standalone function version of this method:
202
+
203
+ ```typescript
204
+ import { CeStorefrontCore } from "ce-storefront/core.js";
205
+ import { authUserAddProfileImage } from "ce-storefront/funcs/authUserAddProfileImage.js";
206
+
207
+ // Use `CeStorefrontCore` for best tree-shaking performance.
208
+ // You can create one instance of it to use across an application.
209
+ const ceStorefront = new CeStorefrontCore({
210
+ authorization: "<YOUR_BEARER_TOKEN_HERE>",
211
+ });
212
+
213
+ async function run() {
214
+ const res = await authUserAddProfileImage(ceStorefront, {
215
+ id: "<id>",
216
+ });
217
+
218
+ if (!res.ok) {
219
+ throw res.error;
220
+ }
221
+
222
+ const { value: result } = res;
223
+
224
+ // Handle the result
225
+ console.log(result)
226
+ }
227
+
228
+ run();
229
+ ```
230
+
231
+ ### Parameters
232
+
233
+ | Parameter | Type | Required | Description |
234
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
235
+ | `request` | [operations.PostAuthUserIdProfileImageRequest](../../models/operations/postauthuseridprofileimagerequest.md) | :heavy_check_mark: | The request object to use for the request. |
236
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
237
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
238
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
239
+
240
+ ### Response
241
+
242
+ **Promise\<[operations.PostAuthUserIdProfileImageResponseBody](../../models/operations/postauthuseridprofileimageresponsebody.md)\>**
243
+
244
+ ### Errors
245
+
246
+ | Error Object | Status Code | Content Type |
247
+ | --------------- | --------------- | --------------- |
248
+ | errors.SDKError | 4xx-5xx | */* |
249
+
250
+
251
+ ## updateProfileImage
252
+
253
+ The Profile Image API streamlines the process of updating profile images associating with user accounts, offering a user-centric approach to visual identity customization. Upon success, the API responds with a confirmation message. In case of errors, clear error messages facilitate quick issue resolution. Overall, the Profile Image API enhances user engagement by seamlessly integrating personalized visual elements into digital platforms.
254
+
255
+ ### Example Usage
256
+
257
+ ```typescript
258
+ import { CeStorefront } from "ce-storefront";
259
+
260
+ const ceStorefront = new CeStorefront({
261
+ authorization: "<YOUR_BEARER_TOKEN_HERE>",
262
+ });
263
+
264
+ async function run() {
265
+ const result = await ceStorefront.auth.user.updateProfileImage({
266
+ id: "<id>",
267
+ });
268
+
269
+ // Handle the result
270
+ console.log(result)
271
+ }
272
+
273
+ run();
274
+ ```
275
+
276
+ ### Standalone function
277
+
278
+ The standalone function version of this method:
279
+
280
+ ```typescript
281
+ import { CeStorefrontCore } from "ce-storefront/core.js";
282
+ import { authUserUpdateProfileImage } from "ce-storefront/funcs/authUserUpdateProfileImage.js";
283
+
284
+ // Use `CeStorefrontCore` for best tree-shaking performance.
285
+ // You can create one instance of it to use across an application.
286
+ const ceStorefront = new CeStorefrontCore({
287
+ authorization: "<YOUR_BEARER_TOKEN_HERE>",
288
+ });
289
+
290
+ async function run() {
291
+ const res = await authUserUpdateProfileImage(ceStorefront, {
292
+ id: "<id>",
293
+ });
294
+
295
+ if (!res.ok) {
296
+ throw res.error;
297
+ }
298
+
299
+ const { value: result } = res;
300
+
301
+ // Handle the result
302
+ console.log(result)
303
+ }
304
+
305
+ run();
306
+ ```
307
+
308
+ ### Parameters
309
+
310
+ | Parameter | Type | Required | Description |
311
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
312
+ | `request` | [operations.PutAuthUserIdProfileImageRequest](../../models/operations/putauthuseridprofileimagerequest.md) | :heavy_check_mark: | The request object to use for the request. |
313
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
314
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
315
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
316
+
317
+ ### Response
318
+
319
+ **Promise\<[operations.PutAuthUserIdProfileImageResponseBody](../../models/operations/putauthuseridprofileimageresponsebody.md)\>**
320
+
321
+ ### Errors
322
+
323
+ | Error Object | Status Code | Content Type |
324
+ | --------------- | --------------- | --------------- |
325
+ | errors.SDKError | 4xx-5xx | */* |
326
+
327
+
328
+ ## deleteProfileImage
329
+
330
+ Delete profile image API streamlines the process of removing profile images associating with user accounts. Upon success, the API responds with a confirmation message. In case of errors, clear error messages facilitate quick issue resolution.
331
+
332
+ ### Example Usage
333
+
334
+ ```typescript
335
+ import { CeStorefront } from "ce-storefront";
336
+
337
+ const ceStorefront = new CeStorefront({
338
+ authorization: "<YOUR_BEARER_TOKEN_HERE>",
339
+ });
340
+
341
+ async function run() {
342
+ const result = await ceStorefront.auth.user.deleteProfileImage({
343
+ id: "<id>",
344
+ });
345
+
346
+ // Handle the result
347
+ console.log(result)
348
+ }
349
+
350
+ run();
351
+ ```
352
+
353
+ ### Standalone function
354
+
355
+ The standalone function version of this method:
356
+
357
+ ```typescript
358
+ import { CeStorefrontCore } from "ce-storefront/core.js";
359
+ import { authUserDeleteProfileImage } from "ce-storefront/funcs/authUserDeleteProfileImage.js";
360
+
361
+ // Use `CeStorefrontCore` for best tree-shaking performance.
362
+ // You can create one instance of it to use across an application.
363
+ const ceStorefront = new CeStorefrontCore({
364
+ authorization: "<YOUR_BEARER_TOKEN_HERE>",
365
+ });
366
+
367
+ async function run() {
368
+ const res = await authUserDeleteProfileImage(ceStorefront, {
369
+ id: "<id>",
370
+ });
371
+
372
+ if (!res.ok) {
373
+ throw res.error;
374
+ }
375
+
376
+ const { value: result } = res;
377
+
378
+ // Handle the result
379
+ console.log(result)
380
+ }
381
+
382
+ run();
383
+ ```
384
+
385
+ ### Parameters
386
+
387
+ | Parameter | Type | Required | Description |
388
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
389
+ | `request` | [operations.DeleteAuthUserIdProfileImageRequest](../../models/operations/deleteauthuseridprofileimagerequest.md) | :heavy_check_mark: | The request object to use for the request. |
390
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
391
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
392
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
393
+
394
+ ### Response
395
+
396
+ **Promise\<[operations.DeleteAuthUserIdProfileImageResponseBody](../../models/operations/deleteauthuseridprofileimageresponsebody.md)\>**
397
+
398
+ ### Errors
399
+
400
+ | Error Object | Status Code | Content Type |
401
+ | --------------- | --------------- | --------------- |
402
+ | errors.SDKError | 4xx-5xx | */* |
403
+
404
+
405
+ ## getProfileImage
406
+
407
+ Retrieve user profile image API streamlines the process of retriving profile images associating with user accounts. Upon success, the API responds with a confirmation message. In case of errors, clear error messages facilitate quick issue resolution.
408
+
409
+ ### Example Usage
410
+
411
+ ```typescript
412
+ import { CeStorefront } from "ce-storefront";
413
+
414
+ const ceStorefront = new CeStorefront({
415
+ authorization: "<YOUR_BEARER_TOKEN_HERE>",
416
+ });
417
+
418
+ async function run() {
419
+ const result = await ceStorefront.auth.user.getProfileImage({
420
+ id: "<id>",
421
+ });
422
+
423
+ // Handle the result
424
+ console.log(result)
425
+ }
426
+
427
+ run();
428
+ ```
429
+
430
+ ### Standalone function
431
+
432
+ The standalone function version of this method:
433
+
434
+ ```typescript
435
+ import { CeStorefrontCore } from "ce-storefront/core.js";
436
+ import { authUserGetProfileImage } from "ce-storefront/funcs/authUserGetProfileImage.js";
437
+
438
+ // Use `CeStorefrontCore` for best tree-shaking performance.
439
+ // You can create one instance of it to use across an application.
440
+ const ceStorefront = new CeStorefrontCore({
441
+ authorization: "<YOUR_BEARER_TOKEN_HERE>",
442
+ });
443
+
444
+ async function run() {
445
+ const res = await authUserGetProfileImage(ceStorefront, {
446
+ id: "<id>",
447
+ });
448
+
449
+ if (!res.ok) {
450
+ throw res.error;
451
+ }
452
+
453
+ const { value: result } = res;
454
+
455
+ // Handle the result
456
+ console.log(result)
457
+ }
458
+
459
+ run();
460
+ ```
461
+
462
+ ### Parameters
463
+
464
+ | Parameter | Type | Required | Description |
465
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
466
+ | `request` | [operations.GetAuthUserIdProfileImageRequest](../../models/operations/getauthuseridprofileimagerequest.md) | :heavy_check_mark: | The request object to use for the request. |
467
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
468
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
469
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
470
+
471
+ ### Response
472
+
473
+ **Promise\<[operations.GetAuthUserIdProfileImageResponseBody](../../models/operations/getauthuseridprofileimageresponsebody.md)\>**
474
+
475
+ ### Errors
476
+
477
+ | Error Object | Status Code | Content Type |
478
+ | --------------- | --------------- | --------------- |
479
+ | errors.SDKError | 4xx-5xx | */* |
480
+
481
+
482
+ ## deactivateAccount
483
+
484
+ The Deactivate Account API providing users with a straightforward method to deactivate their accounts. Upon successful deactivation, the API responds with a confirmation message. Error responses are detailed, aiding developers in addressing issues promptly.
485
+
486
+ ### Example Usage
487
+
488
+ ```typescript
489
+ import { CeStorefront } from "ce-storefront";
490
+
491
+ const ceStorefront = new CeStorefront({
492
+ authorization: "<YOUR_BEARER_TOKEN_HERE>",
493
+ });
494
+
495
+ async function run() {
496
+ const result = await ceStorefront.auth.user.deactivateAccount({
497
+ id: "<id>",
498
+ });
499
+
500
+ // Handle the result
501
+ console.log(result)
502
+ }
503
+
504
+ run();
505
+ ```
506
+
507
+ ### Standalone function
508
+
509
+ The standalone function version of this method:
510
+
511
+ ```typescript
512
+ import { CeStorefrontCore } from "ce-storefront/core.js";
513
+ import { authUserDeactivateAccount } from "ce-storefront/funcs/authUserDeactivateAccount.js";
514
+
515
+ // Use `CeStorefrontCore` for best tree-shaking performance.
516
+ // You can create one instance of it to use across an application.
517
+ const ceStorefront = new CeStorefrontCore({
518
+ authorization: "<YOUR_BEARER_TOKEN_HERE>",
519
+ });
520
+
521
+ async function run() {
522
+ const res = await authUserDeactivateAccount(ceStorefront, {
523
+ id: "<id>",
524
+ });
525
+
526
+ if (!res.ok) {
527
+ throw res.error;
528
+ }
529
+
530
+ const { value: result } = res;
531
+
532
+ // Handle the result
533
+ console.log(result)
534
+ }
535
+
536
+ run();
537
+ ```
538
+
539
+ ### Parameters
540
+
541
+ | Parameter | Type | Required | Description |
542
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
543
+ | `request` | [operations.PutAuthUserIdDeactivateRequest](../../models/operations/putauthuseriddeactivaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
544
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
545
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
546
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
547
+
548
+ ### Response
549
+
550
+ **Promise\<[operations.PutAuthUserIdDeactivateResponseBody](../../models/operations/putauthuseriddeactivateresponsebody.md)\>**
551
+
552
+ ### Errors
553
+
554
+ | Error Object | Status Code | Content Type |
555
+ | --------------- | --------------- | --------------- |
556
+ | errors.SDKError | 4xx-5xx | */* |
557
+
558
+
559
+ ## changePassword
560
+
561
+ The Change Password API is a key feature designed to provide a secure and standardized method for users to update their passwords.
562
+
563
+ ### Example Usage
564
+
565
+ ```typescript
566
+ import { CeStorefront } from "ce-storefront";
567
+
568
+ const ceStorefront = new CeStorefront({
569
+ authorization: "<YOUR_BEARER_TOKEN_HERE>",
570
+ });
571
+
572
+ async function run() {
573
+ const result = await ceStorefront.auth.user.changePassword();
574
+
575
+ // Handle the result
576
+ console.log(result)
577
+ }
578
+
579
+ run();
580
+ ```
581
+
582
+ ### Standalone function
583
+
584
+ The standalone function version of this method:
585
+
586
+ ```typescript
587
+ import { CeStorefrontCore } from "ce-storefront/core.js";
588
+ import { authUserChangePassword } from "ce-storefront/funcs/authUserChangePassword.js";
589
+
590
+ // Use `CeStorefrontCore` for best tree-shaking performance.
591
+ // You can create one instance of it to use across an application.
592
+ const ceStorefront = new CeStorefrontCore({
593
+ authorization: "<YOUR_BEARER_TOKEN_HERE>",
594
+ });
595
+
596
+ async function run() {
597
+ const res = await authUserChangePassword(ceStorefront);
598
+
599
+ if (!res.ok) {
600
+ throw res.error;
601
+ }
602
+
603
+ const { value: result } = res;
604
+
605
+ // Handle the result
606
+ console.log(result)
607
+ }
608
+
609
+ run();
610
+ ```
611
+
612
+ ### Parameters
613
+
614
+ | Parameter | Type | Required | Description |
615
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
616
+ | `request` | [operations.PostAuthChangePasswordRequestBody](../../models/operations/postauthchangepasswordrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
617
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
618
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
619
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
620
+
621
+ ### Response
622
+
623
+ **Promise\<[operations.PostAuthChangePasswordResponseBody](../../models/operations/postauthchangepasswordresponsebody.md)\>**
624
+
625
+ ### Errors
626
+
627
+ | Error Object | Status Code | Content Type |
628
+ | ------------------- | ------------------- | ------------------- |
629
+ | errors.BadRequest | 400 | application/json |
630
+ | errors.Unauthorized | 401 | application/json |
631
+ | errors.SDKError | 4xx-5xx | */* |
632
+
633
+
634
+ ## forgotPassword
635
+
636
+ The Forgot Password API provides a secure mechanism for users to initiate the password recovery process. This API provides one-time password (OTP) token, which facilitas the resetting of user’s account password.
637
+
638
+ ### Example Usage
639
+
640
+ ```typescript
641
+ import { CeStorefront } from "ce-storefront";
642
+
643
+ const ceStorefront = new CeStorefront({
644
+ authorization: "<YOUR_BEARER_TOKEN_HERE>",
645
+ });
646
+
647
+ async function run() {
648
+ const result = await ceStorefront.auth.user.forgotPassword();
649
+
650
+ // Handle the result
651
+ console.log(result)
652
+ }
653
+
654
+ run();
655
+ ```
656
+
657
+ ### Standalone function
658
+
659
+ The standalone function version of this method:
660
+
661
+ ```typescript
662
+ import { CeStorefrontCore } from "ce-storefront/core.js";
663
+ import { authUserForgotPassword } from "ce-storefront/funcs/authUserForgotPassword.js";
664
+
665
+ // Use `CeStorefrontCore` for best tree-shaking performance.
666
+ // You can create one instance of it to use across an application.
667
+ const ceStorefront = new CeStorefrontCore({
668
+ authorization: "<YOUR_BEARER_TOKEN_HERE>",
669
+ });
670
+
671
+ async function run() {
672
+ const res = await authUserForgotPassword(ceStorefront);
673
+
674
+ if (!res.ok) {
675
+ throw res.error;
676
+ }
677
+
678
+ const { value: result } = res;
679
+
680
+ // Handle the result
681
+ console.log(result)
682
+ }
683
+
684
+ run();
685
+ ```
686
+
687
+ ### Parameters
688
+
689
+ | Parameter | Type | Required | Description |
690
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
691
+ | `request` | [operations.PostAuthForgotPasswordRequestBody](../../models/operations/postauthforgotpasswordrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
692
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
693
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
694
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
695
+
696
+ ### Response
697
+
698
+ **Promise\<[operations.PostAuthForgotPasswordResponseBody](../../models/operations/postauthforgotpasswordresponsebody.md)\>**
699
+
700
+ ### Errors
701
+
702
+ | Error Object | Status Code | Content Type |
703
+ | --------------- | --------------- | --------------- |
704
+ | errors.SDKError | 4xx-5xx | */* |
705
+
706
+
707
+ ## resetPassword
708
+
709
+ Reset password
710
+
711
+ ### Example Usage
712
+
713
+ ```typescript
714
+ import { CeStorefront } from "ce-storefront";
715
+
716
+ const ceStorefront = new CeStorefront({
717
+ authorization: "<YOUR_BEARER_TOKEN_HERE>",
718
+ });
719
+
720
+ async function run() {
721
+ const result = await ceStorefront.auth.user.resetPassword();
722
+
723
+ // Handle the result
724
+ console.log(result)
725
+ }
726
+
727
+ run();
728
+ ```
729
+
730
+ ### Standalone function
731
+
732
+ The standalone function version of this method:
733
+
734
+ ```typescript
735
+ import { CeStorefrontCore } from "ce-storefront/core.js";
736
+ import { authUserResetPassword } from "ce-storefront/funcs/authUserResetPassword.js";
737
+
738
+ // Use `CeStorefrontCore` for best tree-shaking performance.
739
+ // You can create one instance of it to use across an application.
740
+ const ceStorefront = new CeStorefrontCore({
741
+ authorization: "<YOUR_BEARER_TOKEN_HERE>",
742
+ });
743
+
744
+ async function run() {
745
+ const res = await authUserResetPassword(ceStorefront);
746
+
747
+ if (!res.ok) {
748
+ throw res.error;
749
+ }
750
+
751
+ const { value: result } = res;
752
+
753
+ // Handle the result
754
+ console.log(result)
755
+ }
756
+
757
+ run();
758
+ ```
759
+
760
+ ### Parameters
761
+
762
+ | Parameter | Type | Required | Description |
763
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
764
+ | `request` | [operations.PostAuthResetPasswordRequestBody](../../models/operations/postauthresetpasswordrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
765
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
766
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
767
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
768
+
769
+ ### Response
770
+
771
+ **Promise\<[operations.PostAuthResetPasswordResponseBody](../../models/operations/postauthresetpasswordresponsebody.md)\>**
772
+
773
+ ### Errors
774
+
775
+ | Error Object | Status Code | Content Type |
776
+ | ----------------- | ----------------- | ----------------- |
777
+ | errors.BadRequest | 400 | application/json |
778
+ | errors.SDKError | 4xx-5xx | */* |
779
+
780
+
781
+ ## logout
782
+
783
+ The Logout User API initiate the logout process for a user. Upon a successful request, the API responds with a confirmation message. If the user is not found or there's an issue with the request, an error response is returned with an appropriate message.
784
+
785
+ ### Example Usage
786
+
787
+ ```typescript
788
+ import { CeStorefront } from "ce-storefront";
789
+
790
+ const ceStorefront = new CeStorefront({
791
+ authorization: "<YOUR_BEARER_TOKEN_HERE>",
792
+ });
793
+
794
+ async function run() {
795
+ const result = await ceStorefront.auth.user.logout();
796
+
797
+ // Handle the result
798
+ console.log(result)
799
+ }
800
+
801
+ run();
802
+ ```
803
+
804
+ ### Standalone function
805
+
806
+ The standalone function version of this method:
807
+
808
+ ```typescript
809
+ import { CeStorefrontCore } from "ce-storefront/core.js";
810
+ import { authUserLogout } from "ce-storefront/funcs/authUserLogout.js";
811
+
812
+ // Use `CeStorefrontCore` for best tree-shaking performance.
813
+ // You can create one instance of it to use across an application.
814
+ const ceStorefront = new CeStorefrontCore({
815
+ authorization: "<YOUR_BEARER_TOKEN_HERE>",
816
+ });
817
+
818
+ async function run() {
819
+ const res = await authUserLogout(ceStorefront);
820
+
821
+ if (!res.ok) {
822
+ throw res.error;
823
+ }
824
+
825
+ const { value: result } = res;
826
+
827
+ // Handle the result
828
+ console.log(result)
829
+ }
830
+
831
+ run();
832
+ ```
833
+
834
+ ### Parameters
835
+
836
+ | Parameter | Type | Required | Description |
837
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
838
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
839
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
840
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
841
+
842
+ ### Response
843
+
844
+ **Promise\<[operations.PostAuthLogoutResponseBody](../../models/operations/postauthlogoutresponsebody.md)\>**
845
+
846
+ ### Errors
847
+
848
+ | Error Object | Status Code | Content Type |
849
+ | --------------- | --------------- | --------------- |
850
+ | errors.SDKError | 4xx-5xx | */* |