ce-storefront 0.3.11 → 0.3.17

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 (438) hide show
  1. package/FUNCTIONS.md +2 -2
  2. package/README.md +129 -108
  3. package/docs/sdks/addresses/README.md +4 -363
  4. package/docs/sdks/auth/README.md +72 -0
  5. package/docs/sdks/authuser/README.md +80 -0
  6. package/docs/sdks/{refunds → cards}/README.md +12 -11
  7. package/docs/sdks/catalogproductreviews/README.md +97 -0
  8. package/docs/sdks/{shipments → catalogproducts}/README.md +12 -12
  9. package/docs/sdks/{skus → catalogskus}/README.md +3 -3
  10. package/docs/sdks/{cestorefrontreviews → cestorefrontaddresses}/README.md +123 -34
  11. package/docs/sdks/cestorefrontproducts/README.md +6 -0
  12. package/docs/sdks/cestorefrontuser/README.md +6 -735
  13. package/docs/sdks/cestorefrontusers/README.md +92 -0
  14. package/docs/sdks/countries/README.md +79 -0
  15. package/docs/sdks/customers/README.md +192 -18
  16. package/docs/sdks/juspay/README.md +15 -15
  17. package/docs/sdks/loyalty/README.md +0 -81
  18. package/docs/sdks/loyaltypoints/README.md +88 -0
  19. package/docs/sdks/notificationpreferences/README.md +4 -162
  20. package/docs/sdks/orders/README.md +163 -5
  21. package/docs/sdks/payments/README.md +15 -95
  22. package/docs/sdks/products/README.md +15 -94
  23. package/docs/sdks/reviews/README.md +17 -13
  24. package/docs/sdks/{shipping → shipment}/README.md +5 -5
  25. package/docs/sdks/user/README.md +425 -0
  26. package/docs/sdks/users/README.md +240 -0
  27. package/docs/sdks/utils/README.md +0 -72
  28. package/docs/sdks/wishlist/README.md +5 -5
  29. package/esm/funcs/{catalogProductsGetCrossSells.d.ts → addressesGet.d.ts} +4 -4
  30. package/esm/funcs/addressesGet.d.ts.map +1 -0
  31. package/esm/funcs/{customersAddressesGet.js → addressesGet.js} +2 -2
  32. package/esm/funcs/addressesGet.js.map +1 -0
  33. package/esm/funcs/{authUserLogout.d.ts → authLogout.d.ts} +2 -2
  34. package/esm/funcs/authLogout.d.ts.map +1 -0
  35. package/esm/funcs/{authUserLogout.js → authLogout.js} +2 -2
  36. package/esm/funcs/authLogout.js.map +1 -0
  37. package/esm/funcs/{authUserDeactivateAccount.d.ts → authUserDeactivate.d.ts} +2 -2
  38. package/esm/funcs/{paymentsGetMethods.d.ts.map → authUserDeactivate.d.ts.map} +1 -1
  39. package/esm/funcs/{authUserDeactivateAccount.js → authUserDeactivate.js} +2 -2
  40. package/esm/funcs/authUserDeactivate.js.map +1 -0
  41. package/esm/funcs/{userNotificationPreferencesGet.d.ts → authUserNotificationPreferencesGet.d.ts} +2 -2
  42. package/esm/funcs/authUserNotificationPreferencesGet.d.ts.map +1 -0
  43. package/esm/funcs/{userNotificationPreferencesGet.js → authUserNotificationPreferencesGet.js} +2 -2
  44. package/esm/funcs/authUserNotificationPreferencesGet.js.map +1 -0
  45. package/esm/funcs/{authUserAddProfileImage.d.ts → authUsersAddProfileImage.d.ts} +2 -2
  46. package/esm/funcs/authUsersAddProfileImage.d.ts.map +1 -0
  47. package/esm/funcs/{authUserAddProfileImage.js → authUsersAddProfileImage.js} +2 -2
  48. package/esm/funcs/authUsersAddProfileImage.js.map +1 -0
  49. package/esm/funcs/{catalogProductsReviewsCreate.d.ts → catalogProductReviewsCreate.d.ts} +2 -2
  50. package/esm/funcs/catalogProductReviewsCreate.d.ts.map +1 -0
  51. package/esm/funcs/{catalogProductsReviewsCreate.js → catalogProductReviewsCreate.js} +2 -2
  52. package/esm/funcs/catalogProductReviewsCreate.js.map +1 -0
  53. package/esm/funcs/customersAddAddress.d.ts +16 -0
  54. package/esm/funcs/{catalogProductsList.d.ts.map → customersAddAddress.d.ts.map} +1 -1
  55. package/esm/funcs/{customersAddressesAdd.js → customersAddAddress.js} +2 -2
  56. package/esm/funcs/customersAddAddress.js.map +1 -0
  57. package/esm/funcs/{customersPostCustomers.d.ts → customersCreate.d.ts} +2 -2
  58. package/esm/funcs/customersCreate.d.ts.map +1 -0
  59. package/esm/funcs/{customersPostCustomers.js → customersCreate.js} +2 -2
  60. package/esm/funcs/customersCreate.js.map +1 -0
  61. package/esm/funcs/{customersGetCustomersId.d.ts → customersGet.d.ts} +2 -2
  62. package/esm/funcs/customersGet.d.ts.map +1 -0
  63. package/esm/funcs/{customersGetCustomersId.js → customersGet.js} +2 -2
  64. package/esm/funcs/customersGet.js.map +1 -0
  65. package/esm/funcs/customersGetReviews.d.ts +15 -0
  66. package/esm/funcs/customersGetReviews.d.ts.map +1 -0
  67. package/esm/funcs/{customersReviewsList.js → customersGetReviews.js} +2 -2
  68. package/esm/funcs/customersGetReviews.js.map +1 -0
  69. package/esm/funcs/{customersAddressesAdd.d.ts → customersUpdate.d.ts} +4 -4
  70. package/esm/funcs/customersUpdate.d.ts.map +1 -0
  71. package/esm/funcs/{customersPutCustomersId.js → customersUpdate.js} +2 -2
  72. package/esm/funcs/customersUpdate.js.map +1 -0
  73. package/esm/funcs/juspayCreateCustomer.d.ts +17 -0
  74. package/esm/funcs/juspayCreateCustomer.d.ts.map +1 -0
  75. package/esm/funcs/{juspayPostPaymentsJuspayCreateCustomer.js → juspayCreateCustomer.js} +2 -2
  76. package/esm/funcs/juspayCreateCustomer.js.map +1 -0
  77. package/esm/funcs/{juspayPostPaymentsJuspayCreateOrder.d.ts → juspayCreateOrder.d.ts} +2 -2
  78. package/esm/funcs/juspayCreateOrder.d.ts.map +1 -0
  79. package/esm/funcs/{juspayPostPaymentsJuspayCreateOrder.js → juspayCreateOrder.js} +2 -2
  80. package/esm/funcs/{juspayGetPaymentsJuspayCustomer.js.map → juspayCreateOrder.js.map} +1 -1
  81. package/esm/funcs/{juspayGetPaymentsJuspayCustomer.d.ts → juspayGetCustomer.d.ts} +2 -2
  82. package/esm/funcs/juspayGetCustomer.d.ts.map +1 -0
  83. package/esm/funcs/{juspayGetPaymentsJuspayCustomer.js → juspayGetCustomer.js} +2 -2
  84. package/esm/funcs/{juspayPostPaymentsJuspayCreateOrder.js.map → juspayGetCustomer.js.map} +1 -1
  85. package/esm/funcs/{customersLoyaltyListActivities.d.ts → loyaltyPointsListActivities.d.ts} +2 -2
  86. package/esm/funcs/loyaltyPointsListActivities.d.ts.map +1 -0
  87. package/esm/funcs/{customersLoyaltyListActivities.js → loyaltyPointsListActivities.js} +2 -2
  88. package/esm/funcs/loyaltyPointsListActivities.js.map +1 -0
  89. package/esm/funcs/{customersReviewsList.d.ts → ordersGetPaymentStatus.d.ts} +4 -4
  90. package/esm/funcs/ordersGetPaymentStatus.d.ts.map +1 -0
  91. package/esm/funcs/{ordersGetOrdersIdPaymentStatus.js → ordersGetPaymentStatus.js} +2 -2
  92. package/esm/funcs/ordersGetPaymentStatus.js.map +1 -0
  93. package/esm/funcs/{ordersRefundsList.d.ts → ordersGetRefunds.d.ts} +2 -2
  94. package/esm/funcs/ordersGetRefunds.d.ts.map +1 -0
  95. package/esm/funcs/{ordersRefundsList.js → ordersGetRefunds.js} +2 -2
  96. package/esm/funcs/ordersGetRefunds.js.map +1 -0
  97. package/esm/funcs/{ordersShipmentsList.d.ts → ordersGetShipments.d.ts} +2 -2
  98. package/esm/funcs/ordersGetShipments.d.ts.map +1 -0
  99. package/esm/funcs/{ordersShipmentsList.js → ordersGetShipments.js} +2 -2
  100. package/esm/funcs/ordersGetShipments.js.map +1 -0
  101. package/esm/funcs/{paymentsPostPaymentsCards.d.ts → paymentsAddCard.d.ts} +2 -2
  102. package/esm/funcs/paymentsAddCard.d.ts.map +1 -0
  103. package/esm/funcs/{paymentsPostPaymentsCards.js → paymentsAddCard.js} +2 -2
  104. package/esm/funcs/paymentsAddCard.js.map +1 -0
  105. package/esm/funcs/{paymentsGetPaymentsCards.d.ts → paymentsCardsList.d.ts} +2 -2
  106. package/esm/funcs/paymentsCardsList.d.ts.map +1 -0
  107. package/esm/funcs/{paymentsGetPaymentsCards.js → paymentsCardsList.js} +2 -2
  108. package/esm/funcs/paymentsCardsList.js.map +1 -0
  109. package/esm/funcs/{paymentsGetMethods.d.ts → paymentsListMethods.d.ts} +2 -2
  110. package/esm/funcs/paymentsListMethods.d.ts.map +1 -0
  111. package/esm/funcs/{paymentsGetMethods.js → paymentsListMethods.js} +2 -2
  112. package/esm/funcs/paymentsListMethods.js.map +1 -0
  113. package/esm/funcs/{paymentsGetPaymentsVerifyVpa.d.ts → paymentsVerifyVpa.d.ts} +2 -2
  114. package/esm/funcs/paymentsVerifyVpa.d.ts.map +1 -0
  115. package/esm/funcs/{paymentsGetPaymentsVerifyVpa.js → paymentsVerifyVpa.js} +2 -2
  116. package/esm/funcs/paymentsVerifyVpa.js.map +1 -0
  117. package/esm/funcs/{catalogProductsGetSimilar.d.ts → productsGetSimilar.d.ts} +2 -2
  118. package/esm/funcs/productsGetSimilar.d.ts.map +1 -0
  119. package/esm/funcs/{catalogProductsGetSimilar.js → productsGetSimilar.js} +2 -2
  120. package/esm/funcs/productsGetSimilar.js.map +1 -0
  121. package/esm/funcs/{catalogProductsGetUpsells.d.ts → productsGetUpsells.d.ts} +2 -2
  122. package/esm/funcs/productsGetUpsells.d.ts.map +1 -0
  123. package/esm/funcs/{catalogProductsGetUpsells.js → productsGetUpsells.js} +2 -2
  124. package/esm/funcs/productsGetUpsells.js.map +1 -0
  125. package/esm/funcs/{catalogProductsList.d.ts → productsList.d.ts} +2 -2
  126. package/esm/funcs/productsList.d.ts.map +1 -0
  127. package/esm/funcs/{catalogProductsList.js → productsList.js} +2 -2
  128. package/esm/funcs/productsList.js.map +1 -0
  129. package/esm/funcs/{juspayPostPaymentsJuspayCreateCustomer.d.ts → productsListCrossSells.d.ts} +4 -5
  130. package/esm/funcs/productsListCrossSells.d.ts.map +1 -0
  131. package/esm/funcs/{catalogProductsGetCrossSells.js → productsListCrossSells.js} +2 -2
  132. package/esm/funcs/productsListCrossSells.js.map +1 -0
  133. package/esm/funcs/{shippingCheckPincodeServiceability.d.ts → shipmentCheckPincodeServiceability.d.ts} +2 -2
  134. package/esm/funcs/{shippingCheckPincodeServiceability.d.ts.map → shipmentCheckPincodeServiceability.d.ts.map} +1 -1
  135. package/esm/funcs/{shippingCheckPincodeServiceability.js → shipmentCheckPincodeServiceability.js} +2 -2
  136. package/esm/funcs/{shippingCheckPincodeServiceability.js.map → shipmentCheckPincodeServiceability.js.map} +1 -1
  137. package/esm/funcs/{authUserDeleteProfileImage.d.ts → userDeleteProfileImage.d.ts} +2 -2
  138. package/esm/funcs/userDeleteProfileImage.d.ts.map +1 -0
  139. package/esm/funcs/{authUserDeleteProfileImage.js → userDeleteProfileImage.js} +2 -2
  140. package/esm/funcs/userDeleteProfileImage.js.map +1 -0
  141. package/esm/funcs/{authUserResetPassword.d.ts → userResetPassword.d.ts} +2 -2
  142. package/esm/funcs/{ordersRefundsList.d.ts.map → userResetPassword.d.ts.map} +1 -1
  143. package/esm/funcs/{authUserResetPassword.js → userResetPassword.js} +2 -2
  144. package/esm/funcs/userResetPassword.js.map +1 -0
  145. package/esm/funcs/{authUserUpdate.d.ts → userUpdate.d.ts} +2 -2
  146. package/esm/funcs/userUpdate.d.ts.map +1 -0
  147. package/esm/funcs/{authUserUpdate.js → userUpdate.js} +2 -2
  148. package/esm/funcs/userUpdate.js.map +1 -0
  149. package/esm/funcs/{userNotificationPreferencesUpdate.d.ts → userUpdateNotificationPreferences.d.ts} +2 -2
  150. package/esm/funcs/{userNotificationPreferencesUpdate.d.ts.map → userUpdateNotificationPreferences.d.ts.map} +1 -1
  151. package/esm/funcs/{userNotificationPreferencesUpdate.js → userUpdateNotificationPreferences.js} +2 -2
  152. package/esm/funcs/{userNotificationPreferencesUpdate.js.map → userUpdateNotificationPreferences.js.map} +1 -1
  153. package/esm/funcs/{authUserUpdateProfileImage.d.ts → userUpdateProfileImage.d.ts} +2 -2
  154. package/esm/funcs/userUpdateProfileImage.d.ts.map +1 -0
  155. package/esm/funcs/{authUserUpdateProfileImage.js → userUpdateProfileImage.js} +2 -2
  156. package/esm/funcs/userUpdateProfileImage.js.map +1 -0
  157. package/esm/funcs/{userNotificationPreferencesCreate.d.ts → usersCreateNotificationPreferences.d.ts} +2 -2
  158. package/esm/funcs/usersCreateNotificationPreferences.d.ts.map +1 -0
  159. package/esm/funcs/{userNotificationPreferencesCreate.js → usersCreateNotificationPreferences.js} +2 -2
  160. package/esm/funcs/usersCreateNotificationPreferences.js.map +1 -0
  161. package/esm/funcs/{authUserGet.d.ts → usersGet.d.ts} +2 -2
  162. package/esm/funcs/usersGet.d.ts.map +1 -0
  163. package/esm/funcs/{authUserGet.js → usersGet.js} +2 -2
  164. package/esm/funcs/usersGet.js.map +1 -0
  165. package/esm/funcs/{authUserGetProfileImage.d.ts → usersGetProfileImage.d.ts} +2 -2
  166. package/esm/funcs/{customersReviewsList.d.ts.map → usersGetProfileImage.d.ts.map} +1 -1
  167. package/esm/funcs/{authUserGetProfileImage.js → usersGetProfileImage.js} +2 -2
  168. package/esm/funcs/{customersReviewsList.js.map → usersGetProfileImage.js.map} +1 -1
  169. package/esm/funcs/{utilsGetCountries.d.ts → utilsCountriesGet.d.ts} +2 -2
  170. package/esm/funcs/{utilsGetCountries.d.ts.map → utilsCountriesGet.d.ts.map} +1 -1
  171. package/esm/funcs/{utilsGetCountries.js → utilsCountriesGet.js} +2 -2
  172. package/esm/funcs/{utilsGetCountries.js.map → utilsCountriesGet.js.map} +1 -1
  173. package/esm/funcs/{wishlistDelete.d.ts → wishlistRemoveItem.d.ts} +2 -2
  174. package/esm/funcs/wishlistRemoveItem.d.ts.map +1 -0
  175. package/esm/funcs/{wishlistDelete.js → wishlistRemoveItem.js} +2 -2
  176. package/esm/funcs/wishlistRemoveItem.js.map +1 -0
  177. package/esm/lib/config.d.ts +2 -2
  178. package/esm/lib/config.js +2 -2
  179. package/esm/sdk/addresses.d.ts +0 -28
  180. package/esm/sdk/addresses.d.ts.map +1 -1
  181. package/esm/sdk/addresses.js +2 -42
  182. package/esm/sdk/addresses.js.map +1 -1
  183. package/esm/sdk/auth.d.ts +10 -0
  184. package/esm/sdk/auth.d.ts.map +1 -1
  185. package/esm/sdk/auth.js +14 -0
  186. package/esm/sdk/auth.js.map +1 -1
  187. package/esm/sdk/authuser.d.ts +12 -0
  188. package/esm/sdk/authuser.d.ts.map +1 -0
  189. package/esm/sdk/authuser.js +18 -0
  190. package/esm/sdk/authuser.js.map +1 -0
  191. package/esm/sdk/cards.d.ts +12 -0
  192. package/esm/sdk/cards.d.ts.map +1 -0
  193. package/esm/sdk/cards.js +18 -0
  194. package/esm/sdk/cards.js.map +1 -0
  195. package/esm/sdk/catalog.d.ts +2 -5
  196. package/esm/sdk/catalog.d.ts.map +1 -1
  197. package/esm/sdk/catalog.js +2 -6
  198. package/esm/sdk/catalog.js.map +1 -1
  199. package/esm/sdk/catalogproductreviews.d.ts +12 -0
  200. package/esm/sdk/catalogproductreviews.d.ts.map +1 -0
  201. package/esm/sdk/catalogproductreviews.js +18 -0
  202. package/esm/sdk/catalogproductreviews.js.map +1 -0
  203. package/esm/sdk/catalogproducts.d.ts +12 -0
  204. package/esm/sdk/catalogproducts.d.ts.map +1 -0
  205. package/esm/sdk/catalogproducts.js +18 -0
  206. package/esm/sdk/catalogproducts.js.map +1 -0
  207. package/esm/sdk/{skus.d.ts → catalogskus.d.ts} +2 -2
  208. package/esm/sdk/catalogskus.d.ts.map +1 -0
  209. package/esm/sdk/{skus.js → catalogskus.js} +2 -2
  210. package/esm/sdk/catalogskus.js.map +1 -0
  211. package/esm/sdk/cestorefrontaddresses.d.ts +26 -0
  212. package/esm/sdk/cestorefrontaddresses.d.ts.map +1 -0
  213. package/esm/sdk/cestorefrontaddresses.js +38 -0
  214. package/esm/sdk/cestorefrontaddresses.js.map +1 -0
  215. package/esm/sdk/cestorefrontproducts.d.ts +10 -0
  216. package/esm/sdk/cestorefrontproducts.d.ts.map +1 -0
  217. package/esm/sdk/cestorefrontproducts.js +15 -0
  218. package/esm/sdk/cestorefrontproducts.js.map +1 -0
  219. package/esm/sdk/cestorefrontuser.d.ts +4 -64
  220. package/esm/sdk/cestorefrontuser.d.ts.map +1 -1
  221. package/esm/sdk/cestorefrontuser.js +6 -92
  222. package/esm/sdk/cestorefrontuser.js.map +1 -1
  223. package/esm/sdk/cestorefrontusers.d.ts +12 -0
  224. package/esm/sdk/cestorefrontusers.d.ts.map +1 -0
  225. package/esm/sdk/cestorefrontusers.js +18 -0
  226. package/esm/sdk/cestorefrontusers.js.map +1 -0
  227. package/esm/sdk/countries.d.ts +12 -0
  228. package/esm/sdk/countries.d.ts.map +1 -0
  229. package/esm/sdk/countries.js +18 -0
  230. package/esm/sdk/countries.js.map +1 -0
  231. package/esm/sdk/customers.d.ts +19 -8
  232. package/esm/sdk/customers.d.ts.map +1 -1
  233. package/esm/sdk/customers.js +31 -15
  234. package/esm/sdk/customers.js.map +1 -1
  235. package/esm/sdk/juspay.d.ts +3 -3
  236. package/esm/sdk/juspay.d.ts.map +1 -1
  237. package/esm/sdk/juspay.js +9 -9
  238. package/esm/sdk/juspay.js.map +1 -1
  239. package/esm/sdk/loyalty.d.ts +0 -7
  240. package/esm/sdk/loyalty.d.ts.map +1 -1
  241. package/esm/sdk/loyalty.js +0 -10
  242. package/esm/sdk/loyalty.js.map +1 -1
  243. package/esm/sdk/loyaltypoints.d.ts +12 -0
  244. package/esm/sdk/loyaltypoints.d.ts.map +1 -0
  245. package/esm/sdk/loyaltypoints.js +18 -0
  246. package/esm/sdk/loyaltypoints.js.map +1 -0
  247. package/esm/sdk/notificationpreferences.d.ts +0 -14
  248. package/esm/sdk/notificationpreferences.d.ts.map +1 -1
  249. package/esm/sdk/notificationpreferences.js +2 -22
  250. package/esm/sdk/notificationpreferences.js.map +1 -1
  251. package/esm/sdk/orders.d.ts +15 -7
  252. package/esm/sdk/orders.d.ts.map +1 -1
  253. package/esm/sdk/orders.js +23 -11
  254. package/esm/sdk/orders.js.map +1 -1
  255. package/esm/sdk/payments.d.ts +6 -10
  256. package/esm/sdk/payments.d.ts.map +1 -1
  257. package/esm/sdk/payments.js +13 -19
  258. package/esm/sdk/payments.js.map +1 -1
  259. package/esm/sdk/products.d.ts +1 -14
  260. package/esm/sdk/products.d.ts.map +1 -1
  261. package/esm/sdk/products.js +9 -27
  262. package/esm/sdk/products.js.map +1 -1
  263. package/esm/sdk/reviews.d.ts +3 -3
  264. package/esm/sdk/reviews.d.ts.map +1 -1
  265. package/esm/sdk/reviews.js +4 -4
  266. package/esm/sdk/reviews.js.map +1 -1
  267. package/esm/sdk/sdk.d.ts +27 -3
  268. package/esm/sdk/sdk.d.ts.map +1 -1
  269. package/esm/sdk/sdk.js +35 -3
  270. package/esm/sdk/sdk.js.map +1 -1
  271. package/esm/sdk/{shipping.d.ts → shipment.d.ts} +2 -2
  272. package/esm/sdk/{shipping.d.ts.map → shipment.d.ts.map} +1 -1
  273. package/esm/sdk/{shipping.js → shipment.js} +4 -4
  274. package/esm/sdk/{shipping.js.map → shipment.js.map} +1 -1
  275. package/esm/sdk/user.d.ts +37 -4
  276. package/esm/sdk/user.d.ts.map +1 -1
  277. package/esm/sdk/user.js +50 -3
  278. package/esm/sdk/user.js.map +1 -1
  279. package/esm/sdk/users.d.ts +26 -0
  280. package/esm/sdk/users.d.ts.map +1 -0
  281. package/esm/sdk/users.js +38 -0
  282. package/esm/sdk/users.js.map +1 -0
  283. package/esm/sdk/utils.d.ts +3 -7
  284. package/esm/sdk/utils.d.ts.map +1 -1
  285. package/esm/sdk/utils.js +3 -9
  286. package/esm/sdk/utils.js.map +1 -1
  287. package/esm/sdk/wishlist.d.ts +1 -1
  288. package/esm/sdk/wishlist.d.ts.map +1 -1
  289. package/esm/sdk/wishlist.js +3 -3
  290. package/esm/sdk/wishlist.js.map +1 -1
  291. package/jsr.json +1 -1
  292. package/package.json +1 -1
  293. package/src/funcs/{customersAddressesGet.ts → addressesGet.ts} +1 -1
  294. package/src/funcs/{authUserLogout.ts → authLogout.ts} +1 -1
  295. package/src/funcs/{authUserDeactivateAccount.ts → authUserDeactivate.ts} +1 -1
  296. package/src/funcs/{userNotificationPreferencesGet.ts → authUserNotificationPreferencesGet.ts} +1 -1
  297. package/src/funcs/{authUserAddProfileImage.ts → authUsersAddProfileImage.ts} +1 -1
  298. package/src/funcs/{catalogProductsReviewsCreate.ts → catalogProductReviewsCreate.ts} +1 -1
  299. package/src/funcs/{customersAddressesAdd.ts → customersAddAddress.ts} +1 -1
  300. package/src/funcs/{customersPostCustomers.ts → customersCreate.ts} +1 -1
  301. package/src/funcs/{customersGetCustomersId.ts → customersGet.ts} +1 -1
  302. package/src/funcs/{customersReviewsList.ts → customersGetReviews.ts} +1 -1
  303. package/src/funcs/{customersPutCustomersId.ts → customersUpdate.ts} +1 -1
  304. package/src/funcs/{juspayPostPaymentsJuspayCreateCustomer.ts → juspayCreateCustomer.ts} +1 -1
  305. package/src/funcs/{juspayPostPaymentsJuspayCreateOrder.ts → juspayCreateOrder.ts} +1 -1
  306. package/src/funcs/{juspayGetPaymentsJuspayCustomer.ts → juspayGetCustomer.ts} +1 -1
  307. package/src/funcs/{customersLoyaltyListActivities.ts → loyaltyPointsListActivities.ts} +1 -1
  308. package/src/funcs/{ordersGetOrdersIdPaymentStatus.ts → ordersGetPaymentStatus.ts} +1 -1
  309. package/src/funcs/{ordersRefundsList.ts → ordersGetRefunds.ts} +1 -1
  310. package/src/funcs/{ordersShipmentsList.ts → ordersGetShipments.ts} +1 -1
  311. package/src/funcs/{paymentsPostPaymentsCards.ts → paymentsAddCard.ts} +1 -1
  312. package/src/funcs/{paymentsGetPaymentsCards.ts → paymentsCardsList.ts} +1 -1
  313. package/src/funcs/{paymentsGetMethods.ts → paymentsListMethods.ts} +1 -1
  314. package/src/funcs/{paymentsGetPaymentsVerifyVpa.ts → paymentsVerifyVpa.ts} +1 -1
  315. package/src/funcs/{catalogProductsGetSimilar.ts → productsGetSimilar.ts} +1 -1
  316. package/src/funcs/{catalogProductsGetUpsells.ts → productsGetUpsells.ts} +1 -1
  317. package/src/funcs/{catalogProductsList.ts → productsList.ts} +1 -1
  318. package/src/funcs/{catalogProductsGetCrossSells.ts → productsListCrossSells.ts} +1 -1
  319. package/src/funcs/{shippingCheckPincodeServiceability.ts → shipmentCheckPincodeServiceability.ts} +1 -1
  320. package/src/funcs/{authUserDeleteProfileImage.ts → userDeleteProfileImage.ts} +1 -1
  321. package/src/funcs/{authUserResetPassword.ts → userResetPassword.ts} +1 -1
  322. package/src/funcs/{authUserUpdate.ts → userUpdate.ts} +1 -1
  323. package/src/funcs/{userNotificationPreferencesUpdate.ts → userUpdateNotificationPreferences.ts} +1 -1
  324. package/src/funcs/{authUserUpdateProfileImage.ts → userUpdateProfileImage.ts} +1 -1
  325. package/src/funcs/{userNotificationPreferencesCreate.ts → usersCreateNotificationPreferences.ts} +1 -1
  326. package/src/funcs/{authUserGet.ts → usersGet.ts} +1 -1
  327. package/src/funcs/{authUserGetProfileImage.ts → usersGetProfileImage.ts} +1 -1
  328. package/src/funcs/{utilsGetCountries.ts → utilsCountriesGet.ts} +1 -1
  329. package/src/funcs/{wishlistDelete.ts → wishlistRemoveItem.ts} +1 -1
  330. package/src/lib/config.ts +2 -2
  331. package/src/sdk/addresses.ts +2 -74
  332. package/src/sdk/auth.ts +22 -0
  333. package/src/sdk/authuser.ts +27 -0
  334. package/src/sdk/{refunds.ts → cards.ts} +7 -7
  335. package/src/sdk/catalog.ts +4 -10
  336. package/src/sdk/catalogproductreviews.ts +27 -0
  337. package/src/sdk/catalogproducts.ts +27 -0
  338. package/src/sdk/{skus.ts → catalogskus.ts} +1 -1
  339. package/src/sdk/cestorefrontaddresses.ts +63 -0
  340. package/src/sdk/cestorefrontproducts.ts +19 -0
  341. package/src/sdk/cestorefrontuser.ts +8 -160
  342. package/src/sdk/cestorefrontusers.ts +27 -0
  343. package/src/sdk/countries.ts +25 -0
  344. package/src/sdk/customers.ts +49 -19
  345. package/src/sdk/juspay.ts +9 -9
  346. package/src/sdk/loyalty.ts +0 -18
  347. package/src/sdk/loyaltypoints.ts +27 -0
  348. package/src/sdk/notificationpreferences.ts +2 -38
  349. package/src/sdk/orders.ts +39 -15
  350. package/src/sdk/payments.ts +15 -27
  351. package/src/sdk/products.ts +9 -39
  352. package/src/sdk/reviews.ts +6 -6
  353. package/src/sdk/sdk.ts +54 -4
  354. package/src/sdk/{shipping.ts → shipment.ts} +3 -3
  355. package/src/sdk/user.ts +90 -6
  356. package/src/sdk/users.ts +63 -0
  357. package/src/sdk/utils.ts +4 -14
  358. package/src/sdk/wishlist.ts +3 -3
  359. package/esm/funcs/authUserAddProfileImage.d.ts.map +0 -1
  360. package/esm/funcs/authUserAddProfileImage.js.map +0 -1
  361. package/esm/funcs/authUserDeactivateAccount.d.ts.map +0 -1
  362. package/esm/funcs/authUserDeactivateAccount.js.map +0 -1
  363. package/esm/funcs/authUserDeleteProfileImage.d.ts.map +0 -1
  364. package/esm/funcs/authUserDeleteProfileImage.js.map +0 -1
  365. package/esm/funcs/authUserGet.d.ts.map +0 -1
  366. package/esm/funcs/authUserGet.js.map +0 -1
  367. package/esm/funcs/authUserGetProfileImage.d.ts.map +0 -1
  368. package/esm/funcs/authUserGetProfileImage.js.map +0 -1
  369. package/esm/funcs/authUserLogout.d.ts.map +0 -1
  370. package/esm/funcs/authUserLogout.js.map +0 -1
  371. package/esm/funcs/authUserResetPassword.d.ts.map +0 -1
  372. package/esm/funcs/authUserResetPassword.js.map +0 -1
  373. package/esm/funcs/authUserUpdate.d.ts.map +0 -1
  374. package/esm/funcs/authUserUpdate.js.map +0 -1
  375. package/esm/funcs/authUserUpdateProfileImage.d.ts.map +0 -1
  376. package/esm/funcs/authUserUpdateProfileImage.js.map +0 -1
  377. package/esm/funcs/catalogProductsGetCrossSells.d.ts.map +0 -1
  378. package/esm/funcs/catalogProductsGetCrossSells.js.map +0 -1
  379. package/esm/funcs/catalogProductsGetSimilar.d.ts.map +0 -1
  380. package/esm/funcs/catalogProductsGetSimilar.js.map +0 -1
  381. package/esm/funcs/catalogProductsGetUpsells.d.ts.map +0 -1
  382. package/esm/funcs/catalogProductsGetUpsells.js.map +0 -1
  383. package/esm/funcs/catalogProductsList.js.map +0 -1
  384. package/esm/funcs/catalogProductsReviewsCreate.d.ts.map +0 -1
  385. package/esm/funcs/catalogProductsReviewsCreate.js.map +0 -1
  386. package/esm/funcs/customersAddressesAdd.d.ts.map +0 -1
  387. package/esm/funcs/customersAddressesAdd.js.map +0 -1
  388. package/esm/funcs/customersAddressesGet.d.ts +0 -16
  389. package/esm/funcs/customersAddressesGet.d.ts.map +0 -1
  390. package/esm/funcs/customersAddressesGet.js.map +0 -1
  391. package/esm/funcs/customersGetCustomersId.d.ts.map +0 -1
  392. package/esm/funcs/customersGetCustomersId.js.map +0 -1
  393. package/esm/funcs/customersLoyaltyListActivities.d.ts.map +0 -1
  394. package/esm/funcs/customersLoyaltyListActivities.js.map +0 -1
  395. package/esm/funcs/customersPostCustomers.d.ts.map +0 -1
  396. package/esm/funcs/customersPostCustomers.js.map +0 -1
  397. package/esm/funcs/customersPutCustomersId.d.ts +0 -16
  398. package/esm/funcs/customersPutCustomersId.d.ts.map +0 -1
  399. package/esm/funcs/customersPutCustomersId.js.map +0 -1
  400. package/esm/funcs/juspayGetPaymentsJuspayCustomer.d.ts.map +0 -1
  401. package/esm/funcs/juspayPostPaymentsJuspayCreateCustomer.d.ts.map +0 -1
  402. package/esm/funcs/juspayPostPaymentsJuspayCreateCustomer.js.map +0 -1
  403. package/esm/funcs/juspayPostPaymentsJuspayCreateOrder.d.ts.map +0 -1
  404. package/esm/funcs/ordersGetOrdersIdPaymentStatus.d.ts +0 -15
  405. package/esm/funcs/ordersGetOrdersIdPaymentStatus.d.ts.map +0 -1
  406. package/esm/funcs/ordersGetOrdersIdPaymentStatus.js.map +0 -1
  407. package/esm/funcs/ordersRefundsList.js.map +0 -1
  408. package/esm/funcs/ordersShipmentsList.d.ts.map +0 -1
  409. package/esm/funcs/ordersShipmentsList.js.map +0 -1
  410. package/esm/funcs/paymentsGetMethods.js.map +0 -1
  411. package/esm/funcs/paymentsGetPaymentsCards.d.ts.map +0 -1
  412. package/esm/funcs/paymentsGetPaymentsCards.js.map +0 -1
  413. package/esm/funcs/paymentsGetPaymentsVerifyVpa.d.ts.map +0 -1
  414. package/esm/funcs/paymentsGetPaymentsVerifyVpa.js.map +0 -1
  415. package/esm/funcs/paymentsPostPaymentsCards.d.ts.map +0 -1
  416. package/esm/funcs/paymentsPostPaymentsCards.js.map +0 -1
  417. package/esm/funcs/userNotificationPreferencesCreate.d.ts.map +0 -1
  418. package/esm/funcs/userNotificationPreferencesCreate.js.map +0 -1
  419. package/esm/funcs/userNotificationPreferencesGet.d.ts.map +0 -1
  420. package/esm/funcs/userNotificationPreferencesGet.js.map +0 -1
  421. package/esm/funcs/wishlistDelete.d.ts.map +0 -1
  422. package/esm/funcs/wishlistDelete.js.map +0 -1
  423. package/esm/sdk/cestorefrontreviews.d.ts +0 -19
  424. package/esm/sdk/cestorefrontreviews.d.ts.map +0 -1
  425. package/esm/sdk/cestorefrontreviews.js +0 -28
  426. package/esm/sdk/cestorefrontreviews.js.map +0 -1
  427. package/esm/sdk/refunds.d.ts +0 -12
  428. package/esm/sdk/refunds.d.ts.map +0 -1
  429. package/esm/sdk/refunds.js +0 -18
  430. package/esm/sdk/refunds.js.map +0 -1
  431. package/esm/sdk/shipments.d.ts +0 -12
  432. package/esm/sdk/shipments.d.ts.map +0 -1
  433. package/esm/sdk/shipments.js +0 -18
  434. package/esm/sdk/shipments.js.map +0 -1
  435. package/esm/sdk/skus.d.ts.map +0 -1
  436. package/esm/sdk/skus.js.map +0 -1
  437. package/src/sdk/cestorefrontreviews.ts +0 -45
  438. package/src/sdk/shipments.ts +0 -27
@@ -5,515 +5,10 @@
5
5
 
6
6
  ### Available Operations
7
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
8
+ * [deactivate](#deactivate) - Deactivate account
15
9
  * [changePassword](#changepassword) - Change password
16
- * [forgotPassword](#forgotpassword) - Forgot password
17
- * [resetPassword](#resetpassword) - Reset password
18
- * [logout](#logout) - Logout user
19
10
 
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 Type | Status Code | Content Type |
93
- | -------------- | -------------- | -------------- |
94
- | errors.CeError | 4XX, 5XX | \*/\* |
95
-
96
- ## update
97
-
98
- 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.
99
-
100
- ### Example Usage
101
-
102
- ```typescript
103
- import { CeStorefront } from "ce-storefront";
104
-
105
- const ceStorefront = new CeStorefront({
106
- authorization: "<YOUR_BEARER_TOKEN_HERE>",
107
- });
108
-
109
- async function run() {
110
- const result = await ceStorefront.auth.user.update({
111
- id: "<id>",
112
- user: {
113
- firstName: "Ruthe",
114
- lastName: "Hegmann",
115
- email: "Lizzie.Wyman@hotmail.com",
116
- phone: "317-934-7640 x784",
117
- countryCode: "KZ",
118
- loginMethods: [
119
- "email",
120
- ],
121
- notificationPreferences: {
122
- transactional: {},
123
- promotional: {},
124
- newsletter: {},
125
- },
126
- },
127
- });
128
-
129
- // Handle the result
130
- console.log(result);
131
- }
132
-
133
- run();
134
- ```
135
-
136
- ### Standalone function
137
-
138
- The standalone function version of this method:
139
-
140
- ```typescript
141
- import { CeStorefrontCore } from "ce-storefront/core.js";
142
- import { authUserUpdate } from "ce-storefront/funcs/authUserUpdate.js";
143
-
144
- // Use `CeStorefrontCore` for best tree-shaking performance.
145
- // You can create one instance of it to use across an application.
146
- const ceStorefront = new CeStorefrontCore({
147
- authorization: "<YOUR_BEARER_TOKEN_HERE>",
148
- });
149
-
150
- async function run() {
151
- const res = await authUserUpdate(ceStorefront, {
152
- id: "<id>",
153
- user: {
154
- firstName: "Zelma",
155
- lastName: "Huel",
156
- email: "Houston_OHara69@gmail.com",
157
- phone: "1-321-461-2304 x0484",
158
- countryCode: "PE",
159
- loginMethods: [
160
- "whatsapp",
161
- ],
162
- notificationPreferences: {
163
- transactional: {},
164
- promotional: {},
165
- newsletter: {},
166
- },
167
- },
168
- });
169
-
170
- if (!res.ok) {
171
- throw res.error;
172
- }
173
-
174
- const { value: result } = res;
175
-
176
- // Handle the result
177
- console.log(result);
178
- }
179
-
180
- run();
181
- ```
182
-
183
- ### Parameters
184
-
185
- | Parameter | Type | Required | Description |
186
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
187
- | `request` | [operations.PutAuthUserIdRequest](../../models/operations/putauthuseridrequest.md) | :heavy_check_mark: | The request object to use for the request. |
188
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
189
- | `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. |
190
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
191
-
192
- ### Response
193
-
194
- **Promise\<[operations.PutAuthUserIdResponseBody](../../models/operations/putauthuseridresponsebody.md)\>**
195
-
196
- ### Errors
197
-
198
- | Error Type | Status Code | Content Type |
199
- | -------------- | -------------- | -------------- |
200
- | errors.CeError | 4XX, 5XX | \*/\* |
201
-
202
- ## addProfileImage
203
-
204
- 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.
205
-
206
- ### Example Usage
207
-
208
- ```typescript
209
- import { CeStorefront } from "ce-storefront";
210
- import { openAsBlob } from "node:fs";
211
-
212
- const ceStorefront = new CeStorefront({
213
- authorization: "<YOUR_BEARER_TOKEN_HERE>",
214
- });
215
-
216
- async function run() {
217
- const result = await ceStorefront.auth.user.addProfileImage({
218
- id: "<id>",
219
- requestBody: {
220
- image: await openAsBlob("example.file"),
221
- },
222
- });
223
-
224
- // Handle the result
225
- console.log(result);
226
- }
227
-
228
- run();
229
- ```
230
-
231
- ### Standalone function
232
-
233
- The standalone function version of this method:
234
-
235
- ```typescript
236
- import { CeStorefrontCore } from "ce-storefront/core.js";
237
- import { authUserAddProfileImage } from "ce-storefront/funcs/authUserAddProfileImage.js";
238
- import { openAsBlob } from "node:fs";
239
-
240
- // Use `CeStorefrontCore` for best tree-shaking performance.
241
- // You can create one instance of it to use across an application.
242
- const ceStorefront = new CeStorefrontCore({
243
- authorization: "<YOUR_BEARER_TOKEN_HERE>",
244
- });
245
-
246
- async function run() {
247
- const res = await authUserAddProfileImage(ceStorefront, {
248
- id: "<id>",
249
- requestBody: {
250
- image: await openAsBlob("example.file"),
251
- },
252
- });
253
-
254
- if (!res.ok) {
255
- throw res.error;
256
- }
257
-
258
- const { value: result } = res;
259
-
260
- // Handle the result
261
- console.log(result);
262
- }
263
-
264
- run();
265
- ```
266
-
267
- ### Parameters
268
-
269
- | Parameter | Type | Required | Description |
270
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
271
- | `request` | [operations.PostAuthUserIdProfileImageRequest](../../models/operations/postauthuseridprofileimagerequest.md) | :heavy_check_mark: | The request object to use for the request. |
272
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
273
- | `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. |
274
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
275
-
276
- ### Response
277
-
278
- **Promise\<[operations.PostAuthUserIdProfileImageResponseBody](../../models/operations/postauthuseridprofileimageresponsebody.md)\>**
279
-
280
- ### Errors
281
-
282
- | Error Type | Status Code | Content Type |
283
- | -------------- | -------------- | -------------- |
284
- | errors.CeError | 4XX, 5XX | \*/\* |
285
-
286
- ## updateProfileImage
287
-
288
- 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.
289
-
290
- ### Example Usage
291
-
292
- ```typescript
293
- import { CeStorefront } from "ce-storefront";
294
-
295
- const ceStorefront = new CeStorefront({
296
- authorization: "<YOUR_BEARER_TOKEN_HERE>",
297
- });
298
-
299
- async function run() {
300
- const result = await ceStorefront.auth.user.updateProfileImage({
301
- id: "<id>",
302
- requestBody: {},
303
- });
304
-
305
- // Handle the result
306
- console.log(result);
307
- }
308
-
309
- run();
310
- ```
311
-
312
- ### Standalone function
313
-
314
- The standalone function version of this method:
315
-
316
- ```typescript
317
- import { CeStorefrontCore } from "ce-storefront/core.js";
318
- import { authUserUpdateProfileImage } from "ce-storefront/funcs/authUserUpdateProfileImage.js";
319
-
320
- // Use `CeStorefrontCore` for best tree-shaking performance.
321
- // You can create one instance of it to use across an application.
322
- const ceStorefront = new CeStorefrontCore({
323
- authorization: "<YOUR_BEARER_TOKEN_HERE>",
324
- });
325
-
326
- async function run() {
327
- const res = await authUserUpdateProfileImage(ceStorefront, {
328
- id: "<id>",
329
- requestBody: {},
330
- });
331
-
332
- if (!res.ok) {
333
- throw res.error;
334
- }
335
-
336
- const { value: result } = res;
337
-
338
- // Handle the result
339
- console.log(result);
340
- }
341
-
342
- run();
343
- ```
344
-
345
- ### Parameters
346
-
347
- | Parameter | Type | Required | Description |
348
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
349
- | `request` | [operations.PutAuthUserIdProfileImageRequest](../../models/operations/putauthuseridprofileimagerequest.md) | :heavy_check_mark: | The request object to use for the request. |
350
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
351
- | `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. |
352
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
353
-
354
- ### Response
355
-
356
- **Promise\<[operations.PutAuthUserIdProfileImageResponseBody](../../models/operations/putauthuseridprofileimageresponsebody.md)\>**
357
-
358
- ### Errors
359
-
360
- | Error Type | Status Code | Content Type |
361
- | -------------- | -------------- | -------------- |
362
- | errors.CeError | 4XX, 5XX | \*/\* |
363
-
364
- ## deleteProfileImage
365
-
366
- 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.
367
-
368
- ### Example Usage
369
-
370
- ```typescript
371
- import { CeStorefront } from "ce-storefront";
372
-
373
- const ceStorefront = new CeStorefront({
374
- authorization: "<YOUR_BEARER_TOKEN_HERE>",
375
- });
376
-
377
- async function run() {
378
- const result = await ceStorefront.auth.user.deleteProfileImage({
379
- id: "<id>",
380
- });
381
-
382
- // Handle the result
383
- console.log(result);
384
- }
385
-
386
- run();
387
- ```
388
-
389
- ### Standalone function
390
-
391
- The standalone function version of this method:
392
-
393
- ```typescript
394
- import { CeStorefrontCore } from "ce-storefront/core.js";
395
- import { authUserDeleteProfileImage } from "ce-storefront/funcs/authUserDeleteProfileImage.js";
396
-
397
- // Use `CeStorefrontCore` for best tree-shaking performance.
398
- // You can create one instance of it to use across an application.
399
- const ceStorefront = new CeStorefrontCore({
400
- authorization: "<YOUR_BEARER_TOKEN_HERE>",
401
- });
402
-
403
- async function run() {
404
- const res = await authUserDeleteProfileImage(ceStorefront, {
405
- id: "<id>",
406
- });
407
-
408
- if (!res.ok) {
409
- throw res.error;
410
- }
411
-
412
- const { value: result } = res;
413
-
414
- // Handle the result
415
- console.log(result);
416
- }
417
-
418
- run();
419
- ```
420
-
421
- ### Parameters
422
-
423
- | Parameter | Type | Required | Description |
424
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
425
- | `request` | [operations.DeleteAuthUserIdProfileImageRequest](../../models/operations/deleteauthuseridprofileimagerequest.md) | :heavy_check_mark: | The request object to use for the request. |
426
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
427
- | `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. |
428
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
429
-
430
- ### Response
431
-
432
- **Promise\<[operations.DeleteAuthUserIdProfileImageResponseBody](../../models/operations/deleteauthuseridprofileimageresponsebody.md)\>**
433
-
434
- ### Errors
435
-
436
- | Error Type | Status Code | Content Type |
437
- | -------------- | -------------- | -------------- |
438
- | errors.CeError | 4XX, 5XX | \*/\* |
439
-
440
- ## getProfileImage
441
-
442
- 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.
443
-
444
- ### Example Usage
445
-
446
- ```typescript
447
- import { CeStorefront } from "ce-storefront";
448
-
449
- const ceStorefront = new CeStorefront({
450
- authorization: "<YOUR_BEARER_TOKEN_HERE>",
451
- });
452
-
453
- async function run() {
454
- const result = await ceStorefront.auth.user.getProfileImage({
455
- id: "<id>",
456
- });
457
-
458
- // Handle the result
459
- console.log(result);
460
- }
461
-
462
- run();
463
- ```
464
-
465
- ### Standalone function
466
-
467
- The standalone function version of this method:
468
-
469
- ```typescript
470
- import { CeStorefrontCore } from "ce-storefront/core.js";
471
- import { authUserGetProfileImage } from "ce-storefront/funcs/authUserGetProfileImage.js";
472
-
473
- // Use `CeStorefrontCore` for best tree-shaking performance.
474
- // You can create one instance of it to use across an application.
475
- const ceStorefront = new CeStorefrontCore({
476
- authorization: "<YOUR_BEARER_TOKEN_HERE>",
477
- });
478
-
479
- async function run() {
480
- const res = await authUserGetProfileImage(ceStorefront, {
481
- id: "<id>",
482
- });
483
-
484
- if (!res.ok) {
485
- throw res.error;
486
- }
487
-
488
- const { value: result } = res;
489
-
490
- // Handle the result
491
- console.log(result);
492
- }
493
-
494
- run();
495
- ```
496
-
497
- ### Parameters
498
-
499
- | Parameter | Type | Required | Description |
500
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
501
- | `request` | [operations.GetAuthUserIdProfileImageRequest](../../models/operations/getauthuseridprofileimagerequest.md) | :heavy_check_mark: | The request object to use for the request. |
502
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
503
- | `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. |
504
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
505
-
506
- ### Response
507
-
508
- **Promise\<[operations.GetAuthUserIdProfileImageResponseBody](../../models/operations/getauthuseridprofileimageresponsebody.md)\>**
509
-
510
- ### Errors
511
-
512
- | Error Type | Status Code | Content Type |
513
- | -------------- | -------------- | -------------- |
514
- | errors.CeError | 4XX, 5XX | \*/\* |
515
-
516
- ## deactivateAccount
11
+ ## deactivate
517
12
 
518
13
  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.
519
14
 
@@ -527,7 +22,7 @@ const ceStorefront = new CeStorefront({
527
22
  });
528
23
 
529
24
  async function run() {
530
- const result = await ceStorefront.auth.user.deactivateAccount({
25
+ const result = await ceStorefront.auth.user.deactivate({
531
26
  id: "<id>",
532
27
  });
533
28
 
@@ -544,7 +39,7 @@ The standalone function version of this method:
544
39
 
545
40
  ```typescript
546
41
  import { CeStorefrontCore } from "ce-storefront/core.js";
547
- import { authUserDeactivateAccount } from "ce-storefront/funcs/authUserDeactivateAccount.js";
42
+ import { authUserDeactivate } from "ce-storefront/funcs/authUserDeactivate.js";
548
43
 
549
44
  // Use `CeStorefrontCore` for best tree-shaking performance.
550
45
  // You can create one instance of it to use across an application.
@@ -553,7 +48,7 @@ const ceStorefront = new CeStorefrontCore({
553
48
  });
554
49
 
555
50
  async function run() {
556
- const res = await authUserDeactivateAccount(ceStorefront, {
51
+ const res = await authUserDeactivate(ceStorefront, {
557
52
  id: "<id>",
558
53
  });
559
54
 
@@ -669,228 +164,4 @@ run();
669
164
  | ------------------- | ------------------- | ------------------- |
670
165
  | errors.BadRequest | 400 | application/json |
671
166
  | errors.Unauthorized | 401 | application/json |
672
- | errors.CeError | 4XX, 5XX | \*/\* |
673
-
674
- ## forgotPassword
675
-
676
- 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.
677
-
678
- ### Example Usage
679
-
680
- ```typescript
681
- import { CeStorefront } from "ce-storefront";
682
-
683
- const ceStorefront = new CeStorefront({
684
- authorization: "<YOUR_BEARER_TOKEN_HERE>",
685
- });
686
-
687
- async function run() {
688
- const result = await ceStorefront.auth.user.forgotPassword({});
689
-
690
- // Handle the result
691
- console.log(result);
692
- }
693
-
694
- run();
695
- ```
696
-
697
- ### Standalone function
698
-
699
- The standalone function version of this method:
700
-
701
- ```typescript
702
- import { CeStorefrontCore } from "ce-storefront/core.js";
703
- import { authUserForgotPassword } from "ce-storefront/funcs/authUserForgotPassword.js";
704
-
705
- // Use `CeStorefrontCore` for best tree-shaking performance.
706
- // You can create one instance of it to use across an application.
707
- const ceStorefront = new CeStorefrontCore({
708
- authorization: "<YOUR_BEARER_TOKEN_HERE>",
709
- });
710
-
711
- async function run() {
712
- const res = await authUserForgotPassword(ceStorefront, {});
713
-
714
- if (!res.ok) {
715
- throw res.error;
716
- }
717
-
718
- const { value: result } = res;
719
-
720
- // Handle the result
721
- console.log(result);
722
- }
723
-
724
- run();
725
- ```
726
-
727
- ### Parameters
728
-
729
- | Parameter | Type | Required | Description |
730
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
731
- | `request` | [operations.PostAuthForgotPasswordRequestBody](../../models/operations/postauthforgotpasswordrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
732
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
733
- | `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. |
734
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
735
-
736
- ### Response
737
-
738
- **Promise\<[operations.PostAuthForgotPasswordResponseBody](../../models/operations/postauthforgotpasswordresponsebody.md)\>**
739
-
740
- ### Errors
741
-
742
- | Error Type | Status Code | Content Type |
743
- | -------------- | -------------- | -------------- |
744
- | errors.CeError | 4XX, 5XX | \*/\* |
745
-
746
- ## resetPassword
747
-
748
- Reset password
749
-
750
- ### Example Usage
751
-
752
- ```typescript
753
- import { CeStorefront } from "ce-storefront";
754
-
755
- const ceStorefront = new CeStorefront({
756
- authorization: "<YOUR_BEARER_TOKEN_HERE>",
757
- });
758
-
759
- async function run() {
760
- const result = await ceStorefront.auth.user.resetPassword({
761
- newPassword: "<value>",
762
- confirmPassword: "<value>",
763
- otpToken: "<value>",
764
- });
765
-
766
- // Handle the result
767
- console.log(result);
768
- }
769
-
770
- run();
771
- ```
772
-
773
- ### Standalone function
774
-
775
- The standalone function version of this method:
776
-
777
- ```typescript
778
- import { CeStorefrontCore } from "ce-storefront/core.js";
779
- import { authUserResetPassword } from "ce-storefront/funcs/authUserResetPassword.js";
780
-
781
- // Use `CeStorefrontCore` for best tree-shaking performance.
782
- // You can create one instance of it to use across an application.
783
- const ceStorefront = new CeStorefrontCore({
784
- authorization: "<YOUR_BEARER_TOKEN_HERE>",
785
- });
786
-
787
- async function run() {
788
- const res = await authUserResetPassword(ceStorefront, {
789
- newPassword: "<value>",
790
- confirmPassword: "<value>",
791
- otpToken: "<value>",
792
- });
793
-
794
- if (!res.ok) {
795
- throw res.error;
796
- }
797
-
798
- const { value: result } = res;
799
-
800
- // Handle the result
801
- console.log(result);
802
- }
803
-
804
- run();
805
- ```
806
-
807
- ### Parameters
808
-
809
- | Parameter | Type | Required | Description |
810
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
811
- | `request` | [operations.PostAuthResetPasswordRequestBody](../../models/operations/postauthresetpasswordrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
812
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
813
- | `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. |
814
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
815
-
816
- ### Response
817
-
818
- **Promise\<[operations.PostAuthResetPasswordResponseBody](../../models/operations/postauthresetpasswordresponsebody.md)\>**
819
-
820
- ### Errors
821
-
822
- | Error Type | Status Code | Content Type |
823
- | ----------------- | ----------------- | ----------------- |
824
- | errors.BadRequest | 400 | application/json |
825
- | errors.CeError | 4XX, 5XX | \*/\* |
826
-
827
- ## logout
828
-
829
- 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.
830
-
831
- ### Example Usage
832
-
833
- ```typescript
834
- import { CeStorefront } from "ce-storefront";
835
-
836
- const ceStorefront = new CeStorefront({
837
- authorization: "<YOUR_BEARER_TOKEN_HERE>",
838
- });
839
-
840
- async function run() {
841
- const result = await ceStorefront.auth.user.logout();
842
-
843
- // Handle the result
844
- console.log(result);
845
- }
846
-
847
- run();
848
- ```
849
-
850
- ### Standalone function
851
-
852
- The standalone function version of this method:
853
-
854
- ```typescript
855
- import { CeStorefrontCore } from "ce-storefront/core.js";
856
- import { authUserLogout } from "ce-storefront/funcs/authUserLogout.js";
857
-
858
- // Use `CeStorefrontCore` for best tree-shaking performance.
859
- // You can create one instance of it to use across an application.
860
- const ceStorefront = new CeStorefrontCore({
861
- authorization: "<YOUR_BEARER_TOKEN_HERE>",
862
- });
863
-
864
- async function run() {
865
- const res = await authUserLogout(ceStorefront);
866
-
867
- if (!res.ok) {
868
- throw res.error;
869
- }
870
-
871
- const { value: result } = res;
872
-
873
- // Handle the result
874
- console.log(result);
875
- }
876
-
877
- run();
878
- ```
879
-
880
- ### Parameters
881
-
882
- | Parameter | Type | Required | Description |
883
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
884
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
885
- | `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. |
886
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
887
-
888
- ### Response
889
-
890
- **Promise\<[operations.PostAuthLogoutResponseBody](../../models/operations/postauthlogoutresponsebody.md)\>**
891
-
892
- ### Errors
893
-
894
- | Error Type | Status Code | Content Type |
895
- | -------------- | -------------- | -------------- |
896
- | errors.CeError | 4XX, 5XX | \*/\* |
167
+ | errors.CeError | 4XX, 5XX | \*/\* |