ce-storefront 0.15.21 → 0.15.23
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/README.md +2 -2
- package/docs/sdks/auth/README.md +10 -10
- package/docs/sdks/carts/README.md +13 -13
- package/docs/sdks/catalog/README.md +11 -11
- package/docs/sdks/cestorefront/README.md +1 -1
- package/docs/sdks/common/README.md +1 -1
- package/docs/sdks/customers/README.md +7 -7
- package/docs/sdks/orders/README.md +7 -8
- package/docs/sdks/shipping/README.md +3 -3
- package/esm/funcs/authGenerateOtp.d.ts +1 -1
- package/esm/funcs/authGenerateOtp.js +1 -1
- package/esm/funcs/authGetAnonymousToken.d.ts +1 -1
- package/esm/funcs/authGetAnonymousToken.js +1 -1
- package/esm/funcs/authGetUserDetail.d.ts +1 -1
- package/esm/funcs/authGetUserDetail.js +1 -1
- package/esm/funcs/authLoginWithEmail.d.ts +1 -1
- package/esm/funcs/authLoginWithEmail.js +1 -1
- package/esm/funcs/authLoginWithPhone.d.ts +1 -1
- package/esm/funcs/authLoginWithPhone.js +1 -1
- package/esm/funcs/authLoginWithWhatsapp.d.ts +1 -1
- package/esm/funcs/authLoginWithWhatsapp.js +1 -1
- package/esm/funcs/authLogout.d.ts +1 -1
- package/esm/funcs/authLogout.js +1 -1
- package/esm/funcs/authRefreshToken.d.ts +1 -1
- package/esm/funcs/authRefreshToken.js +1 -1
- package/esm/funcs/authUpdateUser.d.ts +1 -1
- package/esm/funcs/authUpdateUser.js +1 -1
- package/esm/funcs/authVerifyOtp.d.ts +1 -1
- package/esm/funcs/authVerifyOtp.js +1 -1
- package/esm/funcs/cartsAddShippingMethod.d.ts +1 -1
- package/esm/funcs/cartsAddShippingMethod.js +1 -1
- package/esm/funcs/cartsApplyCoupon.d.ts +1 -1
- package/esm/funcs/cartsApplyCoupon.js +1 -1
- package/esm/funcs/cartsCreateCart.d.ts +1 -1
- package/esm/funcs/cartsCreateCart.js +1 -1
- package/esm/funcs/cartsCreateCartAddress.d.ts +1 -1
- package/esm/funcs/cartsCreateCartAddress.js +1 -1
- package/esm/funcs/cartsDeleteCart.d.ts +1 -1
- package/esm/funcs/cartsDeleteCart.js +1 -1
- package/esm/funcs/cartsGetCart.d.ts +1 -1
- package/esm/funcs/cartsGetCart.js +1 -1
- package/esm/funcs/cartsGetUserCart.d.ts +1 -1
- package/esm/funcs/cartsGetUserCart.js +1 -1
- package/esm/funcs/cartsRedeemLoyaltyPoints.d.ts +1 -1
- package/esm/funcs/cartsRedeemLoyaltyPoints.js +1 -1
- package/esm/funcs/cartsRemoveCoupon.d.ts +1 -1
- package/esm/funcs/cartsRemoveCoupon.js +1 -1
- package/esm/funcs/cartsRemoveLoyaltyPoints.d.ts +1 -1
- package/esm/funcs/cartsRemoveLoyaltyPoints.js +1 -1
- package/esm/funcs/cartsRemoveUserCart.d.ts +1 -1
- package/esm/funcs/cartsRemoveUserCart.js +1 -1
- package/esm/funcs/cartsUpdateCart.d.ts +1 -1
- package/esm/funcs/cartsUpdateCart.js +1 -1
- package/esm/funcs/cartsUpdateFulfillmentPreference.d.ts +1 -1
- package/esm/funcs/cartsUpdateFulfillmentPreference.js +1 -1
- package/esm/funcs/catalogGetProductDetail.d.ts +1 -1
- package/esm/funcs/catalogGetProductDetail.js +1 -1
- package/esm/funcs/catalogGetVariantDetail.d.ts +1 -1
- package/esm/funcs/catalogGetVariantDetail.js +1 -1
- package/esm/funcs/catalogListCategories.d.ts +1 -1
- package/esm/funcs/catalogListCategories.js +1 -1
- package/esm/funcs/catalogListCrosssellProducts.d.ts +1 -1
- package/esm/funcs/catalogListCrosssellProducts.js +1 -1
- package/esm/funcs/catalogListProductReviews.d.ts +1 -1
- package/esm/funcs/catalogListProductReviews.js +1 -1
- package/esm/funcs/catalogListProductVariants.d.ts +1 -1
- package/esm/funcs/catalogListProductVariants.js +1 -1
- package/esm/funcs/catalogListProducts.d.ts +1 -1
- package/esm/funcs/catalogListProducts.js +1 -1
- package/esm/funcs/catalogListSimilarProducts.d.ts +1 -1
- package/esm/funcs/catalogListSimilarProducts.js +1 -1
- package/esm/funcs/catalogListSkus.d.ts +1 -1
- package/esm/funcs/catalogListSkus.js +1 -1
- package/esm/funcs/catalogListUpsellProducts.d.ts +1 -1
- package/esm/funcs/catalogListUpsellProducts.js +1 -1
- package/esm/funcs/catalogSearchProducts.d.ts +1 -1
- package/esm/funcs/catalogSearchProducts.js +1 -1
- package/esm/funcs/commonListCountryPincodes.d.ts +1 -1
- package/esm/funcs/commonListCountryPincodes.js +1 -1
- package/esm/funcs/customersCreateAddress.d.ts +1 -1
- package/esm/funcs/customersCreateAddress.js +1 -1
- package/esm/funcs/customersDeleteAddress.d.ts +1 -1
- package/esm/funcs/customersDeleteAddress.js +1 -1
- package/esm/funcs/customersGetAddressDetail.d.ts +1 -1
- package/esm/funcs/customersGetAddressDetail.js +1 -1
- package/esm/funcs/customersGetLoyaltyDetails.d.ts +1 -1
- package/esm/funcs/customersGetLoyaltyDetails.js +1 -1
- package/esm/funcs/customersListAddresses.d.ts +1 -1
- package/esm/funcs/customersListAddresses.js +1 -1
- package/esm/funcs/customersListUserReviews.d.ts +1 -1
- package/esm/funcs/customersListUserReviews.js +1 -1
- package/esm/funcs/customersUpdateAddressDetail.d.ts +1 -1
- package/esm/funcs/customersUpdateAddressDetail.js +1 -1
- package/esm/funcs/ordersCancelOrder.d.ts +1 -1
- package/esm/funcs/ordersCancelOrder.js +1 -1
- package/esm/funcs/ordersCreateOrder.d.ts +1 -1
- package/esm/funcs/ordersCreateOrder.js +1 -1
- package/esm/funcs/ordersGetOrderDetail.d.ts +1 -1
- package/esm/funcs/ordersGetOrderDetail.js +1 -1
- package/esm/funcs/ordersGetPaymentStatus.d.ts +2 -2
- package/esm/funcs/ordersGetPaymentStatus.d.ts.map +1 -1
- package/esm/funcs/ordersGetPaymentStatus.js +3 -3
- package/esm/funcs/ordersGetPaymentStatus.js.map +1 -1
- package/esm/funcs/ordersListOrderShipments.d.ts +1 -1
- package/esm/funcs/ordersListOrderShipments.js +1 -1
- package/esm/funcs/ordersListOrders.d.ts +1 -1
- package/esm/funcs/ordersListOrders.js +1 -1
- package/esm/funcs/ordersRetryOrderPayment.d.ts +1 -1
- package/esm/funcs/ordersRetryOrderPayment.js +1 -1
- package/esm/funcs/shippingCheckServiceability.d.ts +1 -1
- package/esm/funcs/shippingCheckServiceability.js +1 -1
- package/esm/funcs/shippingFulfillmentOptions.d.ts +1 -1
- package/esm/funcs/shippingFulfillmentOptions.js +1 -1
- package/esm/funcs/shippingShippingMethods.d.ts +1 -1
- package/esm/funcs/shippingShippingMethods.js +1 -1
- package/esm/lib/config.d.ts +3 -3
- package/esm/lib/config.js +3 -3
- package/esm/models/components/anonymoususer.d.ts +1 -1
- package/esm/models/components/appliedcoupon.d.ts +1 -1
- package/esm/models/components/appliedpromotion.d.ts +1 -1
- package/esm/models/components/banktransfer.d.ts +1 -1
- package/esm/models/components/booleanattribute.d.ts +1 -1
- package/esm/models/components/cardpayment.d.ts +1 -1
- package/esm/models/components/cart.d.ts +1 -1
- package/esm/models/components/cartbasedserviceabilitycheck.d.ts +1 -1
- package/esm/models/components/cartitem.d.ts +1 -1
- package/esm/models/components/category.d.ts +1 -1
- package/esm/models/components/collectinstore.d.ts +1 -1
- package/esm/models/components/collectinstorefulfillment.d.ts +1 -1
- package/esm/models/components/colorattribute.d.ts +1 -1
- package/esm/models/components/coloroption.d.ts +1 -1
- package/esm/models/components/currency.d.ts +1 -1
- package/esm/models/components/customeraddress.d.ts +1 -1
- package/esm/models/components/customeraddressinput.d.ts +1 -1
- package/esm/models/components/customerloyalty.d.ts +1 -1
- package/esm/models/components/customerreadyforreview.d.ts +1 -1
- package/esm/models/components/customerreview.d.ts +1 -1
- package/esm/models/components/dateattribute.d.ts +1 -1
- package/esm/models/components/deliveryfulfillment.d.ts +1 -1
- package/esm/models/components/discountbasedpromotion.d.ts +1 -1
- package/esm/models/components/fixedpricepromotion.d.ts +1 -1
- package/esm/models/components/freegoodspromotion.d.ts +1 -1
- package/esm/models/components/fulfillmentpreference.d.ts +2 -2
- package/esm/models/components/fulfillmentpreference.js +1 -1
- package/esm/models/components/generateotpwithemail.d.ts +1 -1
- package/esm/models/components/generateotpwithphone.d.ts +1 -1
- package/esm/models/components/item.d.ts +1 -1
- package/esm/models/components/juspaypaymentgatewayparams.d.ts +1 -1
- package/esm/models/components/juspaypaymentinfo.d.ts +1 -1
- package/esm/models/components/multiselectattribute.d.ts +1 -1
- package/esm/models/components/netbankingpayment.d.ts +1 -1
- package/esm/models/components/notificationchannelpreferences.d.ts +1 -1
- package/esm/models/components/notificationpreferences.d.ts +1 -1
- package/esm/models/components/numberattribute.d.ts +1 -1
- package/esm/models/components/order.d.ts +1 -1
- package/esm/models/components/orderdetail.d.ts +1 -1
- package/esm/models/components/orderitem.d.ts +1 -1
- package/esm/models/components/orderlist.d.ts +1 -1
- package/esm/models/components/orderpayment.d.ts +1 -1
- package/esm/models/components/ordershipment.d.ts +1 -1
- package/esm/models/components/pagination.d.ts +1 -1
- package/esm/models/components/paymentgateway.d.ts +2 -2
- package/esm/models/components/paymentgateway.js +1 -1
- package/esm/models/components/paymentgatewayparams.d.ts +1 -1
- package/esm/models/components/payupaymentgatewayparams.d.ts +1 -1
- package/esm/models/components/payupaymentinfo.d.ts +1 -1
- package/esm/models/components/pincode.d.ts +1 -1
- package/esm/models/components/pincodeserviceability.d.ts +1 -1
- package/esm/models/components/product.d.ts +1 -1
- package/esm/models/components/productattribute.d.ts +1 -1
- package/esm/models/components/productbundleitem.d.ts +1 -1
- package/esm/models/components/productcategory.d.ts +1 -1
- package/esm/models/components/productdetail.d.ts +1 -1
- package/esm/models/components/productimage.d.ts +1 -1
- package/esm/models/components/productpricing.d.ts +1 -1
- package/esm/models/components/productpromotion.d.ts +1 -1
- package/esm/models/components/productreview.d.ts +1 -1
- package/esm/models/components/productshipping.d.ts +1 -1
- package/esm/models/components/productsubscription.d.ts +1 -1
- package/esm/models/components/productvideo.d.ts +1 -1
- package/esm/models/components/searchproduct.d.ts +1 -1
- package/esm/models/components/seo.d.ts +1 -1
- package/esm/models/components/shipmentitem.d.ts +1 -1
- package/esm/models/components/singleselectattribute.d.ts +1 -1
- package/esm/models/components/singleselectoption.d.ts +1 -1
- package/esm/models/components/textattribute.d.ts +1 -1
- package/esm/models/components/updatecartitem.d.ts +1 -1
- package/esm/models/components/upipayment.d.ts +1 -1
- package/esm/models/components/user.d.ts +2 -2
- package/esm/models/components/variant.d.ts +1 -1
- package/esm/models/components/variantdetail.d.ts +1 -1
- package/esm/models/components/variantoption.d.ts +1 -1
- package/esm/models/components/volumebasedpromotion.d.ts +1 -1
- package/esm/models/components/walletpayment.d.ts +1 -1
- package/esm/models/operations/createaddress.d.ts +1 -1
- package/esm/models/operations/getaddressdetail.d.ts +1 -1
- package/esm/models/operations/listaddresses.d.ts +1 -1
- package/esm/models/operations/updateaddressdetail.d.ts +1 -1
- package/esm/sdk/auth.d.ts +10 -10
- package/esm/sdk/auth.js +10 -10
- package/esm/sdk/carts.d.ts +13 -13
- package/esm/sdk/carts.js +13 -13
- package/esm/sdk/catalog.d.ts +11 -11
- package/esm/sdk/catalog.js +11 -11
- package/esm/sdk/common.d.ts +1 -1
- package/esm/sdk/common.js +1 -1
- package/esm/sdk/customers.d.ts +7 -7
- package/esm/sdk/customers.js +7 -7
- package/esm/sdk/orders.d.ts +7 -7
- package/esm/sdk/orders.js +7 -7
- package/esm/sdk/shipping.d.ts +3 -3
- package/esm/sdk/shipping.js +3 -3
- package/examples/authGetAnonymousToken.example.ts +1 -1
- package/examples/package-lock.json +1 -1
- package/jsr.json +1 -1
- package/package.json +1 -1
- package/src/funcs/authGenerateOtp.ts +1 -1
- package/src/funcs/authGetAnonymousToken.ts +1 -1
- package/src/funcs/authGetUserDetail.ts +1 -1
- package/src/funcs/authLoginWithEmail.ts +1 -1
- package/src/funcs/authLoginWithPhone.ts +1 -1
- package/src/funcs/authLoginWithWhatsapp.ts +1 -1
- package/src/funcs/authLogout.ts +1 -1
- package/src/funcs/authRefreshToken.ts +1 -1
- package/src/funcs/authUpdateUser.ts +1 -1
- package/src/funcs/authVerifyOtp.ts +1 -1
- package/src/funcs/cartsAddShippingMethod.ts +1 -1
- package/src/funcs/cartsApplyCoupon.ts +1 -1
- package/src/funcs/cartsCreateCart.ts +1 -1
- package/src/funcs/cartsCreateCartAddress.ts +1 -1
- package/src/funcs/cartsDeleteCart.ts +1 -1
- package/src/funcs/cartsGetCart.ts +1 -1
- package/src/funcs/cartsGetUserCart.ts +1 -1
- package/src/funcs/cartsRedeemLoyaltyPoints.ts +1 -1
- package/src/funcs/cartsRemoveCoupon.ts +1 -1
- package/src/funcs/cartsRemoveLoyaltyPoints.ts +1 -1
- package/src/funcs/cartsRemoveUserCart.ts +1 -1
- package/src/funcs/cartsUpdateCart.ts +1 -1
- package/src/funcs/cartsUpdateFulfillmentPreference.ts +1 -1
- package/src/funcs/catalogGetProductDetail.ts +1 -1
- package/src/funcs/catalogGetVariantDetail.ts +1 -1
- package/src/funcs/catalogListCategories.ts +1 -1
- package/src/funcs/catalogListCrosssellProducts.ts +1 -1
- package/src/funcs/catalogListProductReviews.ts +1 -1
- package/src/funcs/catalogListProductVariants.ts +1 -1
- package/src/funcs/catalogListProducts.ts +1 -1
- package/src/funcs/catalogListSimilarProducts.ts +1 -1
- package/src/funcs/catalogListSkus.ts +1 -1
- package/src/funcs/catalogListUpsellProducts.ts +1 -1
- package/src/funcs/catalogSearchProducts.ts +1 -1
- package/src/funcs/commonListCountryPincodes.ts +1 -1
- package/src/funcs/customersCreateAddress.ts +1 -1
- package/src/funcs/customersDeleteAddress.ts +1 -1
- package/src/funcs/customersGetAddressDetail.ts +1 -1
- package/src/funcs/customersGetLoyaltyDetails.ts +1 -1
- package/src/funcs/customersListAddresses.ts +1 -1
- package/src/funcs/customersListUserReviews.ts +1 -1
- package/src/funcs/customersUpdateAddressDetail.ts +1 -1
- package/src/funcs/ordersCancelOrder.ts +1 -1
- package/src/funcs/ordersCreateOrder.ts +1 -1
- package/src/funcs/ordersGetOrderDetail.ts +1 -1
- package/src/funcs/ordersGetPaymentStatus.ts +2 -6
- package/src/funcs/ordersListOrderShipments.ts +1 -1
- package/src/funcs/ordersListOrders.ts +1 -1
- package/src/funcs/ordersRetryOrderPayment.ts +1 -1
- package/src/funcs/shippingCheckServiceability.ts +1 -1
- package/src/funcs/shippingFulfillmentOptions.ts +1 -1
- package/src/funcs/shippingShippingMethods.ts +1 -1
- package/src/lib/config.ts +3 -3
- package/src/models/components/anonymoususer.ts +1 -1
- package/src/models/components/appliedcoupon.ts +1 -1
- package/src/models/components/appliedpromotion.ts +1 -1
- package/src/models/components/banktransfer.ts +1 -1
- package/src/models/components/booleanattribute.ts +1 -1
- package/src/models/components/cardpayment.ts +1 -1
- package/src/models/components/cart.ts +1 -1
- package/src/models/components/cartbasedserviceabilitycheck.ts +1 -1
- package/src/models/components/cartitem.ts +1 -1
- package/src/models/components/category.ts +1 -1
- package/src/models/components/collectinstore.ts +1 -1
- package/src/models/components/collectinstorefulfillment.ts +1 -1
- package/src/models/components/colorattribute.ts +1 -1
- package/src/models/components/coloroption.ts +1 -1
- package/src/models/components/currency.ts +1 -1
- package/src/models/components/customeraddress.ts +1 -1
- package/src/models/components/customeraddressinput.ts +1 -1
- package/src/models/components/customerloyalty.ts +1 -1
- package/src/models/components/customerreadyforreview.ts +1 -1
- package/src/models/components/customerreview.ts +1 -1
- package/src/models/components/dateattribute.ts +1 -1
- package/src/models/components/deliveryfulfillment.ts +1 -1
- package/src/models/components/discountbasedpromotion.ts +1 -1
- package/src/models/components/fixedpricepromotion.ts +1 -1
- package/src/models/components/freegoodspromotion.ts +1 -1
- package/src/models/components/fulfillmentpreference.ts +2 -2
- package/src/models/components/generateotpwithemail.ts +1 -1
- package/src/models/components/generateotpwithphone.ts +1 -1
- package/src/models/components/item.ts +1 -1
- package/src/models/components/juspaypaymentgatewayparams.ts +1 -1
- package/src/models/components/juspaypaymentinfo.ts +1 -1
- package/src/models/components/multiselectattribute.ts +1 -1
- package/src/models/components/netbankingpayment.ts +1 -1
- package/src/models/components/notificationchannelpreferences.ts +1 -1
- package/src/models/components/notificationpreferences.ts +1 -1
- package/src/models/components/numberattribute.ts +1 -1
- package/src/models/components/order.ts +1 -1
- package/src/models/components/orderdetail.ts +1 -1
- package/src/models/components/orderitem.ts +1 -1
- package/src/models/components/orderlist.ts +1 -1
- package/src/models/components/orderpayment.ts +1 -1
- package/src/models/components/ordershipment.ts +1 -1
- package/src/models/components/pagination.ts +1 -1
- package/src/models/components/paymentgateway.ts +2 -2
- package/src/models/components/paymentgatewayparams.ts +1 -1
- package/src/models/components/payupaymentgatewayparams.ts +1 -1
- package/src/models/components/payupaymentinfo.ts +1 -1
- package/src/models/components/pincode.ts +1 -1
- package/src/models/components/pincodeserviceability.ts +1 -1
- package/src/models/components/product.ts +1 -1
- package/src/models/components/productattribute.ts +1 -1
- package/src/models/components/productbundleitem.ts +1 -1
- package/src/models/components/productcategory.ts +1 -1
- package/src/models/components/productdetail.ts +1 -1
- package/src/models/components/productimage.ts +1 -1
- package/src/models/components/productpricing.ts +1 -1
- package/src/models/components/productpromotion.ts +1 -1
- package/src/models/components/productreview.ts +1 -1
- package/src/models/components/productshipping.ts +1 -1
- package/src/models/components/productsubscription.ts +1 -1
- package/src/models/components/productvideo.ts +1 -1
- package/src/models/components/searchproduct.ts +1 -1
- package/src/models/components/seo.ts +1 -1
- package/src/models/components/shipmentitem.ts +1 -1
- package/src/models/components/singleselectattribute.ts +1 -1
- package/src/models/components/singleselectoption.ts +1 -1
- package/src/models/components/textattribute.ts +1 -1
- package/src/models/components/updatecartitem.ts +1 -1
- package/src/models/components/upipayment.ts +1 -1
- package/src/models/components/user.ts +2 -2
- package/src/models/components/variant.ts +1 -1
- package/src/models/components/variantdetail.ts +1 -1
- package/src/models/components/variantoption.ts +1 -1
- package/src/models/components/volumebasedpromotion.ts +1 -1
- package/src/models/components/walletpayment.ts +1 -1
- package/src/models/operations/createaddress.ts +1 -1
- package/src/models/operations/getaddressdetail.ts +1 -1
- package/src/models/operations/listaddresses.ts +1 -1
- package/src/models/operations/updateaddressdetail.ts +1 -1
- package/src/sdk/auth.ts +10 -10
- package/src/sdk/carts.ts +13 -13
- package/src/sdk/catalog.ts +11 -11
- package/src/sdk/common.ts +1 -1
- package/src/sdk/customers.ts +7 -7
- package/src/sdk/orders.ts +7 -7
- package/src/sdk/shipping.ts +3 -3
package/README.md
CHANGED
|
@@ -7,7 +7,7 @@ CE Storefront APIs: CE Storefront APIs
|
|
|
7
7
|
|
|
8
8
|
Commerce Engine Storefront APIs
|
|
9
9
|
|
|
10
|
-
For more information about the API: [Commerce Engine API Reference Documentation](https://
|
|
10
|
+
For more information about the API: [Commerce Engine API Reference Documentation](https://llm-docs.commercengine.io)
|
|
11
11
|
<!-- End Summary [summary] -->
|
|
12
12
|
|
|
13
13
|
<!-- Start Table of Contents [toc] -->
|
|
@@ -385,7 +385,7 @@ run();
|
|
|
385
385
|
|
|
386
386
|
**Inherit from [`CeStorefrontError`](./src/models/errors/cestorefronterror.ts)**:
|
|
387
387
|
* [`NotFound`](./src/models/errors/notfound.ts): Requested resource not found. Status code `404`. Applicable to 41 of 52 methods.*
|
|
388
|
-
* [`BadRequest`](./src/models/errors/badrequest.ts): Bad request. Status code `400`. Applicable to
|
|
388
|
+
* [`BadRequest`](./src/models/errors/badrequest.ts): Bad request. Status code `400`. Applicable to 30 of 52 methods.*
|
|
389
389
|
* [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
|
|
390
390
|
|
|
391
391
|
</details>
|
package/docs/sdks/auth/README.md
CHANGED
|
@@ -22,7 +22,7 @@ This API’s focus is on anonymous users who have not undergone the formal accou
|
|
|
22
22
|
To interact with the system, each anonymous user is issued an access token. This access token plays a dual role in the system: it serves as a means of authenticating the user and it also acts as a tool for authorization, determining what actions the authenticated user is permitted to perform.
|
|
23
23
|
|
|
24
24
|
API reference for the get-anonymous-token operation
|
|
25
|
-
<https://
|
|
25
|
+
<https://llm-docs.commercengine.io/operations/get-anonymous-token>
|
|
26
26
|
|
|
27
27
|
### Example Usage
|
|
28
28
|
|
|
@@ -96,7 +96,7 @@ run();
|
|
|
96
96
|
Generating a One-Time Password (OTP) typically involves creating a random code that is sent to a user for authentication or verification purposes.
|
|
97
97
|
|
|
98
98
|
API reference for the generate-otp operation
|
|
99
|
-
<https://
|
|
99
|
+
<https://llm-docs.commercengine.io/operations/generate-otp>
|
|
100
100
|
|
|
101
101
|
### Example Usage
|
|
102
102
|
|
|
@@ -178,7 +178,7 @@ run();
|
|
|
178
178
|
This API enables users to authenticate into the system using their email address. It provides a secure way for users to Login by verifying their identity through a one-time password (OTP) sent to their email address.
|
|
179
179
|
|
|
180
180
|
API reference for the login-with-email operation
|
|
181
|
-
<https://
|
|
181
|
+
<https://llm-docs.commercengine.io/operations/login-with-email>
|
|
182
182
|
|
|
183
183
|
### Example Usage
|
|
184
184
|
|
|
@@ -257,7 +257,7 @@ run();
|
|
|
257
257
|
This API enables users to authenticate into the system using their phone number. It provides a secure way for users to log in by verifying their identity through a one-time password (OTP) sent to their registered phone.
|
|
258
258
|
|
|
259
259
|
API reference for the login-with-phone operation
|
|
260
|
-
<https://
|
|
260
|
+
<https://llm-docs.commercengine.io/operations/login-with-phone>
|
|
261
261
|
|
|
262
262
|
### Example Usage
|
|
263
263
|
|
|
@@ -336,7 +336,7 @@ run();
|
|
|
336
336
|
This API enables users to authenticate into the system using their WhatsApp Number. It provides a secure way for users to Login by verifying their identity through a one-time password (OTP) sent to their WhatsApp Number.
|
|
337
337
|
|
|
338
338
|
API reference for the login-with-whatsapp operation
|
|
339
|
-
<https://
|
|
339
|
+
<https://llm-docs.commercengine.io/operations/login-with-whatsapp>
|
|
340
340
|
|
|
341
341
|
### Example Usage
|
|
342
342
|
|
|
@@ -414,7 +414,7 @@ run();
|
|
|
414
414
|
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.
|
|
415
415
|
|
|
416
416
|
API reference for the logout operation
|
|
417
|
-
<https://
|
|
417
|
+
<https://llm-docs.commercengine.io/operations/logout>
|
|
418
418
|
|
|
419
419
|
### Example Usage
|
|
420
420
|
|
|
@@ -488,7 +488,7 @@ run();
|
|
|
488
488
|
The Refresh Access Token API is an integral component designed to enhance security and user experience. It enables clients to refresh their access tokens seamlessly, extending user sessions without compromising security.
|
|
489
489
|
|
|
490
490
|
API reference for the refresh-token operation
|
|
491
|
-
<https://
|
|
491
|
+
<https://llm-docs.commercengine.io/operations/refresh-token>
|
|
492
492
|
|
|
493
493
|
### Example Usage
|
|
494
494
|
|
|
@@ -566,7 +566,7 @@ run();
|
|
|
566
566
|
The Retrieve User API is designed to facilitate the retrieval of comprehensive user information from the system. A required parameter is a user-id of the user whose information needs to be retrieved.
|
|
567
567
|
|
|
568
568
|
API reference for the get-user-detail operation
|
|
569
|
-
<https://
|
|
569
|
+
<https://llm-docs.commercengine.io/operations/get-user-detail>
|
|
570
570
|
|
|
571
571
|
### Example Usage
|
|
572
572
|
|
|
@@ -645,7 +645,7 @@ run();
|
|
|
645
645
|
The Update User API helps to efficiently modify and enhance user information within the system, ensuring that user profiles remain accurate and up-to-date. This API provides a secure and flexible mechanism for updating specific details while maintaining adherence to established conventions.
|
|
646
646
|
|
|
647
647
|
API reference for the update-user operation
|
|
648
|
-
<https://
|
|
648
|
+
<https://llm-docs.commercengine.io/operations/update-user>
|
|
649
649
|
|
|
650
650
|
### Example Usage
|
|
651
651
|
|
|
@@ -779,7 +779,7 @@ run();
|
|
|
779
779
|
This API endpoint allows you to verify a one-time password (OTP) for authentication purposes. By sending a request to this endpoint with the necessary parameters, you can confirm the validity of the OTP provided by the user.
|
|
780
780
|
|
|
781
781
|
API reference for the verify-otp operation
|
|
782
|
-
<https://
|
|
782
|
+
<https://llm-docs.commercengine.io/operations/verify-otp>
|
|
783
783
|
|
|
784
784
|
### Example Usage
|
|
785
785
|
|
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
Create cart
|
|
25
25
|
|
|
26
26
|
API reference for the create-cart operation
|
|
27
|
-
<https://
|
|
27
|
+
<https://llm-docs.commercengine.io/operations/create-cart>
|
|
28
28
|
|
|
29
29
|
### Example Usage
|
|
30
30
|
|
|
@@ -135,7 +135,7 @@ run();
|
|
|
135
135
|
Retrieve cart detail using user id
|
|
136
136
|
|
|
137
137
|
API reference for the get-user-cart operation
|
|
138
|
-
<https://
|
|
138
|
+
<https://llm-docs.commercengine.io/operations/get-user-cart>
|
|
139
139
|
|
|
140
140
|
### Example Usage
|
|
141
141
|
|
|
@@ -213,7 +213,7 @@ run();
|
|
|
213
213
|
delete all items from the cart using user id.
|
|
214
214
|
|
|
215
215
|
API reference for the delete-user-cart operation
|
|
216
|
-
<https://
|
|
216
|
+
<https://llm-docs.commercengine.io/operations/delete-user-cart>
|
|
217
217
|
|
|
218
218
|
### Example Usage
|
|
219
219
|
|
|
@@ -291,7 +291,7 @@ run();
|
|
|
291
291
|
Retrieve cart detail
|
|
292
292
|
|
|
293
293
|
API reference for the get-cart operation
|
|
294
|
-
<https://
|
|
294
|
+
<https://llm-docs.commercengine.io/operations/get-cart>
|
|
295
295
|
|
|
296
296
|
### Example Usage
|
|
297
297
|
|
|
@@ -369,7 +369,7 @@ run();
|
|
|
369
369
|
delete all items from the cart.
|
|
370
370
|
|
|
371
371
|
API reference for the delete-cart operation
|
|
372
|
-
<https://
|
|
372
|
+
<https://llm-docs.commercengine.io/operations/delete-cart>
|
|
373
373
|
|
|
374
374
|
### Example Usage
|
|
375
375
|
|
|
@@ -447,7 +447,7 @@ run();
|
|
|
447
447
|
Update billing and shipping address
|
|
448
448
|
|
|
449
449
|
API reference for the create-cart-address operation
|
|
450
|
-
<https://
|
|
450
|
+
<https://llm-docs.commercengine.io/operations/create-cart-address>
|
|
451
451
|
|
|
452
452
|
### Example Usage
|
|
453
453
|
|
|
@@ -534,7 +534,7 @@ run();
|
|
|
534
534
|
Apply coupon
|
|
535
535
|
|
|
536
536
|
API reference for the apply-coupon operation
|
|
537
|
-
<https://
|
|
537
|
+
<https://llm-docs.commercengine.io/operations/apply-coupon>
|
|
538
538
|
|
|
539
539
|
### Example Usage
|
|
540
540
|
|
|
@@ -619,7 +619,7 @@ run();
|
|
|
619
619
|
remove coupon from cart
|
|
620
620
|
|
|
621
621
|
API reference for the remove-coupon operation
|
|
622
|
-
<https://
|
|
622
|
+
<https://llm-docs.commercengine.io/operations/remove-coupon>
|
|
623
623
|
|
|
624
624
|
### Example Usage
|
|
625
625
|
|
|
@@ -697,7 +697,7 @@ run();
|
|
|
697
697
|
Update fulfillment preference
|
|
698
698
|
|
|
699
699
|
API reference for the update-fulfillment-preference operation
|
|
700
|
-
<https://
|
|
700
|
+
<https://llm-docs.commercengine.io/operations/update-fulfillment-preference>
|
|
701
701
|
|
|
702
702
|
### Example Usage
|
|
703
703
|
|
|
@@ -782,7 +782,7 @@ run();
|
|
|
782
782
|
Add Item to cart. To delete item from cart, pass quantity = 0
|
|
783
783
|
|
|
784
784
|
API reference for the update-cart operation
|
|
785
|
-
<https://
|
|
785
|
+
<https://llm-docs.commercengine.io/operations/update-cart>
|
|
786
786
|
|
|
787
787
|
### Example Usage
|
|
788
788
|
|
|
@@ -871,7 +871,7 @@ run();
|
|
|
871
871
|
Redeem loyalty points
|
|
872
872
|
|
|
873
873
|
API reference for the redeem-loyalty-points operation
|
|
874
|
-
<https://
|
|
874
|
+
<https://llm-docs.commercengine.io/operations/redeem-loyalty-points>
|
|
875
875
|
|
|
876
876
|
### Example Usage
|
|
877
877
|
|
|
@@ -955,7 +955,7 @@ run();
|
|
|
955
955
|
Remove loyalty points applied in cart
|
|
956
956
|
|
|
957
957
|
API reference for the remove-loyalty-points operation
|
|
958
|
-
<https://
|
|
958
|
+
<https://llm-docs.commercengine.io/operations/remove-loyalty-points>
|
|
959
959
|
|
|
960
960
|
### Example Usage
|
|
961
961
|
|
|
@@ -1033,7 +1033,7 @@ run();
|
|
|
1033
1033
|
Update preferred shipping method and courier.
|
|
1034
1034
|
|
|
1035
1035
|
API reference for the update-shipping-method operation
|
|
1036
|
-
<https://
|
|
1036
|
+
<https://llm-docs.commercengine.io/operations/update-shipping-method>
|
|
1037
1037
|
|
|
1038
1038
|
### Example Usage
|
|
1039
1039
|
|
|
@@ -22,7 +22,7 @@
|
|
|
22
22
|
Returns a list of your product categories. The categories are returned sorted by creation date, with the most recently created categories appearing first.
|
|
23
23
|
|
|
24
24
|
API reference for the list-categories operation
|
|
25
|
-
<https://
|
|
25
|
+
<https://llm-docs.commercengine.io/operations/list-categories>
|
|
26
26
|
|
|
27
27
|
### Example Usage
|
|
28
28
|
|
|
@@ -105,7 +105,7 @@ run();
|
|
|
105
105
|
Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.
|
|
106
106
|
|
|
107
107
|
API reference for the list-products operation
|
|
108
|
-
<https://
|
|
108
|
+
<https://llm-docs.commercengine.io/operations/list-products>
|
|
109
109
|
|
|
110
110
|
### Example Usage
|
|
111
111
|
|
|
@@ -183,7 +183,7 @@ run();
|
|
|
183
183
|
Retrieves a list of products specified for cross selling. The cross-sell products are returned based on product ids specified in request param.
|
|
184
184
|
|
|
185
185
|
API reference for the list-crosssell-products operation
|
|
186
|
-
<https://
|
|
186
|
+
<https://llm-docs.commercengine.io/operations/list-crosssell-products>
|
|
187
187
|
|
|
188
188
|
### Example Usage
|
|
189
189
|
|
|
@@ -257,7 +257,7 @@ run();
|
|
|
257
257
|
Search for products matching a specific words or characters given.
|
|
258
258
|
|
|
259
259
|
API reference for the search-products operation
|
|
260
|
-
<https://
|
|
260
|
+
<https://llm-docs.commercengine.io/operations/search-products>
|
|
261
261
|
|
|
262
262
|
### Example Usage
|
|
263
263
|
|
|
@@ -338,7 +338,7 @@ run();
|
|
|
338
338
|
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.
|
|
339
339
|
|
|
340
340
|
API reference for the list-similar-products operation
|
|
341
|
-
<https://
|
|
341
|
+
<https://llm-docs.commercengine.io/operations/list-similar-products>
|
|
342
342
|
|
|
343
343
|
### Example Usage
|
|
344
344
|
|
|
@@ -412,7 +412,7 @@ run();
|
|
|
412
412
|
Retrieves a list of products specified for upsell. The upsell products are returned based on product ids specified in request param.
|
|
413
413
|
|
|
414
414
|
API reference for the list-upsell-products operation
|
|
415
|
-
<https://
|
|
415
|
+
<https://llm-docs.commercengine.io/operations/list-upsell-products>
|
|
416
416
|
|
|
417
417
|
### Example Usage
|
|
418
418
|
|
|
@@ -486,7 +486,7 @@ run();
|
|
|
486
486
|
Retrieves the details of an existing product. Supply either the unique product ID or the unique slug, and Commerce Engine will return the corresponding product information.
|
|
487
487
|
|
|
488
488
|
API reference for the get-product-detail operation
|
|
489
|
-
<https://
|
|
489
|
+
<https://llm-docs.commercengine.io/operations/get-product-detail>
|
|
490
490
|
|
|
491
491
|
### Example Usage
|
|
492
492
|
|
|
@@ -564,7 +564,7 @@ run();
|
|
|
564
564
|
List of reviews for a specified product. The reviews are returned sorted by submission date, with the most recent reviews appearing first. You can filter the reviews by rating, reviewer, or date for more detailed analysis.
|
|
565
565
|
|
|
566
566
|
API reference for the list-product-reviews operation
|
|
567
|
-
<https://
|
|
567
|
+
<https://llm-docs.commercengine.io/operations/list-product-reviews>
|
|
568
568
|
|
|
569
569
|
### Example Usage
|
|
570
570
|
|
|
@@ -644,7 +644,7 @@ run();
|
|
|
644
644
|
Retrieves the variants of an existing product. Supply the unique product ID, and Commerce Engine will return the corresponding product variants information.
|
|
645
645
|
|
|
646
646
|
API reference for the list-product-variants operation
|
|
647
|
-
<https://
|
|
647
|
+
<https://llm-docs.commercengine.io/operations/list-product-variants>
|
|
648
648
|
|
|
649
649
|
### Example Usage
|
|
650
650
|
|
|
@@ -722,7 +722,7 @@ run();
|
|
|
722
722
|
Retrieves the details of a particular variant. Supply the unique product ID, and variant ID.
|
|
723
723
|
|
|
724
724
|
API reference for the get-variant-detail operation
|
|
725
|
-
<https://
|
|
725
|
+
<https://llm-docs.commercengine.io/operations/get-variant-detail>
|
|
726
726
|
|
|
727
727
|
### Example Usage
|
|
728
728
|
|
|
@@ -802,7 +802,7 @@ run();
|
|
|
802
802
|
Returns a list of SKUs. The SKUs are returned sorted by creation date, with the most recently created SKUs appearing first.
|
|
803
803
|
|
|
804
804
|
API reference for the list-skus operation
|
|
805
|
-
<https://
|
|
805
|
+
<https://llm-docs.commercengine.io/operations/list-skus>
|
|
806
806
|
|
|
807
807
|
### Example Usage
|
|
808
808
|
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
Retrieve billing and shipping address of particular customer
|
|
19
19
|
|
|
20
20
|
API reference for the list-addresses operation
|
|
21
|
-
<https://
|
|
21
|
+
<https://llm-docs.commercengine.io/operations/list-addresses>
|
|
22
22
|
|
|
23
23
|
### Example Usage
|
|
24
24
|
|
|
@@ -97,7 +97,7 @@ run();
|
|
|
97
97
|
Add new address
|
|
98
98
|
|
|
99
99
|
API reference for the create-address operation
|
|
100
|
-
<https://
|
|
100
|
+
<https://llm-docs.commercengine.io/operations/create-address>
|
|
101
101
|
|
|
102
102
|
### Example Usage
|
|
103
103
|
|
|
@@ -205,7 +205,7 @@ run();
|
|
|
205
205
|
Retrieve address
|
|
206
206
|
|
|
207
207
|
API reference for the get-address-detail operation
|
|
208
|
-
<https://
|
|
208
|
+
<https://llm-docs.commercengine.io/operations/get-address-detail>
|
|
209
209
|
|
|
210
210
|
### Example Usage
|
|
211
211
|
|
|
@@ -285,7 +285,7 @@ run();
|
|
|
285
285
|
Update address
|
|
286
286
|
|
|
287
287
|
API reference for the update-address-detail operation
|
|
288
|
-
<https://
|
|
288
|
+
<https://llm-docs.commercengine.io/operations/update-address-detail>
|
|
289
289
|
|
|
290
290
|
### Example Usage
|
|
291
291
|
|
|
@@ -396,7 +396,7 @@ run();
|
|
|
396
396
|
Delete address
|
|
397
397
|
|
|
398
398
|
API reference for the delete-address operation
|
|
399
|
-
<https://
|
|
399
|
+
<https://llm-docs.commercengine.io/operations/delete-address>
|
|
400
400
|
|
|
401
401
|
### Example Usage
|
|
402
402
|
|
|
@@ -476,7 +476,7 @@ run();
|
|
|
476
476
|
Retrieve loyalty details
|
|
477
477
|
|
|
478
478
|
API reference for the get-loyalty-details operation
|
|
479
|
-
<https://
|
|
479
|
+
<https://llm-docs.commercengine.io/operations/get-loyalty-details>
|
|
480
480
|
|
|
481
481
|
### Example Usage
|
|
482
482
|
|
|
@@ -554,7 +554,7 @@ run();
|
|
|
554
554
|
Retrieve all reviews
|
|
555
555
|
|
|
556
556
|
API reference for the list-user-reviews operation
|
|
557
|
-
<https://
|
|
557
|
+
<https://llm-docs.commercengine.io/operations/list-user-reviews>
|
|
558
558
|
|
|
559
559
|
### Example Usage
|
|
560
560
|
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
Create new order
|
|
19
19
|
|
|
20
20
|
API reference for the create-order operation
|
|
21
|
-
<https://
|
|
21
|
+
<https://llm-docs.commercengine.io/operations/create-order>
|
|
22
22
|
|
|
23
23
|
### Example Usage
|
|
24
24
|
|
|
@@ -112,7 +112,7 @@ run();
|
|
|
112
112
|
list customers all orders
|
|
113
113
|
|
|
114
114
|
API reference for the list-orders operation
|
|
115
|
-
<https://
|
|
115
|
+
<https://llm-docs.commercengine.io/operations/list-orders>
|
|
116
116
|
|
|
117
117
|
### Example Usage
|
|
118
118
|
|
|
@@ -190,7 +190,7 @@ run();
|
|
|
190
190
|
view particular order details
|
|
191
191
|
|
|
192
192
|
API reference for the get-order-detail operation
|
|
193
|
-
<https://
|
|
193
|
+
<https://llm-docs.commercengine.io/operations/get-order-detail>
|
|
194
194
|
|
|
195
195
|
### Example Usage
|
|
196
196
|
|
|
@@ -268,7 +268,7 @@ run();
|
|
|
268
268
|
Order cancellation
|
|
269
269
|
|
|
270
270
|
API reference for the cancel-order operation
|
|
271
|
-
<https://
|
|
271
|
+
<https://llm-docs.commercengine.io/operations/cancel-order>
|
|
272
272
|
|
|
273
273
|
### Example Usage
|
|
274
274
|
|
|
@@ -354,7 +354,7 @@ run();
|
|
|
354
354
|
Retrieve payment status of a paricular order.
|
|
355
355
|
|
|
356
356
|
API reference for the get-payment-status operation
|
|
357
|
-
<https://
|
|
357
|
+
<https://llm-docs.commercengine.io/operations/get-payment-status>
|
|
358
358
|
|
|
359
359
|
### Example Usage
|
|
360
360
|
|
|
@@ -423,7 +423,6 @@ run();
|
|
|
423
423
|
|
|
424
424
|
| Error Type | Status Code | Content Type |
|
|
425
425
|
| ------------------- | ------------------- | ------------------- |
|
|
426
|
-
| errors.BadRequest | 400 | application/json |
|
|
427
426
|
| errors.Unauthorized | 401 | application/json |
|
|
428
427
|
| errors.NotFound | 404 | application/json |
|
|
429
428
|
| errors.CeError | 4XX, 5XX | \*/\* |
|
|
@@ -433,7 +432,7 @@ run();
|
|
|
433
432
|
To generate new payment request if first payment request is failed or expired. Retry payment request can be made after 15 mins of last request or immediately after last payment request is marked as failed.
|
|
434
433
|
|
|
435
434
|
API reference for the retry-order-payment operation
|
|
436
|
-
<https://
|
|
435
|
+
<https://llm-docs.commercengine.io/operations/retry-order-payment>
|
|
437
436
|
|
|
438
437
|
### Example Usage
|
|
439
438
|
|
|
@@ -526,7 +525,7 @@ run();
|
|
|
526
525
|
Retrieve order shipments
|
|
527
526
|
|
|
528
527
|
API reference for the list-order-shipments operation
|
|
529
|
-
<https://
|
|
528
|
+
<https://llm-docs.commercengine.io/operations/list-order-shipments>
|
|
530
529
|
|
|
531
530
|
### Example Usage
|
|
532
531
|
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
This endpoint returns the available fulfillment options for a given cart and delivery pincode. It provides both delivery options and collect-in-store (Click & Collect) options, including details of store locations where the item can be collected.
|
|
15
15
|
|
|
16
16
|
API reference for the get-fulfillment-options operation
|
|
17
|
-
<https://
|
|
17
|
+
<https://llm-docs.commercengine.io/operations/get-fulfillment-options>
|
|
18
18
|
|
|
19
19
|
### Example Usage
|
|
20
20
|
|
|
@@ -95,7 +95,7 @@ run();
|
|
|
95
95
|
Checking if delivery is available to the entered pincode based on shipping zones.
|
|
96
96
|
|
|
97
97
|
API reference for the check-pincode-serviceability operation
|
|
98
|
-
<https://
|
|
98
|
+
<https://llm-docs.commercengine.io/operations/check-pincode-serviceability>
|
|
99
99
|
|
|
100
100
|
### Example Usage
|
|
101
101
|
|
|
@@ -174,7 +174,7 @@ run();
|
|
|
174
174
|
Checks whether a given pincode is serviceable and returns all available shipping methods based on delivery address
|
|
175
175
|
|
|
176
176
|
API reference for the get-shipping-methods operation
|
|
177
|
-
<https://
|
|
177
|
+
<https://llm-docs.commercengine.io/operations/get-shipping-methods>
|
|
178
178
|
|
|
179
179
|
### Example Usage
|
|
180
180
|
|
|
@@ -14,7 +14,7 @@ import { Result } from "../types/fp.js";
|
|
|
14
14
|
* @remarks
|
|
15
15
|
* Generating a One-Time Password (OTP) typically involves creating a random code that is sent to a user for authentication or verification purposes.
|
|
16
16
|
*
|
|
17
|
-
* @see {@link https://
|
|
17
|
+
* @see {@link https://llm-docs.commercengine.io/operations/generate-otp} - API reference for the generate-otp operation
|
|
18
18
|
*/
|
|
19
19
|
export declare function authGenerateOtp(client: CeStorefrontCore, request: operations.GenerateOtpRequestBody, options?: RequestOptions): APIPromise<Result<operations.GenerateOtpResponseBody, errors.BadRequest | errors.Unauthorized | CeStorefrontError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
20
20
|
//# sourceMappingURL=authGenerateOtp.d.ts.map
|
|
@@ -16,7 +16,7 @@ import { APIPromise } from "../types/async.js";
|
|
|
16
16
|
* @remarks
|
|
17
17
|
* Generating a One-Time Password (OTP) typically involves creating a random code that is sent to a user for authentication or verification purposes.
|
|
18
18
|
*
|
|
19
|
-
* @see {@link https://
|
|
19
|
+
* @see {@link https://llm-docs.commercengine.io/operations/generate-otp} - API reference for the generate-otp operation
|
|
20
20
|
*/
|
|
21
21
|
export function authGenerateOtp(client, request, options) {
|
|
22
22
|
return new APIPromise($do(client, request, options));
|
|
@@ -15,7 +15,7 @@ import { Result } from "../types/fp.js";
|
|
|
15
15
|
* This API’s focus is on anonymous users who have not undergone the formal account creation process. These anonymous users are associated with a unique ID, ensuring that even in the absence of a fully realized account, there is a distinct and trackable identity for each user.
|
|
16
16
|
* To interact with the system, each anonymous user is issued an access token. This access token plays a dual role in the system: it serves as a means of authenticating the user and it also acts as a tool for authorization, determining what actions the authenticated user is permitted to perform.
|
|
17
17
|
*
|
|
18
|
-
* @see {@link https://
|
|
18
|
+
* @see {@link https://llm-docs.commercengine.io/operations/get-anonymous-token} - API reference for the get-anonymous-token operation
|
|
19
19
|
*/
|
|
20
20
|
export declare function authGetAnonymousToken(client: CeStorefrontCore, security: operations.GetAnonymousTokenSecurity, options?: RequestOptions): APIPromise<Result<operations.GetAnonymousTokenResponseBody, errors.BadRequest | errors.Unauthorized | CeStorefrontError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
21
21
|
//# sourceMappingURL=authGetAnonymousToken.d.ts.map
|
|
@@ -15,7 +15,7 @@ import { APIPromise } from "../types/async.js";
|
|
|
15
15
|
* This API’s focus is on anonymous users who have not undergone the formal account creation process. These anonymous users are associated with a unique ID, ensuring that even in the absence of a fully realized account, there is a distinct and trackable identity for each user.
|
|
16
16
|
* To interact with the system, each anonymous user is issued an access token. This access token plays a dual role in the system: it serves as a means of authenticating the user and it also acts as a tool for authorization, determining what actions the authenticated user is permitted to perform.
|
|
17
17
|
*
|
|
18
|
-
* @see {@link https://
|
|
18
|
+
* @see {@link https://llm-docs.commercengine.io/operations/get-anonymous-token} - API reference for the get-anonymous-token operation
|
|
19
19
|
*/
|
|
20
20
|
export function authGetAnonymousToken(client, security, options) {
|
|
21
21
|
return new APIPromise($do(client, security, options));
|
|
@@ -14,7 +14,7 @@ import { Result } from "../types/fp.js";
|
|
|
14
14
|
* @remarks
|
|
15
15
|
* The Retrieve User API is designed to facilitate the retrieval of comprehensive user information from the system. A required parameter is a user-id of the user whose information needs to be retrieved.
|
|
16
16
|
*
|
|
17
|
-
* @see {@link https://
|
|
17
|
+
* @see {@link https://llm-docs.commercengine.io/operations/get-user-detail} - API reference for the get-user-detail operation
|
|
18
18
|
*/
|
|
19
19
|
export declare function authGetUserDetail(client: CeStorefrontCore, request: operations.GetUserDetailRequest, options?: RequestOptions): APIPromise<Result<operations.GetUserDetailResponseBody, errors.BadRequest | errors.Unauthorized | errors.NotFound | CeStorefrontError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
20
20
|
//# sourceMappingURL=authGetUserDetail.d.ts.map
|
|
@@ -16,7 +16,7 @@ import { APIPromise } from "../types/async.js";
|
|
|
16
16
|
* @remarks
|
|
17
17
|
* The Retrieve User API is designed to facilitate the retrieval of comprehensive user information from the system. A required parameter is a user-id of the user whose information needs to be retrieved.
|
|
18
18
|
*
|
|
19
|
-
* @see {@link https://
|
|
19
|
+
* @see {@link https://llm-docs.commercengine.io/operations/get-user-detail} - API reference for the get-user-detail operation
|
|
20
20
|
*/
|
|
21
21
|
export function authGetUserDetail(client, request, options) {
|
|
22
22
|
return new APIPromise($do(client, request, options));
|
|
@@ -14,7 +14,7 @@ import { Result } from "../types/fp.js";
|
|
|
14
14
|
* @remarks
|
|
15
15
|
* This API enables users to authenticate into the system using their email address. It provides a secure way for users to Login by verifying their identity through a one-time password (OTP) sent to their email address.
|
|
16
16
|
*
|
|
17
|
-
* @see {@link https://
|
|
17
|
+
* @see {@link https://llm-docs.commercengine.io/operations/login-with-email} - API reference for the login-with-email operation
|
|
18
18
|
*/
|
|
19
19
|
export declare function authLoginWithEmail(client: CeStorefrontCore, request: operations.LoginWithEmailRequestBody, options?: RequestOptions): APIPromise<Result<operations.LoginWithEmailResponseBody, errors.BadRequest | errors.Unauthorized | errors.NotFound | CeStorefrontError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
20
20
|
//# sourceMappingURL=authLoginWithEmail.d.ts.map
|
|
@@ -16,7 +16,7 @@ import { APIPromise } from "../types/async.js";
|
|
|
16
16
|
* @remarks
|
|
17
17
|
* This API enables users to authenticate into the system using their email address. It provides a secure way for users to Login by verifying their identity through a one-time password (OTP) sent to their email address.
|
|
18
18
|
*
|
|
19
|
-
* @see {@link https://
|
|
19
|
+
* @see {@link https://llm-docs.commercengine.io/operations/login-with-email} - API reference for the login-with-email operation
|
|
20
20
|
*/
|
|
21
21
|
export function authLoginWithEmail(client, request, options) {
|
|
22
22
|
return new APIPromise($do(client, request, options));
|
|
@@ -14,7 +14,7 @@ import { Result } from "../types/fp.js";
|
|
|
14
14
|
* @remarks
|
|
15
15
|
* This API enables users to authenticate into the system using their phone number. It provides a secure way for users to log in by verifying their identity through a one-time password (OTP) sent to their registered phone.
|
|
16
16
|
*
|
|
17
|
-
* @see {@link https://
|
|
17
|
+
* @see {@link https://llm-docs.commercengine.io/operations/login-with-phone} - API reference for the login-with-phone operation
|
|
18
18
|
*/
|
|
19
19
|
export declare function authLoginWithPhone(client: CeStorefrontCore, request: operations.LoginWithPhoneRequestBody, options?: RequestOptions): APIPromise<Result<operations.LoginWithPhoneResponseBody, errors.BadRequest | errors.Unauthorized | errors.NotFound | CeStorefrontError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
20
20
|
//# sourceMappingURL=authLoginWithPhone.d.ts.map
|
|
@@ -16,7 +16,7 @@ import { APIPromise } from "../types/async.js";
|
|
|
16
16
|
* @remarks
|
|
17
17
|
* This API enables users to authenticate into the system using their phone number. It provides a secure way for users to log in by verifying their identity through a one-time password (OTP) sent to their registered phone.
|
|
18
18
|
*
|
|
19
|
-
* @see {@link https://
|
|
19
|
+
* @see {@link https://llm-docs.commercengine.io/operations/login-with-phone} - API reference for the login-with-phone operation
|
|
20
20
|
*/
|
|
21
21
|
export function authLoginWithPhone(client, request, options) {
|
|
22
22
|
return new APIPromise($do(client, request, options));
|
|
@@ -14,7 +14,7 @@ import { Result } from "../types/fp.js";
|
|
|
14
14
|
* @remarks
|
|
15
15
|
* This API enables users to authenticate into the system using their WhatsApp Number. It provides a secure way for users to Login by verifying their identity through a one-time password (OTP) sent to their WhatsApp Number.
|
|
16
16
|
*
|
|
17
|
-
* @see {@link https://
|
|
17
|
+
* @see {@link https://llm-docs.commercengine.io/operations/login-with-whatsapp} - API reference for the login-with-whatsapp operation
|
|
18
18
|
*/
|
|
19
19
|
export declare function authLoginWithWhatsapp(client: CeStorefrontCore, request: operations.LoginWithWhatsappRequestBody, options?: RequestOptions): APIPromise<Result<operations.LoginWithWhatsappResponseBody, errors.BadRequest | errors.Unauthorized | CeStorefrontError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
20
20
|
//# sourceMappingURL=authLoginWithWhatsapp.d.ts.map
|
|
@@ -16,7 +16,7 @@ import { APIPromise } from "../types/async.js";
|
|
|
16
16
|
* @remarks
|
|
17
17
|
* This API enables users to authenticate into the system using their WhatsApp Number. It provides a secure way for users to Login by verifying their identity through a one-time password (OTP) sent to their WhatsApp Number.
|
|
18
18
|
*
|
|
19
|
-
* @see {@link https://
|
|
19
|
+
* @see {@link https://llm-docs.commercengine.io/operations/login-with-whatsapp} - API reference for the login-with-whatsapp operation
|
|
20
20
|
*/
|
|
21
21
|
export function authLoginWithWhatsapp(client, request, options) {
|
|
22
22
|
return new APIPromise($do(client, request, options));
|
|
@@ -14,7 +14,7 @@ import { Result } from "../types/fp.js";
|
|
|
14
14
|
* @remarks
|
|
15
15
|
* 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.
|
|
16
16
|
*
|
|
17
|
-
* @see {@link https://
|
|
17
|
+
* @see {@link https://llm-docs.commercengine.io/operations/logout} - API reference for the logout operation
|
|
18
18
|
*/
|
|
19
19
|
export declare function authLogout(client: CeStorefrontCore, options?: RequestOptions): APIPromise<Result<operations.LogoutResponseBody, errors.BadRequest | errors.Unauthorized | errors.NotFound | CeStorefrontError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
20
20
|
//# sourceMappingURL=authLogout.d.ts.map
|
package/esm/funcs/authLogout.js
CHANGED
|
@@ -14,7 +14,7 @@ import { APIPromise } from "../types/async.js";
|
|
|
14
14
|
* @remarks
|
|
15
15
|
* 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.
|
|
16
16
|
*
|
|
17
|
-
* @see {@link https://
|
|
17
|
+
* @see {@link https://llm-docs.commercengine.io/operations/logout} - API reference for the logout operation
|
|
18
18
|
*/
|
|
19
19
|
export function authLogout(client, options) {
|
|
20
20
|
return new APIPromise($do(client, options));
|