oneentry 1.0.173 → 1.0.174

package/esm/blocks/blocksInterfaces.d.ts

@@ -11,8 +11,8 @@ interface IBlocks {
      * @handleName getBlocks
      * @param {BlockType} [type] - Optional type of blocks to retrieve. When omitted, blocks of all types are returned. 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.
+     * @param {number} [offset] - Number of records to skip. Default: 0.
+     * @param {number} [limit] - Maximum number of records to return. 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.
@@ -22,9 +22,9 @@ 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.
+     * @param {string} langCode - Language code. Default: "en_US".
+     * @param {number} [offset] - Number of records to skip. Default: 0.
+     * @param {number} [limit] - Maximum number of records to return. 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.
@@ -43,10 +43,10 @@ interface IBlocks {
     /**
      * Get frequently ordered products by block marker and product id.
      * @handleName getFrequentlyOrderedProducts
-     * @param {number} productId - Product id. Example: 1.
-     * @param {string} marker - Block marker. Example: "frequently_ordered_block".
+     * @param {number} productId - Product ID. Example: 1.
+     * @param {string} marker - Marker of the block. Example: "frequently_ordered_block".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {string} [signPrice] - Order storage marker for price fixing. If the parameter is set, the price is fixed for a certain time.
+     * @param {string} [signPrice] - Marker of the order storage to fix prices for. When set, each product comes with a `signedPrice` that holds the price for a limited time.
      * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
      * @param {number} [limit] - Maximum number of products to return. When omitted, the block's own quantity setting applies. Example: 10.
      * @returns {IProductsResponse} A promise that resolves to a products response (items + total) or an error.
@@ -56,9 +56,9 @@ interface IBlocks {
     /**
      * Get "complete your cart" products by the cart from context (auth user or guest).
      * @handleName getCartComplement
-     * @param {string} marker - Block marker. Example: "cart_complement_block".
+     * @param {string} marker - Marker of the block. Example: "cart_complement_block".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {string} [signPrice] - Order storage marker for price fixing. If the parameter is set, the price is fixed for a certain time.
+     * @param {string} [signPrice] - Marker of the order storage to fix prices for. When set, each product comes with a `signedPrice` that holds the price for a limited time.
      * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
      * @param {number} [limit] - Maximum number of products to return. When omitted, the block's own quantity setting applies. Example: 10.
      * @returns {IProductsResponse} A promise that resolves to a products response (items + total + totalFound) or an error.
@@ -68,8 +68,8 @@ interface IBlocks {
     /**
      * Get "complete your cart" products by an explicit list of productIds (POST body).
      * @handleName getCartComplementByProductIds
-     * @param {string} marker - Block marker. Example: "cart_complement_block".
-     * @param {IBlockProductsLookup} body - Lookup body.
+     * @param {string} marker - Marker of the block. Example: "cart_complement_block".
+     * @param {IBlockProductsLookup} body - Lookup parameters.
      * @example
         {
           "productIds": [1, 2],
@@ -82,9 +82,9 @@ interface IBlocks {
     /**
      * Get "similar to cart" products by the cart from context (auth user or guest).
      * @handleName getCartSimilar
-     * @param {string} marker - Block marker. Example: "cart_similar_block".
+     * @param {string} marker - Marker of the block. Example: "cart_similar_block".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {string} [signPrice] - Order storage marker for price fixing. If the parameter is set, the price is fixed for a certain time.
+     * @param {string} [signPrice] - Marker of the order storage to fix prices for. When set, each product comes with a `signedPrice` that holds the price for a limited time.
      * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
      * @param {number} [limit] - Maximum number of products to return. When omitted, the block's own quantity setting applies. Example: 10.
      * @returns {IProductsResponse} A promise that resolves to a products response (items + total + totalFound) or an error.
@@ -94,8 +94,8 @@ interface IBlocks {
     /**
      * Get "similar to cart" products by an explicit list of productIds (POST body).
      * @handleName getCartSimilarByProductIds
-     * @param {string} marker - Block marker. Example: "cart_similar_block".
-     * @param {IBlockProductsLookup} body - Lookup body.
+     * @param {string} marker - Marker of the block. Example: "cart_similar_block".
+     * @param {IBlockProductsLookup} body - Lookup parameters.
      * @example
         {
           "productIds": [1, 2],
@@ -108,9 +108,9 @@ interface IBlocks {
     /**
      * Get personal recommendations for the user.
      * @handleName getPersonalRecommendations
-     * @param {string} marker - Block marker. Example: "personal_recommendations_block".
+     * @param {string} marker - Marker of the block. Example: "personal_recommendations_block".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {string} [signPrice] - Order storage marker for price fixing. If the parameter is set, the price is fixed for a certain time.
+     * @param {string} [signPrice] - Marker of the order storage to fix prices for. When set, each product comes with a `signedPrice` that holds the price for a limited time.
      * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
      * @param {number} [limit] - Maximum number of products to return. When omitted, the block's own quantity setting applies. Example: 10.
      * @returns {IProductsResponse} A promise that resolves to a products response (items + total + totalFound) or an error.
@@ -120,9 +120,9 @@ interface IBlocks {
     /**
      * Get recently viewed products.
      * @handleName getRecentlyViewed
-     * @param {string} marker - Block marker. Example: "recently_viewed_block".
+     * @param {string} marker - Marker of the block. Example: "recently_viewed_block".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {string} [signPrice] - Order storage marker for price fixing. If the parameter is set, the price is fixed for a certain time.
+     * @param {string} [signPrice] - Marker of the order storage to fix prices for. When set, each product comes with a `signedPrice` that holds the price for a limited time.
      * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
      * @param {number} [limit] - Maximum number of products to return. When omitted, the block's own quantity setting applies. Example: 10.
      * @returns {IProductsResponse} A promise that resolves to a products response (items + total + totalFound) or an error.
@@ -132,9 +132,9 @@ interface IBlocks {
     /**
      * Get products for repeat purchase.
      * @handleName getRepeatPurchase
-     * @param {string} marker - Block marker. Example: "repeat_purchase_block".
+     * @param {string} marker - Marker of the block. Example: "repeat_purchase_block".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {string} [signPrice] - Order storage marker for price fixing. If the parameter is set, the price is fixed for a certain time.
+     * @param {string} [signPrice] - Marker of the order storage to fix prices for. When set, each product comes with a `signedPrice` that holds the price for a limited time.
      * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
      * @param {number} [limit] - Maximum number of products to return. When omitted, the block's own quantity setting applies. Example: 10.
      * @returns {IProductsResponse} A promise that resolves to a products response (items + total + totalFound) or an error.
@@ -144,7 +144,7 @@ interface IBlocks {
     /**
      * Get the block's slides tree as a flat pre-order array (slider_block only).
      * @handleName getSlides
-     * @param {string} marker - Block marker. Example: "slider_block".
+     * @param {string} marker - Marker of the block. Example: "slider_block".
      * @returns {IBlockSlidesResponse} A promise that resolves to the slides response or an error.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      */
@@ -152,9 +152,9 @@ interface IBlocks {
     /**
      * Get trending products of the block.
      * @handleName getTrending
-     * @param {string} marker - Block marker. Example: "trending_block".
+     * @param {string} marker - Marker of the block. Example: "trending_block".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {string} [signPrice] - Order storage marker for price fixing. If the parameter is set, the price is fixed for a certain time.
+     * @param {string} [signPrice] - Marker of the order storage to fix prices for. When set, each product comes with a `signedPrice` that holds the price for a limited time.
      * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
      * @param {number} [limit] - Maximum number of products to return. When omitted, the block's own quantity setting applies. Example: 10.
      * @returns {IProductsResponse} A promise that resolves to a products response (items + total + totalFound) or an error.
@@ -164,9 +164,9 @@ interface IBlocks {
     /**
      * Get "similar to wishlist" products by the wishlist from context (auth user or guest).
      * @handleName getWishlistSimilar
-     * @param {string} marker - Block marker. Example: "wishlist_similar_block".
+     * @param {string} marker - Marker of the block. Example: "wishlist_similar_block".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {string} [signPrice] - Order storage marker for price fixing. If the parameter is set, the price is fixed for a certain time.
+     * @param {string} [signPrice] - Marker of the order storage to fix prices for. When set, each product comes with a `signedPrice` that holds the price for a limited time.
      * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
      * @param {number} [limit] - Maximum number of products to return. When omitted, the block's own quantity setting applies. Example: 10.
      * @returns {IProductsResponse} A promise that resolves to a products response (items + total + totalFound) or an error.
@@ -176,8 +176,8 @@ interface IBlocks {
     /**
      * Get "similar to wishlist" products by an explicit list of productIds (POST body).
      * @handleName getWishlistSimilarByProductIds
-     * @param {string} marker - Block marker. Example: "wishlist_similar_block".
-     * @param {IBlockProductsLookup} body - Lookup body.
+     * @param {string} marker - Marker of the block. Example: "wishlist_similar_block".
+     * @param {IBlockProductsLookup} body - Lookup parameters.
      * @example
         {
           "productIds": [1, 2],
@@ -192,7 +192,7 @@ interface IBlocks {
  * Represents a response from the blocks API.
  * @interface IBlocksResponse
  * @property {number} total - Total number of found records. Example: 100.
- * @property {IBlockEntity[]} items - Array of block entities.
+ * @property {IBlockEntity[]} items - Blocks in this response.
  * @example
     [
       {
@@ -232,7 +232,7 @@ interface IBlocksResponse {
 /**
  * Represents a block entity with various attributes and properties.
  * @interface IBlockEntity
- * @property {IAttributeValues} attributeValues - Map of attribute values keyed by marker; empty object when none.
+ * @property {IAttributeValues} attributeValues - Attribute values keyed by marker; an empty object when there are none.
  * @example
    {
     "block-text": {
@@ -244,27 +244,27 @@ interface IBlocksResponse {
       "isProductPreview": false
     }
    }
- * @property {number} id - Unique identifier of the block. Example: 1234.
- * @property {ILocalizeInfo} localizeInfos - Localization information for the block.
+ * @property {number} id - ID of the block. Example: 1234.
+ * @property {ILocalizeInfo} localizeInfos - Localized data of 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 {number} version - Version number of the block. Example: 1.
+ * @property {string} identifier - Marker of the block. Example: "block1".
  * @property {BlockType} type - Type of the block. Example: "product".
- * @property {number} position - Position of the block for sorting. Example: 1.
- * @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} position - Position of the block, used for sorting. Example: 1.
+ * @property {string | null} templateIdentifier - Marker of the template used by the block, or `null`. Example: "template1".
+ * @property {boolean} isVisible - Whether the block is visible. Example: true.
+ * @property {number} [countElementsPerRow] - Number of items per row in the block, if set. 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.
+ * @property {IProductsResponse} [similarProducts] - Similar products for the block, as `total` and `items`.
  * @example
     {
      "total": 10,
      "items": []
     }
- * @property {IProductsEntity[]} [products] - Array of product entities associated with the block.
+ * @property {IProductsEntity[]} [products] - Products linked to the block.
  * @example
     [
      {
@@ -296,8 +296,8 @@ interface IBlockEntity {
 /**
  * Represents a search block entity with an identifier, name, and ID.
  * @interface ISearchBlock
- * @property {number} id - Unique identifier of the search block. Example: 1.
- * @property {string} identifier - Unique string identifier for the search block. Example: "search_block_1".
+ * @property {number} id - ID of the search block. Example: 1.
+ * @property {string} identifier - Marker 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.
  */
@@ -310,17 +310,17 @@ interface ISearchBlock {
  * BlockType
  * @type {BlockType}
  * @description This type defines the possible values for block types used in the system: the types `GET /api/content/general-types` returns.
- * `'none'` was dropped — the platform has no such type and a filter by it answers `400 type must be a valid enum value` (CMS-1062).
- * `'service'` is the platform's own name for the type, but the `type` filter of getBlocks and getTemplateByType currently refuses it with the same `400`; that is a platform defect (CMS-1073).
+ * `'none'` was dropped — the platform has no such type and a filter by it answers `400 type must be a valid enum value`.
+ * `'service'` is the platform's own name for the type, but the `type` filter of getBlocks and getTemplateByType currently refuses it with the same `400`; that is a platform defect.
  */
 type BlockType = 'product' | 'error_page' | 'catalog_page' | 'product_preview' | 'similar_products_block' | 'product_block' | 'frequently_ordered_block' | 'trending_block' | 'recently_viewed_block' | 'repeat_purchase_block' | 'slider_block' | 'personal_recommendations_block' | 'cart_complement_block' | 'cart_similar_block' | 'wishlist_similar_block' | 'form' | 'common_page' | 'common_block' | 'order' | 'service' | 'external_page' | 'discount';
 /**
  * Lookup body for block product endpoints by explicit productIds.
  * @interface IBlockProductsLookup
- * @property {number[]} productIds - Product identifiers to look up. Example: [1, 2, 3].
+ * @property {number[]} productIds - IDs of the products to look up. Example: [1, 2, 3].
  * @property {string} [langCode] - Language code. Default: "en_US".
- * @property {number} [limit] - Max number of products to return. Example: 10.
- * @property {string} [signPrice] - Order storage marker for price fixing. If the parameter is set, the price is fixed for a certain time.
+ * @property {number} [limit] - Maximum number of products to return. Example: 10.
+ * @property {string} [signPrice] - Marker of the order storage to fix prices for. When set, each product comes with a `signedPrice` that holds the price for a limited time.
  * @see {@link https://js-sdk.oneentry.cloud/docs/blocks/#Fixing-the-price-signPrice Fixing the price} documentation.
  * @description Body for the POST block product endpoints (cart-complement / cart-similar / wishlist-similar) that accept an explicit list of productIds.
  */
@@ -333,13 +333,13 @@ interface IBlockProductsLookup {
 /**
  * A single slide item of a slider block (flat pre-order tree node).
  * @interface IBlockSlideItem
- * @property {number} id - Slide identifier. Example: 1.
- * @property {number | null} [parentId] - Parent slide identifier, or null for root slides. Example: null.
+ * @property {number} id - Slide ID. Example: 1.
+ * @property {number | null} [parentId] - ID of the parent slide, or `null` for root slides. Example: null.
  * @property {number} depth - Depth of the slide in the tree. Example: 0.
  * @property {number} position - Position of the slide among its siblings. Example: 1.
  * @property {boolean} visible - Whether the slide is visible. Example: true.
- * @property {number} [time] - Display time for the slide. Example: 5.
- * @property {'sec' | 'ms'} [timeInterval] - Unit of the time field. Example: "sec".
+ * @property {number} [time] - How long the slide is shown, in `timeInterval` units. Absent when not set. Example: 5.
+ * @property {'sec' | 'ms'} [timeInterval] - Unit of `time`: `"sec"` or `"ms"`. Example: "sec".
  * @property {IAttributeValues} attributeValues - Map of attribute values keyed by marker.
  * @description A single slide item returned in the slides flat pre-order array.
  */
@@ -357,9 +357,9 @@ interface IBlockSlideItem {
  * Slides response for a slider block.
  * @interface IBlockSlidesResponse
  * @property {number} total - Total number of slides. Example: 3.
- * @property {number} [time] - Default display time for slides. Example: 5.
- * @property {'sec' | 'ms'} [timeInterval] - Unit of the time field. Example: "sec".
- * @property {IBlockSlideItem[]} items - Flat pre-order array of slide items.
+ * @property {number} [time] - Default time each slide is shown, in `timeInterval` units. Example: 5.
+ * @property {'sec' | 'ms'} [timeInterval] - Unit of `time`: `"sec"` or `"ms"`. Example: "sec".
+ * @property {IBlockSlideItem[]} items - Slide items as a flat array in pre-order.
  * @description Response of the block slides endpoint (slider_block only).
  */
 interface IBlockSlidesResponse {

package/esm/discounts/discountsApi.d.ts

@@ -26,9 +26,9 @@ export default class DiscountsApi extends AsyncModules implements IDiscountsApi
      * Return all discounts.
      * @handleName getAllDiscounts
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {number} [offset] - Optional parameter for pagination. Default: 0.
-     * @param {number} [limit] - Optional parameter for pagination. Default: 30.
-     * @param {IDiscountType} [type] - Optional parameter to filter discounts by type.
+     * @param {number} [offset] - Number of records to skip. Default: 0.
+     * @param {number} [limit] - Maximum number of records to return. Default: 30.
+     * @param {IDiscountType} [type] - Discount type to filter by. Optional.
      * @returns {Promise<IDiscountsResponse | IError>} Returns an object containing all discounts or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Fetches all discounts from the server.
@@ -38,7 +38,7 @@ export default class DiscountsApi extends AsyncModules implements IDiscountsApi
     /**
      * Get discount by marker
      * @handleName getDiscountByMarker
-     * @param {string} marker - Textual identifier of the discount storage object. Example: "discount_storage".
+     * @param {string} marker - Marker of the discount storage. Example: "discount_storage".
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<IDiscountsEntity | IError>} Returns an object containing discount by marker or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -57,12 +57,12 @@ export default class DiscountsApi extends AsyncModules implements IDiscountsApi
     /**
      * Get bonus transaction history of the current user.
      * @handleName getBonusHistory
-     * @param {IBonusTransactionType} [type] - Transaction type filter.
-     * @param {string} [dateFrom] - Start date filter.
-     * @param {string} [dateTo] - End date filter.
-     * @param {number} [discountId] - Discount id filter.
-     * @param {number} [moduleId] - Module id filter.
-     * @param {boolean} [isAdmin] - Admin filter.
+     * @param {IBonusTransactionType} [type] - Transaction type to filter by.
+     * @param {string} [dateFrom] - Start of the date range.
+     * @param {string} [dateTo] - End of the date range.
+     * @param {number} [discountId] - Return only transactions of this discount ID.
+     * @param {number} [moduleId] - Filter by module ID.
+     * @param {boolean} [isAdmin] - Filter by the transaction's `isAdmin` flag.
      * @returns {Promise<IBonusHistoryResponse | IError>} Returns the container with the transactions and their total, or an error object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @see {@link https://js-sdk.oneentry.cloud/docs/discounts/getBonusHistory getBonusHistory} documentation.
@@ -71,7 +71,7 @@ export default class DiscountsApi extends AsyncModules implements IDiscountsApi
     /**
      * Validate discounts coupon
      * @handleName validateDiscountsCoupon
-     * @param {string} code - The coupon code to validate.
+     * @param {string} code - Coupon code to validate.
      * @returns {Promise<ICouponValidationResult | IError>} Returns an coupon validation result or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This function validates a coupon code and returns the result.
@@ -81,10 +81,10 @@ export default class DiscountsApi extends AsyncModules implements IDiscountsApi
     /**
      * Semantic (vector) search for discounts.
      * @handleName getDiscountsByVectorSearch
-     * @param {IDiscountsVectorSearch} body - Vector search body. Example: `{ queryText: "winter sale" }`.
+     * @param {IDiscountsVectorSearch} body - Vector search parameters. Example: `{ queryText: "winter sale" }`.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {number} [offset] - Parameter for pagination. Default: 0.
-     * @param {number} [limit] - Parameter for pagination. Default: 30.
+     * @param {number} [offset] - Number of records to skip. Default: 0.
+     * @param {number} [limit] - Maximum number of records to return. Default: 30.
      * @returns {Promise<IVectorSearchResponse<IDiscountsResponse> | IError>} Returns an object with an array of found discounts and total count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method performs a semantic (vector) search for discounts.

package/esm/discounts/discountsApi.js

@@ -24,9 +24,9 @@ export default class DiscountsApi extends AsyncModules {
      * Return all discounts.
      * @handleName getAllDiscounts
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {number} [offset] - Optional parameter for pagination. Default: 0.
-     * @param {number} [limit] - Optional parameter for pagination. Default: 30.
-     * @param {IDiscountType} [type] - Optional parameter to filter discounts by type.
+     * @param {number} [offset] - Number of records to skip. Default: 0.
+     * @param {number} [limit] - Maximum number of records to return. Default: 30.
+     * @param {IDiscountType} [type] - Discount type to filter by. Optional.
      * @returns {Promise<IDiscountsResponse | IError>} Returns an object containing all discounts or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Fetches all discounts from the server.
@@ -45,7 +45,7 @@ export default class DiscountsApi extends AsyncModules {
     /**
      * Get discount by marker
      * @handleName getDiscountByMarker
-     * @param {string} marker - Textual identifier of the discount storage object. Example: "discount_storage".
+     * @param {string} marker - Marker of the discount storage. Example: "discount_storage".
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {Promise<IDiscountsEntity | IError>} Returns an object containing discount by marker or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -74,12 +74,12 @@ export default class DiscountsApi extends AsyncModules {
     /**
      * Get bonus transaction history of the current user.
      * @handleName getBonusHistory
-     * @param {IBonusTransactionType} [type] - Transaction type filter.
-     * @param {string} [dateFrom] - Start date filter.
-     * @param {string} [dateTo] - End date filter.
-     * @param {number} [discountId] - Discount id filter.
-     * @param {number} [moduleId] - Module id filter.
-     * @param {boolean} [isAdmin] - Admin filter.
+     * @param {IBonusTransactionType} [type] - Transaction type to filter by.
+     * @param {string} [dateFrom] - Start of the date range.
+     * @param {string} [dateTo] - End of the date range.
+     * @param {number} [discountId] - Return only transactions of this discount ID.
+     * @param {number} [moduleId] - Filter by module ID.
+     * @param {boolean} [isAdmin] - Filter by the transaction's `isAdmin` flag.
      * @returns {Promise<IBonusHistoryResponse | IError>} Returns the container with the transactions and their total, or an error object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @see {@link https://js-sdk.oneentry.cloud/docs/discounts/getBonusHistory getBonusHistory} documentation.
@@ -99,7 +99,7 @@ export default class DiscountsApi extends AsyncModules {
     /**
      * Validate discounts coupon
      * @handleName validateDiscountsCoupon
-     * @param {string} code - The coupon code to validate.
+     * @param {string} code - Coupon code to validate.
      * @returns {Promise<ICouponValidationResult | IError>} Returns an coupon validation result or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This function validates a coupon code and returns the result.
@@ -115,10 +115,10 @@ export default class DiscountsApi extends AsyncModules {
     /**
      * Semantic (vector) search for discounts.
      * @handleName getDiscountsByVectorSearch
-     * @param {IDiscountsVectorSearch} body - Vector search body. Example: `{ queryText: "winter sale" }`.
+     * @param {IDiscountsVectorSearch} body - Vector search parameters. Example: `{ queryText: "winter sale" }`.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {number} [offset] - Parameter for pagination. Default: 0.
-     * @param {number} [limit] - Parameter for pagination. Default: 30.
+     * @param {number} [offset] - Number of records to skip. Default: 0.
+     * @param {number} [limit] - Maximum number of records to return. Default: 30.
      * @returns {Promise<IVectorSearchResponse<IDiscountsResponse> | IError>} Returns an object with an array of found discounts and total count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method performs a semantic (vector) search for discounts.