oneentry 1.0.126 → 1.0.128

package/dist/products/productsApi.d.ts

@@ -5,17 +5,21 @@ import type { IFilterParams, IProductApi, IProductBlock, IProductsCount, IProduc
 /**
  * Controllers for working with product pages
  * @handle /api/content/products
+ * @description Controllers for working with product pages
  */
 export default class ProductApi extends AsyncModules implements IProductApi {
     protected state: StateModule;
     protected _url: string;
+    /**
+     * Constructor
+     * @param {StateModule} state - StateModule instance
+     * @description Constructor initializes the ProductApi with a given state.
+     */
     constructor(state: StateModule);
     private _defaultQuery;
     /**
      * Search for all products with pagination and filter.
-     *
      * @handleName getProducts
-     *
      * @param {IFilterParams[]} [body] - Request body. Default: []. Example:
         [
           {
@@ -53,16 +57,14 @@ export default class ProductApi extends AsyncModules implements IProductApi {
           "conditionMarker": "equals",
           "attributeMarker": "color"
         }
-     * @return {IProductsResponse} Array with ProductEntity objects
+     * @returns {IProductsResponse} Array with ProductEntity objects
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Fetch products with optional filters and pagination.
      */
     getProducts(body?: IFilterParams[], langCode?: string, userQuery?: IProductsQuery): Promise<IProductsResponse | IError>;
     /**
      * Search for all product page objects with pagination that do not have a category.
-     *
      * @handleName getProductsEmptyPage
-     *
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {IProductsQuery} [userQuery] - Optional set query parameters. Example:
         {
@@ -76,16 +78,14 @@ export default class ProductApi extends AsyncModules implements IProductApi {
           "conditionMarker": "equals",
           "attributeMarker": "color"
         }
-     * @return {IProductsResponse} Array with ProductEntity objects.
+     * @returns {IProductsResponse} Array with ProductEntity objects.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Search for all product page objects with pagination that do not have a category.
      */
     getProductsEmptyPage(langCode?: string, userQuery?: IProductsQuery): Promise<IProductsResponse | IError>;
     /**
      * Search for all products with pagination for the selected category.
-     *
      * @handleName getProductsByPageId
-     *
      * @param {number} id - Page id. Example: 2492.
      * @param {IFilterParams[]} [body] - Request body. Default: []. Example:
         [
@@ -124,16 +124,14 @@ export default class ProductApi extends AsyncModules implements IProductApi {
           "conditionMarker": "equals",
           "attributeMarker": "color"
         }
-     * @return {IProductsResponse} Array with ProductEntity objects
+     * @returns {IProductsResponse} Array with ProductEntity objects
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Fetch products by page ID with optional filters and pagination.
      */
     getProductsByPageId(id: number, body?: IFilterParams[], langCode?: string, userQuery?: IProductsQuery): Promise<IProductsResponse | IError>;
     /**
      * Search for information about products and prices for the selected category.
-     *
      * @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:
@@ -148,16 +146,14 @@ export default class ProductApi extends AsyncModules implements IProductApi {
           "conditionMarker": "equals",
           "attributeMarker": "color"
         }
-     * @return {IProductsInfo} Array with ProductInformation objects.
+     * @returns {IProductsInfo} Array with ProductInformation objects.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Search for information about products and 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.
-     *
      * @handleName getProductsByPageUrl
-     *
      * @param {string} url - Page url. Example: "catalog".
      * @param {IFilterParams[]} [body] - Request body. Default: []. Example:
         [
@@ -167,7 +163,7 @@ export default class ProductApi extends AsyncModules implements IProductApi {
             "statusMarker": "waiting",
             "conditionValue": 1,
             "pageUrls": [
-              "23-laminat-floorwood-maxima"
+            "23-laminat-floorwood-maxima"
             ],
             "isNested": false,
             "title": ""
@@ -177,7 +173,7 @@ export default class ProductApi extends AsyncModules implements IProductApi {
             "conditionMarker": "lth",
             "conditionValue": 3,
             "pageUrls": [
-              "23-laminat-floorwood-maxima"
+            "23-laminat-floorwood-maxima"
             ],
             "isNested": false,
             "title": ""
@@ -196,16 +192,14 @@ export default class ProductApi extends AsyncModules implements IProductApi {
           "conditionMarker": "equals",
           "attributeMarker": "color"
         }
-     * @return {IProductsResponse} Array with ProductEntity objects.
+     * @returns {IProductsResponse} Array with ProductEntity objects.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Search 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.
-     *
      * @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:
@@ -224,17 +218,14 @@ export default class ProductApi extends AsyncModules implements IProductApi {
      * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 0.
      * @param {string} [userQuery.sortOrder] - Optional sorting order "DESC" | "ASC". Example: "DESC".
      * @param {string} [userQuery.sortKey] - Optional field to sort by ("id", "title", "date", "price", "position", "status"). Example: "id".
-     *
-     * @return {IProductsResponse} Array with ProductEntity objects
+     * @returns {IProductsResponse} Array with ProductEntity objects
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description Find all related product page objects.
      */
     getRelatedProductsById(id: number, langCode?: string, userQuery?: IProductsQuery): Promise<IProductsResponse | IError>;
     /**
      * Find products by its ids.
-     *
      * @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:
@@ -258,51 +249,43 @@ export default class ProductApi extends AsyncModules implements IProductApi {
      * @param {string} [userQuery.conditionValue] - Optional value that is being searched. Example: "new".
      * @param {string} [userQuery.conditionMarker] - Optional identifier of the filter condition by which values are filtered. Example: "equals".
      * @param {string} [userQuery.attributeMarker] - Optional text identifier of the indexed attribute by which values are filtered. Example: "color".
-     * @return {IProductsEntity[]} Array with ProductEntity objects
+     * @returns {IProductsEntity[]} Array with ProductEntity objects
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description Find products by its ids.
      */
     getProductsByIds(ids: string, langCode?: string, userQuery?: IProductsQuery): Promise<IProductsEntity[] | IError>;
     /**
      * Retrieve one product object.
-     *
      * @handleName getProductById
-     *
      * @param {number} [id] - Product id. Example: 12345.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {IProductsEntity} ProductEntity object.
+     * @returns {IProductsEntity} ProductEntity object.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description Retrieve one product object.
      */
     getProductById(id: number, langCode?: string): Promise<IProductsEntity | IError>;
     /**
      * Getting a product block object by product id.
-     *
      * @handleName getProductBlockById
-     *
      * @param {number} id - Product id. Example: 12345.
-     * @return {IProductBlock} - Product block object.
+     * @returns {IProductBlock} - Product block object.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Getting a product block object by product id.
      */
     getProductBlockById(id: number): Promise<IProductBlock[] | IError>;
     /**
      * Quick search for product page objects with limited output.
-     *
      * @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".
-     * @return {IProductsEntity[]} Array with ProductEntity objects
+     * @returns {IProductsEntity[]} Array with ProductEntity objects
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description 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 {any[]} body - Body parameters for filter. Deault: []. Example:
         [
           {
@@ -316,17 +299,15 @@ export default class ProductApi extends AsyncModules implements IProductApi {
             "title": "Iphone 17 Pro"
           }
         ]
-     * @return {IProductsCount} Object with product items count.
+     * @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
+     * @param {string} id - Page ID.
      * @param {any[]} body - Body parameters for filter. Deault: []. Example:
         [
           {
@@ -340,17 +321,15 @@ export default class ProductApi extends AsyncModules implements IProductApi {
             "title": "Iphone 17 Pro"
           }
         ]
-     * @return {IProductsCount} Object with product items count.
+     * @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 for the catalog page by page url.
-     *
      * @handleName getProductsCountByPageUrl
-     *
-     * @param {string} url -
+     * @param {string} url - Page url.
      * @param {any[]} body - Body parameters for filter. Deault: []. Example:
         [
           {
@@ -364,7 +343,7 @@ export default class ProductApi extends AsyncModules implements IProductApi {
             "title": "Iphone 17 Pro"
           }
         ]
-     * @return {IProductsCount} Object with product items count.
+     * @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.
      */

package/dist/products/productsApi.js

@@ -3,12 +3,19 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable jsdoc/reject-any-type */
 const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 /**
  * Controllers for working with product pages
  * @handle /api/content/products
+ * @description Controllers for working with product pages
  */
 class ProductApi extends asyncModules_1.default {
+    /**
+     * Constructor
+     * @param {StateModule} state - StateModule instance
+     * @description Constructor initializes the ProductApi with a given state.
+     */
     constructor(state) {
         super(state);
         this._defaultQuery = {
@@ -21,9 +28,7 @@ class ProductApi extends asyncModules_1.default {
     }
     /**
      * Search for all products with pagination and filter.
-     *
      * @handleName getProducts
-     *
      * @param {IFilterParams[]} [body] - Request body. Default: []. Example:
         [
           {
@@ -61,7 +66,7 @@ class ProductApi extends asyncModules_1.default {
           "conditionMarker": "equals",
           "attributeMarker": "color"
         }
-     * @return {IProductsResponse} Array with ProductEntity objects
+     * @returns {IProductsResponse} Array with ProductEntity objects
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Fetch products with optional filters and pagination.
      */
@@ -76,9 +81,7 @@ class ProductApi extends asyncModules_1.default {
     }
     /**
      * Search for all product page objects with pagination that do not have a category.
-     *
      * @handleName getProductsEmptyPage
-     *
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {IProductsQuery} [userQuery] - Optional set query parameters. Example:
         {
@@ -92,7 +95,7 @@ class ProductApi extends asyncModules_1.default {
           "conditionMarker": "equals",
           "attributeMarker": "color"
         }
-     * @return {IProductsResponse} Array with ProductEntity objects.
+     * @returns {IProductsResponse} Array with ProductEntity objects.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Search for all product page objects with pagination that do not have a category.
      */
@@ -103,9 +106,7 @@ class ProductApi extends asyncModules_1.default {
     }
     /**
      * Search for all products with pagination for the selected category.
-     *
      * @handleName getProductsByPageId
-     *
      * @param {number} id - Page id. Example: 2492.
      * @param {IFilterParams[]} [body] - Request body. Default: []. Example:
         [
@@ -144,7 +145,7 @@ class ProductApi extends asyncModules_1.default {
           "conditionMarker": "equals",
           "attributeMarker": "color"
         }
-     * @return {IProductsResponse} Array with ProductEntity objects
+     * @returns {IProductsResponse} Array with ProductEntity objects
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Fetch products by page ID with optional filters and pagination.
      */
@@ -155,9 +156,7 @@ class ProductApi extends asyncModules_1.default {
     }
     /**
      * Search for information about products and prices for the selected category.
-     *
      * @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:
@@ -172,7 +171,7 @@ class ProductApi extends asyncModules_1.default {
           "conditionMarker": "equals",
           "attributeMarker": "color"
         }
-     * @return {IProductsInfo} Array with ProductInformation objects.
+     * @returns {IProductsInfo} Array with ProductInformation objects.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Search for information about products and prices for the selected category.
      */
@@ -187,9 +186,7 @@ class ProductApi extends asyncModules_1.default {
     }
     /**
      * Search for all products with pagination for the selected category.
-     *
      * @handleName getProductsByPageUrl
-     *
      * @param {string} url - Page url. Example: "catalog".
      * @param {IFilterParams[]} [body] - Request body. Default: []. Example:
         [
@@ -199,7 +196,7 @@ class ProductApi extends asyncModules_1.default {
             "statusMarker": "waiting",
             "conditionValue": 1,
             "pageUrls": [
-              "23-laminat-floorwood-maxima"
+            "23-laminat-floorwood-maxima"
             ],
             "isNested": false,
             "title": ""
@@ -209,7 +206,7 @@ class ProductApi extends asyncModules_1.default {
             "conditionMarker": "lth",
             "conditionValue": 3,
             "pageUrls": [
-              "23-laminat-floorwood-maxima"
+            "23-laminat-floorwood-maxima"
             ],
             "isNested": false,
             "title": ""
@@ -228,7 +225,7 @@ class ProductApi extends asyncModules_1.default {
           "conditionMarker": "equals",
           "attributeMarker": "color"
         }
-     * @return {IProductsResponse} Array with ProductEntity objects.
+     * @returns {IProductsResponse} Array with ProductEntity objects.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Search for all products with pagination for the selected category.
      */
@@ -240,9 +237,7 @@ class ProductApi extends asyncModules_1.default {
     }
     /**
      * Find all related product page 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:
@@ -261,8 +256,7 @@ class ProductApi extends asyncModules_1.default {
      * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 0.
      * @param {string} [userQuery.sortOrder] - Optional sorting order "DESC" | "ASC". Example: "DESC".
      * @param {string} [userQuery.sortKey] - Optional field to sort by ("id", "title", "date", "price", "position", "status"). Example: "id".
-     *
-     * @return {IProductsResponse} Array with ProductEntity objects
+     * @returns {IProductsResponse} Array with ProductEntity objects
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description Find all related product page objects.
      */
@@ -273,9 +267,7 @@ class ProductApi extends asyncModules_1.default {
     }
     /**
      * Find products by its ids.
-     *
      * @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:
@@ -299,7 +291,7 @@ class ProductApi extends asyncModules_1.default {
      * @param {string} [userQuery.conditionValue] - Optional value that is being searched. Example: "new".
      * @param {string} [userQuery.conditionMarker] - Optional identifier of the filter condition by which values are filtered. Example: "equals".
      * @param {string} [userQuery.attributeMarker] - Optional text identifier of the indexed attribute by which values are filtered. Example: "color".
-     * @return {IProductsEntity[]} Array with ProductEntity objects
+     * @returns {IProductsEntity[]} Array with ProductEntity objects
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description Find products by its ids.
      */
@@ -315,12 +307,10 @@ class ProductApi extends asyncModules_1.default {
     }
     /**
      * Retrieve one product object.
-     *
      * @handleName getProductById
-     *
      * @param {number} [id] - Product id. Example: 12345.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {IProductsEntity} ProductEntity object.
+     * @returns {IProductsEntity} ProductEntity object.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description Retrieve one product object.
      */
@@ -330,11 +320,9 @@ class ProductApi extends asyncModules_1.default {
     }
     /**
      * Getting a product block object by product id.
-     *
      * @handleName getProductBlockById
-     *
      * @param {number} id - Product id. Example: 12345.
-     * @return {IProductBlock} - Product block object.
+     * @returns {IProductBlock} - Product block object.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Getting a product block object by product id.
      */
@@ -344,12 +332,10 @@ class ProductApi extends asyncModules_1.default {
     }
     /**
      * Quick search for product page objects with limited output.
-     *
      * @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".
-     * @return {IProductsEntity[]} Array with ProductEntity objects
+     * @returns {IProductsEntity[]} Array with ProductEntity objects
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Quick search for product page objects with limited output.
      */
@@ -369,9 +355,7 @@ class ProductApi extends asyncModules_1.default {
     }
     /**
      * Getting the number of products for the entire catalog.
-     *
      * @handleName getProductsCount
-     *
      * @param {any[]} body - Body parameters for filter. Deault: []. Example:
         [
           {
@@ -385,7 +369,7 @@ class ProductApi extends asyncModules_1.default {
             "title": "Iphone 17 Pro"
           }
         ]
-     * @return {IProductsCount} Object with product items count.
+     * @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.
      */
@@ -397,10 +381,8 @@ class ProductApi extends asyncModules_1.default {
     }
     /**
      * Getting the number of products on a catalog page by page ID.
-     *
      * @handleName getProductsCountByPageId
-     *
-     * @param {string} id
+     * @param {string} id - Page ID.
      * @param {any[]} body - Body parameters for filter. Deault: []. Example:
         [
           {
@@ -414,7 +396,7 @@ class ProductApi extends asyncModules_1.default {
             "title": "Iphone 17 Pro"
           }
         ]
-     * @return {IProductsCount} Object with product items count.
+     * @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.
      */
@@ -426,10 +408,8 @@ class ProductApi extends asyncModules_1.default {
     }
     /**
      * Getting the number of products for the catalog page by page url.
-     *
      * @handleName getProductsCountByPageUrl
-     *
-     * @param {string} url -
+     * @param {string} url - Page url.
      * @param {any[]} body - Body parameters for filter. Deault: []. Example:
         [
           {
@@ -443,7 +423,7 @@ class ProductApi extends asyncModules_1.default {
             "title": "Iphone 17 Pro"
           }
         ]
-     * @return {IProductsCount} Object with product items count.
+     * @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.
      */