oneentry 1.0.123 → 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
@@ -23,46 +22,48 @@ class ProductApi extends asyncModules_1.default {
     /**
      * Search for all products with pagination and filter.
      *
-     * @param {Array<IFilterParams>} [body] - Request body. Default [].
-     * @param {string} [langCode] - Language code parameter. Default "en_US"
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
+     * @handleName getProducts
      *
-     * @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.sortOrder] - Optional sorting order DESC | ASC
-     * @param {string} [userQuery.sortKey] - Optional field to sort by (id, title, date, price, position, status)
-     * @param {number} [userQuery.statusId] - Optional parameter - search by status id
-     * @param {string} [userQuery.statusMarker] - Optional identifier of the product page status
-     * @param {string} [userQuery.conditionValue] - Optional value that is being searched
-     * @param {string} [userQuery.conditionMarker] - Optional identifier of the filter condition by which values are filtered
-     * @param {string} [userQuery.attributeMarker] - Optional text identifier of the indexed attribute by which values are filtered
-     *
-     * @example
-     * const body: IFilterParams[] = [
-     *   {
-     *     "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": ""
-     *   }
-     * ]
-     *
-     * @returns  Array with ProductEntity objects
+     * @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
+     * @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 = {
@@ -76,19 +77,24 @@ class ProductApi extends asyncModules_1.default {
     /**
      * Search for all product page objects with pagination that do not have a category.
      *
-     * @param {string} [langCode] - Language code parameter. Default "en_US"
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
+     * @handleName getProductsEmptyPage
      *
-     * @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
-     * @param {string} [userQuery.conditionValue] - Optional value that is being searched
-     * @param {string} [userQuery.conditionMarker] - Optional identifier of the filter condition by which values are filtered
-     * @param {string} [userQuery.attributeMarker] - Optional text identifier of the indexed attribute by which values are filtered
-     * @param {string} [userQuery.sortOrder] - Optional sorting order DESC | ASC
-     * @param {string} [userQuery.sortKey] - Optional field to sort by (id, title, date, price, position, status)
-     *
-     * @returns  Array with ProductEntity objects
+     * @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.
+     * @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.
      */
     async getProductsEmptyPage(langCode = this.state.lang, userQuery) {
         const query = { ...this._defaultQuery, ...userQuery };
@@ -98,46 +104,49 @@ class ProductApi extends asyncModules_1.default {
     /**
      * Search for all products with pagination for the selected category.
      *
-     * @param {number} id - Page id.
-     * @param {Array<IFilterParams>} body - Request body.
-     * @param {string} [langCode] - Language code parameter. Default "en_US"
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
+     * @handleName getProductsByPageId
      *
-     * @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
-     * @param {string} [userQuery.conditionValue] - Optional value that is being searched
-     * @param {string} [userQuery.conditionMarker] - Optional identifier of the filter condition by which values are filtered
-     * @param {string} [userQuery.attributeMarker] - Optional text identifier of the indexed attribute by which values are filtered
-     * @param {string} [userQuery.sortOrder] - Optional sorting order DESC | ASC
-     * @param {string} [userQuery.sortKey] - Optional field to sort by (id, title, date, price, position, status)
-     *
-     * @example
-     * const body = [
-     *   {
-     *     "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": ""
-     *   }
-     * ]
-     *
-     * @returns  Array with ProductEntity objects
+     * @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. 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 };
@@ -147,20 +156,25 @@ class ProductApi extends asyncModules_1.default {
     /**
      * Search for information about products and prices for the selected category.
      *
-     * @param {string} [url] - Page url.
-     * @param {string} [langCode] - Language code.
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
-     *
-     * @param {number} [userQuery.offset] - Optional parameter for pagination, default is 30
-     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 0
-     * @param {string} [userQuery.statusMarker] - Optional identifier of the product page status
-     * @param {string} [userQuery.conditionValue] - Optional value that is being searched
-     * @param {string} [userQuery.conditionMarker] - Optional identifier of the filter condition by which values are filtered
-     * @param {string} [userQuery.attributeMarker] - Optional text identifier of the indexed attribute by which values are filtered
-     * @param {string} [userQuery.sortOrder] - Optional sorting order DESC | ASC
-     * @param {string} [userQuery.sortKey] - Optional field to sort by (id, title, date, price, position, status)
+     * @handleName getProductsPriceByPageUrl
      *
-     * @returns  Array with ProductInformation objects
+     * @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.
+     * @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.
      */
     async getProductsPriceByPageUrl(url, langCode = this.state.lang, userQuery) {
         const query = {
@@ -174,46 +188,49 @@ class ProductApi extends asyncModules_1.default {
     /**
      * Search for all products with pagination for the selected category.
      *
-     * @param {string} [url] - Page url.
-     * @param {Array<IFilterParams>} [body] - Request body.
-     * @param {string} [langCode] - Language code parameter. Default "en_US"
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
-     *
-     * @param {number} [userQuery.offset] - Optional parameter for pagination, default is 30
-     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 0
-     * @param {string} [userQuery.statusMarker] - Optional identifier of the product page status
-     * @param {string} [userQuery.conditionValue] - Optional value that is being searched
-     * @param {string} [userQuery.conditionMarker] - Optional identifier of the filter condition by which values are filtered
-     * @param {string} [userQuery.attributeMarker] - Optional text identifier of the indexed attribute by which values are filtered
-     * @param {string} [userQuery.sortOrder] - Optional sorting order DESC | ASC
-     * @param {string} [userQuery.sortKey] - Optional field to sort by (id, title, date, price, position, status)
-     *
-     * @example
-     * const body = [
-     *   {
-     *     "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": ""
-     *   }
-     * ]
+     * @handleName getProductsByPageUrl
      *
-     * @returns  Array with ProductEntity objects
+     * @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. 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 };
@@ -224,16 +241,30 @@ class ProductApi extends asyncModules_1.default {
     /**
      * Find all related product page objects.
      *
-     * @param {number} [id] - Product page identifier for which to find relationship.
-     * @param {string} [langCode] - Language code parameter. Default "en_US"
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
+     * @handleName getRelatedProductsById
      *
-     * @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.sortOrder] - Optional sorting order DESC | ASC
-     * @param {string} [userQuery.sortKey] - Optional field to sort by (id, title, date, price, position, status)
+     * @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"
+        }
+     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 30.
+     * @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".
      *
-     * @returns  Array with ProductEntity objects
+     * @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) {
         const query = { ...this._defaultQuery, ...userQuery };
@@ -243,16 +274,34 @@ class ProductApi extends asyncModules_1.default {
     /**
      * Find products by its ids.
      *
-     * @param {string} [ids] - Product page identifiers for which to find relationships.
-     * @param {string} [langCode] - Language code parameter. Default "en_US"
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
+     * @handleName getProductsByIds
      *
-     * @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.sortOrder] - Optional sorting order DESC | ASC
-     * @param {string} [userQuery.sortKey] - Optional field to sort by (id, title, date, price, position, status)
-     *
-     * @returns  Array with ProductEntity objects
+     * @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"
+        }
+     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 30.
+     * @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) {
         const query = {
@@ -267,10 +316,13 @@ class ProductApi extends asyncModules_1.default {
     /**
      * Retrieve one product object.
      *
-     * @param {number} [id] - Product id.
-     * @param {string} [langCode] - Language code parameter. Default "en_US".
+     * @handleName getProductById
      *
-     * @returns  ProductEntity object.
+     * @param {number} [id] - Product id. Example: 12345.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @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) {
         const result = await this._fetchGet(`/${id}?langCode=${langCode}`);
@@ -279,7 +331,12 @@ class ProductApi extends asyncModules_1.default {
     /**
      * Getting a product block object by product id.
      *
-     * @param {number} [id] - Product id
+     * @handleName getProductBlockById
+     *
+     * @param {number} id - Product id. Example: 12345.
+     * @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) {
         const response = await this._fetchGet(`/${id}/blocks`);
@@ -288,10 +345,13 @@ class ProductApi extends asyncModules_1.default {
     /**
      * 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)
-     * @param {string} [langCode] - Language code
+     * @handleName searchProduct
      *
-     * @returns  Array with ProductEntity objects
+     * @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) {
         const searchProducts = await this._fetchGet(`/quick/search?langCode=${langCode}&name=${name}`);
@@ -307,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;