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