oneentry 1.0.123 → 1.0.124

package/dist/products/productsInterfaces.d.ts

@@ -1,6 +1,6 @@
 import type { AttributeType, IError, LangType, Types } from '../base/utils';
 /**
- * Represents an interface object of Products Api.
+ * @interface IProductApi
  *
  * @property {function} getProducts - Search for all product page objects with pagination and filtering.
  * @property {function} getProductsEmptyPage - Search for all product page objects with pagination that do not have a category.
@@ -11,31 +11,190 @@ import type { AttributeType, IError, LangType, Types } from '../base/utils';
  * @property {function} getProductById - Retrieve one product object.
  * @property {function} getProductBlockById - Getting a product block object by product id.
  * @property {function} searchProduct - Quick search for product page objects with limited output.
+ *
+ * @description This interface defines methods for retrieving and managing products in the system.
  */
 interface IProductApi {
+    /**
+     * Search for all products with pagination and filter.
+     *
+     * @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: 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 This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
+     */
     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. 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.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.
+     */
     getProductsEmptyPage(langCode?: LangType, userQuery?: IProductsQuery): Promise<IProductsResponse | IError>;
+    /**
+     * Search for all products with pagination for the selected category.
+     *
+     * @param {number} id - Page id. Example: 12345.
+     * @param {Array<IFilterParams>} [body] - Request body. Default: [].
+     * @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.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.
+     */
     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. 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'.
+     *
+     * @return {IProductsInfo} Array with ProductInformation objects.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     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. Example: '23-laminat-floorwood-maxima'.
+     * @param {Array<IFilterParams>} [body] - Request body. Default: [].
+     * @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'.
+     *
+     * @return {IProductsResponse} Array with ProductEntity objects.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     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. Example: 12345.
+     * @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'.
+     *
+     * @return {IProductsResponse} Array with ProductEntity objects
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     */
     getRelatedProductsById(id: number, langCode?: string, userQuery?: IProductsQuery): Promise<IProductsResponse | IError>;
-    getProductById(id: number, langCode: string): Promise<IProductEntity | IError>;
+    /**
+     * Find products by its ids.
+     *
+     * @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.
+     *
+     * @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. Default: 'DESC'.
+     * @param {string} [userQuery.sortKey] - Optional field to sort by (id, title, date, price, position, status). Default: 'id'.
+     *
+     * @return {IProductEntity[]} Array with ProductEntity objects
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     */
+    getProductsByIds(ids: string, langCode?: string, userQuery?: IProductsQuery): Promise<Array<IProductEntity> | IError>;
+    /**
+     * Retrieve one product 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.
+     */
+    getProductById(id: number, langCode?: string): Promise<IProductEntity | IError>;
+    /**
+     * Getting a product block object by product id.
+     *
+     * @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.
+     */
     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). 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.
+     */
     searchProduct(name: string, langCode: string): Promise<Array<IProductsEntity> | IError>;
 }
 /**
- * Represents a product query parameters object.
- *
- * @interface
- * @property {number} offset - Parameter for pagination, default 0.
- * @property {number} limit - Parameter for pagination, default 30.
- * @property {string | null} statusMarker - Product page status id, default null.
- * @property {string | null} conditionValue - The value that is being searched for, default null.
- * @property {string | null} conditionMarker - Id of the filter condition by which the values are filtered, default null.
- * @property {string | null} attributeMarker - The text identifier of the indexed attribute by which values are filtered, default null.
- * @property {string} sortOrder - Sort order 'DESC' | 'ASC', default 'DESC'.
- * @property {string} langCode - localization language code (used only when searching with a filter, default 'en_US'.
- * @property {string} sortKey - Field for sorting (default - null)
+ * @interface IProductsQuery
+ *
+ * @property {number} offset - Parameter for pagination. Default: 0.
+ * @property {number} limit - Parameter for pagination. Default: 30.
+ * @property {string} sortOrder - Sort order 'DESC' | 'ASC'. Default: 'DESC'.
+ * @property {string} sortKey - Field for sorting (default - null). Possible values: 'id', 'position', 'title', 'date', 'price'. Default: null.
+ * @property {string | null} [templateMarker] - Product page status id, default null. Example: 'template_12345'.
+ * @property {string | null} [statusMarker] - Product page status id, default null. Example: 'in_stock'.
+ * @property {string | null} [conditionValue] - The value that is being searched for, default null. Example: 'new'.
+ * @property {string | null} [attributeMarker] - The text identifier of the indexed attribute by which values are filtered, default null. Example: 'color'.
+ * @property {string | null} [conditionMarker] - Id of the filter condition by which the values are filtered, default null. Example: 'equals'.
+ *
+ * @description This interface defines the structure of a query for retrieving products, including pagination, sorting, and filtering parameters.
  */
 interface IProductsQuery {
     offset: number;
@@ -50,15 +209,17 @@ interface IProductsQuery {
     [key: string]: any;
 }
 /**
- * Represents a product POST data object.
- *
- * @interface
- * @property {number | null} conditionValue - The value that is being searched for, default null.
- * @property {string | null} conditionMarker - Id of the filter condition by which the values are filtered, default null.
- * @property {string | null} attributeMarker - The text identifier of the indexed attribute by which values are filtered, default null.
- * @property {Array<string> | null} pageUrl - Url of the category page object.
- * @property {string | null} statusMarker - Text identifier of the product page status (default not set).
- * @property {string | null} title - Product name.
+ * @interface IFilterParams
+ *
+ * @property {string | null} attributeMarker - The text identifier of the indexed attribute by which values are filtered, default null. Example: 'color'.
+ * @property {string | null} [conditionMarker] - Id of the filter condition by which the values are filtered, default null. Example: 'equals'.
+ * @property {number | null} conditionValue - The value that is being searched for, default null. Example: 'new'.
+ * @property {Array<string> | null} [pageUrl] - Url of the category page object. Example: ['23-laminat-floorwood-maxima'].
+ * @property {string | null} [statusMarker] - Text identifier of the product page status (default not set). Example: 'in_stock'.
+ * @property {string | null} [title] - Product name. Example: 'Laminatboden Maxima'.
+ * @property {boolean} [isNested] - Flag for nested attributes, default false. Example: true.
+ *
+ * @description This interface defines the structure of filter parameters used for querying products, including conditions, attributes, and pagination.
  */
 interface IFilterParams {
     attributeMarker: string;
@@ -70,23 +231,26 @@ interface IFilterParams {
     isNested?: boolean;
 }
 /**
- * Represents a product entity object.
- *
- * @interface
- * @property {number} id - The unique identifier.
- * @property {object} additional - Additional value from the index.
- * @property {Record<string, any>} localizeInfos - The name of the products, taking into account localization.
- * @property {boolean} isVisible - A sign of page visibility.
- * @property {boolean} isPositionLocked - Sorting position lock indicator (optional).
- * @property {number | null} statusIdentifier - Product page status identifiers (may be null).
- * @property {Array<number>} relatedIds - Ids of related product pages.
- * @property {string} attributeSetIdentifier - Set of attributes id.
- * @property {boolean} isSync - Indication of page indexing.
- * @property {number} price - The value of the product page price taken from the index.
- * @property {string} templateIdentifier - User id of the linked template.
- * @property {string} shortDescTemplateIdentifier - User id of the linked template for a short description.
- * @property {Record<string, any>} statusLocalizeInfos - JSON description of the item status object, taking into account the language.
- * @property {number} position - Item number (for sorting).
+ * @interface IProductsEntity
+ *
+ * @property {number} id - The unique identifier. Example: 12345.
+ * @property {AttributeType} attributeValues - Array of attribute values from the index, represented. Example: [{ id: 'color', value: 'red' }].
+ * @property {object} additional - Additional value from the index. Example: { prices: { min: 100, max: 200 } }.
+ * @property {Record<string, any>} localizeInfos - The name of the products, taking into account localization. Example: .
+ * @property {boolean} isVisible - A sign of page visibility. Example: true.
+ * @property {boolean} isPositionLocked - Sorting position lock indicator (optional). Example: false.
+ * @property {number | null} statusIdentifier - Product page status identifiers (may be null). Example: 'in_stock'.
+ * @property {Array<number>} relatedIds - Ids of related product pages. Example: [12345, 67890].
+ * @property {string} attributeSetIdentifier - Set of attributes id. Example: 'set_12345'.
+ * @property {boolean} isSync - Indication of page indexing. Example: true.
+ * @property {number} price - The value of the product page price taken from the index. Example: 150.00.
+ * @property {string | null} templateIdentifier - User id of the linked template. Example: 'template_12345'.
+ * @property {string | null} shortDescTemplateIdentifier - User id of the linked template for a short description. Example: 'short_desc_template_12345'.
+ * @property {Record<string, any>} statusLocalizeInfos - JSON description of the item status object, taking into account the language. Example: { en: 'In Stock', de: 'Auf Lager' }.
+ * @property {number} position - Item number (for sorting). Example: 1.
+ * @property {string | null} sku - Product SKU (Stock Keeping Unit), may be null. Example: 'SKU_12345'.
+ *
+ * @description This interface defines the structure of a product entity, including its identifiers, attributes, and related information.
  */
 interface IProductsEntity {
     id: number;
@@ -111,51 +275,70 @@ interface IProductsEntity {
     sku: string | null;
 }
 /**
- * IProductEntity
+ * @interface IProductEntity
  *
- * @interface
- * @property {Array<string>} blocks
- * @property {Array<Record<string, any>> | Record<string, any>} productPages
+ * @property {Array<string>} [blocks] - Array of block identifiers. Example: ['block_12345', 'block_67890'].
+ * @property {Array<Record<string, any>> | Record<string, any>} [productPages] - Array of product pages or a single product page object. Example: [{ id: 12345, title: 'Product 1' }, { id: 67890, title: 'Product 2' }].
+ *
+ * @description This interface extends the IProductsEntity interface to include additional properties specific to product entities, such as blocks and product pages.
  */
 interface IProductEntity extends IProductsEntity {
     blocks?: Array<string>;
     productPages?: Array<Record<string, any>> | Record<string, any>;
 }
 /**
- * IProductsResponse
+ * @interface IProductsResponse
+ *
+ * @property {number} total - The total number of products found. Example: 100.
+ * @property {Array<IProductsEntity>} items - An array of product entities. Example: [{ id: 12345, title: 'Product 1' }, { id: 67890, title: 'Product 2' }].
  *
- * @interface
- * @property {number} total
- * @property {Array<IProductsEntity>} items
+ * @description This interface defines the structure of a response containing multiple product entities, including the total count and an array of product items.
  */
 interface IProductsResponse {
     total: number;
     items: Array<IProductsEntity>;
 }
 /**
- * IProductsInfo
+ * @interface IProductsInfo
+ *
+ * @property {number} total - The total number of products found. Example: 100.
+ * @property {Array<IProductInfo>} items - An array of product information objects. Example: [{ id: 12345, price: 150.00 }, { id: 67890, price: 200.00 }].
  *
- * @interface
- * @property {number} total
- * @property {Array<IProductInfo>} items
+ * @description This interface defines the structure of a response containing product information, including the total count and an array of product items.
  */
 interface IProductsInfo {
     total: number;
     items: Array<IProductInfo>;
 }
 /**
- * IProductInfo
+ * @interface IProductInfo
  *
- * @interface
- * @property {number} id
- * @property {number} price
+ * @property {number} id - The unique identifier of the product. Example: 12345.
+ * @property {number} price - The price of the product. Example: 150.00.
+ *
+ * @description This interface defines the structure of a product information object, including its identifier and price.
  */
 interface IProductInfo {
     id: number;
     price: number;
 }
 /**
- * IProductBlock
+ * @interface IProductBlock
+ *
+ * @property {number} id - Unique identifier of the product block. Example: 12345.
+ * @property {number | null} attributeSetIdentifier - Identifier of the attribute set used in the product block, or null if not applicable. Example: 67890.
+ * @property {Record<string, any>} localizeInfos - Localization information for the product block. Example: .
+ * @property {number} version - Version of the product block entity. Example: 1.
+ * @property {number} position - Position of the product block in a list or layout. Example: 1.
+ * @property {string} identifier - Unique string identifier for the product block. Example: 'product_block_12345'.
+ * @property {Types} type - Type of the product block, such as 'product', 'error_page', etc. Example: 'product'.
+ * @property {object} customSettings - Custom settings for the product block, including slider delay, product configuration, similar product rules, and conditions. Example: .
+ * @property {string | null} templateIdentifier - Identifier for the template used by the product block, or null if not applicable. Example: 'template_12345'.
+ * @property {boolean} isVisible - Indicates whether the product block is visible. Example: true.
+ * @property {boolean} isSync - Indicates whether the product block is synchronized. Example: false.
+ * @property {AttributeType} attributeValues - Array of attribute values from the index, represented as a pair of user attribute id and attribute value. Example: [{ id: 'color', value: 'red' }].
+ *
+ * @description This interface defines the structure of a product block entity, including its identifiers, attributes, and custom settings.
  */
 interface IProductBlock {
     id: number;

package/dist/system/systemApi.d.ts

@@ -11,22 +11,41 @@ export default class SystemApi extends AsyncModules implements ISystem {
     protected _url: string;
     constructor(state: StateModule);
     /**
-     * test404
-     * @returns
+     * Sends a GET request to the '/test404' endpoint and returns the result.
+     *
+     * @handleName test404
+     *
+     * @return {any} The response from the server after fetching data from the '/test404' endpoint.
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description This method is used to test the 404 error handling by sending a GET request to a specific endpoint.
      */
     test404(): Promise<any>;
     /**
-     * test500
-     * @returns
+     * Sends a GET request to the '/test500' endpoint and returns the result.
+     *
+     * @handleName test500
+     *
+     * @return {any} The response from the server after fetching data from the '/test500' endpoint.
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description This method is used to test the 500 error handling by sending a GET request to a specific endpoint.
      */
     test500(): Promise<any>;
     /**
-     * validateCapcha
-     * @param event
-     * @param event.token -
-     * @param event.expectedAction -
-     * @param event.siteKey -
-     * @returns
+     * Validates a CAPTCHA token by sending it to the server for verification.
+     *
+     * @handleName validateCapcha
+     *
+     * @param {Object} event - The event object containing CAPTCHA data.
+     * @param {string} event.token - The CAPTCHA token to be validated. Example: '03AGdBq24...'.
+     * @param {string} event.expectedAction - The expected action associated with the CAPTCHA. Example: 'login'.
+     * @param {string} event.siteKey - The site key used for the CAPTCHA. Example: '6Lc_aCMTAAAAAB...'.
+     *
+     * @return {any} The response from the server after validating the CAPTCHA, or an error object if validation fails.
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description This method sends the CAPTCHA token and related information to the server endpoint '/captcha/validate' to verify its validity.
      */
     validateCapcha(event: {
         token: string;

package/dist/system/systemApi.js

@@ -15,28 +15,47 @@ class SystemApi extends asyncModules_1.default {
         this._url = state.url + '/api/content/system';
     }
     /**
-     * test404
-     * @returns
+     * Sends a GET request to the '/test404' endpoint and returns the result.
+     *
+     * @handleName test404
+     *
+     * @return {any} The response from the server after fetching data from the '/test404' endpoint.
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description This method is used to test the 404 error handling by sending a GET request to a specific endpoint.
      */
     async test404() {
         const result = await this._fetchGet('/test404');
         return result;
     }
     /**
-     * test500
-     * @returns
+     * Sends a GET request to the '/test500' endpoint and returns the result.
+     *
+     * @handleName test500
+     *
+     * @return {any} The response from the server after fetching data from the '/test500' endpoint.
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description This method is used to test the 500 error handling by sending a GET request to a specific endpoint.
      */
     async test500() {
         const result = await this._fetchGet('/test500');
         return result;
     }
     /**
-     * validateCapcha
-     * @param event
-     * @param event.token -
-     * @param event.expectedAction -
-     * @param event.siteKey -
-     * @returns
+     * Validates a CAPTCHA token by sending it to the server for verification.
+     *
+     * @handleName validateCapcha
+     *
+     * @param {Object} event - The event object containing CAPTCHA data.
+     * @param {string} event.token - The CAPTCHA token to be validated. Example: '03AGdBq24...'.
+     * @param {string} event.expectedAction - The expected action associated with the CAPTCHA. Example: 'login'.
+     * @param {string} event.siteKey - The site key used for the CAPTCHA. Example: '6Lc_aCMTAAAAAB...'.
+     *
+     * @return {any} The response from the server after validating the CAPTCHA, or an error object if validation fails.
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description This method sends the CAPTCHA token and related information to the server endpoint '/captcha/validate' to verify its validity.
      */
     async validateCapcha(event) {
         const data = {

package/dist/system/systemInterfaces.d.ts

@@ -1,3 +1,11 @@
+/**
+ * @interface ISystem
+ *
+ * @property {function} test404 - Test 404 error.
+ * @property {function} test500 - Test 500 error.
+ *
+ * @description Represents a interface object of System Api.
+ */
 interface ISystem {
     test404(): Promise<any>;
     test500(): Promise<any>;

package/dist/templates/templatesApi.d.ts

@@ -4,7 +4,11 @@ import type { IError, Types } from '../base/utils';
 import type { ITemplateEntity, ITemplatesApi } from './templatesInterfaces';
 /**
  * Controllers for working with template objects
+ *
+ * @module TemplateController
  * @handle /api/content/templates
+ *
+ * @description This module provides a set of controllers for handling operations related to template objects.
  */
 export default class TemplatesPreviewApi extends AsyncModules implements ITemplatesApi {
     protected state: StateModule;
@@ -13,36 +17,42 @@ export default class TemplatesPreviewApi extends AsyncModules implements ITempla
     /**
      * Get all template objects grouped by types.
      *
-     * @param {string} [langCode] - Optional parameter language code
+     * @handleName getAllTemplates
      *
-     * @returns Returns an object GroupedTemplatesObject, which contains an array of template objects TemplateEntity
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {Record<Types, ITemplateEntity>} Returns an object GroupedTemplatesObject, which contains an array of template objects TemplateEntity
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description This function is designed to fetch organized template objects in groups based on their types.
      */
     getAllTemplates(langCode?: string): Promise<Record<Types, ITemplateEntity> | IError>;
     /**
      * Get template objects by type.
      *
-     * @param {Types} [type] - type
-     * @param {string} [langCode] - Optional parameter language code
+     * @handleName getTemplateByType
+     *
+     * @param {Types} type - The type of templates to retrieve. This parameter specifies the category or classification of templates being requested. Example: 'product'.
+     * @param {string} [langCode] - Language code. Default: "en_US".
      *
-     * @returns Returns a TemplateEntity object
+     * @return {TemplateEntity[]} Returns a TemplateEntity object.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description Fetch template objects that belong to a specific type, with an optional filter by language.
      */
     getTemplateByType(type: Types, langCode?: string): Promise<Array<ITemplateEntity> | IError>;
     /**
-     * Get one template object by id.
+     * Get one template object by marker.
      *
-     * @param {number} [id] - Template id
-     * @param {string} [langCode] - Optional parameter language code
+     * @handleName getTemplateByMarker
      *
-     * @returns Returns a TemplateEntity object
-     */
-    getTemplateById(id: number, langCode?: string): Promise<ITemplateEntity | IError>;
-    /**
-     * Get one template object by id.
+     * @param {number} marker - The unique marker of the template to retrieve. Example: 'template_12345'.
+     * @param {string} [langCode] - Language code. Default: "en_US".
      *
-     * @param {number} [marker] - Template marker
-     * @param {string} [langCode] - Optional parameter language code
+     * @return {ITemplateEntity} Returns a TemplateEntity object
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      *
-     * @returns Returns a TemplateEntity object
+     * @description Fetch a specific template object based on its unique marker.
      */
     getTemplateByMarker(marker: string, langCode?: string): Promise<ITemplateEntity | IError>;
 }