oneentry 1.0.126 → 1.0.128

package/dist/products/productsInterfaces.d.ts

@@ -2,26 +2,25 @@ import type { IFormConfig } from 'forms/formsInterfaces';
 import type { AttributeType, IError, ILocalizeInfo, LangType, Types } from '../base/utils';
 /**
  * @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.
- * @property {function} getProductsByPageId - Search for all products with pagination for the selected category.
- * @property {function} getProductsPriceByPageUrl - Search for information about products and prices for the selected category.
- * @property {function} getProductsByPageUrl - Search for all products with pagination for the selected category.
- * @property {function} getRelatedProductsById - Find all related product page objects.
- * @property {function} getProductsByIds - Find products by its ids.
- * @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.
- * @property {function} getProductsCount - Retrieves the total number of products available in the entire catalog.
- * @property {function} getProductsCountByPageId - Retrieves the number of products on a specific catalog page identified by its page ID.
- * @property {function} getProductsCountByPageUrl - Retrieves the number of products on a specific catalog page identified by its URL.
+ * @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.
+ * @property {Function} getProductsByPageId - Search for all products with pagination for the selected category.
+ * @property {Function} getProductsPriceByPageUrl - Search for information about products and prices for the selected category.
+ * @property {Function} getProductsByPageUrl - Search for all products with pagination for the selected category.
+ * @property {Function} getRelatedProductsById - Find all related product page objects.
+ * @property {Function} getProductsByIds - Find products by its ids.
+ * @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.
+ * @property {Function} getProductsCount - Retrieves the total number of products available in the entire catalog.
+ * @property {Function} getProductsCountByPageId - Retrieves the number of products on a specific catalog page identified by its page ID.
+ * @property {Function} getProductsCountByPageUrl - Retrieves the number of products on a specific catalog page identified by its URL.
  * @description This interface defines methods for retrieving and managing products in the system.
  */
 interface IProductApi {
     /**
      * Search for all products with pagination and filter.
-     *
+     * @handleName getProducts
      * @param {IFilterParams[]} [body] - Request body. Default []. Example:
         [
           {
@@ -59,14 +58,14 @@ interface IProductApi {
           "conditionMarker": "equals",
           "attributeMarker": "color"
         }
-     * @return {IProductsResponse} Array with ProductEntity objects
+     * @returns {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?: 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:
         {
@@ -80,13 +79,14 @@ interface IProductApi {
           "conditionMarker": "equals",
           "attributeMarker": "color"
         }
-     * @return {IProductsResponse} Array with ProductEntity objects.
+     * @returns {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 searches for all product page objects with pagination that do not have a category.
      */
     getProductsEmptyPage(langCode?: LangType, userQuery?: IProductsQuery): Promise<IProductsResponse | IError>;
     /**
      * Search for all products with pagination for the selected category.
-     *
+     * @handleName getProductsByPageId
      * @param {number} id - Page id. Example: 12345.
      * @param {IFilterParams[]} [body] - Request body. Default: [].
      * @param {string} [langCode] - Language code. Default "en_US".
@@ -102,13 +102,14 @@ interface IProductApi {
           "conditionMarker": "equals",
           "attributeMarker": "color"
         }
-     * @return {IProductsResponse} Array with ProductEntity objects
+     * @returns {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 searches for all products with pagination for the selected category.
      */
     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:
@@ -123,13 +124,14 @@ interface IProductApi {
           "conditionMarker": "equals",
           "attributeMarker": "color"
         }
-     * @return {IProductsInfo} Array with ProductInformation objects.
+     * @returns {IProductsInfo} Array with ProductInformation objects.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method searches for information about products 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: "23-laminat-floorwood-maxima".
      * @param {IFilterParams[]} [body] - Request body. Default: [].
      * @param {string} [langCode] - Language code. Default: "en_US".
@@ -145,13 +147,14 @@ interface IProductApi {
           "conditionMarker": "equals",
           "attributeMarker": "color"
         }
-     * @return {IProductsResponse} Array with ProductEntity objects.
+     * @returns {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 searches 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:
@@ -166,13 +169,14 @@ interface IProductApi {
           "conditionMarker": "equals",
           "attributeMarker": "color"
         }
-     * @return {IProductsResponse} Array with ProductEntity objects
+     * @returns {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 finds all related product page objects for the selected product page.
      */
     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:
@@ -187,41 +191,43 @@ interface IProductApi {
           "conditionMarker": "equals",
           "attributeMarker": "color"
         }
-     * @return {IProductsEntity[]} Array with ProductEntity objects
+     * @returns {IProductsEntity[]} Array with ProductEntity objects
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @description This method finds 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".
-     * @return {IProductsEntity} ProductEntity object.
+     * @returns {IProductsEntity} ProductEntity object.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     * @description This method retrieves one product object.
      */
     getProductById(id: number, langCode?: string): Promise<IProductsEntity | IError>;
     /**
      * Getting a product block object by product id.
-     *
+     * @handleName getProductBlockById
      * @param {number} id - Product id. Example: 12345.
-     * @return {IProductBlock}
+     * @returns {IProductBlock}
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets 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".
-     * @return {IProductsEntity[]} Array with ProductEntity objects
+     * @returns {IProductsEntity[]} Array with ProductEntity objects
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method performs a 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 {string} [body] - Body parameters for filter. Deault: []. Example:
         [
           {
@@ -230,7 +236,7 @@ interface IProductApi {
             "statusMarker": "status_1",
             "conditionValue": {},
             "pageUrls": [
-              "23-laminat-floorwood-maxima"
+            "23-laminat-floorwood-maxima"
             ],
             "title": "Iphone 17 Pro"
           },
@@ -240,21 +246,19 @@ interface IProductApi {
             "statusMarker": "status_1",
             "conditionValue": {},
             "pageUrls": [
-              "23-laminat-floorwood-maxima"
+            "23-laminat-floorwood-maxima"
             ],
             "title": "Iphone 17 Pro"
           }
         ]
-     * @return {IProductsCount} Object with product items count.
+     * @returns {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.
      */
     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. Example: 12345.
      * @param {string} body - Body parameters for filter. Deault: []. Example:
         [
@@ -264,7 +268,7 @@ interface IProductApi {
             "statusMarker": "status_1",
             "conditionValue": {},
             "pageUrls": [
-              "23-laminat-floorwood-maxima"
+            "23-laminat-floorwood-maxima"
             ],
             "title": "Iphone 17 Pro"
           },
@@ -274,21 +278,19 @@ interface IProductApi {
             "statusMarker": "status_1",
             "conditionValue": {},
             "pageUrls": [
-              "23-laminat-floorwood-maxima"
+            "23-laminat-floorwood-maxima"
             ],
             "title": "Iphone 17 Pro"
           }
         ]
-     * @return {IProductsCount} Object with product items count.
+     * @returns {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.
      */
     getProductsCountByPageId(id: string, body: any): Promise<IProductsCount | IError>;
     /**
      * Getting the number of products on a catalog page by page URL.
-     *
      * @handleName getProductsCountByPageUrl
-     *
      * @param {string} url - Page url. Example: "catalog".
      * @param {string} body - Body parameters for filter. Deault: []. Example:
         [
@@ -298,7 +300,7 @@ interface IProductApi {
             "statusMarker": "status_1",
             "conditionValue": {},
             "pageUrls": [
-              "23-laminat-floorwood-maxima"
+            "23-laminat-floorwood-maxima"
             ],
             "title": "Iphone 17 Pro"
           },
@@ -308,12 +310,12 @@ interface IProductApi {
             "statusMarker": "status_1",
             "conditionValue": {},
             "pageUrls": [
-              "23-laminat-floorwood-maxima"
+            "23-laminat-floorwood-maxima"
             ],
             "title": "Iphone 17 Pro"
           }
         ]
-     * @return {IProductsCount} Object with product items count.
+     * @returns {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.
      */
@@ -321,7 +323,6 @@ interface IProductApi {
 }
 /**
  * @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".
@@ -347,7 +348,6 @@ interface IProductsQuery {
 }
 /**
  * @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".
@@ -368,7 +368,6 @@ interface IFilterParams {
 }
 /**
  * @interface IProductsEntity
- *
  * @property {number} id - The unique identifier. Example: 12345.
  * @property {ILocalizeInfo} localizeInfos - The name of the products, taking into account localization. Example:
  * @property {string | null} statusIdentifier - Product page status identifiers (may be null). Example: "in_stock".
@@ -433,7 +432,6 @@ interface IProductsEntity {
 }
 /**
  * @interface IProductsResponse
- *
  * @property {number} total - The total number of products found. Example: 100.
  * @property {IProductsEntity[]} items - An array of product entities. Example:
     [
@@ -454,7 +452,6 @@ interface IProductsResponse {
 }
 /**
  * @interface IProductsCount
- *
  * @property {number} totalAll - The total number of products found. Example: 100.
  * @property {number} totalInCategory - The total number of products found in category. Example: 50.
  * @property {number} totalInCategoryWithNested - The total number of products found in nested category. Example: 10.
@@ -467,7 +464,6 @@ interface IProductsCount {
 }
 /**
  * @interface IProductsInfo
- *
  * @property {number} total - The total number of products found. Example: 100.
  * @property {IProductInfo[]} items - An array of product information objects. Example:
     [
@@ -488,7 +484,6 @@ interface IProductsInfo {
 }
 /**
  * @interface IProductInfo
- *
  * @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.
@@ -499,7 +494,6 @@ interface IProductInfo {
 }
 /**
  * @interface IProductBlock
- *
  * @property {number} id - Unique identifier of the product block. Example: 3289.
  * @property {number | null} attributeSetIdentifier - Identifier of the attribute set used in the product block, or null if not applicable. Example: 67890.
  * @property {ILocalizeInfo} localizeInfos - Localization information for the product block. Example:

package/dist/system/systemApi.d.ts

@@ -5,37 +5,37 @@ import type { ISystem } from './systemInterfaces';
 /**
  * Controllers for working with system - system
  * @handle /api/content/system
+ * @description Controllers for working with system - system
  */
 export default class SystemApi extends AsyncModules implements ISystem {
     protected state: StateModule;
     protected _url: string;
+    /**
+     * Constructor
+     * @param {StateModule} state - The state module.
+     * @description Constructor initializes the SystemApi with a given state.
+     */
     constructor(state: StateModule);
     /**
      * 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.
+     * @returns {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 | IError>;
     /**
      * 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.
+     * @returns {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 | IError>;
     /**
      * Validates a CAPTCHA token by sending it to the server for verification.
-     *
      * @handleName validateCapcha
-     *
-     * @param {Object} event - The event object containing CAPTCHA data. Example:
+     * @param {object} event - The event object containing CAPTCHA data. Example:
         {
           "token": "03AGdBq24...",
           "expectedAction": "login",
@@ -44,7 +44,7 @@ export default class SystemApi extends AsyncModules implements ISystem {
      * @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.
+     * @returns {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.
      */
@@ -55,10 +55,8 @@ export default class SystemApi extends AsyncModules implements ISystem {
     }): Promise<any | IError>;
     /**
      * Getting the number of requests to API.
-     *
      * @handleName getApiStat
-     *
-     * @return {any} Return object with date and count.
+     * @returns {any} Return object with date and count.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description Getting the number of requests to API.
      */

package/dist/system/systemApi.js

@@ -3,23 +3,28 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable jsdoc/reject-any-type */
 /* eslint-disable @typescript-eslint/no-explicit-any */
 const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 /**
  * Controllers for working with system - system
  * @handle /api/content/system
+ * @description Controllers for working with system - system
  */
 class SystemApi extends asyncModules_1.default {
+    /**
+     * Constructor
+     * @param {StateModule} state - The state module.
+     * @description Constructor initializes the SystemApi with a given state.
+     */
     constructor(state) {
         super(state);
         this._url = state.url + '/api/content/system';
     }
     /**
      * 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.
+     * @returns {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.
      */
@@ -29,10 +34,8 @@ class SystemApi extends asyncModules_1.default {
     }
     /**
      * 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.
+     * @returns {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.
      */
@@ -42,10 +45,8 @@ class SystemApi extends asyncModules_1.default {
     }
     /**
      * Validates a CAPTCHA token by sending it to the server for verification.
-     *
      * @handleName validateCapcha
-     *
-     * @param {Object} event - The event object containing CAPTCHA data. Example:
+     * @param {object} event - The event object containing CAPTCHA data. Example:
         {
           "token": "03AGdBq24...",
           "expectedAction": "login",
@@ -54,7 +55,7 @@ class SystemApi extends asyncModules_1.default {
      * @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.
+     * @returns {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.
      */
@@ -67,10 +68,8 @@ class SystemApi extends asyncModules_1.default {
     }
     /**
      * Getting the number of requests to API.
-     *
      * @handleName getApiStat
-     *
-     * @return {any} Return object with date and count.
+     * @returns {any} Return object with date and count.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description Getting the number of requests to API.
      */

package/dist/system/systemInterfaces.d.ts

@@ -1,12 +1,23 @@
 /**
  * @interface ISystem
- *
- * @property {function} test404 - Test 404 error.
- * @property {function} test500 - Test 500 error.
+ * @property {Function} test404 - Test 404 error.
+ * @property {Function} test500 - Test 500 error.
  * @description Represents a interface object of System Api.
  */
 interface ISystem {
+    /**
+     * Test 404 error.
+     * @handleName test404
+     * @returns {any} Returns a Promise that resolves with any data.
+     * @description This method tests 404 error.
+     */
     test404(): Promise<any>;
+    /**
+     * Test 500 error.
+     * @handleName test500
+     * @returns {any} Returns a Promise that resolves with any data.
+     * @description This method tests 500 error.
+     */
     test500(): Promise<any>;
 }
 export type { ISystem };

package/dist/templates/templatesApi.d.ts

@@ -4,47 +4,44 @@ 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;
     protected _url: string;
+    /**
+     * Constructor for TemplatesApi class.
+     * @param {StateModule} state - The state module instance.
+     * @description Initializes the TemplatesApi class with the provided state module instance.
+     */
     constructor(state: StateModule);
     /**
      * Get all template objects grouped by types.
-     *
      * @handleName getAllTemplates
-     *
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {Record<Types, ITemplateEntity[]>} Returns an object GroupedTemplatesObject, which contains an array of template objects TemplateEntity
+     * @returns {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.
-     *
      * @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".
-     * @return {ITemplateEntity[]} Returns a TemplateEntity object.
+     * @returns {ITemplateEntity[]} 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<ITemplateEntity[] | IError>;
     /**
      * Get one template object by marker.
-     *
      * @handleName getTemplateByMarker
-     *
      * @param {string} marker - The unique marker of the template to retrieve. Example: "template_12345".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {ITemplateEntity} Returns a TemplateEntity object
+     * @returns {ITemplateEntity} Returns a TemplateEntity object
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Fetch a specific template object based on its unique marker.
      */

package/dist/templates/templatesApi.js

@@ -7,24 +7,25 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 /**
  * 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.
  */
 class TemplatesPreviewApi extends asyncModules_1.default {
+    /**
+     * Constructor for TemplatesApi class.
+     * @param {StateModule} state - The state module instance.
+     * @description Initializes the TemplatesApi class with the provided state module instance.
+     */
     constructor(state) {
         super(state);
         this._url = state.url + '/api/content/templates';
     }
     /**
      * Get all template objects grouped by types.
-     *
      * @handleName getAllTemplates
-     *
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {Record<Types, ITemplateEntity[]>} Returns an object GroupedTemplatesObject, which contains an array of template objects TemplateEntity
+     * @returns {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.
      */
@@ -39,12 +40,10 @@ class TemplatesPreviewApi extends asyncModules_1.default {
     }
     /**
      * Get template objects by type.
-     *
      * @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".
-     * @return {ITemplateEntity[]} Returns a TemplateEntity object.
+     * @returns {ITemplateEntity[]} 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.
      */
@@ -54,12 +53,10 @@ class TemplatesPreviewApi extends asyncModules_1.default {
     }
     /**
      * Get one template object by marker.
-     *
      * @handleName getTemplateByMarker
-     *
      * @param {string} marker - The unique marker of the template to retrieve. Example: "template_12345".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {ITemplateEntity} Returns a TemplateEntity object
+     * @returns {ITemplateEntity} Returns a TemplateEntity object
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Fetch a specific template object based on its unique marker.
      */