oneentry 1.0.122 → 1.0.124

package/dist/blocks/blocksApi.js

@@ -5,8 +5,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 /**
- * Controllers for working with blocks
+ * Controllers for working with blocks.
+ *
  * @handle /api/content/blocks
+ * @class BlocksApi
+ * @extends AsyncModules
+ * @implements {IBlocks}
+ *
+ * @description This class provides methods to interact with blocks.
  */
 class BlocksApi extends asyncModules_1.default {
     constructor(state) {
@@ -16,12 +22,17 @@ class BlocksApi extends asyncModules_1.default {
     /**
      * Get blocks by parameters.
      *
-     * @param {BlockType} [type] - Available values : product | error_page | catalog_page | product_preview | similar_products_block | product_block | form | common_page | common_block | order | none
-     * @param {string} [langCode] - Language code. Default "en_US"
-     * @param {number} [offset] - Parameter for pagination. Default 0
-     * @param {number} [limit] - Parameter for pagination. Default 30
+     * @handleName getBlocks
      *
-     * @returns Return array of BlocksEntity object.
+     * @param {BlockType} type - Available values : product | error_page | catalog_page | product_preview | similar_products_block | product_block | form | common_page | common_block | order | none. Example: 'product'.
+     * @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 {IBlocksResponse} Returns BlocksEntity 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 getBlocks(type, langCode = this.state.lang, offset = 0, limit = 30) {
         const response = await this._fetchGet(`?langCode=${langCode}&type=${type}&offset=${offset}&limit=${limit}`);
@@ -71,12 +82,17 @@ class BlocksApi extends asyncModules_1.default {
     /**
      * Get block by marker.
      *
-     * @param {string} [marker] - Marker of Block.
-     * @param {string} [langCode] - Language code. Default "en_US"
-     * @param {number} [offset] - Parameter for pagination. Default 0
-     * @param {number} [limit] - Parameter for pagination. Default 30
+     * @handleName getBlockByMarker
+     *
+     * @param {string} marker - Marker of Block. Example: 'product_block'.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Parameter for pagination. Default: 0.
+     * @param {number} [limit] - Parameter for pagination. Default: 30.
      *
-     * @returns Return BlocksEntity object.
+     * @return {IBlockEntity} - Returns a BlockEntity object.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description This method retrieves a block by its marker and includes additional information such as similar products or products associated with the block.
      */
     async getBlockByMarker(marker, langCode = this.state.lang, offset = 0, limit = 30) {
         const response = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);
@@ -120,12 +136,17 @@ class BlocksApi extends asyncModules_1.default {
     /**
      * Get similar products by block marker.
      *
-     * @param {string} [marker] - Block identifier
-     * @param {string} [langCode] - Language code. Default "en_US"
-     * @param {number} [offset] - Parameter for pagination. Default 0
-     * @param {number} [limit] - Parameter for pagination. Default 30
+     * @handleName getSimilarProducts
+     *
+     * @param {string} marker - Block identifier. Example: 'similar_products_block'.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Parameter for pagination. Default: 0.
+     * @param {number} [limit] - Parameter for pagination. Default: 30.
      *
-     * @returns Return IProductsResponse with total and items array of BlocksEntity object.
+     * @return {IProductsResponse} - Returns the total count and an array of product items in object by specified block marker.
+     * @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 getSimilarProducts(marker, langCode = this.state.lang, offset = 0, limit = 30) {
         const query = {
@@ -139,12 +160,17 @@ class BlocksApi extends asyncModules_1.default {
     /**
      * Get products by block marker.
      *
-     * @param {string} [marker] - Block identifier
-     * @param {string} [langCode] - Language code. Default "en_US"
-     * @param {number} [offset] - Parameter for pagination. Default 0
-     * @param {number} [limit] - Parameter for pagination. Default 30
+     * @handleName getProductsByBlockMarker
+     *
+     * @param {string} marker - Block identifier. Example: 'product_block'.
+     * @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 {IProductsEntity[]} Return array of BlocksEntity object.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      *
-     * @returns Return array of BlocksEntity 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 getProductsByBlockMarker(marker, langCode = this.state.lang, offset = 0, limit = 30) {
         const query = {
@@ -156,12 +182,17 @@ class BlocksApi extends asyncModules_1.default {
         return this._normalizeData(result.items);
     }
     /**
-     * Quick search for block objects with limited output
+     * Quick search for block objects with limited output.
+     *
+     * @handleName searchBlock
+     *
+     * @param {string} name - Search string. Example: 'product_block'.
+     * @param {string} [langCode] - Language code. Default: "en_US".
      *
-     * @param {string} [name] - Search string
-     * @param {string} [langCode] - Language code. Default "en_US"
+     * @return {ISearchBlock[]} Returns an array of ISearchBlock objects.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      *
-     * @returns Return array of BlocksEntity 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 searchBlock(name, langCode = this.state.lang) {
         const result = await this._fetchGet(`/quick/search?langCode=${langCode}&name=${name}`);

package/dist/blocks/blocksInterfaces.d.ts

@@ -1,45 +1,88 @@
 import type { AttributeType, IError, ILocalizeInfo } from '../base/utils';
 import type { IProductsEntity, IProductsResponse } from '../products/productsInterfaces';
 /**
- * Represents a interface object of Blocks Api.
+ * Interface for managing and retrieving blocks in the system.
+ *
+ * @interface IBlocks
  *
  * @property {function} getBlocks - Get all Blocks objects.
  * @property {function} getBlockByMarker - Get Block object by marker.
  * @property {function} getSimilarProducts - Get Array of similar products from product-similar block.
  * @property {function} getProductsByBlockMarker - Get Array of products from product block.
  * @property {function} searchBlock - Quick search for block objects with limited output.
+ *
+ * @description This interface defines methods for retrieving and managing blocks in the system.
  */
 interface IBlocks {
+    /**
+     * Retrieves all block objects of a specific type.
+     *
+     * @param {BlockType} type - The type of blocks to retrieve. Example: 'product'.
+     * @param {string} [langCode] - Optional language code for localization. Default: "en_US".
+     * @param {number} [offset] - Optional offset for pagination. Default: 0.
+     * @param {number} [limit] - Optional limit for pagination. Default: 30.
+     *
+     * @return {IBlocksResponse} A promise that resolves to a blocks response or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     getBlocks(type: BlockType, langCode?: string, offset?: number, limit?: number): Promise<IBlocksResponse | IError>;
+    /**
+     * Retrieves a block object by its marker.
+     *
+     * @param {string} marker - The marker identifying the block. Example: 'product_block'.
+     * @param {string} langCode - Language code for localization. Default: "en_US".
+     * @param {number} [offset] - Optional offset for pagination. Default: 0.
+     * @param {number} [limit] - Optional limit for pagination. Default: 30.
+     *
+     * @return {IBlockEntity} A promise that resolves to a block entity or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     getBlockByMarker(marker: string, langCode: string, offset?: number, limit?: number): Promise<IBlockEntity | IError>;
+    /**
+     * Performs a quick search for block objects with limited output.
+     *
+     * @param {string} name - The name to search for. Example: 'product_block'.
+     * @param {string} [langCode] - Optional language code for localization. Default: "en_US".
+     *
+     * @return {ISearchBlock[]} A promise that resolves to an array of search blocks or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     searchBlock(name: string, langCode?: string): Promise<Array<ISearchBlock> | IError>;
 }
 /**
- * IBlocksResponse
+ * Represents a response from the blocks API.
+ *
+ * @interface IBlocksResponse
+ *
+ * @property {number} total - Total number of found records. Example: 100.
+ * @property {Array<IBlockEntity>} items - Array of block entities. Example: .
  *
- * @property {number} total -
- * @property {Array<IBlockEntity>} items -
+ * @description Represents a response from the blocks API containing a total count and an array of block entities.
  */
 interface IBlocksResponse {
     total: number;
     items: Array<IBlockEntity>;
 }
 /**
- * IBlockEntity
+ * Represents a block entity with various attributes and properties.
  *
- * @property {AttributeType} attributeValues -
- * @property {number} id -
- * @property {string} identifier -
- * @property {boolean} isVisible -
- * @property {ILocalizeInfo} localizeInfos -
- * @property {number} position -
- * @property {string | null} templateIdentifier -
- * @property {string} type -
- * @property {number} version -
- * @property {number} countElementsPerRow -
- * @property {number} quantity -
- * @property {IProductsResponse} similarProducts -
- * @property {Array<IProductsEntity>} products -
+ * @interface IBlockEntity
+ *
+ * @property {AttributeType} attributeValues - Type of attributes used in the block.
+ * @property {number} id - Unique identifier of the block. Example: 1234.
+ * @property {string} identifier - Unique string identifier for the block. Example: 'block1'.
+ * @property {boolean} isVisible - Indicates whether the block is visible. Example: true.
+ * @property {ILocalizeInfo} localizeInfos - Localization information for the block. Example: .
+ * @property {number} position - Position of the block in a list or layout. Example: 1.
+ * @property {string | null} templateIdentifier - Identifier for the template used by the block, or null if not applicable. Example: 'template1' or null.
+ * @property {string} type - Type of the block, such as 'product', 'error_page', etc. Example: 'product'.
+ * @property {number} version - Version of the block entity. Example: 1.
+ * @property {number} [countElementsPerRow] - Number of elements displayed per row in the block, if applicable. Example: 3.
+ * @property {number} [quantity] - Quantity of items in the block, if applicable. Example: 5.
+ * @property {IProductsResponse} [similarProducts] - Response containing similar products associated with the block. Example: { total: 10, items: [...] }.
+ * @property {Array<IProductsEntity>} [products] - Array of product entities associated with the block. Example: [{ id: 1, name: 'Product 1', ... }, { id: 2, name: 'Product 2', ... }].
+ *
+ * @description Represents a block entity with various attributes and properties.
  */
 interface IBlockEntity {
     attributeValues: AttributeType;
@@ -57,11 +100,15 @@ interface IBlockEntity {
     products?: Array<IProductsEntity>;
 }
 /**
- * ISearchBlock
+ * Represents a search block entity with an identifier, name, and ID.
+ *
+ * @interface ISearchBlock
+ *
+ * @property {number} id - Unique identifier of the search block. Example: 1.
+ * @property {string} name -  Name of the search block. Example: 'Search Block 1'.
+ * @property {string} identifier - Unique string identifier for the search block. Example: 'search_block_1'.
  *
- * @property {number} id -
- * @property {string} name -
- * @property {string} identifier -
+ * @description Represents a search block entity with an identifier, name, and ID.
  */
 interface ISearchBlock {
     id: number;
@@ -70,6 +117,8 @@ interface ISearchBlock {
 }
 /**
  * BlockType
+ * @type {BlockType}
+ * @description This type defines the possible values for block types used in the system.
  */
 type BlockType = 'product' | 'error_page' | 'catalog_page' | 'product_preview' | 'similar_products_block' | 'product_block' | 'form' | 'common_page' | 'common_block' | 'order' | 'service' | 'none';
 export type { BlockType, IBlockEntity, IBlocks, IBlocksResponse, ISearchBlock };

package/dist/events/eventsApi.d.ts

@@ -5,37 +5,71 @@ import type { IEvents } from './eventsInterfaces';
 import type { ISubscriptions } from './eventsInterfaces';
 /**
  * Controllers for working with events
+ *
  * @handle /api/content/events
+ * @class EventsApi
+ * @extends AsyncModules
+ * @implements {IEvents}
+ *
+ * @description This class provides methods to interact with events, including subscribing and unsubscribing to product events, and retrieving all subscriptions.
  */
 export default class EventsApi extends AsyncModules implements IEvents {
     protected state: StateModule;
     protected _url: string;
+    /**
+     * Initializes the EventsApi with the provided state module.
+     *
+     * @constructor
+     * @class - EventsApi
+     * @extends - AsyncModules
+     * @implements {IEvents}
+     *
+     * @param {StateModule} state - The state module containing the base URL and other configurations.
+     *
+     * @description Initializes the EventsApi with the provided state module.
+     */
     constructor(state: StateModule);
     /**
      * Return all subscriptions to product.
      *
-     * @param {number} [offset] - Pagination parameter, default is 0
-     * @param {number} [limit] - Pagination parameter, default is 30
+     * @handleName getAllSubscriptions
+     *
+     * @return {ISubscriptions} Returns an object containing all subscriptions or an error object if there was an issue.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
-    getAllSubscriptions(offset?: number, limit?: number): Promise<ISubscriptions | IError>;
+    getAllSubscriptions(): Promise<ISubscriptions | IError>;
     /**
      * Subscribing to an event on a product.
      *
+     * @handleName subscribeByMarker
+     *
+     * @param {string} marker - Event marker. Example: 'product_price_change'.
+     * @param {string} productId - Product id. Example: 12345.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [threshold] - Threshold value for comparing numerical value. Default is 0.
+     *
+     * @return {any} Returns a promise that resolves to the result of the subscription operation or an error object if there was an issue.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
      * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
-     * @param {string} [marker] - Event marker.
-     * @param {string} [productId] - Product id.
-     * @param {string} [langCode] - Language code.
-     * @param {number} [threshold] - Threshold value for comparing numerical value.
      */
     subscribeByMarker(marker: string, productId: number, langCode?: string, threshold?: number): Promise<any | IError>;
     /**
      * Unsubscribing to an event on a product.
      *
+     * @handleName unsubscribeByMarker
+     *
+     * @param {string} marker - The marker of the event to unsubscribe from. Example: 'product_price_change'.
+     * @param {number} productId - The ID of the product to unsubscribe from. Example: 12345.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [threshold] - The threshold value for comparing numerical values. Default: 0.
+     *
+     * @return {any} - Returns a promise that resolves to the result of the unsubscription operation or an error object if there was an issue.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
      * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
-     * @param {string} [marker] - Event marker.
-     * @param {string} [productId] - Product id.
-     * @param {number} [langCode] - Language code.
-     * @param {number} [threshold] - Threshold value for comparing numerical value.
      */
     unsubscribeByMarker(marker: string, productId: number, langCode?: string, threshold?: number): Promise<any | IError>;
 }

package/dist/events/eventsApi.js

@@ -3,14 +3,30 @@ 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-unused-vars */
-/* eslint-disable @typescript-eslint/no-explicit-any */
 const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 /**
  * Controllers for working with events
+ *
  * @handle /api/content/events
+ * @class EventsApi
+ * @extends AsyncModules
+ * @implements {IEvents}
+ *
+ * @description This class provides methods to interact with events, including subscribing and unsubscribing to product events, and retrieving all subscriptions.
  */
 class EventsApi extends asyncModules_1.default {
+    /**
+     * Initializes the EventsApi with the provided state module.
+     *
+     * @constructor
+     * @class - EventsApi
+     * @extends - AsyncModules
+     * @implements {IEvents}
+     *
+     * @param {StateModule} state - The state module containing the base URL and other configurations.
+     *
+     * @description Initializes the EventsApi with the provided state module.
+     */
     constructor(state) {
         super(state);
         this._url = state.url + '/api/content/events';
@@ -18,27 +34,34 @@ class EventsApi extends asyncModules_1.default {
     /**
      * Return all subscriptions to product.
      *
-     * @param {number} [offset] - Pagination parameter, default is 0
-     * @param {number} [limit] - Pagination parameter, default is 30
+     * @handleName getAllSubscriptions
+     *
+     * @return {ISubscriptions} Returns an object containing all subscriptions or an error object if there was an issue.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
-    async getAllSubscriptions(offset = 0, limit = 30) {
-        const query = {
-            offset,
-            limit,
-        };
+    async getAllSubscriptions() {
         const result = await this._fetchGet(`/subscriptions`);
         return result;
     }
     /**
      * Subscribing to an event on a product.
      *
+     * @handleName subscribeByMarker
+     *
+     * @param {string} marker - Event marker. Example: 'product_price_change'.
+     * @param {string} productId - Product id. Example: 12345.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [threshold] - Threshold value for comparing numerical value. Default is 0.
+     *
+     * @return {any} Returns a promise that resolves to the result of the subscription operation or an error object if there was an issue.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
      * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
-     * @param {string} [marker] - Event marker.
-     * @param {string} [productId] - Product id.
-     * @param {string} [langCode] - Language code.
-     * @param {number} [threshold] - Threshold value for comparing numerical value.
      */
     async subscribeByMarker(marker, productId, langCode = this.state.lang, threshold = 0) {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         const data = {
             locale: langCode,
             productId,
@@ -52,13 +75,20 @@ class EventsApi extends asyncModules_1.default {
     /**
      * Unsubscribing to an event on a product.
      *
+     * @handleName unsubscribeByMarker
+     *
+     * @param {string} marker - The marker of the event to unsubscribe from. Example: 'product_price_change'.
+     * @param {number} productId - The ID of the product to unsubscribe from. Example: 12345.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [threshold] - The threshold value for comparing numerical values. Default: 0.
+     *
+     * @return {any} - Returns a promise that resolves to the result of the unsubscription operation or an error object if there was an issue.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
      * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
-     * @param {string} [marker] - Event marker.
-     * @param {string} [productId] - Product id.
-     * @param {number} [langCode] - Language code.
-     * @param {number} [threshold] - Threshold value for comparing numerical value.
      */
     async unsubscribeByMarker(marker, productId, langCode = this.state.lang, threshold = 0) {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
         const data = {
             locale: langCode,
             productId: productId,

package/dist/events/eventsInterfaces.d.ts

@@ -1,18 +1,60 @@
 import type { IError } from '../base/utils';
 /**
- * Represents a interface object of Events Api.
+ * Interface for managing event subscriptions related to products.
+ *
+ * @interface IEvents
  *
  * @property {function} getAllSubscriptions - Return all subscriptions to product.
  * @property {function} subscribeByMarker - Subscribing to an event on a product.
  * @property {function} unsubscribeByMarker - Unsubscribing to an event on a product.
+ *
+ * @description This interface defines methods for managing event subscriptions related to products.
  */
 interface IEvents {
+    /**
+     * Retrieves all subscriptions to products.
+     *
+     * @param {number} [limit] - Optional limit for pagination. Default is 30.
+     * @param {number} [offset] - Optional offset for pagination. Default is 0.
+     *
+     * @return {ISubscriptions} A promise that resolves to a subscriptions object or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     getAllSubscriptions(limit?: number, offset?: number): Promise<ISubscriptions | IError>;
+    /**
+     * Subscribes to an event on a product by its marker.
+     *
+     * @param {string} marker - The marker identifying the event. Example: 'product_price_change'.
+     * @param {number} productId - The ID of the product to subscribe to. Example: 12345.
+     * @param {string} [langCode] - Optional language code for localization. Default: "en_US".
+     * @param {number} [threshold] - Optional threshold value for the subscription. Default: 0.
+     *
+     * @return {any} A promise that resolves to any type or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     subscribeByMarker(marker: string, productId: number, langCode?: string, threshold?: number): Promise<any | IError>;
+    /**
+     * Unsubscribes from an event on a product by its marker.
+     *
+     * @param {string} marker - The marker identifying the event. Example: 'product_price_change'.
+     * @param {number} productId - The ID of the product to unsubscribe from. Example: 12345.
+     * @param {string} [langCode] - Optional language code for localization. Default: "en_US".
+     * @param {number} [threshold] - Optional threshold value for the unsubscription. Default: 0.
+     *
+     * @returns {any} A promise that resolves to any type or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
     unsubscribeByMarker(marker: string, productId: number, langCode?: string, threshold?: number): Promise<any | IError>;
 }
 /**
- * ISubscriptions
+ * Represents a response from the events API containing a total count and an array of subscription items.
+ *
+ * @interface ISubscriptions
+ *
+ * @property {number} total - Total number of found records. Example: 100.
+ * @property {Array<{ eventMarker: string; productId: number }>} items - Array of subscription items, each containing an event marker and a product ID. Example: [{ eventMarker: 'product_price_change', productId: 12345 }, { eventMarker: 'product_stock_update', productId: 67890 }].
+ *
+ * @description Represents a response from the events API containing a total count and an array of subscription items.
  */
 interface ISubscriptions {
     total: number;

package/dist/file-uploading/fileUploadingApi.d.ts

@@ -4,6 +4,13 @@ import type { IError } from '../base/utils';
 import type { IFileUploading, IUploadingQuery, IUploadingReturns } from './fileUploadingInterfaces';
 /**
  * Controllers for working with file uploading
+ *
+ * @handle /api/content/files
+ * @class FileUploadingApi
+ * @extends AsyncModules
+ * @implements {IFileUploading}
+ *
+ * @description This class provides methods to upload and delete files in a cloud file storage, as well as retrieve files by parameters.
  */
 export default class FileUploadingApi extends AsyncModules implements IFileUploading {
     protected state: StateModule;
@@ -13,45 +20,58 @@ export default class FileUploadingApi extends AsyncModules implements IFileUploa
     /**
      * Upload file function.
      *
-     * @param {File} [data] File objects. Get data as File from your unput as e.target.files[0]
+     * @handleName upload
      *
-     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters.
-     * @param {string} [fileQuery.type] - Type, determines the folder name in the storage. Example: "page"
-     * @param {string} [fileQuery.entity] - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor"
-     * @param {number} [fileQuery.id] - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787
-     * @param {number} [fileQuery.width] - Optional width parameter. Example: 0
-     * @param {number} [fileQuery.height] - Optional height parameter. Example: 0
-     * @param {boolean} [fileQuery.compress] - Optional flag of optimization (compression) for images. Example: true
-     * @param {boolean} [fileQuery.template] - preview template identifier. Example: 1
+     * @param {File | Blob} file - File to upload. Example: new File(["content"], "file.png", { type: "image/png" }).
+     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters. Example: { type: 'page', entity: 'editor', id: 3787, width: 0, height: 0, compress: true, template: 1 }.
      *
-     * @returns Uploads a file to an Amazon S3-compatible cloud file storage
+     * @param {string} [fileQuery.type] - Type, determines the folder name in the storage. Example: "page".
+     * @param {string} [fileQuery.entity] - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
+     * @param {number} [fileQuery.id] - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
+     * @param {number} [fileQuery.width] - Optional width parameter. Example: 0.
+     * @param {number} [fileQuery.height] - Optional height parameter. Example: 0.
+     * @param {boolean} [fileQuery.compress] - Optional flag of optimization (compression) for images. Example: true.
+     * @param {boolean} [fileQuery.template] - preview template identifier. Example: 1.
+     *
+     * @return {IUploadingReturns} Uploads a file to an Amazon S3-compatible cloud file storage.
+     * @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.
      */
     upload(file: File | Blob, fileQuery?: IUploadingQuery): Promise<IUploadingReturns | IError>;
     /**
      * Deletes a file from the cloud file storage.
      *
-     * @param {string} [filename] File name. Example "file.png"
+     * @handleName delete
      *
-     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters.
-     * @param {string} [fileQuery.type] - Type, determines the folder name in the storage. Example: "page"
-     * @param {string} [fileQuery.entity] - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor"
-     * @param {number} [fileQuery.id] - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787
-     * @param {number} [fileQuery.template] - preview template identifier. Example: 1
+     * @param {string} [filename] - File name. Example: "file.png".
+     * @param {IUploadingQuery} [fileQuery] - Optional set query parameters. Example: { type: 'page', entity: 'editor', id: 3787, template: 1 }.
+     * @param {string} [fileQuery.type] - Type, determines the folder name in the storage. Example: "page".
+     * @param {string} [fileQuery.entity] - Entity name from which the file is uploaded, determines the folder name in the storage. Example: "editor".
+     * @param {number} [fileQuery.id] - Identifier of the object from which the file is uploaded, determines the folder name in the storage. Example: 3787.
+     * @param {number} [fileQuery.template] - preview template identifier. Example: 1.
      *
-     * @returns Deletes a file from the cloud file storage
+     * @return {any} Returns a promise that resolves to the result of the deletion operation or an error object if there was an issue.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      */
     delete(filename: string, fileQuery?: IUploadingQuery): Promise<any | IError>;
     /**
      * Get file by parameters.
      *
-     * @param {number} [id] - Object identifier, from which the file is uploaded, determines the folder name in the storage
+     * @handleName getFile
+     *
+     * @param {number} [id] - Object identifier, from which the file is uploaded, determines the folder name in the storage. Example: 3787.
+     * @param {string} [type] - Type, determines the folder name in the storage. Example: "page".
+     * @param {string} [entity] - Entity name, from which the file is uploaded, determines the folder name in the storage. Example: "editor".
+     * @param {string} [filename] - Filename. Example: "file.png".
+     * @param {string} [template] - Preview template identifier. Example: 1.
      *
-     * @param {string} [type] - Type, determines the folder name in the storage
-     * @param {string} [entity] - entity name, from which the file is uploaded, determines the folder name in the storage
-     * @param {string} [filename] - Filename. Example "file.png"
-     * @param {string} [template] - preview template identifier. Example 1
+     * @return {any} Returns a promise that resolves to a Blob object containing the file data 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 Return file as File 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.
      */
-    getFile(id: number, type: string, entity: string, filename?: string, template?: string): Promise<Blob | IError>;
+    getFile(id: number, type: string, entity: string, filename: string, template?: string): Promise<any | IError>;
 }