ce-storefront 0.0.1

package/README.md

@@ -0,0 +1,714 @@
+# ce-storefront
+
+<div align="left">
+    <a href="https://www.speakeasy.com/?utm_source=ce-storefront&utm_campaign=typescript"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
+    <a href="https://opensource.org/licenses/MIT">
+        <img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" />
+    </a>
+</div>
+
+
+## 🏗 **Welcome to your new SDK!** 🏗
+
+It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:
+- [ ] 🛠 Make your SDK feel handcrafted by [customizing it](https://www.speakeasy.com/docs/customize-sdks)
+- [ ] ♻️ Refine your SDK quickly by iterating locally with the [Speakeasy CLI](https://github.com/speakeasy-api/speakeasy)
+- [ ] 🎁 Publish your SDK to package managers by [configuring automatic publishing](https://www.speakeasy.com/docs/advanced-setup/publish-sdks)
+- [ ] ✨ When ready to productionize, delete this section from the README
+
+<!-- Start SDK Installation [installation] -->
+## SDK Installation
+
+### NPM
+
+```bash
+npm add <UNSET>
+```
+
+### PNPM
+
+```bash
+pnpm add <UNSET>
+```
+
+### Bun
+
+```bash
+bun add <UNSET>
+```
+
+### Yarn
+
+```bash
+yarn add <UNSET> zod
+
+# Note that Yarn does not install peer dependencies automatically. You will need
+# to install zod as shown above.
+```
+<!-- End SDK Installation [installation] -->
+
+<!-- Start Requirements [requirements] -->
+## Requirements
+
+For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
+<!-- End Requirements [requirements] -->
+
+<!-- Start SDK Example Usage [usage] -->
+## SDK Example Usage
+
+### Example
+
+```typescript
+import { CeStorefront } from "ce-storefront";
+
+const ceStorefront = new CeStorefront({
+    authorization: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+    const result = await ceStorefront.catalog.products.list({
+        sortBy: '{"country":"asc","city":"asc","population":"desc"}',
+    });
+
+    // Handle the result
+    console.log(result);
+}
+
+run();
+
+```
+<!-- End SDK Example Usage [usage] -->
+
+<!-- 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
+
+### [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.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.similar](docs/sdks/similar/README.md)
+
+* [list](docs/sdks/similar/README.md#list) - Retrieve similar products
+
+### [catalog.products.upSell](docs/sdks/upsell/README.md)
+
+* [list](docs/sdks/upsell/README.md#list) - Retrieve up-sell products
+
+### [catalog.products.crossSell](docs/sdks/crosssell/README.md)
+
+* [list](docs/sdks/crosssell/README.md#list) - Retrieve cross-sell products
+
+### [catalog.products.recommended](docs/sdks/recommended/README.md)
+
+* [list](docs/sdks/recommended/README.md#list) - Retrieve recommended products
+
+### [catalog.skus](docs/sdks/skus/README.md)
+
+* [list](docs/sdks/skus/README.md#list) - List all SKUs
+
+### [catalog.categories](docs/sdks/categories/README.md)
+
+* [list](docs/sdks/categories/README.md#list) - List all categories
+
+### [carts](docs/sdks/carts/README.md)
+
+* [create](docs/sdks/carts/README.md#create) - Create cart
+* [get](docs/sdks/carts/README.md#get) - Retrieve cart details
+* [delete](docs/sdks/carts/README.md#delete) - Delete cart
+* [addItem](docs/sdks/carts/README.md#additem) - Add/delete cart item
+
+### [checkout](docs/sdks/checkout/README.md)
+
+* [updateAddress](docs/sdks/checkout/README.md#updateaddress) - Update cart address
+* [applyCoupon](docs/sdks/checkout/README.md#applycoupon) - Apply coupon
+* [removeCoupon](docs/sdks/checkout/README.md#removecoupon) - Remove coupon
+* [redeemLoyaltyPoints](docs/sdks/checkout/README.md#redeemloyaltypoints) - Redeem loyalty points
+* [removeLoyaltyPoints](docs/sdks/checkout/README.md#removeloyaltypoints) - Remove loyalty points
+* [useCreditBalance](docs/sdks/checkout/README.md#usecreditbalance) - Use credit balance
+* [removeCreditBalance](docs/sdks/checkout/README.md#removecreditbalance) - Remove credit balance
+* [redeemGiftCard](docs/sdks/checkout/README.md#redeemgiftcard) - Redeem gift card
+
+### [offers](docs/sdks/offers/README.md)
+
+* [getCoupons](docs/sdks/offers/README.md#getcoupons) - Retrieve all coupons
+* [getPromotions](docs/sdks/offers/README.md#getpromotions) - 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)
+
+* [getAddresses](docs/sdks/customers/README.md#getaddresses) - Retrieve all addresses
+
+### [customers.addresses](docs/sdks/addresses/README.md)
+
+* [add](docs/sdks/addresses/README.md#add) - Add address
+* [get](docs/sdks/addresses/README.md#get) - Retrieve particular address
+* [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)
+
+* [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)
+
+* [getAll](docs/sdks/reviews/README.md#getall) - Retrieve all reviews
+
+### [orders](docs/sdks/orders/README.md)
+
+* [create](docs/sdks/orders/README.md#create) - Create order
+* [list](docs/sdks/orders/README.md#list) - Retrieve all orders
+* [get](docs/sdks/orders/README.md#get) - Retrieve order detail
+* [cancel](docs/sdks/orders/README.md#cancel) - Cancel order
+* [retryPayment](docs/sdks/orders/README.md#retrypayment) - Retry payment
+* [getReturns](docs/sdks/orders/README.md#getreturns) - Retrieve all order returns
+
+### [orders.shipments](docs/sdks/shipments/README.md)
+
+* [list](docs/sdks/shipments/README.md#list) - Retrieve order shipments
+
+### [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.returns](docs/sdks/returns/README.md)
+
+* [create](docs/sdks/returns/README.md#create) - Create order return
+* [list](docs/sdks/returns/README.md#list) - List all order returns
+* [get](docs/sdks/returns/README.md#get) - Retrieve order return detail
+
+### [shipping](docs/sdks/shipping/README.md)
+
+* [getPincodeServiceability](docs/sdks/shipping/README.md#getpincodeserviceability) - Check pincode serviceability
+
+### [auth](docs/sdks/auth/README.md)
+
+* [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
+* [getUser](docs/sdks/auth/README.md#getuser) - Retrieve a user
+* [updateUser](docs/sdks/auth/README.md#updateuser) - Update a user
+* [verifyEmailPhone](docs/sdks/auth/README.md#verifyemailphone) - Check verified email phone
+
+### [auth.user](docs/sdks/user/README.md)
+
+* [addProfileImage](docs/sdks/user/README.md#addprofileimage) - Add profile image
+* [updateProfileImage](docs/sdks/user/README.md#updateprofileimage) - Update profile image
+* [deleteProfileImage](docs/sdks/user/README.md#deleteprofileimage) - Delete profile image
+* [getProfileImage](docs/sdks/user/README.md#getprofileimage) - Retrieve a profile image
+* [deactivateAccount](docs/sdks/user/README.md#deactivateaccount) - Deactivate account
+* [changePassword](docs/sdks/user/README.md#changepassword) - Change password
+* [forgotPassword](docs/sdks/user/README.md#forgotpassword) - Forgot password
+* [resetPassword](docs/sdks/user/README.md#resetpassword) - Reset password
+* [getNotificationPreferences](docs/sdks/user/README.md#getnotificationpreferences) - Retrieve user notification preferences
+* [createNotificationPreferences](docs/sdks/user/README.md#createnotificationpreferences) - Create user notification preferences
+* [updateNotificationPreferences](docs/sdks/user/README.md#updatenotificationpreferences) - Update user notification preferences
+* [logout](docs/sdks/user/README.md#logout) - Logout user
+
+### [auth.token](docs/sdks/token/README.md)
+
+* [refresh](docs/sdks/token/README.md#refresh) - Refresh access token
+
+### [auth.otp](docs/sdks/otp/README.md)
+
+* [generate](docs/sdks/otp/README.md#generate) - Generate OTP
+
+### [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
+
+### [common](docs/sdks/common/README.md)
+
+* [getCountries](docs/sdks/common/README.md#getcountries) - Retrieve all countries
+
+### [common.countries](docs/sdks/countries/README.md)
+
+* [getStates](docs/sdks/countries/README.md#getstates) - Retrieve country wise states
+* [getPincodes](docs/sdks/countries/README.md#getpincodes) - Retrieve pincodes
+
+### [analytics](docs/sdks/analytics/README.md)
+
+* [trackEvent](docs/sdks/analytics/README.md#trackevent) - Track event
+
+### [campaigns](docs/sdks/campaigns/README.md)
+
+* [subscribeNewsletter](docs/sdks/campaigns/README.md#subscribenewsletter) - Subscribe to newsletter
+<!-- End Available Resources and Operations [operations] -->
+
+<!-- Start Standalone functions [standalone-funcs] -->
+## Standalone functions
+
+All the methods listed above are available as standalone functions. These
+functions are ideal for use in applications running in the browser, serverless
+runtimes or other environments where application bundle size is a primary
+concern. When using a bundler to build your application, all unused
+functionality will be either excluded from the final bundle or tree-shaken away.
+
+To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
+
+<details>
+
+<summary>Available standalone functions</summary>
+
+- [analyticsTrackEvent](docs/sdks/analytics/README.md#trackevent)
+- [authGetUser](docs/sdks/auth/README.md#getuser)
+- [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)
+- [authOtpGenerate](docs/sdks/otp/README.md#generate)
+- [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)
+- [authTokenRefresh](docs/sdks/token/README.md#refresh)
+- [authUpdateUser](docs/sdks/auth/README.md#updateuser)
+- [authUserAddProfileImage](docs/sdks/user/README.md#addprofileimage)
+- [authUserChangePassword](docs/sdks/user/README.md#changepassword)
+- [authUserCreateNotificationPreferences](docs/sdks/user/README.md#createnotificationpreferences)
+- [authUserDeactivateAccount](docs/sdks/user/README.md#deactivateaccount)
+- [authUserDeleteProfileImage](docs/sdks/user/README.md#deleteprofileimage)
+- [authUserForgotPassword](docs/sdks/user/README.md#forgotpassword)
+- [authUserGetNotificationPreferences](docs/sdks/user/README.md#getnotificationpreferences)
+- [authUserGetProfileImage](docs/sdks/user/README.md#getprofileimage)
+- [authUserLogout](docs/sdks/user/README.md#logout)
+- [authUserResetPassword](docs/sdks/user/README.md#resetpassword)
+- [authUserUpdateNotificationPreferences](docs/sdks/user/README.md#updatenotificationpreferences)
+- [authUserUpdateProfileImage](docs/sdks/user/README.md#updateprofileimage)
+- [authVerifyEmailPhone](docs/sdks/auth/README.md#verifyemailphone)
+- [authVerifyOtp](docs/sdks/auth/README.md#verifyotp)
+- [campaignsSubscribeNewsletter](docs/sdks/campaigns/README.md#subscribenewsletter)
+- [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)
+- [catalogProductsCrossSellList](docs/sdks/crosssell/README.md#list)
+- [catalogProductsGet](docs/sdks/products/README.md#get)
+- [catalogProductsList](docs/sdks/products/README.md#list)
+- [catalogProductsRecommendedList](docs/sdks/recommended/README.md#list)
+- [catalogProductsReviewsCreate](docs/sdks/cestorefrontreviews/README.md#create)
+- [catalogProductsReviewsList](docs/sdks/cestorefrontreviews/README.md#list)
+- [catalogProductsSimilarList](docs/sdks/similar/README.md#list)
+- [catalogProductsUpSellList](docs/sdks/upsell/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)
+- [commonCountriesGetPincodes](docs/sdks/countries/README.md#getpincodes)
+- [commonCountriesGetStates](docs/sdks/countries/README.md#getstates)
+- [commonGetCountries](docs/sdks/common/README.md#getcountries)
+- [customersAddressesAdd](docs/sdks/addresses/README.md#add)
+- [customersAddressesDelete](docs/sdks/addresses/README.md#delete)
+- [customersAddressesGet](docs/sdks/addresses/README.md#get)
+- [customersAddressesUpdate](docs/sdks/addresses/README.md#update)
+- [customersGetAddresses](docs/sdks/customers/README.md#getaddresses)
+- [customersLoyaltyGet](docs/sdks/loyalty/README.md#get)
+- [customersLoyaltyListActivities](docs/sdks/loyalty/README.md#listactivities)
+- [customersReviewsGetAll](docs/sdks/reviews/README.md#getall)
+- [offersGetCoupons](docs/sdks/offers/README.md#getcoupons)
+- [offersGetPromotions](docs/sdks/offers/README.md#getpromotions)
+- [ordersCancel](docs/sdks/orders/README.md#cancel)
+- [ordersCreate](docs/sdks/orders/README.md#create)
+- [ordersGetReturns](docs/sdks/orders/README.md#getreturns)
+- [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)
+- [ordersReturnsCreate](docs/sdks/returns/README.md#create)
+- [ordersReturnsGet](docs/sdks/returns/README.md#get)
+- [ordersReturnsList](docs/sdks/returns/README.md#list)
+- [ordersShipmentsList](docs/sdks/shipments/README.md#list)
+- [paymentsGenerateHash](docs/sdks/payments/README.md#generatehash)
+- [paymentsGetMethods](docs/sdks/payments/README.md#getmethods)
+- [shippingGetPincodeServiceability](docs/sdks/shipping/README.md#getpincodeserviceability)
+- [wishlistAdd](docs/sdks/wishlist/README.md#add)
+- [wishlistDelete](docs/sdks/wishlist/README.md#delete)
+- [wishlistGet](docs/sdks/wishlist/README.md#get)
+
+
+</details>
+<!-- End Standalone functions [standalone-funcs] -->
+
+<!-- Start File uploads [file-upload] -->
+## File uploads
+
+Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.
+
+> [!TIP]
+>
+> Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:
+>
+> - **Node.js v20+:** Since v20, Node.js comes with a native `openAsBlob` function in [`node:fs`](https://nodejs.org/docs/latest-v20.x/api/fs.html#fsopenasblobpath-options).
+> - **Bun:** The native [`Bun.file`](https://bun.sh/docs/api/file-io#reading-files-bun-file) function produces a file handle that can be used for streaming file uploads.
+> - **Browsers:** All supported browsers return an instance to a [`File`](https://developer.mozilla.org/en-US/docs/Web/API/File) when reading the value from an `<input type="file">` element.
+> - **Node.js v18:** A file stream can be created using the `fileFrom` helper from [`fetch-blob/from.js`](https://www.npmjs.com/package/fetch-blob).
+
+```typescript
+import { CeStorefront } from "ce-storefront";
+
+const ceStorefront = new CeStorefront({
+    authorization: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+    const result = await ceStorefront.auth.user.addProfileImage({
+        id: "<id>",
+    });
+
+    // Handle the result
+    console.log(result);
+}
+
+run();
+
+```
+<!-- End File uploads [file-upload] -->
+
+<!-- Start Retries [retries] -->
+## Retries
+
+Some of the endpoints in this SDK support retries.  If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API.  However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
+
+To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
+```typescript
+import { CeStorefront } from "ce-storefront";
+
+const ceStorefront = new CeStorefront({
+    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,
+            },
+        }
+    );
+
+    // Handle the result
+    console.log(result);
+}
+
+run();
+
+```
+
+If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
+```typescript
+import { CeStorefront } from "ce-storefront";
+
+const ceStorefront = new CeStorefront({
+    retryConfig: {
+        strategy: "backoff",
+        backoff: {
+            initialInterval: 1,
+            maxInterval: 50,
+            exponent: 1.1,
+            maxElapsedTime: 100,
+        },
+        retryConnectionErrors: false,
+    },
+    authorization: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+    const result = await ceStorefront.catalog.products.list({
+        sortBy: '{"country":"asc","city":"asc","population":"desc"}',
+    });
+
+    // Handle the result
+    console.log(result);
+}
+
+run();
+
+```
+<!-- End Retries [retries] -->
+
+<!-- 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.
+
+| Error Object        | Status Code         | Content Type        |
+| ------------------- | ------------------- | ------------------- |
+| errors.Unauthorized | 401                 | application/json    |
+| errors.NotFound     | 404                 | application/json    |
+| errors.SDKError     | 4xx-5xx             | */*                 |
+
+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. 
+
+
+```typescript
+import { CeStorefront } from "ce-storefront";
+import { SDKValidationError } from "ce-storefront/models/errors";
+
+const ceStorefront = new CeStorefront({
+    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;
+            }
+        }
+    }
+
+    // Handle the result
+    console.log(result);
+}
+
+run();
+
+```
+<!-- End Error Handling [errors] -->
+
+<!-- Start Server Selection [server] -->
+## Server Selection
+
+### 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:
+
+| # | 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`) |
+| 2 | `https://stoplight.io/mocks/tarkaikaman/ce-apis/217963442` | None |
+
+```typescript
+import { CeStorefront } from "ce-storefront";
+
+const ceStorefront = new CeStorefront({
+    serverIdx: 2,
+    authorization: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+    const result = await ceStorefront.catalog.products.list({
+        sortBy: '{"country":"asc","city":"asc","population":"desc"}',
+    });
+
+    // 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:
+
+```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>",
+});
+
+async function run() {
+    const result = await ceStorefront.catalog.products.list({
+        sortBy: '{"country":"asc","city":"asc","population":"desc"}',
+    });
+
+    // Handle the result
+    console.log(result);
+}
+
+run();
+
+```
+<!-- End Server Selection [server] -->
+
+<!-- Start Custom HTTP Client [http-client] -->
+## Custom HTTP Client
+
+The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native
+[Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). This
+client is a thin wrapper around `fetch` and provides the ability to attach hooks
+around the request lifecycle that can be used to modify the request or handle
+errors and response.
+
+The `HTTPClient` constructor takes an optional `fetcher` argument that can be
+used to integrate a third-party HTTP client or when writing tests to mock out
+the HTTP client and feed in fixtures.
+
+The following example shows how to use the `"beforeRequest"` hook to to add a
+custom header and a timeout to requests and how to use the `"requestError"` hook
+to log errors:
+
+```typescript
+import { CeStorefront } from "ce-storefront";
+import { HTTPClient } from "ce-storefront/lib/http";
+
+const httpClient = new HTTPClient({
+  // fetcher takes a function that has the same signature as native `fetch`.
+  fetcher: (request) => {
+    return fetch(request);
+  }
+});
+
+httpClient.addHook("beforeRequest", (request) => {
+  const nextRequest = new Request(request, {
+    signal: request.signal || AbortSignal.timeout(5000)
+  });
+
+  nextRequest.headers.set("x-custom-header", "custom value");
+
+  return nextRequest;
+});
+
+httpClient.addHook("requestError", (error, request) => {
+  console.group("Request Error");
+  console.log("Reason:", `${error}`);
+  console.log("Endpoint:", `${request.method} ${request.url}`);
+  console.groupEnd();
+});
+
+const sdk = new CeStorefront({ httpClient });
+```
+<!-- End Custom HTTP Client [http-client] -->
+
+<!-- Start Authentication [security] -->
+## Authentication
+
+### Per-Client Security Schemes
+
+This SDK supports the following security scheme globally:
+
+| 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>",
+});
+
+async function run() {
+    const result = await ceStorefront.catalog.products.list({
+        sortBy: '{"country":"asc","city":"asc","population":"desc"}',
+    });
+
+    // Handle the result
+    console.log(result);
+}
+
+run();
+
+```
+<!-- End Authentication [security] -->
+
+<!-- Start Debugging [debug] -->
+## Debugging
+
+You can setup your SDK to emit debug logs for SDK requests and responses.
+
+You can pass a logger that matches `console`'s interface as an SDK option.
+
+> [!WARNING]
+> Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
+
+```typescript
+import { CeStorefront } from "ce-storefront";
+
+const sdk = new CeStorefront({ debugLogger: console });
+```
+<!-- End Debugging [debug] -->
+
+<!-- Placeholder for Future Speakeasy SDK Sections -->
+
+# Development
+
+## Maturity
+
+This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
+to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
+looking for the latest version.
+
+## Contributions
+
+While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. 
+We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release. 
+
+### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=ce-storefront&utm_campaign=typescript)