oneentry 1.0.127 → 1.0.128

package/dist/products/productsApi.js

@@ -29,44 +29,44 @@ class ProductApi extends asyncModules_1.default {
     /**
      * Search for all products with pagination and filter.
      * @handleName getProducts
-     * @param   {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. Example:
-                                                {
-                                                "limit": 30,
-                                                "offset": 0,
-                                                "sortOrder": "DESC",
-                                                "sortKey": "id",
-                                                "statusId": 123,
-                                                "statusMarker": "in_stock",
-                                                "conditionValue": "new",
-                                                "conditionMarker": "equals",
-                                                "attributeMarker": "color"
-                                                }
-     * @returns {IProductsResponse}             Array with ProductEntity objects
+     * @param {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. Example:
+        {
+          "limit": 30,
+          "offset": 0,
+          "sortOrder": "DESC",
+          "sortKey": "id",
+          "statusId": 123,
+          "statusMarker": "in_stock",
+          "conditionValue": "new",
+          "conditionMarker": "equals",
+          "attributeMarker": "color"
+        }
+     * @returns {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.
      */
@@ -82,20 +82,20 @@ class ProductApi extends asyncModules_1.default {
     /**
      * Search for all product page objects with pagination that do not have a category.
      * @handleName getProductsEmptyPage
-     * @param   {string}            [langCode]  - Language code. Default: "en_US".
-     * @param   {IProductsQuery}    [userQuery] - Optional set query parameters. Example:
-                                                {
-                                                "limit": 30,
-                                                "offset": 0,
-                                                "sortOrder": "DESC",
-                                                "sortKey": "id",
-                                                "statusId": 123,
-                                                "statusMarker": "in_stock",
-                                                "conditionValue": "new",
-                                                "conditionMarker": "equals",
-                                                "attributeMarker": "color"
-                                                }
-     * @returns {IProductsResponse}             Array with ProductEntity objects.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {IProductsQuery} [userQuery] - Optional set query parameters. Example:
+        {
+          "limit": 30,
+          "offset": 0,
+          "sortOrder": "DESC",
+          "sortKey": "id",
+          "statusId": 123,
+          "statusMarker": "in_stock",
+          "conditionValue": "new",
+          "conditionMarker": "equals",
+          "attributeMarker": "color"
+        }
+     * @returns {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 product page objects with pagination that do not have a category.
      */
@@ -107,45 +107,45 @@ class ProductApi 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: []. 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. Example:
-                                                {
-                                                "limit": 30,
-                                                "offset": 0,
-                                                "sortOrder": "DESC",
-                                                "sortKey": "id",
-                                                "statusId": 123,
-                                                "statusMarker": "in_stock",
-                                                "conditionValue": "new",
-                                                "conditionMarker": "equals",
-                                                "attributeMarker": "color"
-                                                }
-     * @returns {IProductsResponse}             Array with ProductEntity objects
+     * @param {number} id - Page id. Example: 2492.
+     * @param {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. Example:
+        {
+          "limit": 30,
+          "offset": 0,
+          "sortOrder": "DESC",
+          "sortKey": "id",
+          "statusId": 123,
+          "statusMarker": "in_stock",
+          "conditionValue": "new",
+          "conditionMarker": "equals",
+          "attributeMarker": "color"
+        }
+     * @returns {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.
      */
@@ -157,21 +157,21 @@ class ProductApi 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}         [langCode]  - Language code. Default: "en_US".
-     * @param   {IProductsQuery} [userQuery] - Optional set query parameters. Example:
-                                             {
-                                             "limit": 30,
-                                             "offset": 0,
-                                             "sortOrder": "DESC",
-                                             "sortKey": "id",
-                                             "statusId": 123,
-                                             "statusMarker": "in_stock",
-                                             "conditionValue": "new",
-                                             "conditionMarker": "equals",
-                                             "attributeMarker": "color"
-                                             }
-     * @returns {IProductsInfo}              Array with ProductInformation objects.
+     * @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. Example:
+        {
+          "limit": 30,
+          "offset": 0,
+          "sortOrder": "DESC",
+          "sortKey": "id",
+          "statusId": 123,
+          "statusMarker": "in_stock",
+          "conditionValue": "new",
+          "conditionMarker": "equals",
+          "attributeMarker": "color"
+        }
+     * @returns {IProductsInfo} Array with ProductInformation objects.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Search for information about products and prices for the selected category.
      */
@@ -187,45 +187,45 @@ class ProductApi 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: []. 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. Example:
-                                                {
-                                                "limit": 30,
-                                                "offset": 0,
-                                                "sortOrder": "DESC",
-                                                "sortKey": "id",
-                                                "statusId": 123,
-                                                "statusMarker": "in_stock",
-                                                "conditionValue": "new",
-                                                "conditionMarker": "equals",
-                                                "attributeMarker": "color"
-                                                }
-     * @returns {IProductsResponse}             Array with ProductEntity objects.
+     * @param {string} url - Page url. Example: "catalog".
+     * @param {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. Example:
+        {
+          "limit": 30,
+          "offset": 0,
+          "sortOrder": "DESC",
+          "sortKey": "id",
+          "statusId": 123,
+          "statusMarker": "in_stock",
+          "conditionValue": "new",
+          "conditionMarker": "equals",
+          "attributeMarker": "color"
+        }
+     * @returns {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.
      */
@@ -238,25 +238,25 @@ class ProductApi 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   {string}            [langCode]            - Language code. Default: "en_US".
-     * @param   {IProductsQuery}    [userQuery]           - Optional set query parameters. Example:
-                                                          {
-                                                          "limit": 30,
-                                                          "offset": 0,
-                                                          "sortOrder": "DESC",
-                                                          "sortKey": "id",
-                                                          "statusId": 123,
-                                                          "statusMarker": "in_stock",
-                                                          "conditionValue": "new",
-                                                          "conditionMarker": "equals",
-                                                          "attributeMarker": "color"
-                                                          }
-     * @param   {number}            [userQuery.limit]     - Optional parameter for pagination. Default: 30.
-     * @param   {number}            [userQuery.offset]    - Optional parameter for pagination. 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".
-     * @returns {IProductsResponse}                       Array with ProductEntity objects
+     * @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:
+        {
+          "limit": 30,
+          "offset": 0,
+          "sortOrder": "DESC",
+          "sortKey": "id",
+          "statusId": 123,
+          "statusMarker": "in_stock",
+          "conditionValue": "new",
+          "conditionMarker": "equals",
+          "attributeMarker": "color"
+        }
+     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 30.
+     * @param {number} [userQuery.offset] - Optional parameter for pagination. 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".
+     * @returns {IProductsResponse} Array with ProductEntity objects
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description Find all related product page objects.
      */
@@ -268,30 +268,30 @@ class ProductApi 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   {IProductsQuery}    [userQuery]                 - Optional set query parameters. Example:
-                                                                {
-                                                                "limit": 30,
-                                                                "offset": 0,
-                                                                "sortOrder": "DESC",
-                                                                "sortKey": "id",
-                                                                "statusId": 123,
-                                                                "statusMarker": "in_stock",
-                                                                "conditionValue": "new",
-                                                                "conditionMarker": "equals",
-                                                                "attributeMarker": "color"
-                                                                }
-     * @param   {number}            [userQuery.limit]           - Optional parameter for pagination. Default: 30.
-     * @param   {number}            [userQuery.offset]          - Optional parameter for pagination. 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   {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".
-     * @returns {IProductsEntity[]}                             Array with ProductEntity objects
+     * @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:
+        {
+          "limit": 30,
+          "offset": 0,
+          "sortOrder": "DESC",
+          "sortKey": "id",
+          "statusId": 123,
+          "statusMarker": "in_stock",
+          "conditionValue": "new",
+          "conditionMarker": "equals",
+          "attributeMarker": "color"
+        }
+     * @param {number} [userQuery.limit] - Optional parameter for pagination. Default: 30.
+     * @param {number} [userQuery.offset] - Optional parameter for pagination. 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 {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".
+     * @returns {IProductsEntity[]} Array with ProductEntity objects
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description Find products by its ids.
      */
@@ -308,9 +308,9 @@ class ProductApi extends asyncModules_1.default {
     /**
      * Retrieve one product object.
      * @handleName getProductById
-     * @param   {number}          [id]       - Product id. Example: 12345.
-     * @param   {string}          [langCode] - Language code. Default: "en_US".
-     * @returns {IProductsEntity}            ProductEntity object.
+     * @param {number} [id] - Product id. Example: 12345.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {IProductsEntity} ProductEntity object.
      * @throws {IError} If there is an error during the fetch operation, it will return an error object.
      * @description Retrieve one product object.
      */
@@ -321,8 +321,8 @@ class ProductApi extends asyncModules_1.default {
     /**
      * Getting a product block object by product id.
      * @handleName getProductBlockById
-     * @param   {number}        id - Product id. Example: 12345.
-     * @returns {IProductBlock}    - Product block object.
+     * @param {number} id - Product id. Example: 12345.
+     * @returns {IProductBlock} - Product block object.
      * @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.
      */
@@ -333,9 +333,9 @@ class ProductApi 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}            [langCode] - Language code. Default: "en_US".
-     * @returns {IProductsEntity[]}            Array with ProductEntity objects
+     * @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".
+     * @returns {IProductsEntity[]} Array with ProductEntity objects
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description Quick search for product page objects with limited output.
      */
@@ -356,20 +356,20 @@ class ProductApi extends asyncModules_1.default {
     /**
      * Getting the number of products for the entire catalog.
      * @handleName getProductsCount
-     * @param   {any[]}          body - Body parameters for filter. Deault: []. Example:
-                                      [
-                                      {
-                                      "attributeMarker": "price",
-                                      "conditionMarker": "in",
-                                      "statusMarker": "status_1",
-                                      "conditionValue": {},
-                                      "pageUrls": [
-                                      "23-laminat-floorwood-maxima"
-                                      ],
-                                      "title": "Iphone 17 Pro"
-                                      }
-                                      ]
-     * @returns {IProductsCount}      Object with product items count.
+     * @param {any[]} body - Body parameters for filter. Deault: []. Example:
+        [
+          {
+            "attributeMarker": "price",
+            "conditionMarker": "in",
+            "statusMarker": "status_1",
+            "conditionValue": {},
+            "pageUrls": [
+              "23-laminat-floorwood-maxima"
+            ],
+            "title": "Iphone 17 Pro"
+          }
+        ]
+     * @returns {IProductsCount} Object with product items count.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method calculates and returns the total number of products present across the entire catalog, optionally applying specified filters.
      */
@@ -382,21 +382,21 @@ class ProductApi 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: []. Example:
-                                      [
-                                      {
-                                      "attributeMarker": "price",
-                                      "conditionMarker": "in",
-                                      "statusMarker": "status_1",
-                                      "conditionValue": {},
-                                      "pageUrls": [
-                                      "23-laminat-floorwood-maxima"
-                                      ],
-                                      "title": "Iphone 17 Pro"
-                                      }
-                                      ]
-     * @returns {IProductsCount}      Object with product items count.
+     * @param {string} id - Page ID.
+     * @param {any[]} body - Body parameters for filter. Deault: []. Example:
+        [
+          {
+            "attributeMarker": "price",
+            "conditionMarker": "in",
+            "statusMarker": "status_1",
+            "conditionValue": {},
+            "pageUrls": [
+              "23-laminat-floorwood-maxima"
+            ],
+            "title": "Iphone 17 Pro"
+          }
+        ]
+     * @returns {IProductsCount} Object with product items count.
      * @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.
      */
@@ -409,21 +409,21 @@ class ProductApi extends asyncModules_1.default {
     /**
      * Getting the number of products for the catalog page by page url.
      * @handleName getProductsCountByPageUrl
-     * @param   {string}         url  -
-     * @param   {any[]}          body - Body parameters for filter. Deault: []. Example:
-                                      [
-                                      {
-                                      "attributeMarker": "price",
-                                      "conditionMarker": "in",
-                                      "statusMarker": "status_1",
-                                      "conditionValue": {},
-                                      "pageUrls": [
-                                      "23-laminat-floorwood-maxima"
-                                      ],
-                                      "title": "Iphone 17 Pro"
-                                      }
-                                      ]
-     * @returns {IProductsCount}      Object with product items count.
+     * @param {string} url - Page url.
+     * @param {any[]} body - Body parameters for filter. Deault: []. Example:
+        [
+          {
+            "attributeMarker": "price",
+            "conditionMarker": "in",
+            "statusMarker": "status_1",
+            "conditionValue": {},
+            "pageUrls": [
+              "23-laminat-floorwood-maxima"
+            ],
+            "title": "Iphone 17 Pro"
+          }
+        ]
+     * @returns {IProductsCount} Object with product items count.
      * @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 URL, with optional filtering.
      */