oneentry 1.0.124 → 1.0.125

package/dist/blocks/blocksApi.js

@@ -24,18 +24,16 @@ class BlocksApi extends asyncModules_1.default {
      *
      * @handleName getBlocks
      *
-     * @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 {BlockType} type - Available values: "product" | "error_page" | "catalog_page" | "product_preview" | "similar_products_block" | "product_block" | "form" | "common_page" | "common_block" | "order" | "service" | "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}`);
+    async getBlocks(type = '', langCode = this.state.lang, offset = 0, limit = 30) {
+        const response = await this._fetchPost(`?langCode=${langCode}&type=${type}&offset=${offset}&limit=${limit}`);
         if (!this.state.traficLimit) {
             const normalizeResponse = this._normalizeData(response);
             await Promise.all(
@@ -84,14 +82,12 @@ class BlocksApi extends asyncModules_1.default {
      *
      * @handleName getBlockByMarker
      *
-     * @param {string} marker - Marker of Block. Example: 'product_block'.
+     * @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.
-     *
      * @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) {
@@ -138,14 +134,12 @@ class BlocksApi extends asyncModules_1.default {
      *
      * @handleName getSimilarProducts
      *
-     * @param {string} marker - Block identifier. Example: 'similar_products_block'.
+     * @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.
-     *
      * @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) {
@@ -162,14 +156,12 @@ class BlocksApi extends asyncModules_1.default {
      *
      * @handleName getProductsByBlockMarker
      *
-     * @param {string} marker - Block identifier. Example: 'product_block'.
+     * @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.
-     *
      * @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) {
@@ -186,12 +178,10 @@ class BlocksApi extends asyncModules_1.default {
      *
      * @handleName searchBlock
      *
-     * @param {string} name - Search string. Example: 'product_block'.
+     * @param {string} name - Search string. Example: "product_block".
      * @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.
-     *
      * @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) {

package/dist/blocks/blocksInterfaces.d.ts

@@ -10,18 +10,16 @@ import type { IProductsEntity, IProductsResponse } from '../products/productsInt
  * @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 {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.
      */
@@ -29,11 +27,10 @@ interface IBlocks {
     /**
      * Retrieves a block object by its marker.
      *
-     * @param {string} marker - The marker identifying the block. Example: 'product_block'.
+     * @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.
      */
@@ -41,13 +38,12 @@ interface IBlocks {
     /**
      * Performs a quick search for block objects with limited output.
      *
-     * @param {string} name - The name to search for. Example: 'product_block'.
+     * @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>;
+    searchBlock(name: string, langCode?: string): Promise<ISearchBlock[] | IError>;
 }
 /**
  * Represents a response from the blocks API.
@@ -55,49 +51,99 @@ interface IBlocks {
  * @interface IBlocksResponse
  *
  * @property {number} total - Total number of found records. Example: 100.
- * @property {Array<IBlockEntity>} items - Array of block entities. Example: .
- *
+ * @property {IBlockEntity[]} items - Array of block entities. Example:
+    [
+      {
+        "attributeValues": [],
+        "id": 1,
+        "identifier": "block1",
+        "isVisible": true,
+        "localizeInfos": { "key": "value" },
+        "position": 1,
+        "templateIdentifier": null,
+        "type": "product",
+        "version": 1,
+        "countElementsPerRow": 3,
+        "quantity": 9,
+        "similarProducts": {
+          "total": 0,
+          "items": []
+        },
+        "products": [
+          {
+            "id": 1,
+            "name": "Product 1"
+          },
+          {
+            "id": 2,
+            "name": "Product 2"
+          }
+        ]
+      }
+    ]
  * @description Represents a response from the blocks API containing a total count and an array of block entities.
  */
 interface IBlocksResponse {
+    items: IBlockEntity[];
     total: number;
-    items: Array<IBlockEntity>;
 }
 /**
  * Represents a block entity with various attributes and properties.
  *
  * @interface IBlockEntity
  *
- * @property {AttributeType} attributeValues - Type of attributes used in the block.
+ * @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
+      }
+    }
  * @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 {ILocalizeInfo} localizeInfos - Localization information for the block. Example: {"key": "value"}
  * @property {number} version - Version of the block entity. Example: 1.
+ * @property {string} identifier - Unique string identifier for the block. Example: "block1".
+ * @property {string} type - Type of the block, such as 'product', 'error_page', etc. Example: "product".
+ * @property {string | null} templateIdentifier - Identifier for the template used by the block, or null if not applicable. Example: "template1".
+ * @property {boolean} isVisible - Indicates whether the block is visible. Example: true.
  * @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', ... }].
- *
+ * @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:
+    [
+      {
+        "id": 1,
+        "name": "Product 1"
+      },
+      {
+        "id": 2,
+        "name": "Product 2"
+      }
+    ]
  * @description Represents a block entity with various attributes and properties.
  */
 interface IBlockEntity {
-    attributeValues: AttributeType;
     id: number;
-    identifier: string;
-    isVisible: boolean;
     localizeInfos: ILocalizeInfo;
+    version: number;
     position: number;
-    templateIdentifier: string | null;
+    identifier: string;
     type: string;
-    version: number;
+    templateIdentifier: string | null;
+    isVisible: boolean;
+    attributeValues: AttributeType;
+    similarProducts?: IProductsResponse;
     countElementsPerRow?: number;
     quantity?: number;
-    similarProducts?: IProductsResponse;
-    products?: Array<IProductsEntity>;
+    products?: IProductsEntity[];
 }
 /**
  * Represents a search block entity with an identifier, name, and ID.
@@ -105,15 +151,14 @@ interface IBlockEntity {
  * @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 {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".
  * @description Represents a search block entity with an identifier, name, and ID.
  */
 interface ISearchBlock {
     id: number;
-    name: string;
     identifier: string;
+    name: string;
 }
 /**
  * BlockType

package/dist/events/eventsApi.d.ts

@@ -1,8 +1,7 @@
 import AsyncModules from '../base/asyncModules';
 import type StateModule from '../base/stateModule';
 import type { IError } from '../base/utils';
-import type { IEvents } from './eventsInterfaces';
-import type { ISubscriptions } from './eventsInterfaces';
+import type { IEvents, ISubscriptions } from './eventsInterfaces';
 /**
  * Controllers for working with events
  *
@@ -34,21 +33,23 @@ export default class EventsApi extends AsyncModules implements IEvents {
      *
      * @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.
      * @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(): Promise<ISubscriptions | IError>;
+    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} 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.
+     * @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.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
@@ -61,14 +62,12 @@ export default class EventsApi extends AsyncModules implements IEvents {
      *
      * @handleName unsubscribeByMarker
      *
-     * @param {string} marker - The marker of the event to unsubscribe from. Example: 'product_price_change'.
+     * @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.
      */
     unsubscribeByMarker(marker: string, productId: number, langCode?: string, threshold?: number): Promise<any | IError>;

package/dist/events/eventsApi.js

@@ -3,6 +3,7 @@ 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 events
@@ -36,13 +37,19 @@ class EventsApi extends asyncModules_1.default {
      *
      * @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.
      * @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() {
-        const result = await this._fetchGet(`/subscriptions`);
+    async getAllSubscriptions(offset = 0, limit = 30) {
+        const query = {
+            offset,
+            limit,
+        };
+        const result = await this._fetchGet(`/subscriptions?` + this._queryParamsToString(query));
         return result;
     }
     /**
@@ -50,10 +57,10 @@ class EventsApi extends asyncModules_1.default {
      *
      * @handleName subscribeByMarker
      *
-     * @param {string} marker - Event marker. Example: 'product_price_change'.
+     * @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.
+     * @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.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
@@ -77,14 +84,12 @@ class EventsApi extends asyncModules_1.default {
      *
      * @handleName unsubscribeByMarker
      *
-     * @param {string} marker - The marker of the event to unsubscribe from. Example: 'product_price_change'.
+     * @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.
      */
     async unsubscribeByMarker(marker, productId, langCode = this.state.lang, threshold = 0) {

package/dist/events/eventsInterfaces.d.ts

@@ -7,28 +7,25 @@ import type { IError } from '../base/utils';
  * @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.
-     *
+     * @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.
      * @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>;
+    getAllSubscriptions(offset?: number, limit?: 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 {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.
      */
@@ -36,11 +33,10 @@ interface IEvents {
     /**
      * Unsubscribes from an event on a product by its marker.
      *
-     * @param {string} marker - The marker identifying the event. Example: 'product_price_change'.
+     * @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.
      */
@@ -52,8 +48,17 @@ interface IEvents {
  * @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 }].
- *
+ * @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
+      }
+    ]
  * @description Represents a response from the events API containing a total count and an array of subscription items.
  */
 interface ISubscriptions {

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

@@ -1,7 +1,7 @@
 import AsyncModules from '../base/asyncModules';
 import type StateModule from '../base/stateModule';
 import type { IError } from '../base/utils';
-import type { IFileUploading, IUploadingQuery, IUploadingReturns } from './fileUploadingInterfaces';
+import type { IFileUploading, IUploadingQuery, IUploadingReturn } from './fileUploadingInterfaces';
 /**
  * Controllers for working with file uploading
  *
@@ -22,38 +22,48 @@ export default class FileUploadingApi extends AsyncModules implements IFileUploa
      *
      * @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: { type: 'page', entity: 'editor', id: 3787, width: 0, height: 0, compress: true, template: 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
+        }
      * @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.
+     * @param {any} [fileQuery.template] - preview template identifier. Example: 1.
+     * @return {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<IUploadingReturns | IError>;
+    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 {IUploadingQuery} [fileQuery] - Optional set query parameters. Example: { type: 'page', entity: 'editor', id: 3787, template: 1 }.
+     * @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.
-     *
      * @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>;
@@ -67,10 +77,8 @@ export default class FileUploadingApi extends AsyncModules implements IFileUploa
      * @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.
      * @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.
      */
     getFile(id: number, type: string, entity: string, filename: string, template?: string): Promise<any | IError>;

package/dist/file-uploading/fileUploadingApi.js

@@ -33,20 +33,26 @@ class FileUploadingApi extends asyncModules_1.default {
      *
      * @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: { type: 'page', entity: 'editor', id: 3787, width: 0, height: 0, compress: true, template: 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
+        }
      * @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.
+     * @param {any} [fileQuery.template] - preview template identifier. Example: 1.
+     * @return {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.
      */
     async upload(file, fileQuery) {
@@ -62,15 +68,19 @@ class FileUploadingApi extends asyncModules_1.default {
      * @handleName delete
      *
      * @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 {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.
-     *
      * @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.
      */
     async delete(filename, fileQuery) {
@@ -88,10 +98,8 @@ class FileUploadingApi extends asyncModules_1.default {
      * @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.
      * @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 getFile(id, type, entity, filename, template) {