oneentry 1.0.173 → 1.0.174

package/dist/products/productsInterfaces.d.ts

@@ -35,7 +35,7 @@ interface IProductsApi {
           }
         ]
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {IProductsQueryBase} [userQuery] - Optional set query parameters.
+     * @param {IProductsQueryBase} [userQuery] - Optional query parameters.
      * @example
         {
           "limit": 30,
@@ -53,7 +53,7 @@ interface IProductsApi {
      * @handleName getProductsEmptyPage
      * @param body
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {IProductsQueryBase} [userQuery] - Optional set query parameters.
+     * @param {IProductsQueryBase} [userQuery] - Optional query parameters.
      * @example
         {
           "limit": 30,
@@ -70,10 +70,10 @@ interface IProductsApi {
     /**
      * Search for all products with pagination for the selected category.
      * @handleName getProductsByPageId
-     * @param {number} id - Page id. Example: 12345.
-     * @param {IFilterParams[]} [body] - Request body. Default: [].
-     * @param {string} [langCode] - Language code. Default "en_US".
-     * @param {IProductsQueryBase} [userQuery] - Optional set query parameters.
+     * @param {number} id - Page ID. Example: 12345.
+     * @param {IFilterParams[]} [body] - Request body. Default: `[]`.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {IProductsQueryBase} [userQuery] - Optional query parameters.
      * @example
         {
           "limit": 30,
@@ -90,9 +90,9 @@ interface IProductsApi {
     /**
      * Search for information about products and prices for the selected category.
      * @handleName getProductsPriceByPageUrl
-     * @param {string} [url] - Page url. Example: "23-laminat-floorwood-maxima".
+     * @param {string} [url] - Page URL. Example: "23-laminat-floorwood-maxima".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {IProductsPriceQuery} [userQuery] - Optional set query parameters.
+     * @param {IProductsPriceQuery} [userQuery] - Optional query parameters.
      * @example
         {
           "limit": 30,
@@ -109,10 +109,10 @@ interface IProductsApi {
     /**
      * Search for all products with pagination for the selected category.
      * @handleName getProductsByPageUrl
-     * @param {string} url - Page url. Example: "23-laminat-floorwood-maxima".
-     * @param {IFilterParams[]} [body] - Request body. Default: [].
+     * @param {string} url - Page URL. Example: "23-laminat-floorwood-maxima".
+     * @param {IFilterParams[]} [body] - Request body. Default: `[]`.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {IProductsQueryBase} [userQuery] - Optional set query parameters.
+     * @param {IProductsQueryBase} [userQuery] - Optional query parameters.
      * @example
         {
           "limit": 30,
@@ -129,9 +129,9 @@ interface IProductsApi {
     /**
      * Find all related product page objects.
      * @handleName getRelatedProductsById
-     * @param {number} [id] - Product page identifier for which to find relationship. Example: 12345.
+     * @param {number} [id] - ID of the product page to find related products for. Example: 12345.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {IProductsRelatedQuery} [userQuery] - Optional set query parameters.
+     * @param {IProductsRelatedQuery} [userQuery] - Optional query parameters.
      * @example
         {
           "limit": 30,
@@ -150,9 +150,9 @@ interface IProductsApi {
     /**
      * Find products by its ids.
      * @handleName getProductsByIds
-     * @param {string} ids - Product page identifiers for which to find relationships. Example: "12345,67890".
+     * @param {string} ids - Comma-separated IDs of the product pages to fetch. Example: "12345,67890".
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {IProductsByIdsQuery} [userQuery] - Optional set query parameters.
+     * @param {IProductsByIdsQuery} [userQuery] - Optional query parameters.
      * @example
         {
           "limit": 30,
@@ -167,9 +167,9 @@ interface IProductsApi {
     /**
      * Retrieve one product object.
      * @handleName getProductById
-     * @param {number} id - Product id. Example: 12345.
+     * @param {number} id - Product ID. Example: 12345.
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @param {boolean} [isNormalized] - If true, the product object will be normalized.
+     * @param {boolean} [isNormalized] - When `true`, the product is returned in normalized form.
      * @returns {IProductsEntity} ProductEntity object.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description This method retrieves one product object.
@@ -178,7 +178,7 @@ interface IProductsApi {
     /**
      * Getting a product block object by product id.
      * @handleName getProductBlockById
-     * @param {number} id - Product id. Example: 12345.
+     * @param {number} id - Product ID. Example: 12345.
      * @returns {IProductBlock}
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method gets a product block object by product id.
@@ -187,7 +187,7 @@ interface IProductsApi {
     /**
      * Quick search for product page objects with limited output.
      * @handleName searchProduct
-     * @param {string} name - Text to search product page objects (search is based on the title field of the localizeInfos object with language consideration). Example: 'laminat'.
+     * @param {string} name - Text to search for in product titles (`localizeInfos.title`) in the requested language. Example: 'laminat'.
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {IProductsEntity[] | IProductSearchResult[]} Array with ProductEntity objects, or an array with short ProductSearchResult cards when the traficLimit config option is enabled
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
@@ -197,7 +197,7 @@ interface IProductsApi {
     /**
      * Getting the number of products for the entire catalog.
      * @handleName getProductsCount
-     * @param {object[]} [body] - Body parameters for filter. Deault: [].
+     * @param {object[]} [body] - Filter objects with search conditions. Default: `[]`.
      * @example
         [
           {
@@ -229,8 +229,8 @@ interface IProductsApi {
     /**
      * Getting the number of products on a catalog page by page ID.
      * @handleName getProductsCountByPageId
-     * @param {string} id - Page id. Example: "12345".
-     * @param {object[]} body - Body parameters for filter. Deault: [].
+     * @param {number | string} id - Page ID. Example: 12345.
+     * @param {object[]} [body] - Filter objects with search conditions. Default: `[]`.
      * @example
         [
           {
@@ -258,12 +258,12 @@ interface IProductsApi {
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method calculates and returns the number of products available on a given catalog page, identified by its page ID, with optional filtering.
      */
-    getProductsCountByPageId(id: string, body?: object[]): Promise<IProductsCount | IError>;
+    getProductsCountByPageId(id: number | string, body?: object[]): Promise<IProductsCount | IError>;
     /**
      * Getting the number of products on a catalog page by page URL.
      * @handleName getProductsCountByPageUrl
-     * @param {string} url - Page url. Example: "catalog".
-     * @param {string} body - Body parameters for filter. Deault: [].
+     * @param {string} url - Page URL. Example: "catalog".
+     * @param {string} body - Filter objects with search conditions. Default: `[]`.
      * @example
         [
           {
@@ -295,10 +295,10 @@ interface IProductsApi {
     /**
      * Semantic (vector) search for products.
      * @handleName getProductsByVectorSearch
-     * @param {IVectorSearchProducts} body - Vector search body. Example: `{ queryText: "red running shoes" }`.
+     * @param {IVectorSearchProducts} body - Vector search parameters. Example: `{ queryText: "red running shoes" }`.
      * @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 {IVectorSearchResponse<IProductsResponse>} A promise that resolves to a products response (items + total + indexReady) 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 semantic (vector) search for products.
@@ -307,11 +307,11 @@ interface IProductsApi {
 }
 /**
  * @interface IProductsQueryBase
- * @property {number} offset - Parameter for pagination. Default: 0.
- * @property {number} limit - Parameter for pagination. Default: 30.
- * @property {string} sortOrder - Sort order "DESC" | "ASC". Default: "DESC".
- * @property {string} sortKey - Field for sorting (default - null). Possible values: "id", "position", "title", "date", "price", "status". Default: null.
- * @property {string} [signPrice] - Order storage marker for price fixing. If the parameter is set, the price is fixed for a certain time.
+ * @property {number} offset - Number of records to skip. Default: 0.
+ * @property {number} limit - Maximum number of records to return. Default: 30.
+ * @property {string} sortOrder - Sort order: "DESC" or "ASC". Default: "DESC".
+ * @property {string} sortKey - Field to sort by: "id", "position", "title", "date", "price" or "status". Default: null.
+ * @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/products/#Fixing-the-price-signPrice Fixing the price} documentation.
  * @description Base query parameters shared by the product listing endpoints (getProducts, getProductsEmptyPage, getProductsByPageId, getProductsByPageUrl): pagination, sorting and price fixing.
  */
@@ -325,8 +325,8 @@ interface IProductsQueryBase {
 /**
  * @interface IProductsRelatedQuery
  * @augments IProductsQueryBase
- * @property {string | null} [statusMarker] - Product page status marker, default null. Example: "in_stock".
- * @property {string | null} [templateMarker] - Product page template marker, default null. Example: "template_12345".
+ * @property {string | null} [statusMarker] - Marker of the product status. Default: null. Example: "in_stock".
+ * @property {string | null} [templateMarker] - Marker of the product template. Default: null. Example: "template_12345".
  * @property {string} [relationMode] - How relations are computed: "global" (the default) runs the template's chain of conditions as is; "local" additionally requires the attribute value of the product `id` to satisfy the template condition (same operator, same stored operand) before the products of that step are kept. Example: "local".
  * @description Query parameters for getRelatedProductsById: the base query plus product page status and template markers and the relation mode.
  */
@@ -339,11 +339,11 @@ interface IProductsRelatedQuery extends IProductsQueryBase {
  * Query parameters for getProductsPriceByPageUrl: the base query without
  * `sortKey`, plus the product page status marker.
  * @typedef {object} IProductsPriceQuery
- * @property {number} [offset] - Parameter for pagination. Default: 0.
- * @property {number} [limit] - Parameter for pagination. Default: 30.
- * @property {string} [sortOrder] - Sort order "DESC" | "ASC". Default: "DESC".
- * @property {string} [signPrice] - Order storage marker for price fixing.
- * @property {string | null} [statusMarker] - Product page status marker, default null. Example: "in_stock".
+ * @property {number} [offset] - Number of records to skip. Default: 0.
+ * @property {number} [limit] - Maximum number of records to return. Default: 30.
+ * @property {string} [sortOrder] - Sort order: "DESC" or "ASC". Default: "DESC".
+ * @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.
+ * @property {string | null} [statusMarker] - Marker of the product status. Default: null. Example: "in_stock".
  */
 type IProductsPriceQuery = Omit<IProductsQueryBase, 'sortKey'> & {
     statusMarker?: string | null;
@@ -352,7 +352,7 @@ type IProductsPriceQuery = Omit<IProductsQueryBase, 'sortKey'> & {
  * Query parameters for getProductsByIds: only price fixing — `ids` is passed
  * as a dedicated method argument.
  * @typedef {object} IProductsByIdsQuery
- * @property {string} [signPrice] - Order storage marker for price fixing.
+ * @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.
  */
 type IProductsByIdsQuery = Pick<IProductsQueryBase, 'signPrice'>;
 /**
@@ -368,13 +368,13 @@ type IProductsQuery = IProductsQueryBase;
 /**
  * @interface IFilterParams
  * @property {string} [attributeMarker] - The text identifier of the indexed attribute by which values are filtered. Example: "color". Optional: a filter entry may select by `statusMarker` (or `pageUrls`, `title`) alone, e.g. `{ statusMarker: "in_stock" }`.
- * @property {string | null} [conditionMarker] - Id of the filter condition by which the values are filtered. Default: null. Example: "eq".
+ * @property {string | null} [conditionMarker] - Marker of the filter condition, such as `eq`. Default: `null`. Example: "eq".
  * @property {number | string | null} [conditionValue] - The value that is being searched for, default null. Example: "new". Needed together with `attributeMarker`.
- * @property {string | null} [pageUrl] - Url of the category page object. Example: ["23-laminat-floorwood-maxima"].
- * @property {string[] | null} [pageUrls] - Url of the category page object. Example: ["23-laminat-floorwood-maxima"].
- * @property {string | null} [statusMarker] - Text identifier of the product page status (default not set). Example: "in_stock".
+ * @property {string | null} [pageUrl] - URL of one category page. Example: "23-laminat-floorwood-maxima".
+ * @property {string[] | null} [pageUrls] - URLs of the category pages. Example: ["23-laminat-floorwood-maxima"].
+ * @property {string | null} [statusMarker] - Marker of the product status. Not set by default. Example: "in_stock".
  * @property {string | null} [title] - Product name. Example: "Laminatboden Maxima".
- * @property {boolean} [isNested] - Flag for nested attributes, default false. Example: true.
+ * @property {boolean} [isNested] - Whether the entity is nested. Default: `false`. Example: true.
  * @description This interface defines the structure of filter parameters used for querying products, including conditions, attributes, and pagination.
  */
 interface IFilterParams {
@@ -409,10 +409,10 @@ interface IProductPriceRange {
 }
 /**
  * @interface IProductPageRef
- * @property {number} id - Unique identifier of the product-to-page link record. Example: 16.
+ * @property {number} id - ID of the product-to-page link record. Example: 16.
  * @property {number} pageId - Identifier of the page the product is linked to. Example: 4.
- * @property {number} productId - Identifier of the product. Example: 15.
- * @property {number} positionId - Sorting position identifier within the page. Example: 244.
+ * @property {number} productId - Product ID. Example: 15.
+ * @property {number} positionId - ID of the position record that stores the product's sort order. Example: 244.
  * @property {string} categoryPath - Category path of the page the product belongs to. Example: "products".
  * @description Reference linking a product to one of the pages it is published on.
  */
@@ -425,14 +425,14 @@ interface IProductPageRef {
 }
 /**
  * @interface IProductsEntity
- * @property {number} id - The unique identifier. Example: 12345.
- * @property {ILocalizeInfo} localizeInfos - The name of the products, taking into account localization. Example: {}.
- * @property {string | null} statusIdentifier - Product page status identifiers (may be null). Example: "in_stock".
+ * @property {number} id - ID of the product. Example: 12345.
+ * @property {ILocalizeInfo} localizeInfos - Localized product data, such as the title. Example: {}.
+ * @property {string | null} statusIdentifier - Marker of the product status, or `null`. Example: "in_stock".
  * @property {ILocalizeInfo} statusLocalizeInfos - Localized status name for the product. Example: `{ "title": "Sale" }`.
- * @property {string | null} attributeSetIdentifier - Set of attributes id. Example: "set_12345".
- * @property {number} position - Item number (for sorting). Example: 1.
- * @property {number | null} price - The value of the product page price taken from the index. Example: 150.00.
- * @property {object} additional - Additional value from the index.
+ * @property {string | null} attributeSetIdentifier - Marker of the attribute set, or `null` if none is assigned. Example: "set_12345".
+ * @property {number} position - Position used for sorting. Example: 1.
+ * @property {number | null} price - Product price from the search index. Example: 150.00.
+ * @property {object} additional - Extra values computed by the search index, such as the price range in `prices.min` and `prices.max`.
  * @example
     {
       "prices": {
@@ -440,9 +440,9 @@ interface IProductPageRef {
         "max": 150
       }
     }
- * @property {string | null} sku - Product SKU (Stock Keeping Unit), may be null. Example: "SKU_12345".
- * @property {boolean} isSync - Indication of page indexing. Example: true.
- * @property {IAttributeValues} attributeValues - Array of attribute values from the index, represented.
+ * @property {string | null} sku - Product SKU from the search index, or `null`. Example: "SKU_12345".
+ * @property {boolean} isSync - Whether the product is indexed. Example: true.
+ * @property {IAttributeValues} attributeValues - Attribute values keyed by attribute marker.
  * @example
     [
       {
@@ -450,31 +450,31 @@ interface IProductPageRef {
         "value": "red"
       }
     ]
- * @property {string[]} categories - Product categories.
+ * @property {string[]} categories - URLs of the catalog pages the product belongs to.
  * @example
     [
       1,
       2,
       3
     ]
- * @property {boolean} isVisible - A sign of page visibility. Example: true.
- * @property {Array<IFormConfig>} [moduleFormConfigs] - Module form configurations (optional).
- * @property {IRating} [rating] - Rating data.
- * @property {boolean} isPositionLocked - Sorting position lock indicator (optional). Example: false.
- * @property {number[]} relatedIds - Ids of related product pages.
+ * @property {boolean} isVisible - Whether the product is visible. Example: true.
+ * @property {Array<IFormConfig>} [moduleFormConfigs] - Form configurations of the module.
+ * @property {IRating} [rating] - Rating data: average value, likes and dislikes, and the calculation method.
+ * @property {boolean} [isPositionLocked] - Whether the sorting position is locked. Example: false.
+ * @property {number[]} relatedIds - IDs of related products.
  * @example
     [
       12345,
       67890
     ]
- * @property {unknown} [paymentStages] - Payment stages data (may be null). Example: null.
- * @property {number} [distance] - Vector (semantic) search relevance distance. Present only in results of vector search. Example: 0.42.
- * @property {Record<string, unknown>} [discountConfig] - Discount configuration object. Example: {}.
- * @property {string | null} [templateIdentifier] - User id of the linked template. Example: "template_12345".
- * @property {string | null} [shortDescTemplateIdentifier] - User id of the linked template for a short description. Example: "short_desc_template_12345".
- * @property {string} [signedPrice] - The signed price of the product is obtained along with the product data when `signPrice` is set. Example: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
+ * @property {unknown} [paymentStages] - Payment stages data, or `null`. Example: null.
+ * @property {number} [distance] - Relevance distance in vector (semantic) search. Present only in vector search results. Example: 0.42.
+ * @property {Record<string, unknown>} [discountConfig] - Discount configuration. Example: {}.
+ * @property {string | null} [templateIdentifier] - Marker of the linked template. Example: "template_12345".
+ * @property {string | null} [shortDescTemplateIdentifier] - Marker of the template used for the short description. Example: "short_desc_template_12345".
+ * @property {string} [signedPrice] - Signed token (JWT) that fixes the product price for an order. Returned when `signPrice` is set. Example: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
  * @see {@link https://js-sdk.oneentry.cloud/docs/orders/#Fixed-product-price-signedPrice Fixed product price} documentation.
- * @property {IProductPageRef[]} [productPages] - Array of product page references linking the product to its pages.
+ * @property {IProductPageRef[]} [productPages] - Links between the product and the catalog pages it belongs to.
  * @example
     [
       {
@@ -485,7 +485,7 @@ interface IProductPageRef {
         "categoryPath": "products"
       }
     ]
- * @property {string[]} [blocks] - Array of block identifiers.
+ * @property {string[]} [blocks] - Markers of the blocks attached to the product.
  * @example
     [
       "block_12345",
@@ -522,8 +522,8 @@ interface IProductsEntity {
 }
 /**
  * @interface IProductsResponse
- * @property {number} total - The total number of products found. Example: 100.
- * @property {IProductsEntity[]} items - An array of product entities.
+ * @property {number} total - Total number of products found. Example: 100.
+ * @property {IProductsEntity[]} items - Products in this response.
  * @example
     [
       {
@@ -558,8 +558,8 @@ interface IProductSearchResult {
 /**
  * @interface IProductsCount
  * @property {number} totalAll - The total number of products found. Example: 100.
- * @property {number} totalInCategory - The total number of products found in category. Example: 50.
- * @property {number} totalInCategoryWithNested - The total number of products found in nested category. Example: 10.
+ * @property {number} totalInCategory - Number of products in the category. Example: 50.
+ * @property {number} totalInCategoryWithNested - Number of products in the category, including its nested categories. Example: 10.
  * @description This interface defines the structure of a response with total count of product items.
  */
 interface IProductsCount {
@@ -569,8 +569,8 @@ interface IProductsCount {
 }
 /**
  * @interface IProductsInfo
- * @property {number} total - The total number of products found. Example: 100.
- * @property {IProductInfo[]} items - An array of product information objects.
+ * @property {number} total - Total number of products found. Example: 100.
+ * @property {IProductInfo[]} items - Price records of the products.
  * @example
     [
       {
@@ -590,7 +590,7 @@ interface IProductsInfo {
 }
 /**
  * @interface IProductInfo
- * @property {number} id - The unique identifier of the product. Example: 12345.
+ * @property {number} id - ID of the product. Example: 12345.
  * @property {number} price - The price of the product. Example: 150.00.
  * @property {string} [signedPrice] - The signed (fixed) price of the product, returned when `signPrice` is set. Example: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...".
  * @see {@link https://js-sdk.oneentry.cloud/docs/orders/#Fixed-product-price-signedPrice Fixed product price} documentation.
@@ -603,22 +603,22 @@ interface IProductInfo {
 }
 /**
  * @interface IProductBlock
- * @property {number} id - Unique identifier of the product block. Example: 3289.
- * @property {string | null} attributeSetIdentifier - Identifier of the attribute set used in the product block, or null if not applicable. Example: "product_block".
- * @property {ILocalizeInfo} localizeInfos - Localization information for the product block.
+ * @property {number} id - ID of the product block. Example: 3289.
+ * @property {string | null} attributeSetIdentifier - Marker of the attribute set used in the product block, or `null` if there is none. Example: "product_block".
+ * @property {ILocalizeInfo} localizeInfos - Localized data of the product block.
  * @example
     {
       "title": "Box"
     }
- * @property {number} version - Version of the product block entity. Example: 1.
+ * @property {number} version - Version number of the product block. Example: 1.
  * @property {number} position - Position of the product block in a list or layout. Example: 1.
- * @property {string} identifier - Unique string identifier for the product block. Example: "product_block_12345".
- * @property {BlockType} type - Type of the product block, such as "product", "error_page", etc. Example: "product".
- * @property {object} customSettings - Custom settings for the product block, including slider delay, product configuration, similar product rules, and conditions. Example: {}
- * @property {string | null} templateIdentifier - Identifier for the template used by the product block, or null if not applicable. Example: "template_12345".
- * @property {boolean} isVisible - Indicates whether the product block is visible. Example: true.
- * @property {boolean} isSync - Indicates whether the product block is synchronized. Example: false.
- * @property {IAttributeValues} attributeValues - Array of attribute values from the index, represented as a pair of user attribute id and attribute value.
+ * @property {string} identifier - Marker of the product block. Example: "product_block_12345".
+ * @property {BlockType} type - Block type. Example: "product".
+ * @property {object} customSettings - Custom settings of the product block: slider delay, product configuration, similar-product rules and conditions. Example: {}
+ * @property {string | null} templateIdentifier - Marker of the template used by the product block, or `null`. Example: "template_12345".
+ * @property {boolean} isVisible - Whether the product block is visible. Example: true.
+ * @property {boolean} isSync - Whether the product block is synchronized. Example: false.
+ * @property {IAttributeValues} attributeValues - Attribute values keyed by attribute marker.
  * @example
     [
       {
@@ -697,12 +697,12 @@ interface IProductBlock {
 /**
  * @interface IAggregatedProductGroup
  * @deprecated No method returns this shape: getProductsEmptyPage was declared with it,
- * but the endpoint answers `{ items, total }` — see IProductsResponse (CMS-1065).
+ * but the endpoint answers `{ items, total }` — see IProductsResponse.
  * Kept so that existing imports still compile.
  * @property {string} attrValue - Attribute value.
  * @property {IProductsEntity[]} items - Array of product entities.
  * @property {string[]} productIds - Array of product ids.
- * @property {number} total - Total count.
+ * @property {number} total - Total number of records.
  */
 interface IAggregatedProductGroup {
     attrValue: string;
@@ -714,9 +714,9 @@ interface IAggregatedProductGroup {
  * Body for semantic (vector) product search.
  * @interface IVectorSearchProducts
  * @property {string} queryText - Natural-language search query. Example: "red running shoes".
- * @property {number} [vectorDistanceThreshold] - Max vector distance for a hit. Example: 0.5.
- * @property {number} [maxHits] - Max number of hits to return. Example: 50.
- * @property {boolean} [debug] - Include debug info in the response. Example: false.
+ * @property {number} [vectorDistanceThreshold] - Maximum vector distance for a match. Example: 0.5.
+ * @property {number} [maxHits] - Maximum number of hits to return. Example: 50.
+ * @property {boolean} [debug] - Whether to add debug information to the response. Example: false.
  * @description Body for the products vector/search endpoint.
  */
 interface IVectorSearchProducts {

package/dist/search/searchApi.d.ts

@@ -24,9 +24,9 @@ export default class SearchApi extends AsyncModules implements ISearchApi {
      * @param {string} query - Search query. Example: "winter".
      * @param {TGlobalSearchEntityType[]} [types] - Entity types to search in, sent comma-separated. Searches every type when omitted.
      * @param {'all' | 'visible' | 'hidden'} [visibility] - Visibility filter of the searched records. Default: "all".
-     * @param {number} [offset] - Drilldown mode offset. Pass it only together with a single accessible type in `types`.
-     * @param {number} [limit] - Drilldown mode page size. Pass it only together with a single accessible type in `types`, otherwise the API answers 400 "Drilldown mode (limit/offset) requires exactly one accessible type in `types`". Without it every group is returned in full.
-     * @param {string} [langCode] - Language code. Default: "en_US". The search index is per language: a word of a second locale is found only when its own langCode is sent (CMS-912).
+     * @param {number} [offset] - Offset for drilldown mode. Pass it only together with exactly one accessible type in `types`.
+     * @param {number} [limit] - Page size for drilldown mode. Pass it only together with exactly one accessible type in `types`; otherwise the API responds with `400 Drilldown mode (limit/offset) requires exactly one accessible type in types`. Without it, every group is returned in full.
+     * @param {string} [langCode] - Language code. Default: "en_US". The search index is built per language: words in another locale are found only when you pass that locale's `langCode`.
      * @returns {Promise<IGlobalSearchResponse | IError>} Returns the query and the found records grouped by entity type.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Searches names and attribute values of visible records across entity types. The index is per language — the request carries `langCode`, so a bilingual project finds a word of either locale.

package/dist/search/searchApi.js

@@ -62,9 +62,9 @@ class SearchApi extends asyncModules_1.default {
      * @param {string} query - Search query. Example: "winter".
      * @param {TGlobalSearchEntityType[]} [types] - Entity types to search in, sent comma-separated. Searches every type when omitted.
      * @param {'all' | 'visible' | 'hidden'} [visibility] - Visibility filter of the searched records. Default: "all".
-     * @param {number} [offset] - Drilldown mode offset. Pass it only together with a single accessible type in `types`.
-     * @param {number} [limit] - Drilldown mode page size. Pass it only together with a single accessible type in `types`, otherwise the API answers 400 "Drilldown mode (limit/offset) requires exactly one accessible type in `types`". Without it every group is returned in full.
-     * @param {string} [langCode] - Language code. Default: "en_US". The search index is per language: a word of a second locale is found only when its own langCode is sent (CMS-912).
+     * @param {number} [offset] - Offset for drilldown mode. Pass it only together with exactly one accessible type in `types`.
+     * @param {number} [limit] - Page size for drilldown mode. Pass it only together with exactly one accessible type in `types`; otherwise the API responds with `400 Drilldown mode (limit/offset) requires exactly one accessible type in types`. Without it, every group is returned in full.
+     * @param {string} [langCode] - Language code. Default: "en_US". The search index is built per language: words in another locale are found only when you pass that locale's `langCode`.
      * @returns {Promise<IGlobalSearchResponse | IError>} Returns the query and the found records grouped by entity type.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Searches names and attribute values of visible records across entity types. The index is per language — the request carries `langCode`, so a bilingual project finds a word of either locale.

package/dist/search/searchInterfaces.d.ts

@@ -11,9 +11,9 @@ interface ISearchApi {
      * @param {string} query - Search query. Example: "winter".
      * @param {TGlobalSearchEntityType[]} [types] - Entity types to search in, sent comma-separated. Searches every type when omitted.
      * @param {'all' | 'visible' | 'hidden'} [visibility] - Visibility filter of the searched records. Default: "all".
-     * @param {number} [offset] - Drilldown mode offset. Pass it only together with a single accessible type in `types`.
-     * @param {number} [limit] - Drilldown mode page size. Pass it only together with a single accessible type in `types`, otherwise the API answers 400 "Drilldown mode (limit/offset) requires exactly one accessible type in `types`". Without it every group is returned in full.
-     * @param {string} [langCode] - Language code. Default: "en_US". The search index is per language: a word of a second locale is found only when its own langCode is sent (CMS-912).
+     * @param {number} [offset] - Offset for drilldown mode. Pass it only together with exactly one accessible type in `types`.
+     * @param {number} [limit] - Page size for drilldown mode. Pass it only together with exactly one accessible type in `types`; otherwise the API responds with `400 Drilldown mode (limit/offset) requires exactly one accessible type in types`. Without it, every group is returned in full.
+     * @param {string} [langCode] - Language code. Default: "en_US". The search index is built per language: words in another locale are found only when you pass that locale's `langCode`.
      * @returns {Promise<IGlobalSearchResponse | IError>} Returns the query and the found records grouped by entity type.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Searches names and attribute values of visible records across entity types. The index is per language — the request carries `langCode`, so a bilingual project finds a word of either locale.
@@ -72,7 +72,7 @@ interface IGlobalSearchItem {
  * Global search results of a single entity type.
  * @interface IGlobalSearchGroup
  * @property {TGlobalSearchEntityType} type - Entity type of the group. Example: "products".
- * @property {IGlobalSearchItem[]} items - Records found within this entity type.
+ * @property {IGlobalSearchItem[]} items - Records of this entity type that match the query.
  * @property {boolean} hasMore - Whether more records of this type are available beyond the requested page. Example: false.
  * @description Global search results of a single entity type.
  */

package/dist/sitemap/sitemapApi.d.ts

@@ -28,7 +28,7 @@ export default class SitemapApi extends AsyncModules implements ISitemapApi {
     /**
      * Generates a new set of sitemaps.
      * @handleName updateSitemap
-     * @param {ISitemapQuery} body - Sitemap body params (e.g. `{ baseUrls: { en_US: "https://…" } }`).
+     * @param {ISitemapQuery} body - Sitemap parameters, for example `{ baseUrls: { en_US: "https://…" } }`.
      * @returns {Promise<string[] | IError>} Returns an array of generated sitemap URLs.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @see {@link https://js-sdk.oneentry.cloud/docs/sitemap/updateSitemap updateSitemap} documentation.

package/dist/sitemap/sitemapApi.js

@@ -34,7 +34,7 @@ class SitemapApi extends asyncModules_1.default {
     /**
      * Generates a new set of sitemaps.
      * @handleName updateSitemap
-     * @param {ISitemapQuery} body - Sitemap body params (e.g. `{ baseUrls: { en_US: "https://…" } }`).
+     * @param {ISitemapQuery} body - Sitemap parameters, for example `{ baseUrls: { en_US: "https://…" } }`.
      * @returns {Promise<string[] | IError>} Returns an array of generated sitemap URLs.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @see {@link https://js-sdk.oneentry.cloud/docs/sitemap/updateSitemap updateSitemap} documentation.

package/dist/sitemap/sitemapInterfaces.d.ts

@@ -24,8 +24,8 @@ interface ISitemapApi {
  * @property {Record<string, string>} [baseUrls] - Base URLs per language for sitemap generation. Example: `{ "en_US": "https://example.com/" }`.
  * @property {string} [url] - URL of a single sitemap entry.
  * @property {string} [lastmod] - Last modification date of the entry.
- * @property {string} [changefreq] - Frequency of changes for the entry.
- * @property {number} [priority] - Priority of the entry.
+ * @property {string} [changefreq] - How often the entry changes.
+ * @property {number} [priority] - Sitemap `priority` of the entry.
  */
 interface ISitemapQuery {
     baseUrls?: Record<string, string>;

package/dist/subscriptions/subscriptionsApi.d.ts

@@ -21,7 +21,7 @@ export default class SubscriptionsApi extends AsyncModules implements ISubscript
     /**
      * Create a new subscription and get a payment session for it.
      * @handleName subscribe
-     * @param {ISubscribe} body - Subscription body. Example: `{ marker: "premium" }`.
+     * @param {ISubscribe} body - Subscription parameters. Example: `{ marker: "premium" }`.
      * @returns {Promise<ICreatedSubscription | IError>} Returns the created payment session for the subscription.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization.
@@ -32,7 +32,7 @@ export default class SubscriptionsApi extends AsyncModules implements ISubscript
     /**
      * Cancel a subscription.
      * @handleName cancelSubscription
-     * @param {ICancelSubscription} body - Subscription body. Example: `{ marker: "premium" }`.
+     * @param {ICancelSubscription} body - Subscription parameters. Example: `{ marker: "premium" }`.
      * @returns {Promise<boolean | IError>} Returns true if the subscription was cancelled, or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization.
@@ -63,7 +63,7 @@ export default class SubscriptionsApi extends AsyncModules implements ISubscript
     /**
      * Recover a subscription through the Stripe Billing Portal.
      * @handleName recoverSubscriptions
-     * @param {ICancelSubscription} body - Subscription body. Example: `{ marker: "premium" }`.
+     * @param {ICancelSubscription} body - Subscription parameters. Example: `{ marker: "premium" }`.
      * @returns {Promise<boolean | IError>} Returns true if the recovery request was accepted, or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization.

package/dist/subscriptions/subscriptionsApi.js

@@ -59,7 +59,7 @@ class SubscriptionsApi extends asyncModules_1.default {
     /**
      * Create a new subscription and get a payment session for it.
      * @handleName subscribe
-     * @param {ISubscribe} body - Subscription body. Example: `{ marker: "premium" }`.
+     * @param {ISubscribe} body - Subscription parameters. Example: `{ marker: "premium" }`.
      * @returns {Promise<ICreatedSubscription | IError>} Returns the created payment session for the subscription.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization.
@@ -74,7 +74,7 @@ class SubscriptionsApi extends asyncModules_1.default {
     /**
      * Cancel a subscription.
      * @handleName cancelSubscription
-     * @param {ICancelSubscription} body - Subscription body. Example: `{ marker: "premium" }`.
+     * @param {ICancelSubscription} body - Subscription parameters. Example: `{ marker: "premium" }`.
      * @returns {Promise<boolean | IError>} Returns true if the subscription was cancelled, or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization.
@@ -115,7 +115,7 @@ class SubscriptionsApi extends asyncModules_1.default {
     /**
      * Recover a subscription through the Stripe Billing Portal.
      * @handleName recoverSubscriptions
-     * @param {ICancelSubscription} body - Subscription body. Example: `{ marker: "premium" }`.
+     * @param {ICancelSubscription} body - Subscription parameters. Example: `{ marker: "premium" }`.
      * @returns {Promise<boolean | IError>} Returns true if the recovery request was accepted, or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method requires user authorization.