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
|
@@ -10,7 +10,6 @@
|
|
|
10
10
|
* [get](#get) - Retrieve order detail
|
|
11
11
|
* [cancel](#cancel) - Cancel order
|
|
12
12
|
* [retryPayment](#retrypayment) - Retry payment
|
|
13
|
-
* [getReturns](#getreturns) - Retrieve all order returns
|
|
14
13
|
|
|
15
14
|
## create
|
|
16
15
|
|
|
@@ -400,75 +399,3 @@ run();
|
|
|
400
399
|
| Error Object | Status Code | Content Type |
|
|
401
400
|
| --------------- | --------------- | --------------- |
|
|
402
401
|
| errors.SDKError | 4xx-5xx | */* |
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
## getReturns
|
|
406
|
-
|
|
407
|
-
Retrieve all order returns
|
|
408
|
-
|
|
409
|
-
### Example Usage
|
|
410
|
-
|
|
411
|
-
```typescript
|
|
412
|
-
import { CeStorefront } from "ce-storefront";
|
|
413
|
-
|
|
414
|
-
const ceStorefront = new CeStorefront({
|
|
415
|
-
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
416
|
-
});
|
|
417
|
-
|
|
418
|
-
async function run() {
|
|
419
|
-
const result = await ceStorefront.orders.getReturns();
|
|
420
|
-
|
|
421
|
-
// Handle the result
|
|
422
|
-
console.log(result)
|
|
423
|
-
}
|
|
424
|
-
|
|
425
|
-
run();
|
|
426
|
-
```
|
|
427
|
-
|
|
428
|
-
### Standalone function
|
|
429
|
-
|
|
430
|
-
The standalone function version of this method:
|
|
431
|
-
|
|
432
|
-
```typescript
|
|
433
|
-
import { CeStorefrontCore } from "ce-storefront/core.js";
|
|
434
|
-
import { ordersGetReturns } from "ce-storefront/funcs/ordersGetReturns.js";
|
|
435
|
-
|
|
436
|
-
// Use `CeStorefrontCore` for best tree-shaking performance.
|
|
437
|
-
// You can create one instance of it to use across an application.
|
|
438
|
-
const ceStorefront = new CeStorefrontCore({
|
|
439
|
-
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
440
|
-
});
|
|
441
|
-
|
|
442
|
-
async function run() {
|
|
443
|
-
const res = await ordersGetReturns(ceStorefront);
|
|
444
|
-
|
|
445
|
-
if (!res.ok) {
|
|
446
|
-
throw res.error;
|
|
447
|
-
}
|
|
448
|
-
|
|
449
|
-
const { value: result } = res;
|
|
450
|
-
|
|
451
|
-
// Handle the result
|
|
452
|
-
console.log(result)
|
|
453
|
-
}
|
|
454
|
-
|
|
455
|
-
run();
|
|
456
|
-
```
|
|
457
|
-
|
|
458
|
-
### Parameters
|
|
459
|
-
|
|
460
|
-
| Parameter | Type | Required | Description |
|
|
461
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
462
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
463
|
-
| `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. |
|
|
464
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
465
|
-
|
|
466
|
-
### Response
|
|
467
|
-
|
|
468
|
-
**Promise\<[operations.GetOrdersReturnsResponseBody](../../models/operations/getordersreturnsresponsebody.md)\>**
|
|
469
|
-
|
|
470
|
-
### Errors
|
|
471
|
-
|
|
472
|
-
| Error Object | Status Code | Content Type |
|
|
473
|
-
| --------------- | --------------- | --------------- |
|
|
474
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
@@ -7,6 +7,9 @@
|
|
|
7
7
|
|
|
8
8
|
* [list](#list) - List all products
|
|
9
9
|
* [get](#get) - Retrieve a product
|
|
10
|
+
* [getSimilar](#getsimilar) - Retrieve similar products
|
|
11
|
+
* [getUpsells](#getupsells) - Retrieve up-sell products
|
|
12
|
+
* [getCrossSells](#getcrosssells) - Retrieve cross-sell products
|
|
10
13
|
|
|
11
14
|
## list
|
|
12
15
|
|
|
@@ -164,3 +167,228 @@ run();
|
|
|
164
167
|
| errors.Unauthorized | 401 | application/json |
|
|
165
168
|
| errors.NotFound | 404 | application/json |
|
|
166
169
|
| errors.SDKError | 4xx-5xx | */* |
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
## getSimilar
|
|
173
|
+
|
|
174
|
+
Retrieves a list of products similar to a specified product based on their attributes and category. The similar products are returned sorted by relevance, with the most closely matching products appearing first. Useful for providing product recommendations to your customers.
|
|
175
|
+
|
|
176
|
+
### Example Usage
|
|
177
|
+
|
|
178
|
+
```typescript
|
|
179
|
+
import { CeStorefront } from "ce-storefront";
|
|
180
|
+
|
|
181
|
+
const ceStorefront = new CeStorefront({
|
|
182
|
+
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
183
|
+
});
|
|
184
|
+
|
|
185
|
+
async function run() {
|
|
186
|
+
const result = await ceStorefront.catalog.products.getSimilar({});
|
|
187
|
+
|
|
188
|
+
// Handle the result
|
|
189
|
+
console.log(result)
|
|
190
|
+
}
|
|
191
|
+
|
|
192
|
+
run();
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
### Standalone function
|
|
196
|
+
|
|
197
|
+
The standalone function version of this method:
|
|
198
|
+
|
|
199
|
+
```typescript
|
|
200
|
+
import { CeStorefrontCore } from "ce-storefront/core.js";
|
|
201
|
+
import { catalogProductsGetSimilar } from "ce-storefront/funcs/catalogProductsGetSimilar.js";
|
|
202
|
+
|
|
203
|
+
// Use `CeStorefrontCore` for best tree-shaking performance.
|
|
204
|
+
// You can create one instance of it to use across an application.
|
|
205
|
+
const ceStorefront = new CeStorefrontCore({
|
|
206
|
+
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
207
|
+
});
|
|
208
|
+
|
|
209
|
+
async function run() {
|
|
210
|
+
const res = await catalogProductsGetSimilar(ceStorefront, {});
|
|
211
|
+
|
|
212
|
+
if (!res.ok) {
|
|
213
|
+
throw res.error;
|
|
214
|
+
}
|
|
215
|
+
|
|
216
|
+
const { value: result } = res;
|
|
217
|
+
|
|
218
|
+
// Handle the result
|
|
219
|
+
console.log(result)
|
|
220
|
+
}
|
|
221
|
+
|
|
222
|
+
run();
|
|
223
|
+
```
|
|
224
|
+
|
|
225
|
+
### Parameters
|
|
226
|
+
|
|
227
|
+
| Parameter | Type | Required | Description |
|
|
228
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
229
|
+
| `request` | [operations.GetSimilarRequest](../../models/operations/getsimilarrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
230
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
231
|
+
| `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. |
|
|
232
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
233
|
+
|
|
234
|
+
### Response
|
|
235
|
+
|
|
236
|
+
**Promise\<[operations.GetSimilarResponseBody](../../models/operations/getsimilarresponsebody.md)\>**
|
|
237
|
+
|
|
238
|
+
### Errors
|
|
239
|
+
|
|
240
|
+
| Error Object | Status Code | Content Type |
|
|
241
|
+
| ------------------- | ------------------- | ------------------- |
|
|
242
|
+
| errors.Unauthorized | 401 | application/json |
|
|
243
|
+
| errors.NotFound | 404 | application/json |
|
|
244
|
+
| errors.SDKError | 4xx-5xx | */* |
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
## getUpsells
|
|
248
|
+
|
|
249
|
+
Retrieves a list of products specified for upsell. The upsell products are returned based on product ids specified in request param.
|
|
250
|
+
|
|
251
|
+
### Example Usage
|
|
252
|
+
|
|
253
|
+
```typescript
|
|
254
|
+
import { CeStorefront } from "ce-storefront";
|
|
255
|
+
|
|
256
|
+
const ceStorefront = new CeStorefront({
|
|
257
|
+
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
258
|
+
});
|
|
259
|
+
|
|
260
|
+
async function run() {
|
|
261
|
+
const result = await ceStorefront.catalog.products.getUpsells({});
|
|
262
|
+
|
|
263
|
+
// Handle the result
|
|
264
|
+
console.log(result)
|
|
265
|
+
}
|
|
266
|
+
|
|
267
|
+
run();
|
|
268
|
+
```
|
|
269
|
+
|
|
270
|
+
### Standalone function
|
|
271
|
+
|
|
272
|
+
The standalone function version of this method:
|
|
273
|
+
|
|
274
|
+
```typescript
|
|
275
|
+
import { CeStorefrontCore } from "ce-storefront/core.js";
|
|
276
|
+
import { catalogProductsGetUpsells } from "ce-storefront/funcs/catalogProductsGetUpsells.js";
|
|
277
|
+
|
|
278
|
+
// Use `CeStorefrontCore` for best tree-shaking performance.
|
|
279
|
+
// You can create one instance of it to use across an application.
|
|
280
|
+
const ceStorefront = new CeStorefrontCore({
|
|
281
|
+
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
282
|
+
});
|
|
283
|
+
|
|
284
|
+
async function run() {
|
|
285
|
+
const res = await catalogProductsGetUpsells(ceStorefront, {});
|
|
286
|
+
|
|
287
|
+
if (!res.ok) {
|
|
288
|
+
throw res.error;
|
|
289
|
+
}
|
|
290
|
+
|
|
291
|
+
const { value: result } = res;
|
|
292
|
+
|
|
293
|
+
// Handle the result
|
|
294
|
+
console.log(result)
|
|
295
|
+
}
|
|
296
|
+
|
|
297
|
+
run();
|
|
298
|
+
```
|
|
299
|
+
|
|
300
|
+
### Parameters
|
|
301
|
+
|
|
302
|
+
| Parameter | Type | Required | Description |
|
|
303
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
304
|
+
| `request` | [operations.GetUpSellRequest](../../models/operations/getupsellrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
305
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
306
|
+
| `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. |
|
|
307
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
308
|
+
|
|
309
|
+
### Response
|
|
310
|
+
|
|
311
|
+
**Promise\<[operations.GetUpSellResponseBody](../../models/operations/getupsellresponsebody.md)\>**
|
|
312
|
+
|
|
313
|
+
### Errors
|
|
314
|
+
|
|
315
|
+
| Error Object | Status Code | Content Type |
|
|
316
|
+
| ------------------- | ------------------- | ------------------- |
|
|
317
|
+
| errors.Unauthorized | 401 | application/json |
|
|
318
|
+
| errors.NotFound | 404 | application/json |
|
|
319
|
+
| errors.SDKError | 4xx-5xx | */* |
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
## getCrossSells
|
|
323
|
+
|
|
324
|
+
Retrieves a list of products specified for cross selling. The cross-sell products are returned based on product ids specified in request param.
|
|
325
|
+
|
|
326
|
+
### Example Usage
|
|
327
|
+
|
|
328
|
+
```typescript
|
|
329
|
+
import { CeStorefront } from "ce-storefront";
|
|
330
|
+
|
|
331
|
+
const ceStorefront = new CeStorefront({
|
|
332
|
+
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
333
|
+
});
|
|
334
|
+
|
|
335
|
+
async function run() {
|
|
336
|
+
const result = await ceStorefront.catalog.products.getCrossSells({});
|
|
337
|
+
|
|
338
|
+
// Handle the result
|
|
339
|
+
console.log(result)
|
|
340
|
+
}
|
|
341
|
+
|
|
342
|
+
run();
|
|
343
|
+
```
|
|
344
|
+
|
|
345
|
+
### Standalone function
|
|
346
|
+
|
|
347
|
+
The standalone function version of this method:
|
|
348
|
+
|
|
349
|
+
```typescript
|
|
350
|
+
import { CeStorefrontCore } from "ce-storefront/core.js";
|
|
351
|
+
import { catalogProductsGetCrossSells } from "ce-storefront/funcs/catalogProductsGetCrossSells.js";
|
|
352
|
+
|
|
353
|
+
// Use `CeStorefrontCore` for best tree-shaking performance.
|
|
354
|
+
// You can create one instance of it to use across an application.
|
|
355
|
+
const ceStorefront = new CeStorefrontCore({
|
|
356
|
+
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
357
|
+
});
|
|
358
|
+
|
|
359
|
+
async function run() {
|
|
360
|
+
const res = await catalogProductsGetCrossSells(ceStorefront, {});
|
|
361
|
+
|
|
362
|
+
if (!res.ok) {
|
|
363
|
+
throw res.error;
|
|
364
|
+
}
|
|
365
|
+
|
|
366
|
+
const { value: result } = res;
|
|
367
|
+
|
|
368
|
+
// Handle the result
|
|
369
|
+
console.log(result)
|
|
370
|
+
}
|
|
371
|
+
|
|
372
|
+
run();
|
|
373
|
+
```
|
|
374
|
+
|
|
375
|
+
### Parameters
|
|
376
|
+
|
|
377
|
+
| Parameter | Type | Required | Description |
|
|
378
|
+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
379
|
+
| `request` | [operations.GetCrossSellRequest](../../models/operations/getcrosssellrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
380
|
+
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
381
|
+
| `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. |
|
|
382
|
+
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
383
|
+
|
|
384
|
+
### Response
|
|
385
|
+
|
|
386
|
+
**Promise\<[operations.GetCrossSellResponseBody](../../models/operations/getcrosssellresponsebody.md)\>**
|
|
387
|
+
|
|
388
|
+
### Errors
|
|
389
|
+
|
|
390
|
+
| Error Object | Status Code | Content Type |
|
|
391
|
+
| ------------------- | ------------------- | ------------------- |
|
|
392
|
+
| errors.Unauthorized | 401 | application/json |
|
|
393
|
+
| errors.NotFound | 404 | application/json |
|
|
394
|
+
| errors.SDKError | 4xx-5xx | */* |
|
|
@@ -1,15 +1,15 @@
|
|
|
1
|
-
#
|
|
2
|
-
(*
|
|
1
|
+
# Promotions
|
|
2
|
+
(*offers.promotions*)
|
|
3
3
|
|
|
4
4
|
## Overview
|
|
5
5
|
|
|
6
6
|
### Available Operations
|
|
7
7
|
|
|
8
|
-
* [list](#list) - Retrieve
|
|
8
|
+
* [list](#list) - Retrieve all promotions
|
|
9
9
|
|
|
10
10
|
## list
|
|
11
11
|
|
|
12
|
-
|
|
12
|
+
All active promotions
|
|
13
13
|
|
|
14
14
|
### Example Usage
|
|
15
15
|
|
|
@@ -21,7 +21,7 @@ const ceStorefront = new CeStorefront({
|
|
|
21
21
|
});
|
|
22
22
|
|
|
23
23
|
async function run() {
|
|
24
|
-
const result = await ceStorefront.
|
|
24
|
+
const result = await ceStorefront.offers.promotions.list();
|
|
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 { offersPromotionsList } from "ce-storefront/funcs/offersPromotionsList.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 offersPromotionsList(ceStorefront);
|
|
49
49
|
|
|
50
50
|
if (!res.ok) {
|
|
51
51
|
throw res.error;
|
|
@@ -70,12 +70,11 @@ run();
|
|
|
70
70
|
|
|
71
71
|
### Response
|
|
72
72
|
|
|
73
|
-
**Promise\<[operations.
|
|
73
|
+
**Promise\<[operations.GetPromotionsResponseBody](../../models/operations/getpromotionsresponsebody.md)\>**
|
|
74
74
|
|
|
75
75
|
### Errors
|
|
76
76
|
|
|
77
77
|
| Error Object | Status Code | Content Type |
|
|
78
78
|
| ------------------- | ------------------- | ------------------- |
|
|
79
79
|
| errors.Unauthorized | 401 | application/json |
|
|
80
|
-
| errors.NotFound | 404 | application/json |
|
|
81
80
|
| errors.SDKError | 4xx-5xx | */* |
|
|
@@ -5,88 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
### Available Operations
|
|
7
7
|
|
|
8
|
-
* [create](#create) - Create order return
|
|
9
8
|
* [list](#list) - List all order returns
|
|
10
|
-
* [get](#get) - Retrieve order return detail
|
|
11
|
-
|
|
12
|
-
## create
|
|
13
|
-
|
|
14
|
-
Create order return
|
|
15
|
-
|
|
16
|
-
### Example Usage
|
|
17
|
-
|
|
18
|
-
```typescript
|
|
19
|
-
import { CeStorefront } from "ce-storefront";
|
|
20
|
-
|
|
21
|
-
const ceStorefront = new CeStorefront({
|
|
22
|
-
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
23
|
-
});
|
|
24
|
-
|
|
25
|
-
async function run() {
|
|
26
|
-
const result = await ceStorefront.orders.returns.create({
|
|
27
|
-
orderNumber: "<value>",
|
|
28
|
-
});
|
|
29
|
-
|
|
30
|
-
// Handle the result
|
|
31
|
-
console.log(result)
|
|
32
|
-
}
|
|
33
|
-
|
|
34
|
-
run();
|
|
35
|
-
```
|
|
36
|
-
|
|
37
|
-
### Standalone function
|
|
38
|
-
|
|
39
|
-
The standalone function version of this method:
|
|
40
|
-
|
|
41
|
-
```typescript
|
|
42
|
-
import { CeStorefrontCore } from "ce-storefront/core.js";
|
|
43
|
-
import { ordersReturnsCreate } from "ce-storefront/funcs/ordersReturnsCreate.js";
|
|
44
|
-
|
|
45
|
-
// Use `CeStorefrontCore` for best tree-shaking performance.
|
|
46
|
-
// You can create one instance of it to use across an application.
|
|
47
|
-
const ceStorefront = new CeStorefrontCore({
|
|
48
|
-
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
49
|
-
});
|
|
50
|
-
|
|
51
|
-
async function run() {
|
|
52
|
-
const res = await ordersReturnsCreate(ceStorefront, {
|
|
53
|
-
orderNumber: "<value>",
|
|
54
|
-
});
|
|
55
|
-
|
|
56
|
-
if (!res.ok) {
|
|
57
|
-
throw res.error;
|
|
58
|
-
}
|
|
59
|
-
|
|
60
|
-
const { value: result } = res;
|
|
61
|
-
|
|
62
|
-
// Handle the result
|
|
63
|
-
console.log(result)
|
|
64
|
-
}
|
|
65
|
-
|
|
66
|
-
run();
|
|
67
|
-
```
|
|
68
|
-
|
|
69
|
-
### Parameters
|
|
70
|
-
|
|
71
|
-
| Parameter | Type | Required | Description |
|
|
72
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
73
|
-
| `request` | [operations.PostOrdersOrderNumberReturnRequest](../../models/operations/postordersordernumberreturnrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
74
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
75
|
-
| `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. |
|
|
76
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
77
|
-
|
|
78
|
-
### Response
|
|
79
|
-
|
|
80
|
-
**Promise\<[operations.PostOrdersOrderNumberReturnResponseBody](../../models/operations/postordersordernumberreturnresponsebody.md)\>**
|
|
81
|
-
|
|
82
|
-
### Errors
|
|
83
|
-
|
|
84
|
-
| Error Object | Status Code | Content Type |
|
|
85
|
-
| ------------------- | ------------------- | ------------------- |
|
|
86
|
-
| errors.Unauthorized | 401 | application/json |
|
|
87
|
-
| errors.NotFound | 404 | application/json |
|
|
88
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
89
|
-
|
|
90
9
|
|
|
91
10
|
## list
|
|
92
11
|
|
|
@@ -163,82 +82,3 @@ run();
|
|
|
163
82
|
| Error Object | Status Code | Content Type |
|
|
164
83
|
| --------------- | --------------- | --------------- |
|
|
165
84
|
| errors.SDKError | 4xx-5xx | */* |
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
## get
|
|
169
|
-
|
|
170
|
-
Retrieve order return detail
|
|
171
|
-
|
|
172
|
-
### Example Usage
|
|
173
|
-
|
|
174
|
-
```typescript
|
|
175
|
-
import { CeStorefront } from "ce-storefront";
|
|
176
|
-
|
|
177
|
-
const ceStorefront = new CeStorefront({
|
|
178
|
-
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
179
|
-
});
|
|
180
|
-
|
|
181
|
-
async function run() {
|
|
182
|
-
const result = await ceStorefront.orders.returns.get({
|
|
183
|
-
orderNumber: "<value>",
|
|
184
|
-
returnId: "<value>",
|
|
185
|
-
});
|
|
186
|
-
|
|
187
|
-
// Handle the result
|
|
188
|
-
console.log(result)
|
|
189
|
-
}
|
|
190
|
-
|
|
191
|
-
run();
|
|
192
|
-
```
|
|
193
|
-
|
|
194
|
-
### Standalone function
|
|
195
|
-
|
|
196
|
-
The standalone function version of this method:
|
|
197
|
-
|
|
198
|
-
```typescript
|
|
199
|
-
import { CeStorefrontCore } from "ce-storefront/core.js";
|
|
200
|
-
import { ordersReturnsGet } from "ce-storefront/funcs/ordersReturnsGet.js";
|
|
201
|
-
|
|
202
|
-
// Use `CeStorefrontCore` for best tree-shaking performance.
|
|
203
|
-
// You can create one instance of it to use across an application.
|
|
204
|
-
const ceStorefront = new CeStorefrontCore({
|
|
205
|
-
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
206
|
-
});
|
|
207
|
-
|
|
208
|
-
async function run() {
|
|
209
|
-
const res = await ordersReturnsGet(ceStorefront, {
|
|
210
|
-
orderNumber: "<value>",
|
|
211
|
-
returnId: "<value>",
|
|
212
|
-
});
|
|
213
|
-
|
|
214
|
-
if (!res.ok) {
|
|
215
|
-
throw res.error;
|
|
216
|
-
}
|
|
217
|
-
|
|
218
|
-
const { value: result } = res;
|
|
219
|
-
|
|
220
|
-
// Handle the result
|
|
221
|
-
console.log(result)
|
|
222
|
-
}
|
|
223
|
-
|
|
224
|
-
run();
|
|
225
|
-
```
|
|
226
|
-
|
|
227
|
-
### Parameters
|
|
228
|
-
|
|
229
|
-
| Parameter | Type | Required | Description |
|
|
230
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
231
|
-
| `request` | [operations.GetOrdersOrderNumberReturnReturnIdRequest](../../models/operations/getordersordernumberreturnreturnidrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
232
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
233
|
-
| `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. |
|
|
234
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
235
|
-
|
|
236
|
-
### Response
|
|
237
|
-
|
|
238
|
-
**Promise\<[operations.GetOrdersOrderNumberReturnReturnIdResponseBody](../../models/operations/getordersordernumberreturnreturnidresponsebody.md)\>**
|
|
239
|
-
|
|
240
|
-
### Errors
|
|
241
|
-
|
|
242
|
-
| Error Object | Status Code | Content Type |
|
|
243
|
-
| --------------- | --------------- | --------------- |
|
|
244
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
@@ -5,9 +5,9 @@
|
|
|
5
5
|
|
|
6
6
|
### Available Operations
|
|
7
7
|
|
|
8
|
-
* [
|
|
8
|
+
* [list](#list) - Retrieve all reviews
|
|
9
9
|
|
|
10
|
-
##
|
|
10
|
+
## list
|
|
11
11
|
|
|
12
12
|
Retrieve all reviews
|
|
13
13
|
|
|
@@ -21,7 +21,7 @@ const ceStorefront = new CeStorefront({
|
|
|
21
21
|
});
|
|
22
22
|
|
|
23
23
|
async function run() {
|
|
24
|
-
const result = await ceStorefront.customers.reviews.
|
|
24
|
+
const result = await ceStorefront.customers.reviews.list({
|
|
25
25
|
userId: "<value>",
|
|
26
26
|
});
|
|
27
27
|
|
|
@@ -38,7 +38,7 @@ The standalone function version of this method:
|
|
|
38
38
|
|
|
39
39
|
```typescript
|
|
40
40
|
import { CeStorefrontCore } from "ce-storefront/core.js";
|
|
41
|
-
import {
|
|
41
|
+
import { customersReviewsList } from "ce-storefront/funcs/customersReviewsList.js";
|
|
42
42
|
|
|
43
43
|
// Use `CeStorefrontCore` for best tree-shaking performance.
|
|
44
44
|
// You can create one instance of it to use across an application.
|
|
@@ -47,7 +47,7 @@ const ceStorefront = new CeStorefrontCore({
|
|
|
47
47
|
});
|
|
48
48
|
|
|
49
49
|
async function run() {
|
|
50
|
-
const res = await
|
|
50
|
+
const res = await customersReviewsList(ceStorefront, {
|
|
51
51
|
userId: "<value>",
|
|
52
52
|
});
|
|
53
53
|
|
|
@@ -5,9 +5,9 @@
|
|
|
5
5
|
|
|
6
6
|
### Available Operations
|
|
7
7
|
|
|
8
|
-
* [
|
|
8
|
+
* [checkPincodeServiceability](#checkpincodeserviceability) - Check pincode serviceability
|
|
9
9
|
|
|
10
|
-
##
|
|
10
|
+
## checkPincodeServiceability
|
|
11
11
|
|
|
12
12
|
Check shipment delivery availability in an area by pincode
|
|
13
13
|
|
|
@@ -21,7 +21,7 @@ const ceStorefront = new CeStorefront({
|
|
|
21
21
|
});
|
|
22
22
|
|
|
23
23
|
async function run() {
|
|
24
|
-
const result = await ceStorefront.shipping.
|
|
24
|
+
const result = await ceStorefront.shipping.checkPincodeServiceability({
|
|
25
25
|
pincode: "144552",
|
|
26
26
|
});
|
|
27
27
|
|
|
@@ -38,7 +38,7 @@ The standalone function version of this method:
|
|
|
38
38
|
|
|
39
39
|
```typescript
|
|
40
40
|
import { CeStorefrontCore } from "ce-storefront/core.js";
|
|
41
|
-
import {
|
|
41
|
+
import { shippingCheckPincodeServiceability } from "ce-storefront/funcs/shippingCheckPincodeServiceability.js";
|
|
42
42
|
|
|
43
43
|
// Use `CeStorefrontCore` for best tree-shaking performance.
|
|
44
44
|
// You can create one instance of it to use across an application.
|
|
@@ -47,7 +47,7 @@ const ceStorefront = new CeStorefrontCore({
|
|
|
47
47
|
});
|
|
48
48
|
|
|
49
49
|
async function run() {
|
|
50
|
-
const res = await
|
|
50
|
+
const res = await shippingCheckPincodeServiceability(ceStorefront, {
|
|
51
51
|
pincode: "144552",
|
|
52
52
|
});
|
|
53
53
|
|