oneentry 1.0.124 → 1.0.125

package/dist/products/productsApi.js

@@ -4,7 +4,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const asyncModules_1 = __importDefault(require("../base/asyncModules"));
-// import { IProductInfo } from './productsInterfaces';
 /**
  * Controllers for working with product pages
  * @handle /api/content/products
@@ -25,25 +24,46 @@ class ProductApi extends asyncModules_1.default {
      *
      * @handleName getProducts
      *
-     * @param {Array<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 {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.
-     *
-     * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 0.
-     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 30.
-     * @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'.
-     * @param {number} [userQuery.statusId] - Optional parameter - search by status id. Example: 123.
-     * @param {string} [userQuery.statusMarker] - Optional identifier of the product page status. Example: 'in_stock'.
-     * @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'.
-     *
+     * @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
      * @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.
-     *
      */
     async getProducts(body = [], langCode = this.state.lang, userQuery) {
         const query = {
@@ -60,21 +80,21 @@ class ProductApi extends asyncModules_1.default {
      * @handleName getProductsEmptyPage
      *
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
-     *
-     * @param {number} [userQuery.offset] - Optional parameter for pagination, default is 0.
-     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 30.
-     * @param {string} [userQuery.statusMarker] - Optional identifier of the product page status. Example: 'in_stock'.
-     * @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'.
-     * @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'.
-     *
+     * @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.
      * @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.
+     * @description Search for all product page objects with pagination that do not have a category.
      */
     async getProductsEmptyPage(langCode = this.state.lang, userQuery) {
         const query = { ...this._defaultQuery, ...userQuery };
@@ -86,25 +106,47 @@ class ProductApi extends asyncModules_1.default {
      *
      * @handleName getProductsByPageId
      *
-     * @param {number} id - Page id.
-     * @param {Array<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 {number} id - Page id. Example: 2492.
+     * @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.
-     *
-     * @param {number} [userQuery.offset] - Optional parameter for pagination. Default is 0.
-     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default is 30.
-     * @param {string} [userQuery.statusMarker] - Optional identifier of the product page status. Example: 'in_stock'.
-     * @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'.
-     * @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'.
-     *
+     * @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
      * @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.
-     *
      */
     async getProductsByPageId(id, body = [], langCode = this.state.lang, userQuery) {
         const query = { ...this._defaultQuery, ...userQuery };
@@ -116,23 +158,23 @@ class ProductApi extends asyncModules_1.default {
      *
      * @handleName getProductsPriceByPageUrl
      *
-     * @param {string} [url] - Page url. Example: '23-laminat-floorwood-maxima'.
+     * @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.
-     *
-     * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 30.
-     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 0.
-     * @param {string} [userQuery.statusMarker] - Optional identifier of the product page status. Example: 'in_stock'.
-     * @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'.
-     * @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'.
-     *
+     * @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.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
-     *
-     * @description
+     * @description Search for information about products and prices for the selected category.
      */
     async getProductsPriceByPageUrl(url, langCode = this.state.lang, userQuery) {
         const query = {
@@ -148,25 +190,47 @@ class ProductApi extends asyncModules_1.default {
      *
      * @handleName getProductsByPageUrl
      *
-     * @param {string} url - Page url.
-     * @param {Array<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} url - Page url. Example: "catalog".
+     * @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.
-     *
-     * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 30.
-     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 0.
-     * @param {string} [userQuery.statusMarker] - Optional identifier of the product page status. Example: 'in_stock'.
-     * @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'.
-     * @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'.
-     *
+     * @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.
      * @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.
-     *
      */
     async getProductsByPageUrl(url, body = [], langCode = this.state.lang, userQuery) {
         const query = { ...this._defaultQuery, ...userQuery };
@@ -181,16 +245,25 @@ class ProductApi extends asyncModules_1.default {
      *
      * @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: { offset: 0, limit: 30, sortOrder: 'DESC', sortKey: 'id' }.
-     *
-     * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 0.
+     * @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"
+        }
      * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 30.
-     * @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'.
+     * @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
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
-     *
      * @description Find all related product page objects.
      */
     async getRelatedProductsById(id, langCode = this.state.lang, userQuery) {
@@ -203,18 +276,31 @@ class ProductApi extends asyncModules_1.default {
      *
      * @handleName getProductsByIds
      *
-     * @param {string} [ids] - Product page identifiers for which to find relationships. Example: '12345,67890'.
+     * @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: { offset: 0, limit: 30, sortOrder: 'DESC', sortKey: 'id' }.
-     *
-     * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 0.
+     * @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"
+        }
      * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 30.
-     * @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 {IProductEntity[]} Array with ProductEntity objects
+     * @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".
+     * @param {number} [userQuery.statusId] - Optional parameter - search by status id. Example: 123.
+     * @param {string} [userQuery.statusMarker] - Optional identifier of the product page status. Example: "in_stock".
+     * @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
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
-     *
      * @description Find products by its ids.
      */
     async getProductsByIds(ids, langCode = this.state.lang, userQuery) {
@@ -234,10 +320,8 @@ class ProductApi extends asyncModules_1.default {
      *
      * @param {number} [id] - Product id. Example: 12345.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     *
-     * @return {IProductEntity} ProductEntity object.
+     * @return {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.
      */
     async getProductById(id, langCode = this.state.lang) {
@@ -250,10 +334,8 @@ class ProductApi extends asyncModules_1.default {
      * @handleName getProductBlockById
      *
      * @param {number} id - Product id. Example: 12345.
-     *
-     * @return {IProductBlock}
+     * @return {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.
      */
     async getProductBlockById(id) {
@@ -265,12 +347,10 @@ class ProductApi extends asyncModules_1.default {
      *
      * @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} 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
      * @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.
      */
     async searchProduct(name, langCode = this.state.lang) {
@@ -287,5 +367,91 @@ class ProductApi extends asyncModules_1.default {
         }
         return searchProducts;
     }
+    /**
+     * Getting the number of products for the entire catalog.
+     *
+     * @handleName getProductsCount
+     *
+     * @param {any[]} body - Body parameters for filter. Deault: []. Example:
+        [
+          {
+            "attributeMarker": "price",
+            "conditionMarker": "in",
+            "statusMarker": "status_1",
+            "conditionValue": {},
+            "pageUrls": [
+              "23-laminat-floorwood-maxima"
+            ],
+            "title": "Iphone 17 Pro"
+          }
+        ]
+     * @return {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.
+     */
+    async getProductsCount(
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    body = []) {
+        const result = await this._fetchPost(`/all/counts`, body);
+        return result;
+    }
+    /**
+     * Getting the number of products on a catalog page by page ID.
+     *
+     * @handleName getProductsCountByPageId
+     *
+     * @param {string} id
+     * @param {any[]} body - Body parameters for filter. Deault: []. Example:
+        [
+          {
+            "attributeMarker": "price",
+            "conditionMarker": "in",
+            "statusMarker": "status_1",
+            "conditionValue": {},
+            "pageUrls": [
+              "23-laminat-floorwood-maxima"
+            ],
+            "title": "Iphone 17 Pro"
+          }
+        ]
+     * @return {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.
+     */
+    async getProductsCountByPageId(id, 
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    body = []) {
+        const result = await this._fetchPost(`/page/${id}/counts`, body);
+        return result;
+    }
+    /**
+     * Getting the number of products for the catalog page by page url.
+     *
+     * @handleName getProductsCountByPageUrl
+     *
+     * @param {string} url -
+     * @param {any[]} body - Body parameters for filter. Deault: []. Example:
+        [
+          {
+            "attributeMarker": "price",
+            "conditionMarker": "in",
+            "statusMarker": "status_1",
+            "conditionValue": {},
+            "pageUrls": [
+              "23-laminat-floorwood-maxima"
+            ],
+            "title": "Iphone 17 Pro"
+          }
+        ]
+     * @return {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.
+     */
+    async getProductsCountByPageUrl(url, 
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    body = []) {
+        const result = await this._fetchPost(`/page/url/${url}/counts`, body);
+        return result;
+    }
 }
 exports.default = ProductApi;