ce-storefront 0.3.17 → 0.4.0

package/docs/sdks/products/README.md

@@ -1,14 +1,15 @@
 # Products
-(*products*)
+(*catalog.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
-* [listCrossSells](#listcrosssells) - Retrieve cross-sell products
+* [getCrossSells](#getcrosssells) - Retrieve cross-sell products
 
 ## list
 
@@ -24,7 +25,7 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.products.list({
+  const result = await ceStorefront.catalog.products.list({
     sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
   });
 
@@ -41,7 +42,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CeStorefrontCore } from "ce-storefront/core.js";
-import { productsList } from "ce-storefront/funcs/productsList.js";
+import { catalogProductsList } from "ce-storefront/funcs/catalogProductsList.js";
 
 // Use `CeStorefrontCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -50,7 +51,7 @@ const ceStorefront = new CeStorefrontCore({
 });
 
 async function run() {
-  const res = await productsList(ceStorefront, {
+  const res = await catalogProductsList(ceStorefront, {
     sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
   });
 
@@ -88,6 +89,84 @@ 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.
@@ -102,7 +181,7 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.products.getSimilar({});
+  const result = await ceStorefront.catalog.products.getSimilar({});
 
   // Handle the result
   console.log(result);
@@ -117,7 +196,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CeStorefrontCore } from "ce-storefront/core.js";
-import { productsGetSimilar } from "ce-storefront/funcs/productsGetSimilar.js";
+import { catalogProductsGetSimilar } from "ce-storefront/funcs/catalogProductsGetSimilar.js";
 
 // Use `CeStorefrontCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -126,7 +205,7 @@ const ceStorefront = new CeStorefrontCore({
 });
 
 async function run() {
-  const res = await productsGetSimilar(ceStorefront, {});
+  const res = await catalogProductsGetSimilar(ceStorefront, {});
 
   if (!res.ok) {
     throw res.error;
@@ -176,7 +255,7 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.products.getUpsells({});
+  const result = await ceStorefront.catalog.products.getUpsells({});
 
   // Handle the result
   console.log(result);
@@ -191,7 +270,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CeStorefrontCore } from "ce-storefront/core.js";
-import { productsGetUpsells } from "ce-storefront/funcs/productsGetUpsells.js";
+import { catalogProductsGetUpsells } from "ce-storefront/funcs/catalogProductsGetUpsells.js";
 
 // Use `CeStorefrontCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -200,7 +279,7 @@ const ceStorefront = new CeStorefrontCore({
 });
 
 async function run() {
-  const res = await productsGetUpsells(ceStorefront, {});
+  const res = await catalogProductsGetUpsells(ceStorefront, {});
 
   if (!res.ok) {
     throw res.error;
@@ -236,7 +315,7 @@ run();
 | errors.NotFound     | 404                 | application/json    |
 | errors.CeError      | 4XX, 5XX            | \*/\*               |
 
-## listCrossSells
+## getCrossSells
 
 Retrieves a list of products specified for cross selling. The cross-sell products are returned based on product ids specified in request param.
 
@@ -250,7 +329,7 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.products.listCrossSells({});
+  const result = await ceStorefront.catalog.products.getCrossSells({});
 
   // Handle the result
   console.log(result);
@@ -265,7 +344,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CeStorefrontCore } from "ce-storefront/core.js";
-import { productsListCrossSells } from "ce-storefront/funcs/productsListCrossSells.js";
+import { catalogProductsGetCrossSells } from "ce-storefront/funcs/catalogProductsGetCrossSells.js";
 
 // Use `CeStorefrontCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -274,7 +353,7 @@ const ceStorefront = new CeStorefrontCore({
 });
 
 async function run() {
-  const res = await productsListCrossSells(ceStorefront, {});
+  const res = await catalogProductsGetCrossSells(ceStorefront, {});
 
   if (!res.ok) {
     throw res.error;

package/docs/sdks/{cards → refunds}/README.md

@@ -1,15 +1,15 @@
-# Cards
-(*payments.cards*)
+# Refunds
+(*orders.refunds*)
 
 ## Overview
 
 ### Available Operations
 
-* [list](#list) - List all saved cards
+* [list](#list) - Retrieve order refunds
 
 ## list
 
-List all saved cards.
+Retrieve order refunds
 
 ### Example Usage
 
@@ -21,8 +21,8 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.payments.cards.list({
-    paymentGateway: "JUSPAY",
+  const result = await ceStorefront.orders.refunds.list({
+    orderNumber: "<value>",
   });
 
   // Handle the result
@@ -38,7 +38,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CeStorefrontCore } from "ce-storefront/core.js";
-import { paymentsCardsList } from "ce-storefront/funcs/paymentsCardsList.js";
+import { ordersRefundsList } from "ce-storefront/funcs/ordersRefundsList.js";
 
 // Use `CeStorefrontCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -47,8 +47,8 @@ const ceStorefront = new CeStorefrontCore({
 });
 
 async function run() {
-  const res = await paymentsCardsList(ceStorefront, {
-    paymentGateway: "JUSPAY",
+  const res = await ordersRefundsList(ceStorefront, {
+    orderNumber: "<value>",
   });
 
   if (!res.ok) {
@@ -68,20 +68,19 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.GetPaymentsCardsRequest](../../models/operations/getpaymentscardsrequest.md)                                                                                       | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.GetOrdersIdRefundsRequest](../../models/operations/getordersidrefundsrequest.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)\>**
+**Promise\<[operations.GetOrdersIdRefundsResponseBody](../../models/operations/getordersidrefundsresponsebody.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            | \*/\*               |

package/docs/sdks/reviews/README.md

@@ -1,15 +1,15 @@
 # Reviews
-(*catalog.products.reviews*)
+(*customers.reviews*)
 
 ## Overview
 
 ### Available Operations
 
-* [list](#list) - List all product reviews
+* [list](#list) - Retrieve all reviews
 
 ## list
 
-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.
+Retrieve all reviews
 
 ### Example Usage
 
@@ -21,9 +21,8 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.catalog.products.reviews.list({
-    productId: "<id>",
-    sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
+  const result = await ceStorefront.customers.reviews.list({
+    userId: "<id>",
   });
 
   // Handle the result
@@ -39,7 +38,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CeStorefrontCore } from "ce-storefront/core.js";
-import { catalogProductsReviewsList } from "ce-storefront/funcs/catalogProductsReviewsList.js";
+import { customersReviewsList } from "ce-storefront/funcs/customersReviewsList.js";
 
 // Use `CeStorefrontCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -48,9 +47,8 @@ const ceStorefront = new CeStorefrontCore({
 });
 
 async function run() {
-  const res = await catalogProductsReviewsList(ceStorefront, {
-    productId: "<id>",
-    sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
+  const res = await customersReviewsList(ceStorefront, {
+    userId: "<id>",
   });
 
   if (!res.ok) {
@@ -70,19 +68,17 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.GetProductsIdReviewsRequest](../../models/operations/getproductsidreviewsrequest.md)                                                                               | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.GetCustomersUserIdReviewsRequest](../../models/operations/getcustomersuseridreviewsrequest.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.GetProductsIdReviewsResponseBody](../../models/operations/getproductsidreviewsresponsebody.md)\>**
+**Promise\<[operations.GetCustomersUserIdReviewsResponseBody](../../models/operations/getcustomersuseridreviewsresponsebody.md)\>**
 
 ### Errors
 
-| Error Type          | Status Code         | Content Type        |
-| ------------------- | ------------------- | ------------------- |
-| errors.Unauthorized | 401                 | application/json    |
-| errors.NotFound     | 404                 | application/json    |
-| errors.CeError      | 4XX, 5XX            | \*/\*               |
+| Error Type     | Status Code    | Content Type   |
+| -------------- | -------------- | -------------- |
+| errors.CeError | 4XX, 5XX       | \*/\*          |

package/docs/sdks/{catalogproducts → shipments}/README.md

@@ -1,15 +1,15 @@
-# CatalogProducts
-(*catalogProducts*)
+# Shipments
+(*orders.shipments*)
 
 ## Overview
 
 ### Available Operations
 
-* [get](#get) - Retrieve a product detail
+* [list](#list) - Retrieve order shipments
 
-## get
+## list
 
-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.
+Retrieve order shipments
 
 ### Example Usage
 
@@ -21,8 +21,8 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.catalogProducts.get({
-    productId: "41",
+  const result = await ceStorefront.orders.shipments.list({
+    orderNumber: "<value>",
   });
 
   // Handle the result
@@ -38,7 +38,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CeStorefrontCore } from "ce-storefront/core.js";
-import { catalogProductsGet } from "ce-storefront/funcs/catalogProductsGet.js";
+import { ordersShipmentsList } from "ce-storefront/funcs/ordersShipmentsList.js";
 
 // Use `CeStorefrontCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -47,8 +47,8 @@ const ceStorefront = new CeStorefrontCore({
 });
 
 async function run() {
-  const res = await catalogProductsGet(ceStorefront, {
-    productId: "41",
+  const res = await ordersShipmentsList(ceStorefront, {
+    orderNumber: "<value>",
   });
 
   if (!res.ok) {
@@ -68,14 +68,14 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.GetProductDetailsRequest](../../models/operations/getproductdetailsrequest.md)                                                                                     | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.GetOrdersIdShipmentsRequest](../../models/operations/getordersidshipmentsrequest.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)\>**
+**Promise\<[operations.GetOrdersIdShipmentsResponseBody](../../models/operations/getordersidshipmentsresponsebody.md)\>**
 
 ### Errors
 

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

@@ -1,5 +1,5 @@
-# Shipment
-(*shipment*)
+# Shipping
+(*shipping*)
 
 ## Overview
 
@@ -21,7 +21,7 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.shipment.checkPincodeServiceability({
+  const result = await ceStorefront.shipping.checkPincodeServiceability({
     pincode: "144552",
   });
 
@@ -38,7 +38,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CeStorefrontCore } from "ce-storefront/core.js";
-import { shipmentCheckPincodeServiceability } from "ce-storefront/funcs/shipmentCheckPincodeServiceability.js";
+import { shippingCheckPincodeServiceability } from "ce-storefront/funcs/shippingCheckPincodeServiceability.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 shipmentCheckPincodeServiceability(ceStorefront, {
+  const res = await shippingCheckPincodeServiceability(ceStorefront, {
     pincode: "144552",
   });
 

package/docs/sdks/{catalogskus → skus}/README.md

@@ -1,5 +1,5 @@
-# CatalogSkus
-(*catalogSkus*)
+# Skus
+(*catalog.skus*)
 
 ## Overview
 
@@ -21,7 +21,7 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.catalogSkus.list({
+  const result = await ceStorefront.catalog.skus.list({
     sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
   });