oneentry 1.0.127 → 1.0.130

package/dist/blocks/blocksInterfaces.d.ts

@@ -3,22 +3,22 @@ import type { IProductsEntity, IProductsResponse } from '../products/productsInt
 /**
  * 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} 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} 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.
-     * @returns {IBlocksResponse}            A promise that resolves to a blocks response or an error.
+     * @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.
+     * @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.
      */
@@ -26,11 +26,11 @@ interface IBlocks {
     /**
      * 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.
-     * @returns {IBlockEntity}          A promise that resolves to a block entity or an error.
+     * @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.
+     * @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.
      */
@@ -38,9 +38,9 @@ interface IBlocks {
     /**
      * 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".
-     * @returns {ISearchBlock[]}            A promise that resolves to an array of search blocks or an error.
+     * @param {string} name - The name to search for. Example: "product_block".
+     * @param {string} [langCode] - Optional language code for localization. Default: "en_US".
+     * @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.
      */
@@ -49,37 +49,37 @@ interface IBlocks {
 /**
  * Represents a response from the blocks API.
  * @interface IBlocksResponse
- * @property {number}         total - Total number of found records. Example: 100.
+ * @property {number} total - Total number of found records. Example: 100.
  * @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"
-                                    }
-                                    ]
-                                    }
-                                    ]
+    [
+      {
+        "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 {
@@ -89,42 +89,42 @@ 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
-                                                       }
-                                                       }
- * @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.
- * @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 {IProductsEntity[]} [products]            - Array of product entities associated with the block. Example:
-                                                       [
-                                                       {
-                                                       "id": 1,
-                                                       "name": "Product 1"
-                                                       },
-                                                       {
-                                                       "id": 2,
-                                                       "name": "Product 2"
-                                                       }
-                                                       ]
+ * @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 {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 {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 {
@@ -145,9 +145,9 @@ 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 {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/events/eventsApi.d.ts

@@ -25,9 +25,9 @@ export default class EventsApi extends AsyncModules implements IEvents {
     /**
      * 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.
-     * @returns {ISubscriptions}          Returns an object containing all subscriptions or an error object if there was an issue.
+     * @param {number} [offset] - Optional offset for pagination. Default: 0.
+     * @param {number} [limit] - Optional limit for pagination. Default: 30.
+     * @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.
      */
@@ -35,10 +35,10 @@ export default class EventsApi extends AsyncModules implements IEvents {
     /**
      * Subscribing to an event on a product.
      * @handleName subscribeByMarker
-     * @param   {string}                    marker     - Event marker. Example: "product_price_change".
-     * @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.
+     * @param {string} marker - Event marker. Example: "product_price_change".
+     * @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.
      */
@@ -46,10 +46,10 @@ export default class EventsApi extends AsyncModules implements IEvents {
     /**
      * 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".
-     * @returns {any}               - Returns a promise that resolves to the result of the unsubscription operation or an error object if there was an issue.
+     * @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".
+     * @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.
      */

package/dist/events/eventsApi.js

@@ -30,9 +30,9 @@ 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.
-     * @returns {ISubscriptions}          Returns an object containing all subscriptions or an error object if there was an issue.
+     * @param {number} [offset] - Optional offset for pagination. Default: 0.
+     * @param {number} [limit] - Optional limit for pagination. Default: 30.
+     * @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.
      */
@@ -47,10 +47,10 @@ 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   {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.
+     * @param {string} marker - Event marker. Example: "product_price_change".
+     * @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.
      */
@@ -70,10 +70,10 @@ 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".
-     * @returns {any}               - Returns a promise that resolves to the result of the unsubscription operation or an error object if there was an issue.
+     * @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".
+     * @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.
      */

package/dist/events/eventsInterfaces.d.ts

@@ -8,9 +8,9 @@ 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.
-     * @returns {ISubscriptions}          A promise that resolves to a subscriptions object or an error.
+     * @param {number} [offset] - Optional offset for pagination. Default: 0.
+     * @param {number} [limit] - Optional limit for pagination. Default: 30.
+     * @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.
      */
@@ -18,10 +18,10 @@ interface IEvents {
     /**
      * 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".
-     * @returns {boolean}            A promise that resolves to any type or an error.
+     * @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".
+     * @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.
      */
@@ -29,10 +29,10 @@ interface IEvents {
     /**
      * 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".
-     * @returns {boolean}            A promise that resolves to any type or an error.
+     * @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".
+     * @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.
      */
@@ -41,18 +41,18 @@ interface IEvents {
 /**
  * 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 {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 {
@@ -65,7 +65,7 @@ interface ISubscriptions {
 /**
  * Interface for the body of the subscribe methods.
  * @interface ISubscribeBody
- * @property {string} locale    - Locale of the user. Example: "en_US".
+ * @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.
  */

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

@@ -21,25 +21,25 @@ export default class FileUploadingApi extends AsyncModules implements IFileUploa
     /**
      * 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:
-                                                          {
-                                                          "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   {any}                [fileQuery.template] - preview template identifier. Example: 1.
-     * @returns {IUploadingReturn[]}                      Uploads a file to an Amazon S3-compatible cloud file storage.
+     * @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 {any} [fileQuery.template] - preview template identifier. Example: 1.
+     * @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.
      */
@@ -47,19 +47,19 @@ export default class FileUploadingApi extends AsyncModules implements IFileUploa
     /**
      * 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   {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 {any}                                  Returns a promise that resolves to the result of the deletion operation or an error object if there was an issue.
+     * @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 {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.
      */
@@ -67,12 +67,12 @@ export default class FileUploadingApi extends AsyncModules implements IFileUploa
     /**
      * 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   {string} [template] - Preview template identifier. Example: 1.
-     * @returns {any}               Returns a promise that resolves to a Blob object containing the file data or an error object if there was an issue.
+     * @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.
+     * @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.
      */

package/dist/file-uploading/fileUploadingApi.js

@@ -33,25 +33,25 @@ class FileUploadingApi extends asyncModules_1.default {
     /**
      * 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:
-                                                          {
-                                                          "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   {any}                [fileQuery.template] - preview template identifier. Example: 1.
-     * @returns {IUploadingReturn[]}                      Uploads a file to an Amazon S3-compatible cloud file storage.
+     * @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 {any} [fileQuery.template] - preview template identifier. Example: 1.
+     * @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.
      */
@@ -65,19 +65,19 @@ class FileUploadingApi extends asyncModules_1.default {
     /**
      * 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   {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 {any}                                  Returns a promise that resolves to the result of the deletion operation or an error object if there was an issue.
+     * @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 {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.
      */
@@ -89,12 +89,12 @@ class FileUploadingApi extends asyncModules_1.default {
     /**
      * 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   {string} [template] - Preview template identifier. Example: 1.
-     * @returns {any}               Returns a promise that resolves to a Blob object containing the file data or an error object if there was an issue.
+     * @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.
+     * @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.
      */