ce-storefront 0.3.17 → 0.3.19

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

@@ -1,17 +1,16 @@
-# CeStorefrontAddresses
-(*customers.addresses*)
+# CeStorefrontReviews
+(*catalog.products.reviews*)
 
 ## Overview
 
 ### Available Operations
 
-* [list](#list) - Retrieve all addresses
-* [update](#update) - Update particular address
-* [delete](#delete) - Remove particular address
+* [list](#list) - List all product reviews
+* [create](#create) - Create product review
 
 ## list
 
-Retrieve billing and shipping address of particular customer
+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
 
@@ -23,8 +22,9 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.customers.addresses.list({
-    userId: "<id>",
+  const result = await ceStorefront.catalog.products.reviews.list({
+    productId: "<id>",
+    sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
   });
 
   // Handle the result
@@ -40,7 +40,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CeStorefrontCore } from "ce-storefront/core.js";
-import { customersAddressesList } from "ce-storefront/funcs/customersAddressesList.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.
@@ -49,8 +49,9 @@ const ceStorefront = new CeStorefrontCore({
 });
 
 async function run() {
-  const res = await customersAddressesList(ceStorefront, {
-    userId: "<id>",
+  const res = await catalogProductsReviewsList(ceStorefront, {
+    productId: "<id>",
+    sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
   });
 
   if (!res.ok) {
@@ -70,125 +71,26 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.GetAddressRequest](../../models/operations/getaddressrequest.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.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)\>**
+**Promise\<[operations.GetProductsIdReviewsResponseBody](../../models/operations/getproductsidreviewsresponsebody.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            | \*/\*               |
 
-## delete
+## create
 
-Delete address
+Create a product review
 
 ### Example Usage
 
@@ -200,9 +102,13 @@ const ceStorefront = new CeStorefront({
 });
 
 async function run() {
-  const result = await ceStorefront.customers.addresses.delete({
-    userId: "<id>",
-    addressId: "<id>",
+  const result = await ceStorefront.catalog.products.reviews.create({
+    productId: "<id>",
+    createReview: {
+      orderNumber: "<value>",
+      rating: 4865.89,
+      userId: "<id>",
+    },
   });
 
   // Handle the result
@@ -218,7 +124,7 @@ The standalone function version of this method:
 
 ```typescript
 import { CeStorefrontCore } from "ce-storefront/core.js";
-import { customersAddressesDelete } from "ce-storefront/funcs/customersAddressesDelete.js";
+import { catalogProductsReviewsCreate } from "ce-storefront/funcs/catalogProductsReviewsCreate.js";
 
 // Use `CeStorefrontCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -227,9 +133,13 @@ const ceStorefront = new CeStorefrontCore({
 });
 
 async function run() {
-  const res = await customersAddressesDelete(ceStorefront, {
-    userId: "<id>",
-    addressId: "<id>",
+  const res = await catalogProductsReviewsCreate(ceStorefront, {
+    productId: "<id>",
+    createReview: {
+      orderNumber: "<value>",
+      rating: 4865.89,
+      userId: "<id>",
+    },
   });
 
   if (!res.ok) {
@@ -249,19 +159,20 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.DeleteCustomerAddressIdRequest](../../models/operations/deletecustomeraddressidrequest.md)                                                                         | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `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.DeleteCustomerAddressIdResponseBody](../../models/operations/deletecustomeraddressidresponsebody.md)\>**
+**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            | \*/\*               |