oneentry 1.0.126 → 1.0.128

package/dist/blocks/blocksInterfaces.d.ts

@@ -2,54 +2,53 @@ import type { AttributeType, IError, ILocalizeInfo } from '../base/utils';
 import type { IProductsEntity, IProductsResponse } from '../products/productsInterfaces';
 /**
  * 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.
+ * @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.
-     *
+     * @handleName getBlocks
      * @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.
+     * @returns {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.
+     * @description This method retrieves all block objects of a specific type.
      */
     getBlocks(type: BlockType, langCode?: string, offset?: number, limit?: number): Promise<IBlocksResponse | IError>;
     /**
      * Retrieves a block object by its marker.
-     *
+     * @handleName getBlockByMarker
      * @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.
+     * @returns {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.
+     * @description This method retrieves a block object by its marker.
      */
     getBlockByMarker(marker: string, langCode: string, offset?: number, limit?: number): Promise<IBlockEntity | IError>;
     /**
      * Performs a quick search for block objects with limited output.
-     *
+     * @handleName searchBlock
      * @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.
+     * @returns {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.
+     * @description This method performs a quick search for block objects with limited output.
      */
     searchBlock(name: string, langCode?: string): Promise<ISearchBlock[] | IError>;
 }
 /**
  * Represents a response from the blocks API.
- *
  * @interface IBlocksResponse
- *
  * @property {number} total - Total number of found records. Example: 100.
  * @property {IBlockEntity[]} items - Array of block entities. Example:
     [
@@ -71,12 +70,12 @@ interface IBlocks {
         },
         "products": [
           {
-            "id": 1,
-            "name": "Product 1"
+          "id": 1,
+          "name": "Product 1"
           },
           {
-            "id": 2,
-            "name": "Product 2"
+          "id": 2,
+          "name": "Product 2"
           }
         ]
       }
@@ -89,20 +88,18 @@ interface IBlocksResponse {
 }
 /**
  * Represents a block entity with various attributes and properties.
- *
  * @interface IBlockEntity
- *
  * @property {AttributeType} attributeValues - Type of attributes used in the block. Example:
-    {
-      "block-text": {
-        "type": "string",
-        "value": "some text",
-        "isIcon": false,
-        "position": 0,
-        "additionalFields": [],
-        "isProductPreview": false
-      }
+   {
+    "block-text": {
+      "type": "string",
+      "value": "some text",
+      "isIcon": false,
+      "position": 0,
+      "additionalFields": [],
+      "isProductPreview": false
     }
+   }
  * @property {number} id - Unique identifier of the block. Example: 1234.
  * @property {ILocalizeInfo} localizeInfos - Localization information for the block. Example: {"key": "value"}
  * @property {number} version - Version of the block entity. Example: 1.
@@ -113,21 +110,21 @@ interface IBlocksResponse {
  * @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 {IProductsEntity[]} [products] - Array of product entities associated with the block. Example:
+   [
     {
-      "total": 10,
-      "items": []
+      "id": 1,
+      "name": "Product 1"
+    },
+    {
+      "id": 2,
+      "name": "Product 2"
     }
- * @property {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 {
@@ -147,12 +144,10 @@ interface IBlockEntity {
 }
 /**
  * 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} identifier - Unique string identifier for the search block. Example: "search_block_1".
- * @property {string} name -  Name of the search block. Example: "Search Block 1".
+ * @property {string} name - Name of the search block. Example: "Search Block 1".
  * @description Represents a search block entity with an identifier, name, and ID.
  */
 interface ISearchBlock {

package/dist/config.d.ts

@@ -0,0 +1,13 @@
+export declare const projectUrl = "https://stage.oneentry.cloud";
+export declare const projectToken = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiTlBNIiwic2VyaWFsTnVtYmVyIjozLCJpYXQiOjE3NDA1OTE0MzgsImV4cCI6MTc3MjEyNzQzMX0.MWbtBoXh-MqGTWgmiMTZSkfN8N-WYv3Cv2kSPhRpFlk";
+/**
+ * authData
+ */
+export declare const authData: {
+    marker: string;
+    value: string;
+}[];
+export declare const authData2: {
+    marker: string;
+    value: string;
+}[];

package/dist/config.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.authData2 = exports.authData = exports.projectToken = exports.projectUrl = void 0;
+exports.projectUrl = 'https://stage.oneentry.cloud';
+exports.projectToken = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiTlBNIiwic2VyaWFsTnVtYmVyIjozLCJpYXQiOjE3NDA1OTE0MzgsImV4cCI6MTc3MjEyNzQzMX0.MWbtBoXh-MqGTWgmiMTZSkfN8N-WYv3Cv2kSPhRpFlk';
+/**
+ * authData
+ */
+exports.authData = [
+    {
+        marker: 'email_reg',
+        value: 'test@test.ru',
+    },
+    {
+        marker: 'password_reg',
+        // value: '12345',
+        value: '1-1',
+    },
+];
+exports.authData2 = [
+    {
+        marker: 'email_reg',
+        value: 'test2@test.ru',
+    },
+    {
+        marker: 'password_reg',
+        // value: '12345',
+        value: '1-1',
+    },
+];

package/dist/events/eventsApi.d.ts

@@ -4,12 +4,10 @@ import type { IError } from '../base/utils';
 import type { IEvents, ISubscriptions } from './eventsInterfaces';
 /**
  * Controllers for working with events
- *
  * @handle /api/content/events
  * @class EventsApi
- * @extends AsyncModules
+ * @augments 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 {
@@ -17,58 +15,43 @@ export default class EventsApi extends AsyncModules implements IEvents {
     protected _url: string;
     /**
      * Initializes the EventsApi with the provided state module.
-     *
-     * @constructor
-     * @class - EventsApi
-     * @extends - AsyncModules
+     * @class EventsApi
+     * @augments 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.
-     *
      * @handleName getAllSubscriptions
-     *
      * @param {number} [offset] - Optional offset for pagination. Default: 0.
      * @param {number} [limit] - Optional limit for pagination. Default: 30.
-     * @return {ISubscriptions} Returns an object containing all subscriptions or an error object if there was an issue.
+     * @returns {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>;
     /**
      * 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: 0.
-     *
-     * @return {any} Returns a promise that resolves to the result of the subscription operation or an error object if there was an issue.
+     * @param {number} productId - Product id. Example: 12345.
+     * @param {string} [langCode] - Language code. Default: "en_US".=
+     * @returns {Promise<boolean | IError>} Returns true if subscription was successful, 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.
      */
-    subscribeByMarker(marker: string, productId: number, langCode?: string, threshold?: number): Promise<any | IError>;
+    subscribeByMarker(marker: string, productId: number, langCode?: string): Promise<boolean | 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.
+     * @returns {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.
      */
-    unsubscribeByMarker(marker: string, productId: number, langCode?: string, threshold?: number): Promise<any | IError>;
+    unsubscribeByMarker(marker: string, productId: number, langCode?: string): Promise<boolean | IError>;
 }

package/dist/events/eventsApi.js

@@ -3,29 +3,24 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable jsdoc/reject-any-type */
 /* 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
+ * @augments 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
+     * @class EventsApi
+     * @augments 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) {
@@ -34,14 +29,11 @@ class EventsApi extends asyncModules_1.default {
     }
     /**
      * Return all subscriptions to product.
-     *
      * @handleName getAllSubscriptions
-     *
      * @param {number} [offset] - Optional offset for pagination. Default: 0.
      * @param {number} [limit] - Optional limit for pagination. Default: 30.
-     * @return {ISubscriptions} Returns an object containing all subscriptions or an error object if there was an issue.
+     * @returns {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) {
@@ -54,55 +46,49 @@ class EventsApi extends asyncModules_1.default {
     }
     /**
      * 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: 0.
-     *
-     * @return {any} Returns a promise that resolves to the result of the subscription operation or an error object if there was an issue.
+     * @param {number} productId - Product id. Example: 12345.
+     * @param {string} [langCode] - Language code. Default: "en_US".=
+     * @returns {Promise<boolean | IError>} Returns true if subscription was successful, 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 subscribeByMarker(marker, productId, langCode = this.state.lang, threshold = 0) {
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        const data = {
+    async subscribeByMarker(marker, productId, langCode = this.state.lang) {
+        const body = {
             locale: langCode,
             productId,
         };
-        if (threshold) {
-            data.threshold = threshold;
+        try {
+            await this._fetchPost(`/subscribe/marker/${marker}`, body);
+            return true;
+        }
+        catch (e) {
+            return e;
         }
-        const result = await this._fetchPost(`/subscribe/marker/${marker}`, data);
-        return result;
     }
     /**
      * 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.
+     * @returns {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.
      */
-    async unsubscribeByMarker(marker, productId, langCode = this.state.lang, threshold = 0) {
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        const data = {
-            locale: langCode,
+    async unsubscribeByMarker(marker, productId, langCode = this.state.lang) {
+        const body = {
             productId: productId,
+            locale: langCode,
         };
-        if (threshold) {
-            data.threshold = threshold;
+        try {
+            await this._fetchDelete(`/unsubscribe/marker/${marker}`, body);
+            return true;
+        }
+        catch (e) {
+            return e;
         }
-        const result = await this._fetchDelete(`/unsubscribe/marker/${marker}`, data);
-        return result;
     }
 }
 exports.default = EventsApi;

package/dist/events/eventsInterfaces.d.ts

@@ -1,64 +1,58 @@
 import type { IError } from '../base/utils';
 /**
  * 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.
-     *
+     * @handleName getAllSubscriptions
      * @param {number} [offset] - Optional offset for pagination. Default: 0.
      * @param {number} [limit] - Optional limit for pagination. Default: 30.
-     * @return {ISubscriptions} A promise that resolves to a subscriptions object or an error.
+     * @returns {Promise<ISubscriptions | IError>} 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.
+     * @description This method retrieves all subscriptions to products.
      */
     getAllSubscriptions(offset?: number, limit?: number): Promise<ISubscriptions | IError>;
     /**
      * Subscribes to an event on a product by its marker.
-     *
+     * @handleName subscribeByMarker
      * @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.
+     * @returns {Promise<boolean | IError>} 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.
+     * @description This method subscribes to an event on a product by its marker.
      */
-    subscribeByMarker(marker: string, productId: number, langCode?: string, threshold?: number): Promise<any | IError>;
+    subscribeByMarker(marker: string, productId: number, langCode?: string): Promise<boolean | IError>;
     /**
      * Unsubscribes from an event on a product by its marker.
-     *
+     * @handleName unsubscribeByMarker
      * @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.
+     * @returns {Promise<boolean | IError>} 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.
+     * @description This method unsubscribes from an event on a product by its marker.
      */
-    unsubscribeByMarker(marker: string, productId: number, langCode?: string, threshold?: number): Promise<any | IError>;
+    unsubscribeByMarker(marker: string, productId: number, langCode?: string): Promise<boolean | IError>;
 }
 /**
  * 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 {{ 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
-      }
-    ]
+   [
+     {
+       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 {
@@ -68,4 +62,15 @@ interface ISubscriptions {
         productId: number;
     }>;
 }
-export type { IEvents, ISubscriptions };
+/**
+ * Interface for the body of the subscribe methods.
+ * @interface ISubscribeBody
+ * @property {string} locale - Locale of the user. Example: "en_US".
+ * @property {number} productId - Product ID. Example: 12345.
+ * @description Represents a body for the subscribe methods, containing the locale and product ID.
+ */
+interface ISubscribeBody {
+    locale: string;
+    productId: number;
+}
+export type { IEvents, ISubscribeBody, ISubscriptions };

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

@@ -4,24 +4,23 @@ import type { IError } from '../base/utils';
 import type { IFileUploading, IUploadingQuery, IUploadingReturn } from './fileUploadingInterfaces';
 /**
  * Controllers for working with file uploading
- *
  * @handle /api/content/files
  * @class FileUploadingApi
- * @extends AsyncModules
+ * @augments 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;
     protected _url: string;
+    /**
+     *
+     */
     constructor(state: StateModule);
     private _defaultQuery;
     /**
      * Upload file function.
-     *
      * @handleName upload
-     *
      * @param {File | Blob} file - File to upload. Example: `new File(["content"], "file.png", {"type": "image/png"})`
      * @param {IUploadingQuery} [fileQuery] - Optional set query parameters. Example:
         {
@@ -40,17 +39,15 @@ export default class FileUploadingApi extends AsyncModules implements IFileUploa
      * @param {number} [fileQuery.height] - Optional height parameter. Example: 0.
      * @param {boolean} [fileQuery.compress] - Optional flag of optimization (compression) for images. Example: true.
      * @param {any} [fileQuery.template] - preview template identifier. Example: 1.
-     * @return {IUploadingReturn[]} Uploads a file to an Amazon S3-compatible cloud file storage.
+     * @returns {IUploadingReturn[]} 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<IUploadingReturn[] | IError>;
     /**
      * Deletes a file from the cloud file storage.
-     *
      * @handleName delete
-     *
-     * @param {string} [filename] - File name. Example: "file.png".
+     * @param {string} filename - File name. Example: "file.png".
      * @param {IUploadingQuery} [fileQuery] - Optional set query parameters. Example:
         {
           "type": "page",
@@ -62,22 +59,20 @@ export default class FileUploadingApi extends AsyncModules implements IFileUploa
      * @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.
-     * @return {any} Returns a promise that resolves to the result of the deletion operation or an error object if there was an issue.
+     * @returns {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.
-     *
      * @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 {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.
-     * @return {any} Returns a promise that resolves to a Blob object containing the file data or an error object if there was an issue.
+     * @returns {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.
      * @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.
      */