oneentry 1.0.123 → 1.0.124

package/dist/integration-collections/integrationCollectionsApi.js

@@ -3,15 +3,21 @@ 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.
+ *
  * @handle /api/content/integration-collections
+ * @class IntegrationCollectionsApi
+ * @extends 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
         this._defaultQuery = {
             langCode: 'en_US',
             offset: 0,
@@ -20,149 +26,176 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
         this._url = state.url + '/api/content/integration-collections';
     }
     /**
-     * Get all collections
+     * Get all collections.
      *
-     * @param {string} [langCode] - Language code.
+     * @handleName getICollections
+     *
+     * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {any} [userQuery] - Optional set query parameters.
+     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 0.
+     * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 30.
+     * @param {number} [userQuery.entityType] - Entity type. Example: 1.
+     * @param {number} [userQuery.entityId] - Entity identifier. Example: orders.
      *
-     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 0
-     * @param {number} [userQuery.offset] - Optional parameter for pagination, default is 30
+     * @return {ICollection[]} 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.
      *
-     * @returns Returns an array of ICollections 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 getICollections(langCode = this.state.lang, userQuery) {
+    async getICollections(langCode = this.state.lang, 
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    userQuery) {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         const query = { ...this._defaultQuery, ...userQuery, langCode };
-        const result = await this._fetchGet(`/?` + this._queryParamsToString(query));
+        const result = await this._fetchGet(`?` + this._queryParamsToString(query));
         return this._dataPostProcess(result, langCode);
     }
     /**
      * Get a single collection object by id.
      *
-     * @param {number} [id] - Collection id.
-     * @param {string} [langCode] - Language code.
+     * @handleName getICollectionById
+     *
+     * @param {number} id - Collection id. Example: 1.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {ICollection} 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.
      *
-     * @returns Returns single ICollection 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 query = { langCode };
-        const result = await this._fetchGet(`/${id}/?` + this._queryParamsToString(query));
+        const result = await this._fetchGet(`/${id}?` + this._queryParamsToString(query));
         return this._dataPostProcess(result, langCode);
     }
     /**
      * Get all records belonging to the collection by collection id.
      *
-     * @param {number} [id] - Collection id.
-     * @param {string} [langCode] - Language code.
-     * @param {any} [userQuery] - Optional set query parameters.
+     * @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: .
+     *
+     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 0.
+     * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 30.
+     * @param {number} [userQuery.entityType] - Entity type. Example: 1.
+     * @param {number} [userQuery.entityId] - Entity identifier. Example: "orders".
      *
-     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 0
-     * @param {number} [userQuery.offset] - Optional parameter for pagination, default is 30
-     * @param {number} [userQuery.entityType] - Entity type. Example: 1
-     * @param {number} [userQuery.entityId] - Entity identifier. Example: orders
+     * @return {ICollectionResponce} 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.
      *
-     * @returns Returns object ItemsWithTotal, where items is an array of requested objects
+     * @description Get all records belonging to the collection by collection id.
      */
-    async getICollectionRowsById(id, langCode = this.state.lang, userQuery) {
+    async getICollectionRowsById(id, langCode = this.state.lang, 
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    userQuery) {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         const query = { ...this._defaultQuery, ...userQuery, langCode };
-        const result = await this._fetchGet(`/${id}/rows/?` + this._queryParamsToString(query));
+        const result = await this._fetchGet(`/${id}/rows?` + this._queryParamsToString(query));
         return this._dataPostProcess(result, langCode);
     }
     /**
-     * Check for the existence of a text identifier (marker)
+     * Check for the existence of a text identifier (marker).
      *
-     * @param {string} [marker] - Collection marker.
+     * @handleName validateICollectionMarker
      *
-     * @returns Returns object with value true if text identifier (marker) exists or false if not
+     * @param {string} marker - Collection marker. Example: "collection1".
+     *
+     * @return {any} Returns an object with a boolean property `valid` indicating whether the marker is valid or not.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description
      */
     async validateICollectionMarker(marker) {
-        const result = await this._fetchGet(`/marker-validation/${marker}/`);
+        const result = await this._fetchGet(`/marker-validation/${marker}`);
         return this._dataPostProcess(result);
     }
     /**
      * Getting all records from the collection.
      *
-     * @param {string} [marker] - Collection text identifier
-     * @param {string} [langCode] - Language code.
+     * @handleName getICollectionRowsByMarker
+     *
+     * @param {string} marker - Collection text identifier. Example: "collection1".
+     * @param {string} [langCode] - Language code. Default: "en_US".
      *
-     * @returns Returns CollectionRowEntity object.
+     * @return {any} 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.
      */
     async getICollectionRowsByMarker(marker, langCode = this.state.lang) {
-        const result = await this._fetchGet(`/marker/${marker}/rows/?langCode=${langCode}`);
+        const result = await this._fetchGet(`/marker/${marker}/rows?langCode=${langCode}`);
         return this._dataPostProcess(result, langCode);
     }
     /**
      * Getting one record from the collection.
      *
-     * @param {string} [marker] - Collection text identifier
-     * @param {number} [id] - Collection record identifier
-     * @param {string} [langCode] - Language code.
+     * @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".
      *
-     * @returns Returns CollectionRowEntity object.
+     * @return {any} 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.
      */
     async getICollectionRowByMarkerAndId(marker, id, langCode = this.state.lang) {
-        const result = await this._fetchGet(`/marker/${marker}/rows/${id}/?langCode=${langCode}`);
+        const result = await this._fetchGet(`/marker/${marker}/rows/${id}?langCode=${langCode}`);
         return this._dataPostProcess(result, langCode);
     }
     /**
-     * Create a record in the collection
-     *
-     * @param {string} [marker] - Collection text identifier. Example : collection1
-     * @param {ICollectionFormObject} [body] - Object for creating a record
-     * const body: ICollectionFormObject = {
-        "formIdentifier": "collection-form",
-        "formData": {
-          "en_US": [
-            {
-              "marker": "collection_marker",
-              "type": "string",
-              "value": "Collection marker"
-            }
-          ]
-        }
-      }
-     * @param {string} [langCode] - Language code.
-     *
-     * @description Create a record in the collection
+     * 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" } ] } }
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {any} 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.
      */
     async createICollectionRow(marker, body, langCode = this.state.lang) {
-        const response = await this._fetchPost(`/marker/${marker}/rows/?` + `langCode=${langCode}`, body);
+        const response = await this._fetchPost(`/marker/${marker}/rows?langCode=${langCode}`, body);
         return this._normalizeData(response, langCode);
     }
     /**
-     * Edit a record in the collection
-     *
-     * @param {string} [marker] - text identifier of the collection
-     * @param {number} [id] - row id
-     * @param {any} [body] - Object for updating a record in the collection
-     *
-     * const body = {
-        "formIdentifier": "collection-form",
-        "formData": {
-          "en_US": [
-            {
-              "marker": "collection_marker",
-              "type": "string",
-              "value": "Collection marker"
-            }
-          ]
-        }
-      }
-     *
-     * @param {string} [langCode] - language code
-     *
-     * @returns Returns object
+     * 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" } ] } }
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {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.
      */
     async updateICollectionRow(marker, id, body, langCode = this.state.lang) {
-        const response = await this._fetchPut(`/marker/${marker}/rows/${id}/?` + `langCode=${langCode}`, body);
+        const response = await this._fetchPut(`/marker/${marker}/rows/${id}?` + `langCode=${langCode}`, body);
         return this._normalizeData(response, langCode);
     }
     /**
      * Deletion of collection record object
      *
-     * @param {string} [marker] - text identifier of the collection Example : collection1
-     * @param {number} [id] - record identifier in the collection Example : 12
+     * @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)
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      *
-     * @returns Returns true (in case of successful deletion) or false (in case of unsuccessful deletion) (permission "collections.row.delete" required for access)
+     * @description
      */
     async deleteICollectionRowByMarkerAndId(marker, id) {
         const result = await this._fetchDelete(`/marker/${marker}/rows/${id}`);

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

@@ -1,35 +1,135 @@
 import type { IError } from '../base/utils';
 /**
- * Represents an interface object of ICollections Api.
+ * @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} [getICollectionRowByMarkerAndId] - Getting one record (row) 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 {
-    getICollections(marker: string, langCode: string, userQuery?: any): Promise<Array<any> | IError>;
-    getICollectionById(id: number, langCode: string): Promise<any | IError>;
+    /**
+     * Get all collections.
+     *
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {any} [userQuery] - Optional set query parameters.
+     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 0.
+     * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 30.
+     * @param {number} [userQuery.entityType] - Entity type. Example: .
+     * @param {number} [userQuery.entityId] - Entity identifier. Example: .
+     *
+     * @return {ICollection[]} 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.
+     */
+    getICollections(marker: string, langCode: string, userQuery?: any): Promise<Array<ICollection> | IError>;
+    /**
+     * Get a single collection object by id.
+     *
+     * @param {number} id - Collection id. Example: 1.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {ICollection} 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.
+     */
+    getICollectionById(id: number, langCode: string): Promise<ICollection | IError>;
+    /**
+     * Get all records belonging to the collection by collection id.
+     *
+     * @param {number} id - Collection id.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {any} [userQuery] - Optional set query parameters.
+     *
+     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 0.
+     * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 30.
+     * @param {number} [userQuery.entityType] - Entity type. Example: .
+     * @param {number} [userQuery.entityId] - Entity identifier. Example: .
+     *
+     * @return {ICollectionResponce} 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.
+     */
     getICollectionRowsById(id: number, langCode: string, userQuery?: any): Promise<any | IError>;
+    /**
+     * Check for the existence of a text identifier (marker).
+     *
+     * @param {string} marker - Collection marker. Example: "collection1".
+     *
+     * @return {any} Returns an object with a boolean property `valid` indicating whether the marker is valid or not.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     validateICollectionMarker(marker: string): Promise<any | IError>;
+    /**
+     * Getting all records from the collection.
+     *
+     * @param {string} marker - Collection text identifier. Example: "collection1".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {any} Returns CollectionRowEntity object.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
+    getICollectionRowsByMarker(marker: string, langCode?: string): Promise<any | IError>;
+    /**
+     * Getting one record from the collection.
+     *
+     * @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 {any} Returns CollectionRowEntity object.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     getICollectionRowByMarkerAndId(marker: string, id: number, langCode: string): Promise<any | IError>;
+    /**
+     * Create a record in the collection.
+     *
+     * @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" } ] } }
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {any} Returns object of type ICollectionRow.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     createICollectionRow(marker: string, body: any, langCode: string): Promise<Array<any> | IError>;
+    /**
+     * Edit a record in the collection.
+     *
+     * @param {string} marker - Text identifier of the collection. Example: "collection1".
+     * @param {number} id - Row id. 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" } ] } }
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {ICollectionRow} Returns object of type ICollectionRow.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     updateICollectionRow(marker: string, id: number, body: any, langCode: string): Promise<any | IError>;
+    /**
+     * Deletion of collection record object
+     *
+     * @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)
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     deleteICollectionRowByMarkerAndId(marker: string, id: number): Promise<any | IError>;
 }
 /**
- * ICollection
+ * @interface ICollection
+ *
+ * @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 {object} localizeInfos - Localized information about the collection. Example: .
+ * @property {string | null} attributeSetId - Identifier of the set of attributes used by the form attached to the collection. Example: "attributeSet1" 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} [id] - Object identifier
- * @property {object} [localizeInfos] - Name considering localization
- * @property {string | null} [identifier] - Text identifier for record field
- * @property {number | null} [formId] - Identifier for the form used by the order storage
- * @property {string | null} [attributeSetId] - Identifier of the set of attributes used by the form attached to the collection
- * @property {string | null} [selectedAttributeMarkers] - Text identifiers of form object attributes for display in the data table
+ * @description Represents a collection object with various properties, including identifiers, form information, and localized data.
  */
 interface ICollection {
     id: number;
@@ -40,21 +140,25 @@ interface ICollection {
     selectedAttributeMarkers: string | null;
 }
 /**
- * ICollectionResponce
+ * @interface ICollectionResponce
+ *
+ * @property {ICollection[]} items - Array of collection objects. Example: [{ id: 1, identifier: "collection1", ... }].
+ * @property {number} total - Total number of found records. Example: 10.
  *
- * @property {ICollection[]} items -
- * @property {number} total -
+ * @description Represents a response from the collections API containing a total count and an array of collection objects.
  */
 interface ICollectionResponce {
     items: ICollection[];
     total: number;
 }
 /**
- * ICollectionFormData
+ * @interface ICollectionFormData
  *
- * @property {string} marker -
- * @property {string} type -
- * @property {string} value -
+ * @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: "string".
+ * @property {string} value - Value of the form field, which can be a string, number, date, etc. Example: "Collection marker".
+ *
+ * @description Represents a form data object within a collection, containing a marker, type, and value.
  */
 interface ICollectionFormData {
     marker: string;
@@ -62,10 +166,12 @@ interface ICollectionFormData {
     value: string;
 }
 /**
- * ICollectionFormObject
+ * @interface ICollectionFormObject
+ *
+ * @property {string} formIdentifier - Text identifier (marker) of the form. Example: "collection-form".
+ * @property {ICollectionFormData[]} formData - An object where keys are form field markers and values are arrays of ICollectionFormData objects. Example: .
  *
- * @property {string} formIdentifier -
- * @property {object} formData -
+ * @description Represents a collection form object that contains a form identifier and associated form data. This interface defines the structure of a collection form object, which includes a form identifier and a set of form data organized by markers.
  */
 interface ICollectionFormObject {
     formIdentifier: string;
@@ -74,7 +180,18 @@ interface ICollectionFormObject {
     };
 }
 /**
- * ICollectionRow
+ * @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 {any} entityId - Identifier of the entity associated with the collection row. Example: 12345.
+ * @property {any} entityType - Type of the entity associated with the collection row. Example: "product", "order", etc.
+ * @property {ICollectionFormData[]} formData - Array of form data objects associated with the collection row. Example: .
+ * @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} [total] - Total value associated with the collection row, if applicable. Example: "100.00".
+ *
+ * @description Represents a row in a collection, containing various properties such as identifiers, dates, form data, and an optional total value.
  */
 interface ICollectionRow {
     id: number;
@@ -87,7 +204,12 @@ interface ICollectionRow {
     total?: string;
 }
 /**
- * ICollectionRows
+ * @interface ICollectionRowsResponce
+ *
+ * @property {ICollectionRow[]} items - Array of collection row objects. Example: .
+ * @property {number} total - Total number of found records. Example: 10.
+ *
+ * @description Represents a response from the collections API containing a total count and an array of collection row objects.
  */
 interface ICollectionRowsResponce {
     items: ICollectionRow[];

package/dist/locales/localesApi.d.ts

@@ -13,7 +13,12 @@ export default class LocalesApi extends AsyncModules implements ILocales {
     /**
      * Find all active language localization objects.
      *
-     * @returns Returns an array of LocaleEntity objects
+     * @handleName getLocales
+     *
+     * @return {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
      */
     getLocales(): Promise<Array<ILocalEntity> | IError>;
 }

package/dist/locales/localesApi.js

@@ -16,7 +16,12 @@ class LocalesApi extends asyncModules_1.default {
     /**
      * Find all active language localization objects.
      *
-     * @returns Returns an array of LocaleEntity objects
+     * @handleName getLocales
+     *
+     * @return {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
      */
     async getLocales() {
         const result = await this._fetchGet('/active/all');

package/dist/locales/localesInterfaces.d.ts

@@ -1,24 +1,33 @@
 import type { IError } from '../base/utils';
 /**
- * Represents an interface object of Locales Api.
+ * @interface ILocales
  *
  * @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.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     getLocales(): Promise<Array<ILocalEntity> | IError>;
 }
 /**
- * Represents a locales object.
+ * @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} image - The language image. Example: "https://example.com/images/en.png".
+ * @property {number} position - The language position. Example: 1.
  *
- * @interface
- * @property {number} id - The unique identifier of the locales.
- * @property {string} shortCode - The shortCode of locales.
- * @property {string} code - The full language code.
- * @property {string} name - The language name.
- * @property {string} nativeName - The native language name.
- * @property {boolean} isActive - Active language flag.
- * @property {string} image - The language image.
- * @property {number} position - The language position.
+ * @description This interface defines the structure of a locales entity, including its identifiers, name, and other properties.
  */
 interface ILocalEntity {
     id: number;

package/dist/menus/menusApi.d.ts

@@ -13,10 +13,15 @@ export default class MenusApi extends AsyncModules implements IMenus {
     /**
      * Get pages includes in menu by marker.
      *
-     * @param {string} [marker] - Menu marker
-     * @param {string} [langCode] - Language code
+     * @handleName getMenusByMarker
      *
-     * @returns Returns a single menu object as a ContentMenu object with included pages
+     * @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.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description
      */
     getMenusByMarker(marker: string, langCode?: string): Promise<IMenusEntity | IError>;
 }

package/dist/menus/menusApi.js

@@ -16,10 +16,15 @@ class MenusApi extends asyncModules_1.default {
     /**
      * Get pages includes in menu by marker.
      *
-     * @param {string} [marker] - Menu marker
-     * @param {string} [langCode] - Language code
+     * @handleName getMenusByMarker
      *
-     * @returns Returns a single menu object as a ContentMenu object with included pages
+     * @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.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description
      */
     async getMenusByMarker(marker, langCode = this.state.lang) {
         const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);