oneentry 1.0.65 → 1.0.67

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'
 
@@ -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:
 
@@ -1535,7 +1535,7 @@ Example with a simple type attribute "radioButton" or "list"
       "title": "red",
       "value": "1",
       "extended": {
-        "value": "красный",
+        "value": "red",
         "type": "string"
       }
     }
@@ -3872,13 +3872,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 +3942,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 +3988,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 +4162,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 +4316,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
-    }
-  },
-  "blocks": [
-    null
-  ],
-  "sku": "0-123",
-  "productPages": [
+[
+  {
+    "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 = [
     {
-      "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
+        "attributeMarker": "price",
+        "conditionMarker": "mth",
+        "statusMarker": "waiting",
+        "conditionValue": 1,
+        "pageUrls": [
+            "23-laminat-floorwood-maxima"
+        ]
+    },
+    {
+        "attributeMarker": "price",
+        "conditionMarker": "lth",
+        "conditionValue": 3,
+        "pageUrls": [
+            "23-laminat-floorwood-maxima"
+        ]
     }
-  },
-  "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 +4445,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 +4503,7 @@ example: my-template-short <br>
 
 </details>
 
+
 ### Products.getRelatedProductsById(id, langCode, userQuery)
 
 ```js
@@ -4669,162 +4769,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)