oneentry 1.0.66 → 1.0.68

package/README.md

@@ -1,18 +1,18 @@
-# OneEntry SDK
+# AsyncModules SDK
 
-OneEntry Headless CMS SDK is an SDK that provides an easy way to interact with the OneEntry Headless CMS API.
+AsyncModules Headless CMS SDK is an SDK that provides an easy way to interact with the AsyncModules Headless CMS API.
 
 ## Official Site
 
-Visit the official OneEntry website at [https://oneentry.cloud](https://oneentry.cloud) to learn more about the OneEntry Headless CMS.
+Visit the official AsyncModules website at [https://oneentry.cloud](https://oneentry.cloud) to learn more about the AsyncModules Headless CMS.
 
 ## Sign Up
 
-To get started with OneEntry, sign up for an account at [https://account.oneentry.cloud/authentication/register](https://account.oneentry.cloud/authentication/register).
+To get started with AsyncModules, sign up for an account at [https://account.oneentry.cloud/authentication/register](https://account.oneentry.cloud/authentication/register).
 
 # Installation
 
-To install the OneEntry Headless CMS SDK in your project, run the following command:
+To install the AsyncModules Headless CMS SDK in your project, run the following command:
 
 ```bash
 npm install oneentry
@@ -20,7 +20,7 @@ npm install oneentry
 
 # Usage
 
-To use the OneEntry Headless CMS SDK in your project, import the defineOneEntry function:
+To use the AsyncModules Headless CMS SDK in your project, import the defineOneEntry function:
 ```js
 import { defineOneEntry } from 'oneentry'
 
@@ -55,7 +55,7 @@ const api = defineOneEntry('your-url');
 
 The second parameter of the function takes a configuration object with the keys "token", "langCode" and "multipleResponse".
 Set the token key if your project secure "Security API Token"
-If your project uses user authorization, pass the user access token to the "userToken" variable to use methods that require authorization.
+If your project uses user authorization, pass the user REFRESH TOKEN to the "userToken" variable to use methods that require authorization.
 Set the "langCode" to set the default language. By specifying this parameter once, you don't have to pass the langCode to the methods ONEENTRY API. If you have not passed the default language, it will be set "en_US"
 Some methods use more than one request to the CMS so that the data you receive is complete and easy to work with. Pass the value "false" for this parameter to save traffic and decide for yourself what data you need. The default value "true"
 
@@ -76,7 +76,7 @@ You can also connect a tls certificate to protect your project. In this case, do
 ```js 
 const api = defineOneEntry('your-url', {
     token: 'my-token', 
-    userToken: 'user.token',
+    userToken: 'rerfesh.token',
     langCode:'my-langCode',
 })
 ```
@@ -773,13 +773,13 @@ example: email <br>
 const { Blocks } = defineOneEntry('your-url');
 ```
 
-### Blocks.getBlocks(langCode, offset, limit)
+### Blocks.getBlocks(type, langCode, offset, limit)
 
 ```js
-const value = await Blocks.getBlocks('en_US', 0, 30)
+const value = await Blocks.getBlocks()
 ```
 
-> This method return array of all blocks object.
+> This method return array of all blocks object. Available values of type : forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, forOrder, service
 
 Example return:
 
@@ -1882,7 +1882,7 @@ const { Orders } = defineOneEntry('your-url');
 ### Orders.getOrderByMarker(marker, langCode)
 
 ```js
-const value = await Orders.getOrderByMarker('my-order', 'en_US')
+const value = await Orders.getOrderByMarker('my-order')
 ```
 
 > This method retrieves one order storage object by marker.
@@ -1940,31 +1940,31 @@ example:  [{ "identifier": "p1" }] <br>
  const body = {
     "formIdentifier": "order_form",
     "paymentAccountIdentifier": "stripe",
-    "currency": "USD",
     "formData": [
             {
                 "marker": "name_order",
-                "value": "Alex"
+                "value": "Alex",
+                "type": "string"
             },
             {
                 "marker": "phone_order",
-                "value": "+19999999999"
+                "value": "+19999999999",
+                "type": "string"
             },
             {
                 "marker": "email_order",
-                "value": "example@oneentry.cloud"
+                "value": "example@oneentry.cloud",
+                "type": "string"
             }
     ],
     "products": [
         {
             "productId": 444,
             "quantity": 1,
-            "price": "0.1"
         },
         {
             "productId": 446,
             "quantity": 3,
-            "price": "123"
         }
     ]
 }
@@ -1977,40 +1977,28 @@ const value = await Orders.createOrder('my-order', body)
 Example return:
 ```json
 {
-  "id": 17,
+  "formIdentifier": "bars",
+  "paymentAccountIdentifier": "payment1",
   "statusIdentifier": "inprogress",
-  "formIdentifier": "order-form",
-  "paymentIdentifier": "payment-1",
   "formData": [
-    {
-      "marker": "name_1",
-      "value": "Name"
-    }
-  ],
+      {
+        "marker": "Name",
+        "value": "Name"
+      }
+    ],
   "products": [
     {
-      "id": 1,
-      "title": "Floorwood Maxima Laminate, 9811 Oak Mistral",
-      "sku": null,
-      "price": "1.00",
-      "quantity": 10,
-      "previewImage": [
-        {
-          "filename": "files/project/page/36/image/20240322_77c83b02-4c82-4bea-80eb-3763c469b00e.jpg",
-          "downloadLink": "http://my-site.com/files/project/page/36/image/20240322_77c83b02-4c82-4bea-80eb-3763c469b00e.jpg",
-          "size": 296391,
-          "previewLink": ""
-        }
-      ]
+      "productId": 1,
+      "quantity": 2
+    },
+    {
+      "productId": 2,
+      "quantity": 3
     }
   ],
-  "totalSum": "12.00",
+  "createdDate": "2024-06-04T09:57:38.328Z",
   "currency": "USD",
-  "createdDate": "2023-01-01 12:12",
-  "paymentAccountIdentifier": "payment-1",
-  "paymentAccountLocalizeInfos": {
-    "title": "Account 1"
-  }
+  "totalSum": 345
 }
 ```
 <details>
@@ -2024,7 +2012,7 @@ example: inprogress <br>
 *text identifier of the form status* <br>
 example: order-form <br>
 
-**paymentIdentifier** string <br>
+**paymentAccountIdentifier** string <br>
 *text identifier of the order payment* <br>
 example: payment-1 <br>
 
@@ -2047,17 +2035,6 @@ example: USD <br>
 *date when the order was created* <br>
 example: 2023-01-01 12:12 <br>
 
-**price** number <br>
-*price of the product per unit (at the time of ordering)* <br>
-example: 20.00 <br>
-
-**paymentAccountIdentifier** string <br>
-*textual identifier for the order payment* <br>
-example: payment-1 <br>
-
-**paymentAccountLocalizeInfos** CommonLocalizeInfos <br>
-*payment account name considering localization* <br>
-example: { "title": "Account 1" } <br>
 </details>
 
 
@@ -2067,31 +2044,31 @@ example: { "title": "Account 1" } <br>
 const body = {
     "formIdentifier": "order_form",
     "paymentAccountIdentifier": "stripe",
-    "currency": "USD",
     "formData": [
         {
             "marker": "name_order",
-            "value": "Alex"
+            "value": "Alex",
+            "type": "string"
         },
         {
             "marker": "phone_order",
-            "value": "+19999999999"
+            "value": "+19999999999",
+            "type": "string"
         },
         {
             "marker": "email_order",
-            "value": "example@oneentry.cloud"
+            "value": "example@oneentry.cloud",
+            "type": "string"
         }
     ],
     "products": [
         {
             "productId": 444,
             "quantity": 1,
-            "price": "0.1"
         },
         {
             "productId": 446,
             "quantity": 3,
-            "price": "123"
         }
     ]
 }
@@ -2104,40 +2081,28 @@ const value = await Orders.updateOrderByMarkerAndId('my-order', body)
 Example return:
 ```json
 {
-  "id": 17,
+  "formIdentifier": "bars",
+  "paymentAccountIdentifier": "payment1",
   "statusIdentifier": "inprogress",
-  "formIdentifier": "order-form",
-  "paymentIdentifier": "payment-1",
   "formData": [
-    {
-      "marker": "name_1",
-      "value": "Name"
-    }
-  ],
+      {
+        "marker": "Name",
+        "value": "Name"
+      }
+    ],
   "products": [
     {
-      "id": 1,
-      "title": "Floorwood Maxima Laminate, 9811 Oak Mistral",
-      "sku": null,
-      "price": "1.00",
-      "quantity": 10,
-      "previewImage": [
-        {
-          "filename": "files/project/page/36/image/20240322_77c83b02-4c82-4bea-80eb-3763c469b00e.jpg",
-          "downloadLink": "http://my-site.com/files/project/page/36/image/20240322_77c83b02-4c82-4bea-80eb-3763c469b00e.jpg",
-          "size": 296391,
-          "previewLink": ""
-        }
-      ]
+      "productId": 1,
+      "quantity": 2
+    },
+    {
+      "productId": 2,
+      "quantity": 3
     }
   ],
-  "totalSum": "12.00",
+  "createdDate": "2024-06-04T09:57:38.328Z",
   "currency": "USD",
-  "createdDate": "2023-01-01 12:12",
-  "paymentAccountIdentifier": "payment-1",
-  "paymentAccountLocalizeInfos": {
-    "title": "Account 1"
-  }
+  "totalSum": 345
 }
 ```
 <details>
@@ -2151,7 +2116,7 @@ example: inprogress <br>
 *text identifier of the form status* <br>
 example: order-form <br>
 
-**paymentIdentifier** string <br>
+**paymentAccountIdentifier** string <br>
 *text identifier of the order payment* <br>
 example: payment-1 <br>
 
@@ -2174,17 +2139,6 @@ example: USD <br>
 *date when the order was created* <br>
 example: 2023-01-01 12:12 <br>
 
-**price** number <br>
-*price of the product per unit (at the time of ordering)* <br>
-example: 20.00 <br>
-
-**paymentAccountIdentifier** string <br>
-*textual identifier for the order payment* <br>
-example: payment-1 <br>
-
-**paymentAccountLocalizeInfos** CommonLocalizeInfos <br>
-*payment account name considering localization* <br>
-example: { "title": "Account 1" } <br>
 </details>
 
 
@@ -2245,7 +2199,7 @@ example:  [{ "identifier": "p1" }] <br>
 </details>
 
 
-### Orders.getAllOrdersByMarker(marker, langCode)
+### Orders.getAllOrdersByMarker(marker, langCode, limit, offset)
 
 ```js
 const value = await Orders.getAllOrdersByMarker('my-order')
@@ -2254,45 +2208,48 @@ const value = await Orders.getAllOrdersByMarker('my-order')
 > This method getting all order storage object by marker. The method will add the default language to the request body. If you want to change the language, just pass it with the second argument
 
 Example return:
+
 ```json
-{
-  "id": 17,
-  "statusIdentifier": "inprogress",
-  "formIdentifier": "order-form",
-  "paymentIdentifier": "payment-1",
-  "formData": [
-    {
-      "marker": "name_1",
-      "value": "Name"
-    }
-  ],
-  "products": [
-    {
-      "id": 1,
-      "title": "Floorwood Maxima Laminate, 9811 Oak Mistral",
-      "sku": null,
-      "price": "1.00",
-      "quantity": 10,
-      "previewImage": [
-        {
-          "filename": "files/project/page/36/image/20240322_77c83b02-4c82-4bea-80eb-3763c469b00e.jpg",
-          "downloadLink": "http://my-site.com/files/project/page/36/image/20240322_77c83b02-4c82-4bea-80eb-3763c469b00e.jpg",
-          "size": 296391,
-          "previewLink": ""
-        }
-      ]
-    }
-  ],
-  "totalSum": "12.00",
-  "currency": "USD",
-  "createdDate": "2023-01-01 12:12",
-  "price": 20,
-  "paymentAccountIdentifier": "payment-1",
-  "paymentAccountLocalizeInfos": {
-    "title": "Account 1"
-  },
-  "isHistory": true
-}
+[
+  {
+    "id": 17,
+    "statusIdentifier": "inprogress",
+    "paymentIdentifier": "payment-1",
+    "formData": [
+      {
+        "marker": "name_1",
+        "value": "Name",
+        "type": "string"
+      }
+    ],
+    "products": [
+      {
+        "id": 1,
+        "title": "Floorwood Maxima Laminate, 9811 Oak Mistral",
+        "sku": null,
+        "price": "1.00",
+        "quantity": 10,
+        "previewImage": [
+          {
+            "filename": "files/project/page/36/image/20240322_77c83b02-4c82-4bea-80eb-3763c469b00e.jpg",
+            "downloadLink": "http://my-site.com/files/project/page/36/image/20240322_77c83b02-4c82-4bea-80eb-3763c469b00e.jpg",
+            "size": 296391,
+            "previewLink": ""
+          }
+        ]
+      }
+    ],
+    "totalSum": "12.00",
+    "currency": "USD",
+    "createdDate": "2023-01-01 12:12",
+    "price": 20,
+    "paymentAccountIdentifier": "payment-1",
+    "paymentAccountLocalizeInfos": {
+      "title": "Account 1"
+    },
+    "isHistory": true
+  }
+]
 ```
 <details>
 <summary>Schema</summary>
@@ -2305,9 +2262,6 @@ example: inprogress <br>
 *text identifier of the form status* <br>
 example: order-form <br>
 
-**paymentIdentifier** string <br>
-*text identifier of the order payment* <br>
-example: payment-1 <br>
 
 **formData** FormDataType <br>
 *data submitted by the form linked to the order store* <br>
@@ -3838,7 +3792,7 @@ const { Products } = defineOneEntry('your-url');
 ```
 
 >This module accepts a set of user parameters called userQuery. If the parameters are not passed to the method, the default value will be applied.
-
+>Some methods accept the body as a parameter for filtering. If you don't want to set up sorting, pass an empty array or don't pass anything.
 Parameters:
 
 ```js
@@ -3872,13 +3826,33 @@ const userQuery = {
 > 'nexs' - Does not exist
 
 
-### Products.getProducts(langCode, userQuery)
+### Products.getProducts(body, langCode, userQuery)
 
 ```js
-const value = await Products.getProducts('en_US', userQuery)
+const body = [
+    {
+        "attributeMarker": "price",
+        "conditionMarker": "mth",
+        "statusMarker": "waiting",
+        "conditionValue": 1,
+        "pageUrls": [
+            "23-laminat-floorwood-maxima"
+        ]
+    },
+    {
+        "attributeMarker": "price",
+        "conditionMarker": "lth",
+        "conditionValue": 3,
+        "pageUrls": [
+            "23-laminat-floorwood-maxima"
+        ]
+    }
+]
+
+const value = await Products.getProducts(body)
 ```
 
-> This method searches for product page objects with pagination and filtering based on the provided query parameters (userQuery). It returns a Promise that resolves to a list of products (IProduct[]).
+> This method searches for all products objects with pagination that do not have a category, based on the provided query parameters (userQuery). It returns a Promise that resolves to an array of items, where each item is a ContentIndexedProductDto object.
 
 Example return:
 
@@ -3922,18 +3896,17 @@ Example return:
     "templateIdentifier": "my-template",
     "shortDescTemplateIdentifier": "my-template-short",
     "attributeValues": {
-        "marker": {
-          "value": "",
-          "type": "string",
-          "position": 1,
-          "isProductPreview": false
+      "marker": {
+        "value": "",
+        "type": "string",
+        "position": 1,
+        "isProductPreview": false
       }
     },
     "position": 1
   }
 ]
 ```
-
 <details>
 <summary>Schema</summary>
 
@@ -3969,6 +3942,10 @@ example: my-template <br>
 *attribute set identifier* <br>
 example: 7 <br>
 
+**blocks:**	array <br>
+*product blocks* <br>
+example: ['product_block'] <br>
+
 **isSync:**	boolean <br>
 *indicator of page indexing (true or false)* <br>
 example: false <br>
@@ -4139,64 +4116,86 @@ example: my-template-short <br>
 </details>
 
 
-### Products.getProductsPageById(id, langCode, userQuery)
+### Products.getProductsByPageId(id, body, langCode, userQuery)
 
 ```js
-const value = await Products.getProductsPageById(1, 'en_US', userQuery)
+const body = [
+    {
+        "attributeMarker": "price",
+        "conditionMarker": "mth",
+        "statusMarker": "waiting",
+        "conditionValue": 1,
+        "pageUrls": [
+            "23-laminat-floorwood-maxima"
+        ]
+    },
+    {
+        "attributeMarker": "price",
+        "conditionMarker": "lth",
+        "conditionValue": 3,
+        "pageUrls": [
+            "23-laminat-floorwood-maxima"
+        ]
+    }
+]
+
+const value = await Products.getProductsByPageId(1764, body)
 ```
 
-> This method searches for all product page objects with pagination for the selected category based on the page identifier (id). It accepts an optional userQuery parameter to set query parameters for the search. The query parameters include limit, offset, statusMarker, conditionValue, conditionMarker, attributeMarker, sortOrder, and sortKey. It returns a Promise that resolves to an array of ContentIndexedProductDto objects.
+> This method searches for all products objects with pagination for the selected category, based on the provided query parameters (userQuery). It returns a Promise that resolves to an array of items, where each item is a ContentIndexedProductDto object.
 
 Example return:
 
 ```json
-{
-  "id": 1764,
-  "localizeInfos": {
-    "title": "Product"
-  },
-  "isVisible": true,
-  "statusId": 1,
-  "relatedIds": [
-    1,
-    2,
-    3
-  ],
-  "attributeSetId": 7,
-  "isSync": true,
-  "price": 0,
-  "additional": {
-    "prices": {
-      "min": 0,
-      "max": 100
-    }
-  },
-  "blocks": [
-    null
-  ],
-  "sku": "0-123",
-  "productPages": [
-    {
-      "id": 8997,
-      "pageId": 1176,
-      "productId": 8872
-    }
-  ],
-  "statusLocalizeInfos": {
-    "title": "Product"
-  },
-  "templateIdentifier": "my-template",
-  "shortDescTemplateIdentifier": "my-template-short",
-  "attributeValues": {
-    "marker": {
-      "value": "",
-      "type": "string",
-      "position": 1,
-      "isProductPreview": false
-    }
-  },
-  "position": 1
-}
+[
+  {
+    "id": 1764,
+    "localizeInfos": {
+      "title": "Product"
+    },
+    "isVisible": true,
+    "statusId": 1,
+    "relatedIds": [
+      1,
+      2,
+      3
+    ],
+    "attributeSetId": 7,
+    "isSync": true,
+    "price": 0,
+    "additional": {
+      "prices": {
+        "min": 0,
+        "max": 100
+      }
+    },
+    "blocks": [
+      null
+    ],
+    "sku": "0-123",
+    "productPages": [
+      {
+        "id": 8997,
+        "pageId": 1176,
+        "productId": 8872
+      }
+    ],
+    "statusLocalizeInfos": {
+      "title": "Product"
+    },
+    "templateIdentifier": "my-template",
+    "shortDescTemplateIdentifier": "my-template-short",
+    "attributeValues": {
+      "marker": {
+        "value": "",
+        "type": "string",
+        "position": 1,
+        "isProductPreview": false
+      }
+    },
+    "position": 1
+  }
+]
 ```
 <details>
 <summary>Schema</summary>
@@ -4271,64 +4270,119 @@ example: my-template-short <br>
 
 </details>
 
-### Products.getProductsPageByUrl(url, langCode, userQuery)
+
+### Products.getProductsPriceByPageUrl(url, userQuery)
 
 ```js
-const value = await Products.getProductsPageByUrl('cup', 'en_US', userQuery)
+const value = await Products.getProductsPriceByPageUrl('catalog')
 ```
 
-> This method searches for all product page objects with pagination for the selected category based on the page URL (url). It accepts an optional userQuery parameter to set query parameters for the search. The query parameters include limit, offset, statusMarker, conditionValue, conditionMarker, attributeMarker, sortOrder, and sortKey. It returns a Promise that resolves to an array of ContentIndexedProductDto objects.
+> This method searches for information about products and prices for the selected category, based on the provided query parameters (userQuery). It returns a Promise that resolves to an array of items, where each item is a ContentIndexedProductDto object.
 
 Example return:
 
 ```json
-{
-  "id": 1764,
-  "localizeInfos": {
-    "title": "Product"
-  },
-  "isVisible": true,
-  "statusId": 1,
-  "relatedIds": [
-    1,
-    2,
-    3
-  ],
-  "attributeSetId": 7,
-  "isSync": true,
-  "price": 0,
-  "additional": {
-    "prices": {
-      "min": 0,
-      "max": 100
+[
+  {
+    "id": 1764,
+    "price": 0
+  }
+]
+```
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764 <br>
+
+**price:**	number <br>
+*price value of the product page taken from the index* <br>
+example: 0 <br>
+
+</details>
+
+
+### Products.getProductsByPageUrl(url, body, langCode, userQuery)
+
+```js
+const body = [
+    {
+        "attributeMarker": "price",
+        "conditionMarker": "mth",
+        "statusMarker": "waiting",
+        "conditionValue": 1,
+        "pageUrls": [
+            "23-laminat-floorwood-maxima"
+        ]
+    },
+    {
+        "attributeMarker": "price",
+        "conditionMarker": "lth",
+        "conditionValue": 3,
+        "pageUrls": [
+            "23-laminat-floorwood-maxima"
+        ]
     }
-  },
-  "blocks": [
-    null
-  ],
-  "sku": "0-123",
-  "productPages": [
-    {
-      "id": 8997,
-      "pageId": 1176,
-      "productId": 8872
-    }
-  ],
-  "statusLocalizeInfos": {
-    "title": "Product"
-  },
-  "templateIdentifier": "my-template",
-  "shortDescTemplateIdentifier": "my-template-short",
-  "attributeValues": {
-    "marker": {
-      "value": "",
-      "type": "string",
-      "position": 1,
-      "isProductPreview": false
-    }
-  },
-  "position": 1
-}
+]
+
+const value = await Products.getProductsByPageUrl('catalog', body)
+```
+
+> This method searches for all products objects with pagination for the selected category, based on the provided query parameters (userQuery). It returns a Promise that resolves to an array of items, where each item is a ContentIndexedProductDto object.
+
+Example return:
+
+```json
+[
+  {
+    "id": 1764,
+    "localizeInfos": {
+      "title": "Product"
+    },
+    "isVisible": true,
+    "statusId": 1,
+    "relatedIds": [
+      1,
+      2,
+      3
+    ],
+    "attributeSetId": 7,
+    "isSync": true,
+    "price": 0,
+    "additional": {
+      "prices": {
+        "min": 0,
+        "max": 100
+      }
+    },
+    "blocks": [
+      null
+    ],
+    "sku": "0-123",
+    "productPages": [
+      {
+        "id": 8997,
+        "pageId": 1176,
+        "productId": 8872
+      }
+    ],
+    "statusLocalizeInfos": {
+      "title": "Product"
+    },
+    "templateIdentifier": "my-template",
+    "shortDescTemplateIdentifier": "my-template-short",
+    "attributeValues": {
+      "marker": {
+        "value": "",
+        "type": "string",
+        "position": 1,
+        "isProductPreview": false
+      }
+    },
+    "position": 1
+  }
+]
 ```
 <details>
 <summary>Schema</summary>
@@ -4345,7 +4399,6 @@ example: OrderedMap { "prices": OrderedMap { "min": 0, "max": 100 } } <br>
 *json description of the item status object, taking into account the language* <br>
 example: {  "title": "Product" <br>
 
-
 **localizeInfos:**	Record<string, any> <br>
 *json description of the main page data object taking into account the language "en_US" (for example)* <br>
 example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } } <br>
@@ -4404,6 +4457,7 @@ example: my-template-short <br>
 
 </details>
 
+
 ### Products.getRelatedProductsById(id, langCode, userQuery)
 
 ```js
@@ -4669,162 +4723,123 @@ example: my-template-short <br>
 </details>
 
 
-### Products.filterProduct(data, langCode, userQuery)
+### Products.getProductBlockById(id)
 
 ```js
-  const data = {
-        attributeMarker: "price",
-        conditionMarker: "lth",
-        conditionValue: "200",
-    }
-
-const value = await Products.filterProduct(data, 'en_US', userQuery)
+const value = await Products.getProductBlockById(1764)
 ```
 
-Example body:
+> This method Getting a product block object by product id.
 
-```js
+Example return:
+
+```json
 [
   {
-    "attributeMarker": "price",
-    "conditionMarker": "mth",
-    "conditionValue": 1,
-    "pageId": 0
-  },
-  {
-    "attributeMarker": "price",
-    "conditionMarker": "lth",
-    "conditionValue": 3,
-    "pageId": 0
+    "id": 4,
+    "localizeInfos": {
+      "title": "Name"
+    },
+    "version": 0,
+    "position": 3,
+    "identifier": "product",
+    "type": "forProductBlock",
+    "templateIdentifier": null,
+    "isVisible": true,
+    "attributeValues": {
+      "attr": {
+        "type": "string",
+        "value": "",
+        "position": 0,
+        "isProductPreview": false
+      }
+    },
+    "countElementsPerRow": 3,
+    "products": [
+      {
+        "id": 446,
+        "localizeInfos": {
+          "title": "new product 3"
+        },
+        "relatedIds": [1, 2],
+        "statusId": null,
+        "attributeSetId": 11,
+        "position": 3,
+        "templateIdentifier": null,
+        "shortDescTemplateIdentifier": null,
+        "price": 543,
+        "sku": "ggg",
+        "isSync": true,
+        "attributeValues": {
+          "sku": {
+            "type": "string",
+            "value": "ggg",
+            "position": 0,
+            "isProductPreview": false
+          },
+          "images": {
+            "type": "groupOfImages",
+            "value": {},
+            "position": 3,
+            "isProductPreview": false
+          }
+        },
+        "isVisible": true
+      }
+    ]
   }
 ]
 ```
 
-> This method filters product page objects with pagination and multiple filtering based on the provided data request body. The data parameter should be an array of {attributeMarker:string,conditionMarker:string,conditionValue:number,pageId:number}.
-
-Example return:
-
-```json
-{
-  "id": 1764,
-  "localizeInfos": {
-    "title": "Product"
-  },
-  "isVisible": true,
-  "statusId": 1,
-  "relatedIds": [
-    1,
-    2,
-    3
-  ],
-  "attributeSetId": 7,
-  "isSync": true,
-  "price": 0,
-  "additional": {
-    "prices": {
-      "min": 0,
-      "max": 100
-    }
-  },
-  "blocks": [
-    null
-  ],
-  "sku": "0-123",
-  "productPages": [
-    {
-      "id": 8997,
-      "pageId": 1176,
-      "productId": 8872
-    }
-  ],
-  "statusLocalizeInfos": {
-    "title": "Product"
-  },
-  "templateIdentifier": "my-template",
-  "shortDescTemplateIdentifier": "my-template-short",
-  "attributeValues": {
-    "marker": {
-      "value": "",
-      "type": "string",
-      "position": 1,
-      "isProductPreview": false
-    }
-  },
-  "position": 1
-}
-```
 <details>
 <summary>Schema</summary>
 
 **id:**	number <br>
-*object identifier* <br>
+*object identifier*
 example: 1764 <br>
 
-**additional:**	Record<string, any> <br>
-*additional value from the index* <br>
-example: OrderedMap { "prices": OrderedMap { "min": 0, "max": 100 } } <br>
+**attributeSetId:** number <br>
+*identifier for the used attribute set* <br>
+example: 7 <br>
 
-**statusLocalizeInfos:**	CommonLocalizeInfos <br>
-*json description of the item status object, taking into account the language* <br>
-example: {  "title": "Product" <br>
+**localizeInfos:**	CommonLocalizeInfos <br>
+*block name with localization* <br>
+example: OrderedMap { "en_US": OrderedMap { "title": "My block" } } <br>
 
-**localizeInfos:**	Record<string, any> <br>
-*json description of the main page data object taking into account the language "en_US" (for example)* <br>
-example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } } <br>
+**customSettings:**	BlockCustomSettings <br>
+*custom settings for different block types* <br>
+example: OrderedMap { "sliderDelay": 0, "sliderDelayType": "", "productQuantity": 4, "productSortType": "By_ID", "productSortOrder": "Descending", "productCountElementsPerRow": 10, "similarProductRules": List [ OrderedMap { "property": "Descending", "includes": "", "keywords": "", "strict": "" } ] } <br>
 
-**isVisible:**	boolean <br>
-*Page visibility flag* <br>
-example: true <br>
+**version:** number <br>
+*object version number* <br>
+example: 10 <br>
 
-**position:**	number <br>
+**identifier:**	string <br>
+*textual identifier for the field record* <br>
+example: catalog <br>
+default: marker <br>
+
+**position:** number <br>
 *position number (for sorting)* <br>
 example: 192 <br>
 
-**templateIdentifier:**	string <br>
-*custom identifier of the associated template* <br>
-example: my-template <br>
-
-**attributeSetId:**	number <br>
-*attribute set identifier* <br>
-example: 7 <br>
-
-**blocks:**	array <br>
-*product blocks* <br>
-example: ['product_block'] <br>
-
-**isSync:**	boolean <br>
-*indicator of page indexing (true or false)* <br>
-example: false <br>
-
 **attributeValues:**	Record<string, string> <br>
-*Array of attribute values from the index (presented as a pair of custom attribute identifier: attribute value)* <br>
+*array of attribute values from the index (presented as a pair of custom attribute identifier: attribute value)* <br>
 example: OrderedMap { "en_US": OrderedMap { "marker": OrderedMap { "value": "", "type": "string" } } } <br>
 
-**statusId:** number <br>
-*status identifiers of the product page (can be null)* <br>
-example: 1 <br>
-
-**sku:** string <br>
-*product SKU value taken from the index* <br>
-example: 1 <br>
-
-**relatedIds:** array <br>
-*identifiers of related product pages* <br>
-example: List [ 1, 2, 3 ] <br>
+**type:** string <br>
+*block type* <br>
+example: forNewsPage <br>
 
-**price:**	number <br>
-*price value of the product page taken from the index* <br>
-example: 0 <br>
+**templateIdentifier:**	string <br>
+*template marker used by the block (can be null)* <br>
+Enum:
+[ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ] <br>
+example: null <br>
 
-**templateIdentifier**	string <br>
-*custom identifier of the associated template* <br>
-example: my-template <br>
+</details>
 
-**shortDescTemplateIdentifier**	string <br>
-*custom identifier of the associated template for short description* <br>
-example: my-template-short <br>
 
-</details>
 
 ### Products.searchProduct(name, langCode)