oneentry 1.0.126 → 1.0.128

package/dist/integration-collections/integrationCollectionsApi.js

@@ -3,17 +3,20 @@ 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 */
 const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 /**
  * Controllers for working with attributes.
- *
  * @handle /api/content/integration-collections
  * @class IntegrationCollectionsApi
- * @extends AsyncModules
+ * @augments AsyncModules
  * @implements {ICollectionsApi}
  * @description This class provides methods to interact with integration collections, including retrieving all collections, getting a single collection by ID, and managing collection rows.
  */
 class IntegrationCollectionsApi extends asyncModules_1.default {
+    /**
+     *
+     */
     constructor(state) {
         super(state);
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -26,9 +29,7 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
     }
     /**
      * Get all collections.
-     *
      * @handleName getICollections
-     *
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {object} [userQuery] - Optional set query parameters. Example:
         {
@@ -41,13 +42,11 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
      * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 30.
      * @param {string} [userQuery.entityType] - Entity type. Example: "orders".
      * @param {number} [userQuery.entityId] - Entity identifier. Example: 1.
-     * @return {ICollectionEntity[]} Returns an array of ICollection objects or an error object if there was an issue.
+     * @returns {ICollectionEntity[]} Returns an array of ICollection objects or an error object if there was an issue.
      * @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.
      */
-    async getICollections(langCode = this.state.lang, 
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    userQuery) {
+    async getICollections(langCode = this.state.lang, userQuery) {
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         const query = { ...this._defaultQuery, ...userQuery, langCode };
         const result = await this._fetchGet(`?` + this._queryParamsToString(query));
@@ -55,25 +54,20 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
     }
     /**
      * Get a single collection object by id.
-     *
      * @handleName getICollectionById
-     *
      * @param {number} id - Collection id. Example: 1.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {ICollectionEntity} Returns an ICollection object or an error object if there was an issue.
+     * @returns {ICollectionEntity} Returns an ICollection object or an error object if there was an issue.
      * @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.
      */
     async getICollectionById(id, langCode = this.state.lang) {
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         const result = await this._fetchGet(`/${id}?` + this._queryParamsToString({ langCode }));
         return this._dataPostProcess(result, langCode);
     }
     /**
      * Get all records belonging to the collection by collection id.
-     *
      * @handleName getICollectionRowsById
-     *
      * @param {number} id - Collection id. Example: 1.
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {any} [userQuery] - Optional set query parameters. Example:
@@ -87,7 +81,7 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
      * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 30.
      * @param {number} [userQuery.entityType] - Entity type. Example: "orders".
      * @param {number} [userQuery.entityId] - Entity identifier. Example: 1.
-     * @return {ICollectionRowsResponce} Returns object ItemsWithTotal, where items is an array of requested objects.
+     * @returns {ICollectionRowsResponce} Returns object ItemsWithTotal, where items is an array of requested objects.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Get all records belonging to the collection by collection id.
      */
@@ -102,11 +96,9 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
     }
     /**
      * Check for the existence of a text identifier (marker).
-     *
      * @handleName validateICollectionMarker
-     *
      * @param {string} marker - Collection marker. Example: "collection1".
-     * @return {ICollectionIsValid} Returns an object with a boolean property `valid` indicating whether the marker is valid or not. Example:
+     * @returns {ICollectionIsValid} Returns an object with a boolean property `valid` indicating whether the marker is valid or not. Example:
         {
           "valid": true
         }
@@ -119,12 +111,10 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
     }
     /**
      * Getting all records from the collection.
-     *
      * @handleName getICollectionRowsByMarker
-     *
      * @param {string} marker - Collection text identifier. Example: "collection1".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {ICollectionRowsResponce} Returns CollectionRowEntity object.
+     * @returns {ICollectionRowsResponce} Returns CollectionRowEntity object.
      * @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.
      */
@@ -134,13 +124,11 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
     }
     /**
      * Getting one record from the collection.
-     *
      * @handleName getICollectionRowByMarkerAndId
-     *
      * @param {string} marker - Collection text identifier. Example: "collection1".
      * @param {number} id - Collection record identifier. Example: 1.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {ICollectionRow} Returns CollectionRowEntity object.
+     * @returns {ICollectionRow} Returns CollectionRowEntity object.
      * @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.
      */
@@ -150,25 +138,21 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
     }
     /**
      * Create a record in the collection.
-     *
      * @handleName createICollectionRow
-     *
      * @param {string} marker - Collection text identifier. Example: "collection1".
      * @param {ICollectionFormObject} body - Object for creating a record. Example:
         {
           "formIdentifier": "collection-form",
-          "formData": {
-            "en_US": [
-              {
-                "marker": "collection_marker",
-                "type": "string",
-                "value": "Collection marker"
-              }
-            ]
-          }
+          "formData": [
+            {
+            "marker": "collection_marker",
+            "type": "string",
+            "value": "Collection marker"
+            }
+          ]
         }
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {ICollectionRow} Returns object of type ICollectionRow.
+     * @returns {ICollectionRow} Returns object of type ICollectionRow.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Create a record in the collection.
      */
@@ -178,26 +162,24 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
     }
     /**
      * Edit a record in the collection.
-     *
      * @handleName updateICollectionRow
-     *
      * @param {string} marker - Text identifier of the collection. Example: "collection1".
      * @param {number} id - Row identifier in the collection. Example: 12.
      * @param {object} body - Object for updating a record in the collection. Example:
         {
           "formIdentifier": "collection-form",
-          "formData": {
-            "en_US": [
-              {
-                "marker": "collection_marker",
-                "type": "string",
-                "value": "Collection marker"
-              }
-            ]
-          }
+          "formData": [
+            {
+              "marker": "collection_marker",
+              "type": "string",
+              "value": "Collection marker"
+            }
+          ]
         }
+     * @param {string} body.formIdentifier - Textual identifier of the form. Example: "collection-form".
+     * @param {any} body.formData - Object with the form data.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {ICollectionRow} Returns object of type ICollectionRow.
+     * @returns {ICollectionRow} Returns object of type ICollectionRow.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Edit a record in the collection.
      */
@@ -207,12 +189,10 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
     }
     /**
      * Deletion of collection record object
-     *
      * @handleName deleteICollectionRowByMarkerAndId
-     *
      * @param {string} marker - text identifier of the collection Example: "collection1".
      * @param {number} id - record identifier in the collection Example: 12.
-     * @return {boolean} Returns true (in case of successful deletion) or false (in case of unsuccessful deletion) (permission "collections.row.delete" required for access)
+     * @returns {boolean} Returns true (in case of successful deletion) or false (in case of unsuccessful deletion) (permission "collections.row.delete" required for access)
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Deletion of collection record object
      */

package/dist/integration-collections/integrationCollectionsInterfaces.d.ts

@@ -1,22 +1,21 @@
 import type { IError, ILocalizeInfo } from '../base/utils';
 /**
  * @interface ICollectionsApi
- *
- * @property {function} getICollections - Get all collections.
- * @property {function} getICollectionById - Get a single collection object.
- * @property {function} getICollectionRowsById - Get all records belonging to the collection by collection id.
- * @property {function} validateICollectionMarker - Check for the existence of a text identifier (marker).
- * @property {function} getICollectionRowsByMarker - Getting all records (row) from the collection.
- * @property {function} getICollectionRowByMarkerAndId - Getting one record (rows) from the collection.
- * @property {function} createICollectionRow - Create a record (row) in the collection.
- * @property {function} updateICollectionRow - Edit a record (row) in the collection.
- * @property {function} deleteICollectionRowByMarkerAndId - Deletion of collection record object (row).
+ * @property {Function} getICollections - Get all collections.
+ * @property {Function} getICollectionById - Get a single collection object.
+ * @property {Function} getICollectionRowsById - Get all records belonging to the collection by collection id.
+ * @property {Function} validateICollectionMarker - Check for the existence of a text identifier (marker).
+ * @property {Function} getICollectionRowsByMarker - Getting all records (row) from the collection.
+ * @property {Function} getICollectionRowByMarkerAndId - Getting one record (rows) from the collection.
+ * @property {Function} createICollectionRow - Create a record (row) in the collection.
+ * @property {Function} updateICollectionRow - Edit a record (row) in the collection.
+ * @property {Function} deleteICollectionRowByMarkerAndId - Deletion of collection record object (row).
  * @description This interface defines methods for managing collections and their records in the system.
  */
 interface ICollectionsApi {
     /**
      * Get all collections.
-     *
+     * @handleName getICollections
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {any} [userQuery] - Query parameters. Example:
         {
@@ -29,8 +28,9 @@ interface ICollectionsApi {
      * @param {number} [userQuery.offset] - Parameter for pagination. Default: 30.
      * @param {string} [userQuery.entityType] - Entity type. Example: "orders".
      * @param {number} [userQuery.entityId] - Entity identifier. Example: 1.
-     * @return {ICollectionEntity[]} Returns an array of ICollection objects or an error object if there was an issue.
+     * @returns {ICollectionEntity[]} Returns an array of ICollection objects or an error object if there was an issue.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets all collections.
      */
     getICollections(langCode: string, userQuery?: {
         limit: number;
@@ -40,16 +40,17 @@ interface ICollectionsApi {
     }): Promise<ICollectionEntity[] | IError>;
     /**
      * Get a single collection object by id.
-     *
+     * @handleName getICollectionById
      * @param {number} id - Collection id. Example: 1.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {ICollectionEntity} Returns an ICollection object or an error object if there was an issue.
+     * @returns {ICollectionEntity} Returns an ICollection object or an error object if there was an issue.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets a single collection object by id.
      */
     getICollectionById(id: number, langCode: string): Promise<ICollectionEntity | IError>;
     /**
      * Get all records belonging to the collection by collection id.
-     *
+     * @handleName getICollectionRowsById
      * @param {number} id - Collection id.
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {any} [userQuery] - Optional set query parameters. Example:
@@ -63,98 +64,101 @@ interface ICollectionsApi {
      * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 0.
      * @param {number} [userQuery.entityType] - Entity type. Example: "orders".
      * @param {number} [userQuery.entityId] - Entity identifier. Example: 1.
-     * @return {ICollectionRowsResponce} Returns object ItemsWithTotal, where items is an array of requested objects.
+     * @returns {ICollectionRowsResponce} Returns object ItemsWithTotal, where items is an array of requested objects.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets all records belonging to the collection by collection id.
      */
     getICollectionRowsById(id: number, langCode: string, userQuery?: any): Promise<ICollectionRowsResponce | IError>;
     /**
      * Check for the existence of a text identifier (marker).
-     *
+     * @handleName validateICollectionMarker
      * @param {string} marker - Collection marker. Example: "collection1".
-     * @return {ICollectionIsValid} Returns an object with a boolean property `valid` indicating whether the marker is valid or not. Example:
+     * @returns {ICollectionIsValid} Returns an object with a boolean property `valid` indicating whether the marker is valid or not. Example:
         {
           "valid": true
         }
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method checks for the existence of a text identifier (marker).
      */
-    validateICollectionMarker(marker: string): Promise<any | IError>;
+    validateICollectionMarker(marker: string): Promise<ICollectionIsValid | IError>;
     /**
      * Getting all records from the collection.
-     *
+     * @handleName getICollectionRowsByMarker
      * @param {string} marker - Collection text identifier. Example: "collection1".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {ICollectionRowsResponce} Returns collection row entity object.
+     * @returns {ICollectionRowsResponce} Returns collection row entity object.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets all records from the collection.
      */
     getICollectionRowsByMarker(marker: string, langCode?: string): Promise<ICollectionRowsResponce | IError>;
     /**
      * Getting one record from the collection.
-     *
+     * @handleName getICollectionRowByMarkerAndId
      * @param {string} marker - Collection text identifier. Example: "collection1".
      * @param {number} id - Collection record identifier. Example: 1.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {ICollectionRow} Returns collection row entity object.
+     * @returns {ICollectionRow} Returns collection row entity object.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets one record from the collection.
      */
     getICollectionRowByMarkerAndId(marker: string, id: number, langCode: string): Promise<ICollectionRow | IError>;
     /**
      * Create a record in the collection.
-     *
+     * @handleName createICollectionRow
      * @param {string} marker - Collection text identifier. Example: "collection1".
      * @param {ICollectionFormObject} body - Object for creating a record. Example:
         {
           "formIdentifier": "collection-form",
-          "formData": {
-            "en_US": [
-              {
-                "marker": "collection_marker",
-                "type": "string",
-                "value": "Collection marker"
-              }
-            ]
-          }
+          "formData": [
+            {
+              "marker": "collection_marker",
+              "type": "string",
+              "value": "Collection marker"
+            }
+          ]
         }
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {any} Returns object of type ICollectionRow.
+     * @returns {any} Returns object of type ICollectionRow.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method creates a record in the collection.
      */
     createICollectionRow(marker: string, body: ICollectionFormObject, langCode: string): Promise<any | IError>;
     /**
      * Edit a record in the collection.
-     *
+     * @handleName updateICollectionRow
      * @param {string} marker - Text identifier of the collection. Example: "collection1".
      * @param {number} id - Row id. Example: 12.
      * @param {ICollectionFormObject} body - Object for updating a record in the collection. Example:
         {
           "formIdentifier": "collection-form",
-          "formData": {
-            "en_US": [
-              {
-                "marker": "collection_marker",
-                "type": "string",
-                "value": "Collection marker"
-              }
-            ]
-          }
+          "formData": [
+            {
+              "marker": "collection_marker",
+              "type": "string",
+              "value": "Collection marker"
+            }
+          ]
         }
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {ICollectionRow} Returns object of type ICollectionRow.
+     * @returns {ICollectionRow} Returns object of type ICollectionRow.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method edits a record in the collection.
      */
     updateICollectionRow(marker: string, id: number, body: ICollectionFormObject, langCode: string): Promise<any | IError>;
     /**
      * Deletion of collection record object
-     *
+     * @handleName deleteICollectionRowByMarkerAndId
      * @param {string} marker - text identifier of the collection Example: "collection1".
      * @param {number} id - record identifier in the collection Example: 12.
-     * @return {boolean} Returns true (in case of successful deletion) or false (in case of unsuccessful deletion) (permission "collections.row.delete" required for access)
+     * @returns {boolean} Returns true (in case of successful deletion) or false (in case of unsuccessful deletion) (permission "collections.row.delete" required for access)
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method deletes a collection record object.
      */
     deleteICollectionRowByMarkerAndId(marker: string, id: number): Promise<any | IError>;
 }
 /**
+ * Collection object
  * @interface ICollectionEntity
- *
  * @property {number} id - Object identifier. Example: 1.
  * @property {string | null} identifier - Text identifier for record field. Example: "collection1".
  * @property {number | null} formId - Identifier for the form used by the order storage. Example: 1234.
@@ -175,8 +179,8 @@ interface ICollectionEntity {
     selectedAttributeMarkers: string | null;
 }
 /**
+ * Collection response object
  * @interface ICollectionResponce
- *
  * @property {ICollectionEntity[]} items - Array of collection objects. Example:
     [
       {
@@ -192,8 +196,8 @@ interface ICollectionResponce {
     total: number;
 }
 /**
+ * Collection form data object
  * @interface ICollectionFormData
- *
  * @property {string} marker - Text identifier (marker) of the form field. Example: "collection_marker".
  * @property {string} type - Type of the form field, such as "text", "number", "date", "etc". Example: "number".
  * @property {string} value - Value of the form field, which can be a "string", "number", "date", "etc". Example: "Collection marker".
@@ -205,8 +209,8 @@ interface ICollectionFormData {
     value: string;
 }
 /**
+ * Collection form object
  * @interface ICollectionFormObject
- *
  * @property {string} formIdentifier - Text identifier (marker) of the form. Example: "collection-form".
  * @property {Record<string, ICollectionFormData>} formData - An object where keys are form field markers and values are arrays of ICollectionFormData objects. Example:
     [
@@ -228,8 +232,8 @@ interface ICollectionFormObject {
     };
 }
 /**
+ * Collection row object
  * @interface ICollectionRow
- *
  * @property {number} id - Object identifier. Example: 1.
  * @property {string} createdDate - Date of creation of the record. Example: "2023-01-01T00:00:00Z".
  * @property {string} updatedDate - Date of last update of the record. Example: "2023-01-02T00:00:00Z".
@@ -257,11 +261,11 @@ interface ICollectionRow {
     entityType: string | null;
     entityId: number | null;
     attributeSetIdentifier?: string | null;
-    total: string;
+    total?: string;
 }
 /**
+ * Collection rows response object
  * @interface ICollectionRowsResponce
- *
  * @property {ICollectionRow[]} items - Array of collection row objects. Example:
     [
       {
@@ -272,9 +276,9 @@ interface ICollectionRow {
         "entityType": null,
         "formData": [
           {
-            "marker": "name_1",
-            "type": "string",
-            "value": "Value"
+          "marker": "name_1",
+          "type": "string",
+          "value": "Value"
           }
         ],
         "attributeSetIdentifier": null
@@ -288,8 +292,8 @@ interface ICollectionRowsResponce {
     total: number;
 }
 /**
+ * Collection is valid object
  * @interface ICollectionIsValid
- *
  * @property {boolean} valid - Valid marker object. Example: true.
  * @description Represents a response from the validateICollectionMarker.
  */

package/dist/locales/localesApi.d.ts

@@ -5,17 +5,21 @@ import type { ILocalEntity, ILocales } from './localesInterfaces';
 /**
  * Controllers for working with localizations (content language)
  * @handle /api/content/locales
+ * @description Controllers for working with localizations (content language)
  */
 export default class LocalesApi extends AsyncModules implements ILocales {
     protected state: StateModule;
     protected _url: string;
+    /**
+     * Constructor
+     * @param {StateModule} state - StateModule instance
+     * @description Constructor initializes the LocalesApi with a given state.
+     */
     constructor(state: StateModule);
     /**
      * Find all active language localization objects.
-     *
      * @handleName getLocales
-     *
-     * @return {ILocalEntity[]} Returns an array of LocaleEntity objects.
+     * @returns {ILocalEntity[]} Returns an array of LocaleEntity objects.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Find all active language localization objects.
      */

package/dist/locales/localesApi.js

@@ -7,18 +7,22 @@ const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 /**
  * Controllers for working with localizations (content language)
  * @handle /api/content/locales
+ * @description Controllers for working with localizations (content language)
  */
 class LocalesApi extends asyncModules_1.default {
+    /**
+     * Constructor
+     * @param {StateModule} state - StateModule instance
+     * @description Constructor initializes the LocalesApi with a given state.
+     */
     constructor(state) {
         super(state);
         this._url = state.url + '/api/content/locales';
     }
     /**
      * Find all active language localization objects.
-     *
      * @handleName getLocales
-     *
-     * @return {ILocalEntity[]} Returns an array of LocaleEntity objects.
+     * @returns {ILocalEntity[]} Returns an array of LocaleEntity objects.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Find all active language localization objects.
      */

package/dist/locales/localesInterfaces.d.ts

@@ -1,22 +1,23 @@
 import type { IError } from '../base/utils';
 /**
+ * The `ILocales` interface defines methods for working with language localization objects in the system.
  * @interface ILocales
- *
- * @property {function} getLocales - Find all active language localization objects.
+ * @property {Function} getLocales - Find all active language localization objects.
  * @description This interface defines a method for retrieving all active language localization objects in the system.
  */
 interface ILocales {
     /**
      * Find all active language localization objects.
-     *
-     * @return {ILocalEntity[]} Returns an array of LocaleEntity objects.
+     * @handleName getLocales
+     * @returns {ILocalEntity[]} Returns an array of LocaleEntity objects.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method finds all active language localization objects.
      */
     getLocales(): Promise<ILocalEntity[] | IError>;
 }
 /**
+ * The `ILocalEntity` interface defines the structure of a locales entity, including its identifiers, name, and other properties.
  * @interface ILocalEntity
- *
  * @property {number} id - The unique identifier of the locales. Example: 1.
  * @property {string} shortCode - The shortCode of locales. Example: "en".
  * @property {string} code - The full language code. Example: "en_US".

package/dist/menus/menusApi.d.ts

@@ -5,19 +5,23 @@ import type { IMenus, IMenusEntity } from './menusInterfaces';
 /**
  * Controllers for working with menu objects
  * @handle /api/content/menus
+ * @description Controllers for working with menu objects
  */
 export default class MenusApi extends AsyncModules implements IMenus {
     protected state: StateModule;
     protected _url: string;
+    /**
+     * Constructor initializes the MenusApi with a given state.
+     * @param {StateModule} state - The state module.
+     * @description Constructor initializes the MenusApi with a given state.
+     */
     constructor(state: StateModule);
     /**
      * Get pages includes in menu by marker.
-     *
      * @handleName getMenusByMarker
-     *
      * @param {string} marker - Menu marker. Example: "main_menu".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {IMenusEntity} Returns a single menu object as a ContentMenu object with included pages.
+     * @returns {IMenusEntity} Returns a single menu object as a ContentMenu object with included pages.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Get pages includes in menu by marker.
      */

package/dist/menus/menusApi.js

@@ -7,20 +7,24 @@ const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 /**
  * Controllers for working with menu objects
  * @handle /api/content/menus
+ * @description Controllers for working with menu objects
  */
 class MenusApi extends asyncModules_1.default {
+    /**
+     * Constructor initializes the MenusApi with a given state.
+     * @param {StateModule} state - The state module.
+     * @description Constructor initializes the MenusApi with a given state.
+     */
     constructor(state) {
         super(state);
         this._url = state.url + '/api/content/menus';
     }
     /**
      * Get pages includes in menu by marker.
-     *
      * @handleName getMenusByMarker
-     *
      * @param {string} marker - Menu marker. Example: "main_menu".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @return {IMenusEntity} Returns a single menu object as a ContentMenu object with included pages.
+     * @returns {IMenusEntity} Returns a single menu object as a ContentMenu object with included pages.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Get pages includes in menu by marker.
      */