ce-storefront 0.2.6 → 0.3.1

package/README.md

@@ -61,6 +61,10 @@ yarn add ce-storefront zod
 # Note that Yarn does not install peer dependencies automatically. You will need
 # to install zod as shown above.
 ```
+
+> [!NOTE]
+> This package is published as an ES Module (ESM) only. For applications using
+> CommonJS, use `await import("ce-storefront")` to import and use this package.
 <!-- End SDK Installation [installation] -->
 
 <!-- Start Requirements [requirements] -->
@@ -248,14 +252,26 @@ run();
 
 * [list](docs/sdks/shipments/README.md#list) - Retrieve order shipments
 
+### [ordersAPI](docs/sdks/ordersapi/README.md)
+
+* [getOrdersIdPaymentStatus](docs/sdks/ordersapi/README.md#getordersidpaymentstatus) - Retrieve payment status
+
 ### [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
+* [getMethods](docs/sdks/payments/README.md#getmethods) - List all payment methods
 
 ### [paymentsAPI](docs/sdks/paymentsapi/README.md)
 
-* [postPaymentsSession](docs/sdks/paymentsapi/README.md#postpaymentssession) - Create payment session
+* [getPaymentsCards](docs/sdks/paymentsapi/README.md#getpaymentscards) - List all saved cards
+* [postPaymentsCards](docs/sdks/paymentsapi/README.md#postpaymentscards) - Add card
+* [getPaymentsVerifyVpa](docs/sdks/paymentsapi/README.md#getpaymentsverifyvpa) - Verify VPA
+
+### [paymentsAPIJuspay](docs/sdks/paymentsapijuspay/README.md)
+
+* [postPaymentsJuspayCreateOrder](docs/sdks/paymentsapijuspay/README.md#postpaymentsjuspaycreateorder) - Create order in juspay
+* [postPaymentsJuspayCreateCustomer](docs/sdks/paymentsapijuspay/README.md#postpaymentsjuspaycreatecustomer) - Create customer in juspay
+* [getPaymentsJuspayCustomer](docs/sdks/paymentsapijuspay/README.md#getpaymentsjuspaycustomer) - Retrieve customer from juspay
 
 ### [shipping](docs/sdks/shipping/README.md)
 
@@ -363,6 +379,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`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
+- [`ordersAPIGetOrdersIdPaymentStatus`](docs/sdks/ordersapi/README.md#getordersidpaymentstatus) - Retrieve payment status
 - [`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
@@ -371,9 +388,14 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`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
-- [`paymentsAPIPostPaymentsSession`](docs/sdks/paymentsapi/README.md#postpaymentssession) - Create payment session
+- [`paymentsAPIGetPaymentsCards`](docs/sdks/paymentsapi/README.md#getpaymentscards) - List all saved cards
+- [`paymentsAPIGetPaymentsVerifyVpa`](docs/sdks/paymentsapi/README.md#getpaymentsverifyvpa) - Verify VPA
+- [`paymentsAPIJuspayGetPaymentsJuspayCustomer`](docs/sdks/paymentsapijuspay/README.md#getpaymentsjuspaycustomer) - Retrieve customer from juspay
+- [`paymentsAPIJuspayPostPaymentsJuspayCreateCustomer`](docs/sdks/paymentsapijuspay/README.md#postpaymentsjuspaycreatecustomer) - Create customer in juspay
+- [`paymentsAPIJuspayPostPaymentsJuspayCreateOrder`](docs/sdks/paymentsapijuspay/README.md#postpaymentsjuspaycreateorder) - Create order in juspay
+- [`paymentsAPIPostPaymentsCards`](docs/sdks/paymentsapi/README.md#postpaymentscards) - Add card
 - [`paymentsGenerateHash`](docs/sdks/payments/README.md#generatehash) - Generate hash
-- [`paymentsGetMethods`](docs/sdks/payments/README.md#getmethods) - Retrieve available payment methods
+- [`paymentsGetMethods`](docs/sdks/payments/README.md#getmethods) - List all 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
@@ -505,9 +527,9 @@ Some methods specify known errors which can be thrown. All the known errors are
 | ------------------- | ----------- | ---------------- |
 | errors.Unauthorized | 401         | application/json |
 | errors.NotFound     | 404         | application/json |
-| errors.SDKError     | 4XX, 5XX    | \*/\*            |
+| errors.CeError      | 4XX, 5XX    | \*/\*            |
 
-If the method throws an error and it is not captured by the known errors, it will default to throwing a `SDKError`.
+If the method throws an error and it is not captured by the known errors, it will default to throwing a `CeError`.
 
 ```typescript
 import { CeStorefront } from "ce-storefront";

package/docs/sdks/addresses/README.md

@@ -26,7 +26,7 @@ const ceStorefront = new CeStorefront({
 
 async function run() {
   const result = await ceStorefront.customers.addresses.list({
-    userId: "<value>",
+    userId: "<id>",
   });
 
   // Handle the result
@@ -52,7 +52,7 @@ const ceStorefront = new CeStorefrontCore({
 
 async function run() {
   const res = await customersAddressesList(ceStorefront, {
-    userId: "<value>",
+    userId: "<id>",
   });
 
   if (!res.ok) {
@@ -83,9 +83,9 @@ run();
 
 ### Errors
 
-| Error Type      | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4XX, 5XX        | \*/\*           |
+| Error Type     | Status Code    | Content Type   |
+| -------------- | -------------- | -------------- |
+| errors.CeError | 4XX, 5XX       | \*/\*          |
 
 ## add
 
@@ -102,7 +102,7 @@ const ceStorefront = new CeStorefront({
 
 async function run() {
   const result = await ceStorefront.customers.addresses.add({
-    userId: "<value>",
+    userId: "<id>",
     requestBody: {
       firstName: "Katlynn",
       phone: "895-711-7545 x3085",
@@ -138,7 +138,7 @@ const ceStorefront = new CeStorefrontCore({
 
 async function run() {
   const res = await customersAddressesAdd(ceStorefront, {
-    userId: "<value>",
+    userId: "<id>",
     requestBody: {
       firstName: "Katlynn",
       phone: "895-711-7545 x3085",
@@ -183,7 +183,7 @@ run();
 | ------------------- | ------------------- | ------------------- |
 | errors.BadRequest   | 400                 | application/json    |
 | errors.Unauthorized | 401                 | application/json    |
-| errors.SDKError     | 4XX, 5XX            | \*/\*               |
+| errors.CeError      | 4XX, 5XX            | \*/\*               |
 
 ## get
 
@@ -200,8 +200,8 @@ const ceStorefront = new CeStorefront({
 
 async function run() {
   const result = await ceStorefront.customers.addresses.get({
-    userId: "<value>",
-    addressId: "<value>",
+    userId: "<id>",
+    addressId: "<id>",
   });
 
   // Handle the result
@@ -227,8 +227,8 @@ const ceStorefront = new CeStorefrontCore({
 
 async function run() {
   const res = await customersAddressesGet(ceStorefront, {
-    userId: "<value>",
-    addressId: "<value>",
+    userId: "<id>",
+    addressId: "<id>",
   });
 
   if (!res.ok) {
@@ -263,7 +263,7 @@ run();
 | ------------------- | ------------------- | ------------------- |
 | errors.Unauthorized | 401                 | application/json    |
 | errors.NotFound     | 404                 | application/json    |
-| errors.SDKError     | 4XX, 5XX            | \*/\*               |
+| errors.CeError      | 4XX, 5XX            | \*/\*               |
 
 ## update
 
@@ -280,8 +280,8 @@ const ceStorefront = new CeStorefront({
 
 async function run() {
   const result = await ceStorefront.customers.addresses.update({
-    userId: "<value>",
-    addressId: "<value>",
+    userId: "<id>",
+    addressId: "<id>",
     requestBody: {
       firstName: "Ruthe",
       phone: "(496) 590-8432 x1783",
@@ -317,8 +317,8 @@ const ceStorefront = new CeStorefrontCore({
 
 async function run() {
   const res = await customersAddressesUpdate(ceStorefront, {
-    userId: "<value>",
-    addressId: "<value>",
+    userId: "<id>",
+    addressId: "<id>",
     requestBody: {
       firstName: "Ruthe",
       phone: "(496) 590-8432 x1783",
@@ -364,7 +364,7 @@ run();
 | errors.BadRequest   | 400                 | application/json    |
 | errors.Unauthorized | 401                 | application/json    |
 | errors.NotFound     | 404                 | application/json    |
-| errors.SDKError     | 4XX, 5XX            | \*/\*               |
+| errors.CeError      | 4XX, 5XX            | \*/\*               |
 
 ## delete
 
@@ -381,8 +381,8 @@ const ceStorefront = new CeStorefront({
 
 async function run() {
   const result = await ceStorefront.customers.addresses.delete({
-    userId: "<value>",
-    addressId: "<value>",
+    userId: "<id>",
+    addressId: "<id>",
   });
 
   // Handle the result
@@ -408,8 +408,8 @@ const ceStorefront = new CeStorefrontCore({
 
 async function run() {
   const res = await customersAddressesDelete(ceStorefront, {
-    userId: "<value>",
-    addressId: "<value>",
+    userId: "<id>",
+    addressId: "<id>",
   });
 
   if (!res.ok) {
@@ -444,4 +444,4 @@ run();
 | ------------------- | ------------------- | ------------------- |
 | errors.Unauthorized | 401                 | application/json    |
 | errors.NotFound     | 404                 | application/json    |
-| errors.SDKError     | 4XX, 5XX            | \*/\*               |
+| errors.CeError      | 4XX, 5XX            | \*/\*               |

package/docs/sdks/analytics/README.md

@@ -32,8 +32,8 @@ async function run() {
     },
     properties: {},
     messageId: "<id>",
-    timestamp: new Date("2024-05-20T11:37:56.914Z"),
-    sentAt: new Date("2023-06-07T16:48:30.895Z"),
+    timestamp: new Date("2025-05-20T11:37:56.914Z"),
+    sentAt: new Date("2024-06-06T16:48:30.895Z"),
   });
 
   // Handle the result
@@ -69,8 +69,8 @@ async function run() {
     },
     properties: {},
     messageId: "<id>",
-    timestamp: new Date("2024-05-20T11:37:56.914Z"),
-    sentAt: new Date("2023-06-07T16:48:30.895Z"),
+    timestamp: new Date("2025-05-20T11:37:56.914Z"),
+    sentAt: new Date("2024-06-06T16:48:30.895Z"),
   });
 
   if (!res.ok) {
@@ -101,6 +101,6 @@ run();
 
 ### Errors
 
-| Error Type      | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4XX, 5XX        | \*/\*           |
+| Error Type     | Status Code    | Content Type   |
+| -------------- | -------------- | -------------- |
+| errors.CeError | 4XX, 5XX       | \*/\*          |

package/docs/sdks/auth/README.md

@@ -88,9 +88,9 @@ run();
 
 ### Errors
 
-| Error Type      | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4XX, 5XX        | \*/\*           |
+| Error Type     | Status Code    | Content Type   |
+| -------------- | -------------- | -------------- |
+| errors.CeError | 4XX, 5XX       | \*/\*          |
 
 ## loginWithPhone
 
@@ -164,9 +164,9 @@ run();
 
 ### Errors
 
-| Error Type      | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4XX, 5XX        | \*/\*           |
+| Error Type     | Status Code    | Content Type   |
+| -------------- | -------------- | -------------- |
+| errors.CeError | 4XX, 5XX       | \*/\*          |
 
 ## loginWithEmail
 
@@ -240,9 +240,9 @@ run();
 
 ### Errors
 
-| Error Type      | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4XX, 5XX        | \*/\*           |
+| Error Type     | Status Code    | Content Type   |
+| -------------- | -------------- | -------------- |
+| errors.CeError | 4XX, 5XX       | \*/\*          |
 
 ## loginWithWhatsapp
 
@@ -316,9 +316,9 @@ run();
 
 ### Errors
 
-| Error Type      | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4XX, 5XX        | \*/\*           |
+| Error Type     | Status Code    | Content Type   |
+| -------------- | -------------- | -------------- |
+| errors.CeError | 4XX, 5XX       | \*/\*          |
 
 ## loginWithPassword
 
@@ -392,9 +392,9 @@ run();
 
 ### Errors
 
-| Error Type      | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4XX, 5XX        | \*/\*           |
+| Error Type     | Status Code    | Content Type   |
+| -------------- | -------------- | -------------- |
+| errors.CeError | 4XX, 5XX       | \*/\*          |
 
 ## verifyOtp
 
@@ -472,9 +472,9 @@ run();
 
 ### Errors
 
-| Error Type      | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4XX, 5XX        | \*/\*           |
+| Error Type     | Status Code    | Content Type   |
+| -------------- | -------------- | -------------- |
+| errors.CeError | 4XX, 5XX       | \*/\*          |
 
 ## registerWithPhone
 
@@ -552,9 +552,9 @@ run();
 
 ### Errors
 
-| Error Type      | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4XX, 5XX        | \*/\*           |
+| Error Type     | Status Code    | Content Type   |
+| -------------- | -------------- | -------------- |
+| errors.CeError | 4XX, 5XX       | \*/\*          |
 
 ## registerWithEmail
 
@@ -633,9 +633,9 @@ run();
 
 ### Errors
 
-| Error Type      | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4XX, 5XX        | \*/\*           |
+| Error Type     | Status Code    | Content Type   |
+| -------------- | -------------- | -------------- |
+| errors.CeError | 4XX, 5XX       | \*/\*          |
 
 ## registerWithWhatsapp
 
@@ -715,9 +715,9 @@ run();
 
 ### Errors
 
-| Error Type      | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4XX, 5XX        | \*/\*           |
+| Error Type     | Status Code    | Content Type   |
+| -------------- | -------------- | -------------- |
+| errors.CeError | 4XX, 5XX       | \*/\*          |
 
 ## registerWithPassword
 
@@ -798,9 +798,9 @@ run();
 
 ### Errors
 
-| Error Type      | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4XX, 5XX        | \*/\*           |
+| Error Type     | Status Code    | Content Type   |
+| -------------- | -------------- | -------------- |
+| errors.CeError | 4XX, 5XX       | \*/\*          |
 
 ## refreshToken
 
@@ -870,9 +870,9 @@ run();
 
 ### Errors
 
-| Error Type      | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4XX, 5XX        | \*/\*           |
+| Error Type     | Status Code    | Content Type   |
+| -------------- | -------------- | -------------- |
+| errors.CeError | 4XX, 5XX       | \*/\*          |
 
 ## generateOtp
 
@@ -946,9 +946,9 @@ run();
 
 ### Errors
 
-| Error Type      | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4XX, 5XX        | \*/\*           |
+| Error Type     | Status Code    | Content Type   |
+| -------------- | -------------- | -------------- |
+| errors.CeError | 4XX, 5XX       | \*/\*          |
 
 ## verifyEmailPhone
 
@@ -1018,6 +1018,6 @@ run();
 
 ### Errors
 
-| Error Type      | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4XX, 5XX        | \*/\*           |
+| Error Type     | Status Code    | Content Type   |
+| -------------- | -------------- | -------------- |
+| errors.CeError | 4XX, 5XX       | \*/\*          |

package/docs/sdks/carts/README.md

@@ -78,9 +78,9 @@ run();
 
 ### Errors
 
-| Error Type      | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4XX, 5XX        | \*/\*           |
+| Error Type     | Status Code    | Content Type   |
+| -------------- | -------------- | -------------- |
+| errors.CeError | 4XX, 5XX       | \*/\*          |
 
 ## get
 
@@ -97,7 +97,7 @@ const ceStorefront = new CeStorefront({
 
 async function run() {
   const result = await ceStorefront.carts.get({
-    userId: "<value>",
+    userId: "<id>",
   });
 
   // Handle the result
@@ -123,7 +123,7 @@ const ceStorefront = new CeStorefrontCore({
 
 async function run() {
   const res = await cartsGet(ceStorefront, {
-    userId: "<value>",
+    userId: "<id>",
   });
 
   if (!res.ok) {
@@ -158,7 +158,7 @@ run();
 | ------------------- | ------------------- | ------------------- |
 | errors.Unauthorized | 401                 | application/json    |
 | errors.NotFound     | 404                 | application/json    |
-| errors.SDKError     | 4XX, 5XX            | \*/\*               |
+| errors.CeError      | 4XX, 5XX            | \*/\*               |
 
 ## delete
 
@@ -175,7 +175,7 @@ const ceStorefront = new CeStorefront({
 
 async function run() {
   const result = await ceStorefront.carts.delete({
-    userId: "<value>",
+    userId: "<id>",
   });
 
   // Handle the result
@@ -201,7 +201,7 @@ const ceStorefront = new CeStorefrontCore({
 
 async function run() {
   const res = await cartsDelete(ceStorefront, {
-    userId: "<value>",
+    userId: "<id>",
   });
 
   if (!res.ok) {
@@ -236,7 +236,7 @@ run();
 | ------------------- | ------------------- | ------------------- |
 | errors.Unauthorized | 401                 | application/json    |
 | errors.NotFound     | 404                 | application/json    |
-| errors.SDKError     | 4XX, 5XX            | \*/\*               |
+| errors.CeError      | 4XX, 5XX            | \*/\*               |
 
 ## addItem
 
@@ -258,6 +258,7 @@ async function run() {
       productId: "<id>",
       sku: "<value>",
       quantity: 587352,
+      onSubscription: false,
     },
   });
 
@@ -289,6 +290,7 @@ async function run() {
       productId: "<id>",
       sku: "<value>",
       quantity: 587352,
+      onSubscription: false,
     },
   });
 
@@ -325,4 +327,4 @@ run();
 | errors.BadRequest   | 400                 | application/json    |
 | errors.Unauthorized | 401                 | application/json    |
 | errors.NotFound     | 404                 | application/json    |
-| errors.SDKError     | 4XX, 5XX            | \*/\*               |
+| errors.CeError      | 4XX, 5XX            | \*/\*               |

package/docs/sdks/categories/README.md

@@ -23,6 +23,7 @@ const ceStorefront = new CeStorefront({
 async function run() {
   const result = await ceStorefront.catalog.categories.list({
     parentCategoryId: "a847641353e947d3bed69a4eea975634",
+    nestedLevel: 0,
     sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
   });
 
@@ -50,6 +51,7 @@ const ceStorefront = new CeStorefrontCore({
 async function run() {
   const res = await catalogCategoriesList(ceStorefront, {
     parentCategoryId: "a847641353e947d3bed69a4eea975634",
+    nestedLevel: 0,
     sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
   });
 
@@ -81,6 +83,6 @@ run();
 
 ### Errors
 
-| Error Type      | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4XX, 5XX        | \*/\*           |
+| Error Type     | Status Code    | Content Type   |
+| -------------- | -------------- | -------------- |
+| errors.CeError | 4XX, 5XX       | \*/\*          |

package/docs/sdks/cestorefrontpayments/README.md

@@ -83,4 +83,4 @@ run();
 | ------------------- | ------------------- | ------------------- |
 | errors.Unauthorized | 401                 | application/json    |
 | errors.NotFound     | 404                 | application/json    |
-| errors.SDKError     | 4XX, 5XX            | \*/\*               |
+| errors.CeError      | 4XX, 5XX            | \*/\*               |

package/docs/sdks/cestorefrontreviews/README.md

@@ -23,7 +23,7 @@ const ceStorefront = new CeStorefront({
 
 async function run() {
   const result = await ceStorefront.catalog.products.reviews.list({
-    productId: "<value>",
+    productId: "<id>",
     sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
   });
 
@@ -50,7 +50,7 @@ const ceStorefront = new CeStorefrontCore({
 
 async function run() {
   const res = await catalogProductsReviewsList(ceStorefront, {
-    productId: "<value>",
+    productId: "<id>",
     sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
   });
 
@@ -86,7 +86,7 @@ run();
 | ------------------- | ------------------- | ------------------- |
 | errors.Unauthorized | 401                 | application/json    |
 | errors.NotFound     | 404                 | application/json    |
-| errors.SDKError     | 4XX, 5XX            | \*/\*               |
+| errors.CeError      | 4XX, 5XX            | \*/\*               |
 
 ## create
 
@@ -103,7 +103,7 @@ const ceStorefront = new CeStorefront({
 
 async function run() {
   const result = await ceStorefront.catalog.products.reviews.create({
-    productId: "<value>",
+    productId: "<id>",
     createReview: {
       orderNumber: "<value>",
       rating: 4865.89,
@@ -134,7 +134,7 @@ const ceStorefront = new CeStorefrontCore({
 
 async function run() {
   const res = await catalogProductsReviewsCreate(ceStorefront, {
-    productId: "<value>",
+    productId: "<id>",
     createReview: {
       orderNumber: "<value>",
       rating: 4865.89,
@@ -175,4 +175,4 @@ run();
 | errors.BadRequest   | 400                 | application/json    |
 | errors.Unauthorized | 401                 | application/json    |
 | errors.NotFound     | 404                 | application/json    |
-| errors.SDKError     | 4XX, 5XX            | \*/\*               |
+| errors.CeError      | 4XX, 5XX            | \*/\*               |