oneentry 1.0.123 → 1.0.124

package/dist/products/productsApi.js

@@ -23,46 +23,27 @@ class ProductApi extends asyncModules_1.default {
     /**
      * Search for all products with pagination and filter.
      *
-     * @param {Array<IFilterParams>} [body] - Request body. Default [].
-     * @param {string} [langCode] - Language code parameter. Default "en_US"
+     * @handleName getProducts
+     *
+     * @param {Array<IFilterParams>} [body] - Request body. Default: []. Example: [ { "attributeMarker": "price", "conditionMarker": "mth", "statusMarker": "waiting", "conditionValue": 1, "pageUrls": [ "23-laminat-floorwood-maxima" ], "isNested": false, "title": "" }, { "attributeMarker": "price", "conditionMarker": "lth", "conditionValue": 3, "pageUrls": [ "23-laminat-floorwood-maxima" ], "isNested": false, "title": "" } ].
+     * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {IProductsQuery} [userQuery] - Optional set query parameters.
      *
-     * @param {number} [userQuery.offset] - Optional parameter for pagination, default is 0
-     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 30
-     * @param {string} [userQuery.sortOrder] - Optional sorting order DESC | ASC
-     * @param {string} [userQuery.sortKey] - Optional field to sort by (id, title, date, price, position, status)
-     * @param {number} [userQuery.statusId] - Optional parameter - search by status id
-     * @param {string} [userQuery.statusMarker] - Optional identifier of the product page status
-     * @param {string} [userQuery.conditionValue] - Optional value that is being searched
-     * @param {string} [userQuery.conditionMarker] - Optional identifier of the filter condition by which values are filtered
-     * @param {string} [userQuery.attributeMarker] - Optional text identifier of the indexed attribute by which values are filtered
-     *
-     * @example
-     * const body: IFilterParams[] = [
-     *   {
-     *     "attributeMarker": "price",
-     *     "conditionMarker": "mth",
-     *     "statusMarker": "waiting",
-     *     "conditionValue": 1,
-     *     "pageUrls": [
-     *       "23-laminat-floorwood-maxima"
-     *     ],
-     *     "isNested": false,
-     *     "title": ""
-     *   },
-     *   {
-     *     "attributeMarker": "price",
-     *     "conditionMarker": "lth",
-     *     "conditionValue": 3,
-     *     "pageUrls": [
-     *       "23-laminat-floorwood-maxima"
-     *     ],
-     *     "isNested": false,
-     *     "title": ""
-     *   }
-     * ]
-     *
-     * @returns  Array with ProductEntity objects
+     * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 0.
+     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 30.
+     * @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 {number} [userQuery.statusId] - Optional parameter - search by status id. Example: 123.
+     * @param {string} [userQuery.statusMarker] - Optional identifier of the product page status. Example: 'in_stock'.
+     * @param {string} [userQuery.conditionValue] - Optional value that is being searched. Example: 'new'.
+     * @param {string} [userQuery.conditionMarker] - Optional identifier of the filter condition by which values are filtered. Example: 'equals'.
+     * @param {string} [userQuery.attributeMarker] - Optional text identifier of the indexed attribute by which values are filtered. Example: 'color'.
+     *
+     * @return {IProductsResponse} Array with ProductEntity objects
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description Fetch products with optional filters and pagination.
+     *
      */
     async getProducts(body = [], langCode = this.state.lang, userQuery) {
         const query = {
@@ -76,19 +57,24 @@ class ProductApi extends asyncModules_1.default {
     /**
      * Search for all product page objects with pagination that do not have a category.
      *
-     * @param {string} [langCode] - Language code parameter. Default "en_US"
+     * @handleName getProductsEmptyPage
+     *
+     * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {IProductsQuery} [userQuery] - Optional set query parameters.
      *
-     * @param {number} [userQuery.offset] - Optional parameter for pagination, default is 0
-     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 30
-     * @param {string} [userQuery.statusMarker] - Optional identifier of the product page status
-     * @param {string} [userQuery.conditionValue] - Optional value that is being searched
-     * @param {string} [userQuery.conditionMarker] - Optional identifier of the filter condition by which values are filtered
-     * @param {string} [userQuery.attributeMarker] - Optional text identifier of the indexed attribute by which values are filtered
-     * @param {string} [userQuery.sortOrder] - Optional sorting order DESC | ASC
-     * @param {string} [userQuery.sortKey] - Optional field to sort by (id, title, date, price, position, status)
+     * @param {number} [userQuery.offset] - Optional parameter for pagination, default is 0.
+     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 30.
+     * @param {string} [userQuery.statusMarker] - Optional identifier of the product page status. Example: 'in_stock'.
+     * @param {string} [userQuery.conditionValue] - Optional value that is being searched. Example: 'new'.
+     * @param {string} [userQuery.conditionMarker] - Optional identifier of the filter condition by which values are filtered. Example: 'equals'.
+     * @param {string} [userQuery.attributeMarker] - Optional text identifier of the indexed attribute by which values are filtered. Example: 'color'.
+     * @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'.
+     *
+     * @return {IProductsResponse} Array with ProductEntity objects.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      *
-     * @returns  Array with ProductEntity objects
+     * @description Fetch products with optional filters and pagination.
      */
     async getProductsEmptyPage(langCode = this.state.lang, userQuery) {
         const query = { ...this._defaultQuery, ...userQuery };
@@ -98,46 +84,27 @@ class ProductApi extends asyncModules_1.default {
     /**
      * Search for all products with pagination for the selected category.
      *
+     * @handleName getProductsByPageId
+     *
      * @param {number} id - Page id.
-     * @param {Array<IFilterParams>} body - Request body.
-     * @param {string} [langCode] - Language code parameter. Default "en_US"
+     * @param {Array<IFilterParams>} [body] - Request body. Default: []. Example: [ { "attributeMarker": "price", "conditionMarker": "mth", "statusMarker": "waiting", "conditionValue": 1, "pageUrls": [ "23-laminat-floorwood-maxima" ], "isNested": false, "title": "" }, { "attributeMarker": "price", "conditionMarker": "lth", "conditionValue": 3, "pageUrls": [ "23-laminat-floorwood-maxima" ], "isNested": false, "title": "" } ].
+     * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {IProductsQuery} [userQuery] - Optional set query parameters.
      *
-     * @param {number} [userQuery.offset] - Optional parameter for pagination, default is 0
-     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 30
-     * @param {string} [userQuery.statusMarker] - Optional identifier of the product page status
-     * @param {string} [userQuery.conditionValue] - Optional value that is being searched
-     * @param {string} [userQuery.conditionMarker] - Optional identifier of the filter condition by which values are filtered
-     * @param {string} [userQuery.attributeMarker] - Optional text identifier of the indexed attribute by which values are filtered
-     * @param {string} [userQuery.sortOrder] - Optional sorting order DESC | ASC
-     * @param {string} [userQuery.sortKey] - Optional field to sort by (id, title, date, price, position, status)
-     *
-     * @example
-     * const body = [
-     *   {
-     *     "attributeMarker": "price",
-     *     "conditionMarker": "mth",
-     *     "statusMarker": "waiting",
-     *     "conditionValue": 1,
-     *     "pageUrls": [
-     *       "23-laminat-floorwood-maxima"
-     *     ],
-     *     "isNested": false,
-     *     "title": ""
-     *   },
-     *   {
-     *     "attributeMarker": "price",
-     *     "conditionMarker": "lth",
-     *     "conditionValue": 3,
-     *     "pageUrls": [
-     *       "23-laminat-floorwood-maxima"
-     *     ],
-     *     "isNested": false,
-     *     "title": ""
-     *   }
-     * ]
-     *
-     * @returns  Array with ProductEntity objects
+     * @param {number} [userQuery.offset] - Optional parameter for pagination. Default is 0.
+     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default is 30.
+     * @param {string} [userQuery.statusMarker] - Optional identifier of the product page status. Example: 'in_stock'.
+     * @param {string} [userQuery.conditionValue] - Optional value that is being searched. Example: 'new'.
+     * @param {string} [userQuery.conditionMarker] - Optional identifier of the filter condition by which values are filtered. Example: 'equals'.
+     * @param {string} [userQuery.attributeMarker] - Optional text identifier of the indexed attribute by which values are filtered. Example: 'color'.
+     * @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'.
+     *
+     * @return {IProductsResponse} Array with ProductEntity objects
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description Fetch products by page ID with optional filters and pagination.
+     *
      */
     async getProductsByPageId(id, body = [], langCode = this.state.lang, userQuery) {
         const query = { ...this._defaultQuery, ...userQuery };
@@ -147,20 +114,25 @@ class ProductApi extends asyncModules_1.default {
     /**
      * Search for information about products and prices for the selected category.
      *
-     * @param {string} [url] - Page url.
-     * @param {string} [langCode] - Language code.
+     * @handleName getProductsPriceByPageUrl
+     *
+     * @param {string} [url] - Page url. Example: '23-laminat-floorwood-maxima'.
+     * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {IProductsQuery} [userQuery] - Optional set query parameters.
      *
-     * @param {number} [userQuery.offset] - Optional parameter for pagination, default is 30
-     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 0
-     * @param {string} [userQuery.statusMarker] - Optional identifier of the product page status
-     * @param {string} [userQuery.conditionValue] - Optional value that is being searched
-     * @param {string} [userQuery.conditionMarker] - Optional identifier of the filter condition by which values are filtered
-     * @param {string} [userQuery.attributeMarker] - Optional text identifier of the indexed attribute by which values are filtered
-     * @param {string} [userQuery.sortOrder] - Optional sorting order DESC | ASC
-     * @param {string} [userQuery.sortKey] - Optional field to sort by (id, title, date, price, position, status)
+     * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 30.
+     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 0.
+     * @param {string} [userQuery.statusMarker] - Optional identifier of the product page status. Example: 'in_stock'.
+     * @param {string} [userQuery.conditionValue] - Optional value that is being searched. Example: 'new'.
+     * @param {string} [userQuery.conditionMarker] - Optional identifier of the filter condition by which values are filtered. Example: 'equals'.
+     * @param {string} [userQuery.attributeMarker] - Optional text identifier of the indexed attribute by which values are filtered. Example: 'color'.
+     * @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'.
+     *
+     * @return {IProductsInfo} Array with ProductInformation objects.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      *
-     * @returns  Array with ProductInformation objects
+     * @description
      */
     async getProductsPriceByPageUrl(url, langCode = this.state.lang, userQuery) {
         const query = {
@@ -174,46 +146,27 @@ class ProductApi extends asyncModules_1.default {
     /**
      * Search for all products with pagination for the selected category.
      *
-     * @param {string} [url] - Page url.
-     * @param {Array<IFilterParams>} [body] - Request body.
-     * @param {string} [langCode] - Language code parameter. Default "en_US"
+     * @handleName getProductsByPageUrl
+     *
+     * @param {string} url - Page url.
+     * @param {Array<IFilterParams>} [body] - Request body. Default: []. Example: [ { "attributeMarker": "price", "conditionMarker": "mth", "statusMarker": "waiting", "conditionValue": 1, "pageUrls": [ "23-laminat-floorwood-maxima" ], "isNested": false, "title": "" }, { "attributeMarker": "price", "conditionMarker": "lth", "conditionValue": 3, "pageUrls": [ "23-laminat-floorwood-maxima" ], "isNested": false, "title": "" } ].
+     * @param {string} [langCode] - Language code. Default: "en_US".
      * @param {IProductsQuery} [userQuery] - Optional set query parameters.
      *
-     * @param {number} [userQuery.offset] - Optional parameter for pagination, default is 30
-     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 0
-     * @param {string} [userQuery.statusMarker] - Optional identifier of the product page status
-     * @param {string} [userQuery.conditionValue] - Optional value that is being searched
-     * @param {string} [userQuery.conditionMarker] - Optional identifier of the filter condition by which values are filtered
-     * @param {string} [userQuery.attributeMarker] - Optional text identifier of the indexed attribute by which values are filtered
-     * @param {string} [userQuery.sortOrder] - Optional sorting order DESC | ASC
-     * @param {string} [userQuery.sortKey] - Optional field to sort by (id, title, date, price, position, status)
-     *
-     * @example
-     * const body = [
-     *   {
-     *     "attributeMarker": "price",
-     *     "conditionMarker": "mth",
-     *     "statusMarker": "waiting",
-     *     "conditionValue": 1,
-     *     "pageUrls": [
-     *       "23-laminat-floorwood-maxima"
-     *     ],
-     *     "isNested": false,
-     *     "title": ""
-     *   },
-     *   {
-     *     "attributeMarker": "price",
-     *     "conditionMarker": "lth",
-     *     "conditionValue": 3,
-     *     "pageUrls": [
-     *       "23-laminat-floorwood-maxima"
-     *     ],
-     *     "isNested": false,
-     *     "title": ""
-     *   }
-     * ]
-     *
-     * @returns  Array with ProductEntity objects
+     * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 30.
+     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 0.
+     * @param {string} [userQuery.statusMarker] - Optional identifier of the product page status. Example: 'in_stock'.
+     * @param {string} [userQuery.conditionValue] - Optional value that is being searched. Example: 'new'.
+     * @param {string} [userQuery.conditionMarker] - Optional identifier of the filter condition by which values are filtered. Example: 'equals'.
+     * @param {string} [userQuery.attributeMarker] - Optional text identifier of the indexed attribute by which values are filtered. Example: 'color'.
+     * @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'.
+     *
+     * @return {IProductsResponse} Array with ProductEntity objects.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description Search for all products with pagination for the selected category.
+     *
      */
     async getProductsByPageUrl(url, body = [], langCode = this.state.lang, userQuery) {
         const query = { ...this._defaultQuery, ...userQuery };
@@ -224,16 +177,21 @@ class ProductApi extends asyncModules_1.default {
     /**
      * Find all related product page objects.
      *
-     * @param {number} [id] - Product page identifier for which to find relationship.
-     * @param {string} [langCode] - Language code parameter. Default "en_US"
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
+     * @handleName getRelatedProductsById
+     *
+     * @param {number} [id] - Product page identifier for which to find relationship. Example: 12345.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {IProductsQuery} [userQuery] - Optional set query parameters. Example: { offset: 0, limit: 30, sortOrder: 'DESC', sortKey: 'id' }.
+     *
+     * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 0.
+     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 30.
+     * @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 {number} [userQuery.offset] - Optional parameter for pagination, default is 0
-     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 30
-     * @param {string} [userQuery.sortOrder] - Optional sorting order DESC | ASC
-     * @param {string} [userQuery.sortKey] - Optional field to sort by (id, title, date, price, position, status)
+     * @return {IProductsResponse} Array with ProductEntity objects
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      *
-     * @returns  Array with ProductEntity objects
+     * @description Find all related product page objects.
      */
     async getRelatedProductsById(id, langCode = this.state.lang, userQuery) {
         const query = { ...this._defaultQuery, ...userQuery };
@@ -243,16 +201,21 @@ class ProductApi extends asyncModules_1.default {
     /**
      * Find products by its ids.
      *
-     * @param {string} [ids] - Product page identifiers for which to find relationships.
-     * @param {string} [langCode] - Language code parameter. Default "en_US"
-     * @param {IProductsQuery} [userQuery] - Optional set query parameters.
+     * @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 {IProductsQuery} [userQuery] - Optional set query parameters. Example: { offset: 0, limit: 30, sortOrder: 'DESC', sortKey: 'id' }.
+     *
+     * @param {number} [userQuery.offset] - Optional parameter for pagination. Default: 0.
+     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 30.
+     * @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 {number} [userQuery.offset] - Optional parameter for pagination, default is 0
-     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 30
-     * @param {string} [userQuery.sortOrder] - Optional sorting order DESC | ASC
-     * @param {string} [userQuery.sortKey] - Optional field to sort by (id, title, date, price, position, status)
+     * @return {IProductEntity[]} Array with ProductEntity objects
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      *
-     * @returns  Array with ProductEntity objects
+     * @description Find products by its ids.
      */
     async getProductsByIds(ids, langCode = this.state.lang, userQuery) {
         const query = {
@@ -267,10 +230,15 @@ class ProductApi extends asyncModules_1.default {
     /**
      * Retrieve one product object.
      *
-     * @param {number} [id] - Product id.
-     * @param {string} [langCode] - Language code parameter. Default "en_US".
+     * @handleName getProductById
      *
-     * @returns  ProductEntity object.
+     * @param {number} [id] - Product id. Example: 12345.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {IProductEntity} ProductEntity object.
+     * @throws {IError} If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description Retrieve one product object.
      */
     async getProductById(id, langCode = this.state.lang) {
         const result = await this._fetchGet(`/${id}?langCode=${langCode}`);
@@ -279,7 +247,14 @@ class ProductApi extends asyncModules_1.default {
     /**
      * Getting a product block object by product id.
      *
-     * @param {number} [id] - Product id
+     * @handleName getProductBlockById
+     *
+     * @param {number} id - Product id. Example: 12345.
+     *
+     * @return {IProductBlock}
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     *
+     * @description Getting a product block object by product id.
      */
     async getProductBlockById(id) {
         const response = await this._fetchGet(`/${id}/blocks`);
@@ -288,10 +263,15 @@ class ProductApi extends asyncModules_1.default {
     /**
      * Quick search for product page objects with limited output.
      *
-     * @param {string} [name] - Text to search product page objects (search is based on the title field of the localizeInfos object with language consideration)
-     * @param {string} [langCode] - Language code
+     * @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} [langCode] - Language code. Default: "en_US".
+     *
+     * @return {IProductsEntity[]} Array with ProductEntity objects
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      *
-     * @returns  Array with ProductEntity objects
+     * @description Quick search for product page objects with limited output.
      */
     async searchProduct(name, langCode = this.state.lang) {
         const searchProducts = await this._fetchGet(`/quick/search?langCode=${langCode}&name=${name}`);