ce-storefront 0.0.1 → 0.0.4

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 (415) hide show
  1. package/.devcontainer/README.md +5 -0
  2. package/README.md +101 -117
  3. package/docs/sdks/addresses/README.md +78 -0
  4. package/docs/sdks/analytics/README.md +5 -5
  5. package/docs/sdks/auth/README.md +91 -24
  6. package/docs/sdks/campaigns/README.md +1 -79
  7. package/docs/sdks/cestorefrontuser/README.md +850 -0
  8. package/docs/sdks/{common → coupons}/README.md +9 -9
  9. package/docs/sdks/customers/README.md +1 -83
  10. package/docs/sdks/{upsell → customersapi}/README.md +16 -10
  11. package/docs/sdks/{otp → newsletter}/README.md +10 -10
  12. package/docs/sdks/{returns → notificationpreferences}/README.md +35 -39
  13. package/docs/sdks/offers/README.md +1 -152
  14. package/docs/sdks/orders/README.md +0 -73
  15. package/docs/sdks/products/README.md +228 -0
  16. package/docs/sdks/{recommended → promotions}/README.md +8 -9
  17. package/docs/sdks/reviews/README.md +5 -5
  18. package/docs/sdks/shipping/README.md +5 -5
  19. package/docs/sdks/user/README.md +1 -927
  20. package/docs/sdks/{countries → utils}/README.md +81 -8
  21. package/funcs/{analyticsTrackEvent.d.ts → analyticsTrack.d.ts} +2 -2
  22. package/funcs/analyticsTrack.d.ts.map +1 -0
  23. package/funcs/{analyticsTrackEvent.js → analyticsTrack.js} +3 -3
  24. package/funcs/analyticsTrack.js.map +1 -0
  25. package/funcs/{authOtpGenerate.d.ts → authGenerateOtp.d.ts} +2 -2
  26. package/funcs/{authOtpGenerate.d.ts.map → authGenerateOtp.d.ts.map} +1 -1
  27. package/funcs/{authOtpGenerate.js → authGenerateOtp.js} +3 -3
  28. package/funcs/{authOtpGenerate.js.map → authGenerateOtp.js.map} +1 -1
  29. package/funcs/authLoginAnonymously.d.ts +16 -0
  30. package/funcs/authLoginAnonymously.d.ts.map +1 -0
  31. package/funcs/{ordersGetReturns.js → authLoginAnonymously.js} +21 -13
  32. package/funcs/authLoginAnonymously.js.map +1 -0
  33. package/funcs/{authTokenRefresh.d.ts → authRefreshToken.d.ts} +2 -2
  34. package/funcs/{authTokenRefresh.d.ts.map → authRefreshToken.d.ts.map} +1 -1
  35. package/funcs/{authTokenRefresh.js → authRefreshToken.js} +3 -3
  36. package/funcs/{authTokenRefresh.js.map → authRefreshToken.js.map} +1 -1
  37. package/funcs/{authGetUser.d.ts → authUserGet.d.ts} +2 -2
  38. package/funcs/{authGetUser.d.ts.map → authUserGet.d.ts.map} +1 -1
  39. package/funcs/{authGetUser.js → authUserGet.js} +3 -3
  40. package/funcs/{authGetUser.js.map → authUserGet.js.map} +1 -1
  41. package/funcs/{authUpdateUser.d.ts → authUserUpdate.d.ts} +2 -2
  42. package/funcs/{authUpdateUser.d.ts.map → authUserUpdate.d.ts.map} +1 -1
  43. package/funcs/{authUpdateUser.js → authUserUpdate.js} +3 -3
  44. package/funcs/{authUpdateUser.js.map → authUserUpdate.js.map} +1 -1
  45. package/funcs/{campaignsSubscribeNewsletter.d.ts → campaignsNewsletterSubscribe.d.ts} +2 -2
  46. package/funcs/{campaignsSubscribeNewsletter.d.ts.map → campaignsNewsletterSubscribe.d.ts.map} +1 -1
  47. package/funcs/{campaignsSubscribeNewsletter.js → campaignsNewsletterSubscribe.js} +3 -3
  48. package/funcs/{campaignsSubscribeNewsletter.js.map → campaignsNewsletterSubscribe.js.map} +1 -1
  49. package/funcs/{catalogProductsCrossSellList.d.ts → catalogProductsGetCrossSells.d.ts} +2 -2
  50. package/funcs/{catalogProductsCrossSellList.d.ts.map → catalogProductsGetCrossSells.d.ts.map} +1 -1
  51. package/funcs/{catalogProductsCrossSellList.js → catalogProductsGetCrossSells.js} +3 -3
  52. package/funcs/{catalogProductsCrossSellList.js.map → catalogProductsGetCrossSells.js.map} +1 -1
  53. package/funcs/{catalogProductsSimilarList.d.ts → catalogProductsGetSimilar.d.ts} +2 -2
  54. package/funcs/catalogProductsGetSimilar.d.ts.map +1 -0
  55. package/funcs/{catalogProductsSimilarList.js → catalogProductsGetSimilar.js} +3 -3
  56. package/funcs/catalogProductsGetSimilar.js.map +1 -0
  57. package/funcs/{catalogProductsUpSellList.d.ts → catalogProductsGetUpsells.d.ts} +2 -2
  58. package/funcs/{catalogProductsUpSellList.d.ts.map → catalogProductsGetUpsells.d.ts.map} +1 -1
  59. package/funcs/{catalogProductsUpSellList.js → catalogProductsGetUpsells.js} +3 -3
  60. package/funcs/{catalogProductsUpSellList.js.map → catalogProductsGetUpsells.js.map} +1 -1
  61. package/funcs/{catalogProductsRecommendedList.d.ts → customersAPIGetRecommendedProducts.d.ts} +3 -3
  62. package/funcs/customersAPIGetRecommendedProducts.d.ts.map +1 -0
  63. package/funcs/customersAPIGetRecommendedProducts.js +97 -0
  64. package/funcs/customersAPIGetRecommendedProducts.js.map +1 -0
  65. package/funcs/{commonCountriesGetPincodes.d.ts → customersAddressesList.d.ts} +4 -4
  66. package/funcs/customersAddressesList.d.ts.map +1 -0
  67. package/funcs/{customersGetAddresses.js → customersAddressesList.js} +3 -3
  68. package/funcs/customersAddressesList.js.map +1 -0
  69. package/funcs/{customersReviewsGetAll.d.ts → customersReviewsList.d.ts} +2 -2
  70. package/funcs/customersReviewsList.d.ts.map +1 -0
  71. package/funcs/{customersReviewsGetAll.js → customersReviewsList.js} +3 -3
  72. package/funcs/customersReviewsList.js.map +1 -0
  73. package/funcs/{offersGetCoupons.d.ts → offersCouponsList.d.ts} +2 -2
  74. package/funcs/offersCouponsList.d.ts.map +1 -0
  75. package/funcs/{offersGetCoupons.js → offersCouponsList.js} +3 -3
  76. package/funcs/{ordersGetReturns.js.map → offersCouponsList.js.map} +1 -1
  77. package/funcs/{offersGetPromotions.d.ts → offersPromotionsList.d.ts} +2 -2
  78. package/funcs/offersPromotionsList.d.ts.map +1 -0
  79. package/funcs/{offersGetPromotions.js → offersPromotionsList.js} +3 -3
  80. package/funcs/offersPromotionsList.js.map +1 -0
  81. package/funcs/{shippingGetPincodeServiceability.d.ts → shippingCheckPincodeServiceability.d.ts} +2 -2
  82. package/funcs/shippingCheckPincodeServiceability.d.ts.map +1 -0
  83. package/funcs/{shippingGetPincodeServiceability.js → shippingCheckPincodeServiceability.js} +3 -3
  84. package/funcs/shippingCheckPincodeServiceability.js.map +1 -0
  85. package/funcs/{authUserCreateNotificationPreferences.d.ts → userNotificationPreferencesCreate.d.ts} +2 -2
  86. package/funcs/userNotificationPreferencesCreate.d.ts.map +1 -0
  87. package/funcs/{authUserCreateNotificationPreferences.js → userNotificationPreferencesCreate.js} +3 -3
  88. package/funcs/userNotificationPreferencesCreate.js.map +1 -0
  89. package/funcs/{authUserGetNotificationPreferences.d.ts → userNotificationPreferencesGet.d.ts} +2 -2
  90. package/funcs/userNotificationPreferencesGet.d.ts.map +1 -0
  91. package/funcs/{authUserGetNotificationPreferences.js → userNotificationPreferencesGet.js} +3 -3
  92. package/funcs/userNotificationPreferencesGet.js.map +1 -0
  93. package/funcs/{authUserUpdateNotificationPreferences.d.ts → userNotificationPreferencesUpdate.d.ts} +2 -2
  94. package/funcs/userNotificationPreferencesUpdate.d.ts.map +1 -0
  95. package/funcs/{authUserUpdateNotificationPreferences.js → userNotificationPreferencesUpdate.js} +3 -3
  96. package/funcs/userNotificationPreferencesUpdate.js.map +1 -0
  97. package/funcs/{commonGetCountries.d.ts → utilsGetCountries.d.ts} +2 -2
  98. package/funcs/utilsGetCountries.d.ts.map +1 -0
  99. package/funcs/{commonGetCountries.js → utilsGetCountries.js} +3 -3
  100. package/funcs/utilsGetCountries.js.map +1 -0
  101. package/funcs/{customersGetAddresses.d.ts → utilsGetPincodes.d.ts} +4 -4
  102. package/funcs/utilsGetPincodes.d.ts.map +1 -0
  103. package/funcs/{commonCountriesGetPincodes.js → utilsGetPincodes.js} +3 -3
  104. package/funcs/utilsGetPincodes.js.map +1 -0
  105. package/funcs/{commonCountriesGetStates.d.ts → utilsGetStates.d.ts} +2 -2
  106. package/funcs/utilsGetStates.d.ts.map +1 -0
  107. package/funcs/{commonCountriesGetStates.js → utilsGetStates.js} +3 -3
  108. package/funcs/utilsGetStates.js.map +1 -0
  109. package/lib/config.d.ts +4 -4
  110. package/lib/config.d.ts.map +1 -1
  111. package/lib/config.js +3 -8
  112. package/lib/config.js.map +1 -1
  113. package/models/components/cartitem.js +4 -4
  114. package/models/components/cartitem.js.map +1 -1
  115. package/models/components/index.d.ts +1 -3
  116. package/models/components/index.d.ts.map +1 -1
  117. package/models/components/index.js +1 -3
  118. package/models/components/index.js.map +1 -1
  119. package/models/components/productattribute.js +1 -1
  120. package/models/components/productattribute.js.map +1 -1
  121. package/models/components/productdetail.js +5 -5
  122. package/models/components/productdetail.js.map +1 -1
  123. package/models/components/productlist.js +5 -5
  124. package/models/components/productlist.js.map +1 -1
  125. package/models/components/productreview.js +1 -1
  126. package/models/components/productreview.js.map +1 -1
  127. package/models/components/productshipping.js +2 -2
  128. package/models/components/productshipping.js.map +1 -1
  129. package/models/components/productsubscription.js +1 -1
  130. package/models/components/productsubscription.js.map +1 -1
  131. package/models/components/recommendedproduct.d.ts +149 -0
  132. package/models/components/recommendedproduct.d.ts.map +1 -0
  133. package/models/components/recommendedproduct.js +230 -0
  134. package/models/components/recommendedproduct.js.map +1 -0
  135. package/models/components/skuinfo.js +4 -4
  136. package/models/components/skuinfo.js.map +1 -1
  137. package/models/errors/unauthorized.js +1 -1
  138. package/models/errors/unauthorized.js.map +1 -1
  139. package/models/operations/getrecommendedproducts.d.ts +82 -0
  140. package/models/operations/getrecommendedproducts.d.ts.map +1 -0
  141. package/models/operations/getrecommendedproducts.js +93 -0
  142. package/models/operations/getrecommendedproducts.js.map +1 -0
  143. package/models/operations/index.d.ts +2 -5
  144. package/models/operations/index.d.ts.map +1 -1
  145. package/models/operations/index.js +2 -5
  146. package/models/operations/index.js.map +1 -1
  147. package/models/operations/postauthanonymous.d.ts +101 -0
  148. package/models/operations/postauthanonymous.d.ts.map +1 -0
  149. package/models/operations/postauthanonymous.js +124 -0
  150. package/models/operations/postauthanonymous.js.map +1 -0
  151. package/models/operations/postcartitemid.js +1 -1
  152. package/models/operations/postcartitemid.js.map +1 -1
  153. package/package.json +5 -1
  154. package/sdk/addresses.d.ts +7 -0
  155. package/sdk/addresses.d.ts.map +1 -1
  156. package/sdk/addresses.js +10 -0
  157. package/sdk/addresses.js.map +1 -1
  158. package/sdk/analytics.d.ts +1 -1
  159. package/sdk/analytics.d.ts.map +1 -1
  160. package/sdk/analytics.js +3 -3
  161. package/sdk/analytics.js.map +1 -1
  162. package/sdk/auth.d.ts +16 -14
  163. package/sdk/auth.d.ts.map +1 -1
  164. package/sdk/auth.js +22 -21
  165. package/sdk/auth.js.map +1 -1
  166. package/sdk/campaigns.d.ts +4 -9
  167. package/sdk/campaigns.d.ts.map +1 -1
  168. package/sdk/campaigns.js +4 -10
  169. package/sdk/campaigns.js.map +1 -1
  170. package/sdk/cestorefrontuser.d.ts +82 -0
  171. package/sdk/cestorefrontuser.d.ts.map +1 -0
  172. package/sdk/cestorefrontuser.js +122 -0
  173. package/sdk/cestorefrontuser.js.map +1 -0
  174. package/sdk/coupons.d.ts +12 -0
  175. package/sdk/coupons.d.ts.map +1 -0
  176. package/sdk/coupons.js +22 -0
  177. package/sdk/coupons.js.map +1 -0
  178. package/sdk/customers.d.ts +1 -9
  179. package/sdk/customers.d.ts.map +1 -1
  180. package/sdk/customers.js +0 -11
  181. package/sdk/customers.js.map +1 -1
  182. package/sdk/{recommended.d.ts → customersapi.d.ts} +4 -4
  183. package/sdk/customersapi.d.ts.map +1 -0
  184. package/sdk/{recommended.js → customersapi.js} +8 -8
  185. package/sdk/customersapi.js.map +1 -0
  186. package/sdk/newsletter.d.ts +12 -0
  187. package/sdk/newsletter.d.ts.map +1 -0
  188. package/sdk/newsletter.js +22 -0
  189. package/sdk/newsletter.js.map +1 -0
  190. package/sdk/notificationpreferences.d.ts +26 -0
  191. package/sdk/notificationpreferences.d.ts.map +1 -0
  192. package/sdk/notificationpreferences.js +42 -0
  193. package/sdk/notificationpreferences.js.map +1 -0
  194. package/sdk/offers.d.ts +7 -16
  195. package/sdk/offers.d.ts.map +1 -1
  196. package/sdk/offers.js +8 -19
  197. package/sdk/offers.js.map +1 -1
  198. package/sdk/orders.d.ts +0 -10
  199. package/sdk/orders.d.ts.map +1 -1
  200. package/sdk/orders.js +0 -15
  201. package/sdk/orders.js.map +1 -1
  202. package/sdk/products.d.ts +21 -12
  203. package/sdk/products.d.ts.map +1 -1
  204. package/sdk/products.js +30 -20
  205. package/sdk/products.js.map +1 -1
  206. package/sdk/promotions.d.ts +12 -0
  207. package/sdk/promotions.d.ts.map +1 -0
  208. package/sdk/promotions.js +22 -0
  209. package/sdk/promotions.js.map +1 -0
  210. package/sdk/reviews.d.ts +1 -1
  211. package/sdk/reviews.d.ts.map +1 -1
  212. package/sdk/reviews.js +3 -3
  213. package/sdk/reviews.js.map +1 -1
  214. package/sdk/sdk.d.ts +9 -3
  215. package/sdk/sdk.d.ts.map +1 -1
  216. package/sdk/sdk.js +13 -3
  217. package/sdk/sdk.js.map +1 -1
  218. package/sdk/shipping.d.ts +1 -1
  219. package/sdk/shipping.d.ts.map +1 -1
  220. package/sdk/shipping.js +3 -3
  221. package/sdk/shipping.js.map +1 -1
  222. package/sdk/user.d.ts +4 -86
  223. package/sdk/user.d.ts.map +1 -1
  224. package/sdk/user.js +4 -120
  225. package/sdk/user.js.map +1 -1
  226. package/sdk/{countries.d.ts → utils.d.ts} +9 -2
  227. package/sdk/utils.d.ts.map +1 -0
  228. package/sdk/utils.js +42 -0
  229. package/sdk/utils.js.map +1 -0
  230. package/src/funcs/{analyticsTrackEvent.ts → analyticsTrack.ts} +1 -1
  231. package/src/funcs/{authOtpGenerate.ts → authGenerateOtp.ts} +1 -1
  232. package/src/funcs/{ordersGetReturns.ts → authLoginAnonymously.ts} +23 -14
  233. package/src/funcs/{authTokenRefresh.ts → authRefreshToken.ts} +1 -1
  234. package/src/funcs/{authGetUser.ts → authUserGet.ts} +1 -1
  235. package/src/funcs/{authUpdateUser.ts → authUserUpdate.ts} +1 -1
  236. package/src/funcs/{campaignsSubscribeNewsletter.ts → campaignsNewsletterSubscribe.ts} +1 -1
  237. package/src/funcs/{catalogProductsCrossSellList.ts → catalogProductsGetCrossSells.ts} +1 -1
  238. package/src/funcs/{catalogProductsSimilarList.ts → catalogProductsGetSimilar.ts} +1 -1
  239. package/src/funcs/{catalogProductsUpSellList.ts → catalogProductsGetUpsells.ts} +1 -1
  240. package/src/funcs/{ordersReturnsCreate.ts → customersAPIGetRecommendedProducts.ts} +14 -18
  241. package/src/funcs/{customersGetAddresses.ts → customersAddressesList.ts} +1 -1
  242. package/src/funcs/{customersReviewsGetAll.ts → customersReviewsList.ts} +1 -1
  243. package/src/funcs/{offersGetCoupons.ts → offersCouponsList.ts} +1 -1
  244. package/src/funcs/{offersGetPromotions.ts → offersPromotionsList.ts} +1 -1
  245. package/src/funcs/{shippingGetPincodeServiceability.ts → shippingCheckPincodeServiceability.ts} +1 -1
  246. package/src/funcs/{authUserCreateNotificationPreferences.ts → userNotificationPreferencesCreate.ts} +1 -1
  247. package/src/funcs/{authUserGetNotificationPreferences.ts → userNotificationPreferencesGet.ts} +1 -1
  248. package/src/funcs/{authUserUpdateNotificationPreferences.ts → userNotificationPreferencesUpdate.ts} +1 -1
  249. package/src/funcs/{commonGetCountries.ts → utilsGetCountries.ts} +1 -1
  250. package/src/funcs/{commonCountriesGetPincodes.ts → utilsGetPincodes.ts} +1 -1
  251. package/src/funcs/{commonCountriesGetStates.ts → utilsGetStates.ts} +1 -1
  252. package/src/lib/config.ts +3 -8
  253. package/src/models/components/cartitem.ts +4 -4
  254. package/src/models/components/index.ts +1 -3
  255. package/src/models/components/productattribute.ts +1 -1
  256. package/src/models/components/productdetail.ts +5 -5
  257. package/src/models/components/productlist.ts +5 -5
  258. package/src/models/components/productreview.ts +1 -1
  259. package/src/models/components/productshipping.ts +2 -2
  260. package/src/models/components/productsubscription.ts +1 -1
  261. package/src/models/components/recommendedproduct.ts +359 -0
  262. package/src/models/components/skuinfo.ts +4 -4
  263. package/src/models/errors/unauthorized.ts +1 -1
  264. package/src/models/operations/getrecommendedproducts.ts +140 -0
  265. package/src/models/operations/index.ts +2 -5
  266. package/src/models/operations/postauthanonymous.ts +190 -0
  267. package/src/models/operations/postcartitemid.ts +1 -1
  268. package/src/sdk/addresses.ts +14 -0
  269. package/src/sdk/analytics.ts +3 -3
  270. package/src/sdk/auth.ts +31 -28
  271. package/src/sdk/campaigns.ts +5 -15
  272. package/src/sdk/cestorefrontuser.ts +160 -0
  273. package/src/sdk/coupons.ts +20 -0
  274. package/src/sdk/customers.ts +1 -17
  275. package/src/sdk/{recommended.ts → customersapi.ts} +8 -5
  276. package/src/sdk/newsletter.ts +23 -0
  277. package/src/sdk/notificationpreferences.ts +51 -0
  278. package/src/sdk/offers.ts +9 -21
  279. package/src/sdk/orders.ts +0 -17
  280. package/src/sdk/products.ts +42 -24
  281. package/src/sdk/promotions.ts +20 -0
  282. package/src/sdk/reviews.ts +3 -3
  283. package/src/sdk/sdk.ts +16 -4
  284. package/src/sdk/shipping.ts +3 -3
  285. package/src/sdk/user.ts +5 -166
  286. package/src/sdk/{countries.ts → utils.ts} +18 -5
  287. package/docs/sdks/crosssell/README.md +0 -82
  288. package/docs/sdks/similar/README.md +0 -82
  289. package/docs/sdks/token/README.md +0 -80
  290. package/funcs/analyticsTrackEvent.d.ts.map +0 -1
  291. package/funcs/analyticsTrackEvent.js.map +0 -1
  292. package/funcs/authUserCreateNotificationPreferences.d.ts.map +0 -1
  293. package/funcs/authUserCreateNotificationPreferences.js.map +0 -1
  294. package/funcs/authUserGetNotificationPreferences.d.ts.map +0 -1
  295. package/funcs/authUserGetNotificationPreferences.js.map +0 -1
  296. package/funcs/authUserUpdateNotificationPreferences.d.ts.map +0 -1
  297. package/funcs/authUserUpdateNotificationPreferences.js.map +0 -1
  298. package/funcs/catalogProductsRecommendedList.d.ts.map +0 -1
  299. package/funcs/catalogProductsRecommendedList.js +0 -84
  300. package/funcs/catalogProductsRecommendedList.js.map +0 -1
  301. package/funcs/catalogProductsSimilarList.d.ts.map +0 -1
  302. package/funcs/catalogProductsSimilarList.js.map +0 -1
  303. package/funcs/commonCountriesGetPincodes.d.ts.map +0 -1
  304. package/funcs/commonCountriesGetPincodes.js.map +0 -1
  305. package/funcs/commonCountriesGetStates.d.ts.map +0 -1
  306. package/funcs/commonCountriesGetStates.js.map +0 -1
  307. package/funcs/commonGetCountries.d.ts.map +0 -1
  308. package/funcs/commonGetCountries.js.map +0 -1
  309. package/funcs/customersGetAddresses.d.ts.map +0 -1
  310. package/funcs/customersGetAddresses.js.map +0 -1
  311. package/funcs/customersReviewsGetAll.d.ts.map +0 -1
  312. package/funcs/customersReviewsGetAll.js.map +0 -1
  313. package/funcs/offersGetCoupons.d.ts.map +0 -1
  314. package/funcs/offersGetCoupons.js.map +0 -1
  315. package/funcs/offersGetPromotions.d.ts.map +0 -1
  316. package/funcs/offersGetPromotions.js.map +0 -1
  317. package/funcs/ordersGetReturns.d.ts +0 -15
  318. package/funcs/ordersGetReturns.d.ts.map +0 -1
  319. package/funcs/ordersReturnsCreate.d.ts +0 -16
  320. package/funcs/ordersReturnsCreate.d.ts.map +0 -1
  321. package/funcs/ordersReturnsCreate.js +0 -101
  322. package/funcs/ordersReturnsCreate.js.map +0 -1
  323. package/funcs/ordersReturnsGet.d.ts +0 -15
  324. package/funcs/ordersReturnsGet.d.ts.map +0 -1
  325. package/funcs/ordersReturnsGet.js +0 -100
  326. package/funcs/ordersReturnsGet.js.map +0 -1
  327. package/funcs/ordersReturnsList.d.ts +0 -15
  328. package/funcs/ordersReturnsList.d.ts.map +0 -1
  329. package/funcs/ordersReturnsList.js +0 -96
  330. package/funcs/ordersReturnsList.js.map +0 -1
  331. package/funcs/shippingGetPincodeServiceability.d.ts.map +0 -1
  332. package/funcs/shippingGetPincodeServiceability.js.map +0 -1
  333. package/models/components/createorderreturn.d.ts +0 -29
  334. package/models/components/createorderreturn.d.ts.map +0 -1
  335. package/models/components/createorderreturn.js +0 -69
  336. package/models/components/createorderreturn.js.map +0 -1
  337. package/models/components/orderreturn.d.ts +0 -59
  338. package/models/components/orderreturn.d.ts.map +0 -1
  339. package/models/components/orderreturn.js +0 -165
  340. package/models/components/orderreturn.js.map +0 -1
  341. package/models/components/orderreturnitem.d.ts +0 -122
  342. package/models/components/orderreturnitem.d.ts.map +0 -1
  343. package/models/components/orderreturnitem.js +0 -171
  344. package/models/components/orderreturnitem.js.map +0 -1
  345. package/models/operations/getordersordernumberreturn.d.ts +0 -59
  346. package/models/operations/getordersordernumberreturn.d.ts.map +0 -1
  347. package/models/operations/getordersordernumberreturn.js +0 -99
  348. package/models/operations/getordersordernumberreturn.js.map +0 -1
  349. package/models/operations/getordersordernumberreturnreturnid.d.ts +0 -87
  350. package/models/operations/getordersordernumberreturnreturnid.d.ts.map +0 -1
  351. package/models/operations/getordersordernumberreturnreturnid.js +0 -122
  352. package/models/operations/getordersordernumberreturnreturnid.js.map +0 -1
  353. package/models/operations/getordersreturns.d.ts +0 -56
  354. package/models/operations/getordersreturns.d.ts.map +0 -1
  355. package/models/operations/getordersreturns.js +0 -74
  356. package/models/operations/getordersreturns.js.map +0 -1
  357. package/models/operations/getrecommended.d.ts +0 -56
  358. package/models/operations/getrecommended.d.ts.map +0 -1
  359. package/models/operations/getrecommended.js +0 -74
  360. package/models/operations/getrecommended.js.map +0 -1
  361. package/models/operations/postordersordernumberreturn.d.ts +0 -84
  362. package/models/operations/postordersordernumberreturn.d.ts.map +0 -1
  363. package/models/operations/postordersordernumberreturn.js +0 -122
  364. package/models/operations/postordersordernumberreturn.js.map +0 -1
  365. package/sdk/common.d.ts +0 -15
  366. package/sdk/common.d.ts.map +0 -1
  367. package/sdk/common.js +0 -27
  368. package/sdk/common.js.map +0 -1
  369. package/sdk/countries.d.ts.map +0 -1
  370. package/sdk/countries.js +0 -32
  371. package/sdk/countries.js.map +0 -1
  372. package/sdk/crosssell.d.ts +0 -12
  373. package/sdk/crosssell.d.ts.map +0 -1
  374. package/sdk/crosssell.js +0 -22
  375. package/sdk/crosssell.js.map +0 -1
  376. package/sdk/otp.d.ts +0 -12
  377. package/sdk/otp.d.ts.map +0 -1
  378. package/sdk/otp.js +0 -22
  379. package/sdk/otp.js.map +0 -1
  380. package/sdk/recommended.d.ts.map +0 -1
  381. package/sdk/recommended.js.map +0 -1
  382. package/sdk/returns.d.ts +0 -26
  383. package/sdk/returns.d.ts.map +0 -1
  384. package/sdk/returns.js +0 -42
  385. package/sdk/returns.js.map +0 -1
  386. package/sdk/similar.d.ts +0 -12
  387. package/sdk/similar.d.ts.map +0 -1
  388. package/sdk/similar.js +0 -22
  389. package/sdk/similar.js.map +0 -1
  390. package/sdk/token.d.ts +0 -12
  391. package/sdk/token.d.ts.map +0 -1
  392. package/sdk/token.js +0 -22
  393. package/sdk/token.js.map +0 -1
  394. package/sdk/upsell.d.ts +0 -12
  395. package/sdk/upsell.d.ts.map +0 -1
  396. package/sdk/upsell.js +0 -22
  397. package/sdk/upsell.js.map +0 -1
  398. package/src/funcs/catalogProductsRecommendedList.ts +0 -114
  399. package/src/funcs/ordersReturnsGet.ts +0 -132
  400. package/src/funcs/ordersReturnsList.ts +0 -127
  401. package/src/models/components/createorderreturn.ts +0 -73
  402. package/src/models/components/orderreturn.ts +0 -198
  403. package/src/models/components/orderreturnitem.ts +0 -222
  404. package/src/models/operations/getordersordernumberreturn.ts +0 -125
  405. package/src/models/operations/getordersordernumberreturnreturnid.ts +0 -174
  406. package/src/models/operations/getordersreturns.ts +0 -97
  407. package/src/models/operations/getrecommended.ts +0 -97
  408. package/src/models/operations/postordersordernumberreturn.ts +0 -171
  409. package/src/sdk/common.ts +0 -28
  410. package/src/sdk/crosssell.ts +0 -23
  411. package/src/sdk/otp.ts +0 -23
  412. package/src/sdk/returns.ts +0 -51
  413. package/src/sdk/similar.ts +0 -23
  414. package/src/sdk/token.ts +0 -23
  415. package/src/sdk/upsell.ts +0 -23
@@ -1,4 +1,9 @@
1
1
 
2
+ <div align="center">
3
+ <a href="https://codespaces.new/tark-ai/ce-storefront-sdk.git/tree/main"><img src="https://github.com/codespaces/badge.svg" /></a>
4
+ </div>
5
+ <br>
6
+
2
7
  > **Remember to shutdown a GitHub Codespace when it is not in use!**
3
8
 
4
9
  # Dev Containers Quick Start
package/README.md CHANGED
@@ -1,46 +1,30 @@
1
1
  # ce-storefront
2
2
 
3
- <div align="left">
4
- <a href="https://www.speakeasy.com/?utm_source=ce-storefront&utm_campaign=typescript"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
5
- <a href="https://opensource.org/licenses/MIT">
6
- <img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" />
7
- </a>
8
- </div>
9
-
10
-
11
- ## 🏗 **Welcome to your new SDK!** 🏗
12
-
13
- It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:
14
- - [ ] 🛠 Make your SDK feel handcrafted by [customizing it](https://www.speakeasy.com/docs/customize-sdks)
15
- - [ ] ♻️ Refine your SDK quickly by iterating locally with the [Speakeasy CLI](https://github.com/speakeasy-api/speakeasy)
16
- - [ ] 🎁 Publish your SDK to package managers by [configuring automatic publishing](https://www.speakeasy.com/docs/advanced-setup/publish-sdks)
17
- - [ ] ✨ When ready to productionize, delete this section from the README
18
-
19
3
  <!-- Start SDK Installation [installation] -->
20
4
  ## SDK Installation
21
5
 
22
6
  ### NPM
23
7
 
24
8
  ```bash
25
- npm add <UNSET>
9
+ npm add ce-storefront
26
10
  ```
27
11
 
28
12
  ### PNPM
29
13
 
30
14
  ```bash
31
- pnpm add <UNSET>
15
+ pnpm add ce-storefront
32
16
  ```
33
17
 
34
18
  ### Bun
35
19
 
36
20
  ```bash
37
- bun add <UNSET>
21
+ bun add ce-storefront
38
22
  ```
39
23
 
40
24
  ### Yarn
41
25
 
42
26
  ```bash
43
- yarn add <UNSET> zod
27
+ yarn add ce-storefront zod
44
28
 
45
29
  # Note that Yarn does not install peer dependencies automatically. You will need
46
30
  # to install zod as shown above.
@@ -86,6 +70,9 @@ run();
86
70
 
87
71
  * [list](docs/sdks/products/README.md#list) - List all products
88
72
  * [get](docs/sdks/products/README.md#get) - Retrieve a product
73
+ * [getSimilar](docs/sdks/products/README.md#getsimilar) - Retrieve similar products
74
+ * [getUpsells](docs/sdks/products/README.md#getupsells) - Retrieve up-sell products
75
+ * [getCrossSells](docs/sdks/products/README.md#getcrosssells) - Retrieve cross-sell products
89
76
 
90
77
  ### [catalog.products.variants](docs/sdks/variants/README.md)
91
78
 
@@ -97,22 +84,6 @@ run();
97
84
  * [list](docs/sdks/cestorefrontreviews/README.md#list) - Retrieve product reviews
98
85
  * [create](docs/sdks/cestorefrontreviews/README.md#create) - Create product review
99
86
 
100
- ### [catalog.products.similar](docs/sdks/similar/README.md)
101
-
102
- * [list](docs/sdks/similar/README.md#list) - Retrieve similar products
103
-
104
- ### [catalog.products.upSell](docs/sdks/upsell/README.md)
105
-
106
- * [list](docs/sdks/upsell/README.md#list) - Retrieve up-sell products
107
-
108
- ### [catalog.products.crossSell](docs/sdks/crosssell/README.md)
109
-
110
- * [list](docs/sdks/crosssell/README.md#list) - Retrieve cross-sell products
111
-
112
- ### [catalog.products.recommended](docs/sdks/recommended/README.md)
113
-
114
- * [list](docs/sdks/recommended/README.md#list) - Retrieve recommended products
115
-
116
87
  ### [catalog.skus](docs/sdks/skus/README.md)
117
88
 
118
89
  * [list](docs/sdks/skus/README.md#list) - List all SKUs
@@ -121,6 +92,10 @@ run();
121
92
 
122
93
  * [list](docs/sdks/categories/README.md#list) - List all categories
123
94
 
95
+ ### [customersAPI](docs/sdks/customersapi/README.md)
96
+
97
+ * [getRecommendedProducts](docs/sdks/customersapi/README.md#getrecommendedproducts) - List all recommended products
98
+
124
99
  ### [carts](docs/sdks/carts/README.md)
125
100
 
126
101
  * [create](docs/sdks/carts/README.md#create) - Create cart
@@ -139,10 +114,14 @@ run();
139
114
  * [removeCreditBalance](docs/sdks/checkout/README.md#removecreditbalance) - Remove credit balance
140
115
  * [redeemGiftCard](docs/sdks/checkout/README.md#redeemgiftcard) - Redeem gift card
141
116
 
142
- ### [offers](docs/sdks/offers/README.md)
143
117
 
144
- * [getCoupons](docs/sdks/offers/README.md#getcoupons) - Retrieve all coupons
145
- * [getPromotions](docs/sdks/offers/README.md#getpromotions) - Retrieve all promotions
118
+ ### [offers.coupons](docs/sdks/coupons/README.md)
119
+
120
+ * [list](docs/sdks/coupons/README.md#list) - Retrieve all coupons
121
+
122
+ ### [offers.promotions](docs/sdks/promotions/README.md)
123
+
124
+ * [list](docs/sdks/promotions/README.md#list) - Retrieve all promotions
146
125
 
147
126
  ### [wishlist](docs/sdks/wishlist/README.md)
148
127
 
@@ -150,12 +129,10 @@ run();
150
129
  * [add](docs/sdks/wishlist/README.md#add) - Add product to wishlist
151
130
  * [delete](docs/sdks/wishlist/README.md#delete) - Delete product from wishlist
152
131
 
153
- ### [customers](docs/sdks/customers/README.md)
154
-
155
- * [getAddresses](docs/sdks/customers/README.md#getaddresses) - Retrieve all addresses
156
132
 
157
133
  ### [customers.addresses](docs/sdks/addresses/README.md)
158
134
 
135
+ * [list](docs/sdks/addresses/README.md#list) - Retrieve all addresses
159
136
  * [add](docs/sdks/addresses/README.md#add) - Add address
160
137
  * [get](docs/sdks/addresses/README.md#get) - Retrieve particular address
161
138
  * [update](docs/sdks/addresses/README.md#update) - Update particular address
@@ -168,7 +145,7 @@ run();
168
145
 
169
146
  ### [customers.reviews](docs/sdks/reviews/README.md)
170
147
 
171
- * [getAll](docs/sdks/reviews/README.md#getall) - Retrieve all reviews
148
+ * [list](docs/sdks/reviews/README.md#list) - Retrieve all reviews
172
149
 
173
150
  ### [orders](docs/sdks/orders/README.md)
174
151
 
@@ -177,7 +154,6 @@ run();
177
154
  * [get](docs/sdks/orders/README.md#get) - Retrieve order detail
178
155
  * [cancel](docs/sdks/orders/README.md#cancel) - Cancel order
179
156
  * [retryPayment](docs/sdks/orders/README.md#retrypayment) - Retry payment
180
- * [getReturns](docs/sdks/orders/README.md#getreturns) - Retrieve all order returns
181
157
 
182
158
  ### [orders.shipments](docs/sdks/shipments/README.md)
183
159
 
@@ -191,18 +167,13 @@ run();
191
167
 
192
168
  * [list](docs/sdks/cestorefrontpayments/README.md#list) - Retrieve order payments
193
169
 
194
- ### [orders.returns](docs/sdks/returns/README.md)
195
-
196
- * [create](docs/sdks/returns/README.md#create) - Create order return
197
- * [list](docs/sdks/returns/README.md#list) - List all order returns
198
- * [get](docs/sdks/returns/README.md#get) - Retrieve order return detail
199
-
200
170
  ### [shipping](docs/sdks/shipping/README.md)
201
171
 
202
- * [getPincodeServiceability](docs/sdks/shipping/README.md#getpincodeserviceability) - Check pincode serviceability
172
+ * [checkPincodeServiceability](docs/sdks/shipping/README.md#checkpincodeserviceability) - Check pincode serviceability
203
173
 
204
174
  ### [auth](docs/sdks/auth/README.md)
205
175
 
176
+ * [loginAnonymously](docs/sdks/auth/README.md#loginanonymously) - Anonymous user
206
177
  * [loginWithPhone](docs/sdks/auth/README.md#loginwithphone) - Login with phone
207
178
  * [loginWithEmail](docs/sdks/auth/README.md#loginwithemail) - Login with email
208
179
  * [loginWithWhatsapp](docs/sdks/auth/README.md#loginwithwhatsapp) - Login with whatsapp
@@ -212,54 +183,50 @@ run();
212
183
  * [registerWithEmail](docs/sdks/auth/README.md#registerwithemail) - Register with email
213
184
  * [registerWithWhatsapp](docs/sdks/auth/README.md#registerwithwhatsapp) - Register with whatsapp
214
185
  * [registerWithPassword](docs/sdks/auth/README.md#registerwithpassword) - Register with password
215
- * [getUser](docs/sdks/auth/README.md#getuser) - Retrieve a user
216
- * [updateUser](docs/sdks/auth/README.md#updateuser) - Update a user
186
+ * [refreshToken](docs/sdks/auth/README.md#refreshtoken) - Refresh access token
187
+ * [generateOtp](docs/sdks/auth/README.md#generateotp) - Generate OTP
217
188
  * [verifyEmailPhone](docs/sdks/auth/README.md#verifyemailphone) - Check verified email phone
218
189
 
219
- ### [auth.user](docs/sdks/user/README.md)
190
+ ### [auth.user](docs/sdks/cestorefrontuser/README.md)
220
191
 
221
- * [addProfileImage](docs/sdks/user/README.md#addprofileimage) - Add profile image
222
- * [updateProfileImage](docs/sdks/user/README.md#updateprofileimage) - Update profile image
223
- * [deleteProfileImage](docs/sdks/user/README.md#deleteprofileimage) - Delete profile image
224
- * [getProfileImage](docs/sdks/user/README.md#getprofileimage) - Retrieve a profile image
225
- * [deactivateAccount](docs/sdks/user/README.md#deactivateaccount) - Deactivate account
226
- * [changePassword](docs/sdks/user/README.md#changepassword) - Change password
227
- * [forgotPassword](docs/sdks/user/README.md#forgotpassword) - Forgot password
228
- * [resetPassword](docs/sdks/user/README.md#resetpassword) - Reset password
229
- * [getNotificationPreferences](docs/sdks/user/README.md#getnotificationpreferences) - Retrieve user notification preferences
230
- * [createNotificationPreferences](docs/sdks/user/README.md#createnotificationpreferences) - Create user notification preferences
231
- * [updateNotificationPreferences](docs/sdks/user/README.md#updatenotificationpreferences) - Update user notification preferences
232
- * [logout](docs/sdks/user/README.md#logout) - Logout user
192
+ * [get](docs/sdks/cestorefrontuser/README.md#get) - Retrieve a user
193
+ * [update](docs/sdks/cestorefrontuser/README.md#update) - Update a user
194
+ * [addProfileImage](docs/sdks/cestorefrontuser/README.md#addprofileimage) - Add profile image
195
+ * [updateProfileImage](docs/sdks/cestorefrontuser/README.md#updateprofileimage) - Update profile image
196
+ * [deleteProfileImage](docs/sdks/cestorefrontuser/README.md#deleteprofileimage) - Delete profile image
197
+ * [getProfileImage](docs/sdks/cestorefrontuser/README.md#getprofileimage) - Retrieve a profile image
198
+ * [deactivateAccount](docs/sdks/cestorefrontuser/README.md#deactivateaccount) - Deactivate account
199
+ * [changePassword](docs/sdks/cestorefrontuser/README.md#changepassword) - Change password
200
+ * [forgotPassword](docs/sdks/cestorefrontuser/README.md#forgotpassword) - Forgot password
201
+ * [resetPassword](docs/sdks/cestorefrontuser/README.md#resetpassword) - Reset password
202
+ * [logout](docs/sdks/cestorefrontuser/README.md#logout) - Logout user
233
203
 
234
- ### [auth.token](docs/sdks/token/README.md)
235
204
 
236
- * [refresh](docs/sdks/token/README.md#refresh) - Refresh access token
205
+ ### [user.notificationPreferences](docs/sdks/notificationpreferences/README.md)
237
206
 
238
- ### [auth.otp](docs/sdks/otp/README.md)
239
-
240
- * [generate](docs/sdks/otp/README.md#generate) - Generate OTP
207
+ * [get](docs/sdks/notificationpreferences/README.md#get) - Retrieve user notification preferences
208
+ * [create](docs/sdks/notificationpreferences/README.md#create) - Create user notification preferences
209
+ * [update](docs/sdks/notificationpreferences/README.md#update) - Update user notification preferences
241
210
 
242
211
  ### [payments](docs/sdks/payments/README.md)
243
212
 
244
213
  * [generateHash](docs/sdks/payments/README.md#generatehash) - Generate hash
245
214
  * [getMethods](docs/sdks/payments/README.md#getmethods) - Retrieve available payment methods
246
215
 
247
- ### [common](docs/sdks/common/README.md)
248
-
249
- * [getCountries](docs/sdks/common/README.md#getcountries) - Retrieve all countries
250
-
251
- ### [common.countries](docs/sdks/countries/README.md)
216
+ ### [utils](docs/sdks/utils/README.md)
252
217
 
253
- * [getStates](docs/sdks/countries/README.md#getstates) - Retrieve country wise states
254
- * [getPincodes](docs/sdks/countries/README.md#getpincodes) - Retrieve pincodes
218
+ * [getCountries](docs/sdks/utils/README.md#getcountries) - Retrieve all countries
219
+ * [getStates](docs/sdks/utils/README.md#getstates) - Retrieve country wise states
220
+ * [getPincodes](docs/sdks/utils/README.md#getpincodes) - Retrieve pincodes
255
221
 
256
222
  ### [analytics](docs/sdks/analytics/README.md)
257
223
 
258
- * [trackEvent](docs/sdks/analytics/README.md#trackevent) - Track event
224
+ * [track](docs/sdks/analytics/README.md#track) - Track event
259
225
 
260
- ### [campaigns](docs/sdks/campaigns/README.md)
261
226
 
262
- * [subscribeNewsletter](docs/sdks/campaigns/README.md#subscribenewsletter) - Subscribe to newsletter
227
+ ### [campaigns.newsletter](docs/sdks/newsletter/README.md)
228
+
229
+ * [subscribe](docs/sdks/newsletter/README.md#subscribe) - Subscribe to newsletter
263
230
  <!-- End Available Resources and Operations [operations] -->
264
231
 
265
232
  <!-- Start Standalone functions [standalone-funcs] -->
@@ -277,47 +244,44 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
277
244
 
278
245
  <summary>Available standalone functions</summary>
279
246
 
280
- - [analyticsTrackEvent](docs/sdks/analytics/README.md#trackevent)
281
- - [authGetUser](docs/sdks/auth/README.md#getuser)
247
+ - [analyticsTrack](docs/sdks/analytics/README.md#track)
248
+ - [authGenerateOtp](docs/sdks/auth/README.md#generateotp)
249
+ - [authLoginAnonymously](docs/sdks/auth/README.md#loginanonymously)
282
250
  - [authLoginWithEmail](docs/sdks/auth/README.md#loginwithemail)
283
251
  - [authLoginWithPassword](docs/sdks/auth/README.md#loginwithpassword)
284
252
  - [authLoginWithPhone](docs/sdks/auth/README.md#loginwithphone)
285
253
  - [authLoginWithWhatsapp](docs/sdks/auth/README.md#loginwithwhatsapp)
286
- - [authOtpGenerate](docs/sdks/otp/README.md#generate)
254
+ - [authRefreshToken](docs/sdks/auth/README.md#refreshtoken)
287
255
  - [authRegisterWithEmail](docs/sdks/auth/README.md#registerwithemail)
288
256
  - [authRegisterWithPassword](docs/sdks/auth/README.md#registerwithpassword)
289
257
  - [authRegisterWithPhone](docs/sdks/auth/README.md#registerwithphone)
290
258
  - [authRegisterWithWhatsapp](docs/sdks/auth/README.md#registerwithwhatsapp)
291
- - [authTokenRefresh](docs/sdks/token/README.md#refresh)
292
- - [authUpdateUser](docs/sdks/auth/README.md#updateuser)
293
- - [authUserAddProfileImage](docs/sdks/user/README.md#addprofileimage)
294
- - [authUserChangePassword](docs/sdks/user/README.md#changepassword)
295
- - [authUserCreateNotificationPreferences](docs/sdks/user/README.md#createnotificationpreferences)
296
- - [authUserDeactivateAccount](docs/sdks/user/README.md#deactivateaccount)
297
- - [authUserDeleteProfileImage](docs/sdks/user/README.md#deleteprofileimage)
298
- - [authUserForgotPassword](docs/sdks/user/README.md#forgotpassword)
299
- - [authUserGetNotificationPreferences](docs/sdks/user/README.md#getnotificationpreferences)
300
- - [authUserGetProfileImage](docs/sdks/user/README.md#getprofileimage)
301
- - [authUserLogout](docs/sdks/user/README.md#logout)
302
- - [authUserResetPassword](docs/sdks/user/README.md#resetpassword)
303
- - [authUserUpdateNotificationPreferences](docs/sdks/user/README.md#updatenotificationpreferences)
304
- - [authUserUpdateProfileImage](docs/sdks/user/README.md#updateprofileimage)
259
+ - [authUserAddProfileImage](docs/sdks/cestorefrontuser/README.md#addprofileimage)
260
+ - [authUserChangePassword](docs/sdks/cestorefrontuser/README.md#changepassword)
261
+ - [authUserDeactivateAccount](docs/sdks/cestorefrontuser/README.md#deactivateaccount)
262
+ - [authUserDeleteProfileImage](docs/sdks/cestorefrontuser/README.md#deleteprofileimage)
263
+ - [authUserForgotPassword](docs/sdks/cestorefrontuser/README.md#forgotpassword)
264
+ - [authUserGetProfileImage](docs/sdks/cestorefrontuser/README.md#getprofileimage)
265
+ - [authUserGet](docs/sdks/cestorefrontuser/README.md#get)
266
+ - [authUserLogout](docs/sdks/cestorefrontuser/README.md#logout)
267
+ - [authUserResetPassword](docs/sdks/cestorefrontuser/README.md#resetpassword)
268
+ - [authUserUpdateProfileImage](docs/sdks/cestorefrontuser/README.md#updateprofileimage)
269
+ - [authUserUpdate](docs/sdks/cestorefrontuser/README.md#update)
305
270
  - [authVerifyEmailPhone](docs/sdks/auth/README.md#verifyemailphone)
306
271
  - [authVerifyOtp](docs/sdks/auth/README.md#verifyotp)
307
- - [campaignsSubscribeNewsletter](docs/sdks/campaigns/README.md#subscribenewsletter)
272
+ - [campaignsNewsletterSubscribe](docs/sdks/newsletter/README.md#subscribe)
308
273
  - [cartsAddItem](docs/sdks/carts/README.md#additem)
309
274
  - [cartsCreate](docs/sdks/carts/README.md#create)
310
275
  - [cartsDelete](docs/sdks/carts/README.md#delete)
311
276
  - [cartsGet](docs/sdks/carts/README.md#get)
312
277
  - [catalogCategoriesList](docs/sdks/categories/README.md#list)
313
- - [catalogProductsCrossSellList](docs/sdks/crosssell/README.md#list)
278
+ - [catalogProductsGetCrossSells](docs/sdks/products/README.md#getcrosssells)
279
+ - [catalogProductsGetSimilar](docs/sdks/products/README.md#getsimilar)
280
+ - [catalogProductsGetUpsells](docs/sdks/products/README.md#getupsells)
314
281
  - [catalogProductsGet](docs/sdks/products/README.md#get)
315
282
  - [catalogProductsList](docs/sdks/products/README.md#list)
316
- - [catalogProductsRecommendedList](docs/sdks/recommended/README.md#list)
317
283
  - [catalogProductsReviewsCreate](docs/sdks/cestorefrontreviews/README.md#create)
318
284
  - [catalogProductsReviewsList](docs/sdks/cestorefrontreviews/README.md#list)
319
- - [catalogProductsSimilarList](docs/sdks/similar/README.md#list)
320
- - [catalogProductsUpSellList](docs/sdks/upsell/README.md#list)
321
285
  - [catalogProductsVariantsGet](docs/sdks/variants/README.md#get)
322
286
  - [catalogProductsVariantsList](docs/sdks/variants/README.md#list)
323
287
  - [catalogSkusList](docs/sdks/skus/README.md#list)
@@ -329,34 +293,34 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
329
293
  - [checkoutRemoveLoyaltyPoints](docs/sdks/checkout/README.md#removeloyaltypoints)
330
294
  - [checkoutUpdateAddress](docs/sdks/checkout/README.md#updateaddress)
331
295
  - [checkoutUseCreditBalance](docs/sdks/checkout/README.md#usecreditbalance)
332
- - [commonCountriesGetPincodes](docs/sdks/countries/README.md#getpincodes)
333
- - [commonCountriesGetStates](docs/sdks/countries/README.md#getstates)
334
- - [commonGetCountries](docs/sdks/common/README.md#getcountries)
296
+ - [customersAPIGetRecommendedProducts](docs/sdks/customersapi/README.md#getrecommendedproducts)
335
297
  - [customersAddressesAdd](docs/sdks/addresses/README.md#add)
336
298
  - [customersAddressesDelete](docs/sdks/addresses/README.md#delete)
337
299
  - [customersAddressesGet](docs/sdks/addresses/README.md#get)
300
+ - [customersAddressesList](docs/sdks/addresses/README.md#list)
338
301
  - [customersAddressesUpdate](docs/sdks/addresses/README.md#update)
339
- - [customersGetAddresses](docs/sdks/customers/README.md#getaddresses)
340
302
  - [customersLoyaltyGet](docs/sdks/loyalty/README.md#get)
341
303
  - [customersLoyaltyListActivities](docs/sdks/loyalty/README.md#listactivities)
342
- - [customersReviewsGetAll](docs/sdks/reviews/README.md#getall)
343
- - [offersGetCoupons](docs/sdks/offers/README.md#getcoupons)
344
- - [offersGetPromotions](docs/sdks/offers/README.md#getpromotions)
304
+ - [customersReviewsList](docs/sdks/reviews/README.md#list)
305
+ - [offersCouponsList](docs/sdks/coupons/README.md#list)
306
+ - [offersPromotionsList](docs/sdks/promotions/README.md#list)
345
307
  - [ordersCancel](docs/sdks/orders/README.md#cancel)
346
308
  - [ordersCreate](docs/sdks/orders/README.md#create)
347
- - [ordersGetReturns](docs/sdks/orders/README.md#getreturns)
348
309
  - [ordersGet](docs/sdks/orders/README.md#get)
349
310
  - [ordersList](docs/sdks/orders/README.md#list)
350
311
  - [ordersPaymentsList](docs/sdks/cestorefrontpayments/README.md#list)
351
312
  - [ordersRefundsList](docs/sdks/refunds/README.md#list)
352
313
  - [ordersRetryPayment](docs/sdks/orders/README.md#retrypayment)
353
- - [ordersReturnsCreate](docs/sdks/returns/README.md#create)
354
- - [ordersReturnsGet](docs/sdks/returns/README.md#get)
355
- - [ordersReturnsList](docs/sdks/returns/README.md#list)
356
314
  - [ordersShipmentsList](docs/sdks/shipments/README.md#list)
357
315
  - [paymentsGenerateHash](docs/sdks/payments/README.md#generatehash)
358
316
  - [paymentsGetMethods](docs/sdks/payments/README.md#getmethods)
359
- - [shippingGetPincodeServiceability](docs/sdks/shipping/README.md#getpincodeserviceability)
317
+ - [shippingCheckPincodeServiceability](docs/sdks/shipping/README.md#checkpincodeserviceability)
318
+ - [userNotificationPreferencesCreate](docs/sdks/notificationpreferences/README.md#create)
319
+ - [userNotificationPreferencesGet](docs/sdks/notificationpreferences/README.md#get)
320
+ - [userNotificationPreferencesUpdate](docs/sdks/notificationpreferences/README.md#update)
321
+ - [utilsGetCountries](docs/sdks/utils/README.md#getcountries)
322
+ - [utilsGetPincodes](docs/sdks/utils/README.md#getpincodes)
323
+ - [utilsGetStates](docs/sdks/utils/README.md#getstates)
360
324
  - [wishlistAdd](docs/sdks/wishlist/README.md#add)
361
325
  - [wishlistDelete](docs/sdks/wishlist/README.md#delete)
362
326
  - [wishlistGet](docs/sdks/wishlist/README.md#get)
@@ -543,13 +507,12 @@ You can override the default server globally by passing a server index to the `s
543
507
  | - | ------ | --------- |
544
508
  | 0 | `https://staging.api.commercengine.io/api/v1/{store_id}/storefront` | `store_id` (default is `x2yh61zw4k`) |
545
509
  | 1 | `https://prod.api.commercengine.io/api/v1/{store_id}/storefront` | `store_id` (default is `x2yh61zw4k`) |
546
- | 2 | `https://stoplight.io/mocks/tarkaikaman/ce-apis/217963442` | None |
547
510
 
548
511
  ```typescript
549
512
  import { CeStorefront } from "ce-storefront";
550
513
 
551
514
  const ceStorefront = new CeStorefront({
552
- serverIdx: 2,
515
+ serverIdx: 1,
553
516
  authorization: "<YOUR_BEARER_TOKEN_HERE>",
554
517
  });
555
518
 
@@ -676,6 +639,27 @@ async function run() {
676
639
 
677
640
  run();
678
641
 
642
+ ```
643
+
644
+ ### Per-Operation Security Schemes
645
+
646
+ Some operations in this SDK require the security scheme to be specified at the request level. For example:
647
+ ```typescript
648
+ import { CeStorefront } from "ce-storefront";
649
+
650
+ const ceStorefront = new CeStorefront();
651
+
652
+ async function run() {
653
+ const result = await ceStorefront.auth.loginAnonymously({
654
+ xApiKey: "<YOUR_API_KEY_HERE>",
655
+ });
656
+
657
+ // Handle the result
658
+ console.log(result);
659
+ }
660
+
661
+ run();
662
+
679
663
  ```
680
664
  <!-- End Authentication [security] -->
681
665
 
@@ -5,11 +5,89 @@
5
5
 
6
6
  ### Available Operations
7
7
 
8
+ * [list](#list) - Retrieve all addresses
8
9
  * [add](#add) - Add address
9
10
  * [get](#get) - Retrieve particular address
10
11
  * [update](#update) - Update particular address
11
12
  * [delete](#delete) - Remove particular address
12
13
 
14
+ ## list
15
+
16
+ Retrieve billing and shipping address of particular customer
17
+
18
+ ### Example Usage
19
+
20
+ ```typescript
21
+ import { CeStorefront } from "ce-storefront";
22
+
23
+ const ceStorefront = new CeStorefront({
24
+ authorization: "<YOUR_BEARER_TOKEN_HERE>",
25
+ });
26
+
27
+ async function run() {
28
+ const result = await ceStorefront.customers.addresses.list({
29
+ userId: "<value>",
30
+ });
31
+
32
+ // Handle the result
33
+ console.log(result)
34
+ }
35
+
36
+ run();
37
+ ```
38
+
39
+ ### Standalone function
40
+
41
+ The standalone function version of this method:
42
+
43
+ ```typescript
44
+ import { CeStorefrontCore } from "ce-storefront/core.js";
45
+ import { customersAddressesList } from "ce-storefront/funcs/customersAddressesList.js";
46
+
47
+ // Use `CeStorefrontCore` for best tree-shaking performance.
48
+ // You can create one instance of it to use across an application.
49
+ const ceStorefront = new CeStorefrontCore({
50
+ authorization: "<YOUR_BEARER_TOKEN_HERE>",
51
+ });
52
+
53
+ async function run() {
54
+ const res = await customersAddressesList(ceStorefront, {
55
+ userId: "<value>",
56
+ });
57
+
58
+ if (!res.ok) {
59
+ throw res.error;
60
+ }
61
+
62
+ const { value: result } = res;
63
+
64
+ // Handle the result
65
+ console.log(result)
66
+ }
67
+
68
+ run();
69
+ ```
70
+
71
+ ### Parameters
72
+
73
+ | Parameter | Type | Required | Description |
74
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
75
+ | `request` | [operations.GetAddressRequest](../../models/operations/getaddressrequest.md) | :heavy_check_mark: | The request object to use for the request. |
76
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
77
+ | `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. |
78
+ | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
79
+
80
+ ### Response
81
+
82
+ **Promise\<[operations.GetAddressResponseBody](../../models/operations/getaddressresponsebody.md)\>**
83
+
84
+ ### Errors
85
+
86
+ | Error Object | Status Code | Content Type |
87
+ | --------------- | --------------- | --------------- |
88
+ | errors.SDKError | 4xx-5xx | */* |
89
+
90
+
13
91
  ## add
14
92
 
15
93
  Add new address
@@ -5,9 +5,9 @@
5
5
 
6
6
  ### Available Operations
7
7
 
8
- * [trackEvent](#trackevent) - Track event
8
+ * [track](#track) - Track event
9
9
 
10
- ## trackEvent
10
+ ## track
11
11
 
12
12
  Track event
13
13
 
@@ -21,7 +21,7 @@ const ceStorefront = new CeStorefront({
21
21
  });
22
22
 
23
23
  async function run() {
24
- const result = await ceStorefront.analytics.trackEvent();
24
+ const result = await ceStorefront.analytics.track();
25
25
 
26
26
  // Handle the result
27
27
  console.log(result)
@@ -36,7 +36,7 @@ The standalone function version of this method:
36
36
 
37
37
  ```typescript
38
38
  import { CeStorefrontCore } from "ce-storefront/core.js";
39
- import { analyticsTrackEvent } from "ce-storefront/funcs/analyticsTrackEvent.js";
39
+ import { analyticsTrack } from "ce-storefront/funcs/analyticsTrack.js";
40
40
 
41
41
  // Use `CeStorefrontCore` for best tree-shaking performance.
42
42
  // You can create one instance of it to use across an application.
@@ -45,7 +45,7 @@ const ceStorefront = new CeStorefrontCore({
45
45
  });
46
46
 
47
47
  async function run() {
48
- const res = await analyticsTrackEvent(ceStorefront);
48
+ const res = await analyticsTrack(ceStorefront);
49
49
 
50
50
  if (!res.ok) {
51
51
  throw res.error;