ce-storefront 0.0.4 → 0.1.0

package/README.md

@@ -1,8 +1,35 @@
 # 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
+
+* [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)
+<!-- 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 +73,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,35 +93,49 @@ run();
 <!-- Start Available Resources and Operations [operations] -->
 ## Available Resources and Operations
 
-### [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
+<details open>
+<summary>Available methods</summary>
 
-### [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
+* [subscribe](docs/sdks/newsletter/README.md#subscribe) - Subscribe to newsletter
 
 ### [carts](docs/sdks/carts/README.md)
 
@@ -103,6 +144,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
@@ -114,23 +185,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
@@ -138,15 +196,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
@@ -155,78 +231,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)
-
-* [list](docs/sdks/cestorefrontpayments/README.md#list) - Retrieve order payments
+#### [orders.shipments](docs/sdks/shipments/README.md)
 
-### [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] -->
@@ -293,7 +340,10 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [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)
@@ -347,16 +397,16 @@ Certain SDK methods accept files as part of a multi-part request. It is possible
 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.auth.user.addProfileImage({
-        id: "<id>",
-    });
+  const result = await ceStorefront.auth.user.addProfileImage({
+    id: "<id>",
+  });
 
-    // Handle the result
-    console.log(result);
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -374,30 +424,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();
@@ -409,26 +456,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();
@@ -452,43 +499,49 @@ Validation errors can also occur when either method arguments or data returned f
 
 ```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();
@@ -512,17 +565,17 @@ You can override the default server globally by passing a server index to the `s
 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();
@@ -542,17 +595,18 @@ The default server can also be overridden globally by passing a URL to the `serv
 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/{store_id}/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();
@@ -625,16 +679,16 @@ To authenticate with the API the `authorization` parameter must be set when init
 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();
@@ -650,12 +704,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();

package/docs/sdks/addresses/README.md

@@ -28,7 +28,7 @@ async function run() {
   const result = await ceStorefront.customers.addresses.list({
     userId: "<value>",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -105,7 +105,7 @@ async function run() {
   const result = await ceStorefront.customers.addresses.add({
     userId: "<value>",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -185,7 +185,7 @@ async function run() {
     userId: "<value>",
     addressId: "<value>",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -266,7 +266,7 @@ async function run() {
     userId: "<value>",
     addressId: "<value>",
   });
-
+  
   // Handle the result
   console.log(result)
 }
@@ -348,7 +348,7 @@ async function run() {
     userId: "<value>",
     addressId: "<value>",
   });
-
+  
   // Handle the result
   console.log(result)
 }

package/docs/sdks/analytics/README.md

@@ -22,7 +22,7 @@ const ceStorefront = new CeStorefront({
 
 async function run() {
   const result = await ceStorefront.analytics.track();
-
+  
   // Handle the result
   console.log(result)
 }