ce-storefront 0.3.10 → 0.3.17

package/docs/sdks/payments/README.md

@@ -8,10 +8,9 @@ Payments
 ### Available Operations
 
 * [generateHash](#generatehash) - Generate hash
-* [getMethods](#getmethods) - List all payment methods
-* [getPaymentsCards](#getpaymentscards) - List all saved cards
-* [postPaymentsCards](#postpaymentscards) - Add card
-* [getPaymentsVerifyVpa](#getpaymentsverifyvpa) - Verify VPA
+* [listMethods](#listmethods) - List all payment methods
+* [addCard](#addcard) - Add card
+* [verifyVpa](#verifyvpa) - Verify VPA
 
 ## generateHash
 
@@ -94,7 +93,7 @@ run();
 | errors.NotFound     | 404                 | application/json    |
 | errors.CeError      | 4XX, 5XX            | \*/\*               |
 
-## getMethods
+## listMethods
 
 List all payment methods
 
@@ -108,7 +107,7 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.payments.getMethods({
+  const result = await ceStorefront.payments.listMethods({
     paymentGateway: "JUSPAY",
   });
 
@@ -125,7 +124,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CeStorefrontCore } from "ce-storefront/core.js";
-import { paymentsGetMethods } from "ce-storefront/funcs/paymentsGetMethods.js";
+import { paymentsListMethods } from "ce-storefront/funcs/paymentsListMethods.js";
 
 // Use `CeStorefrontCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -134,7 +133,7 @@ const ceStorefront = new CeStorefrontCore({
 });
 
 async function run() {
-  const res = await paymentsGetMethods(ceStorefront, {
+  const res = await paymentsListMethods(ceStorefront, {
     paymentGateway: "JUSPAY",
   });
 
@@ -170,86 +169,7 @@ run();
 | -------------- | -------------- | -------------- |
 | errors.CeError | 4XX, 5XX       | \*/\*          |
 
-## getPaymentsCards
-
-List all saved cards.
-
-### Example Usage
-
-```typescript
-import { CeStorefront } from "ce-storefront";
-
-const ceStorefront = new CeStorefront({
-  authorization: "<YOUR_BEARER_TOKEN_HERE>",
-});
-
-async function run() {
-  const result = await ceStorefront.payments.getPaymentsCards({
-    paymentGateway: "JUSPAY",
-  });
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CeStorefrontCore } from "ce-storefront/core.js";
-import { paymentsGetPaymentsCards } from "ce-storefront/funcs/paymentsGetPaymentsCards.js";
-
-// Use `CeStorefrontCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const ceStorefront = new CeStorefrontCore({
-  authorization: "<YOUR_BEARER_TOKEN_HERE>",
-});
-
-async function run() {
-  const res = await paymentsGetPaymentsCards(ceStorefront, {
-    paymentGateway: "JUSPAY",
-  });
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.GetPaymentsCardsRequest](../../models/operations/getpaymentscardsrequest.md)                                                                                       | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[operations.GetPaymentsCardsResponseBody](../../models/operations/getpaymentscardsresponsebody.md)\>**
-
-### Errors
-
-| Error Type          | Status Code         | Content Type        |
-| ------------------- | ------------------- | ------------------- |
-| errors.BadRequest   | 400                 | application/json    |
-| errors.Unauthorized | 401                 | application/json    |
-| errors.NotFound     | 404                 | application/json    |
-| errors.CeError      | 4XX, 5XX            | \*/\*               |
-
-## postPaymentsCards
+## addCard
 
 Add a new card
 
@@ -263,7 +183,7 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.payments.postPaymentsCards({
+  const result = await ceStorefront.payments.addCard({
     cardDetails: {},
   });
 
@@ -280,7 +200,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CeStorefrontCore } from "ce-storefront/core.js";
-import { paymentsPostPaymentsCards } from "ce-storefront/funcs/paymentsPostPaymentsCards.js";
+import { paymentsAddCard } from "ce-storefront/funcs/paymentsAddCard.js";
 
 // Use `CeStorefrontCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -289,7 +209,7 @@ const ceStorefront = new CeStorefrontCore({
 });
 
 async function run() {
-  const res = await paymentsPostPaymentsCards(ceStorefront, {
+  const res = await paymentsAddCard(ceStorefront, {
     cardDetails: {},
   });
 
@@ -328,7 +248,7 @@ run();
 | errors.NotFound     | 404                 | application/json    |
 | errors.CeError      | 4XX, 5XX            | \*/\*               |
 
-## getPaymentsVerifyVpa
+## verifyVpa
 
 The Virtual Payment Address or VPA is a unique ID given to an individual using the Unified Payment Interface (UPI) service to send or receive money. In the case of UPI collect VPA is the mandatory param and merchants are always advised to check if the VPA is valid or not.
 Validating the VPA will help in reducing the failure rate due to incorrect vpa. 
@@ -343,7 +263,7 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.payments.getPaymentsVerifyVpa({
+  const result = await ceStorefront.payments.verifyVpa({
     paymentGateway: "JUSPAY",
   });
 
@@ -360,7 +280,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CeStorefrontCore } from "ce-storefront/core.js";
-import { paymentsGetPaymentsVerifyVpa } from "ce-storefront/funcs/paymentsGetPaymentsVerifyVpa.js";
+import { paymentsVerifyVpa } from "ce-storefront/funcs/paymentsVerifyVpa.js";
 
 // Use `CeStorefrontCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -369,7 +289,7 @@ const ceStorefront = new CeStorefrontCore({
 });
 
 async function run() {
-  const res = await paymentsGetPaymentsVerifyVpa(ceStorefront, {
+  const res = await paymentsVerifyVpa(ceStorefront, {
     paymentGateway: "JUSPAY",
   });
 

package/docs/sdks/products/README.md

@@ -1,15 +1,14 @@
 # Products
-(*catalog.products*)
+(*products*)
 
 ## Overview
 
 ### Available Operations
 
 * [list](#list) - List all products
-* [get](#get) - Retrieve a product detail
 * [getSimilar](#getsimilar) - Retrieve similar products
 * [getUpsells](#getupsells) - Retrieve up-sell products
-* [getCrossSells](#getcrosssells) - Retrieve cross-sell products
+* [listCrossSells](#listcrosssells) - Retrieve cross-sell products
 
 ## list
 
@@ -25,7 +24,7 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.catalog.products.list({
+  const result = await ceStorefront.products.list({
     sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
   });
 
@@ -42,7 +41,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CeStorefrontCore } from "ce-storefront/core.js";
-import { catalogProductsList } from "ce-storefront/funcs/catalogProductsList.js";
+import { productsList } from "ce-storefront/funcs/productsList.js";
 
 // Use `CeStorefrontCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -51,7 +50,7 @@ const ceStorefront = new CeStorefrontCore({
 });
 
 async function run() {
-  const res = await catalogProductsList(ceStorefront, {
+  const res = await productsList(ceStorefront, {
     sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
   });
 
@@ -89,84 +88,6 @@ run();
 | errors.NotFound     | 404                 | application/json    |
 | errors.CeError      | 4XX, 5XX            | \*/\*               |
 
-## get
-
-Retrieves the details of an existing product. Supply the unique product ID from either a product creation request or the product list, and Commerce Engine will return the corresponding product information.
-
-### Example Usage
-
-```typescript
-import { CeStorefront } from "ce-storefront";
-
-const ceStorefront = new CeStorefront({
-  authorization: "<YOUR_BEARER_TOKEN_HERE>",
-});
-
-async function run() {
-  const result = await ceStorefront.catalog.products.get({
-    productId: "41",
-  });
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CeStorefrontCore } from "ce-storefront/core.js";
-import { catalogProductsGet } from "ce-storefront/funcs/catalogProductsGet.js";
-
-// Use `CeStorefrontCore` for best tree-shaking performance.
-// You can create one instance of it to use across an application.
-const ceStorefront = new CeStorefrontCore({
-  authorization: "<YOUR_BEARER_TOKEN_HERE>",
-});
-
-async function run() {
-  const res = await catalogProductsGet(ceStorefront, {
-    productId: "41",
-  });
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.GetProductDetailsRequest](../../models/operations/getproductdetailsrequest.md)                                                                                     | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[operations.GetProductDetailsResponseBody](../../models/operations/getproductdetailsresponsebody.md)\>**
-
-### Errors
-
-| Error Type          | Status Code         | Content Type        |
-| ------------------- | ------------------- | ------------------- |
-| errors.Unauthorized | 401                 | application/json    |
-| errors.NotFound     | 404                 | application/json    |
-| errors.CeError      | 4XX, 5XX            | \*/\*               |
-
 ## getSimilar
 
 Retrieves a list of products similar to a specified product based on their attributes and category. The similar products are returned sorted by relevance, with the most closely matching products appearing first. Useful for providing product recommendations to your customers.
@@ -181,7 +102,7 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.catalog.products.getSimilar({});
+  const result = await ceStorefront.products.getSimilar({});
 
   // Handle the result
   console.log(result);
@@ -196,7 +117,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CeStorefrontCore } from "ce-storefront/core.js";
-import { catalogProductsGetSimilar } from "ce-storefront/funcs/catalogProductsGetSimilar.js";
+import { productsGetSimilar } from "ce-storefront/funcs/productsGetSimilar.js";
 
 // Use `CeStorefrontCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -205,7 +126,7 @@ const ceStorefront = new CeStorefrontCore({
 });
 
 async function run() {
-  const res = await catalogProductsGetSimilar(ceStorefront, {});
+  const res = await productsGetSimilar(ceStorefront, {});
 
   if (!res.ok) {
     throw res.error;
@@ -255,7 +176,7 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.catalog.products.getUpsells({});
+  const result = await ceStorefront.products.getUpsells({});
 
   // Handle the result
   console.log(result);
@@ -270,7 +191,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CeStorefrontCore } from "ce-storefront/core.js";
-import { catalogProductsGetUpsells } from "ce-storefront/funcs/catalogProductsGetUpsells.js";
+import { productsGetUpsells } from "ce-storefront/funcs/productsGetUpsells.js";
 
 // Use `CeStorefrontCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -279,7 +200,7 @@ const ceStorefront = new CeStorefrontCore({
 });
 
 async function run() {
-  const res = await catalogProductsGetUpsells(ceStorefront, {});
+  const res = await productsGetUpsells(ceStorefront, {});
 
   if (!res.ok) {
     throw res.error;
@@ -315,7 +236,7 @@ run();
 | errors.NotFound     | 404                 | application/json    |
 | errors.CeError      | 4XX, 5XX            | \*/\*               |
 
-## getCrossSells
+## listCrossSells
 
 Retrieves a list of products specified for cross selling. The cross-sell products are returned based on product ids specified in request param.
 
@@ -329,7 +250,7 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.catalog.products.getCrossSells({});
+  const result = await ceStorefront.products.listCrossSells({});
 
   // Handle the result
   console.log(result);
@@ -344,7 +265,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CeStorefrontCore } from "ce-storefront/core.js";
-import { catalogProductsGetCrossSells } from "ce-storefront/funcs/catalogProductsGetCrossSells.js";
+import { productsListCrossSells } from "ce-storefront/funcs/productsListCrossSells.js";
 
 // Use `CeStorefrontCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -353,7 +274,7 @@ const ceStorefront = new CeStorefrontCore({
 });
 
 async function run() {
-  const res = await catalogProductsGetCrossSells(ceStorefront, {});
+  const res = await productsListCrossSells(ceStorefront, {});
 
   if (!res.ok) {
     throw res.error;

package/docs/sdks/reviews/README.md

@@ -1,15 +1,15 @@
 # Reviews
-(*customers.reviews*)
+(*catalog.products.reviews*)
 
 ## Overview
 
 ### Available Operations
 
-* [list](#list) - Retrieve all reviews
+* [list](#list) - List all product reviews
 
 ## list
 
-Retrieve all reviews
+List of reviews for a specified product. The reviews are returned sorted by submission date, with the most recent reviews appearing first. You can filter the reviews by rating, reviewer, or date for more detailed analysis.
 
 ### Example Usage
 
@@ -21,8 +21,9 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.customers.reviews.list({
-    userId: "<id>",
+  const result = await ceStorefront.catalog.products.reviews.list({
+    productId: "<id>",
+    sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
   });
 
   // Handle the result
@@ -38,7 +39,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CeStorefrontCore } from "ce-storefront/core.js";
-import { customersReviewsList } from "ce-storefront/funcs/customersReviewsList.js";
+import { catalogProductsReviewsList } from "ce-storefront/funcs/catalogProductsReviewsList.js";
 
 // Use `CeStorefrontCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -47,8 +48,9 @@ const ceStorefront = new CeStorefrontCore({
 });
 
 async function run() {
-  const res = await customersReviewsList(ceStorefront, {
-    userId: "<id>",
+  const res = await catalogProductsReviewsList(ceStorefront, {
+    productId: "<id>",
+    sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
   });
 
   if (!res.ok) {
@@ -68,17 +70,19 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.GetCustomersUserIdReviewsRequest](../../models/operations/getcustomersuseridreviewsrequest.md)                                                                     | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.GetProductsIdReviewsRequest](../../models/operations/getproductsidreviewsrequest.md)                                                                               | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
 | `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
 | `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
 | `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
 
 ### Response
 
-**Promise\<[operations.GetCustomersUserIdReviewsResponseBody](../../models/operations/getcustomersuseridreviewsresponsebody.md)\>**
+**Promise\<[operations.GetProductsIdReviewsResponseBody](../../models/operations/getproductsidreviewsresponsebody.md)\>**
 
 ### Errors
 
-| Error Type     | Status Code    | Content Type   |
-| -------------- | -------------- | -------------- |
-| errors.CeError | 4XX, 5XX       | \*/\*          |
+| Error Type          | Status Code         | Content Type        |
+| ------------------- | ------------------- | ------------------- |
+| errors.Unauthorized | 401                 | application/json    |
+| errors.NotFound     | 404                 | application/json    |
+| errors.CeError      | 4XX, 5XX            | \*/\*               |

package/docs/sdks/{shipping → shipment}/README.md

@@ -1,5 +1,5 @@
-# Shipping
-(*shipping*)
+# Shipment
+(*shipment*)
 
 ## Overview
 
@@ -21,7 +21,7 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.shipping.checkPincodeServiceability({
+  const result = await ceStorefront.shipment.checkPincodeServiceability({
     pincode: "144552",
   });
 
@@ -38,7 +38,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CeStorefrontCore } from "ce-storefront/core.js";
-import { shippingCheckPincodeServiceability } from "ce-storefront/funcs/shippingCheckPincodeServiceability.js";
+import { shipmentCheckPincodeServiceability } from "ce-storefront/funcs/shipmentCheckPincodeServiceability.js";
 
 // Use `CeStorefrontCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -47,7 +47,7 @@ const ceStorefront = new CeStorefrontCore({
 });
 
 async function run() {
-  const res = await shippingCheckPincodeServiceability(ceStorefront, {
+  const res = await shipmentCheckPincodeServiceability(ceStorefront, {
     pincode: "144552",
   });