ce-storefront 0.3.11 → 0.3.17

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

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

package/docs/sdks/catalogproductreviews/README.md

@@ -0,0 +1,97 @@
+# CatalogProductReviews
+(*catalogProductReviews*)
+
+## Overview
+
+### Available Operations
+
+* [create](#create) - Create product review
+
+## create
+
+Create a product review
+
+### Example Usage
+
+```typescript
+import { CeStorefront } from "ce-storefront";
+
+const ceStorefront = new CeStorefront({
+  authorization: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+  const result = await ceStorefront.catalogProductReviews.create({
+    productId: "<id>",
+    createReview: {
+      orderNumber: "<value>",
+      rating: 4865.89,
+      userId: "<id>",
+    },
+  });
+
+  // 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 { catalogProductReviewsCreate } from "ce-storefront/funcs/catalogProductReviewsCreate.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 catalogProductReviewsCreate(ceStorefront, {
+    productId: "<id>",
+    createReview: {
+      orderNumber: "<value>",
+      rating: 4865.89,
+      userId: "<id>",
+    },
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.PostProductsIdReviewsRequest](../../models/operations/postproductsidreviewsrequest.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.PostProductsIdReviewsResponseBody](../../models/operations/postproductsidreviewsresponsebody.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/{shipments → catalogproducts}/README.md

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

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

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

package/docs/sdks/{cestorefrontreviews → cestorefrontaddresses}/README.md

@@ -1,16 +1,17 @@
-# CeStorefrontReviews
-(*catalog.products.reviews*)
+# CeStorefrontAddresses
+(*customers.addresses*)
 
 ## Overview
 
 ### Available Operations
 
-* [list](#list) - List all product reviews
-* [create](#create) - Create product review
+* [list](#list) - Retrieve all addresses
+* [update](#update) - Update particular address
+* [delete](#delete) - Remove particular address
 
 ## 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 billing and shipping address of particular customer
 
 ### Example Usage
 
@@ -22,9 +23,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.addresses.list({
+    userId: "<id>",
   });
 
   // Handle the result
@@ -40,7 +40,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 { customersAddressesList } from "ce-storefront/funcs/customersAddressesList.js";
 
 // Use `CeStorefrontCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -49,9 +49,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 customersAddressesList(ceStorefront, {
+    userId: "<id>",
   });
 
   if (!res.ok) {
@@ -71,26 +70,125 @@ 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.GetAddressRequest](../../models/operations/getaddressrequest.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.GetAddressResponseBody](../../models/operations/getaddressresponsebody.md)\>**
+
+### Errors
+
+| Error Type     | Status Code    | Content Type   |
+| -------------- | -------------- | -------------- |
+| errors.CeError | 4XX, 5XX       | \*/\*          |
+
+## update
+
+Update address
+
+### Example Usage
+
+```typescript
+import { CeStorefront } from "ce-storefront";
+
+const ceStorefront = new CeStorefront({
+  authorization: "<YOUR_BEARER_TOKEN_HERE>",
+});
+
+async function run() {
+  const result = await ceStorefront.customers.addresses.update({
+    userId: "<id>",
+    addressId: "<id>",
+    requestBody: {
+      firstName: "Ruthe",
+      phone: "(496) 590-8432 x1783",
+      email: "Olen75@yahoo.com",
+      addressLine1: "5123 The Square",
+      pincode: "<value>",
+      city: "Port St. Lucie",
+      state: "Montana",
+      country: "India",
+    },
+  });
+
+  // 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 { customersAddressesUpdate } from "ce-storefront/funcs/customersAddressesUpdate.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 customersAddressesUpdate(ceStorefront, {
+    userId: "<id>",
+    addressId: "<id>",
+    requestBody: {
+      firstName: "Ruthe",
+      phone: "(496) 590-8432 x1783",
+      email: "Olen75@yahoo.com",
+      addressLine1: "5123 The Square",
+      pincode: "<value>",
+      city: "Port St. Lucie",
+      state: "Montana",
+      country: "India",
+    },
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.PutCustomerAddressIdRequest](../../models/operations/putcustomeraddressidrequest.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.PutCustomerAddressIdResponseBody](../../models/operations/putcustomeraddressidresponsebody.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            | \*/\*               |
 
-## create
+## delete
 
-Create a product review
+Delete address
 
 ### Example Usage
 
@@ -102,13 +200,9 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.catalog.products.reviews.create({
-    productId: "<id>",
-    createReview: {
-      orderNumber: "<value>",
-      rating: 4865.89,
-      userId: "<id>",
-    },
+  const result = await ceStorefront.customers.addresses.delete({
+    userId: "<id>",
+    addressId: "<id>",
   });
 
   // Handle the result
@@ -124,7 +218,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CeStorefrontCore } from "ce-storefront/core.js";
-import { catalogProductsReviewsCreate } from "ce-storefront/funcs/catalogProductsReviewsCreate.js";
+import { customersAddressesDelete } from "ce-storefront/funcs/customersAddressesDelete.js";
 
 // Use `CeStorefrontCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -133,13 +227,9 @@ const ceStorefront = new CeStorefrontCore({
 });
 
 async function run() {
-  const res = await catalogProductsReviewsCreate(ceStorefront, {
-    productId: "<id>",
-    createReview: {
-      orderNumber: "<value>",
-      rating: 4865.89,
-      userId: "<id>",
-    },
+  const res = await customersAddressesDelete(ceStorefront, {
+    userId: "<id>",
+    addressId: "<id>",
   });
 
   if (!res.ok) {
@@ -159,20 +249,19 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.PostProductsIdReviewsRequest](../../models/operations/postproductsidreviewsrequest.md)                                                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.DeleteCustomerAddressIdRequest](../../models/operations/deletecustomeraddressidrequest.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.PostProductsIdReviewsResponseBody](../../models/operations/postproductsidreviewsresponsebody.md)\>**
+**Promise\<[operations.DeleteCustomerAddressIdResponseBody](../../models/operations/deletecustomeraddressidresponsebody.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/cestorefrontproducts/README.md

@@ -0,0 +1,6 @@
+# CeStorefrontProducts
+(*catalog.products*)
+
+## Overview
+
+### Available Operations