ce-storefront 0.0.1 → 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.devcontainer/README.md +5 -0
- package/README.md +89 -124
- package/docs/sdks/addresses/README.md +78 -0
- package/docs/sdks/analytics/README.md +5 -5
- package/docs/sdks/auth/README.md +16 -24
- package/docs/sdks/campaigns/README.md +1 -79
- package/docs/sdks/cestorefrontuser/README.md +850 -0
- package/docs/sdks/{common → coupons}/README.md +9 -9
- package/docs/sdks/customers/README.md +12 -15
- package/docs/sdks/{otp → newsletter}/README.md +10 -10
- package/docs/sdks/notificationpreferences/README.md +240 -0
- package/docs/sdks/offers/README.md +1 -152
- package/docs/sdks/orders/README.md +0 -73
- package/docs/sdks/products/README.md +228 -0
- package/docs/sdks/{recommended → promotions}/README.md +8 -9
- package/docs/sdks/returns/README.md +0 -160
- package/docs/sdks/reviews/README.md +5 -5
- package/docs/sdks/shipping/README.md +5 -5
- package/docs/sdks/user/README.md +1 -927
- package/docs/sdks/{countries → utils}/README.md +81 -8
- package/funcs/{analyticsTrackEvent.d.ts → analyticsTrack.d.ts} +2 -2
- package/funcs/analyticsTrack.d.ts.map +1 -0
- package/funcs/{analyticsTrackEvent.js → analyticsTrack.js} +3 -3
- package/funcs/analyticsTrack.js.map +1 -0
- package/funcs/{authOtpGenerate.d.ts → authGenerateOtp.d.ts} +2 -2
- package/funcs/{authOtpGenerate.d.ts.map → authGenerateOtp.d.ts.map} +1 -1
- package/funcs/{authOtpGenerate.js → authGenerateOtp.js} +3 -3
- package/funcs/{authOtpGenerate.js.map → authGenerateOtp.js.map} +1 -1
- package/funcs/{authTokenRefresh.d.ts → authRefreshToken.d.ts} +2 -2
- package/funcs/{authTokenRefresh.d.ts.map → authRefreshToken.d.ts.map} +1 -1
- package/funcs/{authTokenRefresh.js → authRefreshToken.js} +3 -3
- package/funcs/{authTokenRefresh.js.map → authRefreshToken.js.map} +1 -1
- package/funcs/{authGetUser.d.ts → authUserGet.d.ts} +2 -2
- package/funcs/{authGetUser.d.ts.map → authUserGet.d.ts.map} +1 -1
- package/funcs/{authGetUser.js → authUserGet.js} +3 -3
- package/funcs/{authGetUser.js.map → authUserGet.js.map} +1 -1
- package/funcs/{authUpdateUser.d.ts → authUserUpdate.d.ts} +2 -2
- package/funcs/{authUpdateUser.d.ts.map → authUserUpdate.d.ts.map} +1 -1
- package/funcs/{authUpdateUser.js → authUserUpdate.js} +3 -3
- package/funcs/{authUpdateUser.js.map → authUserUpdate.js.map} +1 -1
- package/funcs/{campaignsSubscribeNewsletter.d.ts → campaignsNewsletterSubscribe.d.ts} +2 -2
- package/funcs/{campaignsSubscribeNewsletter.d.ts.map → campaignsNewsletterSubscribe.d.ts.map} +1 -1
- package/funcs/{campaignsSubscribeNewsletter.js → campaignsNewsletterSubscribe.js} +3 -3
- package/funcs/{campaignsSubscribeNewsletter.js.map → campaignsNewsletterSubscribe.js.map} +1 -1
- package/funcs/{catalogProductsCrossSellList.d.ts → catalogProductsGetCrossSells.d.ts} +2 -2
- package/funcs/{catalogProductsCrossSellList.d.ts.map → catalogProductsGetCrossSells.d.ts.map} +1 -1
- package/funcs/{catalogProductsCrossSellList.js → catalogProductsGetCrossSells.js} +3 -3
- package/funcs/{catalogProductsCrossSellList.js.map → catalogProductsGetCrossSells.js.map} +1 -1
- package/funcs/{catalogProductsSimilarList.d.ts → catalogProductsGetSimilar.d.ts} +2 -2
- package/funcs/catalogProductsGetSimilar.d.ts.map +1 -0
- package/funcs/{catalogProductsSimilarList.js → catalogProductsGetSimilar.js} +3 -3
- package/funcs/catalogProductsGetSimilar.js.map +1 -0
- package/funcs/{catalogProductsUpSellList.d.ts → catalogProductsGetUpsells.d.ts} +2 -2
- package/funcs/{catalogProductsUpSellList.d.ts.map → catalogProductsGetUpsells.d.ts.map} +1 -1
- package/funcs/{catalogProductsUpSellList.js → catalogProductsGetUpsells.js} +3 -3
- package/funcs/{catalogProductsUpSellList.js.map → catalogProductsGetUpsells.js.map} +1 -1
- package/funcs/{commonCountriesGetPincodes.d.ts → customersAddressesList.d.ts} +4 -4
- package/funcs/customersAddressesList.d.ts.map +1 -0
- package/funcs/{customersGetAddresses.js → customersAddressesList.js} +3 -3
- package/funcs/customersAddressesList.js.map +1 -0
- package/funcs/{catalogProductsRecommendedList.d.ts → customersGetRecommendedProducts.d.ts} +2 -2
- package/funcs/customersGetRecommendedProducts.d.ts.map +1 -0
- package/funcs/{catalogProductsRecommendedList.js → customersGetRecommendedProducts.js} +3 -3
- package/funcs/customersGetRecommendedProducts.js.map +1 -0
- package/funcs/{customersReviewsGetAll.d.ts → customersReviewsList.d.ts} +2 -2
- package/funcs/customersReviewsList.d.ts.map +1 -0
- package/funcs/{customersReviewsGetAll.js → customersReviewsList.js} +3 -3
- package/funcs/customersReviewsList.js.map +1 -0
- package/funcs/{offersGetCoupons.d.ts → offersCouponsList.d.ts} +2 -2
- package/funcs/offersCouponsList.d.ts.map +1 -0
- package/funcs/{offersGetCoupons.js → offersCouponsList.js} +3 -3
- package/funcs/{ordersGetReturns.js.map → offersCouponsList.js.map} +1 -1
- package/funcs/{offersGetPromotions.d.ts → offersPromotionsList.d.ts} +2 -2
- package/funcs/offersPromotionsList.d.ts.map +1 -0
- package/funcs/{offersGetPromotions.js → offersPromotionsList.js} +3 -3
- package/funcs/offersPromotionsList.js.map +1 -0
- package/funcs/{shippingGetPincodeServiceability.d.ts → shippingCheckPincodeServiceability.d.ts} +2 -2
- package/funcs/shippingCheckPincodeServiceability.d.ts.map +1 -0
- package/funcs/{shippingGetPincodeServiceability.js → shippingCheckPincodeServiceability.js} +3 -3
- package/funcs/shippingCheckPincodeServiceability.js.map +1 -0
- package/funcs/{authUserCreateNotificationPreferences.d.ts → userNotificationPreferencesCreate.d.ts} +2 -2
- package/funcs/userNotificationPreferencesCreate.d.ts.map +1 -0
- package/funcs/{authUserCreateNotificationPreferences.js → userNotificationPreferencesCreate.js} +3 -3
- package/funcs/userNotificationPreferencesCreate.js.map +1 -0
- package/funcs/{authUserGetNotificationPreferences.d.ts → userNotificationPreferencesGet.d.ts} +2 -2
- package/funcs/userNotificationPreferencesGet.d.ts.map +1 -0
- package/funcs/{authUserGetNotificationPreferences.js → userNotificationPreferencesGet.js} +3 -3
- package/funcs/userNotificationPreferencesGet.js.map +1 -0
- package/funcs/{authUserUpdateNotificationPreferences.d.ts → userNotificationPreferencesUpdate.d.ts} +2 -2
- package/funcs/userNotificationPreferencesUpdate.d.ts.map +1 -0
- package/funcs/{authUserUpdateNotificationPreferences.js → userNotificationPreferencesUpdate.js} +3 -3
- package/funcs/userNotificationPreferencesUpdate.js.map +1 -0
- package/funcs/{commonGetCountries.d.ts → utilsGetCountries.d.ts} +2 -2
- package/funcs/utilsGetCountries.d.ts.map +1 -0
- package/funcs/{commonGetCountries.js → utilsGetCountries.js} +3 -3
- package/funcs/utilsGetCountries.js.map +1 -0
- package/funcs/{customersGetAddresses.d.ts → utilsGetPincodes.d.ts} +4 -4
- package/funcs/utilsGetPincodes.d.ts.map +1 -0
- package/funcs/{commonCountriesGetPincodes.js → utilsGetPincodes.js} +3 -3
- package/funcs/utilsGetPincodes.js.map +1 -0
- package/funcs/{commonCountriesGetStates.d.ts → utilsGetStates.d.ts} +2 -2
- package/funcs/utilsGetStates.d.ts.map +1 -0
- package/funcs/{commonCountriesGetStates.js → utilsGetStates.js} +3 -3
- package/funcs/utilsGetStates.js.map +1 -0
- package/lib/config.d.ts +4 -4
- package/lib/config.d.ts.map +1 -1
- package/lib/config.js +3 -8
- package/lib/config.js.map +1 -1
- package/models/components/cartitem.js +4 -4
- package/models/components/cartitem.js.map +1 -1
- package/models/components/index.d.ts +0 -1
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +0 -1
- package/models/components/index.js.map +1 -1
- package/models/components/orderreturnitem.d.ts +0 -31
- package/models/components/orderreturnitem.d.ts.map +1 -1
- package/models/components/orderreturnitem.js +1 -42
- package/models/components/orderreturnitem.js.map +1 -1
- package/models/components/productattribute.js +1 -1
- package/models/components/productattribute.js.map +1 -1
- package/models/components/productdetail.js +5 -5
- package/models/components/productdetail.js.map +1 -1
- package/models/components/productlist.js +5 -5
- package/models/components/productlist.js.map +1 -1
- package/models/components/productreview.js +1 -1
- package/models/components/productreview.js.map +1 -1
- package/models/components/productshipping.js +2 -2
- package/models/components/productshipping.js.map +1 -1
- package/models/components/productsubscription.js +1 -1
- package/models/components/productsubscription.js.map +1 -1
- package/models/components/skuinfo.js +4 -4
- package/models/components/skuinfo.js.map +1 -1
- package/models/errors/unauthorized.js +1 -1
- package/models/errors/unauthorized.js.map +1 -1
- package/models/operations/index.d.ts +0 -3
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +0 -3
- package/models/operations/index.js.map +1 -1
- package/models/operations/postcartitemid.js +1 -1
- package/models/operations/postcartitemid.js.map +1 -1
- package/package.json +5 -1
- package/sdk/addresses.d.ts +7 -0
- package/sdk/addresses.d.ts.map +1 -1
- package/sdk/addresses.js +10 -0
- package/sdk/addresses.js.map +1 -1
- package/sdk/analytics.d.ts +1 -1
- package/sdk/analytics.d.ts.map +1 -1
- package/sdk/analytics.js +3 -3
- package/sdk/analytics.js.map +1 -1
- package/sdk/auth.d.ts +8 -14
- package/sdk/auth.d.ts.map +1 -1
- package/sdk/auth.js +12 -22
- package/sdk/auth.js.map +1 -1
- package/sdk/campaigns.d.ts +4 -9
- package/sdk/campaigns.d.ts.map +1 -1
- package/sdk/campaigns.js +4 -10
- package/sdk/campaigns.js.map +1 -1
- package/sdk/cestorefrontuser.d.ts +82 -0
- package/sdk/cestorefrontuser.d.ts.map +1 -0
- package/sdk/cestorefrontuser.js +122 -0
- package/sdk/cestorefrontuser.js.map +1 -0
- package/sdk/coupons.d.ts +12 -0
- package/sdk/coupons.d.ts.map +1 -0
- package/sdk/coupons.js +22 -0
- package/sdk/coupons.js.map +1 -0
- package/sdk/customers.d.ts +3 -3
- package/sdk/customers.d.ts.map +1 -1
- package/sdk/customers.js +5 -5
- package/sdk/customers.js.map +1 -1
- package/sdk/newsletter.d.ts +12 -0
- package/sdk/newsletter.d.ts.map +1 -0
- package/sdk/newsletter.js +22 -0
- package/sdk/newsletter.js.map +1 -0
- package/sdk/notificationpreferences.d.ts +26 -0
- package/sdk/notificationpreferences.d.ts.map +1 -0
- package/sdk/notificationpreferences.js +42 -0
- package/sdk/notificationpreferences.js.map +1 -0
- package/sdk/offers.d.ts +7 -16
- package/sdk/offers.d.ts.map +1 -1
- package/sdk/offers.js +8 -19
- package/sdk/offers.js.map +1 -1
- package/sdk/orders.d.ts +0 -7
- package/sdk/orders.d.ts.map +1 -1
- package/sdk/orders.js +0 -10
- package/sdk/orders.js.map +1 -1
- package/sdk/products.d.ts +21 -12
- package/sdk/products.d.ts.map +1 -1
- package/sdk/products.js +30 -20
- package/sdk/products.js.map +1 -1
- package/sdk/promotions.d.ts +12 -0
- package/sdk/promotions.d.ts.map +1 -0
- package/sdk/promotions.js +22 -0
- package/sdk/promotions.js.map +1 -0
- package/sdk/returns.d.ts +0 -14
- package/sdk/returns.d.ts.map +1 -1
- package/sdk/returns.js +0 -20
- package/sdk/returns.js.map +1 -1
- package/sdk/reviews.d.ts +1 -1
- package/sdk/reviews.d.ts.map +1 -1
- package/sdk/reviews.js +3 -3
- package/sdk/reviews.js.map +1 -1
- package/sdk/sdk.d.ts +8 -5
- package/sdk/sdk.d.ts.map +1 -1
- package/sdk/sdk.js +12 -7
- package/sdk/sdk.js.map +1 -1
- package/sdk/shipping.d.ts +1 -1
- package/sdk/shipping.d.ts.map +1 -1
- package/sdk/shipping.js +3 -3
- package/sdk/shipping.js.map +1 -1
- package/sdk/user.d.ts +4 -86
- package/sdk/user.d.ts.map +1 -1
- package/sdk/user.js +4 -120
- package/sdk/user.js.map +1 -1
- package/sdk/{countries.d.ts → utils.d.ts} +9 -2
- package/sdk/utils.d.ts.map +1 -0
- package/sdk/utils.js +42 -0
- package/sdk/utils.js.map +1 -0
- package/src/funcs/{analyticsTrackEvent.ts → analyticsTrack.ts} +1 -1
- package/src/funcs/{authOtpGenerate.ts → authGenerateOtp.ts} +1 -1
- package/src/funcs/{authTokenRefresh.ts → authRefreshToken.ts} +1 -1
- package/src/funcs/{authGetUser.ts → authUserGet.ts} +1 -1
- package/src/funcs/{authUpdateUser.ts → authUserUpdate.ts} +1 -1
- package/src/funcs/{campaignsSubscribeNewsletter.ts → campaignsNewsletterSubscribe.ts} +1 -1
- package/src/funcs/{catalogProductsCrossSellList.ts → catalogProductsGetCrossSells.ts} +1 -1
- package/src/funcs/{catalogProductsSimilarList.ts → catalogProductsGetSimilar.ts} +1 -1
- package/src/funcs/{catalogProductsUpSellList.ts → catalogProductsGetUpsells.ts} +1 -1
- package/src/funcs/{customersGetAddresses.ts → customersAddressesList.ts} +1 -1
- package/src/funcs/{catalogProductsRecommendedList.ts → customersGetRecommendedProducts.ts} +1 -1
- package/src/funcs/{customersReviewsGetAll.ts → customersReviewsList.ts} +1 -1
- package/src/funcs/{offersGetCoupons.ts → offersCouponsList.ts} +1 -1
- package/src/funcs/{offersGetPromotions.ts → offersPromotionsList.ts} +1 -1
- package/src/funcs/{shippingGetPincodeServiceability.ts → shippingCheckPincodeServiceability.ts} +1 -1
- package/src/funcs/{authUserCreateNotificationPreferences.ts → userNotificationPreferencesCreate.ts} +1 -1
- package/src/funcs/{authUserGetNotificationPreferences.ts → userNotificationPreferencesGet.ts} +1 -1
- package/src/funcs/{authUserUpdateNotificationPreferences.ts → userNotificationPreferencesUpdate.ts} +1 -1
- package/src/funcs/{commonGetCountries.ts → utilsGetCountries.ts} +1 -1
- package/src/funcs/{commonCountriesGetPincodes.ts → utilsGetPincodes.ts} +1 -1
- package/src/funcs/{commonCountriesGetStates.ts → utilsGetStates.ts} +1 -1
- package/src/lib/config.ts +3 -8
- package/src/models/components/cartitem.ts +4 -4
- package/src/models/components/index.ts +0 -1
- package/src/models/components/orderreturnitem.ts +0 -70
- package/src/models/components/productattribute.ts +1 -1
- package/src/models/components/productdetail.ts +5 -5
- package/src/models/components/productlist.ts +5 -5
- package/src/models/components/productreview.ts +1 -1
- package/src/models/components/productshipping.ts +2 -2
- package/src/models/components/productsubscription.ts +1 -1
- package/src/models/components/skuinfo.ts +4 -4
- package/src/models/errors/unauthorized.ts +1 -1
- package/src/models/operations/index.ts +0 -3
- package/src/models/operations/postcartitemid.ts +1 -1
- package/src/sdk/addresses.ts +14 -0
- package/src/sdk/analytics.ts +3 -3
- package/src/sdk/auth.ts +18 -30
- package/src/sdk/campaigns.ts +5 -15
- package/src/sdk/cestorefrontuser.ts +160 -0
- package/src/sdk/coupons.ts +20 -0
- package/src/sdk/customers.ts +6 -7
- package/src/sdk/newsletter.ts +23 -0
- package/src/sdk/notificationpreferences.ts +51 -0
- package/src/sdk/offers.ts +9 -21
- package/src/sdk/orders.ts +0 -11
- package/src/sdk/products.ts +42 -24
- package/src/sdk/promotions.ts +20 -0
- package/src/sdk/returns.ts +0 -28
- package/src/sdk/reviews.ts +3 -3
- package/src/sdk/sdk.ts +15 -9
- package/src/sdk/shipping.ts +3 -3
- package/src/sdk/user.ts +5 -166
- package/src/sdk/{countries.ts → utils.ts} +18 -5
- package/docs/sdks/crosssell/README.md +0 -82
- package/docs/sdks/similar/README.md +0 -82
- package/docs/sdks/token/README.md +0 -80
- package/docs/sdks/upsell/README.md +0 -82
- package/funcs/analyticsTrackEvent.d.ts.map +0 -1
- package/funcs/analyticsTrackEvent.js.map +0 -1
- package/funcs/authUserCreateNotificationPreferences.d.ts.map +0 -1
- package/funcs/authUserCreateNotificationPreferences.js.map +0 -1
- package/funcs/authUserGetNotificationPreferences.d.ts.map +0 -1
- package/funcs/authUserGetNotificationPreferences.js.map +0 -1
- package/funcs/authUserUpdateNotificationPreferences.d.ts.map +0 -1
- package/funcs/authUserUpdateNotificationPreferences.js.map +0 -1
- package/funcs/catalogProductsRecommendedList.d.ts.map +0 -1
- package/funcs/catalogProductsRecommendedList.js.map +0 -1
- package/funcs/catalogProductsSimilarList.d.ts.map +0 -1
- package/funcs/catalogProductsSimilarList.js.map +0 -1
- package/funcs/commonCountriesGetPincodes.d.ts.map +0 -1
- package/funcs/commonCountriesGetPincodes.js.map +0 -1
- package/funcs/commonCountriesGetStates.d.ts.map +0 -1
- package/funcs/commonCountriesGetStates.js.map +0 -1
- package/funcs/commonGetCountries.d.ts.map +0 -1
- package/funcs/commonGetCountries.js.map +0 -1
- package/funcs/customersGetAddresses.d.ts.map +0 -1
- package/funcs/customersGetAddresses.js.map +0 -1
- package/funcs/customersReviewsGetAll.d.ts.map +0 -1
- package/funcs/customersReviewsGetAll.js.map +0 -1
- package/funcs/offersGetCoupons.d.ts.map +0 -1
- package/funcs/offersGetCoupons.js.map +0 -1
- package/funcs/offersGetPromotions.d.ts.map +0 -1
- package/funcs/offersGetPromotions.js.map +0 -1
- package/funcs/ordersGetReturns.d.ts +0 -15
- package/funcs/ordersGetReturns.d.ts.map +0 -1
- package/funcs/ordersGetReturns.js +0 -80
- package/funcs/ordersReturnsCreate.d.ts +0 -16
- package/funcs/ordersReturnsCreate.d.ts.map +0 -1
- package/funcs/ordersReturnsCreate.js +0 -101
- package/funcs/ordersReturnsCreate.js.map +0 -1
- package/funcs/ordersReturnsGet.d.ts +0 -15
- package/funcs/ordersReturnsGet.d.ts.map +0 -1
- package/funcs/ordersReturnsGet.js +0 -100
- package/funcs/ordersReturnsGet.js.map +0 -1
- package/funcs/shippingGetPincodeServiceability.d.ts.map +0 -1
- package/funcs/shippingGetPincodeServiceability.js.map +0 -1
- package/models/components/createorderreturn.d.ts +0 -29
- package/models/components/createorderreturn.d.ts.map +0 -1
- package/models/components/createorderreturn.js +0 -69
- package/models/components/createorderreturn.js.map +0 -1
- package/models/operations/getordersordernumberreturnreturnid.d.ts +0 -87
- package/models/operations/getordersordernumberreturnreturnid.d.ts.map +0 -1
- package/models/operations/getordersordernumberreturnreturnid.js +0 -122
- package/models/operations/getordersordernumberreturnreturnid.js.map +0 -1
- package/models/operations/getordersreturns.d.ts +0 -56
- package/models/operations/getordersreturns.d.ts.map +0 -1
- package/models/operations/getordersreturns.js +0 -74
- package/models/operations/getordersreturns.js.map +0 -1
- package/models/operations/postordersordernumberreturn.d.ts +0 -84
- package/models/operations/postordersordernumberreturn.d.ts.map +0 -1
- package/models/operations/postordersordernumberreturn.js +0 -122
- package/models/operations/postordersordernumberreturn.js.map +0 -1
- package/sdk/common.d.ts +0 -15
- package/sdk/common.d.ts.map +0 -1
- package/sdk/common.js +0 -27
- package/sdk/common.js.map +0 -1
- package/sdk/countries.d.ts.map +0 -1
- package/sdk/countries.js +0 -32
- package/sdk/countries.js.map +0 -1
- package/sdk/crosssell.d.ts +0 -12
- package/sdk/crosssell.d.ts.map +0 -1
- package/sdk/crosssell.js +0 -22
- package/sdk/crosssell.js.map +0 -1
- package/sdk/otp.d.ts +0 -12
- package/sdk/otp.d.ts.map +0 -1
- package/sdk/otp.js +0 -22
- package/sdk/otp.js.map +0 -1
- package/sdk/recommended.d.ts +0 -12
- package/sdk/recommended.d.ts.map +0 -1
- package/sdk/recommended.js +0 -22
- package/sdk/recommended.js.map +0 -1
- package/sdk/similar.d.ts +0 -12
- package/sdk/similar.d.ts.map +0 -1
- package/sdk/similar.js +0 -22
- package/sdk/similar.js.map +0 -1
- package/sdk/token.d.ts +0 -12
- package/sdk/token.d.ts.map +0 -1
- package/sdk/token.js +0 -22
- package/sdk/token.js.map +0 -1
- package/sdk/upsell.d.ts +0 -12
- package/sdk/upsell.d.ts.map +0 -1
- package/sdk/upsell.js +0 -22
- package/sdk/upsell.js.map +0 -1
- package/src/funcs/ordersGetReturns.ts +0 -103
- package/src/funcs/ordersReturnsCreate.ts +0 -139
- package/src/funcs/ordersReturnsGet.ts +0 -132
- package/src/models/components/createorderreturn.ts +0 -73
- package/src/models/operations/getordersordernumberreturnreturnid.ts +0 -174
- package/src/models/operations/getordersreturns.ts +0 -97
- package/src/models/operations/postordersordernumberreturn.ts +0 -171
- package/src/sdk/common.ts +0 -28
- package/src/sdk/crosssell.ts +0 -23
- package/src/sdk/otp.ts +0 -23
- package/src/sdk/recommended.ts +0 -20
- package/src/sdk/similar.ts +0 -23
- package/src/sdk/token.ts +0 -23
- package/src/sdk/upsell.ts +0 -23
package/.devcontainer/README.md
CHANGED
|
@@ -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
|
|
9
|
+
npm add ce-storefront
|
|
26
10
|
```
|
|
27
11
|
|
|
28
12
|
### PNPM
|
|
29
13
|
|
|
30
14
|
```bash
|
|
31
|
-
pnpm add
|
|
15
|
+
pnpm add ce-storefront
|
|
32
16
|
```
|
|
33
17
|
|
|
34
18
|
### Bun
|
|
35
19
|
|
|
36
20
|
```bash
|
|
37
|
-
bun add
|
|
21
|
+
bun add ce-storefront
|
|
38
22
|
```
|
|
39
23
|
|
|
40
24
|
### Yarn
|
|
41
25
|
|
|
42
26
|
```bash
|
|
43
|
-
yarn add
|
|
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,29 +84,34 @@ 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.
|
|
87
|
+
### [catalog.skus](docs/sdks/skus/README.md)
|
|
101
88
|
|
|
102
|
-
* [list](docs/sdks/
|
|
89
|
+
* [list](docs/sdks/skus/README.md#list) - List all SKUs
|
|
103
90
|
|
|
104
|
-
### [catalog.
|
|
91
|
+
### [catalog.categories](docs/sdks/categories/README.md)
|
|
105
92
|
|
|
106
|
-
* [list](docs/sdks/
|
|
93
|
+
* [list](docs/sdks/categories/README.md#list) - List all categories
|
|
107
94
|
|
|
108
|
-
### [
|
|
95
|
+
### [customers](docs/sdks/customers/README.md)
|
|
109
96
|
|
|
110
|
-
* [
|
|
97
|
+
* [getRecommendedProducts](docs/sdks/customers/README.md#getrecommendedproducts) - Retrieve recommended products
|
|
111
98
|
|
|
112
|
-
### [
|
|
99
|
+
### [customers.addresses](docs/sdks/addresses/README.md)
|
|
113
100
|
|
|
114
|
-
* [list](docs/sdks/
|
|
101
|
+
* [list](docs/sdks/addresses/README.md#list) - Retrieve all addresses
|
|
102
|
+
* [add](docs/sdks/addresses/README.md#add) - Add address
|
|
103
|
+
* [get](docs/sdks/addresses/README.md#get) - Retrieve particular address
|
|
104
|
+
* [update](docs/sdks/addresses/README.md#update) - Update particular address
|
|
105
|
+
* [delete](docs/sdks/addresses/README.md#delete) - Remove particular address
|
|
115
106
|
|
|
116
|
-
### [
|
|
107
|
+
### [customers.loyalty](docs/sdks/loyalty/README.md)
|
|
117
108
|
|
|
118
|
-
* [
|
|
109
|
+
* [get](docs/sdks/loyalty/README.md#get) - Retrieve loyalty details
|
|
110
|
+
* [listActivities](docs/sdks/loyalty/README.md#listactivities) - List all loyalty points activity
|
|
119
111
|
|
|
120
|
-
### [
|
|
112
|
+
### [customers.reviews](docs/sdks/reviews/README.md)
|
|
121
113
|
|
|
122
|
-
* [list](docs/sdks/
|
|
114
|
+
* [list](docs/sdks/reviews/README.md#list) - Retrieve all reviews
|
|
123
115
|
|
|
124
116
|
### [carts](docs/sdks/carts/README.md)
|
|
125
117
|
|
|
@@ -139,10 +131,14 @@ run();
|
|
|
139
131
|
* [removeCreditBalance](docs/sdks/checkout/README.md#removecreditbalance) - Remove credit balance
|
|
140
132
|
* [redeemGiftCard](docs/sdks/checkout/README.md#redeemgiftcard) - Redeem gift card
|
|
141
133
|
|
|
142
|
-
### [offers](docs/sdks/offers/README.md)
|
|
143
134
|
|
|
144
|
-
|
|
145
|
-
|
|
135
|
+
### [offers.coupons](docs/sdks/coupons/README.md)
|
|
136
|
+
|
|
137
|
+
* [list](docs/sdks/coupons/README.md#list) - Retrieve all coupons
|
|
138
|
+
|
|
139
|
+
### [offers.promotions](docs/sdks/promotions/README.md)
|
|
140
|
+
|
|
141
|
+
* [list](docs/sdks/promotions/README.md#list) - Retrieve all promotions
|
|
146
142
|
|
|
147
143
|
### [wishlist](docs/sdks/wishlist/README.md)
|
|
148
144
|
|
|
@@ -150,26 +146,6 @@ run();
|
|
|
150
146
|
* [add](docs/sdks/wishlist/README.md#add) - Add product to wishlist
|
|
151
147
|
* [delete](docs/sdks/wishlist/README.md#delete) - Delete product from wishlist
|
|
152
148
|
|
|
153
|
-
### [customers](docs/sdks/customers/README.md)
|
|
154
|
-
|
|
155
|
-
* [getAddresses](docs/sdks/customers/README.md#getaddresses) - Retrieve all addresses
|
|
156
|
-
|
|
157
|
-
### [customers.addresses](docs/sdks/addresses/README.md)
|
|
158
|
-
|
|
159
|
-
* [add](docs/sdks/addresses/README.md#add) - Add address
|
|
160
|
-
* [get](docs/sdks/addresses/README.md#get) - Retrieve particular address
|
|
161
|
-
* [update](docs/sdks/addresses/README.md#update) - Update particular address
|
|
162
|
-
* [delete](docs/sdks/addresses/README.md#delete) - Remove particular address
|
|
163
|
-
|
|
164
|
-
### [customers.loyalty](docs/sdks/loyalty/README.md)
|
|
165
|
-
|
|
166
|
-
* [get](docs/sdks/loyalty/README.md#get) - Retrieve loyalty details
|
|
167
|
-
* [listActivities](docs/sdks/loyalty/README.md#listactivities) - List all loyalty points activity
|
|
168
|
-
|
|
169
|
-
### [customers.reviews](docs/sdks/reviews/README.md)
|
|
170
|
-
|
|
171
|
-
* [getAll](docs/sdks/reviews/README.md#getall) - Retrieve all reviews
|
|
172
|
-
|
|
173
149
|
### [orders](docs/sdks/orders/README.md)
|
|
174
150
|
|
|
175
151
|
* [create](docs/sdks/orders/README.md#create) - Create order
|
|
@@ -177,7 +153,6 @@ run();
|
|
|
177
153
|
* [get](docs/sdks/orders/README.md#get) - Retrieve order detail
|
|
178
154
|
* [cancel](docs/sdks/orders/README.md#cancel) - Cancel order
|
|
179
155
|
* [retryPayment](docs/sdks/orders/README.md#retrypayment) - Retry payment
|
|
180
|
-
* [getReturns](docs/sdks/orders/README.md#getreturns) - Retrieve all order returns
|
|
181
156
|
|
|
182
157
|
### [orders.shipments](docs/sdks/shipments/README.md)
|
|
183
158
|
|
|
@@ -193,13 +168,11 @@ run();
|
|
|
193
168
|
|
|
194
169
|
### [orders.returns](docs/sdks/returns/README.md)
|
|
195
170
|
|
|
196
|
-
* [create](docs/sdks/returns/README.md#create) - Create order return
|
|
197
171
|
* [list](docs/sdks/returns/README.md#list) - List all order returns
|
|
198
|
-
* [get](docs/sdks/returns/README.md#get) - Retrieve order return detail
|
|
199
172
|
|
|
200
173
|
### [shipping](docs/sdks/shipping/README.md)
|
|
201
174
|
|
|
202
|
-
* [
|
|
175
|
+
* [checkPincodeServiceability](docs/sdks/shipping/README.md#checkpincodeserviceability) - Check pincode serviceability
|
|
203
176
|
|
|
204
177
|
### [auth](docs/sdks/auth/README.md)
|
|
205
178
|
|
|
@@ -212,54 +185,50 @@ run();
|
|
|
212
185
|
* [registerWithEmail](docs/sdks/auth/README.md#registerwithemail) - Register with email
|
|
213
186
|
* [registerWithWhatsapp](docs/sdks/auth/README.md#registerwithwhatsapp) - Register with whatsapp
|
|
214
187
|
* [registerWithPassword](docs/sdks/auth/README.md#registerwithpassword) - Register with password
|
|
215
|
-
* [
|
|
216
|
-
* [
|
|
188
|
+
* [refreshToken](docs/sdks/auth/README.md#refreshtoken) - Refresh access token
|
|
189
|
+
* [generateOtp](docs/sdks/auth/README.md#generateotp) - Generate OTP
|
|
217
190
|
* [verifyEmailPhone](docs/sdks/auth/README.md#verifyemailphone) - Check verified email phone
|
|
218
191
|
|
|
219
|
-
### [auth.user](docs/sdks/
|
|
220
|
-
|
|
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
|
+
### [auth.user](docs/sdks/cestorefrontuser/README.md)
|
|
233
193
|
|
|
234
|
-
|
|
194
|
+
* [get](docs/sdks/cestorefrontuser/README.md#get) - Retrieve a user
|
|
195
|
+
* [update](docs/sdks/cestorefrontuser/README.md#update) - Update a user
|
|
196
|
+
* [addProfileImage](docs/sdks/cestorefrontuser/README.md#addprofileimage) - Add profile image
|
|
197
|
+
* [updateProfileImage](docs/sdks/cestorefrontuser/README.md#updateprofileimage) - Update profile image
|
|
198
|
+
* [deleteProfileImage](docs/sdks/cestorefrontuser/README.md#deleteprofileimage) - Delete profile image
|
|
199
|
+
* [getProfileImage](docs/sdks/cestorefrontuser/README.md#getprofileimage) - Retrieve a profile image
|
|
200
|
+
* [deactivateAccount](docs/sdks/cestorefrontuser/README.md#deactivateaccount) - Deactivate account
|
|
201
|
+
* [changePassword](docs/sdks/cestorefrontuser/README.md#changepassword) - Change password
|
|
202
|
+
* [forgotPassword](docs/sdks/cestorefrontuser/README.md#forgotpassword) - Forgot password
|
|
203
|
+
* [resetPassword](docs/sdks/cestorefrontuser/README.md#resetpassword) - Reset password
|
|
204
|
+
* [logout](docs/sdks/cestorefrontuser/README.md#logout) - Logout user
|
|
235
205
|
|
|
236
|
-
* [refresh](docs/sdks/token/README.md#refresh) - Refresh access token
|
|
237
206
|
|
|
238
|
-
### [
|
|
207
|
+
### [user.notificationPreferences](docs/sdks/notificationpreferences/README.md)
|
|
239
208
|
|
|
240
|
-
* [
|
|
209
|
+
* [get](docs/sdks/notificationpreferences/README.md#get) - Retrieve user notification preferences
|
|
210
|
+
* [create](docs/sdks/notificationpreferences/README.md#create) - Create user notification preferences
|
|
211
|
+
* [update](docs/sdks/notificationpreferences/README.md#update) - Update user notification preferences
|
|
241
212
|
|
|
242
213
|
### [payments](docs/sdks/payments/README.md)
|
|
243
214
|
|
|
244
215
|
* [generateHash](docs/sdks/payments/README.md#generatehash) - Generate hash
|
|
245
216
|
* [getMethods](docs/sdks/payments/README.md#getmethods) - Retrieve available payment methods
|
|
246
217
|
|
|
247
|
-
### [
|
|
248
|
-
|
|
249
|
-
* [getCountries](docs/sdks/common/README.md#getcountries) - Retrieve all countries
|
|
218
|
+
### [utils](docs/sdks/utils/README.md)
|
|
250
219
|
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
* [
|
|
254
|
-
* [getPincodes](docs/sdks/countries/README.md#getpincodes) - Retrieve pincodes
|
|
220
|
+
* [getCountries](docs/sdks/utils/README.md#getcountries) - Retrieve all countries
|
|
221
|
+
* [getStates](docs/sdks/utils/README.md#getstates) - Retrieve country wise states
|
|
222
|
+
* [getPincodes](docs/sdks/utils/README.md#getpincodes) - Retrieve pincodes
|
|
255
223
|
|
|
256
224
|
### [analytics](docs/sdks/analytics/README.md)
|
|
257
225
|
|
|
258
|
-
* [
|
|
226
|
+
* [track](docs/sdks/analytics/README.md#track) - Track event
|
|
227
|
+
|
|
259
228
|
|
|
260
|
-
### [campaigns](docs/sdks/
|
|
229
|
+
### [campaigns.newsletter](docs/sdks/newsletter/README.md)
|
|
261
230
|
|
|
262
|
-
* [
|
|
231
|
+
* [subscribe](docs/sdks/newsletter/README.md#subscribe) - Subscribe to newsletter
|
|
263
232
|
<!-- End Available Resources and Operations [operations] -->
|
|
264
233
|
|
|
265
234
|
<!-- Start Standalone functions [standalone-funcs] -->
|
|
@@ -277,47 +246,43 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
277
246
|
|
|
278
247
|
<summary>Available standalone functions</summary>
|
|
279
248
|
|
|
280
|
-
- [
|
|
281
|
-
- [
|
|
249
|
+
- [analyticsTrack](docs/sdks/analytics/README.md#track)
|
|
250
|
+
- [authGenerateOtp](docs/sdks/auth/README.md#generateotp)
|
|
282
251
|
- [authLoginWithEmail](docs/sdks/auth/README.md#loginwithemail)
|
|
283
252
|
- [authLoginWithPassword](docs/sdks/auth/README.md#loginwithpassword)
|
|
284
253
|
- [authLoginWithPhone](docs/sdks/auth/README.md#loginwithphone)
|
|
285
254
|
- [authLoginWithWhatsapp](docs/sdks/auth/README.md#loginwithwhatsapp)
|
|
286
|
-
- [
|
|
255
|
+
- [authRefreshToken](docs/sdks/auth/README.md#refreshtoken)
|
|
287
256
|
- [authRegisterWithEmail](docs/sdks/auth/README.md#registerwithemail)
|
|
288
257
|
- [authRegisterWithPassword](docs/sdks/auth/README.md#registerwithpassword)
|
|
289
258
|
- [authRegisterWithPhone](docs/sdks/auth/README.md#registerwithphone)
|
|
290
259
|
- [authRegisterWithWhatsapp](docs/sdks/auth/README.md#registerwithwhatsapp)
|
|
291
|
-
- [
|
|
292
|
-
- [
|
|
293
|
-
- [
|
|
294
|
-
- [
|
|
295
|
-
- [
|
|
296
|
-
- [
|
|
297
|
-
- [
|
|
298
|
-
- [
|
|
299
|
-
- [
|
|
300
|
-
- [
|
|
301
|
-
- [
|
|
302
|
-
- [authUserResetPassword](docs/sdks/user/README.md#resetpassword)
|
|
303
|
-
- [authUserUpdateNotificationPreferences](docs/sdks/user/README.md#updatenotificationpreferences)
|
|
304
|
-
- [authUserUpdateProfileImage](docs/sdks/user/README.md#updateprofileimage)
|
|
260
|
+
- [authUserAddProfileImage](docs/sdks/cestorefrontuser/README.md#addprofileimage)
|
|
261
|
+
- [authUserChangePassword](docs/sdks/cestorefrontuser/README.md#changepassword)
|
|
262
|
+
- [authUserDeactivateAccount](docs/sdks/cestorefrontuser/README.md#deactivateaccount)
|
|
263
|
+
- [authUserDeleteProfileImage](docs/sdks/cestorefrontuser/README.md#deleteprofileimage)
|
|
264
|
+
- [authUserForgotPassword](docs/sdks/cestorefrontuser/README.md#forgotpassword)
|
|
265
|
+
- [authUserGetProfileImage](docs/sdks/cestorefrontuser/README.md#getprofileimage)
|
|
266
|
+
- [authUserGet](docs/sdks/cestorefrontuser/README.md#get)
|
|
267
|
+
- [authUserLogout](docs/sdks/cestorefrontuser/README.md#logout)
|
|
268
|
+
- [authUserResetPassword](docs/sdks/cestorefrontuser/README.md#resetpassword)
|
|
269
|
+
- [authUserUpdateProfileImage](docs/sdks/cestorefrontuser/README.md#updateprofileimage)
|
|
270
|
+
- [authUserUpdate](docs/sdks/cestorefrontuser/README.md#update)
|
|
305
271
|
- [authVerifyEmailPhone](docs/sdks/auth/README.md#verifyemailphone)
|
|
306
272
|
- [authVerifyOtp](docs/sdks/auth/README.md#verifyotp)
|
|
307
|
-
- [
|
|
273
|
+
- [campaignsNewsletterSubscribe](docs/sdks/newsletter/README.md#subscribe)
|
|
308
274
|
- [cartsAddItem](docs/sdks/carts/README.md#additem)
|
|
309
275
|
- [cartsCreate](docs/sdks/carts/README.md#create)
|
|
310
276
|
- [cartsDelete](docs/sdks/carts/README.md#delete)
|
|
311
277
|
- [cartsGet](docs/sdks/carts/README.md#get)
|
|
312
278
|
- [catalogCategoriesList](docs/sdks/categories/README.md#list)
|
|
313
|
-
- [
|
|
279
|
+
- [catalogProductsGetCrossSells](docs/sdks/products/README.md#getcrosssells)
|
|
280
|
+
- [catalogProductsGetSimilar](docs/sdks/products/README.md#getsimilar)
|
|
281
|
+
- [catalogProductsGetUpsells](docs/sdks/products/README.md#getupsells)
|
|
314
282
|
- [catalogProductsGet](docs/sdks/products/README.md#get)
|
|
315
283
|
- [catalogProductsList](docs/sdks/products/README.md#list)
|
|
316
|
-
- [catalogProductsRecommendedList](docs/sdks/recommended/README.md#list)
|
|
317
284
|
- [catalogProductsReviewsCreate](docs/sdks/cestorefrontreviews/README.md#create)
|
|
318
285
|
- [catalogProductsReviewsList](docs/sdks/cestorefrontreviews/README.md#list)
|
|
319
|
-
- [catalogProductsSimilarList](docs/sdks/similar/README.md#list)
|
|
320
|
-
- [catalogProductsUpSellList](docs/sdks/upsell/README.md#list)
|
|
321
286
|
- [catalogProductsVariantsGet](docs/sdks/variants/README.md#get)
|
|
322
287
|
- [catalogProductsVariantsList](docs/sdks/variants/README.md#list)
|
|
323
288
|
- [catalogSkusList](docs/sdks/skus/README.md#list)
|
|
@@ -329,34 +294,35 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
|
|
|
329
294
|
- [checkoutRemoveLoyaltyPoints](docs/sdks/checkout/README.md#removeloyaltypoints)
|
|
330
295
|
- [checkoutUpdateAddress](docs/sdks/checkout/README.md#updateaddress)
|
|
331
296
|
- [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)
|
|
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
|
-
- [
|
|
302
|
+
- [customersGetRecommendedProducts](docs/sdks/customers/README.md#getrecommendedproducts)
|
|
340
303
|
- [customersLoyaltyGet](docs/sdks/loyalty/README.md#get)
|
|
341
304
|
- [customersLoyaltyListActivities](docs/sdks/loyalty/README.md#listactivities)
|
|
342
|
-
- [
|
|
343
|
-
- [
|
|
344
|
-
- [
|
|
305
|
+
- [customersReviewsList](docs/sdks/reviews/README.md#list)
|
|
306
|
+
- [offersCouponsList](docs/sdks/coupons/README.md#list)
|
|
307
|
+
- [offersPromotionsList](docs/sdks/promotions/README.md#list)
|
|
345
308
|
- [ordersCancel](docs/sdks/orders/README.md#cancel)
|
|
346
309
|
- [ordersCreate](docs/sdks/orders/README.md#create)
|
|
347
|
-
- [ordersGetReturns](docs/sdks/orders/README.md#getreturns)
|
|
348
310
|
- [ordersGet](docs/sdks/orders/README.md#get)
|
|
349
311
|
- [ordersList](docs/sdks/orders/README.md#list)
|
|
350
312
|
- [ordersPaymentsList](docs/sdks/cestorefrontpayments/README.md#list)
|
|
351
313
|
- [ordersRefundsList](docs/sdks/refunds/README.md#list)
|
|
352
314
|
- [ordersRetryPayment](docs/sdks/orders/README.md#retrypayment)
|
|
353
|
-
- [ordersReturnsCreate](docs/sdks/returns/README.md#create)
|
|
354
|
-
- [ordersReturnsGet](docs/sdks/returns/README.md#get)
|
|
355
315
|
- [ordersReturnsList](docs/sdks/returns/README.md#list)
|
|
356
316
|
- [ordersShipmentsList](docs/sdks/shipments/README.md#list)
|
|
357
317
|
- [paymentsGenerateHash](docs/sdks/payments/README.md#generatehash)
|
|
358
318
|
- [paymentsGetMethods](docs/sdks/payments/README.md#getmethods)
|
|
359
|
-
- [
|
|
319
|
+
- [shippingCheckPincodeServiceability](docs/sdks/shipping/README.md#checkpincodeserviceability)
|
|
320
|
+
- [userNotificationPreferencesCreate](docs/sdks/notificationpreferences/README.md#create)
|
|
321
|
+
- [userNotificationPreferencesGet](docs/sdks/notificationpreferences/README.md#get)
|
|
322
|
+
- [userNotificationPreferencesUpdate](docs/sdks/notificationpreferences/README.md#update)
|
|
323
|
+
- [utilsGetCountries](docs/sdks/utils/README.md#getcountries)
|
|
324
|
+
- [utilsGetPincodes](docs/sdks/utils/README.md#getpincodes)
|
|
325
|
+
- [utilsGetStates](docs/sdks/utils/README.md#getstates)
|
|
360
326
|
- [wishlistAdd](docs/sdks/wishlist/README.md#add)
|
|
361
327
|
- [wishlistDelete](docs/sdks/wishlist/README.md#delete)
|
|
362
328
|
- [wishlistGet](docs/sdks/wishlist/README.md#get)
|
|
@@ -543,13 +509,12 @@ You can override the default server globally by passing a server index to the `s
|
|
|
543
509
|
| - | ------ | --------- |
|
|
544
510
|
| 0 | `https://staging.api.commercengine.io/api/v1/{store_id}/storefront` | `store_id` (default is `x2yh61zw4k`) |
|
|
545
511
|
| 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
512
|
|
|
548
513
|
```typescript
|
|
549
514
|
import { CeStorefront } from "ce-storefront";
|
|
550
515
|
|
|
551
516
|
const ceStorefront = new CeStorefront({
|
|
552
|
-
serverIdx:
|
|
517
|
+
serverIdx: 1,
|
|
553
518
|
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
554
519
|
});
|
|
555
520
|
|
|
@@ -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
|
-
* [
|
|
8
|
+
* [track](#track) - Track event
|
|
9
9
|
|
|
10
|
-
##
|
|
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.
|
|
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 {
|
|
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
|
|
48
|
+
const res = await analyticsTrack(ceStorefront);
|
|
49
49
|
|
|
50
50
|
if (!res.ok) {
|
|
51
51
|
throw res.error;
|