ce-storefront 0.0.5 → 0.2.0

package/README.md

@@ -1,8 +1,40 @@
 # ce-storefront
 
+<!-- Start Summary [summary] -->
+## Summary
+
+CE Storefront APIs: CE Storefront APIs
+
+Commerce Engine Storefront APIs
+<!-- End Summary [summary] -->
+
+<!-- Start Table of Contents [toc] -->
+## Table of Contents
+<!-- $toc-max-depth=2 -->
+* [ce-storefront](#ce-storefront)
+  * [SDK Installation](#sdk-installation)
+  * [Requirements](#requirements)
+  * [SDK Example Usage](#sdk-example-usage)
+  * [Available Resources and Operations](#available-resources-and-operations)
+  * [Standalone functions](#standalone-functions)
+  * [File uploads](#file-uploads)
+  * [Retries](#retries)
+  * [Error Handling](#error-handling)
+  * [Server Selection](#server-selection)
+  * [Custom HTTP Client](#custom-http-client)
+  * [Authentication](#authentication)
+  * [Debugging](#debugging)
+* [Development](#development)
+  * [Maturity](#maturity)
+  * [Contributions](#contributions)
+
+<!-- End Table of Contents [toc] -->
+
 <!-- Start SDK Installation [installation] -->
 ## SDK Installation
 
+The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.
+
 ### NPM
 
 ```bash
@@ -46,16 +78,16 @@ For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
 import { CeStorefront } from "ce-storefront";
 
 const ceStorefront = new CeStorefront({
-    authorization: "<YOUR_BEARER_TOKEN_HERE>",
+  authorization: "<YOUR_BEARER_TOKEN_HERE>",
 });
 
 async function run() {
-    const result = await ceStorefront.catalog.products.list({
-        sortBy: '{"country":"asc","city":"asc","population":"desc"}',
-    });
+  const result = await ceStorefront.catalog.products.list({
+    sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
+  });
 
-    // Handle the result
-    console.log(result);
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -66,38 +98,49 @@ run();
 <!-- Start Available Resources and Operations [operations] -->
 ## Available Resources and Operations
 
-### [catalog.products](docs/sdks/products/README.md)
+<details open>
+<summary>Available methods</summary>
 
-* [list](docs/sdks/products/README.md#list) - List all products
-* [get](docs/sdks/products/README.md#get) - Retrieve a product
-* [getSimilar](docs/sdks/products/README.md#getsimilar) - Retrieve similar products
-* [getUpsells](docs/sdks/products/README.md#getupsells) - Retrieve up-sell products
-* [getCrossSells](docs/sdks/products/README.md#getcrosssells) - Retrieve cross-sell products
-
-### [catalog.products.variants](docs/sdks/variants/README.md)
+### [analytics](docs/sdks/analytics/README.md)
 
-* [list](docs/sdks/variants/README.md#list) - Retrieve product variants
-* [get](docs/sdks/variants/README.md#get) - Retrieve variant detail
+* [track](docs/sdks/analytics/README.md#track) - Track event
 
-### [catalog.products.reviews](docs/sdks/cestorefrontreviews/README.md)
+### [auth](docs/sdks/auth/README.md)
 
-* [list](docs/sdks/cestorefrontreviews/README.md#list) - Retrieve product reviews
-* [create](docs/sdks/cestorefrontreviews/README.md#create) - Create product review
+* [loginAnonymously](docs/sdks/auth/README.md#loginanonymously) - Anonymous user
+* [loginWithPhone](docs/sdks/auth/README.md#loginwithphone) - Login with phone
+* [loginWithEmail](docs/sdks/auth/README.md#loginwithemail) - Login with email
+* [loginWithWhatsapp](docs/sdks/auth/README.md#loginwithwhatsapp) - Login with whatsapp
+* [loginWithPassword](docs/sdks/auth/README.md#loginwithpassword) - Login with password
+* [verifyOtp](docs/sdks/auth/README.md#verifyotp) - Verify OTP
+* [registerWithPhone](docs/sdks/auth/README.md#registerwithphone) - Register with phone
+* [registerWithEmail](docs/sdks/auth/README.md#registerwithemail) - Register with email
+* [registerWithWhatsapp](docs/sdks/auth/README.md#registerwithwhatsapp) - Register with whatsapp
+* [registerWithPassword](docs/sdks/auth/README.md#registerwithpassword) - Register with password
+* [refreshToken](docs/sdks/auth/README.md#refreshtoken) - Refresh access token
+* [generateOtp](docs/sdks/auth/README.md#generateotp) - Generate OTP
+* [verifyEmailPhone](docs/sdks/auth/README.md#verifyemailphone) - Check verified email phone
 
-### [catalog.skus](docs/sdks/skus/README.md)
+#### [auth.user](docs/sdks/cestorefrontuser/README.md)
 
-* [list](docs/sdks/skus/README.md#list) - List all SKUs
+* [get](docs/sdks/cestorefrontuser/README.md#get) - Retrieve a user
+* [update](docs/sdks/cestorefrontuser/README.md#update) - Update a user
+* [addProfileImage](docs/sdks/cestorefrontuser/README.md#addprofileimage) - Add profile image
+* [updateProfileImage](docs/sdks/cestorefrontuser/README.md#updateprofileimage) - Update profile image
+* [deleteProfileImage](docs/sdks/cestorefrontuser/README.md#deleteprofileimage) - Delete profile image
+* [getProfileImage](docs/sdks/cestorefrontuser/README.md#getprofileimage) - Retrieve a profile image
+* [deactivateAccount](docs/sdks/cestorefrontuser/README.md#deactivateaccount) - Deactivate account
+* [changePassword](docs/sdks/cestorefrontuser/README.md#changepassword) - Change password
+* [forgotPassword](docs/sdks/cestorefrontuser/README.md#forgotpassword) - Forgot password
+* [resetPassword](docs/sdks/cestorefrontuser/README.md#resetpassword) - Reset password
+* [logout](docs/sdks/cestorefrontuser/README.md#logout) - Logout user
 
-### [catalog.categories](docs/sdks/categories/README.md)
+### [campaigns](docs/sdks/campaigns/README.md)
 
-* [list](docs/sdks/categories/README.md#list) - List all categories
 
-### [customersAPI](docs/sdks/customersapi/README.md)
+#### [campaigns.newsletter](docs/sdks/newsletter/README.md)
 
-* [getRecommendedProducts](docs/sdks/customersapi/README.md#getrecommendedproducts) - List all recommended products
-* [postCustomers](docs/sdks/customersapi/README.md#postcustomers) - Create customer
-* [getCustomersId](docs/sdks/customersapi/README.md#getcustomersid) - Retrieve customer detail
-* [putCustomersId](docs/sdks/customersapi/README.md#putcustomersid) - Update customer detail
+* [subscribe](docs/sdks/newsletter/README.md#subscribe) - Subscribe to newsletter
 
 ### [carts](docs/sdks/carts/README.md)
 
@@ -106,6 +149,36 @@ run();
 * [delete](docs/sdks/carts/README.md#delete) - Delete cart
 * [addItem](docs/sdks/carts/README.md#additem) - Add/delete cart item
 
+### [catalog](docs/sdks/catalog/README.md)
+
+
+#### [catalog.categories](docs/sdks/categories/README.md)
+
+* [list](docs/sdks/categories/README.md#list) - List all categories
+
+#### [catalog.products](docs/sdks/products/README.md)
+
+* [list](docs/sdks/products/README.md#list) - List all products
+* [get](docs/sdks/products/README.md#get) - Retrieve a product
+* [getSimilar](docs/sdks/products/README.md#getsimilar) - Retrieve similar products
+* [getUpsells](docs/sdks/products/README.md#getupsells) - Retrieve up-sell products
+* [getCrossSells](docs/sdks/products/README.md#getcrosssells) - Retrieve cross-sell products
+
+#### [catalog.products.reviews](docs/sdks/cestorefrontreviews/README.md)
+
+* [list](docs/sdks/cestorefrontreviews/README.md#list) - Retrieve product reviews
+* [create](docs/sdks/cestorefrontreviews/README.md#create) - Create product review
+
+#### [catalog.products.variants](docs/sdks/variants/README.md)
+
+* [list](docs/sdks/variants/README.md#list) - Retrieve product variants
+* [get](docs/sdks/variants/README.md#get) - Retrieve variant detail
+
+#### [catalog.skus](docs/sdks/skus/README.md)
+
+* [list](docs/sdks/skus/README.md#list) - List all SKUs
+
+
 ### [checkout](docs/sdks/checkout/README.md)
 
 * [updateAddress](docs/sdks/checkout/README.md#updateaddress) - Update cart address
@@ -117,23 +190,10 @@ run();
 * [removeCreditBalance](docs/sdks/checkout/README.md#removecreditbalance) - Remove credit balance
 * [redeemGiftCard](docs/sdks/checkout/README.md#redeemgiftcard) - Redeem gift card
 
-
-### [offers.coupons](docs/sdks/coupons/README.md)
-
-* [list](docs/sdks/coupons/README.md#list) - Retrieve all coupons
-
-### [offers.promotions](docs/sdks/promotions/README.md)
-
-* [list](docs/sdks/promotions/README.md#list) - Retrieve all promotions
-
-### [wishlist](docs/sdks/wishlist/README.md)
-
-* [get](docs/sdks/wishlist/README.md#get) - Retrieve wishlist
-* [add](docs/sdks/wishlist/README.md#add) - Add product to wishlist
-* [delete](docs/sdks/wishlist/README.md#delete) - Delete product from wishlist
+### [customers](docs/sdks/customers/README.md)
 
 
-### [customers.addresses](docs/sdks/addresses/README.md)
+#### [customers.addresses](docs/sdks/addresses/README.md)
 
 * [list](docs/sdks/addresses/README.md#list) - Retrieve all addresses
 * [add](docs/sdks/addresses/README.md#add) - Add address
@@ -141,15 +201,33 @@ run();
 * [update](docs/sdks/addresses/README.md#update) - Update particular address
 * [delete](docs/sdks/addresses/README.md#delete) - Remove particular address
 
-### [customers.loyalty](docs/sdks/loyalty/README.md)
+#### [customers.loyalty](docs/sdks/loyalty/README.md)
 
 * [get](docs/sdks/loyalty/README.md#get) - Retrieve loyalty details
 * [listActivities](docs/sdks/loyalty/README.md#listactivities) - List all loyalty points activity
 
-### [customers.reviews](docs/sdks/reviews/README.md)
+#### [customers.reviews](docs/sdks/reviews/README.md)
 
 * [list](docs/sdks/reviews/README.md#list) - Retrieve all reviews
 
+### [customersAPI](docs/sdks/customersapi/README.md)
+
+* [getRecommendedProducts](docs/sdks/customersapi/README.md#getrecommendedproducts) - List all recommended products
+* [postCustomers](docs/sdks/customersapi/README.md#postcustomers) - Create customer
+* [getCustomersId](docs/sdks/customersapi/README.md#getcustomersid) - Retrieve customer detail
+* [putCustomersId](docs/sdks/customersapi/README.md#putcustomersid) - Update customer detail
+
+### [offers](docs/sdks/offers/README.md)
+
+
+#### [offers.coupons](docs/sdks/coupons/README.md)
+
+* [list](docs/sdks/coupons/README.md#list) - Retrieve all coupons
+
+#### [offers.promotions](docs/sdks/promotions/README.md)
+
+* [list](docs/sdks/promotions/README.md#list) - Retrieve all promotions
+
 ### [orders](docs/sdks/orders/README.md)
 
 * [create](docs/sdks/orders/README.md#create) - Create order
@@ -158,78 +236,49 @@ run();
 * [cancel](docs/sdks/orders/README.md#cancel) - Cancel order
 * [retryPayment](docs/sdks/orders/README.md#retrypayment) - Retry payment
 
-### [orders.shipments](docs/sdks/shipments/README.md)
+#### [orders.payments](docs/sdks/cestorefrontpayments/README.md)
 
-* [list](docs/sdks/shipments/README.md#list) - Retrieve order shipments
+* [list](docs/sdks/cestorefrontpayments/README.md#list) - Retrieve order payments
 
-### [orders.refunds](docs/sdks/refunds/README.md)
+#### [orders.refunds](docs/sdks/refunds/README.md)
 
 * [list](docs/sdks/refunds/README.md#list) - Retrieve order refunds
 
-### [orders.payments](docs/sdks/cestorefrontpayments/README.md)
+#### [orders.shipments](docs/sdks/shipments/README.md)
 
-* [list](docs/sdks/cestorefrontpayments/README.md#list) - Retrieve order payments
-
-### [shipping](docs/sdks/shipping/README.md)
+* [list](docs/sdks/shipments/README.md#list) - Retrieve order shipments
 
-* [checkPincodeServiceability](docs/sdks/shipping/README.md#checkpincodeserviceability) - Check pincode serviceability
+### [payments](docs/sdks/payments/README.md)
 
-### [auth](docs/sdks/auth/README.md)
+* [generateHash](docs/sdks/payments/README.md#generatehash) - Generate hash
+* [getMethods](docs/sdks/payments/README.md#getmethods) - Retrieve available payment methods
 
-* [loginAnonymously](docs/sdks/auth/README.md#loginanonymously) - Anonymous user
-* [loginWithPhone](docs/sdks/auth/README.md#loginwithphone) - Login with phone
-* [loginWithEmail](docs/sdks/auth/README.md#loginwithemail) - Login with email
-* [loginWithWhatsapp](docs/sdks/auth/README.md#loginwithwhatsapp) - Login with whatsapp
-* [loginWithPassword](docs/sdks/auth/README.md#loginwithpassword) - Login with password
-* [verifyOtp](docs/sdks/auth/README.md#verifyotp) - Verify OTP
-* [registerWithPhone](docs/sdks/auth/README.md#registerwithphone) - Register with phone
-* [registerWithEmail](docs/sdks/auth/README.md#registerwithemail) - Register with email
-* [registerWithWhatsapp](docs/sdks/auth/README.md#registerwithwhatsapp) - Register with whatsapp
-* [registerWithPassword](docs/sdks/auth/README.md#registerwithpassword) - Register with password
-* [refreshToken](docs/sdks/auth/README.md#refreshtoken) - Refresh access token
-* [generateOtp](docs/sdks/auth/README.md#generateotp) - Generate OTP
-* [verifyEmailPhone](docs/sdks/auth/README.md#verifyemailphone) - Check verified email phone
+### [shipping](docs/sdks/shipping/README.md)
 
-### [auth.user](docs/sdks/cestorefrontuser/README.md)
+* [checkPincodeServiceability](docs/sdks/shipping/README.md#checkpincodeserviceability) - Check pincode serviceability
 
-* [get](docs/sdks/cestorefrontuser/README.md#get) - Retrieve a user
-* [update](docs/sdks/cestorefrontuser/README.md#update) - Update a user
-* [addProfileImage](docs/sdks/cestorefrontuser/README.md#addprofileimage) - Add profile image
-* [updateProfileImage](docs/sdks/cestorefrontuser/README.md#updateprofileimage) - Update profile image
-* [deleteProfileImage](docs/sdks/cestorefrontuser/README.md#deleteprofileimage) - Delete profile image
-* [getProfileImage](docs/sdks/cestorefrontuser/README.md#getprofileimage) - Retrieve a profile image
-* [deactivateAccount](docs/sdks/cestorefrontuser/README.md#deactivateaccount) - Deactivate account
-* [changePassword](docs/sdks/cestorefrontuser/README.md#changepassword) - Change password
-* [forgotPassword](docs/sdks/cestorefrontuser/README.md#forgotpassword) - Forgot password
-* [resetPassword](docs/sdks/cestorefrontuser/README.md#resetpassword) - Reset password
-* [logout](docs/sdks/cestorefrontuser/README.md#logout) - Logout user
+### [user](docs/sdks/user/README.md)
 
 
-### [user.notificationPreferences](docs/sdks/notificationpreferences/README.md)
+#### [user.notificationPreferences](docs/sdks/notificationpreferences/README.md)
 
 * [get](docs/sdks/notificationpreferences/README.md#get) - Retrieve user notification preferences
 * [create](docs/sdks/notificationpreferences/README.md#create) - Create user notification preferences
 * [update](docs/sdks/notificationpreferences/README.md#update) - Update user notification preferences
 
-### [payments](docs/sdks/payments/README.md)
-
-* [generateHash](docs/sdks/payments/README.md#generatehash) - Generate hash
-* [getMethods](docs/sdks/payments/README.md#getmethods) - Retrieve available payment methods
-
 ### [utils](docs/sdks/utils/README.md)
 
 * [getCountries](docs/sdks/utils/README.md#getcountries) - Retrieve all countries
 * [getStates](docs/sdks/utils/README.md#getstates) - Retrieve country wise states
 * [getPincodes](docs/sdks/utils/README.md#getpincodes) - Retrieve pincodes
 
-### [analytics](docs/sdks/analytics/README.md)
-
-* [track](docs/sdks/analytics/README.md#track) - Track event
-
+### [wishlist](docs/sdks/wishlist/README.md)
 
-### [campaigns.newsletter](docs/sdks/newsletter/README.md)
+* [get](docs/sdks/wishlist/README.md#get) - Retrieve wishlist
+* [add](docs/sdks/wishlist/README.md#add) - Add product to wishlist
+* [delete](docs/sdks/wishlist/README.md#delete) - Delete product from wishlist
 
-* [subscribe](docs/sdks/newsletter/README.md#subscribe) - Subscribe to newsletter
+</details>
 <!-- End Available Resources and Operations [operations] -->
 
 <!-- Start Standalone functions [standalone-funcs] -->
@@ -247,90 +296,89 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 
 <summary>Available standalone functions</summary>
 
-- [analyticsTrack](docs/sdks/analytics/README.md#track)
-- [authGenerateOtp](docs/sdks/auth/README.md#generateotp)
-- [authLoginAnonymously](docs/sdks/auth/README.md#loginanonymously)
-- [authLoginWithEmail](docs/sdks/auth/README.md#loginwithemail)
-- [authLoginWithPassword](docs/sdks/auth/README.md#loginwithpassword)
-- [authLoginWithPhone](docs/sdks/auth/README.md#loginwithphone)
-- [authLoginWithWhatsapp](docs/sdks/auth/README.md#loginwithwhatsapp)
-- [authRefreshToken](docs/sdks/auth/README.md#refreshtoken)
-- [authRegisterWithEmail](docs/sdks/auth/README.md#registerwithemail)
-- [authRegisterWithPassword](docs/sdks/auth/README.md#registerwithpassword)
-- [authRegisterWithPhone](docs/sdks/auth/README.md#registerwithphone)
-- [authRegisterWithWhatsapp](docs/sdks/auth/README.md#registerwithwhatsapp)
-- [authUserAddProfileImage](docs/sdks/cestorefrontuser/README.md#addprofileimage)
-- [authUserChangePassword](docs/sdks/cestorefrontuser/README.md#changepassword)
-- [authUserDeactivateAccount](docs/sdks/cestorefrontuser/README.md#deactivateaccount)
-- [authUserDeleteProfileImage](docs/sdks/cestorefrontuser/README.md#deleteprofileimage)
-- [authUserForgotPassword](docs/sdks/cestorefrontuser/README.md#forgotpassword)
-- [authUserGetProfileImage](docs/sdks/cestorefrontuser/README.md#getprofileimage)
-- [authUserGet](docs/sdks/cestorefrontuser/README.md#get)
-- [authUserLogout](docs/sdks/cestorefrontuser/README.md#logout)
-- [authUserResetPassword](docs/sdks/cestorefrontuser/README.md#resetpassword)
-- [authUserUpdateProfileImage](docs/sdks/cestorefrontuser/README.md#updateprofileimage)
-- [authUserUpdate](docs/sdks/cestorefrontuser/README.md#update)
-- [authVerifyEmailPhone](docs/sdks/auth/README.md#verifyemailphone)
-- [authVerifyOtp](docs/sdks/auth/README.md#verifyotp)
-- [campaignsNewsletterSubscribe](docs/sdks/newsletter/README.md#subscribe)
-- [cartsAddItem](docs/sdks/carts/README.md#additem)
-- [cartsCreate](docs/sdks/carts/README.md#create)
-- [cartsDelete](docs/sdks/carts/README.md#delete)
-- [cartsGet](docs/sdks/carts/README.md#get)
-- [catalogCategoriesList](docs/sdks/categories/README.md#list)
-- [catalogProductsGetCrossSells](docs/sdks/products/README.md#getcrosssells)
-- [catalogProductsGetSimilar](docs/sdks/products/README.md#getsimilar)
-- [catalogProductsGetUpsells](docs/sdks/products/README.md#getupsells)
-- [catalogProductsGet](docs/sdks/products/README.md#get)
-- [catalogProductsList](docs/sdks/products/README.md#list)
-- [catalogProductsReviewsCreate](docs/sdks/cestorefrontreviews/README.md#create)
-- [catalogProductsReviewsList](docs/sdks/cestorefrontreviews/README.md#list)
-- [catalogProductsVariantsGet](docs/sdks/variants/README.md#get)
-- [catalogProductsVariantsList](docs/sdks/variants/README.md#list)
-- [catalogSkusList](docs/sdks/skus/README.md#list)
-- [checkoutApplyCoupon](docs/sdks/checkout/README.md#applycoupon)
-- [checkoutRedeemGiftCard](docs/sdks/checkout/README.md#redeemgiftcard)
-- [checkoutRedeemLoyaltyPoints](docs/sdks/checkout/README.md#redeemloyaltypoints)
-- [checkoutRemoveCoupon](docs/sdks/checkout/README.md#removecoupon)
-- [checkoutRemoveCreditBalance](docs/sdks/checkout/README.md#removecreditbalance)
-- [checkoutRemoveLoyaltyPoints](docs/sdks/checkout/README.md#removeloyaltypoints)
-- [checkoutUpdateAddress](docs/sdks/checkout/README.md#updateaddress)
-- [checkoutUseCreditBalance](docs/sdks/checkout/README.md#usecreditbalance)
-- [customersAPIGetCustomersId](docs/sdks/customersapi/README.md#getcustomersid)
-- [customersAPIGetRecommendedProducts](docs/sdks/customersapi/README.md#getrecommendedproducts)
-- [customersAPIPostCustomers](docs/sdks/customersapi/README.md#postcustomers)
-- [customersAPIPutCustomersId](docs/sdks/customersapi/README.md#putcustomersid)
-- [customersAddressesAdd](docs/sdks/addresses/README.md#add)
-- [customersAddressesDelete](docs/sdks/addresses/README.md#delete)
-- [customersAddressesGet](docs/sdks/addresses/README.md#get)
-- [customersAddressesList](docs/sdks/addresses/README.md#list)
-- [customersAddressesUpdate](docs/sdks/addresses/README.md#update)
-- [customersLoyaltyGet](docs/sdks/loyalty/README.md#get)
-- [customersLoyaltyListActivities](docs/sdks/loyalty/README.md#listactivities)
-- [customersReviewsList](docs/sdks/reviews/README.md#list)
-- [offersCouponsList](docs/sdks/coupons/README.md#list)
-- [offersPromotionsList](docs/sdks/promotions/README.md#list)
-- [ordersCancel](docs/sdks/orders/README.md#cancel)
-- [ordersCreate](docs/sdks/orders/README.md#create)
-- [ordersGet](docs/sdks/orders/README.md#get)
-- [ordersList](docs/sdks/orders/README.md#list)
-- [ordersPaymentsList](docs/sdks/cestorefrontpayments/README.md#list)
-- [ordersRefundsList](docs/sdks/refunds/README.md#list)
-- [ordersRetryPayment](docs/sdks/orders/README.md#retrypayment)
-- [ordersShipmentsList](docs/sdks/shipments/README.md#list)
-- [paymentsGenerateHash](docs/sdks/payments/README.md#generatehash)
-- [paymentsGetMethods](docs/sdks/payments/README.md#getmethods)
-- [shippingCheckPincodeServiceability](docs/sdks/shipping/README.md#checkpincodeserviceability)
-- [userNotificationPreferencesCreate](docs/sdks/notificationpreferences/README.md#create)
-- [userNotificationPreferencesGet](docs/sdks/notificationpreferences/README.md#get)
-- [userNotificationPreferencesUpdate](docs/sdks/notificationpreferences/README.md#update)
-- [utilsGetCountries](docs/sdks/utils/README.md#getcountries)
-- [utilsGetPincodes](docs/sdks/utils/README.md#getpincodes)
-- [utilsGetStates](docs/sdks/utils/README.md#getstates)
-- [wishlistAdd](docs/sdks/wishlist/README.md#add)
-- [wishlistDelete](docs/sdks/wishlist/README.md#delete)
-- [wishlistGet](docs/sdks/wishlist/README.md#get)
-
+- [`analyticsTrack`](docs/sdks/analytics/README.md#track) - Track event
+- [`authGenerateOtp`](docs/sdks/auth/README.md#generateotp) - Generate OTP
+- [`authLoginAnonymously`](docs/sdks/auth/README.md#loginanonymously) - Anonymous user
+- [`authLoginWithEmail`](docs/sdks/auth/README.md#loginwithemail) - Login with email
+- [`authLoginWithPassword`](docs/sdks/auth/README.md#loginwithpassword) - Login with password
+- [`authLoginWithPhone`](docs/sdks/auth/README.md#loginwithphone) - Login with phone
+- [`authLoginWithWhatsapp`](docs/sdks/auth/README.md#loginwithwhatsapp) - Login with whatsapp
+- [`authRefreshToken`](docs/sdks/auth/README.md#refreshtoken) - Refresh access token
+- [`authRegisterWithEmail`](docs/sdks/auth/README.md#registerwithemail) - Register with email
+- [`authRegisterWithPassword`](docs/sdks/auth/README.md#registerwithpassword) - Register with password
+- [`authRegisterWithPhone`](docs/sdks/auth/README.md#registerwithphone) - Register with phone
+- [`authRegisterWithWhatsapp`](docs/sdks/auth/README.md#registerwithwhatsapp) - Register with whatsapp
+- [`authUserAddProfileImage`](docs/sdks/cestorefrontuser/README.md#addprofileimage) - Add profile image
+- [`authUserChangePassword`](docs/sdks/cestorefrontuser/README.md#changepassword) - Change password
+- [`authUserDeactivateAccount`](docs/sdks/cestorefrontuser/README.md#deactivateaccount) - Deactivate account
+- [`authUserDeleteProfileImage`](docs/sdks/cestorefrontuser/README.md#deleteprofileimage) - Delete profile image
+- [`authUserForgotPassword`](docs/sdks/cestorefrontuser/README.md#forgotpassword) - Forgot password
+- [`authUserGet`](docs/sdks/cestorefrontuser/README.md#get) - Retrieve a user
+- [`authUserGetProfileImage`](docs/sdks/cestorefrontuser/README.md#getprofileimage) - Retrieve a profile image
+- [`authUserLogout`](docs/sdks/cestorefrontuser/README.md#logout) - Logout user
+- [`authUserResetPassword`](docs/sdks/cestorefrontuser/README.md#resetpassword) - Reset password
+- [`authUserUpdate`](docs/sdks/cestorefrontuser/README.md#update) - Update a user
+- [`authUserUpdateProfileImage`](docs/sdks/cestorefrontuser/README.md#updateprofileimage) - Update profile image
+- [`authVerifyEmailPhone`](docs/sdks/auth/README.md#verifyemailphone) - Check verified email phone
+- [`authVerifyOtp`](docs/sdks/auth/README.md#verifyotp) - Verify OTP
+- [`campaignsNewsletterSubscribe`](docs/sdks/newsletter/README.md#subscribe) - Subscribe to newsletter
+- [`cartsAddItem`](docs/sdks/carts/README.md#additem) - Add/delete cart item
+- [`cartsCreate`](docs/sdks/carts/README.md#create) - Create cart
+- [`cartsDelete`](docs/sdks/carts/README.md#delete) - Delete cart
+- [`cartsGet`](docs/sdks/carts/README.md#get) - Retrieve cart details
+- [`catalogCategoriesList`](docs/sdks/categories/README.md#list) - List all categories
+- [`catalogProductsGet`](docs/sdks/products/README.md#get) - Retrieve a product
+- [`catalogProductsGetCrossSells`](docs/sdks/products/README.md#getcrosssells) - Retrieve cross-sell products
+- [`catalogProductsGetSimilar`](docs/sdks/products/README.md#getsimilar) - Retrieve similar products
+- [`catalogProductsGetUpsells`](docs/sdks/products/README.md#getupsells) - Retrieve up-sell products
+- [`catalogProductsList`](docs/sdks/products/README.md#list) - List all products
+- [`catalogProductsReviewsCreate`](docs/sdks/cestorefrontreviews/README.md#create) - Create product review
+- [`catalogProductsReviewsList`](docs/sdks/cestorefrontreviews/README.md#list) - Retrieve product reviews
+- [`catalogProductsVariantsGet`](docs/sdks/variants/README.md#get) - Retrieve variant detail
+- [`catalogProductsVariantsList`](docs/sdks/variants/README.md#list) - Retrieve product variants
+- [`catalogSkusList`](docs/sdks/skus/README.md#list) - List all SKUs
+- [`checkoutApplyCoupon`](docs/sdks/checkout/README.md#applycoupon) - Apply coupon
+- [`checkoutRedeemGiftCard`](docs/sdks/checkout/README.md#redeemgiftcard) - Redeem gift card
+- [`checkoutRedeemLoyaltyPoints`](docs/sdks/checkout/README.md#redeemloyaltypoints) - Redeem loyalty points
+- [`checkoutRemoveCoupon`](docs/sdks/checkout/README.md#removecoupon) - Remove coupon
+- [`checkoutRemoveCreditBalance`](docs/sdks/checkout/README.md#removecreditbalance) - Remove credit balance
+- [`checkoutRemoveLoyaltyPoints`](docs/sdks/checkout/README.md#removeloyaltypoints) - Remove loyalty points
+- [`checkoutUpdateAddress`](docs/sdks/checkout/README.md#updateaddress) - Update cart address
+- [`checkoutUseCreditBalance`](docs/sdks/checkout/README.md#usecreditbalance) - Use credit balance
+- [`customersAddressesAdd`](docs/sdks/addresses/README.md#add) - Add address
+- [`customersAddressesDelete`](docs/sdks/addresses/README.md#delete) - Remove particular address
+- [`customersAddressesGet`](docs/sdks/addresses/README.md#get) - Retrieve particular address
+- [`customersAddressesList`](docs/sdks/addresses/README.md#list) - Retrieve all addresses
+- [`customersAddressesUpdate`](docs/sdks/addresses/README.md#update) - Update particular address
+- [`customersAPIGetCustomersId`](docs/sdks/customersapi/README.md#getcustomersid) - Retrieve customer detail
+- [`customersAPIGetRecommendedProducts`](docs/sdks/customersapi/README.md#getrecommendedproducts) - List all recommended products
+- [`customersAPIPostCustomers`](docs/sdks/customersapi/README.md#postcustomers) - Create customer
+- [`customersAPIPutCustomersId`](docs/sdks/customersapi/README.md#putcustomersid) - Update customer detail
+- [`customersLoyaltyGet`](docs/sdks/loyalty/README.md#get) - Retrieve loyalty details
+- [`customersLoyaltyListActivities`](docs/sdks/loyalty/README.md#listactivities) - List all loyalty points activity
+- [`customersReviewsList`](docs/sdks/reviews/README.md#list) - Retrieve all reviews
+- [`offersCouponsList`](docs/sdks/coupons/README.md#list) - Retrieve all coupons
+- [`offersPromotionsList`](docs/sdks/promotions/README.md#list) - Retrieve all promotions
+- [`ordersCancel`](docs/sdks/orders/README.md#cancel) - Cancel order
+- [`ordersCreate`](docs/sdks/orders/README.md#create) - Create order
+- [`ordersGet`](docs/sdks/orders/README.md#get) - Retrieve order detail
+- [`ordersList`](docs/sdks/orders/README.md#list) - Retrieve all orders
+- [`ordersPaymentsList`](docs/sdks/cestorefrontpayments/README.md#list) - Retrieve order payments
+- [`ordersRefundsList`](docs/sdks/refunds/README.md#list) - Retrieve order refunds
+- [`ordersRetryPayment`](docs/sdks/orders/README.md#retrypayment) - Retry payment
+- [`ordersShipmentsList`](docs/sdks/shipments/README.md#list) - Retrieve order shipments
+- [`paymentsGenerateHash`](docs/sdks/payments/README.md#generatehash) - Generate hash
+- [`paymentsGetMethods`](docs/sdks/payments/README.md#getmethods) - Retrieve available payment methods
+- [`shippingCheckPincodeServiceability`](docs/sdks/shipping/README.md#checkpincodeserviceability) - Check pincode serviceability
+- [`userNotificationPreferencesCreate`](docs/sdks/notificationpreferences/README.md#create) - Create user notification preferences
+- [`userNotificationPreferencesGet`](docs/sdks/notificationpreferences/README.md#get) - Retrieve user notification preferences
+- [`userNotificationPreferencesUpdate`](docs/sdks/notificationpreferences/README.md#update) - Update user notification preferences
+- [`utilsGetCountries`](docs/sdks/utils/README.md#getcountries) - Retrieve all countries
+- [`utilsGetPincodes`](docs/sdks/utils/README.md#getpincodes) - Retrieve pincodes
+- [`utilsGetStates`](docs/sdks/utils/README.md#getstates) - Retrieve country wise states
+- [`wishlistAdd`](docs/sdks/wishlist/README.md#add) - Add product to wishlist
+- [`wishlistDelete`](docs/sdks/wishlist/README.md#delete) - Delete product from wishlist
+- [`wishlistGet`](docs/sdks/wishlist/README.md#get) - Retrieve wishlist
 
 </details>
 <!-- End Standalone functions [standalone-funcs] -->
@@ -351,18 +399,22 @@ Certain SDK methods accept files as part of a multi-part request. It is possible
 
 ```typescript
 import { CeStorefront } from "ce-storefront";
+import { openAsBlob } from "node:fs";
 
 const ceStorefront = new CeStorefront({
-    authorization: "<YOUR_BEARER_TOKEN_HERE>",
+  authorization: "<YOUR_BEARER_TOKEN_HERE>",
 });
 
 async function run() {
-    const result = await ceStorefront.auth.user.addProfileImage({
-        id: "<id>",
-    });
+  const result = await ceStorefront.auth.user.addProfileImage({
+    id: "<id>",
+    requestBody: {
+      image: await openAsBlob("example.file"),
+    },
+  });
 
-    // Handle the result
-    console.log(result);
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -380,30 +432,27 @@ To change the default retry strategy for a single API call, simply provide a ret
 import { CeStorefront } from "ce-storefront";
 
 const ceStorefront = new CeStorefront({
-    authorization: "<YOUR_BEARER_TOKEN_HERE>",
+  authorization: "<YOUR_BEARER_TOKEN_HERE>",
 });
 
 async function run() {
-    const result = await ceStorefront.catalog.products.list(
-        {
-            sortBy: '{"country":"asc","city":"asc","population":"desc"}',
-        },
-        {
-            retries: {
-                strategy: "backoff",
-                backoff: {
-                    initialInterval: 1,
-                    maxInterval: 50,
-                    exponent: 1.1,
-                    maxElapsedTime: 100,
-                },
-                retryConnectionErrors: false,
-            },
-        }
-    );
+  const result = await ceStorefront.catalog.products.list({
+    sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
+  }, {
+    retries: {
+      strategy: "backoff",
+      backoff: {
+        initialInterval: 1,
+        maxInterval: 50,
+        exponent: 1.1,
+        maxElapsedTime: 100,
+      },
+      retryConnectionErrors: false,
+    },
+  });
 
-    // Handle the result
-    console.log(result);
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -415,26 +464,26 @@ If you'd like to override the default retry strategy for all operations that sup
 import { CeStorefront } from "ce-storefront";
 
 const ceStorefront = new CeStorefront({
-    retryConfig: {
-        strategy: "backoff",
-        backoff: {
-            initialInterval: 1,
-            maxInterval: 50,
-            exponent: 1.1,
-            maxElapsedTime: 100,
-        },
-        retryConnectionErrors: false,
+  retryConfig: {
+    strategy: "backoff",
+    backoff: {
+      initialInterval: 1,
+      maxInterval: 50,
+      exponent: 1.1,
+      maxElapsedTime: 100,
     },
-    authorization: "<YOUR_BEARER_TOKEN_HERE>",
+    retryConnectionErrors: false,
+  },
+  authorization: "<YOUR_BEARER_TOKEN_HERE>",
 });
 
 async function run() {
-    const result = await ceStorefront.catalog.products.list({
-        sortBy: '{"country":"asc","city":"asc","population":"desc"}',
-    });
+  const result = await ceStorefront.catalog.products.list({
+    sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
+  });
 
-    // Handle the result
-    console.log(result);
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -445,61 +494,78 @@ run();
 <!-- Start Error Handling [errors] -->
 ## Error Handling
 
-All SDK methods return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.
+All SDK methods return a response object or throw an error. By default, an API error will throw a `errors.SDKError`.
 
-| Error Object        | Status Code         | Content Type        |
-| ------------------- | ------------------- | ------------------- |
-| errors.Unauthorized | 401                 | application/json    |
-| errors.NotFound     | 404                 | application/json    |
-| errors.SDKError     | 4xx-5xx             | */*                 |
+If a HTTP request fails, an operation my also throw an error from the `models/errors/httpclienterrors.ts` module:
 
-Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging. 
+| HTTP Client Error                                    | Description                                          |
+| ---------------------------------------------------- | ---------------------------------------------------- |
+| RequestAbortedError                                  | HTTP request was aborted by the client               |
+| RequestTimeoutError                                  | HTTP request timed out due to an AbortSignal signal  |
+| ConnectionError                                      | HTTP client was unable to make a request to a server |
+| InvalidRequestError                                  | Any input used to create a request is invalid        |
+| UnexpectedClientError                                | Unrecognised or unexpected error                     |
 
+In addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective *Errors* tables in SDK docs for more details on possible error types for each operation. For example, the `list` method may throw the following errors:
+
+| Error Type          | Status Code | Content Type     |
+| ------------------- | ----------- | ---------------- |
+| errors.Unauthorized | 401         | application/json |
+| errors.NotFound     | 404         | application/json |
+| errors.SDKError     | 4XX, 5XX    | \*/\*            |
 
 ```typescript
 import { CeStorefront } from "ce-storefront";
-import { SDKValidationError } from "ce-storefront/models/errors";
+import {
+  NotFound,
+  SDKValidationError,
+  Unauthorized,
+} from "ce-storefront/models/errors";
 
 const ceStorefront = new CeStorefront({
-    authorization: "<YOUR_BEARER_TOKEN_HERE>",
+  authorization: "<YOUR_BEARER_TOKEN_HERE>",
 });
 
 async function run() {
-    let result;
-    try {
-        result = await ceStorefront.catalog.products.list({
-            sortBy: '{"country":"asc","city":"asc","population":"desc"}',
-        });
-    } catch (err) {
-        switch (true) {
-            case err instanceof SDKValidationError: {
-                // Validation errors can be pretty-printed
-                console.error(err.pretty());
-                // Raw value may also be inspected
-                console.error(err.rawValue);
-                return;
-            }
-            case err instanceof errors.Unauthorized: {
-                console.error(err); // handle exception
-                return;
-            }
-            case err instanceof errors.NotFound: {
-                console.error(err); // handle exception
-                return;
-            }
-            default: {
-                throw err;
-            }
-        }
-    }
+  let result;
+  try {
+    result = await ceStorefront.catalog.products.list({
+      sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
+    });
 
     // Handle the result
     console.log(result);
+  } catch (err) {
+    switch (true) {
+      case (err instanceof SDKValidationError): {
+        // Validation errors can be pretty-printed
+        console.error(err.pretty());
+        // Raw value may also be inspected
+        console.error(err.rawValue);
+        return;
+      }
+      case (err instanceof Unauthorized): {
+        // Handle err.data$: UnauthorizedData
+        console.error(err);
+        return;
+      }
+      case (err instanceof NotFound): {
+        // Handle err.data$: NotFoundData
+        console.error(err);
+        return;
+      }
+      default: {
+        throw err;
+      }
+    }
+  }
 }
 
 run();
 
 ```
+
+Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.
 <!-- End Error Handling [errors] -->
 
 <!-- Start Server Selection [server] -->
@@ -507,58 +573,57 @@ run();
 
 ### Select Server by Index
 
-You can override the default server globally by passing a server index to the `serverIdx` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
+You can override the default server globally by passing a server index to the `serverIdx: number` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
 
-| # | Server | Variables |
-| - | ------ | --------- |
-| 0 | `https://staging.api.commercengine.io/api/v1/{store_id}/storefront` | `store_id` (default is `x2yh61zw4k`) |
-| 1 | `https://prod.api.commercengine.io/api/v1/{store_id}/storefront` | `store_id` (default is `x2yh61zw4k`) |
+| #   | Server                                                              | Variables         | Default values |
+| --- | ------------------------------------------------------------------- | ----------------- | -------------- |
+| 0   | `https://staging.api.commercengine.io/api/v1/{store_id}/storefront` | `storeId: string` | `"x2yh61zw4k"` |
+| 1   | `https://prod.api.commercengine.io/api/v1/{store_id}/storefront`    | `storeId: string` | `"x2yh61zw4k"` |
+
+If the selected server has variables, you may override their default values through the additional parameters made available in the SDK constructor.
+
+#### Example
 
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
 const ceStorefront = new CeStorefront({
-    serverIdx: 1,
-    authorization: "<YOUR_BEARER_TOKEN_HERE>",
+  serverIdx: 1,
+  authorization: "<YOUR_BEARER_TOKEN_HERE>",
 });
 
 async function run() {
-    const result = await ceStorefront.catalog.products.list({
-        sortBy: '{"country":"asc","city":"asc","population":"desc"}',
-    });
+  const result = await ceStorefront.catalog.products.list({
+    sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
+  });
 
-    // Handle the result
-    console.log(result);
+  // Handle the result
+  console.log(result);
 }
 
 run();
 
 ```
 
-#### Variables
-
-Some of the server options above contain variables. If you want to set the values of those variables, the following optional parameters are available when initializing the SDK client instance:
- * `storeId: string`
-
 ### Override Server URL Per-Client
 
-The default server can also be overridden globally by passing a URL to the `serverURL` optional parameter when initializing the SDK client instance. For example:
-
+The default server can also be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
 const ceStorefront = new CeStorefront({
-    serverURL: "https://staging.api.commercengine.io/api/v1/{store_id}/storefront",
-    authorization: "<YOUR_BEARER_TOKEN_HERE>",
+  serverURL:
+    "https://staging.api.commercengine.io/api/v1/x2yh61zw4k/storefront",
+  authorization: "<YOUR_BEARER_TOKEN_HERE>",
 });
 
 async function run() {
-    const result = await ceStorefront.catalog.products.list({
-        sortBy: '{"country":"asc","city":"asc","population":"desc"}',
-    });
+  const result = await ceStorefront.catalog.products.list({
+    sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
+  });
 
-    // Handle the result
-    console.log(result);
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -622,25 +687,25 @@ const sdk = new CeStorefront({ httpClient });
 
 This SDK supports the following security scheme globally:
 
-| Name            | Type            | Scheme          |
-| --------------- | --------------- | --------------- |
-| `authorization` | http            | HTTP Bearer     |
+| Name            | Type | Scheme      |
+| --------------- | ---- | ----------- |
+| `authorization` | http | HTTP Bearer |
 
 To authenticate with the API the `authorization` parameter must be set when initializing the SDK client instance. For example:
 ```typescript
 import { CeStorefront } from "ce-storefront";
 
 const ceStorefront = new CeStorefront({
-    authorization: "<YOUR_BEARER_TOKEN_HERE>",
+  authorization: "<YOUR_BEARER_TOKEN_HERE>",
 });
 
 async function run() {
-    const result = await ceStorefront.catalog.products.list({
-        sortBy: '{"country":"asc","city":"asc","population":"desc"}',
-    });
+  const result = await ceStorefront.catalog.products.list({
+    sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
+  });
 
-    // Handle the result
-    console.log(result);
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -656,12 +721,12 @@ import { CeStorefront } from "ce-storefront";
 const ceStorefront = new CeStorefront();
 
 async function run() {
-    const result = await ceStorefront.auth.loginAnonymously({
-        xApiKey: "<YOUR_API_KEY_HERE>",
-    });
+  const result = await ceStorefront.auth.loginAnonymously({
+    xApiKey: "<YOUR_API_KEY_HERE>",
+  });
 
-    // Handle the result
-    console.log(result);
+  // Handle the result
+  console.log(result);
 }
 
 run();