ce-storefront 0.0.1 → 0.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.devcontainer/README.md +5 -0
- package/README.md +101 -117
- package/docs/sdks/addresses/README.md +78 -0
- package/docs/sdks/analytics/README.md +5 -5
- package/docs/sdks/auth/README.md +91 -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 +1 -83
- package/docs/sdks/{upsell → customersapi}/README.md +16 -10
- package/docs/sdks/{otp → newsletter}/README.md +10 -10
- package/docs/sdks/{returns → notificationpreferences}/README.md +35 -39
- 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/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/authLoginAnonymously.d.ts +16 -0
- package/funcs/authLoginAnonymously.d.ts.map +1 -0
- package/funcs/{ordersGetReturns.js → authLoginAnonymously.js} +21 -13
- package/funcs/authLoginAnonymously.js.map +1 -0
- 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/{catalogProductsRecommendedList.d.ts → customersAPIGetRecommendedProducts.d.ts} +3 -3
- package/funcs/customersAPIGetRecommendedProducts.d.ts.map +1 -0
- package/funcs/customersAPIGetRecommendedProducts.js +97 -0
- package/funcs/customersAPIGetRecommendedProducts.js.map +1 -0
- 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/{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 +1 -3
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +1 -3
- package/models/components/index.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/recommendedproduct.d.ts +149 -0
- package/models/components/recommendedproduct.d.ts.map +1 -0
- package/models/components/recommendedproduct.js +230 -0
- package/models/components/recommendedproduct.js.map +1 -0
- 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/getrecommendedproducts.d.ts +82 -0
- package/models/operations/getrecommendedproducts.d.ts.map +1 -0
- package/models/operations/getrecommendedproducts.js +93 -0
- package/models/operations/getrecommendedproducts.js.map +1 -0
- package/models/operations/index.d.ts +2 -5
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +2 -5
- package/models/operations/index.js.map +1 -1
- package/models/operations/postauthanonymous.d.ts +101 -0
- package/models/operations/postauthanonymous.d.ts.map +1 -0
- package/models/operations/postauthanonymous.js +124 -0
- package/models/operations/postauthanonymous.js.map +1 -0
- 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 +16 -14
- package/sdk/auth.d.ts.map +1 -1
- package/sdk/auth.js +22 -21
- 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 +1 -9
- package/sdk/customers.d.ts.map +1 -1
- package/sdk/customers.js +0 -11
- package/sdk/customers.js.map +1 -1
- package/sdk/{recommended.d.ts → customersapi.d.ts} +4 -4
- package/sdk/customersapi.d.ts.map +1 -0
- package/sdk/{recommended.js → customersapi.js} +8 -8
- package/sdk/customersapi.js.map +1 -0
- 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 -10
- package/sdk/orders.d.ts.map +1 -1
- package/sdk/orders.js +0 -15
- 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/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 +9 -3
- package/sdk/sdk.d.ts.map +1 -1
- package/sdk/sdk.js +13 -3
- 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/{ordersGetReturns.ts → authLoginAnonymously.ts} +23 -14
- 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/{ordersReturnsCreate.ts → customersAPIGetRecommendedProducts.ts} +14 -18
- package/src/funcs/{customersGetAddresses.ts → customersAddressesList.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 +1 -3
- 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/recommendedproduct.ts +359 -0
- package/src/models/components/skuinfo.ts +4 -4
- package/src/models/errors/unauthorized.ts +1 -1
- package/src/models/operations/getrecommendedproducts.ts +140 -0
- package/src/models/operations/index.ts +2 -5
- package/src/models/operations/postauthanonymous.ts +190 -0
- 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 +31 -28
- 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 +1 -17
- package/src/sdk/{recommended.ts → customersapi.ts} +8 -5
- 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 -17
- package/src/sdk/products.ts +42 -24
- package/src/sdk/promotions.ts +20 -0
- package/src/sdk/reviews.ts +3 -3
- package/src/sdk/sdk.ts +16 -4
- 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/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 +0 -84
- 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/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/ordersReturnsList.d.ts +0 -15
- package/funcs/ordersReturnsList.d.ts.map +0 -1
- package/funcs/ordersReturnsList.js +0 -96
- package/funcs/ordersReturnsList.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/components/orderreturn.d.ts +0 -59
- package/models/components/orderreturn.d.ts.map +0 -1
- package/models/components/orderreturn.js +0 -165
- package/models/components/orderreturn.js.map +0 -1
- package/models/components/orderreturnitem.d.ts +0 -122
- package/models/components/orderreturnitem.d.ts.map +0 -1
- package/models/components/orderreturnitem.js +0 -171
- package/models/components/orderreturnitem.js.map +0 -1
- package/models/operations/getordersordernumberreturn.d.ts +0 -59
- package/models/operations/getordersordernumberreturn.d.ts.map +0 -1
- package/models/operations/getordersordernumberreturn.js +0 -99
- package/models/operations/getordersordernumberreturn.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/getrecommended.d.ts +0 -56
- package/models/operations/getrecommended.d.ts.map +0 -1
- package/models/operations/getrecommended.js +0 -74
- package/models/operations/getrecommended.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.map +0 -1
- package/sdk/recommended.js.map +0 -1
- package/sdk/returns.d.ts +0 -26
- package/sdk/returns.d.ts.map +0 -1
- package/sdk/returns.js +0 -42
- package/sdk/returns.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/catalogProductsRecommendedList.ts +0 -114
- package/src/funcs/ordersReturnsGet.ts +0 -132
- package/src/funcs/ordersReturnsList.ts +0 -127
- package/src/models/components/createorderreturn.ts +0 -73
- package/src/models/components/orderreturn.ts +0 -198
- package/src/models/components/orderreturnitem.ts +0 -222
- package/src/models/operations/getordersordernumberreturn.ts +0 -125
- package/src/models/operations/getordersordernumberreturnreturnid.ts +0 -174
- package/src/models/operations/getordersreturns.ts +0 -97
- package/src/models/operations/getrecommended.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/returns.ts +0 -51
- package/src/sdk/similar.ts +0 -23
- package/src/sdk/token.ts +0 -23
- package/src/sdk/upsell.ts +0 -23
package/docs/sdks/user/README.md
CHANGED
|
@@ -1,928 +1,2 @@
|
|
|
1
1
|
# User
|
|
2
|
-
(*
|
|
3
|
-
|
|
4
|
-
## Overview
|
|
5
|
-
|
|
6
|
-
### Available Operations
|
|
7
|
-
|
|
8
|
-
* [addProfileImage](#addprofileimage) - Add profile image
|
|
9
|
-
* [updateProfileImage](#updateprofileimage) - Update profile image
|
|
10
|
-
* [deleteProfileImage](#deleteprofileimage) - Delete profile image
|
|
11
|
-
* [getProfileImage](#getprofileimage) - Retrieve a profile image
|
|
12
|
-
* [deactivateAccount](#deactivateaccount) - Deactivate account
|
|
13
|
-
* [changePassword](#changepassword) - Change password
|
|
14
|
-
* [forgotPassword](#forgotpassword) - Forgot password
|
|
15
|
-
* [resetPassword](#resetpassword) - Reset password
|
|
16
|
-
* [getNotificationPreferences](#getnotificationpreferences) - Retrieve user notification preferences
|
|
17
|
-
* [createNotificationPreferences](#createnotificationpreferences) - Create user notification preferences
|
|
18
|
-
* [updateNotificationPreferences](#updatenotificationpreferences) - Update user notification preferences
|
|
19
|
-
* [logout](#logout) - Logout user
|
|
20
|
-
|
|
21
|
-
## addProfileImage
|
|
22
|
-
|
|
23
|
-
The Profile Image API streamlines the process of uploading profile images associating with user accounts, offering a user-centric approach to visual identity customization. Upon success, the API responds with a confirmation message. In case of errors, clear error messages facilitate quick issue resolution. Overall, the Profile Image API enhances user engagement by seamlessly integrating personalized visual elements into digital platforms.
|
|
24
|
-
|
|
25
|
-
### Example Usage
|
|
26
|
-
|
|
27
|
-
```typescript
|
|
28
|
-
import { CeStorefront } from "ce-storefront";
|
|
29
|
-
|
|
30
|
-
const ceStorefront = new CeStorefront({
|
|
31
|
-
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
32
|
-
});
|
|
33
|
-
|
|
34
|
-
async function run() {
|
|
35
|
-
const result = await ceStorefront.auth.user.addProfileImage({
|
|
36
|
-
id: "<id>",
|
|
37
|
-
});
|
|
38
|
-
|
|
39
|
-
// Handle the result
|
|
40
|
-
console.log(result)
|
|
41
|
-
}
|
|
42
|
-
|
|
43
|
-
run();
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
### Standalone function
|
|
47
|
-
|
|
48
|
-
The standalone function version of this method:
|
|
49
|
-
|
|
50
|
-
```typescript
|
|
51
|
-
import { CeStorefrontCore } from "ce-storefront/core.js";
|
|
52
|
-
import { authUserAddProfileImage } from "ce-storefront/funcs/authUserAddProfileImage.js";
|
|
53
|
-
|
|
54
|
-
// Use `CeStorefrontCore` for best tree-shaking performance.
|
|
55
|
-
// You can create one instance of it to use across an application.
|
|
56
|
-
const ceStorefront = new CeStorefrontCore({
|
|
57
|
-
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
58
|
-
});
|
|
59
|
-
|
|
60
|
-
async function run() {
|
|
61
|
-
const res = await authUserAddProfileImage(ceStorefront, {
|
|
62
|
-
id: "<id>",
|
|
63
|
-
});
|
|
64
|
-
|
|
65
|
-
if (!res.ok) {
|
|
66
|
-
throw res.error;
|
|
67
|
-
}
|
|
68
|
-
|
|
69
|
-
const { value: result } = res;
|
|
70
|
-
|
|
71
|
-
// Handle the result
|
|
72
|
-
console.log(result)
|
|
73
|
-
}
|
|
74
|
-
|
|
75
|
-
run();
|
|
76
|
-
```
|
|
77
|
-
|
|
78
|
-
### Parameters
|
|
79
|
-
|
|
80
|
-
| Parameter | Type | Required | Description |
|
|
81
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
82
|
-
| `request` | [operations.PostAuthUserIdProfileImageRequest](../../models/operations/postauthuseridprofileimagerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
83
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
84
|
-
| `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. |
|
|
85
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
86
|
-
|
|
87
|
-
### Response
|
|
88
|
-
|
|
89
|
-
**Promise\<[operations.PostAuthUserIdProfileImageResponseBody](../../models/operations/postauthuseridprofileimageresponsebody.md)\>**
|
|
90
|
-
|
|
91
|
-
### Errors
|
|
92
|
-
|
|
93
|
-
| Error Object | Status Code | Content Type |
|
|
94
|
-
| --------------- | --------------- | --------------- |
|
|
95
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
## updateProfileImage
|
|
99
|
-
|
|
100
|
-
The Profile Image API streamlines the process of updating profile images associating with user accounts, offering a user-centric approach to visual identity customization. Upon success, the API responds with a confirmation message. In case of errors, clear error messages facilitate quick issue resolution. Overall, the Profile Image API enhances user engagement by seamlessly integrating personalized visual elements into digital platforms.
|
|
101
|
-
|
|
102
|
-
### Example Usage
|
|
103
|
-
|
|
104
|
-
```typescript
|
|
105
|
-
import { CeStorefront } from "ce-storefront";
|
|
106
|
-
|
|
107
|
-
const ceStorefront = new CeStorefront({
|
|
108
|
-
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
109
|
-
});
|
|
110
|
-
|
|
111
|
-
async function run() {
|
|
112
|
-
const result = await ceStorefront.auth.user.updateProfileImage({
|
|
113
|
-
id: "<id>",
|
|
114
|
-
});
|
|
115
|
-
|
|
116
|
-
// Handle the result
|
|
117
|
-
console.log(result)
|
|
118
|
-
}
|
|
119
|
-
|
|
120
|
-
run();
|
|
121
|
-
```
|
|
122
|
-
|
|
123
|
-
### Standalone function
|
|
124
|
-
|
|
125
|
-
The standalone function version of this method:
|
|
126
|
-
|
|
127
|
-
```typescript
|
|
128
|
-
import { CeStorefrontCore } from "ce-storefront/core.js";
|
|
129
|
-
import { authUserUpdateProfileImage } from "ce-storefront/funcs/authUserUpdateProfileImage.js";
|
|
130
|
-
|
|
131
|
-
// Use `CeStorefrontCore` for best tree-shaking performance.
|
|
132
|
-
// You can create one instance of it to use across an application.
|
|
133
|
-
const ceStorefront = new CeStorefrontCore({
|
|
134
|
-
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
135
|
-
});
|
|
136
|
-
|
|
137
|
-
async function run() {
|
|
138
|
-
const res = await authUserUpdateProfileImage(ceStorefront, {
|
|
139
|
-
id: "<id>",
|
|
140
|
-
});
|
|
141
|
-
|
|
142
|
-
if (!res.ok) {
|
|
143
|
-
throw res.error;
|
|
144
|
-
}
|
|
145
|
-
|
|
146
|
-
const { value: result } = res;
|
|
147
|
-
|
|
148
|
-
// Handle the result
|
|
149
|
-
console.log(result)
|
|
150
|
-
}
|
|
151
|
-
|
|
152
|
-
run();
|
|
153
|
-
```
|
|
154
|
-
|
|
155
|
-
### Parameters
|
|
156
|
-
|
|
157
|
-
| Parameter | Type | Required | Description |
|
|
158
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
159
|
-
| `request` | [operations.PutAuthUserIdProfileImageRequest](../../models/operations/putauthuseridprofileimagerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
160
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
161
|
-
| `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. |
|
|
162
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
163
|
-
|
|
164
|
-
### Response
|
|
165
|
-
|
|
166
|
-
**Promise\<[operations.PutAuthUserIdProfileImageResponseBody](../../models/operations/putauthuseridprofileimageresponsebody.md)\>**
|
|
167
|
-
|
|
168
|
-
### Errors
|
|
169
|
-
|
|
170
|
-
| Error Object | Status Code | Content Type |
|
|
171
|
-
| --------------- | --------------- | --------------- |
|
|
172
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
## deleteProfileImage
|
|
176
|
-
|
|
177
|
-
Delete profile image API streamlines the process of removing profile images associating with user accounts. Upon success, the API responds with a confirmation message. In case of errors, clear error messages facilitate quick issue resolution.
|
|
178
|
-
|
|
179
|
-
### Example Usage
|
|
180
|
-
|
|
181
|
-
```typescript
|
|
182
|
-
import { CeStorefront } from "ce-storefront";
|
|
183
|
-
|
|
184
|
-
const ceStorefront = new CeStorefront({
|
|
185
|
-
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
186
|
-
});
|
|
187
|
-
|
|
188
|
-
async function run() {
|
|
189
|
-
const result = await ceStorefront.auth.user.deleteProfileImage({
|
|
190
|
-
id: "<id>",
|
|
191
|
-
});
|
|
192
|
-
|
|
193
|
-
// Handle the result
|
|
194
|
-
console.log(result)
|
|
195
|
-
}
|
|
196
|
-
|
|
197
|
-
run();
|
|
198
|
-
```
|
|
199
|
-
|
|
200
|
-
### Standalone function
|
|
201
|
-
|
|
202
|
-
The standalone function version of this method:
|
|
203
|
-
|
|
204
|
-
```typescript
|
|
205
|
-
import { CeStorefrontCore } from "ce-storefront/core.js";
|
|
206
|
-
import { authUserDeleteProfileImage } from "ce-storefront/funcs/authUserDeleteProfileImage.js";
|
|
207
|
-
|
|
208
|
-
// Use `CeStorefrontCore` for best tree-shaking performance.
|
|
209
|
-
// You can create one instance of it to use across an application.
|
|
210
|
-
const ceStorefront = new CeStorefrontCore({
|
|
211
|
-
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
212
|
-
});
|
|
213
|
-
|
|
214
|
-
async function run() {
|
|
215
|
-
const res = await authUserDeleteProfileImage(ceStorefront, {
|
|
216
|
-
id: "<id>",
|
|
217
|
-
});
|
|
218
|
-
|
|
219
|
-
if (!res.ok) {
|
|
220
|
-
throw res.error;
|
|
221
|
-
}
|
|
222
|
-
|
|
223
|
-
const { value: result } = res;
|
|
224
|
-
|
|
225
|
-
// Handle the result
|
|
226
|
-
console.log(result)
|
|
227
|
-
}
|
|
228
|
-
|
|
229
|
-
run();
|
|
230
|
-
```
|
|
231
|
-
|
|
232
|
-
### Parameters
|
|
233
|
-
|
|
234
|
-
| Parameter | Type | Required | Description |
|
|
235
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
236
|
-
| `request` | [operations.DeleteAuthUserIdProfileImageRequest](../../models/operations/deleteauthuseridprofileimagerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
237
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
238
|
-
| `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. |
|
|
239
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
240
|
-
|
|
241
|
-
### Response
|
|
242
|
-
|
|
243
|
-
**Promise\<[operations.DeleteAuthUserIdProfileImageResponseBody](../../models/operations/deleteauthuseridprofileimageresponsebody.md)\>**
|
|
244
|
-
|
|
245
|
-
### Errors
|
|
246
|
-
|
|
247
|
-
| Error Object | Status Code | Content Type |
|
|
248
|
-
| --------------- | --------------- | --------------- |
|
|
249
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
## getProfileImage
|
|
253
|
-
|
|
254
|
-
Retrieve user profile image API streamlines the process of retriving profile images associating with user accounts. Upon success, the API responds with a confirmation message. In case of errors, clear error messages facilitate quick issue resolution.
|
|
255
|
-
|
|
256
|
-
### Example Usage
|
|
257
|
-
|
|
258
|
-
```typescript
|
|
259
|
-
import { CeStorefront } from "ce-storefront";
|
|
260
|
-
|
|
261
|
-
const ceStorefront = new CeStorefront({
|
|
262
|
-
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
263
|
-
});
|
|
264
|
-
|
|
265
|
-
async function run() {
|
|
266
|
-
const result = await ceStorefront.auth.user.getProfileImage({
|
|
267
|
-
id: "<id>",
|
|
268
|
-
});
|
|
269
|
-
|
|
270
|
-
// Handle the result
|
|
271
|
-
console.log(result)
|
|
272
|
-
}
|
|
273
|
-
|
|
274
|
-
run();
|
|
275
|
-
```
|
|
276
|
-
|
|
277
|
-
### Standalone function
|
|
278
|
-
|
|
279
|
-
The standalone function version of this method:
|
|
280
|
-
|
|
281
|
-
```typescript
|
|
282
|
-
import { CeStorefrontCore } from "ce-storefront/core.js";
|
|
283
|
-
import { authUserGetProfileImage } from "ce-storefront/funcs/authUserGetProfileImage.js";
|
|
284
|
-
|
|
285
|
-
// Use `CeStorefrontCore` for best tree-shaking performance.
|
|
286
|
-
// You can create one instance of it to use across an application.
|
|
287
|
-
const ceStorefront = new CeStorefrontCore({
|
|
288
|
-
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
289
|
-
});
|
|
290
|
-
|
|
291
|
-
async function run() {
|
|
292
|
-
const res = await authUserGetProfileImage(ceStorefront, {
|
|
293
|
-
id: "<id>",
|
|
294
|
-
});
|
|
295
|
-
|
|
296
|
-
if (!res.ok) {
|
|
297
|
-
throw res.error;
|
|
298
|
-
}
|
|
299
|
-
|
|
300
|
-
const { value: result } = res;
|
|
301
|
-
|
|
302
|
-
// Handle the result
|
|
303
|
-
console.log(result)
|
|
304
|
-
}
|
|
305
|
-
|
|
306
|
-
run();
|
|
307
|
-
```
|
|
308
|
-
|
|
309
|
-
### Parameters
|
|
310
|
-
|
|
311
|
-
| Parameter | Type | Required | Description |
|
|
312
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
313
|
-
| `request` | [operations.GetAuthUserIdProfileImageRequest](../../models/operations/getauthuseridprofileimagerequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
314
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
315
|
-
| `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. |
|
|
316
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
317
|
-
|
|
318
|
-
### Response
|
|
319
|
-
|
|
320
|
-
**Promise\<[operations.GetAuthUserIdProfileImageResponseBody](../../models/operations/getauthuseridprofileimageresponsebody.md)\>**
|
|
321
|
-
|
|
322
|
-
### Errors
|
|
323
|
-
|
|
324
|
-
| Error Object | Status Code | Content Type |
|
|
325
|
-
| --------------- | --------------- | --------------- |
|
|
326
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
## deactivateAccount
|
|
330
|
-
|
|
331
|
-
The Deactivate Account API providing users with a straightforward method to deactivate their accounts. Upon successful deactivation, the API responds with a confirmation message. Error responses are detailed, aiding developers in addressing issues promptly.
|
|
332
|
-
|
|
333
|
-
### Example Usage
|
|
334
|
-
|
|
335
|
-
```typescript
|
|
336
|
-
import { CeStorefront } from "ce-storefront";
|
|
337
|
-
|
|
338
|
-
const ceStorefront = new CeStorefront({
|
|
339
|
-
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
340
|
-
});
|
|
341
|
-
|
|
342
|
-
async function run() {
|
|
343
|
-
const result = await ceStorefront.auth.user.deactivateAccount({
|
|
344
|
-
id: "<id>",
|
|
345
|
-
});
|
|
346
|
-
|
|
347
|
-
// Handle the result
|
|
348
|
-
console.log(result)
|
|
349
|
-
}
|
|
350
|
-
|
|
351
|
-
run();
|
|
352
|
-
```
|
|
353
|
-
|
|
354
|
-
### Standalone function
|
|
355
|
-
|
|
356
|
-
The standalone function version of this method:
|
|
357
|
-
|
|
358
|
-
```typescript
|
|
359
|
-
import { CeStorefrontCore } from "ce-storefront/core.js";
|
|
360
|
-
import { authUserDeactivateAccount } from "ce-storefront/funcs/authUserDeactivateAccount.js";
|
|
361
|
-
|
|
362
|
-
// Use `CeStorefrontCore` for best tree-shaking performance.
|
|
363
|
-
// You can create one instance of it to use across an application.
|
|
364
|
-
const ceStorefront = new CeStorefrontCore({
|
|
365
|
-
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
366
|
-
});
|
|
367
|
-
|
|
368
|
-
async function run() {
|
|
369
|
-
const res = await authUserDeactivateAccount(ceStorefront, {
|
|
370
|
-
id: "<id>",
|
|
371
|
-
});
|
|
372
|
-
|
|
373
|
-
if (!res.ok) {
|
|
374
|
-
throw res.error;
|
|
375
|
-
}
|
|
376
|
-
|
|
377
|
-
const { value: result } = res;
|
|
378
|
-
|
|
379
|
-
// Handle the result
|
|
380
|
-
console.log(result)
|
|
381
|
-
}
|
|
382
|
-
|
|
383
|
-
run();
|
|
384
|
-
```
|
|
385
|
-
|
|
386
|
-
### Parameters
|
|
387
|
-
|
|
388
|
-
| Parameter | Type | Required | Description |
|
|
389
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
390
|
-
| `request` | [operations.PutAuthUserIdDeactivateRequest](../../models/operations/putauthuseriddeactivaterequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
391
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
392
|
-
| `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. |
|
|
393
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
394
|
-
|
|
395
|
-
### Response
|
|
396
|
-
|
|
397
|
-
**Promise\<[operations.PutAuthUserIdDeactivateResponseBody](../../models/operations/putauthuseriddeactivateresponsebody.md)\>**
|
|
398
|
-
|
|
399
|
-
### Errors
|
|
400
|
-
|
|
401
|
-
| Error Object | Status Code | Content Type |
|
|
402
|
-
| --------------- | --------------- | --------------- |
|
|
403
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
## changePassword
|
|
407
|
-
|
|
408
|
-
The Change Password API is a key feature designed to provide a secure and standardized method for users to update their passwords.
|
|
409
|
-
|
|
410
|
-
### Example Usage
|
|
411
|
-
|
|
412
|
-
```typescript
|
|
413
|
-
import { CeStorefront } from "ce-storefront";
|
|
414
|
-
|
|
415
|
-
const ceStorefront = new CeStorefront({
|
|
416
|
-
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
417
|
-
});
|
|
418
|
-
|
|
419
|
-
async function run() {
|
|
420
|
-
const result = await ceStorefront.auth.user.changePassword();
|
|
421
|
-
|
|
422
|
-
// Handle the result
|
|
423
|
-
console.log(result)
|
|
424
|
-
}
|
|
425
|
-
|
|
426
|
-
run();
|
|
427
|
-
```
|
|
428
|
-
|
|
429
|
-
### Standalone function
|
|
430
|
-
|
|
431
|
-
The standalone function version of this method:
|
|
432
|
-
|
|
433
|
-
```typescript
|
|
434
|
-
import { CeStorefrontCore } from "ce-storefront/core.js";
|
|
435
|
-
import { authUserChangePassword } from "ce-storefront/funcs/authUserChangePassword.js";
|
|
436
|
-
|
|
437
|
-
// Use `CeStorefrontCore` for best tree-shaking performance.
|
|
438
|
-
// You can create one instance of it to use across an application.
|
|
439
|
-
const ceStorefront = new CeStorefrontCore({
|
|
440
|
-
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
441
|
-
});
|
|
442
|
-
|
|
443
|
-
async function run() {
|
|
444
|
-
const res = await authUserChangePassword(ceStorefront);
|
|
445
|
-
|
|
446
|
-
if (!res.ok) {
|
|
447
|
-
throw res.error;
|
|
448
|
-
}
|
|
449
|
-
|
|
450
|
-
const { value: result } = res;
|
|
451
|
-
|
|
452
|
-
// Handle the result
|
|
453
|
-
console.log(result)
|
|
454
|
-
}
|
|
455
|
-
|
|
456
|
-
run();
|
|
457
|
-
```
|
|
458
|
-
|
|
459
|
-
### Parameters
|
|
460
|
-
|
|
461
|
-
| Parameter | Type | Required | Description |
|
|
462
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
463
|
-
| `request` | [operations.PostAuthChangePasswordRequestBody](../../models/operations/postauthchangepasswordrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
464
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
465
|
-
| `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. |
|
|
466
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
467
|
-
|
|
468
|
-
### Response
|
|
469
|
-
|
|
470
|
-
**Promise\<[operations.PostAuthChangePasswordResponseBody](../../models/operations/postauthchangepasswordresponsebody.md)\>**
|
|
471
|
-
|
|
472
|
-
### Errors
|
|
473
|
-
|
|
474
|
-
| Error Object | Status Code | Content Type |
|
|
475
|
-
| ------------------- | ------------------- | ------------------- |
|
|
476
|
-
| errors.BadRequest | 400 | application/json |
|
|
477
|
-
| errors.Unauthorized | 401 | application/json |
|
|
478
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
## forgotPassword
|
|
482
|
-
|
|
483
|
-
The Forgot Password API provides a secure mechanism for users to initiate the password recovery process. This API provides one-time password (OTP) token, which facilitas the resetting of user’s account password.
|
|
484
|
-
|
|
485
|
-
### Example Usage
|
|
486
|
-
|
|
487
|
-
```typescript
|
|
488
|
-
import { CeStorefront } from "ce-storefront";
|
|
489
|
-
|
|
490
|
-
const ceStorefront = new CeStorefront({
|
|
491
|
-
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
492
|
-
});
|
|
493
|
-
|
|
494
|
-
async function run() {
|
|
495
|
-
const result = await ceStorefront.auth.user.forgotPassword();
|
|
496
|
-
|
|
497
|
-
// Handle the result
|
|
498
|
-
console.log(result)
|
|
499
|
-
}
|
|
500
|
-
|
|
501
|
-
run();
|
|
502
|
-
```
|
|
503
|
-
|
|
504
|
-
### Standalone function
|
|
505
|
-
|
|
506
|
-
The standalone function version of this method:
|
|
507
|
-
|
|
508
|
-
```typescript
|
|
509
|
-
import { CeStorefrontCore } from "ce-storefront/core.js";
|
|
510
|
-
import { authUserForgotPassword } from "ce-storefront/funcs/authUserForgotPassword.js";
|
|
511
|
-
|
|
512
|
-
// Use `CeStorefrontCore` for best tree-shaking performance.
|
|
513
|
-
// You can create one instance of it to use across an application.
|
|
514
|
-
const ceStorefront = new CeStorefrontCore({
|
|
515
|
-
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
516
|
-
});
|
|
517
|
-
|
|
518
|
-
async function run() {
|
|
519
|
-
const res = await authUserForgotPassword(ceStorefront);
|
|
520
|
-
|
|
521
|
-
if (!res.ok) {
|
|
522
|
-
throw res.error;
|
|
523
|
-
}
|
|
524
|
-
|
|
525
|
-
const { value: result } = res;
|
|
526
|
-
|
|
527
|
-
// Handle the result
|
|
528
|
-
console.log(result)
|
|
529
|
-
}
|
|
530
|
-
|
|
531
|
-
run();
|
|
532
|
-
```
|
|
533
|
-
|
|
534
|
-
### Parameters
|
|
535
|
-
|
|
536
|
-
| Parameter | Type | Required | Description |
|
|
537
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
538
|
-
| `request` | [operations.PostAuthForgotPasswordRequestBody](../../models/operations/postauthforgotpasswordrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
539
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
540
|
-
| `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. |
|
|
541
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
542
|
-
|
|
543
|
-
### Response
|
|
544
|
-
|
|
545
|
-
**Promise\<[operations.PostAuthForgotPasswordResponseBody](../../models/operations/postauthforgotpasswordresponsebody.md)\>**
|
|
546
|
-
|
|
547
|
-
### Errors
|
|
548
|
-
|
|
549
|
-
| Error Object | Status Code | Content Type |
|
|
550
|
-
| --------------- | --------------- | --------------- |
|
|
551
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
## resetPassword
|
|
555
|
-
|
|
556
|
-
Reset password
|
|
557
|
-
|
|
558
|
-
### Example Usage
|
|
559
|
-
|
|
560
|
-
```typescript
|
|
561
|
-
import { CeStorefront } from "ce-storefront";
|
|
562
|
-
|
|
563
|
-
const ceStorefront = new CeStorefront({
|
|
564
|
-
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
565
|
-
});
|
|
566
|
-
|
|
567
|
-
async function run() {
|
|
568
|
-
const result = await ceStorefront.auth.user.resetPassword();
|
|
569
|
-
|
|
570
|
-
// Handle the result
|
|
571
|
-
console.log(result)
|
|
572
|
-
}
|
|
573
|
-
|
|
574
|
-
run();
|
|
575
|
-
```
|
|
576
|
-
|
|
577
|
-
### Standalone function
|
|
578
|
-
|
|
579
|
-
The standalone function version of this method:
|
|
580
|
-
|
|
581
|
-
```typescript
|
|
582
|
-
import { CeStorefrontCore } from "ce-storefront/core.js";
|
|
583
|
-
import { authUserResetPassword } from "ce-storefront/funcs/authUserResetPassword.js";
|
|
584
|
-
|
|
585
|
-
// Use `CeStorefrontCore` for best tree-shaking performance.
|
|
586
|
-
// You can create one instance of it to use across an application.
|
|
587
|
-
const ceStorefront = new CeStorefrontCore({
|
|
588
|
-
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
589
|
-
});
|
|
590
|
-
|
|
591
|
-
async function run() {
|
|
592
|
-
const res = await authUserResetPassword(ceStorefront);
|
|
593
|
-
|
|
594
|
-
if (!res.ok) {
|
|
595
|
-
throw res.error;
|
|
596
|
-
}
|
|
597
|
-
|
|
598
|
-
const { value: result } = res;
|
|
599
|
-
|
|
600
|
-
// Handle the result
|
|
601
|
-
console.log(result)
|
|
602
|
-
}
|
|
603
|
-
|
|
604
|
-
run();
|
|
605
|
-
```
|
|
606
|
-
|
|
607
|
-
### Parameters
|
|
608
|
-
|
|
609
|
-
| Parameter | Type | Required | Description |
|
|
610
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
611
|
-
| `request` | [operations.PostAuthResetPasswordRequestBody](../../models/operations/postauthresetpasswordrequestbody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
612
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
613
|
-
| `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. |
|
|
614
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
615
|
-
|
|
616
|
-
### Response
|
|
617
|
-
|
|
618
|
-
**Promise\<[operations.PostAuthResetPasswordResponseBody](../../models/operations/postauthresetpasswordresponsebody.md)\>**
|
|
619
|
-
|
|
620
|
-
### Errors
|
|
621
|
-
|
|
622
|
-
| Error Object | Status Code | Content Type |
|
|
623
|
-
| ----------------- | ----------------- | ----------------- |
|
|
624
|
-
| errors.BadRequest | 400 | application/json |
|
|
625
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
## getNotificationPreferences
|
|
629
|
-
|
|
630
|
-
The Retrieve Notification Preferences API allows clients to fetch a user's notification preferences based on their unique user identifier (user_id).
|
|
631
|
-
|
|
632
|
-
### Example Usage
|
|
633
|
-
|
|
634
|
-
```typescript
|
|
635
|
-
import { CeStorefront } from "ce-storefront";
|
|
636
|
-
|
|
637
|
-
const ceStorefront = new CeStorefront({
|
|
638
|
-
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
639
|
-
});
|
|
640
|
-
|
|
641
|
-
async function run() {
|
|
642
|
-
const result = await ceStorefront.auth.user.getNotificationPreferences({
|
|
643
|
-
id: "<id>",
|
|
644
|
-
});
|
|
645
|
-
|
|
646
|
-
// Handle the result
|
|
647
|
-
console.log(result)
|
|
648
|
-
}
|
|
649
|
-
|
|
650
|
-
run();
|
|
651
|
-
```
|
|
652
|
-
|
|
653
|
-
### Standalone function
|
|
654
|
-
|
|
655
|
-
The standalone function version of this method:
|
|
656
|
-
|
|
657
|
-
```typescript
|
|
658
|
-
import { CeStorefrontCore } from "ce-storefront/core.js";
|
|
659
|
-
import { authUserGetNotificationPreferences } from "ce-storefront/funcs/authUserGetNotificationPreferences.js";
|
|
660
|
-
|
|
661
|
-
// Use `CeStorefrontCore` for best tree-shaking performance.
|
|
662
|
-
// You can create one instance of it to use across an application.
|
|
663
|
-
const ceStorefront = new CeStorefrontCore({
|
|
664
|
-
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
665
|
-
});
|
|
666
|
-
|
|
667
|
-
async function run() {
|
|
668
|
-
const res = await authUserGetNotificationPreferences(ceStorefront, {
|
|
669
|
-
id: "<id>",
|
|
670
|
-
});
|
|
671
|
-
|
|
672
|
-
if (!res.ok) {
|
|
673
|
-
throw res.error;
|
|
674
|
-
}
|
|
675
|
-
|
|
676
|
-
const { value: result } = res;
|
|
677
|
-
|
|
678
|
-
// Handle the result
|
|
679
|
-
console.log(result)
|
|
680
|
-
}
|
|
681
|
-
|
|
682
|
-
run();
|
|
683
|
-
```
|
|
684
|
-
|
|
685
|
-
### Parameters
|
|
686
|
-
|
|
687
|
-
| Parameter | Type | Required | Description |
|
|
688
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
689
|
-
| `request` | [operations.GetAuthUserIdNotificationPreferencesRequest](../../models/operations/getauthuseridnotificationpreferencesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
690
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
691
|
-
| `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. |
|
|
692
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
693
|
-
|
|
694
|
-
### Response
|
|
695
|
-
|
|
696
|
-
**Promise\<[operations.GetAuthUserIdNotificationPreferencesResponseBody](../../models/operations/getauthuseridnotificationpreferencesresponsebody.md)\>**
|
|
697
|
-
|
|
698
|
-
### Errors
|
|
699
|
-
|
|
700
|
-
| Error Object | Status Code | Content Type |
|
|
701
|
-
| --------------- | --------------- | --------------- |
|
|
702
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
## createNotificationPreferences
|
|
706
|
-
|
|
707
|
-
Create user notification preferences API allows clients to create a user's notification preferences based on their unique user identifier (user_id).
|
|
708
|
-
|
|
709
|
-
### Example Usage
|
|
710
|
-
|
|
711
|
-
```typescript
|
|
712
|
-
import { CeStorefront } from "ce-storefront";
|
|
713
|
-
|
|
714
|
-
const ceStorefront = new CeStorefront({
|
|
715
|
-
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
716
|
-
});
|
|
717
|
-
|
|
718
|
-
async function run() {
|
|
719
|
-
const result = await ceStorefront.auth.user.createNotificationPreferences({
|
|
720
|
-
id: "<id>",
|
|
721
|
-
});
|
|
722
|
-
|
|
723
|
-
// Handle the result
|
|
724
|
-
console.log(result)
|
|
725
|
-
}
|
|
726
|
-
|
|
727
|
-
run();
|
|
728
|
-
```
|
|
729
|
-
|
|
730
|
-
### Standalone function
|
|
731
|
-
|
|
732
|
-
The standalone function version of this method:
|
|
733
|
-
|
|
734
|
-
```typescript
|
|
735
|
-
import { CeStorefrontCore } from "ce-storefront/core.js";
|
|
736
|
-
import { authUserCreateNotificationPreferences } from "ce-storefront/funcs/authUserCreateNotificationPreferences.js";
|
|
737
|
-
|
|
738
|
-
// Use `CeStorefrontCore` for best tree-shaking performance.
|
|
739
|
-
// You can create one instance of it to use across an application.
|
|
740
|
-
const ceStorefront = new CeStorefrontCore({
|
|
741
|
-
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
742
|
-
});
|
|
743
|
-
|
|
744
|
-
async function run() {
|
|
745
|
-
const res = await authUserCreateNotificationPreferences(ceStorefront, {
|
|
746
|
-
id: "<id>",
|
|
747
|
-
});
|
|
748
|
-
|
|
749
|
-
if (!res.ok) {
|
|
750
|
-
throw res.error;
|
|
751
|
-
}
|
|
752
|
-
|
|
753
|
-
const { value: result } = res;
|
|
754
|
-
|
|
755
|
-
// Handle the result
|
|
756
|
-
console.log(result)
|
|
757
|
-
}
|
|
758
|
-
|
|
759
|
-
run();
|
|
760
|
-
```
|
|
761
|
-
|
|
762
|
-
### Parameters
|
|
763
|
-
|
|
764
|
-
| Parameter | Type | Required | Description |
|
|
765
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
766
|
-
| `request` | [operations.PostAuthUserIdNotificationPreferencesRequest](../../models/operations/postauthuseridnotificationpreferencesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
767
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
768
|
-
| `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. |
|
|
769
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
770
|
-
|
|
771
|
-
### Response
|
|
772
|
-
|
|
773
|
-
**Promise\<[operations.PostAuthUserIdNotificationPreferencesResponseBody](../../models/operations/postauthuseridnotificationpreferencesresponsebody.md)\>**
|
|
774
|
-
|
|
775
|
-
### Errors
|
|
776
|
-
|
|
777
|
-
| Error Object | Status Code | Content Type |
|
|
778
|
-
| --------------- | --------------- | --------------- |
|
|
779
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
780
|
-
|
|
781
|
-
|
|
782
|
-
## updateNotificationPreferences
|
|
783
|
-
|
|
784
|
-
Update Notification Preferences API allows clients to update a user's notification preferences based on their unique user identifier (user_id).
|
|
785
|
-
|
|
786
|
-
### Example Usage
|
|
787
|
-
|
|
788
|
-
```typescript
|
|
789
|
-
import { CeStorefront } from "ce-storefront";
|
|
790
|
-
|
|
791
|
-
const ceStorefront = new CeStorefront({
|
|
792
|
-
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
793
|
-
});
|
|
794
|
-
|
|
795
|
-
async function run() {
|
|
796
|
-
const result = await ceStorefront.auth.user.updateNotificationPreferences({
|
|
797
|
-
id: "<id>",
|
|
798
|
-
});
|
|
799
|
-
|
|
800
|
-
// Handle the result
|
|
801
|
-
console.log(result)
|
|
802
|
-
}
|
|
803
|
-
|
|
804
|
-
run();
|
|
805
|
-
```
|
|
806
|
-
|
|
807
|
-
### Standalone function
|
|
808
|
-
|
|
809
|
-
The standalone function version of this method:
|
|
810
|
-
|
|
811
|
-
```typescript
|
|
812
|
-
import { CeStorefrontCore } from "ce-storefront/core.js";
|
|
813
|
-
import { authUserUpdateNotificationPreferences } from "ce-storefront/funcs/authUserUpdateNotificationPreferences.js";
|
|
814
|
-
|
|
815
|
-
// Use `CeStorefrontCore` for best tree-shaking performance.
|
|
816
|
-
// You can create one instance of it to use across an application.
|
|
817
|
-
const ceStorefront = new CeStorefrontCore({
|
|
818
|
-
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
819
|
-
});
|
|
820
|
-
|
|
821
|
-
async function run() {
|
|
822
|
-
const res = await authUserUpdateNotificationPreferences(ceStorefront, {
|
|
823
|
-
id: "<id>",
|
|
824
|
-
});
|
|
825
|
-
|
|
826
|
-
if (!res.ok) {
|
|
827
|
-
throw res.error;
|
|
828
|
-
}
|
|
829
|
-
|
|
830
|
-
const { value: result } = res;
|
|
831
|
-
|
|
832
|
-
// Handle the result
|
|
833
|
-
console.log(result)
|
|
834
|
-
}
|
|
835
|
-
|
|
836
|
-
run();
|
|
837
|
-
```
|
|
838
|
-
|
|
839
|
-
### Parameters
|
|
840
|
-
|
|
841
|
-
| Parameter | Type | Required | Description |
|
|
842
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
843
|
-
| `request` | [operations.PutAuthUserIdNotificationPreferencesRequest](../../models/operations/putauthuseridnotificationpreferencesrequest.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
844
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
845
|
-
| `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. |
|
|
846
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
847
|
-
|
|
848
|
-
### Response
|
|
849
|
-
|
|
850
|
-
**Promise\<[operations.PutAuthUserIdNotificationPreferencesResponseBody](../../models/operations/putauthuseridnotificationpreferencesresponsebody.md)\>**
|
|
851
|
-
|
|
852
|
-
### Errors
|
|
853
|
-
|
|
854
|
-
| Error Object | Status Code | Content Type |
|
|
855
|
-
| --------------- | --------------- | --------------- |
|
|
856
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
857
|
-
|
|
858
|
-
|
|
859
|
-
## logout
|
|
860
|
-
|
|
861
|
-
The Logout User API initiate the logout process for a user. Upon a successful request, the API responds with a confirmation message. If the user is not found or there's an issue with the request, an error response is returned with an appropriate message.
|
|
862
|
-
|
|
863
|
-
### Example Usage
|
|
864
|
-
|
|
865
|
-
```typescript
|
|
866
|
-
import { CeStorefront } from "ce-storefront";
|
|
867
|
-
|
|
868
|
-
const ceStorefront = new CeStorefront({
|
|
869
|
-
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
870
|
-
});
|
|
871
|
-
|
|
872
|
-
async function run() {
|
|
873
|
-
const result = await ceStorefront.auth.user.logout();
|
|
874
|
-
|
|
875
|
-
// Handle the result
|
|
876
|
-
console.log(result)
|
|
877
|
-
}
|
|
878
|
-
|
|
879
|
-
run();
|
|
880
|
-
```
|
|
881
|
-
|
|
882
|
-
### Standalone function
|
|
883
|
-
|
|
884
|
-
The standalone function version of this method:
|
|
885
|
-
|
|
886
|
-
```typescript
|
|
887
|
-
import { CeStorefrontCore } from "ce-storefront/core.js";
|
|
888
|
-
import { authUserLogout } from "ce-storefront/funcs/authUserLogout.js";
|
|
889
|
-
|
|
890
|
-
// Use `CeStorefrontCore` for best tree-shaking performance.
|
|
891
|
-
// You can create one instance of it to use across an application.
|
|
892
|
-
const ceStorefront = new CeStorefrontCore({
|
|
893
|
-
authorization: "<YOUR_BEARER_TOKEN_HERE>",
|
|
894
|
-
});
|
|
895
|
-
|
|
896
|
-
async function run() {
|
|
897
|
-
const res = await authUserLogout(ceStorefront);
|
|
898
|
-
|
|
899
|
-
if (!res.ok) {
|
|
900
|
-
throw res.error;
|
|
901
|
-
}
|
|
902
|
-
|
|
903
|
-
const { value: result } = res;
|
|
904
|
-
|
|
905
|
-
// Handle the result
|
|
906
|
-
console.log(result)
|
|
907
|
-
}
|
|
908
|
-
|
|
909
|
-
run();
|
|
910
|
-
```
|
|
911
|
-
|
|
912
|
-
### Parameters
|
|
913
|
-
|
|
914
|
-
| Parameter | Type | Required | Description |
|
|
915
|
-
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
916
|
-
| `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
|
|
917
|
-
| `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. |
|
|
918
|
-
| `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
|
|
919
|
-
|
|
920
|
-
### Response
|
|
921
|
-
|
|
922
|
-
**Promise\<[operations.PostAuthLogoutResponseBody](../../models/operations/postauthlogoutresponsebody.md)\>**
|
|
923
|
-
|
|
924
|
-
### Errors
|
|
925
|
-
|
|
926
|
-
| Error Object | Status Code | Content Type |
|
|
927
|
-
| --------------- | --------------- | --------------- |
|
|
928
|
-
| errors.SDKError | 4xx-5xx | */* |
|
|
2
|
+
(*user*)
|