oneentry 1.0.140 → 1.0.141

package/dist/products/productsApi.d.ts

@@ -0,0 +1,365 @@
+import AsyncModules from '../base/asyncModules';
+import type StateModule from '../base/stateModule';
+import type { IError } from '../base/utils';
+import type { IFilterParams, IProductBlock, IProductsApi, IProductsCount, IProductsEntity, IProductsInfo, IProductsQuery, IProductsResponse } from './productsInterfaces';
+/**
+ * Controllers for working with product pages
+ * @handle /api/content/products
+ * @description Controllers for working with product pages
+ */
+export default class ProductsApi extends AsyncModules implements IProductsApi {
+    protected state: StateModule;
+    protected _url: string;
+    /**
+     * Constructor
+     * @param {StateModule} state - StateModule instance
+     * @description Constructor initializes the ProductsApi with a given state.
+     */
+    constructor(state: StateModule);
+    /**
+     * Search for all products with pagination and filter.
+     * @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
+        {
+          "signPrice": "orders",
+          "sortOrder": "DESC",
+          "sortKey": "id",
+          "limit": 30,
+          "offset": 0,
+          "statusId": 123,
+          "statusMarker": "in_stock",
+          "conditionValue": "new",
+          "conditionMarker": "equals",
+          "attributeMarker": "color"
+        }
+     * @returns {Promise<IProductsResponse | IError>} Products response, or IError when isShell=true
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @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
+        {
+          "limit": 30,
+          "offset": 0,
+          "sortOrder": "DESC",
+          "sortKey": "id",
+          "statusId": 123,
+          "statusMarker": "in_stock",
+          "conditionValue": "new",
+          "conditionMarker": "equals",
+          "attributeMarker": "color"
+        }
+     * @returns {Promise<IProductsResponse | IError>} Array with ProductEntity objects.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @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
+        [
+          {
+            "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 {Promise<IProductsResponse | IError>} Array with ProductEntity objects
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @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
+        {
+          "limit": 30,
+          "offset": 0,
+          "sortOrder": "DESC",
+          "sortKey": "id",
+          "statusId": 123,
+          "statusMarker": "in_stock",
+          "conditionValue": "new",
+          "conditionMarker": "equals",
+          "attributeMarker": "color"
+        }
+     * @returns {Promise<IProductsInfo | IError>} Array with ProductInformation objects.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @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
+        [
+          {
+            "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 {Promise<IProductsResponse | IError>} Array with ProductEntity objects.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @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
+        {
+          "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 {Promise<IProductsResponse | IError>} Array with ProductEntity objects
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @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
+        {
+          "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".
+     * @returns {Promise<IProductsEntity[] | IError>} Array with ProductEntity objects
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @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".
+     * @param {boolean} [isNormalized] - If true, the product object will be normalized.
+     * @returns {Promise<IProductsEntity | IError>} ProductEntity object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Retrieve one product object.
+     */
+    getProductById(id: number, langCode?: string, isNormalized?: boolean): Promise<IProductsEntity | IError>;
+    /**
+     * Getting a product block object by product id.
+     * @handleName getProductBlockById
+     * @param {number} id - Product id. Example: 12345.
+     * @returns {Promise<IProductBlock | IError>} - Product block object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @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".
+     * @returns {Promise<IProductsEntity[] | IError>} Array with ProductEntity objects
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @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
+        [
+          {
+            "attributeMarker": "price",
+            "conditionMarker": "in",
+            "statusMarker": "status_1",
+            "conditionValue": {},
+            "pageUrls": [
+              "23-laminat-floorwood-maxima"
+            ],
+            "title": "Iphone 17 Pro"
+          }
+        ]
+     * @returns {Promise<IProductsCount | IError>} Object with product items count.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @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.
+     * @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"
+          }
+        ]
+     * @returns {Promise<IProductsCount | IError>} Object with product items count.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @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 - Page 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"
+          }
+        ]
+     * @returns {Promise<IProductsCount | IError>} Object with product items count.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method calculates and returns the number of products available on a given catalog page, identified by its URL, with optional filtering.
+     */
+    getProductsCountByPageUrl(url: string, body?: any[]): Promise<IProductsCount | IError>;
+}