ce-storefront 0.18.3 → 0.20.0

package/docs/sdks/catalog/README.md

@@ -1,876 +0,0 @@
-# Catalog
-(*catalog*)
-
-## Overview
-
-### Available Operations
-
-* [listCategories](#listcategories) - List all categories
-* [listProducts](#listproducts) - List all products
-* [listCrosssellProducts](#listcrosssellproducts) - Retrieve cross-sell products
-* [searchProducts](#searchproducts) - Search products
-* [listSimilarProducts](#listsimilarproducts) - Retrieve similar products
-* [listUpsellProducts](#listupsellproducts) - Retrieve up-sell products
-* [getProductDetail](#getproductdetail) - Retrieve a product detail
-* [listProductReviews](#listproductreviews) - List all product reviews
-* [listProductVariants](#listproductvariants) - Retrieve product variants
-* [getVariantDetail](#getvariantdetail) - Retrieve variant detail
-* [listSkus](#listskus) - List all SKUs
-
-## listCategories
-
-Returns a list of your product categories. The categories are returned sorted by creation date, with the most recently created categories appearing first.
-
-API reference for the list-categories operation
-<https://llm-docs.commercengine.io/storefront/operations/list-categories>
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="list-categories" method="get" path="/catalog/categories" -->
-```typescript
-import { CeStorefront } from "ce-storefront";
-
-const ceStorefront = new CeStorefront({
-  authorization: "<YOUR_BEARER_TOKEN_HERE>",
-});
-
-async function run() {
-  const result = await ceStorefront.catalog.listCategories({
-    sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
-    parentCategoryId: "01JWZW41Y3FBKTZSP399SKANY7",
-    parentCategorySlug: "vitals",
-  });
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CeStorefrontCore } from "ce-storefront/core.js";
-import { catalogListCategories } from "ce-storefront/funcs/catalogListCategories.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 catalogListCategories(ceStorefront, {
-    sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
-    parentCategoryId: "01JWZW41Y3FBKTZSP399SKANY7",
-    parentCategorySlug: "vitals",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("catalogListCategories failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.ListCategoriesRequest](../../models/operations/listcategoriesrequest.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.ListCategoriesResponseBody](../../models/operations/listcategoriesresponsebody.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            | \*/\*               |
-
-## listProducts
-
-Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.
-
-API reference for the list-products operation
-<https://llm-docs.commercengine.io/storefront/operations/list-products>
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="list-products" method="get" path="/catalog/products" -->
-```typescript
-import { CeStorefront } from "ce-storefront";
-
-const ceStorefront = new CeStorefront({
-  authorization: "<YOUR_BEARER_TOKEN_HERE>",
-});
-
-async function run() {
-  const result = await ceStorefront.catalog.listProducts({
-    sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
-  });
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CeStorefrontCore } from "ce-storefront/core.js";
-import { catalogListProducts } from "ce-storefront/funcs/catalogListProducts.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 catalogListProducts(ceStorefront, {
-    sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("catalogListProducts failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.ListProductsRequest](../../models/operations/listproductsrequest.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.ListProductsResponseBody](../../models/operations/listproductsresponsebody.md)\>**
-
-### Errors
-
-| Error Type          | Status Code         | Content Type        |
-| ------------------- | ------------------- | ------------------- |
-| errors.Unauthorized | 401                 | application/json    |
-| errors.NotFound     | 404                 | application/json    |
-| errors.CeError      | 4XX, 5XX            | \*/\*               |
-
-## listCrosssellProducts
-
-Retrieves a list of products specified for cross selling. The cross-sell products are returned based on product ids specified in request param.
-
-API reference for the list-crosssell-products operation
-<https://llm-docs.commercengine.io/storefront/operations/list-crosssell-products>
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="list-crosssell-products" method="get" path="/catalog/products/cross-sell" -->
-```typescript
-import { CeStorefront } from "ce-storefront";
-
-const ceStorefront = new CeStorefront({
-  authorization: "<YOUR_BEARER_TOKEN_HERE>",
-});
-
-async function run() {
-  const result = await ceStorefront.catalog.listCrosssellProducts({});
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CeStorefrontCore } from "ce-storefront/core.js";
-import { catalogListCrosssellProducts } from "ce-storefront/funcs/catalogListCrosssellProducts.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 catalogListCrosssellProducts(ceStorefront, {});
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("catalogListCrosssellProducts failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.ListCrosssellProductsRequest](../../models/operations/listcrosssellproductsrequest.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.ListCrosssellProductsResponseBody](../../models/operations/listcrosssellproductsresponsebody.md)\>**
-
-### Errors
-
-| Error Type          | Status Code         | Content Type        |
-| ------------------- | ------------------- | ------------------- |
-| errors.Unauthorized | 401                 | application/json    |
-| errors.NotFound     | 404                 | application/json    |
-| errors.CeError      | 4XX, 5XX            | \*/\*               |
-
-## searchProducts
-
-Search for products matching a specific words or characters given.
-
-API reference for the search-products operation
-<https://llm-docs.commercengine.io/storefront/operations/search-products>
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="search-products" method="post" path="/catalog/products/search" -->
-```typescript
-import { CeStorefront } from "ce-storefront";
-
-const ceStorefront = new CeStorefront({
-  authorization: "<YOUR_BEARER_TOKEN_HERE>",
-});
-
-async function run() {
-  const result = await ceStorefront.catalog.searchProducts({
-    searchProduct: {
-      query: "<value>",
-    },
-  });
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CeStorefrontCore } from "ce-storefront/core.js";
-import { catalogSearchProducts } from "ce-storefront/funcs/catalogSearchProducts.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 catalogSearchProducts(ceStorefront, {
-    searchProduct: {
-      query: "<value>",
-    },
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("catalogSearchProducts failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.SearchProductsRequest](../../models/operations/searchproductsrequest.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.SearchProductsResponseBody](../../models/operations/searchproductsresponsebody.md)\>**
-
-### Errors
-
-| Error Type          | Status Code         | Content Type        |
-| ------------------- | ------------------- | ------------------- |
-| errors.Unauthorized | 401                 | application/json    |
-| errors.CeError      | 4XX, 5XX            | \*/\*               |
-
-## listSimilarProducts
-
-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.
-
-API reference for the list-similar-products operation
-<https://llm-docs.commercengine.io/storefront/operations/list-similar-products>
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="list-similar-products" method="get" path="/catalog/products/similar" -->
-```typescript
-import { CeStorefront } from "ce-storefront";
-
-const ceStorefront = new CeStorefront({
-  authorization: "<YOUR_BEARER_TOKEN_HERE>",
-});
-
-async function run() {
-  const result = await ceStorefront.catalog.listSimilarProducts({});
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CeStorefrontCore } from "ce-storefront/core.js";
-import { catalogListSimilarProducts } from "ce-storefront/funcs/catalogListSimilarProducts.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 catalogListSimilarProducts(ceStorefront, {});
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("catalogListSimilarProducts failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.ListSimilarProductsRequest](../../models/operations/listsimilarproductsrequest.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.ListSimilarProductsResponseBody](../../models/operations/listsimilarproductsresponsebody.md)\>**
-
-### Errors
-
-| Error Type          | Status Code         | Content Type        |
-| ------------------- | ------------------- | ------------------- |
-| errors.Unauthorized | 401                 | application/json    |
-| errors.NotFound     | 404                 | application/json    |
-| errors.CeError      | 4XX, 5XX            | \*/\*               |
-
-## listUpsellProducts
-
-Retrieves a list of products specified for upsell. The upsell products are returned based on product ids specified in request param.
-
-API reference for the list-upsell-products operation
-<https://llm-docs.commercengine.io/storefront/operations/list-upsell-products>
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="list-upsell-products" method="get" path="/catalog/products/up-sell" -->
-```typescript
-import { CeStorefront } from "ce-storefront";
-
-const ceStorefront = new CeStorefront({
-  authorization: "<YOUR_BEARER_TOKEN_HERE>",
-});
-
-async function run() {
-  const result = await ceStorefront.catalog.listUpsellProducts({});
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CeStorefrontCore } from "ce-storefront/core.js";
-import { catalogListUpsellProducts } from "ce-storefront/funcs/catalogListUpsellProducts.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 catalogListUpsellProducts(ceStorefront, {});
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("catalogListUpsellProducts failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.ListUpsellProductsRequest](../../models/operations/listupsellproductsrequest.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.ListUpsellProductsResponseBody](../../models/operations/listupsellproductsresponsebody.md)\>**
-
-### Errors
-
-| Error Type          | Status Code         | Content Type        |
-| ------------------- | ------------------- | ------------------- |
-| errors.Unauthorized | 401                 | application/json    |
-| errors.NotFound     | 404                 | application/json    |
-| errors.CeError      | 4XX, 5XX            | \*/\*               |
-
-## getProductDetail
-
-Retrieves the details of an existing product. Supply either the unique product ID or the unique slug, and Commerce Engine will return the corresponding product information.
-
-API reference for the get-product-detail operation
-<https://llm-docs.commercengine.io/storefront/operations/get-product-detail>
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="get-product-detail" method="get" path="/catalog/products/{product_id_or_slug}" -->
-```typescript
-import { CeStorefront } from "ce-storefront";
-
-const ceStorefront = new CeStorefront({
-  authorization: "<YOUR_BEARER_TOKEN_HERE>",
-});
-
-async function run() {
-  const result = await ceStorefront.catalog.getProductDetail({
-    productIdOrSlug: "01XGCYCT8CRHXW4BG91JXCMDCW",
-  });
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CeStorefrontCore } from "ce-storefront/core.js";
-import { catalogGetProductDetail } from "ce-storefront/funcs/catalogGetProductDetail.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 catalogGetProductDetail(ceStorefront, {
-    productIdOrSlug: "01XGCYCT8CRHXW4BG91JXCMDCW",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("catalogGetProductDetail failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.GetProductDetailRequest](../../models/operations/getproductdetailrequest.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.GetProductDetailResponseBody](../../models/operations/getproductdetailresponsebody.md)\>**
-
-### Errors
-
-| Error Type          | Status Code         | Content Type        |
-| ------------------- | ------------------- | ------------------- |
-| errors.Unauthorized | 401                 | application/json    |
-| errors.NotFound     | 404                 | application/json    |
-| errors.CeError      | 4XX, 5XX            | \*/\*               |
-
-## listProductReviews
-
-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.
-
-API reference for the list-product-reviews operation
-<https://llm-docs.commercengine.io/storefront/operations/list-product-reviews>
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="list-product-reviews" method="get" path="/catalog/products/{product_id}/reviews" -->
-```typescript
-import { CeStorefront } from "ce-storefront";
-
-const ceStorefront = new CeStorefront({
-  authorization: "<YOUR_BEARER_TOKEN_HERE>",
-});
-
-async function run() {
-  const result = await ceStorefront.catalog.listProductReviews({
-    sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
-    productId: "<id>",
-  });
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CeStorefrontCore } from "ce-storefront/core.js";
-import { catalogListProductReviews } from "ce-storefront/funcs/catalogListProductReviews.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 catalogListProductReviews(ceStorefront, {
-    sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
-    productId: "<id>",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("catalogListProductReviews failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.ListProductReviewsRequest](../../models/operations/listproductreviewsrequest.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.ListProductReviewsResponseBody](../../models/operations/listproductreviewsresponsebody.md)\>**
-
-### Errors
-
-| Error Type          | Status Code         | Content Type        |
-| ------------------- | ------------------- | ------------------- |
-| errors.Unauthorized | 401                 | application/json    |
-| errors.NotFound     | 404                 | application/json    |
-| errors.CeError      | 4XX, 5XX            | \*/\*               |
-
-## listProductVariants
-
-Retrieves the variants of an existing product. Supply the unique product ID, and Commerce Engine will return the corresponding product variants information.
-
-API reference for the list-product-variants operation
-<https://llm-docs.commercengine.io/storefront/operations/list-product-variants>
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="list-product-variants" method="get" path="/catalog/products/{product_id}/variants" -->
-```typescript
-import { CeStorefront } from "ce-storefront";
-
-const ceStorefront = new CeStorefront({
-  authorization: "<YOUR_BEARER_TOKEN_HERE>",
-});
-
-async function run() {
-  const result = await ceStorefront.catalog.listProductVariants({
-    productId: "01H7YK0C86V9PGT0HXRJVEZXJQ",
-  });
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CeStorefrontCore } from "ce-storefront/core.js";
-import { catalogListProductVariants } from "ce-storefront/funcs/catalogListProductVariants.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 catalogListProductVariants(ceStorefront, {
-    productId: "01H7YK0C86V9PGT0HXRJVEZXJQ",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("catalogListProductVariants failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.ListProductVariantsRequest](../../models/operations/listproductvariantsrequest.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.ListProductVariantsResponseBody](../../models/operations/listproductvariantsresponsebody.md)\>**
-
-### Errors
-
-| Error Type          | Status Code         | Content Type        |
-| ------------------- | ------------------- | ------------------- |
-| errors.Unauthorized | 401                 | application/json    |
-| errors.NotFound     | 404                 | application/json    |
-| errors.CeError      | 4XX, 5XX            | \*/\*               |
-
-## getVariantDetail
-
-Retrieves the details of a particular variant. Supply the unique product ID, and variant ID.
-
-API reference for the get-variant-detail operation
-<https://llm-docs.commercengine.io/storefront/operations/get-variant-detail>
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="get-variant-detail" method="get" path="/catalog/products/{product_id}/variants/{variant_id}" -->
-```typescript
-import { CeStorefront } from "ce-storefront";
-
-const ceStorefront = new CeStorefront({
-  authorization: "<YOUR_BEARER_TOKEN_HERE>",
-});
-
-async function run() {
-  const result = await ceStorefront.catalog.getVariantDetail({
-    productId: "01H7YK0C86V9PGT0HXRJVEZXJQ",
-    variantId: "<id>",
-  });
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CeStorefrontCore } from "ce-storefront/core.js";
-import { catalogGetVariantDetail } from "ce-storefront/funcs/catalogGetVariantDetail.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 catalogGetVariantDetail(ceStorefront, {
-    productId: "01H7YK0C86V9PGT0HXRJVEZXJQ",
-    variantId: "<id>",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("catalogGetVariantDetail failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.GetVariantDetailRequest](../../models/operations/getvariantdetailrequest.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.GetVariantDetailResponseBody](../../models/operations/getvariantdetailresponsebody.md)\>**
-
-### Errors
-
-| Error Type          | Status Code         | Content Type        |
-| ------------------- | ------------------- | ------------------- |
-| errors.Unauthorized | 401                 | application/json    |
-| errors.NotFound     | 404                 | application/json    |
-| errors.CeError      | 4XX, 5XX            | \*/\*               |
-
-## listSkus
-
-Returns a list of SKUs. The SKUs are returned sorted by creation date, with the most recently created SKUs appearing first.
-
-API reference for the list-skus operation
-<https://llm-docs.commercengine.io/storefront/operations/list-skus>
-
-### Example Usage
-
-<!-- UsageSnippet language="typescript" operationID="list-skus" method="get" path="/catalog/skus" -->
-```typescript
-import { CeStorefront } from "ce-storefront";
-
-const ceStorefront = new CeStorefront({
-  authorization: "<YOUR_BEARER_TOKEN_HERE>",
-});
-
-async function run() {
-  const result = await ceStorefront.catalog.listSkus({
-    sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
-  });
-
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { CeStorefrontCore } from "ce-storefront/core.js";
-import { catalogListSkus } from "ce-storefront/funcs/catalogListSkus.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 catalogListSkus(ceStorefront, {
-    sortBy: "{\"country\":\"asc\",\"city\":\"asc\",\"population\":\"desc\"}",
-  });
-  if (res.ok) {
-    const { value: result } = res;
-    console.log(result);
-  } else {
-    console.log("catalogListSkus failed:", res.error);
-  }
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.ListSkusRequest](../../models/operations/listskusrequest.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.ListSkusResponseBody](../../models/operations/listskusresponsebody.md)\>**
-
-### Errors
-
-| Error Type          | Status Code         | Content Type        |
-| ------------------- | ------------------- | ------------------- |
-| errors.Unauthorized | 401                 | application/json    |
-| errors.NotFound     | 404                 | application/json    |
-| errors.CeError      | 4XX, 5XX            | \*/\*               |