oneentry 1.0.46 → 1.0.48

package/README.md

@@ -0,0 +1,3643 @@
+# OneEntry SDK
+
+OneEntry Headless CMS SDK is an SDK that provides an easy way to interact with the OneEntry 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.
+
+## 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).
+
+# Installation
+
+To install the OneEntry Headless CMS SDK in your project, run the following command:
+
+```
+npm install oneentry
+```
+
+# Usage
+
+To use the OneEntry Headless CMS SDK in your project, import the defineOneEntry function:
+```js
+import { defineOneEntry } from 'oneentry'
+
+const {
+        Admins,
+        AttributesSets,
+        Blocks,
+        Forms,
+        FormData,
+        FileUploading,
+        GeneralTypes,
+        Locales,
+        Markers,
+        Menus,
+        Pages,
+        Products,
+        ProductstatusesSpec,
+        System,
+        Templates,
+        TemplatePreviews
+} = defineOneEntry('your-url')
+```
+
+Or
+
+```js
+const api = defineOneEntry('your-url')
+```
+
+The second parameter of the function takes a configuration object with the keys "token" and "langCode".
+Set the token key if your project secure "Security API Token"
+
+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"
+
+>If you chose token protection to ensure connection security, just pass your token to the function as an optional parameter.
+
+You can get a token as follows
+1) Log in to your personal account
+2) Go to the "Projects" tab and select a project
+3) Go to the "Access" tab
+4) Set the switch to "Security API Token"
+5) Log in to the project, go to the settings section and open the token tab
+6) Get and copy the token of your project
+
+Also, you can connect a tls certificate to secure your project. In this case, do not transfer the "token" at all.
+[Learn more about security](https://oneentry.ru/instructions.html#START)
+
+
+```js
+const api = defineOneEntry('your-url', {token: 'my-token', langCode:'my-langCode'})
+```
+Now you can use the following links to jump to specific entries:
+- [Admins](#admins)
+- [AttributesSets](#attributessets)
+- [Blocks](#blocks)
+- [Forms](#forms)
+- [FormData](#formdata)
+- [FileUploading](#fileuploading)
+- [GeneralTypes](#generaltypes)
+- [Locales](#locales)
+- [Markers](#markers)
+- [Menus](#menus)
+- [Pages](#pages)
+- [Products](#products)
+- [ProductstatusesSpec](#productstatuses)
+- [System](#system)
+- [Templates](#templates)
+- [TemplatePreviews](#templatepreviews)
+
+
+## <h2 id="admins"> Admins </h2>
+
+
+```js
+const { Admins } = defineOneEntry('your-url')
+```
+
+### Admins.getAdminsInfo(langCode, offset, limit)
+
+
+```js
+const value = await Admins.getAdminsInfo('en_US', 0, 30)
+```
+
+
+> This method retrieves all user objects of type admin from the API. It returns a Promise that resolves to an array of AdminEntity objects.
+
+
+Example return:
+
+```json
+[
+  {
+    "id": 1764,
+    "identifier": "admin1",
+    "attributeSetId": 7,
+    "isSync": false,
+    "attributeValues": {
+      "marker": {
+        "value": "",
+        "type": "string"
+      }
+    },
+    "position": 192
+  }
+]
+```
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier*
+example: 1764 <br>
+
+**identifier:**	string <br>
+*textual identifier for the record field* <br>
+example: admin1 <br>
+default: admin1 <br>
+
+**attributeSetId:**	number <br>
+*Attribute set identifier* <br>
+example: 7
+
+**isSync**	boolean <br>
+*Page indexing flag (true or false)* <br>
+example: false
+
+**attributeValues:** Record<string, string> <br>
+*Array of attribute values from the index (presented as a pair of user attribute identifier: attribute value)* <br>
+example: OrderedMap { "en_US": OrderedMap { "marker": OrderedMap { "value": "", "type": "string" } } } <br>
+
+**position:** number <br>
+*Position number (for sorting)* <br>
+example: 192
+
+</details>
+
+---
+
+
+
+## <h2 id="attributessets"> AttributesSets </h2>
+
+```js
+const { AttributesSets } = defineOneEntry('your-url');
+```
+
+### AttributesSets.getAttributesByMarker(marker, langCode)
+
+```js
+const value = await AttributesSets.getAttributesByMarker('my-marker', 'en_US')
+```
+
+> This method return all attributes with data from the attribute sets.
+
+
+Example return:
+
+
+```json
+[
+  {
+    "type": "list",
+    "marker": "list1",
+    "position": 192,
+    "validators": {
+      "requiredValidator": {
+        "strict": true
+      },
+      "defaultValueValidator": {
+        "fieldDefaultValue": 11
+      }
+    },
+    "localizeInfos": {
+      "title": "My attribute"
+    },
+    "listTitles": [
+      {
+        "title": "red",
+        "value": 1,
+        "position": 1,
+        "extendedValue": null,
+        "extendedValueType": null
+      },
+      {
+        "title": "yellow",
+        "value": 2,
+        "position": 2,
+        "extendedValue": null,
+        "extendedValueType": null
+      }
+    ]
+  }
+]
+```
+
+<details>
+<summary>Schema</summary>
+
+**type:** string <br>
+*attribute type* <br>
+example: list <br>
+
+**marker:**	string <br>
+*textual identifier of the attribute (marker)* <br>
+Enum:
+[ string, text, textWithHeader, integer, real, float, dateTime, date, time, file, image, groupOfImages, radioButton, list, button ]
+example: list1
+
+**position:** number <br>
+*position number for sorting* <br>
+example: 192 <br>
+
+**validators:**	Record<string, any> <br>
+*set of validators for validation* <br>
+example: OrderedMap { "requiredValidator": OrderedMap { "strict": true }, "defaultValueValidator": OrderedMap { "fieldDefaultValue": 11 } }
+
+**localizeInfos:**	Record<string, any> <br>
+*localization data for the set (name)* <br>
+example: OrderedMap { "title": "My attribute" } <br>
+
+**listTitles**	Record<string, any> <br>
+*array of values (with extended data) for list and radioButton attributes* <br>
+example: List [ OrderedMap { "title": "red", "value": 1, "position": 1, "extendedValue": null, "extendedValueType": null }, OrderedMap { "title": "yellow", "value": 2, "position": 2, "extendedValue": null, "extendedValueType": null } ]
+
+</details>
+
+
+### AttributesSets.getSingleAttributeByMarkerSet(attributeMarker, setMarker, langCode)
+
+```js
+const value = await AttributesSets.getSingleAttributeByMarkerSet('list1', 'list1', 'en_US')
+```
+
+> This method return a single attribute with data from the attribute sets.
+
+
+Example return:
+
+```json
+{
+  "type": "list",
+  "marker": "list1",
+  "position": 192,
+  "validators": {
+    "requiredValidator": {
+      "strict": true
+    },
+    "defaultValueValidator": {
+      "fieldDefaultValue": 11
+    }
+  },
+  "localizeInfos": {
+    "title": "My attribute"
+  },
+  "listTitles": [
+    {
+      "title": "red",
+      "value": 1,
+      "position": 1,
+      "extendedValue": null,
+      "extendedValueType": null
+    },
+    {
+      "title": "yellow",
+      "value": 2,
+      "position": 2,
+      "extendedValue": null,
+      "extendedValueType": null
+    }
+  ]
+}
+```
+<details>
+<summary>Schema</summary>
+
+**type:** string <br>
+*attribute type* <br>
+example: list <br>
+
+**marker:**	string <br>
+*textual identifier of the attribute (marker)* <br>
+Enum:
+[ string, text, textWithHeader, integer, real, float, dateTime, date, time, file, image, groupOfImages, radioButton, list, button ]
+example: list1
+
+**position:** number <br>
+*position number for sorting* <br>
+example: 192 <br>
+
+**validators:**	Record<string, any> <br>
+*set of validators for validation* <br>
+example: OrderedMap { "requiredValidator": OrderedMap { "strict": true }, "defaultValueValidator": OrderedMap { "fieldDefaultValue": 11 } }
+
+**localizeInfos:**	Record<string, any> <br>
+*localization data for the set (name)* <br>
+example: OrderedMap { "title": "My attribute" } <br>
+
+**listTitles**	Record<string, any> <br>
+*array of values (with extended data) for list and radioButton attributes* <br>
+example: List [ OrderedMap { "title": "red", "value": 1, "position": 1, "extendedValue": null, "extendedValueType": null }, OrderedMap { "title": "yellow", "value": 2, "position": 2, "extendedValue": null, "extendedValueType": null } ]
+
+</details>
+
+---
+
+
+## <h2 id="blocks"> Blocks </h2>
+
+```js
+const { Blocks } = defineOneEntry('your-url');
+```
+
+### Blocks.getBlockByMarker(marker, langCode)
+
+```js
+const value = await Blocks.getBlockByMarker('my-marker', 'en_US')
+```
+
+> This method return one blocks object by marker.
+
+Example return:
+
+```json
+{
+  "id": 1764,
+  "attributeSetId": 7,
+  "localizeInfos": {
+    "title": "My block"
+  },
+  "customSettings": {
+    "sliderDelay": 0,
+    "sliderDelayType": "",
+    "productQuantity": 4,
+    "productSortType": "By_ID",
+    "productSortOrder": "Descending",
+    "productCountElementsPerRow": 10,
+    "similarProductRules": [
+      {
+        "property": "Descending",
+        "includes": "",
+        "keywords": "",
+        "strict": ""
+      }
+    ]
+  },
+  "version": 10,
+  "identifier": "catalog",
+  "position": 192,
+  "attributeValues": {
+    "marker": {
+      "value": "",
+      "type": "string"
+    }
+  },
+  "type": "forNewsPage",
+  "templateIdentifier": null
+}
+```
+
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier*
+example: 1764 <br>
+
+**attributeSetId:** number <br>
+*identifier for the used attribute set* <br>
+example: 7
+
+**localizeInfos:**	CommonLocalizeInfos <br>
+*block name with localization* <br>
+example: OrderedMap { "en_US": OrderedMap { "title": "My block" } }
+
+**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": "" } ] }
+
+**version:** number <br>
+*object version number* <br>
+example: 10
+
+**identifier:**	string <br>
+*textual identifier for the field record* <br>
+example: catalog <br>
+default: marker
+
+**position:** number <br>
+*position number (for sorting)* <br>
+example: 192
+
+**attributeValues:**	Record<string, string> <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" } } }
+
+**type:** string <br>
+*block type* <br>
+example: forNewsPage
+
+**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 ]
+example: null
+
+</details>
+---
+
+
+
+## <h2 id="fileuploading"> FileUploading </h2>
+
+const { FileUploading } = defineOneEntry('your-url');
+
+### FileUploading.upload(data, fileQuery)
+
+```js
+const query = {
+        type:"page",
+        entity:"editor",
+        id:3787,
+        width:0,
+        height:0,
+        compress:true,
+    }
+
+const value = await FileUploading.upload(data, query)
+```
+
+> This method uploads a file to a cloud file storage. Pass to the date the value obtained from input type "file".
+> Data is file object (or array), learn more - [File Object](https://developer.mozilla.org/en-US/docs/Web/API/File)
+
+Example return:
+
+```json
+[
+  {
+    "filename": "string",
+    "downloadLink": "string",
+    "size": 0
+  }
+]
+```
+
+<details>
+<summary>Schema</summary>
+
+**filename:** string <br>
+*filename with relative path*
+
+**downloadLink:** string <br>
+*link for downloading the file*
+
+**size** number <br>
+*size of the file in bytes*
+
+</details>
+
+### FileUploading.delete(filename, fileQuery)
+
+```js
+const query = {
+        type:"page",
+        entity:"editor",
+        id:3787
+    }
+
+
+const value = await FileUploading.delete("file.png", query)
+```
+
+> This void method delete a file from the cloud file storage. 
+
+### FileUploading.getFile(id, type, entity, filename)
+
+```js
+const value = await FileUploading.getFile(123, 'page', 'editor', 'file.png')
+```
+
+> This method return file object by parameters.
+
+Example return:
+
+```json
+{
+  "file": "string"
+}
+```
+
+---
+
+
+
+## <h2 id="forms"> Forms </h2>
+
+
+const { Forms } = defineOneEntry('your-url');
+
+### Forms.getAllForms(langCode, offset, limit)
+
+```js
+const value = await Forms.getAllForms('en_US', 0, 30)
+```
+
+> This method retrieves all form objects from the API. It returns a Promise that resolves to an array of FormEntity objects.
+
+Example return:
+
+```json
+[
+  {
+    "id": 1764,
+    "attributeSetId": 0,
+    "processingType": "email",
+    "localizeInfos": {
+      "title": "My Form",
+      "titleForSite": "",
+      "successMessage": "",
+      "unsuccessMessage": "",
+      "urlAddress": "",
+      "database": "0",
+      "script": "0"
+    },
+    "processingData": "Unknown Type: ProcessingData",
+    "version": 10,
+    "identifier": "catalog",
+    "position": 192,
+    "attributes": [
+      {
+        "type": "list",
+        "marker": "l1",
+        "position": 2,
+        "listTitles": [
+          {
+            "title": "red",
+            "value": 1,
+            "position": 1,
+            "extendedValue": null,
+            "extendedValueType": null
+          },
+          {
+            "title": "yellow",
+            "value": 2,
+            "position": 2,
+            "extendedValue": null,
+            "extendedValueType": null
+          }
+        ],
+        "validators": {},
+        "localizeInfos": {
+          "title": "l1"
+        }
+      }
+    ]
+  }
+]
+```
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764
+
+**attributeSetId:**	number <br>
+*identifier of the attribute set used* <br>
+
+**processingType:**	string <br>
+*form processing type* <br>
+example: email
+
+**localizeInfos:**	FormLocalizeInfos <br>
+*form name with localization* <br>
+Enum:
+[ db, email, script ]
+example: OrderedMap { "en_US": OrderedMap { "title": "My Form", "titleForSite": "", "successMessage": "", "unsuccessMessage": "", "urlAddress": "", "database": "0", "script": "0" } }
+
+**processingData:**	ProcessingData <br>
+*form data*
+
+**version:** number <br>
+*object version number* <br>
+example: 10
+
+**identifier:**	string <br>
+*textual identifier for the record field* <br>
+example: catalog
+default: marker
+
+**position:** number <br>
+*position number (for sorting)* <br>
+example: 192
+
+**attributes:**	 <br>
+*array of attribute values from the used attribute set for displaying the form (taking into account the specified language)* <br>
+example: List [ OrderedMap { "type": "list", "marker": "l1", "position": 2, "listTitles": List [ OrderedMap { "title": "red", "value": 1, "position": 1, "extendedValue": null, "extendedValueType": null }, OrderedMap { "title": "yellow", "value": 2, "position": 2, "extendedValue": null, "extendedValueType": null } ], "validators": OrderedMap {}, "localizeInfos": OrderedMap { "title": "l1" } } ]
+
+</details>
+
+
+### Forms.getFormByMarker(marker, langCode)
+
+```js
+const value = await Forms.getFormByMarker('My form', 'en_US')
+```
+
+> This method retrieves a single form object based on its textual identifier (marker) from the API. It returns a Promise that resolves to a FormEntity object.
+
+Example return:
+
+```json
+{
+  "id": 1764,
+  "attributeSetId": 0,
+  "processingType": "email",
+  "localizeInfos": {
+    "title": "My Form",
+    "titleForSite": "",
+    "successMessage": "",
+    "unsuccessMessage": "",
+    "urlAddress": "",
+    "database": "0",
+    "script": "0"
+  },
+  "processingData": "Unknown Type: ProcessingData",
+  "version": 10,
+  "identifier": "catalog",
+  "position": 192,
+  "attributes": [
+    {
+      "type": "list",
+      "marker": "l1",
+      "position": 2,
+      "listTitles": [
+        {
+          "title": "red",
+          "value": 1,
+          "position": 1,
+          "extendedValue": null,
+          "extendedValueType": null
+        },
+        {
+          "title": "yellow",
+          "value": 2,
+          "position": 2,
+          "extendedValue": null,
+          "extendedValueType": null
+        }
+      ],
+      "validators": {},
+      "localizeInfos": {
+        "title": "l1"
+      }
+    }
+  ]
+}
+```
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764
+
+**attributeSetId:**	number <br>
+*identifier of the attribute set used* <br>
+
+**processingType:**	string <br>
+*form processing type* <br>
+example: email
+
+**localizeInfos:**	FormLocalizeInfos <br>
+*form name with localization* <br>
+Enum:
+[ db, email, script ]
+example: OrderedMap { "en_US": OrderedMap { "title": "My Form", "titleForSite": "", "successMessage": "", "unsuccessMessage": "", "urlAddress": "", "database": "0", "script": "0" } }
+
+**processingData:**	ProcessingData <br>
+*form data*
+
+**version:** number <br>
+*object version number* <br>
+example: 10
+
+**identifier:**	string <br>
+*textual identifier for the record field* <br>
+example: catalog
+default: marker
+
+**position:** number <br>
+*position number (for sorting)* <br>
+example: 192
+
+**attributes:**	 <br>
+*array of attribute values from the used attribute set for displaying the form (taking into account the specified language)* <br>
+example: List [ OrderedMap { "type": "list", "marker": "l1", "position": 2, "listTitles": List [ OrderedMap { "title": "red", "value": 1, "position": 1, "extendedValue": null, "extendedValueType": null }, OrderedMap { "title": "yellow", "value": 2, "position": 2, "extendedValue": null, "extendedValueType": null } ], "validators": OrderedMap {}, "localizeInfos": OrderedMap { "title": "l1" } } ]
+
+</details>
+
+---
+
+
+## <h2 id="formdata"> FormData </h2>
+
+const { FormData } = defineOneEntry('your-url');
+
+### FormData.postFormsData(data)
+
+```js
+const value = await FormData.postFormsData(data)
+```
+
+> This method retrieves all form data objects from the API. It returns a Promise that resolves to an array of objects of type CreateFormDataDto.
+
+Example return:
+
+```json
+{
+  "id": 1764,
+  "formIdentifier": "my-form",
+  "time": "2023-02-12 10:56",
+  "formData": {
+    "marker": "name_1",
+    "value": "Name"
+  }
+}
+```
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764
+
+**formIdentifier:**	string <br>
+*Text identifier of the form object (marker)* <br>
+example: my-form
+
+**time:** Date <br>
+*Date and time of form modification* <br>
+example: 2023-02-12 10:56
+
+**formData:** FormDataLangType <br>
+*Data submitted by the form* <br>
+example: OrderedMap { "en_US": List [ OrderedMap { "marker": "naimenovanie_1", "value": "Name" } ] }
+
+</details>
+
+### FormData.getFormsData(langCode, offset, limit)
+
+```js
+const value = await FormData.getFormsData('en_US', 0, 30)
+```
+
+> This method creates form data objects by sending a request to the API. It accepts an array of objects of type IFormsPost as the request body to provide the necessary form data. It returns a Promise that resolves to the created CreateFormDataDto objects.
+
+Example return:
+
+```json
+{
+  "id": 1764,
+  "formIdentifier": "my-form",
+  "time": "2023-02-12 10:56",
+  "formData": {
+    "marker": "name_1",
+    "value": "Name"
+  },
+  "attributeSetIdentifier": "test-form"
+}
+```
+
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764
+
+**formIdentifier:**	string <br>
+*Text identifier of the form object (marker)* <br>
+example: my-form
+
+**time:** Date <br>
+*Date and time of form modification* <br>
+example: 2023-02-12 10:56
+
+**formData:** FormDataLangType <br>
+*Data submitted by the form* <br>
+example: OrderedMap { "en_US": List [ OrderedMap { "marker": "naimenovanie_1", "value": "Name" } ] }
+
+**attributeSetIdentifier:**	string
+*text identifier (marker) of the used attribute set*
+example: test-form
+
+</details>
+
+
+### FormData.getFormsDataByMarker(marker, langCode, offset, limit)
+
+```js
+const value = await FormData.getFormsDataByMarker('my-marker', 'en_US', 0, 30)
+```
+
+> This method retrieves a specific form data object by its marker from the API. It accepts a marker parameter as the marker of the form data. It returns a Promise that resolves to an array of objects of type FormDataEntity.
+
+Example return:
+
+```json
+{
+  "id": 1764,
+  "formIdentifier": "my-form",
+  "time": "2023-02-12 10:56",
+  "formData": {
+     "marker": "name_1",
+     "value": "Name"
+  },
+  "attributeSetIdentifier": "test-form"
+}
+```
+
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764
+
+**formIdentifier:**	string <br>
+*Text identifier of the form object (marker)* <br>
+example: my-form
+
+**time:** Date <br>
+*Date and time of form modification* <br>
+example: 2023-02-12 10:56
+
+**formData:** FormDataLangType <br>
+*Data submitted by the form* <br>
+example: OrderedMap { "en_US": List [ OrderedMap { "marker": "naimenovanie_1", "value": "Name" } ] }
+
+**attributeSetIdentifier:**	string
+*text identifier (marker) of the used attribute set*
+example: test-form
+
+</details>
+
+---
+
+
+## <h2 id="generaltypes"> GeneralTypes </h2>
+
+const { GeneralTypes } = defineOneEntry('your-url');
+
+### GeneralTypes.getAllTypes()
+
+```js
+const value = await GeneralTypes.getAllTypes()
+```
+
+> This method retrieves all objects of type GeneralTypeEntity from the API. It returns a Promise that resolves to an array of GeneralTypeEntity objects.
+
+Example return:
+
+```json
+[
+  {
+    "id": 1,
+    "type": "forNewsPage"
+  }
+]
+```
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764
+
+**type:** string <br>
+*type value* <br>
+example: forNewsPage <br>
+Enum:
+[ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ]
+
+</details>
+---
+
+
+## <h2 id="locales"> Locales </h2>
+
+```js
+const { Locales } = defineOneEntry('your-url')
+```
+
+### Locales.getLocales()
+
+```js
+const value = await Locales.getLocales()
+```
+
+> This method retrieves all active language localization objects from the API. It returns a Promise that resolves to an array of LocaleEntity objects.
+
+Example return:
+
+```json
+[
+    {
+      "id": 1764,
+      "shortCode": "en",
+      "code": "en_US",
+      "name": "Bengali",
+      "nativeName": "বাংলা",
+      "isActive": false,
+      "image": "🇦🇨",
+      "position": 1
+    }
+]
+```
+
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764
+
+**shortCode:**	string <br>
+*language code (short)* <br>
+example: en
+
+**code:**	string <br>
+*language code with country code* <br>
+example: en_US
+
+**name** string <br>
+*Language name (in English)* <br>
+example: Bengali
+
+**nativeName**	string <br>
+*Language name (in native language)* <br>
+example: বাংলা
+
+**isActive:**	boolean  <br>
+*Flag of usage* <br>
+example: false
+
+**image:**	string
+*Graphic image of the language (under development)*
+example: 🇦🇨
+
+**position:**	{
+description:position number
+}
+</details>
+---
+
+
+
+## <h2 id="markers"> Markers </h2>
+
+
+```js
+const { Markers } = defineOneEntry('your-url')
+```
+
+### Markers.getMarkers(offset, limit)
+
+```js
+const value = await Markers.getMarkers(0, 30)
+```
+
+>This method return an array of all objects MarkerEntity. 
+
+Example return:
+
+```json
+[
+  {
+    "id": 17,
+    "updatedDate": "2023-12-18T08:53:37.422Z",
+    "version": 10,
+    "identifier": "catalog",
+    "name": "string",
+    "marker": "string",
+    "localizeInfos": {
+      "title": "My marker"
+    }
+  }
+]
+```
+
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764
+
+**updatedDate:**	string($date-time) <br>
+*object modification date* <br>
+
+**version:** number <br>
+*version number of the object change* <br>
+example: 10
+
+**identifier?:**	string <br>
+*textual identifier for a record field* <br>
+example: catalog
+
+**name?:**	string <br>
+*name*
+
+**marker?:** string <br>
+*textual identifier*
+
+**localizeInfos:**	CommonLocalizeInfos <br>
+*localized marker name* <br>
+example: OrderedMap { "en_US": OrderedMap { "title": "My marker" } }
+</details>
+
+
+### Markers.getMarkerById(id)
+
+```js
+const value = await Markers.getMarkerById(1)
+```
+
+>This method return one object of MarkerEntity by id.
+
+Example return:
+
+```json
+{
+  "id": 17,
+  "updatedDate": "2023-12-18T08:55:22.581Z",
+  "version": 10,
+  "identifier": "catalog",
+  "name": "string",
+  "marker": "string",
+  "localizeInfos": {
+    "title": "My marker"
+  }
+}
+```
+
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764
+
+**updatedDate:**	string($date-time) <br>
+*object modification date* <br>
+
+**version:** number <br>
+*version number of the object change* <br>
+example: 10
+
+**identifier?:**	string <br>
+*textual identifier for a record field* <br>
+example: catalog
+
+**name?:**	string <br>
+*name*
+
+**marker?:** string <br>
+*textual identifier*
+
+**localizeInfos:**	CommonLocalizeInfos <br>
+*localized marker name* <br>
+example: OrderedMap { "en_US": OrderedMap { "title": "My marker" } }
+</details>
+
+### Markers.getMarkerByMarker(marker)
+
+```js
+const value = await Markers.getMarkerByMarker('my-marker')
+```
+
+>This method return one object of MarkerEntity by marker.
+
+Example return:
+
+```json
+{
+  "id": 17,
+  "updatedDate": "2023-12-18T08:59:42.006Z",
+  "version": 10,
+  "identifier": "catalog",
+  "name": "string",
+  "marker": "string",
+  "localizeInfos": {
+    "title": "My marker"
+  }
+}
+```
+
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764
+
+**updatedDate:**	string($date-time) <br>
+*object modification date* <br>
+
+**version:** number <br>
+*version number of the object change* <br>
+example: 10
+
+**identifier?:**	string <br>
+*textual identifier for a record field* <br>
+example: catalog
+
+**name?:**	string <br>
+*name*
+
+**marker?:** string <br>
+*textual identifier*
+
+**localizeInfos:**	CommonLocalizeInfos <br>
+*localized marker name* <br>
+example: OrderedMap { "en_US": OrderedMap { "title": "My marker" } }
+</details>
+
+---
+
+## <h2 id="menus"> Menus </h2>
+
+
+```js
+const { Menus } = defineOneEntry('your-url')
+```
+
+### Menus.getMenusByMarker(marker)
+
+```js
+const value = await Menus.getMenusByMarker('my-marker')
+```
+
+> This method retrieves a single menu object based on its marker (marker) from the API. It returns a Promise that resolves to a single menu object as a ContentMenuDto object with included pages.
+
+Example return:
+
+```json
+{
+  "id": 1764,
+  "identifier": "catalog",
+  "localizeInfos": {
+    "title": "Main Menu"
+  },
+  "pages": [
+    {
+      "id": 11,
+      "pageUrl": "122",
+      "localizeInfos": {
+        "en_US": {
+          "title": "12",
+          "content": "",
+          "menuTitle": "12"
+        }
+      },
+      "position": 0,
+      "parentId": null
+    }
+  ]
+}
+```
+
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764
+
+**identifier:**	string <br>
+*textual identifier for a record field* <br>
+example: catalog
+
+**localizeInfos**	Record<string, any> <br>
+*json object description of the menu item with the language "en_US" (for example)* <br>
+example: OrderedMap { "en_US": OrderedMap { "title": "Main Menu" } }
+
+**pages:**
+*data of the pages included in the menu*
+example: List [ OrderedMap { "id": 11, "pageUrl": "122", "localizeInfos": OrderedMap { "en_US": OrderedMap { "title": "12", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "12" } }, "position": 0, "parentId": null } ]
+</details>
+
+---
+
+## <h2 id="pages"> Pages </h2>
+
+```js
+const { Pages } = defineOneEntry('your-url')
+```
+
+### Pages.getRootPages(langCode)
+
+```js
+const value = await Pages.getRootPages('en_US')
+```
+
+> This method retrieves all top-level page objects from the API. It returns a Promise that resolves to an array of ContentIndexedPageDto objects or an empty array [] if there is no data. Get required language parameter.
+
+Example return:
+
+```json
+[
+  {
+      "id": 1764,
+      "parentId": null,
+      "config": {
+        "rowsPerPage": 1,
+        "productsPerRow": 1
+      },
+      "pageUrl": "string",
+      "depth": 3,
+      "localizeInfos": {
+        "title": "Catalog",
+        "content": "Content for catalog",
+        "menuTitle": "Catalog"
+      },
+      "isVisible": true,
+      "products": 0,
+      "attributeSetId": 7,
+      "isSync": false,
+      "templateIdentifier": "my-template",
+      "attributeValues": {
+        "marker": {
+          "value": "",
+          "type": "string"
+        }
+      },
+      "position": 192,
+      "type": "forNewsPage",
+      "childrenCount": 0
+  }
+]
+```
+
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764
+
+**parentId** number <br>
+*parent page identifier, if null, it is a top-level page* <br>
+example: null
+
+**config**	Record<string, number> <br>
+*output settings for catalog pages* <br>
+example: OrderedMap { "rowsPerPage": 1, "productsPerRow": 1 }
+
+**pageUrl**	string <br>
+*unique page URL*
+
+**depth** number <br>
+*page nesting depth relative to parentId* <br>
+example: 3
+
+**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" } }
+
+**isVisible:**	boolean <br>
+*Page visibility flag* <br>
+example: true
+
+**products** number <br>
+*Number of products linked to the page* <br>
+example: 0
+
+**attributeSetId:**	number <br>
+*attribute set identifier* <br>
+example: 7
+
+**forms**	 <br>
+*Array of FormEntity object identifier values linked to the page (optional)*
+
+
+**blocks**	 <br>
+*Array of BlockEntity object identifier values linked to the page (optional)*
+
+
+**isSync:**	boolean <br>
+*indicator of page indexing (true or false)* <br>
+example: false
+
+**templateIdentifier:**	string <br>
+*Custom identifier of the linked template* <br>
+example: my-template
+
+**attributeValues:**	Record<string, string> <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" } } }
+
+**position:**	number <br>
+*position number for sorting (optional)* <br>
+example: 192
+
+**type:**	string <br>
+*Page type* <br>
+example: forNewsPage
+Enum:
+[ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ]
+
+
+**childrenCount:**	number <br>
+*number of nested pages* <br>
+example: 0
+
+</details>
+
+### Pages.getCatalogPages(langCode, limit, offset)
+
+```js
+const value = await Pages.getCatalogPages('en_US', 0, 30)
+```
+
+> This method retrieves all page objects with product information as an array from the API. It accepts two optional parameters limit and offset for pagination and language code parameter. It returns a Promise that resolves to an array of ContentIndexedPageDto objects or an empty array [] if there is no data.
+
+Example return:
+
+```json
+[
+  {
+      "id": 1764,
+      "parentId": null,
+      "config": {
+        "rowsPerPage": 1,
+        "productsPerRow": 1
+      },
+      "pageUrl": "string",
+      "depth": 3,
+      "localizeInfos": {
+        "title": "Catalog",
+        "content": "Content for catalog",
+        "menuTitle": "Catalog"
+      },
+      "isVisible": true,
+      "products": 0,
+      "attributeSetId": 7,
+      "isSync": false,
+      "templateIdentifier": "my-template",
+      "attributeValues": {
+        "marker": {
+          "value": "",
+          "type": "string"
+        }
+      },
+      "position": 192,
+      "type": "forNewsPage",
+      "childrenCount": 0
+  }
+]
+```
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764
+
+**parentId** number <br>
+*parent page identifier, if null, it is a top-level page* <br>
+example: null
+
+**config**	Record<string, number> <br>
+*output settings for catalog pages* <br>
+example: OrderedMap { "rowsPerPage": 1, "productsPerRow": 1 }
+
+**pageUrl**	string <br>
+*unique page URL*
+
+**depth** number <br>
+*page nesting depth relative to parentId* <br>
+example: 3
+
+**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" } }
+
+**isVisible:**	boolean <br>
+*Page visibility flag* <br>
+example: true
+
+**products** number <br>
+*Number of products linked to the page* <br>
+example: 0
+
+**attributeSetId:**	number <br>
+*attribute set identifier* <br>
+example: 7
+
+**forms**	 <br>
+*Array of FormEntity object identifier values linked to the page (optional)*
+
+
+**blocks**	 <br>
+*Array of BlockEntity object identifier values linked to the page (optional)*
+
+
+**isSync:**	boolean <br>
+*indicator of page indexing (true or false)* <br>
+example: false
+
+**templateIdentifier:**	string <br>
+*Custom identifier of the linked template* <br>
+example: my-template
+
+**attributeValues:**	Record<string, string> <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" } } }
+
+**position:**	number <br>
+*position number for sorting (optional)* <br>
+example: 192
+
+**type:**	string <br>
+*Page type* <br>
+example: forNewsPage
+Enum:
+[ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ]
+
+
+**childrenCount:**	number <br>
+*number of nested pages* <br>
+example: 0
+
+</details>
+
+### Pages.getPages(langCode)
+
+```js
+const value = await Pages.getPages('en_US')
+```
+
+> This method retrieves all created pages as an array from the API. It returns a Promise that resolves to an array of ContentIndexedPageDto objects or an empty array [] if there is no data. Get required language parameter.
+
+Example return:
+
+```json
+[
+  {
+      "id": 1764,
+      "parentId": null,
+      "config": {
+        "rowsPerPage": 1,
+        "productsPerRow": 1
+      },
+      "pageUrl": "string",
+      "depth": 3,
+      "localizeInfos": {
+        "title": "Catalog",
+        "content": "Content for catalog",
+        "menuTitle": "Catalog"
+      },
+      "isVisible": true,
+      "products": 0,
+      "attributeSetId": 7,
+      "isSync": false,
+      "templateIdentifier": "my-template",
+      "attributeValues": {
+        "marker": {
+          "value": "",
+          "type": "string"
+        }
+      },
+      "position": 192,
+      "type": "forNewsPage",
+      "childrenCount": 0
+  }
+]
+```
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764
+
+**parentId** number <br>
+*parent page identifier, if null, it is a top-level page* <br>
+example: null
+
+**config**	Record<string, number> <br>
+*output settings for catalog pages* <br>
+example: OrderedMap { "rowsPerPage": 1, "productsPerRow": 1 }
+
+**pageUrl**	string <br>
+*unique page URL*
+
+**depth** number <br>
+*page nesting depth relative to parentId* <br>
+example: 3
+
+**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" } }
+
+**isVisible:**	boolean <br>
+*Page visibility flag* <br>
+example: true
+
+**products** number <br>
+*Number of products linked to the page* <br>
+example: 0
+
+**attributeSetId:**	number <br>
+*attribute set identifier* <br>
+example: 7
+
+**forms**	 <br>
+*Array of FormEntity object identifier values linked to the page (optional)*
+
+
+**blocks**	 <br>
+*Array of BlockEntity object identifier values linked to the page (optional)*
+
+
+**isSync:**	boolean <br>
+*indicator of page indexing (true or false)* <br>
+example: false
+
+**templateIdentifier:**	string <br>
+*Custom identifier of the linked template* <br>
+example: my-template
+
+**attributeValues:**	Record<string, string> <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" } } }
+
+**position:**	number <br>
+*position number for sorting (optional)* <br>
+example: 192
+
+**type:**	string <br>
+*Page type* <br>
+example: forNewsPage
+Enum:
+[ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ]
+
+
+**childrenCount:**	number <br>
+*number of nested pages* <br>
+example: 0
+
+</details>
+
+### Pages.getPageById(id, langCode)
+
+```js
+const value = await Pages.getPageById(1, 'en_US')
+```
+
+> This method retrieves a single page object based on its identifier (id) from the API. It returns a Promise that resolves to the page object, with the specific DTO depending on the type of page being returned. Get required language parameter.
+
+Example return:
+
+```json
+{
+  "id": 1764,
+  "parentId": null,
+  "pageUrl": "string",
+  "depth": 3,
+  "localizeInfos": {
+    "title": "Catalog",
+    "content": "Content for catalog",
+    "menuTitle": "Catalog"
+  },
+  "isVisible": true,
+  "position": 192,
+  "type": "forNewsPage",
+  "templateIdentifier": "my-template",
+  "attributeSetId": 7,
+  "attributeValues": {
+    "marker": "description",
+    "type": "string",
+    "value": ""
+  },
+  "isSync": false,
+  "products": 0
+}
+```
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764
+
+**parentId** number <br>
+*parent page identifier, if null, it is a top-level page* <br>
+example: null
+
+**pageUrl**	string <br>
+*unique page URL*
+
+**depth** number <br>
+*page nesting depth relative to parentId* <br>
+example: 3
+
+**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" } }
+
+**isVisible:**	boolean <br>
+*Page visibility flag* <br>
+example: true
+
+**position:**	number <br>
+*position number (for sorting)* <br>
+example: 192
+
+**type**	string <br>
+*page type:* <br>
+example: forNewsPage <br>
+Enum:
+[ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ]
+
+
+**templateIdentifier:**	string <br>
+*custom identifier of the associated template* <br>
+example: my-template
+
+**attributeSetId:**	number <br>
+*attribute set identifier* <br>
+example: 7
+
+**forms**	 <br>
+*Array of FormEntity object identifier values linked to the page (optional)*
+
+
+**blocks**	 <br>
+*Array of BlockEntity object identifier values linked to the page (optional)*
+
+
+**isSync:**	boolean <br>
+*indicator of page indexing (true or false)* <br>
+example: false
+
+**products** number <br>
+*number of products associated with the page* <br>
+example: 0
+
+</details>
+
+### Pages.getPageByUrl(url, langCode)
+
+```js
+const value = await Pages.getPageByUrl('shop', 'en_US')
+```
+
+> This method retrieves a single page object based on its URL (url) from the API. It returns a Promise that resolves to the page object, with the specific DTO depending on the type of page being returned. Get required language parameter.
+
+Example return:
+
+```json
+{
+  "id": 1764,
+  "parentId": null,
+  "pageUrl": "string",
+  "depth": 3,
+  "localizeInfos": {
+    "title": "Catalog",
+    "content": "Content for catalog",
+    "menuTitle": "Catalog"
+  },
+  "isVisible": true,
+  "position": 192,
+  "type": "forNewsPage",
+  "templateIdentifier": "my-template",
+  "attributeSetId": 7,
+  "attributeValues": {
+    "marker": "description",
+    "type": "string",
+    "value": ""
+  },
+  "isSync": false,
+  "products": 0
+}
+```
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764
+
+**parentId** number <br>
+*parent page identifier, if null, it is a top-level page* <br>
+example: null
+
+**pageUrl**	string <br>
+*unique page URL*
+
+**depth** number <br>
+*page nesting depth relative to parentId* <br>
+example: 3
+
+**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" } }
+
+**isVisible:**	boolean <br>
+*Page visibility flag* <br>
+example: true
+
+**position:**	number <br>
+*position number (for sorting)* <br>
+example: 192
+
+**type**	string <br>
+*page type:* <br>
+example: forNewsPage <br>
+Enum:
+[ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ]
+
+
+**templateIdentifier:**	string <br>
+*custom identifier of the associated template* <br>
+example: my-template
+
+**attributeSetId:**	number <br>
+*attribute set identifier* <br>
+example: 7
+
+**forms**	 <br>
+*Array of FormEntity object identifier values linked to the page (optional)*
+
+
+**blocks**	 <br>
+*Array of BlockEntity object identifier values linked to the page (optional)*
+
+
+**isSync:**	boolean <br>
+*indicator of page indexing (true or false)* <br>
+example: false
+
+**products** number <br>
+*number of products associated with the page* <br>
+example: 0
+
+</details>
+
+
+### Pages.getChildPagesByParentUrl(url, langCode)
+
+```js
+const value = await Pages.getChildPagesByParentUrl('shop', 'en_US')
+```
+
+> Getting child pages with information about products in the form of an array. Returns all created pages as an array of AdminIndexedPageDto objects or an empty array [] (if there is no data) for the selected parent.
+
+Example return:
+
+```json
+[
+  {
+    "id": 1764,
+    "parentId": null,
+    "config": {
+      "rowsPerPage": 1,
+      "productsPerRow": 1
+    },
+    "pageUrl": "string",
+    "depth": 3,
+    "localizeInfos": {
+      "title": "Catalog",
+      "plainContent": "Content for catalog",
+      "htmlContent": "<b>Content for catalog</b>",
+      "menuTitle": "Catalog"
+    },
+    "isVisible": true,
+    "products": 0,
+    "attributeSetId": 7,
+    "forms": [
+      null
+    ],
+    "blocks": [
+      null
+    ],
+    "isSync": false,
+    "templateIdentifier": "my-template",
+    "attributeValues": {
+      "marker": {
+        "value": "",
+        "type": "string"
+      }
+    },
+    "position": 192,
+    "type": "forNewsPage",
+    "childrenCount": 0
+  }
+]
+```
+
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764
+
+**parentId** number <br>
+*parent page identifier, if null, it is a top-level page* <br>
+example: null
+
+**config**	Record<string, number> <br>
+*output settings for catalog pages* <br>
+example: OrderedMap { "rowsPerPage": 1, "productsPerRow": 1 }
+
+**pageUrl**	string <br>
+*unique page URL*
+
+**depth** number <br>
+*page nesting depth relative to parentId* <br>
+example: 3
+
+**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" } }
+
+**isVisible:**	boolean <br>
+*Page visibility flag* <br>
+example: true
+
+**products** number <br>
+*Number of products linked to the page* <br>
+example: 0
+
+**attributeSetId:**	number <br>
+*attribute set identifier* <br>
+example: 7
+
+**forms**	 <br>
+*Array of FormEntity object identifier values linked to the page (optional)*
+
+
+**blocks**	 <br>
+*Array of BlockEntity object identifier values linked to the page (optional)*
+
+
+**isSync:**	boolean <br>
+*indicator of page indexing (true or false)* <br>
+example: false
+
+**templateIdentifier:**	string <br>
+*Custom identifier of the linked template* <br>
+example: my-template
+
+**attributeValues:**	Record<string, string> <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" } } }
+
+**position:**	number <br>
+*position number for sorting (optional)* <br>
+example: 192
+
+**type:**	string <br>
+*Page type* <br>
+example: forNewsPage
+Enum:
+[ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ]
+
+
+**childrenCount:**	number <br>
+*number of nested pages* <br>
+example: 0
+
+</details>
+
+
+### Pages.getBlocksByPageUrl(url, langCode)
+
+```js
+const value = await Pages.getFormsByPageUrl('shop', 'en_US')
+```
+
+> Get PositionBlock objects for a related form by url. Returns an array of PositionBlock objects.
+
+Example return:
+
+```json
+[
+  {
+    "id": 1764,
+    "version": 10,
+    "identifier": "catalog",
+    "attributeSetId": 0,
+    "localizeInfos": {
+      "title": "My block"
+    },
+    "customSettings": {
+      "sliderDelay": 0,
+      "sliderDelayType": "",
+      "productQuantity": 4,
+      "productSortType": "By_ID",
+      "productSortOrder": "Descending",
+      "productCountElementsPerRow": 10,
+      "similarProductRules": [
+        {
+          "property": "Descending",
+          "includes": "",
+          "keywords": "",
+          "strict": ""
+        }
+      ]
+    },
+    "position": 0,
+    "isSync": false,
+    "attributeValues": {
+      "marker": {
+        "value": "",
+        "type": "string"
+      }
+    },
+    "type": "forNewsPage",
+    "templateIdentifier": null
+  }
+]
+```
+
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764
+
+**version**	number <br>
+*object version number* <br>
+example: 10
+
+**identifier:**	string <br>
+*text identifier for the record field* <br>
+example: catalog
+
+**attributeSetId:**	number <br>
+*attribute set identifier* <br>
+example: 7
+
+**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" } }
+
+**customSettings:**	BlockCustomSettings <br>
+*custom settings for different types of blocks* <br>
+example: OrderedMap { "sliderDelay": 0, "sliderDelayType": "", "productQuantity": 4, "productSortType": "By_ID", "productSortOrder": "Descending", "productCountElementsPerRow": 10, "similarProductRules": List [ OrderedMap { "property": "Descending", "includes": "", "keywords": "", "strict": "" } ] }
+
+**isSync:**	boolean <br>
+*indicator of page indexing (true or false)* <br>
+example: false
+
+**attributeValues:**	Record<string, string> <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" } } }
+
+**position:**	number <br>
+*position number for sorting (optional)* <br>
+example: 192
+
+**type:**	string <br>
+*Page type* <br>
+example: forNewsPage
+Enum:
+[ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ]
+
+**templateIdentifier:**	string <br>
+*marker of the template used by the block (can be null)* <br>
+example: null
+
+</details>
+
+
+### Pages.getFormsByPageUrl(url, langCode)
+
+```js
+const value = await Pages.getFormsByPageUrl('shop', 'en_US')
+```
+
+> Get PositionForm objects for a related form by url. Returns an array of PositionForm objects.
+
+Example return:
+
+```json
+[
+  {
+    "id": 1764,
+    "version": 10,
+    "identifier": "catalog",
+    "attributeSetId": 0,
+    "processingType": "email",
+    "localizeInfos": {
+      "title": "My form",
+      "titleForSite": "",
+      "successMessage": "",
+      "unsuccessMessage": "",
+      "urlAddress": "",
+      "database": "0",
+      "script": "0"
+    },
+    "processingData": {},
+    "position": 0,
+    "attributes": [
+      {
+        "type": "list",
+        "marker": "l1",
+        "position": 2,
+        "listTitles": [
+          {
+            "title": "red",
+            "value": 1,
+            "position": 1,
+            "extendedValue": null,
+            "extendedValueType": null
+          },
+          {
+            "title": "yellow",
+            "value": 2,
+            "position": 2,
+            "extendedValue": null,
+            "extendedValueType": null
+          }
+        ],
+        "validators": {},
+        "localizeInfos": {
+          "title": "l1"
+        }
+      }
+    ]
+  }
+]
+```
+
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764
+
+**version**	number <br>
+*object version number* <br>
+example: 10
+
+**identifier:**	string <br>
+*text identifier for the record field* <br>
+example: catalog
+
+**attributeSetId:**	number <br>
+*attribute set identifier* <br>
+example: 7
+
+**processingType:**	string <br>
+*form processing type* <br>
+example: email
+Enum:
+[ db, email, script ]
+
+**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" } }
+
+**processingData:**	 <br>
+*form data*
+
+
+**attributes:**	Record<string, string> <br>
+*array of attribute values from the used attribute set for displaying the form (taking into account the specified language)* <br>
+example: List [ OrderedMap { "type": "list", "marker": "l1", "position": 2, "listTitles": List [ OrderedMap { "title": "red", "value": 1, "position": 1, "extendedValue": null, "extendedValueType": null }, OrderedMap { "title": "yellow", "value": 2, "position": 2, "extendedValue": null, "extendedValueType": null } ], "validators": OrderedMap {}, "localizeInfos": OrderedMap { "title": "l1" } } ]
+
+**position:**	number <br>
+*position number for sorting (optional)* <br>
+example: 192
+
+</details>
+
+### Pages.getConfigPageByUrl(url)
+
+```js
+const value = await Pages.getConfigPageByUrl('shop')
+```
+
+> This method retrieves the settings for a specific page based on its URL (url). It returns a Promise that resolves to a ConfigPageDto object with page display settings.
+
+Example return:
+
+```json
+{
+  "rowsPerPage": 10,
+  "productsPerRow": 10
+}
+```
+<details>
+<summary>Schema</summary>
+
+**rowsPerPage:** number
+*Number of rows per page*
+example: 10
+
+**productsPerRow** number
+*Number of products per row*
+example: 10
+
+</details>
+
+
+### Pages.searchPage(name, langCode)
+
+```js
+const value = await Pages.searchPage('cup', 'en_US')
+```
+
+> This method performs a quick search for page objects based on a text query (name). It returns a Promise that resolves to a ContentIndexedPageDto objects or an empty array []. Get required language parameter.
+
+Example return:
+
+```json
+[
+  {
+      "id": 1764,
+      "parentId": null,
+      "pageUrl": "string",
+      "depth": 3,
+      "localizeInfos": {
+        "title": "Catalog",
+        "content": "Content for catalog",
+        "menuTitle": "Catalog"
+      },
+      "isVisible": true,
+      "position": 192,
+      "type": "forNewsPage",
+      "templateIdentifier": "my-template",
+      "attributeSetId": 7,
+      "attributeValues": {
+        "marker": "description",
+        "type": "string",
+        "value": ""
+      },
+      "isSync": false,
+      "products": 0
+    }
+]
+```
+
+---
+
+
+## <h2 id="products"> Products </h2>
+
+
+```js
+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.
+
+Parameters:
+
+```js
+const userQuery = {
+    offset: 0,
+    limit: 30,
+    statusMarker: null,
+    conditionValue: null,
+    conditionMarker: null,
+    attributeMarker: null,
+    sortOrder: 'DESC',
+    sortKey: 'id'
+}
+```
+
+"conditionMarker" by which values are filtered (not set by default), possible values:
+> 'in' - Contains,
+>
+> 'nin' - Does not contain,
+>
+> 'eq' - Equal,
+>
+> 'neq' - Not equal,
+>
+> 'mth' - Greater than,
+>
+> 'lth' - Less than,
+>
+> 'exs' - Exists,
+>
+> 'nexs' - Does not exist
+
+
+### Products.getProducts(langCode, userQuery)
+
+```js
+const value = await Products.getProducts('en_US', userQuery)
+```
+
+> 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[]).
+
+Example return:
+
+```json
+[
+    {
+      "id": 1764,
+      "localizeInfos": {
+        "title": "Product"
+      },
+      "isVisible": true,
+      "statusId": 1,
+      "relatedIds": [
+        1,
+        2,
+        3
+      ],
+      "attributeSetId": 7,
+      "isSync": true,
+      "price": 0,
+      "templateIdentifier": "my-template",
+      "shortDescTemplateIdentifier": "my-template-short",
+      "attributeValues": {
+        "marker": {
+          "value": "",
+          "type": "string"
+        }
+      },
+      "position": 1
+    }
+]
+```
+
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764
+
+**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" } }
+
+**isVisible:**	boolean <br>
+*Page visibility flag* <br>
+example: true
+
+**position:**	number <br>
+*position number (for sorting)* <br>
+example: 192
+
+**templateIdentifier:**	string <br>
+*custom identifier of the associated template* <br>
+example: my-template
+
+**attributeSetId:**	number <br>
+*attribute set identifier* <br>
+example: 7
+
+**isSync:**	boolean <br>
+*indicator of page indexing (true or false)* <br>
+example: false
+
+**attributeValues:**	Record<string, string> <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" } } }
+
+**statusId:** number <br>
+*status identifiers of the product page (can be null)* <br>
+example: 1
+
+**relatedIds:** array <br>
+*identifiers of related product pages* <br>
+example: List [ 1, 2, 3 ]
+
+**price:**	number <br>
+*price value of the product page taken from the index* <br>
+example: 0
+
+**templateIdentifier**	string
+*custom identifier of the associated template*
+example: my-template
+
+**shortDescTemplateIdentifier**	string <br>
+*custom identifier of the associated template for short description* <br>
+example: my-template-short
+
+</details>
+
+
+### Products.getProductsEmptyPage(langCode, userQuery)
+
+```js
+const value = await Products.getProductsEmptyPage('en_US', userQuery)
+```
+
+> This method searches for product page 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:
+
+```json
+[
+    {
+      "id": 1764,
+      "localizeInfos": {
+        "title": "Product"
+      },
+      "isVisible": true,
+      "statusId": 1,
+      "relatedIds": [
+        1,
+        2,
+        3
+      ],
+      "attributeSetId": 7,
+      "isSync": true,
+      "price": 0,
+      "templateIdentifier": "my-template",
+      "shortDescTemplateIdentifier": "my-template-short",
+      "attributeValues": {
+        "marker": {
+          "value": "",
+          "type": "string"
+        }
+      },
+      "position": 1
+    }
+]
+```
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764
+
+**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" } }
+
+**isVisible:**	boolean <br>
+*Page visibility flag* <br>
+example: true
+
+**position:**	number <br>
+*position number (for sorting)* <br>
+example: 192
+
+**templateIdentifier:**	string <br>
+*custom identifier of the associated template* <br>
+example: my-template
+
+**attributeSetId:**	number <br>
+*attribute set identifier* <br>
+example: 7
+
+**isSync:**	boolean <br>
+*indicator of page indexing (true or false)* <br>
+example: false
+
+**attributeValues:**	Record<string, string> <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" } } }
+
+**statusId:** number <br>
+*status identifiers of the product page (can be null)* <br>
+example: 1
+
+**relatedIds:** array <br>
+*identifiers of related product pages* <br>
+example: List [ 1, 2, 3 ]
+
+**price:**	number <br>
+*price value of the product page taken from the index* <br>
+example: 0
+
+**templateIdentifier**	string
+*custom identifier of the associated template*
+example: my-template
+
+**shortDescTemplateIdentifier**	string <br>
+*custom identifier of the associated template for short description* <br>
+example: my-template-short
+
+</details>
+
+
+### Products.getProductsPageById(id, langCode, userQuery)
+
+```js
+const value = await Products.getProductsPageById(1, 'en_US', userQuery)
+```
+
+> 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.
+
+Example return:
+
+```json
+{
+  "id": 1764,
+  "localizeInfos": {
+    "title": "Product"
+  },
+  "isVisible": true,
+  "statusId": 1,
+  "relatedIds": [
+    1,
+    2,
+    3
+  ],
+  "productPages": [
+    {
+      "id": 8997,
+      "pageId": 1176,
+      "productId": 8872
+    }
+  ],
+  "attributeSetId": 7,
+  "version": 10,
+  "isSync": 0,
+  "price": 0,
+  "templateIdentifier": "my-template",
+  "shortDescTemplateIdentifier": "my-template-short",
+  "attributeValues": {
+    "marker": {
+      "value": "",
+      "type": "string"
+    }
+  },
+  "position": 1
+}
+```
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764
+
+**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" } }
+
+**isVisible:**	boolean <br>
+*Page visibility flag* <br>
+example: true
+
+**position:**	number <br>
+*position number (for sorting)* <br>
+example: 192
+
+**templateIdentifier:**	string <br>
+*custom identifier of the associated template* <br>
+example: my-template
+
+**attributeSetId:**	number <br>
+*attribute set identifier* <br>
+example: 7
+
+**isSync:**	boolean <br>
+*indicator of page indexing (true or false)* <br>
+example: false
+
+**attributeValues:**	Record<string, string> <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" } } }
+
+**statusId:** number <br>
+*status identifiers of the product page (can be null)* <br>
+example: 1
+
+**relatedIds:** array <br>
+*identifiers of related product pages* <br>
+example: List [ 1, 2, 3 ]
+
+**price:**	number <br>
+*price value of the product page taken from the index* <br>
+example: 0
+
+**templateIdentifier**	string
+*custom identifier of the associated template*
+example: my-template
+
+**shortDescTemplateIdentifier**	string <br>
+*custom identifier of the associated template for short description* <br>
+example: my-template-short
+
+</details>
+
+### Products.getProductsPageByUrl(url, langCode, userQuery)
+
+```js
+const value = await Products.getProductsPageByUrl('cup', 'en_US', userQuery)
+```
+
+> 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.
+
+Example return:
+
+```json
+{
+  "id": 1764,
+  "localizeInfos": {
+    "title": "Product"
+  },
+  "isVisible": true,
+  "statusId": 1,
+  "relatedIds": [
+    1,
+    2,
+    3
+  ],
+  "productPages": [
+    {
+      "id": 8997,
+      "pageId": 1176,
+      "productId": 8872
+    }
+  ],
+  "attributeSetId": 7,
+  "version": 10,
+  "isSync": 0,
+  "price": 0,
+  "templateIdentifier": "my-template",
+  "shortDescTemplateIdentifier": "my-template-short",
+  "attributeValues": {
+    "marker": {
+      "value": "",
+      "type": "string"
+    }
+  },
+  "position": 1
+}
+```
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764
+
+**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" } }
+
+**isVisible:**	boolean <br>
+*Page visibility flag* <br>
+example: true
+
+**position:**	number <br>
+*position number (for sorting)* <br>
+example: 192
+
+**templateIdentifier:**	string <br>
+*custom identifier of the associated template* <br>
+example: my-template
+
+**attributeSetId:**	number <br>
+*attribute set identifier* <br>
+example: 7
+
+**isSync:**	boolean <br>
+*indicator of page indexing (true or false)* <br>
+example: false
+
+**attributeValues:**	Record<string, string> <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" } } }
+
+**statusId:** number <br>
+*status identifiers of the product page (can be null)* <br>
+example: 1
+
+**relatedIds:** array <br>
+*identifiers of related product pages* <br>
+example: List [ 1, 2, 3 ]
+
+**price:**	number <br>
+*price value of the product page taken from the index* <br>
+example: 0
+
+**templateIdentifier**	string
+*custom identifier of the associated template*
+example: my-template
+
+**shortDescTemplateIdentifier**	string <br>
+*custom identifier of the associated template for short description* <br>
+example: my-template-short
+
+</details>
+
+### Products.getRelatedProductsById(id, langCode, userQuery)
+
+```js
+const value = await Products.getRelatedProductsById(1, 'en_US', {limit:20, offset:1})
+```
+
+> This method retrieves all related product page objects for a specific product based on its identifier (id) from the API. It accepts an optional userQuery parameter for additional query parameters such as limit, offset, sortOrder, and sortKey. It returns a Promise that resolves to an array of ContentIndexedProductDto objects.
+
+Example return:
+
+```json
+{
+  "id": 1764,
+  "localizeInfos": {
+    "title": "Product"
+  },
+  "isVisible": true,
+  "statusId": 1,
+  "relatedIds": [
+    1,
+    2,
+    3
+  ],
+  "attributeSetId": 7,
+  "isSync": true,
+  "price": 0,
+  "templateIdentifier": "my-template",
+  "shortDescTemplateIdentifier": "my-template-short",
+  "attributeValues": {
+    "marker": {
+      "value": "",
+      "type": "string"
+    }
+  },
+  "position": 1
+}
+```
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764
+
+**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" } }
+
+**isVisible:**	boolean <br>
+*Page visibility flag* <br>
+example: true
+
+**position:**	number <br>
+*position number (for sorting)* <br>
+example: 192
+
+**templateIdentifier:**	string <br>
+*custom identifier of the associated template* <br>
+example: my-template
+
+**attributeSetId:**	number <br>
+*attribute set identifier* <br>
+example: 7
+
+**isSync:**	boolean <br>
+*indicator of page indexing (true or false)* <br>
+example: false
+
+**attributeValues:**	Record<string, string> <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" } } }
+
+**statusId:** number <br>
+*status identifiers of the product page (can be null)* <br>
+example: 1
+
+**relatedIds:** array <br>
+*identifiers of related product pages* <br>
+example: List [ 1, 2, 3 ]
+
+**price:**	number <br>
+*price value of the product page taken from the index* <br>
+example: 0
+
+**templateIdentifier**	string
+*custom identifier of the associated template*
+example: my-template
+
+**shortDescTemplateIdentifier**	string <br>
+*custom identifier of the associated template for short description* <br>
+example: my-template-short
+
+</details>
+
+### Products.getProductById(id, langCode)
+
+```js
+const value = await Products.getProductById(1, 'en_US')
+```
+
+> This method retrieves a single product object based on its identifier (id) from the API. It returns a Promise that resolves to a ContentIndexedProductDto object for the product.
+
+Example return:
+
+```json
+{
+  "id": 1764,
+  "localizeInfos": {
+    "title": "Product"
+  },
+  "isVisible": true,
+  "statusId": 1,
+  "relatedIds": [
+    1,
+    2,
+    3
+  ],
+  "attributeSetId": 7,
+  "isSync": true,
+  "price": 0,
+  "templateIdentifier": "my-template",
+  "shortDescTemplateIdentifier": "my-template-short",
+  "attributeValues": {
+    "marker": {
+      "value": "",
+      "type": "string"
+    }
+  },
+  "position": 1
+}
+```
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764
+
+**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" } }
+
+**isVisible:**	boolean <br>
+*Page visibility flag* <br>
+example: true
+
+**position:**	number <br>
+*position number (for sorting)* <br>
+example: 192
+
+**templateIdentifier:**	string <br>
+*custom identifier of the associated template* <br>
+example: my-template
+
+**attributeSetId:**	number <br>
+*attribute set identifier* <br>
+example: 7
+
+**isSync:**	boolean <br>
+*indicator of page indexing (true or false)* <br>
+example: false
+
+**attributeValues:**	Record<string, string> <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" } } }
+
+**statusId:** number <br>
+*status identifiers of the product page (can be null)* <br>
+example: 1
+
+**relatedIds:** array <br>
+*identifiers of related product pages* <br>
+example: List [ 1, 2, 3 ]
+
+**price:**	number <br>
+*price value of the product page taken from the index* <br>
+example: 0
+
+**templateIdentifier**	string
+*custom identifier of the associated template*
+example: my-template
+
+**shortDescTemplateIdentifier**	string <br>
+*custom identifier of the associated template for short description* <br>
+example: my-template-short
+
+</details>
+
+
+### Products.filterProduct(data, langCode, userQuery)
+
+```js
+  const data = {
+        attributeMarker: "price",
+        conditionMarker: "lth",
+        conditionValue: "200",
+    }
+
+const value = await Products.filterProduct(data, 'en_US', userQuery)
+```
+
+Example body:
+
+```js
+[
+  {
+    "attributeMarker": "price",
+    "conditionMarker": "mth",
+    "conditionValue": 1,
+    "pageId": 0
+  },
+  {
+    "attributeMarker": "price",
+    "conditionMarker": "lth",
+    "conditionValue": 3,
+    "pageId": 0
+  }
+]
+```
+
+> 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
+  ],
+  "productPages": [
+    {
+      "id": 8997,
+      "pageId": 1176,
+      "productId": 8872
+    }
+  ],
+  "attributeSetId": 7,
+  "version": 10,
+  "isSync": 0,
+  "price": 0,
+  "templateIdentifier": "my-template",
+  "shortDescTemplateIdentifier": "my-template-short",
+  "attributeValues": {
+    "marker": {
+      "value": "",
+      "type": "string"
+    }
+  },
+  "position": 1
+}
+```
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764
+
+**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" } }
+
+**isVisible:**	boolean <br>
+*Page visibility flag* <br>
+example: true
+
+**position:**	number <br>
+*position number (for sorting)* <br>
+example: 192
+
+**templateIdentifier:**	string <br>
+*custom identifier of the associated template* <br>
+example: my-template
+
+**attributeSetId:**	number <br>
+*attribute set identifier* <br>
+example: 7
+
+**isSync:**	boolean <br>
+*indicator of page indexing (true or false)* <br>
+example: false
+
+**attributeValues:**	Record<string, string> <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" } } }
+
+**statusId:** number <br>
+*status identifiers of the product page (can be null)* <br>
+example: 1
+
+**relatedIds:** array <br>
+*identifiers of related product pages* <br>
+example: List [ 1, 2, 3 ]
+
+**price:**	number <br>
+*price value of the product page taken from the index* <br>
+example: 0
+
+**templateIdentifier**	string
+*custom identifier of the associated template*
+example: my-template
+
+**shortDescTemplateIdentifier**	string <br>
+*custom identifier of the associated template for short description* <br>
+example: my-template-short
+
+</details>
+
+### Products.searchProduct(name, langCode)
+
+```js
+const value = await Products.searchProduct('cup', 'en_US')
+```
+
+> This method performs a quick search for product page objects based on a text query name. The search is performed on the title field of the localizeInfos object, taking the specified lang language code into consideration. It returns a Promise that resolves to an array of ContentIndexedProductDto objects.
+
+Example return:
+
+```json
+[
+  {
+  "id": 1764,
+  "localizeInfos": {
+    "title": "Product"
+  },
+  "isVisible": true,
+  "statusId": 1,
+  "relatedIds": [
+    1,
+    2,
+    3
+  ],
+  "productPages": [
+    {
+      "id": 8997,
+      "pageId": 1176,
+      "productId": 8872
+    }
+  ],
+  "attributeSetId": 7,
+  "version": 10,
+  "isSync": 0,
+  "price": 0,
+  "templateIdentifier": "my-template",
+  "shortDescTemplateIdentifier": "my-template-short",
+  "attributeValues": {
+    "marker": {
+      "value": "",
+      "type": "string"
+    }
+  },
+  "position": 1
+}
+]
+```
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764
+
+**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" } }
+
+**isVisible:**	boolean <br>
+*Page visibility flag* <br>
+example: true
+
+**position:**	number <br>
+*position number (for sorting)* <br>
+example: 192
+
+**templateIdentifier:**	string <br>
+*custom identifier of the associated template* <br>
+example: my-template
+
+**attributeSetId:**	number <br>
+*attribute set identifier* <br>
+example: 7
+
+**isSync:**	boolean <br>
+*indicator of page indexing (true or false)* <br>
+example: false
+
+**attributeValues:**	Record<string, string> <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" } } }
+
+**statusId:** number <br>
+*status identifiers of the product page (can be null)* <br>
+example: 1
+
+**relatedIds:** array <br>
+*identifiers of related product pages* <br>
+example: List [ 1, 2, 3 ]
+
+**price:**	number <br>
+*price value of the product page taken from the index* <br>
+example: 0
+
+**templateIdentifier**	string
+*custom identifier of the associated template*
+example: my-template
+
+**shortDescTemplateIdentifier**	string <br>
+*custom identifier of the associated template for short description* <br>
+example: my-template-short
+
+</details>
+
+---
+
+
+## <h2 id="productstatuses"> ProductstatusesSpec </h2>
+
+
+```js
+const { ProductstatusesSpec } = defineOneEntry('your-url');
+```
+
+### ProductstatusesSpec.getProductStatuses()
+
+```js
+const value = await ProductstatusesSpec.getProductStatuses()
+```
+
+> This method searches for all product status objects from the API. It returns a Promise that resolves to an array of product status objects.
+
+Example return:
+
+```json
+[
+  {
+      "id": 1764,
+      "updatedDate": "2023-11-20T22:14:19.438Z",
+      "version": 10,
+      "identifier": "catalog",
+      "localizeInfos": {
+        "title": "Status 1"
+      }
+  }
+]
+```
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764
+
+**updatedDate:**	string($date-time) <br>
+*object's date of modification* <br>
+
+**version**	number <br>
+*object's version number of modification* <br>
+example: 10
+
+**identifier:**	string <br>
+*textual identifier for a field in the record* <br>
+example: catalog
+
+**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" } }
+
+</details>
+
+### ProductstatusesSpec.getProductStatusesById(id)
+
+```js
+const value = await ProductstatusesSpec.getProductStatusesById(1)
+```
+
+> This method searches for a product status object based on its identifier (id) from the API. It returns a Promise that resolves to a product status object.
+
+Example return:
+
+```json
+{
+  "id": 1764,
+  "updatedDate": "2023-09-25T13:36:05.907Z",
+  "version": 10,
+  "identifier": "catalog",
+  "localizeInfos": {
+    "title": "Status 1"
+  }
+}
+```
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764
+
+**updatedDate:**	string($date-time) <br>
+*object's date of modification* <br>
+
+**version**	number <br>
+*object's version number of modification* <br>
+example: 10
+
+**identifier:**	string <br>
+*textual identifier for a field in the record* <br>
+example: catalog
+
+**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" } }
+
+</details>
+
+### ProductstatusesSpec.getProductsByStatusMarker(marker)
+
+```js
+const value = await ProductstatusesSpec.getProductsByStatusMarker('my-marker')
+```
+
+> This method searches for a product status object based on its textual identifier (marker) from the API. It returns a Promise that resolves to a product status object.
+
+Example return:
+
+```json
+{
+  "id": 1764,
+  "updatedDate": "2023-09-25T13:39:19.384Z",
+  "version": 10,
+  "identifier": "catalog",
+  "localizeInfos": {
+    "title": "Status 1"
+  }
+}
+```
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764
+
+**updatedDate:**	string($date-time) <br>
+*object's date of modification* <br>
+
+**version**	number <br>
+*object's version number of modification* <br>
+example: 10
+
+**identifier:**	string <br>
+*textual identifier for a field in the record* <br>
+example: catalog
+
+**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" } }
+
+</details>
+
+### ProductstatusesSpec.validateMarker(marker)
+
+```js
+const value = await ProductstatusesSpec.validateMarker('marker')
+```
+
+> This method checks the existence of a textual identifier (marker). It takes a marker parameter as input, representing the product marker to validate. It returns a Promise that resolves to true if the textual identifier (marker) exists or false if it doesn't.
+
+Example return:
+
+```json
+true
+```
+
+---
+
+
+## <h2 id="system"> System </h2>
+
+
+```js
+const { System } = defineOneEntry('your-url')
+```
+
+### System.test404()
+
+```js
+const value = await System.test404()
+```
+
+> This method allows you to redirect to the error page.
+
+### System.test500()
+
+```js
+const value = await System.test500()
+```
+
+> This method allows you to redirect to the error page.
+
+
+## <h2 id="templates"> Templates </h2>
+
+
+```js
+const { Templates } = defineOneEntry('your-url')
+```
+
+### Templates.getAllTemplates()
+
+```js
+const value = await Templates.getAllTemplates()
+```
+
+> This method retrieves all template objects grouped by types from the API. It returns a Promise that resolves to an object GroupedTemplatesObject, which contains an array of template objects.
+
+Example return:
+
+```json
+[
+   {
+      "id": 1764,
+      "updatedDate": "2023-12-05T12:47:02.859Z",
+      "version": 10,
+      "identifier": "marker",
+      "generalType": {
+        "id": 4,
+        "type": "forCatalogPages"
+      },
+      "generalTypeId": 4,
+      "localizeInfos": {
+        "title": "Page template"
+      },
+      "position": 0,
+      "positionId": 12,
+      "generalTypeName": "forProductPreview"
+  }
+]
+```
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764
+
+**updatedDate:**	string($date-time) <br>
+*object's date of modification* <br>
+
+**version**	number <br>
+*object's version number of modification* <br>
+example: 10
+
+**identifier:**	string <br>
+*textual identifier for a field in the record* <br>
+example: catalog
+
+**generalType:**: object <br>
+*object type* <br>
+example: OrderedMap { "id": 4, "type": "forCatalogPages" }
+
+**generalTypeId:**	number
+*type identifier*
+example: 4
+
+**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" } }
+
+**position** object <br>
+*position number* <br>
+example: 0
+
+
+**positionId:**	number <br>
+*position object identifier* <br>
+example: 12
+
+**generalTypeName**	string <br>
+*example: forProductPreview* <br>
+general type name
+
+</details>
+
+### Templates.getTemplateByType(type)
+
+```js
+const value = await Templates.getTemplateByType('forCatalogProducts')
+```
+
+> This method retrieves a single template object based on its identifier (id) from the API. It returns a Promise that resolves to a template object.
+
+Example return:
+
+```json
+[
+  {
+    "id": 1764,
+    "updatedDate": "2023-12-05T12:45:13.566Z",
+    "version": 10,
+    "identifier": "marker",
+    "generalType": {
+      "id": 4,
+      "type": "forCatalogPages"
+    },
+    "generalTypeId": 4,
+    "localizeInfos": {
+      "title": "Page template"
+    },
+    "position": 0,
+    "positionId": 12,
+    "generalTypeName": "forProductPreview"
+  }
+]
+```
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764
+
+**updatedDate:**	string($date-time) <br>
+*object's date of modification* <br>
+
+**version**	number <br>
+*object's version number of modification* <br>
+example: 10
+
+**identifier:**	string <br>
+*textual identifier for a field in the record* <br>
+example: catalog
+
+**generalType:**: object <br>
+*object type* <br>
+example: OrderedMap { "id": 4, "type": "forCatalogPages" }
+
+**generalTypeId:**	number
+*type identifier*
+example: 4
+
+**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" } }
+
+**position** object <br>
+*position number* <br>
+example: 0
+
+
+**positionId:**	number <br>
+*position object identifier* <br>
+example: 12
+
+**generalTypeName**	string <br>
+*example: forProductPreview* <br>
+general type name
+
+</details>
+
+---
+
+
+## <h2 id="templatepreviews"> TemplatePreviews </h2>
+
+
+```js
+const { TemplatePreviews } = defineOneEntry('your-url')
+```
+
+### TemplatePreviews.getTemplatePreviews()
+
+```js
+const value = await TemplatePreviews.getTemplatePreviews()
+```
+
+> This method retrieves all template objects from the API. It returns a Promise that resolves to an array of TemplatePreviewsEntity template objects.
+
+Example return:
+
+```json
+[
+  {
+    "id": 1764,
+    "updatedDate": "2023-12-05T12:44:55.663Z",
+    "version": 10,
+    "identifier": "marker",
+    "proportion": {
+      "horizontal": {
+        "height": 200,
+        "weight": 10,
+        "marker": "horizontal",
+        "title": "Horizontal",
+        "alignmentType": "left"
+      },
+      "vertical": {
+        "height": 10,
+        "weight": 200,
+        "marker": "vertical",
+        "title": "Vertical",
+        "alignmentType": "left"
+      },
+      "square": {
+        "marker": "square",
+        "title": "Square",
+        "slide": 3,
+        "alignmentType": "center"
+      }
+    },
+    "localizeInfos": {
+      "title": "Page Template"
+    },
+    "position": 0
+  }
+]
+```
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764
+
+**updatedDate:**	string($date-time) <br>
+*object's date of modification* <br>
+
+**version**	number <br>
+*object's version number of modification* <br>
+example: 10
+
+**identifier:**	string <br>
+*textual identifier for a field in the record* <br>
+example: catalog
+
+**proportion**	ITemplateProportionType <br>
+*template proportion parameters* <br>
+example: OrderedMap { "horizontal": OrderedMap { "height": 200, "weight": 10, "marker": "horizontal", "title": "Horizontal", "alignmentType": "left" }, "vertical": OrderedMap { "height": 10, "weight": 200, "marker": "vertical", "title": "Vertical", "alignmentType": "left" }, "square": OrderedMap { "marker": "square", "title": "Square", "slide": 3, "alignmentType": "center" } }
+
+**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" } }
+
+**position** object <br>
+*position number* <br>
+example: 0
+
+
+**positionId:**	number <br>
+*position object identifier* <br>
+example: 12
+
+</details>
+
+
+### TemplatePreviews.getTemplatesPreviewById(id)
+
+```js
+const value = await TemplatePreviews.getTemplatePreviewById(1)
+```
+
+> This method retrieves a single template object based on its identifier (id) from the API. It returns a Promise that resolves to a TemplatePreviewsEntity object.
+
+Example return:
+
+```json
+{
+  "id": 1764,
+  "updatedDate": "2023-12-05T12:44:37.348Z",
+  "version": 10,
+  "identifier": "marker",
+  "proportion": {
+    "horizontal": {
+      "height": 200,
+      "weight": 10,
+      "marker": "horizontal",
+      "title": "Horizontal",
+      "alignmentType": "left"
+    },
+    "vertical": {
+      "height": 10,
+      "weight": 200,
+      "marker": "vertical",
+      "title": "Vertical",
+      "alignmentType": "left"
+    },
+    "square": {
+      "marker": "square",
+      "title": "Square",
+      "slide": 3,
+      "alignmentType": "center"
+    }
+  },
+  "localizeInfos": {
+    "title": "Page Template"
+  },
+  "position": 0
+}
+```
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764
+
+**updatedDate:**	string($date-time) <br>
+*object's date of modification* <br>
+
+**version**	number <br>
+*object's version number of modification* <br>
+example: 10
+
+**identifier:**	string <br>
+*textual identifier for a field in the record* <br>
+example: catalog
+
+**proportion**	ITemplateProportionType <br>
+*template proportion parameters* <br>
+example: OrderedMap { "horizontal": OrderedMap { "height": 200, "weight": 10, "marker": "horizontal", "title": "Horizontal", "alignmentType": "left" }, "vertical": OrderedMap { "height": 10, "weight": 200, "marker": "vertical", "title": "Vertical", "alignmentType": "left" }, "square": OrderedMap { "marker": "square", "title": "Square", "slide": 3, "alignmentType": "center" } }
+
+**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" } }
+
+**position** object <br>
+*position number* <br>
+example: 0
+
+
+**positionId:**	number <br>
+*position object identifier* <br>
+example: 12
+
+</details>
+
+### TemplatePreviews.getTemplatesPreviewByMarker(marker)
+
+```js
+const value = await TemplatePreviews.getTemplatePreviewByMarker('my-marker')
+```
+
+> This method retrieves a single template object based on its textual identifier (marker) from the API. It returns a Promise that resolves to a TemplatePreviewsEntity object.
+
+Example return:
+
+```json
+{
+  "id": 1764,
+  "updatedDate": "2023-12-05T12:44:20.008Z",
+  "version": 10,
+  "identifier": "marker",
+  "proportion": {
+    "horizontal": {
+      "height": 200,
+      "weight": 10,
+      "marker": "horizontal",
+      "title": "Horizontal",
+      "alignmentType": "left"
+    },
+    "vertical": {
+      "height": 10,
+      "weight": 200,
+      "marker": "vertical",
+      "title": "Vertical",
+      "alignmentType": "left"
+    },
+    "square": {
+      "marker": "square",
+      "title": "Square",
+      "slide": 3,
+      "alignmentType": "center"
+    }
+  },
+  "localizeInfos": {
+    "title": "Page Template"
+  },
+  "position": 0
+}
+```
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764
+
+**updatedDate:**	string($date-time) <br>
+*object's date of modification* <br>
+
+**version**	number <br>
+*object's version number of modification* <br>
+example: 10
+
+**identifier:**	string <br>
+*textual identifier for a field in the record* <br>
+example: catalog
+
+**proportion**	ITemplateProportionType <br>
+*template proportion parameters* <br>
+example: OrderedMap { "horizontal": OrderedMap { "height": 200, "weight": 10, "marker": "horizontal", "title": "Horizontal", "alignmentType": "left" }, "vertical": OrderedMap { "height": 10, "weight": 200, "marker": "vertical", "title": "Vertical", "alignmentType": "left" }, "square": OrderedMap { "marker": "square", "title": "Square", "slide": 3, "alignmentType": "center" } }
+
+**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" } }
+
+**position** object <br>
+*position number* <br>
+example: 0
+
+
+**positionId:**	number <br>
+*position object identifier* <br>
+example: 12
+
+</details>
+---
+
+