oneentry 1.0.122 → 1.0.124

package/dist/admins/adminsApi.d.ts

@@ -3,22 +3,30 @@ import type StateModule from '../base/stateModule';
 import type { AttributeType, IError } from '../base/utils';
 import type { IAdminEntity, IAdmins } from './adminsInterfaces';
 /**
- * Controllers for working with users - admins
- * @handle /api/content/admins
+ * Controllers for working with users - admins.
+ *
+ * @module AdminsApi
+ *
+ * @description This module provides methods for working with users - admins, including retrieving information about all admins.
  */
 export default class AdminsApi extends AsyncModules implements IAdmins {
     protected state: StateModule;
     protected _url: string;
     constructor(state: StateModule);
     /**
-     * Get all user objects - admins.
+     * Get all admins objects with filters.
      *
-     * @param {Array<any>} [body] - array of objects AttributeType
-     * @param {string} [langCode] - Language code. Default "en_US"
-     * @param {number} [offset] - Optional parameter for pagination, default is 0
-     * @param {number} [limit] - Optional parameter for pagination, default is 30
+     * @handleName getAdminsInfo
      *
-     * @returns Returns all AdminEntity user objects
+     * @param {AttributeType[]} [body] - Array of filter objects with search conditions. Default: [].
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Parameter for pagination. Default: 0.
+     * @param {number} [limit] - Parameter for pagination. Default: 30.
+     *
+     * @return {IAdminEntity[]} Returns an array of admin 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.
      */
     getAdminsInfo(body?: Array<AttributeType>, langCode?: string, offset?: number, limit?: number): Promise<Array<IAdminEntity> | IError>;
 }

package/dist/admins/adminsApi.js

@@ -5,23 +5,31 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 /**
- * Controllers for working with users - admins
- * @handle /api/content/admins
+ * Controllers for working with users - admins.
+ *
+ * @module AdminsApi
+ *
+ * @description This module provides methods for working with users - admins, including retrieving information about all admins.
  */
 class AdminsApi extends asyncModules_1.default {
     constructor(state) {
         super(state);
-        this._url = state.url + '/api/content/admins';
+        this._url = state.url + '/api/content/admins/all';
     }
     /**
-     * Get all user objects - admins.
+     * Get all admins objects with filters.
      *
-     * @param {Array<any>} [body] - array of objects AttributeType
-     * @param {string} [langCode] - Language code. Default "en_US"
-     * @param {number} [offset] - Optional parameter for pagination, default is 0
-     * @param {number} [limit] - Optional parameter for pagination, default is 30
+     * @handleName getAdminsInfo
      *
-     * @returns Returns all AdminEntity user objects
+     * @param {AttributeType[]} [body] - Array of filter objects with search conditions. Default: [].
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Parameter for pagination. Default: 0.
+     * @param {number} [limit] - Parameter for pagination. Default: 30.
+     *
+     * @return {IAdminEntity[]} Returns an array of admin 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.
      */
     async getAdminsInfo(body = [], langCode = this.state.lang, offset = 0, limit = 30) {
         const query = {
@@ -29,7 +37,7 @@ class AdminsApi extends asyncModules_1.default {
             offset,
             limit,
         };
-        const response = await this._fetchPost(`/?` + this._queryParamsToString(query), body);
+        const response = await this._fetchPost(`?` + this._queryParamsToString(query), body);
         return this._normalizeData(response, langCode);
     }
 }

package/dist/admins/adminsInterfaces.d.ts

@@ -1,22 +1,40 @@
 import type { AttributeType, IError } from '../base/utils';
 /**
- * Represents a interface object of Admins Api.
+ * @interface IAdmins
  *
- * @property {function} [getAdminsInfo] - Get all user objects - admins.
+ * @property {function} getAdminsInfo - Method to retrieve all admin user objects.
+ *
+ * @description This interface defines the contract for any class that implements it
  */
 interface IAdmins {
+    /**
+     * Fetches information about admins.
+     *
+     * @param {AttributeType[]} body - An array of attributes used to filter or modify the query. Default: [].
+     * @param {string} [langCode] - The language code for localization purposes. Default: "en_US".
+     * @param {number} [offset] - The starting point for pagination. Default: 0.
+     * @param {number} [limit] - The maximum number of results to return. Default: 30.
+     *
+     * @return {IAdminEntity[]} Returns an array of admin 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.
+     */
     getAdminsInfo(body: Array<AttributeType>, langCode: string, offset: number, limit: number): Promise<Array<IAdminEntity> | IError>;
 }
 /**
- * Represents a position object.
- *
- * @interface
- * @property {number} [id] - The unique identifier of the position.
- * @property {number} [position] - The position of the object.
- * @property {number} [objectId] - The unique identifier of the object.
- * @property {string} [objectType] - The type of the object.
- * @property {boolean} [isLocked] - Indicates whether the position is locked or not.
- * @property {number} [objectCategoryId] - The unique identifier of the object's category.
+ * Interface representing a Position entity.
+ *
+ * @interface IPosition
+ *
+ * @property {number} id - The unique identifier of the position. Example: 1764.
+ * @property {number} position - The position of the object. Example: 192.
+ * @property {number} objectId - The unique identifier of the object. Example: 120.
+ * @property {string} objectType - The type of the object. Example: "admin".
+ * @property {boolean} [isLocked] - Indicates whether the position is locked or not. Example: false.
+ * @property {number} [objectCategoryId] - The unique identifier of the object's category. Example: 5.
+ *
+ * @description This interface outlines the properties associated with a position within a system.
  */
 interface IPosition {
     id: number;
@@ -27,15 +45,18 @@ interface IPosition {
     objectCategoryId?: number;
 }
 /**
- * Represents an object with various properties.
- *
- * @interface
- * @property {number} [id] - The identifier of the object.
- * @property {string} [identifier] - The textual identifier for the record field.
- * @property {number} [attributeSetId] - The identifier of the attribute set being used.
- * @property {boolean} [isSync] - Indication of page indexing.
- * @property {Record<string, any>} [attributeValues] - The attributes with values used by the object.
- * @property {number} [position] - The position of the object.
+ * Interface representing an Admin Entity.
+ *
+ * @interface IAdminEntity
+ *
+ * @property {number} id - The identifier of the object. Example: 1764.
+ * @property {string} identifier - The textual identifier for the record field. Example: "admin1".
+ * @property {number} attributeSetId - The identifier of the attribute set being used. Example: 120.
+ * @property {boolean} isSync - Page indexing flag (true or false). Example: true.
+ * @property {any} attributeValues - Array of attribute values from the index (presented as a pair of user attribute identifier: attribute value). Example: [{"marker": { "value": "", "type": "string" }},].
+ * @property {number} position - Position number (for sorting). Example: 192
+ *
+ * @description This interface captures the essential details and additional attributes of an admin entity.
  */
 interface IAdminEntity {
     id: number;
@@ -47,12 +68,15 @@ interface IAdminEntity {
     [key: string]: any;
 }
 /**
- * Represents IAdmin query parameters object.
+ * Interface representing a query for fetching admin data.
+ *
+ * @interface IAdminQuery
+ *
+ * @property {number} langCode - Language code. Default: "en_US".
+ * @property {number} offset - Parameter for pagination. Default: 0.
+ * @property {number} limit - Parameter for pagination. Default: 30.
  *
- * @interface
- * @property {number} [langCode] - Language code. Default "en_US"
- * @property {number} [offset] - Parameter for pagination, default 0.
- * @property {number} [limit] - Parameter for pagination, default 30.
+ * @description This interface defines the parameters required for querying admin data, including optional defaults.
  */
 interface IAdminQuery {
     langCode: string;

package/dist/attribute-sets/attributeSetsApi.d.ts

@@ -4,51 +4,73 @@ import type { IError } from '../base/utils';
 import type { IAttributeSetsEntity, IAttributesSets, IAttributesSetsEntity, IAttributesSetsResponse } from './attributeSetsInterfaces';
 /**
  * Controllers for working with attributes - AttributesSetsApi.
- * @handle /api/content/attributes-sets
- * @class
+ *
+ * @module AttributesSetsApi
+ *
+ * @description This class provides methods to interact with attribute sets, including fetching attributes, getting attributes by marker, and retrieving single attributes by marker and set.
  */
 export default class AttributesSetsApi extends AsyncModules implements IAttributesSets {
     protected state: StateModule;
     protected _url: string;
     constructor(state: StateModule);
     /**
-     * Getting all attribute sets objects
+     * Getting all attribute sets objects.
      *
-     * @param {number} [langCode] - Language code.
-     * @param {number} [limit] - parameter limiting the selection of records, default - 30. Example : 30
-     * @param {number} [offset] - parameter offset of record selection, default - 0.Example : 0
-     * @param {number} [typeId] - identifier of the attribute set type. Example : null
-     * @param {string} [sortBy] - identifier of the attribute set type. Example : null
+     * @handleName getAttributes
      *
-     * @returns Returns an array of AttributeInSet objects.
+     * @param {number} [langCode] - Language code. Default: "en_US".
+     * @param {number} [limit] - parameter limiting the selection of records. Default: 30.
+     * @param {number} [offset] - parameter offset of record selection. Default: 0.
+     * @param {number} [typeId] - identifier of the attribute set type. Example: null.
+     * @param {string} [sortBy] - identifier of the attribute set type. Example: null.
+     *
+     * @return {IAttributesSetsResponse} Returns object with array of IAttributeSetsEntity and total items count.
+     * @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.
      */
     getAttributes(langCode?: string, offset?: number, limit?: number, typeId?: any, sortBy?: string): Promise<IAttributesSetsResponse | IError>;
     /**
-     * Getting all attributes with data from the attribute set
+     * Getting all attributes with data from the attribute set.
+     *
+     * @handleName getAttributesByMarker
+     *
+     * @param {string} marker - Attribute marker. Example: 'productAttributes'.
+     * @param {string} [langCode] - Language code. Default: "en_US".
      *
-     * @param {string} [marker] - Attribute marker.
-     * @param {string} [langCode] - Language code.
+     * @return {IAttributesSetsEntity} Returns an array of Attributes objects.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      *
-     * @returns Returns an array of AttributeInSet objects.
+     * @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.
      */
     getAttributesByMarker(marker: string, langCode?: string): Promise<Array<IAttributesSetsEntity> | IError>;
     /**
      * Get a single attribute with data from the attribute sets.
      *
-     * @param {string} [setMarker]  - Text identifier (marker) of the attribute set.
-     * @param {string} [attributeMarker]  - Text identifier (marker) of the attribute in the set.
-     * @param {string} [langCode] - Language code.
+     * @handleName getSingleAttributeByMarkerSet
      *
-     * @returns Returns a AttributeInSet object.
+     * @param {string} setMarker - Text identifier (marker) of the attribute set. Example: 'productAttributes'.
+     * @param {string} attributeMarker - Text identifier (marker) of the attribute in the set. Example: 'color'.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {IAttributesSetsEntity} Returns a single attribute object from the attribute set.
+     * @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.
      */
     getSingleAttributeByMarkerSet(setMarker: string, attributeMarker: string, langCode?: string): Promise<IAttributesSetsEntity | IError>;
     /**
-     * Getting a single object from a set of attributes by marker
+     * Getting a single object from a set of attributes by marker.
+     *
+     * @handleName getAttributeSetByMarker
+     *
+     * @param {string} marker - marker of the attribute set object. Example: 'productAttributes'.
+     * @param {string} [langCode] - Language code. Default: "en_US".
      *
-     * @param {string} [marker] - marker of the attribute set object
-     * @param {string} [langCode] - Language code.
+     * @return {IAttributeSetsEntity} Returns one object of the attribute set.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      *
-     * @returns Returns one object of the attribute set
+     * @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.
      */
     getAttributeSetByMarker(marker: string, langCode?: string): Promise<IAttributeSetsEntity | IError>;
 }

package/dist/attribute-sets/attributeSetsApi.js

@@ -3,12 +3,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-/* eslint-disable @typescript-eslint/no-explicit-any */
 const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 /**
  * Controllers for working with attributes - AttributesSetsApi.
- * @handle /api/content/attributes-sets
- * @class
+ *
+ * @module AttributesSetsApi
+ *
+ * @description This class provides methods to interact with attribute sets, including fetching attributes, getting attributes by marker, and retrieving single attributes by marker and set.
  */
 class AttributesSetsApi extends asyncModules_1.default {
     constructor(state) {
@@ -16,17 +17,25 @@ class AttributesSetsApi extends asyncModules_1.default {
         this._url = state.url + '/api/content/attributes-sets';
     }
     /**
-     * Getting all attribute sets objects
+     * Getting all attribute sets objects.
      *
-     * @param {number} [langCode] - Language code.
-     * @param {number} [limit] - parameter limiting the selection of records, default - 30. Example : 30
-     * @param {number} [offset] - parameter offset of record selection, default - 0.Example : 0
-     * @param {number} [typeId] - identifier of the attribute set type. Example : null
-     * @param {string} [sortBy] - identifier of the attribute set type. Example : null
+     * @handleName getAttributes
      *
-     * @returns Returns an array of AttributeInSet objects.
+     * @param {number} [langCode] - Language code. Default: "en_US".
+     * @param {number} [limit] - parameter limiting the selection of records. Default: 30.
+     * @param {number} [offset] - parameter offset of record selection. Default: 0.
+     * @param {number} [typeId] - identifier of the attribute set type. Example: null.
+     * @param {string} [sortBy] - identifier of the attribute set type. Example: null.
+     *
+     * @return {IAttributesSetsResponse} Returns object with array of IAttributeSetsEntity and total items count.
+     * @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 getAttributes(langCode = this.state.lang, offset = 0, limit = 30, typeId = null, sortBy = 'id') {
+    async getAttributes(langCode = this.state.lang, offset = 0, limit = 30, 
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    typeId = null, sortBy = 'id') {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         const query = {
             langCode,
             offset,
@@ -34,16 +43,21 @@ class AttributesSetsApi extends asyncModules_1.default {
             typeId,
             sortBy,
         };
-        const result = await this._fetchGet(`/?` + this._queryParamsToString(query));
+        const result = await this._fetchGet(`?` + this._queryParamsToString(query));
         return this._dataPostProcess(result, langCode);
     }
     /**
-     * Getting all attributes with data from the attribute set
+     * Getting all attributes with data from the attribute set.
+     *
+     * @handleName getAttributesByMarker
+     *
+     * @param {string} marker - Attribute marker. Example: 'productAttributes'.
+     * @param {string} [langCode] - Language code. Default: "en_US".
      *
-     * @param {string} [marker] - Attribute marker.
-     * @param {string} [langCode] - Language code.
+     * @return {IAttributesSetsEntity} Returns an array of Attributes objects.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      *
-     * @returns Returns an array of AttributeInSet objects.
+     * @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 getAttributesByMarker(marker, langCode = this.state.lang) {
         const result = await this._fetchGet(`/${marker}/attributes?langCode=${langCode}`);
@@ -52,26 +66,36 @@ class AttributesSetsApi extends asyncModules_1.default {
     /**
      * Get a single attribute with data from the attribute sets.
      *
-     * @param {string} [setMarker]  - Text identifier (marker) of the attribute set.
-     * @param {string} [attributeMarker]  - Text identifier (marker) of the attribute in the set.
-     * @param {string} [langCode] - Language code.
+     * @handleName getSingleAttributeByMarkerSet
      *
-     * @returns Returns a AttributeInSet object.
+     * @param {string} setMarker - Text identifier (marker) of the attribute set. Example: 'productAttributes'.
+     * @param {string} attributeMarker - Text identifier (marker) of the attribute in the set. Example: 'color'.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {IAttributesSetsEntity} Returns a single attribute object from the attribute set.
+     * @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 getSingleAttributeByMarkerSet(setMarker, attributeMarker, langCode = this.state.lang) {
         const result = await this._fetchGet(`/${setMarker}/attributes/${attributeMarker}?langCode=${langCode}`);
         return result;
     }
     /**
-     * Getting a single object from a set of attributes by marker
+     * Getting a single object from a set of attributes by marker.
+     *
+     * @handleName getAttributeSetByMarker
+     *
+     * @param {string} marker - marker of the attribute set object. Example: 'productAttributes'.
+     * @param {string} [langCode] - Language code. Default: "en_US".
      *
-     * @param {string} [marker] - marker of the attribute set object
-     * @param {string} [langCode] - Language code.
+     * @return {IAttributeSetsEntity} Returns one object of the attribute set.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      *
-     * @returns Returns one object of the attribute set
+     * @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 getAttributeSetByMarker(marker, langCode = this.state.lang) {
-        const result = await this._fetchGet(`/marker/${marker}/?langCode=${langCode}`);
+        const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);
         return this._dataPostProcess(result, langCode);
     }
 }

package/dist/attribute-sets/attributeSetsInterfaces.d.ts

@@ -1,21 +1,45 @@
 import type { IError } from '../base/utils';
 /**
- * Represents an interface object of AttributesSets Api.
+ * @interface IAttributesSets
  *
  * @property {function} getAttributesByMarker - Get all attributes with data from the attribute sets.
  * @property {function} getSingleAttributeByMarkerSet - Get a single attribute with data from the attribute sets.
+ *
+ * @description This interface defines methods for retrieving attributes based on markers and language codes.
  */
 interface IAttributesSets {
+    /**
+     * Fetches attributes by a specific marker.
+     *
+     * @param {string} marker - The marker used to identify the attribute set. Example: 'productAttributes'.
+     * @param {string} langCode - The language code for localization purposes. Default: 'en_US'.
+     *
+     * @returns {IAttributesSetsEntity[]} A promise that resolves to an array of attribute set entities or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     getAttributesByMarker(marker: string, langCode: string): Promise<Array<IAttributesSetsEntity> | IError>;
+    /**
+     * Fetches a single attribute by its marker and the set marker.
+     *
+     * @param {string} attributeMarker - The marker identifying the attribute. Example: 'color'.
+     * @param {string} setMarker - The marker identifying the attribute set. Example: 'productAttributes'.
+     * @param {string} langCode - The language code for localization purposes. Default: 'en_US'.
+     *
+     * @returns {IAttributesSetsEntity} A promise that resolves to an attribute set entity or an error.
+     */
     getSingleAttributeByMarkerSet(attributeMarker: string, setMarker: string, langCode: string): Promise<IAttributesSetsEntity | IError>;
 }
 /**
- * Represents an interface object of IListTitle.
+ * Interface representing the structure of a list item.
+ *
+ * @interface IListTitle
  *
- * @property {string} title - The title or name associated with the list item.
- * @property {number | string} value - The value of the list item, which can be either a number or a string depending on the context.
- * @property {string | number | null} position - The position of the list item, which can be represented as a string, number, or null if not applicable.
+ * @property {string} title - The title or name associated with the list item. Example: "Item Name"
+ * @property {number | string} value - The value of the list item, which can be either a number or a string depending on the context. Example: 42
+ * @property {string | number | null} position - The position of the list item, which can be represented as a string, number, or null if not applicable. Example: 1
  * @property {object} extended - An object containing additional properties or metadata related to the list item. This could include any extra details that extend the basic information.
+
+ * @description This interface defines the structure of a list item, which includes properties for the title, value, position, and extended information.
  */
 interface IListTitle {
     title: string;
@@ -26,19 +50,29 @@ interface IListTitle {
         type: string | null;
     };
 }
+/**
+ * AttributeType
+ *
+ * @type {AttributeType}
+ * @description This type defines the possible values for attribute types used in the system.
+ */
 type AttributeType = 'string' | 'text' | 'textWithHeader' | 'integer' | 'real' | 'float' | 'dateTime' | 'date' | 'time' | 'file' | 'image' | 'groupOfImages' | 'radioButton' | 'list' | 'button';
 /**
- * Represents a template entity object.
+ * Interface representing an attribute set entity.
  *
- * @interface
- * @property {AttributeType} type - Attribute type.
- * @property {string} marker - Textual identifier of the attribute (marker).
- * @property {number} position - Position number for sorting.
- * @property {Record<string, any>} validators - Set of validators for validation.
+ * @interface IAttributesSetsEntity
+ *
+ * @property {AttributeType} type - Attribute type. Example: 'string', 'text', 'integer', etc.
+ * @property {string} marker - Textual identifier of the attribute (marker). Example: 'color', 'size', etc.
+ * @property {number} position - Position number for sorting. Example: 1
+ * @property {Record<string, any>} validators - Set of validators for validation. Example: { required: true, minLength: 3 }.
  * @property {Record<string, any>} localizeInfos - The name of the template, taking into account localization.
  * @property {Array<Record<string, any>>} listTitles - Array of values (with extended data) for list and radioButton attributes.
- * @property {Array<Record<string, any>>} settings -  Additional attribute settings (optional).
+ * @property {Record<string, any>} additionalFields - Additional fields for the attribute (optional).
+ * @property {Array<Record<string, any>>} [settings] -  Additional attribute settings (optional).
+ * @property {any} value - Value of the attribute, which can be of any type
  *
+ * @description This interface defines the structure of an attribute set entity, including its type, marker, position, validators, localization information, list titles, additional fields, and settings.
  */
 interface IAttributesSetsEntity {
     type: AttributeType;
@@ -49,19 +83,26 @@ interface IAttributesSetsEntity {
     listTitles: Array<IListTitle> | Record<string, any>;
     additionalFields?: Record<string, any>;
     settings?: Record<string, any>;
+    value: any;
 }
 /**
- * Represents an interface object of IAttributeSetsEntity.
+ * Interface representing an attribute set entity.
+ *
+ * @interface IAttributeSetsEntity
  *
- * @property {number} id - The unique identifier of the attribute set entity.
- * @property {string} identifier - A string that uniquely identifies the attribute set.
- * @property {boolean} isVisible - Indicates whether the attribute set is visible or not.
+ * @property {number} position - The position number for sorting the attribute set. Example: 1.
+ * @property {number} id - The unique identifier of the attribute set entity. Example: 123.
+ * @property {string} identifier - A string that uniquely identifies the attribute set. Example: "attributeSet1".
+ * @property {boolean} isVisible - Indicates whether the attribute set is visible or not. Example: true.
  * @property {any} schema - The schema definition associated with the attribute set. This could represent the structure or rules for the data.
- * @property {string} title - The title or name of the attribute set.
- * @property {any} type - The type of the attribute set, which could be a specific classification or category.
- * @property {number} typeId - The numerical identifier representing the type of the attribute set.
- * @property {string} updatedDate - The date when the attribute set was last updated, represented as a string. Consider using Date for better date handling.
- * @property {number} version - The version number of the attribute set, used for tracking changes or updates.
+ * @property {string} title - The title or name of the attribute set. Example: "Product Attributes".
+ * @property {any} type - The type of the attribute set, which could be a specific classification or category. Example: "product", "user", etc.
+ * @property {number} typeId - The numerical identifier representing the type of the attribute set. Example: 1.
+ * @property {string} updatedDate - The date when the attribute set was last updated, represented as a string. Example: "2023-10-01T12:00:00Z".
+ * @property {number} version - The version number of the attribute set, used for tracking changes or updates. Example: 1.
+ * @property {any} properties - Additional properties associated with the attribute set, which can be of any type. Example: { color: "red", size: "M" }.
+ *
+ * @description This interface defines the structure of an attribute set entity.
  */
 interface IAttributeSetsEntity {
     id: number;
@@ -74,12 +115,17 @@ interface IAttributeSetsEntity {
     typeId: number;
     updatedDate: string;
     version: number;
+    properties: any;
 }
 /**
- * Represents an interface object of IAttributesSetsResponce.
+ * Interface defining the structure of a response object for attribute sets.
+ *
+ * @interface IAttributesSetsResponse
+ *
+ * @property {IAttributeSetsEntity[]} items - IAttributeSetsEntity array containing attribute set entities. Example: [{ id: 1, identifier: 'set1', ... }, { id: 2, identifier: 'set2', ... }].
+ * @property {number} total - Total items. Example: 100.
  *
- * @property {IAttributeSetsEntity[]} items - IAttributeSetsEntity
- * @property {number} total - total items
+ * @description This interface defines the structure of a response object for attribute sets.
  */
 interface IAttributesSetsResponse {
     items: IAttributeSetsEntity[];