oneentry 1.0.122 → 1.0.124

package/dist/product-statuses/productStatusesInterfaces.d.ts

@@ -1,27 +1,55 @@
 import type { IError } from '../base/utils';
 /**
- * Represents an interface object of Product Statuses Api.
+ * @interface IProductStatuses
  *
  * @property {function} getProductStatuses - Search for all product status objects.
  * @property {function} getProductStatusesById - Search for a product status object by identifier.
  * @property {function} getProductsByStatusMarker - Search for a product status object by its textual identifier (marker).
  * @property {function} validateMarker - Check the existence of a textual identifier.
+ *
+ * @description This interface defines methods for retrieving and managing product statuses in the system.
  */
 interface IProductStatuses {
+    /**
+     * Search for all product status objects.
+     *
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {IProductStatusEntity[]} Returns an array of product status objects.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     getProductStatuses(langCode: string): Promise<Array<IProductStatusEntity> | IError>;
-    getProductStatusesById(id: number, langCode: string): Promise<IProductStatusEntity | IError>;
+    /**
+     * Search for a product status object by its textual identifier (marker).
+     *
+     * @param {string} marker - Product marker. Example: 'in_stock'.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {IProductStatusEntity} Returns a product status object.
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     */
     getProductsByStatusMarker(marker: string, langCode: string): Promise<IProductStatusEntity | IError>;
+    /**
+     * Check the existence of a textual identifier.
+     *
+     * @param {string} marker - Product marker. Example: 'in_stock'.
+     *
+     * @return {boolean} Returns true if the textual identifier (marker) exists or false if it doesn't.
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     */
     validateMarker(marker: string): Promise<boolean | IError>;
 }
 /**
- * Represents a position object.
+ * @interface IProductStatusEntity
+ *
+ * @property {number} id - The unique identifier of the position. Example: 12345.
+ * @property {number} version - The version number of the object. Example: 1.
+ * @property {string} identifier - The textual identifier for the record field. Example: 'in_stock'.
+ * @property {number} position - Position number. Example: 1.
+ * @property {Record<string, any>} localizeInfos - The name of the products statuses, taking into account localization. Example: .
+ * @property {boolean} isDefault - Default status flag. Example: true.
  *
- * @interface
- * @property {number} id - The unique identifier of the position.
- * @property {number} version - The version number of the object.
- * @property {string} identifier - The textual identifier for the record field.
- * @property {number} position - Position number.
- * @property {Record<string, any>} localizeInfos - The name of the products statuses, taking into account localization.
+ * @description This interface defines the structure of a product status entity, including its identifiers, localization information, position, and default status flag.
  */
 interface IProductStatusEntity {
     id: number;

package/dist/products/productsApi.d.ts

@@ -14,227 +14,207 @@ export default class ProductApi extends AsyncModules implements IProductApi {
     /**
      * Search for all products with pagination and filter.
      *
-     * @param {Array<IFilterParams>} [body] - Request body. Default [].
-     * @param {string} [langCode] - Language code parameter. Default "en_US"
+     * @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 {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.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 {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'.
+     *
+     * @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.
+     *
      */
     getProducts(body?: Array<IFilterParams>, langCode?: string, userQuery?: IProductsQuery): Promise<IProductsResponse | IError>;
     /**
      * Search for all product page objects with pagination that do not have a category.
      *
-     * @param {string} [langCode] - Language code parameter. Default "en_US"
+     * @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
-     * @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)
+     * @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'.
+     *
+     * @return {IProductsResponse} Array with ProductEntity objects.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      *
-     * @returns  Array with ProductEntity objects
+     * @description Fetch products with optional filters and pagination.
      */
     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.
-     * @param {Array<IFilterParams>} body - Request body.
-     * @param {string} [langCode] - Language code parameter. Default "en_US"
+     * @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} [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
-     * @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} [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'.
+     *
+     * @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.
+     *
      */
     getProductsByPageId(id: number, body?: Array<IFilterParams>, langCode?: string, userQuery?: IProductsQuery): Promise<IProductsResponse | IError>;
     /**
      * Search for information about products and prices for the selected category.
      *
-     * @param {string} [url] - Page url.
-     * @param {string} [langCode] - Language code.
+     * @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.
      *
-     * @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)
+     * @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'.
+     *
+     * @return {IProductsInfo} Array with ProductInformation objects.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      *
-     * @returns  Array with ProductInformation objects
+     * @description
      */
     getProductsPriceByPageUrl(url: string, langCode?: string, userQuery?: IProductsQuery): Promise<IProductsInfo | IError>;
     /**
      * Search for all products with pagination for the selected category.
      *
-     * @param {string} [url] - Page url.
-     * @param {Array<IFilterParams>} [body] - Request body.
-     * @param {string} [langCode] - Language code parameter. Default "en_US"
+     * @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} [langCode] - Language code. 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": ""
-     *   }
-     * ]
-     *
-     * @returns  Array with ProductEntity objects
+     * @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'.
+     *
+     * @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.
+     *
      */
     getProductsByPageUrl(url: string, body?: Array<IFilterParams>, langCode?: string, userQuery?: IProductsQuery): Promise<IProductsResponse | IError>;
     /**
      * Find all related product page objects.
      *
-     * @param {number} [id] - Product page identifier for which to find relationship.
-     * @param {string} [langCode] - Language code parameter. Default "en_US"
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
+     * @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: { offset: 0, limit: 30, sortOrder: 'DESC', sortKey: 'id' }.
+     *
+     * @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.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)
+     * @return {IProductsResponse} Array with ProductEntity objects
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      *
-     * @returns  Array with ProductEntity objects
+     * @description Find all related product page objects.
      */
     getRelatedProductsById(id: number, langCode?: string, userQuery?: IProductsQuery): Promise<IProductsResponse | IError>;
     /**
      * Find products by its ids.
      *
-     * @param {string} [ids] - Product page identifiers for which to find relationships.
-     * @param {string} [langCode] - Language code parameter. Default "en_US"
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
+     * @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: { offset: 0, limit: 30, sortOrder: 'DESC', sortKey: 'id' }.
+     *
+     * @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.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)
+     * @return {IProductEntity[]} Array with ProductEntity objects
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      *
-     * @returns  Array with ProductEntity objects
+     * @description Find products by its ids.
      */
     getProductsByIds(ids: string, langCode?: string, userQuery?: IProductsQuery): Promise<Array<IProductEntity> | IError>;
     /**
      * 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 {IProductEntity} 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<IProductEntity | IError>;
     /**
      * Getting a product block object by product id.
      *
-     * @param {number} [id] - Product id
+     * @handleName getProductBlockById
+     *
+     * @param {number} id - Product id. Example: 12345.
+     *
+     * @return {IProductBlock}
+     * @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<Array<IProductBlock> | IError>;
     /**
      * Quick search for product page objects with limited output.
      *
-     * @param {string} [name] - Text to search product page objects (search is based on the title field of the localizeInfos object with language consideration)
-     * @param {string} [langCode] - Language code
+     * @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
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      *
-     * @returns  Array with ProductEntity objects
+     * @description Quick search for product page objects with limited output.
      */
     searchProduct(name: string, langCode?: string): Promise<Array<IProductsEntity> | IError>;
 }