oneentry 1.0.172 → 1.0.174

package/dist/integration-collections/integrationCollectionsApi.js

@@ -65,18 +65,14 @@ 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.
+     * @param {ICollectionsListQuery} [userQuery] - Optional query parameters.
      * @example
         {
-          "limit": 0,
-          "offset": 30,
-          "entityType": "orders",
-          "entityId": 1
+          "limit": 30,
+          "offset": 0
         }
-     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 0.
-     * @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.
+     * @param {number} [userQuery.limit] - Maximum number of records to return. Default: 30.
+     * @param {number} [userQuery.offset] - Number of records to skip. Default: 0.
      * @returns {Promise<ICollectionEntity[] | IError>} Returns an array of ICollection objects or an error object if there was an issue.
      * @see {@link https://js-sdk.oneentry.cloud/docs/integration-collections/getICollections getICollections} documentation.
      */
@@ -91,7 +87,7 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
     /**
      * Get a single collection object by id.
      * @handleName getICollectionById
-     * @param {number} id - Collection id. Example: 1.
+     * @param {number} id - Collection ID. Example: 1.
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<ICollectionEntity | IError>} Returns an ICollection object or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -106,20 +102,20 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
     /**
      * Get all records belonging to the collection by collection id.
      * @handleName getICollectionRowsById
-     * @param {number} id - Collection id. Example: 1.
+     * @param {number} id - Collection ID. Example: 1.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {any} [userQuery] - Optional set query parameters.
+     * @param {ICollectionQuery} [userQuery] - Optional query parameters.
      * @example
         {
-          "limit": 0,
-          "offset": 30,
+          "limit": 30,
+          "offset": 0,
           "entityType": "orders",
           "entityId": 1
         }
-     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 0.
-     * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 30.
+     * @param {number} [userQuery.limit] - Maximum number of records to return. Default: 30.
+     * @param {number} [userQuery.offset] - Number of records to skip. Default: 0.
      * @param {string} [userQuery.entityType] - Entity type. Example: "orders".
-     * @param {number} [userQuery.entityId] - Entity identifier. Example: 1.
+     * @param {number} [userQuery.entityId] - Entity ID. Example: 1.
      * @returns {Promise<ICollectionRowsResponce | IError>} Returns object ItemsWithTotal, where items is an array of requested objects.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Get all records belonging to the collection by collection id.
@@ -139,7 +135,7 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
     /**
      * Check for the existence of a text identifier (marker).
      * @handleName validateICollectionMarker
-     * @param {string} marker - Collection marker. Example: "collection1".
+     * @param {string} marker - Marker of the collection. Example: "collection1".
      * @returns {Promise<ICollectionIsValid | IError>} Returns an object with a boolean property `valid` indicating whether the marker is valid or not.
      * @example
         {
@@ -158,7 +154,7 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
     /**
      * Getting all records from the collection.
      * @handleName getICollectionRowsByMarker
-     * @param {string} marker - Collection text identifier. Example: "collection1".
+     * @param {string} marker - Marker of the collection. Example: "collection1".
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<ICollectionRowsResponce | IError>} Returns CollectionRowEntity object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -173,8 +169,8 @@ 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} marker - Marker of the collection. Example: "collection1".
+     * @param {number} id - Collection record ID. Example: 1.
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<ICollectionRow | IError>} Returns CollectionRowEntity object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -189,8 +185,8 @@ 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.
+     * @param {string} marker - Marker of the collection. Example: "collection1".
+     * @param {ICollectionFormObject} body - Data for the new record.
      * @example
         {
           "formIdentifier": "collection-form",
@@ -217,9 +213,9 @@ 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.
+     * @param {string} marker - Marker of the collection. Example: "collection1".
+     * @param {number} id - Row ID in the collection. Example: 12.
+     * @param {object} body - Data for updating the collection record.
      * @example
         {
           "formIdentifier": "collection-form",
@@ -248,8 +244,8 @@ 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.
+     * @param {string} marker - Marker of the collection. Example: "collection1".
+     * @param {number} id - ID of the collection row. Example: 12.
      * @returns {Promise<boolean | IError>} Returns true (in case of successful deletion) or false (in case of unsuccessful deletion) (permission "collections.row.delete" required for access)
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Deletion of collection record object

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

@@ -8,27 +8,23 @@ interface ICollectionsApi {
      * Get all collections.
      * @handleName getICollections
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {ICollectionQuery} [userQuery] - Query parameters.
+     * @param {ICollectionsListQuery} [userQuery] - Query parameters.
      * @example
         {
           "limit": 30,
-          "offset": 0,
-          "entityType": "orders",
-          "entityId": 1
+          "offset": 0
         }
-     * @param {number} [userQuery.limit] - Parameter for pagination. Default: 0.
-     * @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.
+     * @param {number} [userQuery.limit] - Maximum number of records to return. Default: 30.
+     * @param {number} [userQuery.offset] - Number of records to skip. Default: 0.
      * @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?: ICollectionQuery): Promise<ICollectionEntity[] | IError>;
+    getICollections(langCode?: string, userQuery?: ICollectionsListQuery): Promise<ICollectionEntity[] | IError>;
     /**
      * Get a single collection object by id.
      * @handleName getICollectionById
-     * @param {number} id - Collection id. Example: 1.
+     * @param {number} id - Collection ID. Example: 1.
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @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.
@@ -38,9 +34,9 @@ interface ICollectionsApi {
     /**
      * Get all records belonging to the collection by collection id.
      * @handleName getICollectionRowsById
-     * @param {number} id - Collection id.
+     * @param {number} id - Collection ID.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {ICollectionQuery} [userQuery] - Optional set query parameters.
+     * @param {ICollectionQuery} [userQuery] - Optional query parameters.
      * @example
         {
           "limit": 30,
@@ -48,10 +44,10 @@ interface ICollectionsApi {
           "entityType": "orders",
           "entityId": 1
         }
-     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 30.
-     * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 0.
+     * @param {number} [userQuery.limit] - Maximum number of records to return. Default: 30.
+     * @param {number} [userQuery.offset] - Number of records to skip. Default: 0.
      * @param {string} [userQuery.entityType] - Entity type. Example: "orders".
-     * @param {number} [userQuery.entityId] - Entity identifier. Example: 1.
+     * @param {number} [userQuery.entityId] - Entity ID. Example: 1.
      * @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.
@@ -60,7 +56,7 @@ interface ICollectionsApi {
     /**
      * Check for the existence of a text identifier (marker).
      * @handleName validateICollectionMarker
-     * @param {string} marker - Collection marker. Example: "collection1".
+     * @param {string} marker - Marker of the collection. Example: "collection1".
      * @returns {ICollectionIsValid} Returns an object with a boolean property `valid` indicating whether the marker is valid or not.
      * @example
         {
@@ -73,7 +69,7 @@ interface ICollectionsApi {
     /**
      * Getting all records from the collection.
      * @handleName getICollectionRowsByMarker
-     * @param {string} marker - Collection text identifier. Example: "collection1".
+     * @param {string} marker - Marker of the collection. Example: "collection1".
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {ICollectionRowsResponce} Returns collection row entity object.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
@@ -83,8 +79,8 @@ interface ICollectionsApi {
     /**
      * 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} marker - Marker of the collection. Example: "collection1".
+     * @param {number} id - Collection record ID. Example: 1.
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {ICollectionRow} Returns collection row entity object.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
@@ -94,8 +90,8 @@ interface ICollectionsApi {
     /**
      * Create a record in the collection.
      * @handleName createICollectionRow
-     * @param {string} marker - Collection text identifier. Example: "collection1".
-     * @param {ICollectionFormObject} body - Object for creating a record.
+     * @param {string} marker - Marker of the collection. Example: "collection1".
+     * @param {ICollectionFormObject} body - Data for the new record.
      * @example
         {
           "formIdentifier": "collection-form",
@@ -116,9 +112,9 @@ interface ICollectionsApi {
     /**
      * Edit a record in the collection.
      * @handleName updateICollectionRow
-     * @param {string} marker - Text identifier of the collection. Example: "collection1".
+     * @param {string} marker - Marker of the collection. Example: "collection1".
      * @param {number} id - Row id. Example: 12.
-     * @param {ICollectionFormObject} body - Object for updating a record in the collection.
+     * @param {ICollectionFormObject} body - Data for updating the collection record.
      * @example
         {
           "formIdentifier": "collection-form",
@@ -139,8 +135,8 @@ interface ICollectionsApi {
     /**
      * 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.
+     * @param {string} marker - Marker of the collection. Example: "collection1".
+     * @param {number} id - ID of the collection row. Example: 12.
      * @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.
@@ -150,16 +146,16 @@ interface ICollectionsApi {
 /**
  * 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.
- * @property {ILocalizeInfo} localizeInfos - Localized information about the collection.
+ * @property {number} id - Object ID. Example: 1.
+ * @property {string | null} identifier - Text identifier (marker) of the object. Example: "collection1".
+ * @property {number | null} formId - ID of the form used by the collection. Example: 1234.
+ * @property {ILocalizeInfo} localizeInfos - Localized data of the collection.
  * @example
     {
       "title": "Admins text"
     }
- * @property {number | null} attributeSetId - Identifier of the set of attributes used by the form attached to the collection. Example: 1234 or null if not applicable.
- * @property {string | null} selectedAttributeMarkers - Text identifiers of form object attributes for display in the data table. Example: "collection_marker".
+ * @property {number | null} attributeSetId - ID of the attribute set used by the collection's form. Example: 1234 or null if not applicable.
+ * @property {string | null} selectedAttributeMarkers - Markers of the form attributes shown as columns in the data table. Example: "collection_marker".
  * @description Represents a collection object with various properties, including identifiers, form information, and localized data.
  */
 interface ICollectionEntity {
@@ -192,8 +188,8 @@ interface ICollectionResponce {
  * 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".
+ * @property {string} type - Type of the form field, for example `"text"`, `"number"` or `"date"`. Example: "number".
+ * @property {string} value - Value of the form field. Example: "Collection marker".
  * @description Represents a form data object within a collection, containing a marker, type, and value.
  */
 interface ICollectionFormData {
@@ -204,8 +200,8 @@ interface ICollectionFormData {
 /**
  * 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.
+ * @property {string} formIdentifier - Marker of the form. Example: "collection-form".
+ * @property {ICollectionFormData[] | Record<string, ICollectionFormData[]>} formData - Field values: a flat array `[{ marker, type, value }]` (as in the example), or the same array wrapped in a language code — `{ "en_US": [...] }`. The platform stores both; the SDK sends the value as is.
  * @example
     [
       {
@@ -221,18 +217,16 @@ interface ICollectionFormData {
  */
 interface ICollectionFormObject {
     formIdentifier: string;
-    formData: {
-        [key: string]: ICollectionFormData[];
-    };
+    formData: ICollectionFormData[] | Record<string, ICollectionFormData[]>;
 }
 /**
  * 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".
- * @property {number | null} [collectionId] - collectionId associated with the collection row. Example: "product", "order", "etc".
- * @property {ICollectionFormData[]} formData - Array of form data objects associated with the collection row.
+ * @property {number} id - Object ID. Example: 1.
+ * @property {string} createdDate - Creation date of the record. Example: "2023-01-01T00:00:00Z".
+ * @property {string} updatedDate - Date the record was last updated. Example: "2023-01-02T00:00:00Z".
+ * @property {number | null} [collectionId] - ID of the collection the row belongs to. Example: "product", "order", "etc".
+ * @property {ICollectionFormData[]} formData - Form fields of the collection row.
  * @example
     [
       {
@@ -241,12 +235,12 @@ interface ICollectionFormObject {
         "value": "Value"
       }
     ]
- * @property {string | null} entityType - Type of the entity associated with the collection row. Example: "product", "order", "etc".
- * @property {number | null} entityId - Identifier of the entity associated with the collection row. Example: 12345.
- * @property {string | null} [attributeSetIdentifier] - Identifier of the attribute set used by the form attached to the collection row, or null if not applicable. Example: "attributeSet1" or null.
+ * @property {string | null} entityType - Type of the entity the collection row is linked to. Example: "product", "order", "etc".
+ * @property {number | null} entityId - ID of the entity the collection row is linked to. Example: 12345.
+ * @property {string | null} [attributeSetIdentifier] - Marker of the attribute set used by the form attached to the collection row, or `null` if there is none. Example: "attributeSet1" or null.
  * @property {string | null} [langCode] - Language code the row was stored under. Example: "en_US".
- * @property {string | null} [formIdentifier] - Text identifier of the form the row was created from; returned by the create/update row endpoints. Example: "collection_form".
- * @property {string} total - Total count. Example: "1".
+ * @property {string | null} [formIdentifier] - Marker of the form the row was created from; returned by the create and update row endpoints. Example: "collection_form".
+ * @property {string} total - Total number of records. Example: "1".
  * @description Represents a row in a collection, containing various properties such as identifiers, dates, form data, and an optional total value.
  */
 interface ICollectionRow {
@@ -265,7 +259,7 @@ interface ICollectionRow {
 /**
  * Collection rows response object
  * @interface ICollectionRowsResponce
- * @property {ICollectionRow[]} items - Array of collection row objects.
+ * @property {ICollectionRow[]} items - Rows of the collection.
  * @example
     [
       {
@@ -294,24 +288,31 @@ interface ICollectionRowsResponce {
 /**
  * Collection is valid object
  * @interface ICollectionIsValid
- * @property {boolean} valid - Valid marker object. Example: true.
+ * @property {boolean} valid - Whether the marker is valid. Example: true.
  * @description Represents a response from the validateICollectionMarker.
  */
 interface ICollectionIsValid {
     valid: boolean;
 }
 /**
- * Query parameters for collection requests.
+ * Query parameters for collection row requests. All of them are optional.
  * @interface ICollectionQuery
- * @property {number} limit - Parameter for pagination. Default: 30.
- * @property {number} offset - Parameter for pagination. Default: 0.
- * @property {string} entityType - Entity type. Example: "orders".
- * @property {number} entityId - Entity identifier. Example: 1.
+ * @property {number} [limit] - Maximum number of records to return. Default: 30.
+ * @property {number} [offset] - Number of records to skip. Default: 0.
+ * @property {string} [entityType] - Entity type. Example: "orders".
+ * @property {number} [entityId] - Entity ID. Example: 1.
  */
 interface ICollectionQuery {
-    limit: number;
-    offset: number;
-    entityType: string;
-    entityId: number;
+    limit?: number;
+    offset?: number;
+    entityType?: string;
+    entityId?: number;
 }
-export type { ICollectionEntity, ICollectionFormObject, ICollectionIsValid, ICollectionQuery, ICollectionResponce, ICollectionRow, ICollectionRowsResponce, ICollectionsApi, };
+/**
+ * Query parameters for getICollections: pagination only — the collection list takes no entity filter.
+ * @typedef {object} ICollectionsListQuery
+ * @property {number} [limit] - Maximum number of records to return. Default: 30.
+ * @property {number} [offset] - Number of records to skip. Default: 0.
+ */
+type ICollectionsListQuery = Pick<ICollectionQuery, 'limit' | 'offset'>;
+export type { ICollectionEntity, ICollectionFormObject, ICollectionIsValid, ICollectionQuery, ICollectionResponce, ICollectionRow, ICollectionRowsResponce, ICollectionsApi, ICollectionsListQuery, };

package/dist/locales/localesInterfaces.d.ts

@@ -17,14 +17,14 @@ interface ILocales {
 /**
  * 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".
- * @property {string} name - The language name. Example: "English".
- * @property {string} nativeName - The native language name. Example: "English".
- * @property {boolean} isActive - Active language flag. Example: true.
- * @property {string | null} image - The language image. Example: "https://example.com/images/en.png".
- * @property {number} position - The language position. Example: 1.
+ * @property {number} id - ID of the language. Example: 1.
+ * @property {string} shortCode - Short language code, for example `"en"`. Example: "en".
+ * @property {string} code - Full language code, such as `en_US`. Example: "en_US".
+ * @property {string} name - Name of the language. Example: "English".
+ * @property {string} nativeName - Name of the language in that language. Example: "English".
+ * @property {boolean} isActive - Whether the language is active. Example: true.
+ * @property {string | null} image - Image associated with the language. Example: "https://example.com/images/en.png".
+ * @property {number} position - Position of the language in the list. Example: 1.
  * @description This interface defines the structure of a locales entity, including its identifiers, name, and other properties.
  */
 interface ILocalEntity {

package/dist/menus/menusApi.d.ts

@@ -19,7 +19,7 @@ export default class MenusApi extends AsyncModules implements IMenus {
     /**
      * Get pages includes in menu by marker.
      * @handleName getMenusByMarker
-     * @param {string} marker - Menu marker. Example: "main_menu".
+     * @param {string} marker - Marker of the menu. Example: "main_menu".
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<IMenusEntity | IError>} Returns a single menu object as a ContentMenu object with included pages.
      * @throws {IError} When isShell=false and an error occurs during the fetch

package/dist/menus/menusApi.js

@@ -57,7 +57,7 @@ class MenusApi extends asyncModules_1.default {
     /**
      * Get pages includes in menu by marker.
      * @handleName getMenusByMarker
-     * @param {string} marker - Menu marker. Example: "main_menu".
+     * @param {string} marker - Marker of the menu. Example: "main_menu".
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<IMenusEntity | IError>} Returns a single menu object as a ContentMenu object with included pages.
      * @throws {IError} When isShell=false and an error occurs during the fetch

package/dist/menus/menusInterfaces.d.ts

@@ -7,7 +7,7 @@ interface IMenus {
     /**
      * Get pages includes in menu by marker.
      * @handleName getMenusByMarker
-     * @param {string} marker - Menu marker. Example: "main_menu".
+     * @param {string} marker - Marker of the menu. Example: "main_menu".
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @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.
@@ -17,7 +17,7 @@ interface IMenus {
 }
 /**
  * @interface IMenusPages
- * @property {IMenusPages[]} children - Contains array with child page objects.
+ * @property {IMenusPages[]} children - Nested menu items (child pages).
  * @example
     [
       {
@@ -29,21 +29,21 @@ interface IMenus {
         "position": 1
       }
     ]
- * @property {number | null} id - The unique identifier of the menu. Example: 1.
- * @property {string | null} pageUrl - The page url string. Example: "about".
- * @property {ILocalizeInfo} localizeInfos - The menu data, taking into account localization.
+ * @property {number | null} id - ID of the menu. Example: 1.
+ * @property {string | null} pageUrl - URL of the page. Example: "about".
+ * @property {ILocalizeInfo} localizeInfos - Localized menu data.
  * @example
     {
       "title": "menu"
     }
- * @property {IAttributeValues} attributeValues - Attributes sets.
+ * @property {IAttributeValues} attributeValues - Attribute values of the page, keyed by attribute marker.
  * @example
     {
       "color": "red",
       "size": "large"
     }
- * @property {number} position - The menu position. Example: 1.
- * @property {number | null} parentId - The menu parent id. Example: null.
+ * @property {number} position - Position used for sorting. Example: 1.
+ * @property {number | null} parentId - ID of the parent menu item; `null` for a top-level item. Example: null.
  * @property {'page' | 'custom' | null} [parentType] - Kind of the parent item: `page` for a menu page, `custom` for a custom item; `null` together with `parentId` means top level. Page ids and custom item ids overlap, so the parent is ambiguous without it. Example: null.
  * @property {'page' | 'custom'} [itemType] - Kind of this item itself: `page` or `custom`. This is the value the item's children must pass in `parentType`. Example: "page".
  * @description This interface defines the structure of a menu page entity, including its identifiers, localization information, attributes, and hierarchical relationships.
@@ -61,14 +61,14 @@ interface IMenusPages {
 }
 /**
  * @interface IMenusEntity
- * @property {number} id - The unique identifier of the menu. Example: 1.
- * @property {string} identifier - The menu identifier. Example: "main_menu".
- * @property {ILocalizeInfo} localizeInfos - Contains localization information.
+ * @property {number} id - ID of the menu. Example: 1.
+ * @property {string} identifier - Marker of the menu. Example: "main_menu".
+ * @property {ILocalizeInfo} localizeInfos - Localized menu data.
  * @example
     {
       "title": "menu"
     }
- * @property {IMenusPages[]} pages - Array of menu pages.
+ * @property {IMenusPages[]} pages - Pages in the menu.
  * @example
     [
       {