oneentry 1.0.127 → 1.0.128

package/dist/base/utils.d.ts

@@ -1,10 +1,10 @@
 type Types = 'product' | 'error_page' | 'catalog_page' | 'product_preview' | 'similar_products_block' | 'product_block' | 'form' | 'common_page' | 'common_block' | 'order' | 'service' | 'none';
 /**
- * @param {string}  [token]             - If your project is protected by a token, specify this token in this parameter.
- * @param {string}  [langCode]          - specify the default language to avoid specifying it in every request.
- * @param {boolean} [traficLimit]       - Some methods use multiple queries to make it easier to work with the API. Set this parameter to "false" to save traffic and decide for yourself what data you need.
- * @param {boolean} [auth]              - An object with authorization settings
- * @param {boolean} [auth.customAuth]   - Set this flag to true if you want to configure the authorization process yourself. Set the flag to false, or do not pass it at all to have automatic authorization and token renewal
+ * @param {string} [token] - If your project is protected by a token, specify this token in this parameter.
+ * @param {string} [langCode] - specify the default language to avoid specifying it in every request.
+ * @param {boolean} [traficLimit] - Some methods use multiple queries to make it easier to work with the API. Set this parameter to "false" to save traffic and decide for yourself what data you need.
+ * @param {boolean} [auth] - An object with authorization settings
+ * @param {boolean} [auth.customAuth] - Set this flag to true if you want to configure the authorization process yourself. Set the flag to false, or do not pass it at all to have automatic authorization and token renewal
  * @param {boolean} [auth.refreshToken] - Transfer the refresh token here, for example from the local storage, to resume the user's session. Otherwise, the user will need to log in every time a new session is created
  * @param {boolean} [auth.saveFunction] - If you want to store the token between sessions, for example in local storage, create a custom function that takes refreshToken as a parameter and executes the necessary instructions. This function will be called every time the tokens are updated
  * @example
@@ -52,14 +52,14 @@ interface IConfig {
 }
 /**
  * @interface IAttributes
- * @property {Array<object>}       listTitles       - List of titles.
- * @property {ILocalizeInfo}       localizeInfos    - Localization information.
- * @property {string}              marker           - Attribute marker.
- * @property {number}              position         - Attribute position.
- * @property {boolean}             isVisible        - Indicates whether the attribute is visible.
- * @property {string}              type             - Attribute type.
- * @property {Record<string, any>} settings         - Additional settings for the attribute.
- * @property {Record<string, any>} validators       - Validators for the attribute.
+ * @property {Array<object>} listTitles - List of titles.
+ * @property {ILocalizeInfo} localizeInfos - Localization information.
+ * @property {string} marker - Attribute marker.
+ * @property {number} position - Attribute position.
+ * @property {boolean} isVisible - Indicates whether the attribute is visible.
+ * @property {string} type - Attribute type.
+ * @property {Record<string, any>} settings - Additional settings for the attribute.
+ * @property {Record<string, any>} validators - Validators for the attribute.
  * @property {Record<string, any>} additionalFields - Additional fields for the attribute.
  * @description Interface for attributes.
  */

package/dist/blocks/blocksApi.d.ts

@@ -14,17 +14,17 @@ export default class BlocksApi extends AsyncModules implements IBlocks {
     protected state: StateModule;
     protected _url: string;
     /**
-     *
+     * Constructor for BlocksApi class.
      */
     constructor(state: StateModule);
     /**
      * Get blocks by parameters.
      * @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" | "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.
-     * @returns {IBlocksResponse}            Returns BlocksEntity object.
+     * @param {BlockType} type - Available values: "product" | "error_page" | "catalog_page" | "product_preview" | "similar_products_block" | "product_block" | "form" | "common_page" | "common_block" | "order" | "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.
+     * @returns {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.
      */
@@ -32,11 +32,11 @@ export default class BlocksApi extends AsyncModules implements IBlocks {
     /**
      * Get block by marker.
      * @handleName getBlockByMarker
-     * @param   {string}       marker     - Marker of Block. Example: "product_block".
-     * @param   {string}       [langCode] - Language code. Default: "en_US".
-     * @param   {number}       [offset]   - Parameter for pagination. Default: 0.
-     * @param   {number}       [limit]    - Parameter for pagination. Default: 30.
-     * @returns {IBlockEntity}            - Returns a BlockEntity object.
+     * @param {string} marker - Marker of Block. Example: "product_block".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Parameter for pagination. Default: 0.
+     * @param {number} [limit] - Parameter for pagination. Default: 30.
+     * @returns {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.
      */
@@ -44,11 +44,11 @@ export default class BlocksApi extends AsyncModules implements IBlocks {
     /**
      * Get similar products by block marker.
      * @handleName getSimilarProducts
-     * @param   {string}            marker     - Block identifier. Example: "similar_products_block".
-     * @param   {string}            [langCode] - Language code. Default: "en_US".
-     * @param   {number}            [offset]   - Parameter for pagination. Default: 0.
-     * @param   {number}            [limit]    - Parameter for pagination. Default: 30.
-     * @returns {IProductsResponse}            - Returns the total count and an array of product items in object by specified block marker.
+     * @param {string} marker - Block identifier. Example: "similar_products_block".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Parameter for pagination. Default: 0.
+     * @param {number} [limit] - Parameter for pagination. Default: 30.
+     * @returns {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.
      */
@@ -56,11 +56,11 @@ export default class BlocksApi extends AsyncModules implements IBlocks {
     /**
      * Get products by block marker.
      * @handleName getProductsByBlockMarker
-     * @param   {string}            marker     - Block identifier. Example: "product_block".
-     * @param   {string}            [langCode] - Language code. Default: "en_US".
-     * @param   {number}            [offset]   - Parameter for pagination. Default: 0.
-     * @param   {number}            [limit]    - Parameter for pagination. Default: 30.
-     * @returns {IProductsEntity[]}            Return array of BlocksEntity object.
+     * @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.
+     * @returns {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.
      */
@@ -68,9 +68,9 @@ export default class BlocksApi extends AsyncModules implements IBlocks {
     /**
      * Quick search for block objects with limited output.
      * @handleName searchBlock
-     * @param   {string}         name       - Search string. Example: "product_block".
-     * @param   {string}         [langCode] - Language code. Default: "en_US".
-     * @returns {ISearchBlock[]}            Returns an array of ISearchBlock objects.
+     * @param {string} name - Search string. Example: "product_block".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {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.
      */

package/dist/blocks/blocksApi.js

@@ -14,7 +14,7 @@ const asyncModules_1 = __importDefault(require("../base/asyncModules"));
  */
 class BlocksApi extends asyncModules_1.default {
     /**
-     *
+     * Constructor for BlocksApi class.
      */
     constructor(state) {
         super(state);
@@ -23,11 +23,11 @@ class BlocksApi extends asyncModules_1.default {
     /**
      * Get blocks by parameters.
      * @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" | "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.
-     * @returns {IBlocksResponse}            Returns BlocksEntity object.
+     * @param {BlockType} type - Available values: "product" | "error_page" | "catalog_page" | "product_preview" | "similar_products_block" | "product_block" | "form" | "common_page" | "common_block" | "order" | "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.
+     * @returns {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.
      */
@@ -79,11 +79,11 @@ class BlocksApi extends asyncModules_1.default {
     /**
      * Get block by marker.
      * @handleName getBlockByMarker
-     * @param   {string}       marker     - Marker of Block. Example: "product_block".
-     * @param   {string}       [langCode] - Language code. Default: "en_US".
-     * @param   {number}       [offset]   - Parameter for pagination. Default: 0.
-     * @param   {number}       [limit]    - Parameter for pagination. Default: 30.
-     * @returns {IBlockEntity}            - Returns a BlockEntity object.
+     * @param {string} marker - Marker of Block. Example: "product_block".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Parameter for pagination. Default: 0.
+     * @param {number} [limit] - Parameter for pagination. Default: 30.
+     * @returns {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.
      */
@@ -129,11 +129,11 @@ class BlocksApi extends asyncModules_1.default {
     /**
      * Get similar products by block marker.
      * @handleName getSimilarProducts
-     * @param   {string}            marker     - Block identifier. Example: "similar_products_block".
-     * @param   {string}            [langCode] - Language code. Default: "en_US".
-     * @param   {number}            [offset]   - Parameter for pagination. Default: 0.
-     * @param   {number}            [limit]    - Parameter for pagination. Default: 30.
-     * @returns {IProductsResponse}            - Returns the total count and an array of product items in object by specified block marker.
+     * @param {string} marker - Block identifier. Example: "similar_products_block".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Parameter for pagination. Default: 0.
+     * @param {number} [limit] - Parameter for pagination. Default: 30.
+     * @returns {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.
      */
@@ -149,11 +149,11 @@ class BlocksApi extends asyncModules_1.default {
     /**
      * Get products by block marker.
      * @handleName getProductsByBlockMarker
-     * @param   {string}            marker     - Block identifier. Example: "product_block".
-     * @param   {string}            [langCode] - Language code. Default: "en_US".
-     * @param   {number}            [offset]   - Parameter for pagination. Default: 0.
-     * @param   {number}            [limit]    - Parameter for pagination. Default: 30.
-     * @returns {IProductsEntity[]}            Return array of BlocksEntity object.
+     * @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.
+     * @returns {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.
      */
@@ -169,9 +169,9 @@ class BlocksApi extends asyncModules_1.default {
     /**
      * Quick search for block objects with limited output.
      * @handleName searchBlock
-     * @param   {string}         name       - Search string. Example: "product_block".
-     * @param   {string}         [langCode] - Language code. Default: "en_US".
-     * @returns {ISearchBlock[]}            Returns an array of ISearchBlock objects.
+     * @param {string} name - Search string. Example: "product_block".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {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.
      */

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.
  */