oneentry 1.0.172 → 1.0.174

package/dist/products/productsApi.d.ts

@@ -19,7 +19,7 @@ export default class ProductsApi extends AsyncModules implements IProductsApi {
     /**
      * Search for all products with pagination and filter.
      * @handleName getProducts
-     * @param {IFilterParams[]} [body] - Request body. Default: [].
+     * @param {IFilterParams[]} [body] - Request body. Default: `[]`.
      * @example
         [
           {
@@ -45,7 +45,7 @@ export default class ProductsApi extends AsyncModules implements 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,
@@ -54,7 +54,7 @@ export default class ProductsApi extends AsyncModules implements IProductsApi {
           "sortKey": "id",
           "signPrice": "orders"
         }
-     * @param {string} [userQuery.signPrice] - Order storage marker for price fixing. If the parameter is set, the price is fixed for a certain time. Example: "orders_storage".
+     * @param {string} [userQuery.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. Example: "orders_storage".
      * @see {@link https://js-sdk.oneentry.cloud/docs/products/#Fixing-the-price-signPrice Fixing the price} documentation.
      * @param {string} [userQuery.sortOrder] - Sorting order parameter.
      * @returns {Promise<IProductsResponse | IError>} Products response, or IError when isShell=true
@@ -66,9 +66,9 @@ export default class ProductsApi extends AsyncModules implements IProductsApi {
     /**
      * Search for all product page objects with pagination (and aggregation) that do not have a category.
      * @handleName getProductsEmptyPage
-     * @param {object} [body] - Request body. Default: {}.
+     * @param {object} [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,
@@ -86,8 +86,8 @@ export default class ProductsApi extends AsyncModules implements IProductsApi {
     /**
      * Search for all products with pagination for the selected category.
      * @handleName getProductsByPageId
-     * @param {number} id - Page id. Example: 2492.
-     * @param {IFilterParams[]} [body] - Request body. Default: [].
+     * @param {number} id - Page ID. Example: 2492.
+     * @param {IFilterParams[]} [body] - Request body. Default: `[]`.
      * @example
         [
           {
@@ -113,7 +113,7 @@ export default class ProductsApi extends AsyncModules implements 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,
@@ -131,9 +131,9 @@ export default class ProductsApi extends AsyncModules implements 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,
@@ -151,8 +151,8 @@ export default class ProductsApi extends AsyncModules implements IProductsApi {
     /**
      * Search for all products with pagination for the selected category.
      * @handleName getProductsByPageUrl
-     * @param {string} url - Page url. Example: "catalog".
-     * @param {IFilterParams[]} [body] - Request body. Default: [].
+     * @param {string} url - Page URL. Example: "catalog".
+     * @param {IFilterParams[]} [body] - Request body. Default: `[]`.
      * @example
         [
           {
@@ -178,7 +178,7 @@ export default class ProductsApi extends AsyncModules implements 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,
@@ -196,9 +196,9 @@ export default class ProductsApi extends AsyncModules implements 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,
@@ -209,8 +209,8 @@ export default class ProductsApi extends AsyncModules implements IProductsApi {
           "statusMarker": "in_stock",
           "templateMarker": "template_12345"
         }
-     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 30.
-     * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 0.
+     * @param {number} [userQuery.limit] - Maximum number of records to return. Default: 30.
+     * @param {number} [userQuery.offset] - Number of records to skip. Default: 0.
      * @param {string} [userQuery.sortOrder] - Optional sorting order "DESC" | "ASC". Example: "DESC".
      * @param {string} [userQuery.sortKey] - Optional field to sort by ("id", "title", "date", "price", "position", "status"). Example: "id".
      * @param {string} [userQuery.relationMode] - How relations are computed: "global" (default) or "local", which also requires the product `id` itself to satisfy the template condition. Example: "local".
@@ -223,18 +223,18 @@ export default class ProductsApi extends AsyncModules implements IProductsApi {
     /**
      * Find products by its ids.
      * @handleName getProductsByIds
-     * @param {string} ids - Product page identifiers for which to find relationships. Example: "12345,67890".
-     * @param {string} [langCode] - Language code. Default "en_US".
-     * @param {IProductsByIdsQuery} [userQuery] - Optional set query parameters.
+     * @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 query parameters.
      * @example
         {
           "limit": 30,
           "offset": 0,
           "signPrice": "orders"
         }
-     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 30.
-     * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 0.
-     * @param {string} [userQuery.signPrice] - Order storage marker for price fixing.
+     * @param {number} [userQuery.limit] - Maximum number of records to return. Default: 30.
+     * @param {number} [userQuery.offset] - Number of records to skip. Default: 0.
+     * @param {string} [userQuery.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.
      * @returns {Promise<IProductsEntity[] | IError>} Array with ProductEntity objects
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Find products by its ids.
@@ -244,9 +244,9 @@ export default class ProductsApi extends AsyncModules implements 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 {Promise<IProductsEntity | IError>} ProductEntity object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Retrieve one product object.
@@ -256,7 +256,7 @@ export default class ProductsApi extends AsyncModules implements 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 {Promise<IProductBlock | IError>} - Product block object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Getting a product block object by product id.
@@ -266,7 +266,7 @@ export default class ProductsApi extends AsyncModules implements 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 {Promise<IProductsEntity[] | IProductSearchResult[] | IError>} Array with ProductEntity objects, or an array with short ProductSearchResult cards when the traficLimit config option is enabled
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -277,7 +277,7 @@ export default class ProductsApi extends AsyncModules implements IProductsApi {
     /**
      * Getting the number of products for the entire catalog.
      * @handleName getProductsCount
-     * @param {any[]} body - Body parameters for filter. Deault: [].
+     * @param {any[]} body - Filter objects with search conditions. Default: `[]`.
      * @example
         [
           {
@@ -300,8 +300,8 @@ export default class ProductsApi extends AsyncModules implements IProductsApi {
     /**
      * Getting the number of products on a catalog page by page ID.
      * @handleName getProductsCountByPageId
-     * @param {string} id - Page ID.
-     * @param {any[]} body - Body parameters for filter. Deault: [].
+     * @param {number | string} id - Page ID. Example: 12345.
+     * @param {any[]} [body] - Filter objects with search conditions. Default: `[]`.
      * @example
         [
           {
@@ -320,12 +320,12 @@ export default class ProductsApi extends AsyncModules implements IProductsApi {
      * @description This method calculates and returns the number of products available on a given catalog page, identified by its page ID, with optional filtering.
      * @see {@link https://js-sdk.oneentry.cloud/docs/products/getProductsCountByPageId getProductsCountByPageId} documentation.
      */
-    getProductsCountByPageId(id: string, body?: any[]): Promise<IProductsCount | IError>;
+    getProductsCountByPageId(id: number | string, body?: any[]): Promise<IProductsCount | IError>;
     /**
      * Getting the number of products for the catalog page by page url.
      * @handleName getProductsCountByPageUrl
-     * @param {string} url - Page url.
-     * @param {any[]} body - Body parameters for filter. Deault: [].
+     * @param {string} url - Page URL.
+     * @param {any[]} body - Filter objects with search conditions. Default: `[]`.
      * @example
         [
           {
@@ -347,10 +347,10 @@ export default class ProductsApi extends AsyncModules implements 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 {Promise<IVectorSearchResponse<IProductsResponse> | IError>} Returns an object with an array of found products and total count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method performs a semantic (vector) search for products.
@@ -359,7 +359,7 @@ export default class ProductsApi extends AsyncModules implements IProductsApi {
     getProductsByVectorSearch(body: IVectorSearchProducts, langCode?: string, offset?: number, limit?: number): Promise<IVectorSearchResponse<IProductsResponse> | IError>;
     /**
      * Get products by page url.
-     * @param {string} url - Page url.
+     * @param {string} url - Page URL.
      * @param {any[]} body - Request body.
      * @returns {IProductsEntity[] | IError} Returns an array of products or an error object.
      */

package/dist/products/productsApi.js

@@ -58,7 +58,7 @@ class ProductsApi extends asyncModules_1.default {
     /**
      * Search for all products with pagination and filter.
      * @handleName getProducts
-     * @param {IFilterParams[]} [body] - Request body. Default: [].
+     * @param {IFilterParams[]} [body] - Request body. Default: `[]`.
      * @example
         [
           {
@@ -84,7 +84,7 @@ class ProductsApi extends asyncModules_1.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,
@@ -93,7 +93,7 @@ class ProductsApi extends asyncModules_1.default {
           "sortKey": "id",
           "signPrice": "orders"
         }
-     * @param {string} [userQuery.signPrice] - Order storage marker for price fixing. If the parameter is set, the price is fixed for a certain time. Example: "orders_storage".
+     * @param {string} [userQuery.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. Example: "orders_storage".
      * @see {@link https://js-sdk.oneentry.cloud/docs/products/#Fixing-the-price-signPrice Fixing the price} documentation.
      * @param {string} [userQuery.sortOrder] - Sorting order parameter.
      * @returns {Promise<IProductsResponse | IError>} Products response, or IError when isShell=true
@@ -114,9 +114,9 @@ class ProductsApi extends asyncModules_1.default {
     /**
      * Search for all product page objects with pagination (and aggregation) that do not have a category.
      * @handleName getProductsEmptyPage
-     * @param {object} [body] - Request body. Default: {}.
+     * @param {object} [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,
@@ -140,8 +140,8 @@ class ProductsApi extends asyncModules_1.default {
     /**
      * Search for all products with pagination for the selected category.
      * @handleName getProductsByPageId
-     * @param {number} id - Page id. Example: 2492.
-     * @param {IFilterParams[]} [body] - Request body. Default: [].
+     * @param {number} id - Page ID. Example: 2492.
+     * @param {IFilterParams[]} [body] - Request body. Default: `[]`.
      * @example
         [
           {
@@ -167,7 +167,7 @@ class ProductsApi extends asyncModules_1.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,
@@ -191,9 +191,9 @@ class ProductsApi extends asyncModules_1.default {
     /**
      * 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,
@@ -218,8 +218,8 @@ class ProductsApi extends asyncModules_1.default {
     /**
      * Search for all products with pagination for the selected category.
      * @handleName getProductsByPageUrl
-     * @param {string} url - Page url. Example: "catalog".
-     * @param {IFilterParams[]} [body] - Request body. Default: [].
+     * @param {string} url - Page URL. Example: "catalog".
+     * @param {IFilterParams[]} [body] - Request body. Default: `[]`.
      * @example
         [
           {
@@ -245,7 +245,7 @@ class ProductsApi extends asyncModules_1.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,
@@ -270,9 +270,9 @@ class ProductsApi extends asyncModules_1.default {
     /**
      * 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,
@@ -283,8 +283,8 @@ class ProductsApi extends asyncModules_1.default {
           "statusMarker": "in_stock",
           "templateMarker": "template_12345"
         }
-     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 30.
-     * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 0.
+     * @param {number} [userQuery.limit] - Maximum number of records to return. Default: 30.
+     * @param {number} [userQuery.offset] - Number of records to skip. Default: 0.
      * @param {string} [userQuery.sortOrder] - Optional sorting order "DESC" | "ASC". Example: "DESC".
      * @param {string} [userQuery.sortKey] - Optional field to sort by ("id", "title", "date", "price", "position", "status"). Example: "id".
      * @param {string} [userQuery.relationMode] - How relations are computed: "global" (default) or "local", which also requires the product `id` itself to satisfy the template condition. Example: "local".
@@ -303,18 +303,18 @@ class ProductsApi extends asyncModules_1.default {
     /**
      * Find products by its ids.
      * @handleName getProductsByIds
-     * @param {string} ids - Product page identifiers for which to find relationships. Example: "12345,67890".
-     * @param {string} [langCode] - Language code. Default "en_US".
-     * @param {IProductsByIdsQuery} [userQuery] - Optional set query parameters.
+     * @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 query parameters.
      * @example
         {
           "limit": 30,
           "offset": 0,
           "signPrice": "orders"
         }
-     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 30.
-     * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 0.
-     * @param {string} [userQuery.signPrice] - Order storage marker for price fixing.
+     * @param {number} [userQuery.limit] - Maximum number of records to return. Default: 30.
+     * @param {number} [userQuery.offset] - Number of records to skip. Default: 0.
+     * @param {string} [userQuery.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.
      * @returns {Promise<IProductsEntity[] | IError>} Array with ProductEntity objects
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Find products by its ids.
@@ -332,9 +332,9 @@ class ProductsApi extends asyncModules_1.default {
     /**
      * 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 {Promise<IProductsEntity | IError>} ProductEntity object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Retrieve one product object.
@@ -352,7 +352,7 @@ class ProductsApi extends asyncModules_1.default {
     /**
      * 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 {Promise<IProductBlock | IError>} - Product block object.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Getting a product block object by product id.
@@ -365,7 +365,7 @@ class ProductsApi extends asyncModules_1.default {
     /**
      * 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 {Promise<IProductsEntity[] | IProductSearchResult[] | IError>} Array with ProductEntity objects, or an array with short ProductSearchResult cards when the traficLimit config option is enabled
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -396,7 +396,7 @@ class ProductsApi extends asyncModules_1.default {
     /**
      * Getting the number of products for the entire catalog.
      * @handleName getProductsCount
-     * @param {any[]} body - Body parameters for filter. Deault: [].
+     * @param {any[]} body - Filter objects with search conditions. Default: `[]`.
      * @example
         [
           {
@@ -424,8 +424,8 @@ class ProductsApi extends asyncModules_1.default {
     /**
      * Getting the number of products on a catalog page by page ID.
      * @handleName getProductsCountByPageId
-     * @param {string} id - Page ID.
-     * @param {any[]} body - Body parameters for filter. Deault: [].
+     * @param {number | string} id - Page ID. Example: 12345.
+     * @param {any[]} [body] - Filter objects with search conditions. Default: `[]`.
      * @example
         [
           {
@@ -453,8 +453,8 @@ class ProductsApi extends asyncModules_1.default {
     /**
      * Getting the number of products for the catalog page by page url.
      * @handleName getProductsCountByPageUrl
-     * @param {string} url - Page url.
-     * @param {any[]} body - Body parameters for filter. Deault: [].
+     * @param {string} url - Page URL.
+     * @param {any[]} body - Filter objects with search conditions. Default: `[]`.
      * @example
         [
           {
@@ -476,10 +476,10 @@ class ProductsApi extends asyncModules_1.default {
     /**
      * 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 {Promise<IVectorSearchResponse<IProductsResponse> | IError>} Returns an object with an array of found products and total count.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description This method performs a semantic (vector) search for products.
@@ -496,7 +496,7 @@ class ProductsApi extends asyncModules_1.default {
     }
     /**
      * Get products by page url.
-     * @param {string} url - Page url.
+     * @param {string} url - Page URL.
      * @param {any[]} body - Request body.
      * @returns {IProductsEntity[] | IError} Returns an array of products or an error object.
      */