oneentry 1.0.126 → 1.0.127

package/dist/products/productsInterfaces.d.ts

@@ -2,318 +2,320 @@ import type { IFormConfig } from 'forms/formsInterfaces';
 import type { AttributeType, IError, ILocalizeInfo, LangType, Types } from '../base/utils';
 /**
  * @interface IProductApi
- *
- * @property {function} getProducts - Search for all product page objects with pagination and filtering.
- * @property {function} getProductsEmptyPage - Search for all product page objects with pagination that do not have a category.
- * @property {function} getProductsByPageId - Search for all products with pagination for the selected category.
- * @property {function} getProductsPriceByPageUrl - Search for information about products and prices for the selected category.
- * @property {function} getProductsByPageUrl - Search for all products with pagination for the selected category.
- * @property {function} getRelatedProductsById - Find all related product page objects.
- * @property {function} getProductsByIds - Find products by its ids.
- * @property {function} getProductById - Retrieve one product object.
- * @property {function} getProductBlockById - Getting a product block object by product id.
- * @property {function} searchProduct - Quick search for product page objects with limited output.
- * @property {function} getProductsCount - Retrieves the total number of products available in the entire catalog.
- * @property {function} getProductsCountByPageId - Retrieves the number of products on a specific catalog page identified by its page ID.
- * @property {function} getProductsCountByPageUrl - Retrieves the number of products on a specific catalog page identified by its URL.
+ * @property {Function} getProducts               - Search for all product page objects with pagination and filtering.
+ * @property {Function} getProductsEmptyPage      - Search for all product page objects with pagination that do not have a category.
+ * @property {Function} getProductsByPageId       - Search for all products with pagination for the selected category.
+ * @property {Function} getProductsPriceByPageUrl - Search for information about products and prices for the selected category.
+ * @property {Function} getProductsByPageUrl      - Search for all products with pagination for the selected category.
+ * @property {Function} getRelatedProductsById    - Find all related product page objects.
+ * @property {Function} getProductsByIds          - Find products by its ids.
+ * @property {Function} getProductById            - Retrieve one product object.
+ * @property {Function} getProductBlockById       - Getting a product block object by product id.
+ * @property {Function} searchProduct             - Quick search for product page objects with limited output.
+ * @property {Function} getProductsCount          - Retrieves the total number of products available in the entire catalog.
+ * @property {Function} getProductsCountByPageId  - Retrieves the number of products on a specific catalog page identified by its page ID.
+ * @property {Function} getProductsCountByPageUrl - Retrieves the number of products on a specific catalog page identified by its URL.
  * @description This interface defines methods for retrieving and managing products in the system.
  */
 interface IProductApi {
     /**
      * Search for all products with pagination and filter.
-     *
-     * @param {IFilterParams[]} [body] - Request body. Default []. Example:
-        [
-          {
-            "attributeMarker": "price",
-            "conditionMarker": "mth",
-            "statusMarker": "waiting",
-            "conditionValue": 1,
-            "pageUrls": [
-              "23-laminat-floorwood-maxima"
-            ],
-            "isNested": false,
-            "title": ""
-          },
-          {
-            "attributeMarker": "price",
-            "conditionMarker": "lth",
-            "conditionValue": 3,
-            "pageUrls": [
-              "23-laminat-floorwood-maxima"
-            ],
-            "isNested": false,
-            "title": ""
-          }
-        ]
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters. Example:
-        {
-          "limit": 30,
-          "offset": 0,
-          "sortOrder": "DESC",
-          "sortKey": "id",
-          "statusId": 123,
-          "statusMarker": "in_stock",
-          "conditionValue": "new",
-          "conditionMarker": "equals",
-          "attributeMarker": "color"
-        }
-     * @return {IProductsResponse} Array with ProductEntity objects
+     * @handleName getProducts
+     * @param   {IFilterParams[]}   [body]      - Request body. Default []. Example:
+                                                [
+                                                {
+                                                "attributeMarker": "price",
+                                                "conditionMarker": "mth",
+                                                "statusMarker": "waiting",
+                                                "conditionValue": 1,
+                                                "pageUrls": [
+                                                "23-laminat-floorwood-maxima"
+                                                ],
+                                                "isNested": false,
+                                                "title": ""
+                                                },
+                                                {
+                                                "attributeMarker": "price",
+                                                "conditionMarker": "lth",
+                                                "conditionValue": 3,
+                                                "pageUrls": [
+                                                "23-laminat-floorwood-maxima"
+                                                ],
+                                                "isNested": false,
+                                                "title": ""
+                                                }
+                                                ]
+     * @param   {string}            [langCode]  - Language code. Default: "en_US".
+     * @param   {IProductsQuery}    [userQuery] - Optional set query parameters. Example:
+                                                {
+                                                "limit": 30,
+                                                "offset": 0,
+                                                "sortOrder": "DESC",
+                                                "sortKey": "id",
+                                                "statusId": 123,
+                                                "statusMarker": "in_stock",
+                                                "conditionValue": "new",
+                                                "conditionMarker": "equals",
+                                                "attributeMarker": "color"
+                                                }
+     * @returns {IProductsResponse}             Array with ProductEntity objects
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     getProducts(body?: IFilterParams[], langCode?: string, userQuery?: IProductsQuery): Promise<IProductsResponse | IError>;
     /**
      * Search for all product page objects with pagination that do not have a category.
-     *
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters. Example:
-        {
-          "limit": 30,
-          "offset": 0,
-          "sortOrder": "DESC",
-          "sortKey": "id",
-          "statusId": 123,
-          "statusMarker": "in_stock",
-          "conditionValue": "new",
-          "conditionMarker": "equals",
-          "attributeMarker": "color"
-        }
-     * @return {IProductsResponse} Array with ProductEntity objects.
+     * @handleName getProductsEmptyPage
+     * @param   {string}            [langCode]  - Language code. Default: "en_US".
+     * @param   {IProductsQuery}    [userQuery] - Optional set query parameters. Example:
+                                                {
+                                                "limit": 30,
+                                                "offset": 0,
+                                                "sortOrder": "DESC",
+                                                "sortKey": "id",
+                                                "statusId": 123,
+                                                "statusMarker": "in_stock",
+                                                "conditionValue": "new",
+                                                "conditionMarker": "equals",
+                                                "attributeMarker": "color"
+                                                }
+     * @returns {IProductsResponse}             Array with ProductEntity objects.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method searches for all product page objects with pagination that do not have a category.
      */
     getProductsEmptyPage(langCode?: LangType, userQuery?: IProductsQuery): Promise<IProductsResponse | IError>;
     /**
      * Search for all products with pagination for the selected category.
-     *
-     * @param {number} id - Page id. Example: 12345.
-     * @param {IFilterParams[]} [body] - Request body. Default: [].
-     * @param {string} [langCode] - Language code. Default "en_US".
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters. Example:
-        {
-          "limit": 30,
-          "offset": 0,
-          "sortOrder": "DESC",
-          "sortKey": "id",
-          "statusId": 123,
-          "statusMarker": "in_stock",
-          "conditionValue": "new",
-          "conditionMarker": "equals",
-          "attributeMarker": "color"
-        }
-     * @return {IProductsResponse} Array with ProductEntity objects
+     * @handleName getProductsByPageId
+     * @param   {number}            id          - Page id. Example: 12345.
+     * @param   {IFilterParams[]}   [body]      - Request body. Default: [].
+     * @param   {string}            [langCode]  - Language code. Default "en_US".
+     * @param   {IProductsQuery}    [userQuery] - Optional set query parameters. Example:
+                                                {
+                                                "limit": 30,
+                                                "offset": 0,
+                                                "sortOrder": "DESC",
+                                                "sortKey": "id",
+                                                "statusId": 123,
+                                                "statusMarker": "in_stock",
+                                                "conditionValue": "new",
+                                                "conditionMarker": "equals",
+                                                "attributeMarker": "color"
+                                                }
+     * @returns {IProductsResponse}             Array with ProductEntity objects
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method searches for all products with pagination for the selected category.
      */
     getProductsByPageId(id: number, body?: IFilterParams[], langCode?: string, userQuery?: IProductsQuery): Promise<IProductsResponse | IError>;
     /**
      * Search for information about products and prices for the selected category.
-     *
-     * @param {string} [url] - Page url. Example: "23-laminat-floorwood-maxima".
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters. Example:
-        {
-          "limit": 30,
-          "offset": 0,
-          "sortOrder": "DESC",
-          "sortKey": "id",
-          "statusId": 123,
-          "statusMarker": "in_stock",
-          "conditionValue": "new",
-          "conditionMarker": "equals",
-          "attributeMarker": "color"
-        }
-     * @return {IProductsInfo} Array with ProductInformation objects.
+     * @handleName getProductsPriceByPageUrl
+     * @param   {string}         [url]       - Page url. Example: "23-laminat-floorwood-maxima".
+     * @param   {string}         [langCode]  - Language code. Default: "en_US".
+     * @param   {IProductsQuery} [userQuery] - Optional set query parameters. Example:
+                                             {
+                                             "limit": 30,
+                                             "offset": 0,
+                                             "sortOrder": "DESC",
+                                             "sortKey": "id",
+                                             "statusId": 123,
+                                             "statusMarker": "in_stock",
+                                             "conditionValue": "new",
+                                             "conditionMarker": "equals",
+                                             "attributeMarker": "color"
+                                             }
+     * @returns {IProductsInfo}              Array with ProductInformation objects.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method searches for information about products prices for the selected category.
      */
     getProductsPriceByPageUrl(url: string, langCode?: string, userQuery?: IProductsQuery): Promise<IProductsInfo | IError>;
     /**
      * Search for all products with pagination for the selected category.
-     *
-     * @param {string} url - Page url. Example: "23-laminat-floorwood-maxima".
-     * @param {IFilterParams[]} [body] - Request body. Default: [].
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters. Example:
-        {
-          "limit": 30,
-          "offset": 0,
-          "sortOrder": "DESC",
-          "sortKey": "id",
-          "statusId": 123,
-          "statusMarker": "in_stock",
-          "conditionValue": "new",
-          "conditionMarker": "equals",
-          "attributeMarker": "color"
-        }
-     * @return {IProductsResponse} Array with ProductEntity objects.
+     * @handleName getProductsByPageUrl
+     * @param   {string}            url         - Page url. Example: "23-laminat-floorwood-maxima".
+     * @param   {IFilterParams[]}   [body]      - Request body. Default: [].
+     * @param   {string}            [langCode]  - Language code. Default: "en_US".
+     * @param   {IProductsQuery}    [userQuery] - Optional set query parameters. Example:
+                                                {
+                                                "limit": 30,
+                                                "offset": 0,
+                                                "sortOrder": "DESC",
+                                                "sortKey": "id",
+                                                "statusId": 123,
+                                                "statusMarker": "in_stock",
+                                                "conditionValue": "new",
+                                                "conditionMarker": "equals",
+                                                "attributeMarker": "color"
+                                                }
+     * @returns {IProductsResponse}             Array with ProductEntity objects.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method searches for all products with pagination for the selected category.
      */
     getProductsByPageUrl(url: string, body?: IFilterParams[], langCode?: string, userQuery?: IProductsQuery): Promise<IProductsResponse | IError>;
     /**
      * Find all related product page objects.
-     *
-     * @param {number} [id] - Product page identifier for which to find relationship. Example: 12345.
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters. Example:
-        {
-          "limit": 30,
-          "offset": 0,
-          "sortOrder": "DESC",
-          "sortKey": "id",
-          "statusId": 123,
-          "statusMarker": "in_stock",
-          "conditionValue": "new",
-          "conditionMarker": "equals",
-          "attributeMarker": "color"
-        }
-     * @return {IProductsResponse} Array with ProductEntity objects
+     * @handleName getRelatedProductsById
+     * @param   {number}            [id]        - Product page identifier for which to find relationship. Example: 12345.
+     * @param   {string}            [langCode]  - Language code. Default: "en_US".
+     * @param   {IProductsQuery}    [userQuery] - Optional set query parameters. Example:
+                                                {
+                                                "limit": 30,
+                                                "offset": 0,
+                                                "sortOrder": "DESC",
+                                                "sortKey": "id",
+                                                "statusId": 123,
+                                                "statusMarker": "in_stock",
+                                                "conditionValue": "new",
+                                                "conditionMarker": "equals",
+                                                "attributeMarker": "color"
+                                                }
+     * @returns {IProductsResponse}             Array with ProductEntity objects
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @description This method finds all related product page objects for the selected product page.
      */
     getRelatedProductsById(id: number, langCode?: string, userQuery?: IProductsQuery): Promise<IProductsResponse | IError>;
     /**
      * Find products by its ids.
-     *
-     * @param {string} [ids] - Product page identifiers for which to find relationships. Example: "12345,67890".
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters. Example:
-        {
-          "limit": 30,
-          "offset": 0,
-          "sortOrder": "DESC",
-          "sortKey": "id",
-          "statusId": 123,
-          "statusMarker": "in_stock",
-          "conditionValue": "new",
-          "conditionMarker": "equals",
-          "attributeMarker": "color"
-        }
-     * @return {IProductsEntity[]} Array with ProductEntity objects
+     * @handleName getProductsByIds
+     * @param   {string}            [ids]       - Product page identifiers for which to find relationships. Example: "12345,67890".
+     * @param   {string}            [langCode]  - Language code. Default: "en_US".
+     * @param   {IProductsQuery}    [userQuery] - Optional set query parameters. Example:
+                                                {
+                                                "limit": 30,
+                                                "offset": 0,
+                                                "sortOrder": "DESC",
+                                                "sortKey": "id",
+                                                "statusId": 123,
+                                                "statusMarker": "in_stock",
+                                                "conditionValue": "new",
+                                                "conditionMarker": "equals",
+                                                "attributeMarker": "color"
+                                                }
+     * @returns {IProductsEntity[]}             Array with ProductEntity objects
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @description This method finds products by its ids.
      */
     getProductsByIds(ids: string, langCode?: string, userQuery?: IProductsQuery): Promise<IProductsEntity[] | IError>;
     /**
      * Retrieve one product object.
-     *
-     * @param {number} id - Product id. Example: 12345.
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {IProductsEntity} ProductEntity object.
+     * @handleName getProductById
+     * @param   {number}          id         - Product id. Example: 12345.
+     * @param   {string}          [langCode] - Language code. Default: "en_US".
+     * @returns {IProductsEntity}            ProductEntity object.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @description This method retrieves one product object.
      */
     getProductById(id: number, langCode?: string): Promise<IProductsEntity | IError>;
     /**
      * Getting a product block object by product id.
-     *
-     * @param {number} id - Product id. Example: 12345.
-     * @return {IProductBlock}
+     * @handleName getProductBlockById
+     * @param   {number}        id - Product id. Example: 12345.
+     * @returns {IProductBlock}
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets a product block object by product id.
      */
     getProductBlockById(id: number): Promise<IProductBlock[] | IError>;
     /**
      * Quick search for product page objects with limited output.
-     *
-     * @param {string} name - Text to search product page objects (search is based on the title field of the localizeInfos object with language consideration). Example: 'laminat'.
-     * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {IProductsEntity[]} Array with ProductEntity objects
+     * @handleName searchProduct
+     * @param   {string}            name       - Text to search product page objects (search is based on the title field of the localizeInfos object with language consideration). Example: 'laminat'.
+     * @param   {string}            [langCode] - Language code. Default: "en_US".
+     * @returns {IProductsEntity[]}            Array with ProductEntity objects
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method performs a quick search for product page objects with limited output.
      */
     searchProduct(name: string, langCode: string): Promise<IProductsEntity[] | IError>;
     /**
      * Getting the number of products for the entire catalog.
-     *
      * @handleName getProductsCount
-     *
-     * @param {string} [body] - Body parameters for filter. Deault: []. Example:
-        [
-          {
-            "attributeMarker": "price",
-            "conditionMarker": "in",
-            "statusMarker": "status_1",
-            "conditionValue": {},
-            "pageUrls": [
-              "23-laminat-floorwood-maxima"
-            ],
-            "title": "Iphone 17 Pro"
-          },
-          {
-            "attributeMarker": "price",
-            "conditionMarker": "in",
-            "statusMarker": "status_1",
-            "conditionValue": {},
-            "pageUrls": [
-              "23-laminat-floorwood-maxima"
-            ],
-            "title": "Iphone 17 Pro"
-          }
-        ]
-     * @return {IProductsCount} Object with product items count.
+     * @param   {string}         [body] - Body parameters for filter. Deault: []. Example:
+                                        [
+                                        {
+                                        "attributeMarker": "price",
+                                        "conditionMarker": "in",
+                                        "statusMarker": "status_1",
+                                        "conditionValue": {},
+                                        "pageUrls": [
+                                        "23-laminat-floorwood-maxima"
+                                        ],
+                                        "title": "Iphone 17 Pro"
+                                        },
+                                        {
+                                        "attributeMarker": "price",
+                                        "conditionMarker": "in",
+                                        "statusMarker": "status_1",
+                                        "conditionValue": {},
+                                        "pageUrls": [
+                                        "23-laminat-floorwood-maxima"
+                                        ],
+                                        "title": "Iphone 17 Pro"
+                                        }
+                                        ]
+     * @returns {IProductsCount}        Object with product items count.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method calculates and returns the total number of products present across the entire catalog, optionally applying specified filters.
      */
     getProductsCount(body: any): Promise<IProductsCount | IError>;
     /**
      * Getting the number of products on a catalog page by page ID.
-     *
      * @handleName getProductsCountByPageId
-     *
-     * @param {string} id - Page id. Example: 12345.
-     * @param {string} body - Body parameters for filter. Deault: []. Example:
-        [
-          {
-            "attributeMarker": "price",
-            "conditionMarker": "in",
-            "statusMarker": "status_1",
-            "conditionValue": {},
-            "pageUrls": [
-              "23-laminat-floorwood-maxima"
-            ],
-            "title": "Iphone 17 Pro"
-          },
-          {
-            "attributeMarker": "price",
-            "conditionMarker": "in",
-            "statusMarker": "status_1",
-            "conditionValue": {},
-            "pageUrls": [
-              "23-laminat-floorwood-maxima"
-            ],
-            "title": "Iphone 17 Pro"
-          }
-        ]
-     * @return {IProductsCount} Object with product items count.
+     * @param   {string}         id   - Page id. Example: 12345.
+     * @param   {string}         body - Body parameters for filter. Deault: []. Example:
+                                      [
+                                      {
+                                      "attributeMarker": "price",
+                                      "conditionMarker": "in",
+                                      "statusMarker": "status_1",
+                                      "conditionValue": {},
+                                      "pageUrls": [
+                                      "23-laminat-floorwood-maxima"
+                                      ],
+                                      "title": "Iphone 17 Pro"
+                                      },
+                                      {
+                                      "attributeMarker": "price",
+                                      "conditionMarker": "in",
+                                      "statusMarker": "status_1",
+                                      "conditionValue": {},
+                                      "pageUrls": [
+                                      "23-laminat-floorwood-maxima"
+                                      ],
+                                      "title": "Iphone 17 Pro"
+                                      }
+                                      ]
+     * @returns {IProductsCount}      Object with product items count.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method calculates and returns the number of products available on a given catalog page, identified by its page ID, with optional filtering.
      */
     getProductsCountByPageId(id: string, body: any): Promise<IProductsCount | IError>;
     /**
      * Getting the number of products on a catalog page by page URL.
-     *
      * @handleName getProductsCountByPageUrl
-     *
-     * @param {string} url - Page url. Example: "catalog".
-     * @param {string} body - Body parameters for filter. Deault: []. Example:
-        [
-          {
-            "attributeMarker": "price",
-            "conditionMarker": "in",
-            "statusMarker": "status_1",
-            "conditionValue": {},
-            "pageUrls": [
-              "23-laminat-floorwood-maxima"
-            ],
-            "title": "Iphone 17 Pro"
-          },
-          {
-            "attributeMarker": "price",
-            "conditionMarker": "in",
-            "statusMarker": "status_1",
-            "conditionValue": {},
-            "pageUrls": [
-              "23-laminat-floorwood-maxima"
-            ],
-            "title": "Iphone 17 Pro"
-          }
-        ]
-     * @return {IProductsCount} Object with product items count.
+     * @param   {string}         url  - Page url. Example: "catalog".
+     * @param   {string}         body - Body parameters for filter. Deault: []. Example:
+                                      [
+                                      {
+                                      "attributeMarker": "price",
+                                      "conditionMarker": "in",
+                                      "statusMarker": "status_1",
+                                      "conditionValue": {},
+                                      "pageUrls": [
+                                      "23-laminat-floorwood-maxima"
+                                      ],
+                                      "title": "Iphone 17 Pro"
+                                      },
+                                      {
+                                      "attributeMarker": "price",
+                                      "conditionMarker": "in",
+                                      "statusMarker": "status_1",
+                                      "conditionValue": {},
+                                      "pageUrls": [
+                                      "23-laminat-floorwood-maxima"
+                                      ],
+                                      "title": "Iphone 17 Pro"
+                                      }
+                                      ]
+     * @returns {IProductsCount}      Object with product items count.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method calculates and returns the number of products available on a given catalog page, identified by its URL, with optional filtering.
      */
@@ -321,14 +323,13 @@ interface IProductApi {
 }
 /**
  * @interface IProductsQuery
- *
- * @property {number} offset - Parameter for pagination. Default: 0.
- * @property {number} limit - Parameter for pagination. Default: 30.
- * @property {string} sortOrder - Sort order "DESC" | "ASC". Default: "DESC".
- * @property {string} sortKey - Field for sorting (default - null). Possible values: "id", "position", "title", "date", "price". Default: null.
- * @property {string | null} [templateMarker] - Product page template marker, default null. Example: "template_12345".
- * @property {string | null} [statusMarker] - Product page status marker, default null. Example: "in_stock".
- * @property {string | null} [conditionValue] - The value that is being searched for, default null. Example: "new".
+ * @property {number}        offset            - Parameter for pagination. Default: 0.
+ * @property {number}        limit             - Parameter for pagination. Default: 30.
+ * @property {string}        sortOrder         - Sort order "DESC" | "ASC". Default: "DESC".
+ * @property {string}        sortKey           - Field for sorting (default - null). Possible values: "id", "position", "title", "date", "price". Default: null.
+ * @property {string | null} [templateMarker]  - Product page template marker, default null. Example: "template_12345".
+ * @property {string | null} [statusMarker]    - Product page status marker, default null. Example: "in_stock".
+ * @property {string | null} [conditionValue]  - The value that is being searched for, default null. Example: "new".
  * @property {string | null} [attributeMarker] - The text identifier of the indexed attribute by which values are filtered, default null. Example: "color".
  * @property {string | null} [conditionMarker] - Marker of the filter condition by which the values are filtered, default null. Example: "equals".
  * @description This interface defines the structure of a query for retrieving products, including pagination, sorting, and filtering parameters.
@@ -347,14 +348,13 @@ interface IProductsQuery {
 }
 /**
  * @interface IFilterParams
- *
- * @property {string | null} attributeMarker - The text identifier of the indexed attribute by which values are filtered. Default: null. Example: "color".
+ * @property {string | null} attributeMarker   - The text identifier of the indexed attribute by which values are filtered. Default: null. Example: "color".
  * @property {string | null} [conditionMarker] - Id of the filter condition by which the values are filtered. Default: null. Example: "equals".
- * @property {number | null} conditionValue - The value that is being searched for, default null. Example: "new".
- * @property {string | null} [pageUrl] - Url of the category page object. Example: ["23-laminat-floorwood-maxima"].
- * @property {string | null} [statusMarker] - Text identifier of the product page status (default not set). Example: "in_stock".
- * @property {string | null} [title] - Product name. Example: "Laminatboden Maxima".
- * @property {boolean} [isNested] - Flag for nested attributes, default false. Example: true.
+ * @property {number | null} conditionValue    - The value that is being searched for, default null. Example: "new".
+ * @property {string | null} [pageUrl]         - Url of the category page object. Example: ["23-laminat-floorwood-maxima"].
+ * @property {string | null} [statusMarker]    - Text identifier of the product page status (default not set). Example: "in_stock".
+ * @property {string | null} [title]           - Product name. Example: "Laminatboden Maxima".
+ * @property {boolean}       [isNested]        - Flag for nested attributes, default false. Example: true.
  * @description This interface defines the structure of filter parameters used for querying products, including conditions, attributes, and pagination.
  */
 interface IFilterParams {
@@ -368,40 +368,39 @@ interface IFilterParams {
 }
 /**
  * @interface IProductsEntity
- *
- * @property {number} id - The unique identifier. Example: 12345.
- * @property {ILocalizeInfo} localizeInfos - The name of the products, taking into account localization. Example:
- * @property {string | null} statusIdentifier - Product page status identifiers (may be null). Example: "in_stock".
- * @property {any} statusLocalizeInfos - JSON description of the item status object, taking into account the language. Example:
- * @property {string | null} attributeSetIdentifier - Set of attributes id. Example: "set_12345".
- * @property {number} position - Item number (for sorting). Example: 1.
- * @property {string | null} [templateIdentifier] - User id of the linked template. Example: "template_12345".
+ * @property {number}        id                            - The unique identifier. Example: 12345.
+ * @property {ILocalizeInfo} localizeInfos                 - The name of the products, taking into account localization. Example:
+ * @property {string | null} statusIdentifier              - Product page status identifiers (may be null). Example: "in_stock".
+ * @property {any}           statusLocalizeInfos           - JSON description of the item status object, taking into account the language. Example:
+ * @property {string | null} attributeSetIdentifier        - Set of attributes id. Example: "set_12345".
+ * @property {number}        position                      - Item number (for sorting). Example: 1.
+ * @property {string | null} [templateIdentifier]          - User id of the linked template. Example: "template_12345".
  * @property {string | null} [shortDescTemplateIdentifier] - User id of the linked template for a short description. Example: "short_desc_template_12345".
- * @property {number} price - The value of the product page price taken from the index. Example: 150.00.
- * @property {object} additional - Additional value from the index. Example:
-    {
-      "en": "In Stock",
-      "de": "Auf Lager"
-    }
- * @property {string | null} sku - Product SKU (Stock Keeping Unit), may be null. Example: "SKU_12345".
- * @property {boolean} isSync - Indication of page indexing. Example: true.
- * @property {AttributeType} attributeValues - Array of attribute values from the index, represented. Example:
-    [
-      {
-        "id": "color",
-        "value": "red"
-      }
-    ]
- * @property {string[]} categories - Product categories. Example: [1, 2, 3]
- * @property {boolean} isVisible - A sign of page visibility. Example: true.
- * @property {any[]} [productPages] - Array of product pages or a single product page object. Example:
- * @property {string[]} [blocks] - Array of block identifiers. Example:
-    [
-      "block_12345",
-      "block_67890"
-    ]
- * @property {boolean} isPositionLocked - Sorting position lock indicator (optional). Example: false.
- * @property {number[]} relatedIds - Ids of related product pages. Example: [12345, 67890].
+ * @property {number}        price                         - The value of the product page price taken from the index. Example: 150.00.
+ * @property {object}        additional                    - Additional value from the index. Example:
+                                                           {
+                                                           "en": "In Stock",
+                                                           "de": "Auf Lager"
+                                                           }
+ * @property {string | null} sku                           - Product SKU (Stock Keeping Unit), may be null. Example: "SKU_12345".
+ * @property {boolean}       isSync                        - Indication of page indexing. Example: true.
+ * @property {AttributeType} attributeValues               - Array of attribute values from the index, represented. Example:
+                                                           [
+                                                           {
+                                                           "id": "color",
+                                                           "value": "red"
+                                                           }
+                                                           ]
+ * @property {string[]}      categories                    - Product categories. Example: [1, 2, 3]
+ * @property {boolean}       isVisible                     - A sign of page visibility. Example: true.
+ * @property {any[]}         [productPages]                - Array of product pages or a single product page object. Example:
+ * @property {string[]}      [blocks]                      - Array of block identifiers. Example:
+                                                           [
+                                                           "block_12345",
+                                                           "block_67890"
+                                                           ]
+ * @property {boolean}       isPositionLocked              - Sorting position lock indicator (optional). Example: false.
+ * @property {number[]}      relatedIds                    - Ids of related product pages. Example: [12345, 67890].
  * @description This interface defines the structure of a product entity, including its identifiers, attributes, and related information.
  */
 interface IProductsEntity {
@@ -433,19 +432,18 @@ interface IProductsEntity {
 }
 /**
  * @interface IProductsResponse
- *
- * @property {number} total - The total number of products found. Example: 100.
+ * @property {number}            total - The total number of products found. Example: 100.
  * @property {IProductsEntity[]} items - An array of product entities. Example:
-    [
-      {
-        "id": 12345,
-        "title": "Product 1"
-      },
-      {
-        "id": 67890,
-        "title": "Product 2"
-      }
-    ]
+                                       [
+                                       {
+                                       "id": 12345,
+                                       "title": "Product 1"
+                                       },
+                                       {
+                                       "id": 67890,
+                                       "title": "Product 2"
+                                       }
+                                       ]
  * @description This interface defines the structure of a response containing multiple product entities, including the total count and an array of product items.
  */
 interface IProductsResponse {
@@ -454,9 +452,8 @@ interface IProductsResponse {
 }
 /**
  * @interface IProductsCount
- *
- * @property {number} totalAll - The total number of products found. Example: 100.
- * @property {number} totalInCategory - The total number of products found in category. Example: 50.
+ * @property {number} totalAll                  - The total number of products found. Example: 100.
+ * @property {number} totalInCategory           - The total number of products found in category. Example: 50.
  * @property {number} totalInCategoryWithNested - The total number of products found in nested category. Example: 10.
  * @description This interface defines the structure of a response with total count of product items.
  */
@@ -467,19 +464,18 @@ interface IProductsCount {
 }
 /**
  * @interface IProductsInfo
- *
- * @property {number} total - The total number of products found. Example: 100.
+ * @property {number}         total - The total number of products found. Example: 100.
  * @property {IProductInfo[]} items - An array of product information objects. Example:
-    [
-      {
-        "id": 12345,
-        "price": 150.00
-      },
-      {
-        "id": 67890,
-        "price": 200.00
-      }
-    ]
+                                    [
+                                    {
+                                    "id": 12345,
+                                    "price": 150.00
+                                    },
+                                    {
+                                    "id": 67890,
+                                    "price": 200.00
+                                    }
+                                    ]
  * @description This interface defines the structure of a response containing product information, including the total count and an array of product items.
  */
 interface IProductsInfo {
@@ -488,8 +484,7 @@ interface IProductsInfo {
 }
 /**
  * @interface IProductInfo
- *
- * @property {number} id - The unique identifier of the product. Example: 12345.
+ * @property {number} id    - The unique identifier of the product. Example: 12345.
  * @property {number} price - The price of the product. Example: 150.00.
  * @description This interface defines the structure of a product information object, including its identifier and price.
  */
@@ -499,28 +494,27 @@ interface IProductInfo {
 }
 /**
  * @interface IProductBlock
- *
- * @property {number} id - Unique identifier of the product block. Example: 3289.
+ * @property {number}        id                     - Unique identifier of the product block. Example: 3289.
  * @property {number | null} attributeSetIdentifier - Identifier of the attribute set used in the product block, or null if not applicable. Example: 67890.
- * @property {ILocalizeInfo} localizeInfos - Localization information for the product block. Example:
-    {
-      "title": "Box"
-    }
- * @property {number} version - Version of the product block entity. Example: 1.
- * @property {number} position - Position of the product block in a list or layout. Example: 1.
- * @property {string} identifier - Unique string identifier for the product block. Example: "product_block_12345".
- * @property {Types} type - Type of the product block, such as "product", "error_page", etc. Example: "product".
- * @property {object} customSettings - Custom settings for the product block, including slider delay, product configuration, similar product rules, and conditions. Example: {}
- * @property {string | null} templateIdentifier - Identifier for the template used by the product block, or null if not applicable. Example: "template_12345".
- * @property {boolean} isVisible - Indicates whether the product block is visible. Example: true.
- * @property {boolean} isSync - Indicates whether the product block is synchronized. Example: false.
- * @property {AttributeType} attributeValues - Array of attribute values from the index, represented as a pair of user attribute id and attribute value. Example:
-    [
-      {
-        "id": "color",
-        "value": "red"
-      }
-    ]
+ * @property {ILocalizeInfo} localizeInfos          - Localization information for the product block. Example:
+                                                    {
+                                                    "title": "Box"
+                                                    }
+ * @property {number}        version                - Version of the product block entity. Example: 1.
+ * @property {number}        position               - Position of the product block in a list or layout. Example: 1.
+ * @property {string}        identifier             - Unique string identifier for the product block. Example: "product_block_12345".
+ * @property {Types}         type                   - Type of the product block, such as "product", "error_page", etc. Example: "product".
+ * @property {object}        customSettings         - Custom settings for the product block, including slider delay, product configuration, similar product rules, and conditions. Example: {}
+ * @property {string | null} templateIdentifier     - Identifier for the template used by the product block, or null if not applicable. Example: "template_12345".
+ * @property {boolean}       isVisible              - Indicates whether the product block is visible. Example: true.
+ * @property {boolean}       isSync                 - Indicates whether the product block is synchronized. Example: false.
+ * @property {AttributeType} attributeValues        - Array of attribute values from the index, represented as a pair of user attribute id and attribute value. Example:
+                                                    [
+                                                    {
+                                                    "id": "color",
+                                                    "value": "red"
+                                                    }
+                                                    ]
  * @description This interface defines the structure of a product block entity, including its identifiers, attributes, and custom settings.
  */
 interface IProductBlock {