oneentry 1.0.63 → 1.0.65

package/README.md

@@ -27,19 +27,23 @@ import { defineOneEntry } from 'oneentry'
 const {
         Admins,
         AttributesSets,
+        AuthProvider,
         Blocks,
+        Events,
         Forms,
         FormData,
         FileUploading,
         GeneralTypes,
         Locales,
         Menus,
+        Orders,
         Pages,
         Products,
         ProductStatuses,
         System,
         Templates,
-        TemplatePreviews
+        TemplatePreviews,
+        Users
 } = defineOneEntry('your-url');
 ```
 
@@ -51,7 +55,7 @@ const api = defineOneEntry('your-url');
 
 The second parameter of the function takes a configuration object with the keys "token", "langCode" and "multipleResponse".
 Set the token key if your project secure "Security API Token"
-
+If your project uses user authorization, pass the user access token to the "userToken" variable to use methods that require authorization.
 Set the "langCode" to set the default language. By specifying this parameter once, you don't have to pass the langCode to the methods ONEENTRY API. If you have not passed the default language, it will be set "en_US"
 Some methods use more than one request to the CMS so that the data you receive is complete and easy to work with. Pass the value "false" for this parameter to save traffic and decide for yourself what data you need. The default value "true"
 
@@ -70,12 +74,19 @@ You can also connect a tls certificate to protect your project. In this case, do
 
 
 ```js 
-const api = defineOneEntry('your-url', {token: 'my-token', langCode:'my-langCode'})
+const api = defineOneEntry('your-url', {
+    token: 'my-token', 
+    userToken: 'user.token',
+    langCode:'my-langCode',
+})
 ```
+
 Now you can use the following links to jump to specific entries:
 - [Admins](#admins)
 - [AttributesSets](#attributessets)
+- [AuthProvider](#authprovider)
 - [Blocks](#blocks)
+- [Events](#events)
 - [Forms](#forms)
 - [FormData](#formdata)
 - [FileUploading](#fileuploading)
@@ -90,6 +101,7 @@ Now you can use the following links to jump to specific entries:
 - [System](#system)
 - [Templates](#templates)
 - [TemplatePreviews](#templatepreviews)
+- [Users](#users)
 
 
 ## <h2 id="admins"> Admins </h2>
@@ -329,7 +341,7 @@ example: List [ OrderedMap { "title": "red", "value": 1, "position": 1, "extende
 ---
 
 
-## <h2 id="blocks"> User Auth Provider </h2>
+## <h2 id="authprovider"> User Auth Provider </h2>
 
 ```js
 const { AuthProvider } = defineOneEntry('your-url');
@@ -366,7 +378,7 @@ const data = {
     }
 }
 
-const value = await AuthProvider.getBlocks('en_US', 0, 30)
+const value = await AuthProvider.signUp('email', data)
 ```
 
 > This method will register a new user. Returns the registered user's object.
@@ -503,10 +515,23 @@ Example return:
 true
 ```
 
-### AuthProvider.auth(marker, login, password)
+### AuthProvider.auth(marker, data)
 
 ```js
-const value = await AuthProvider.auth('email', 'test@trer.com', '123456')
+const data = {
+    authData: [
+        {
+            marker: "login",
+            value: "user@gmail.com"
+        },
+        {
+            marker: "password",
+            value: "12345"
+        }
+    ]
+}
+
+const value = await AuthProvider.auth('email', data)
 ```
 
 > This method performs user authorization. Returns an object with a set of tokens.
@@ -691,9 +716,7 @@ Example return:
 {
   "id": 1764,
   "localizeInfos": {
-    "en_US": {
       "title": "My block"
-    }
   },
   "version": 10,
   "identifier": "catalog",
@@ -1035,7 +1058,30 @@ Example return:
 ]
 ```
 
-## <h2 id="fileuploading"> Events </h2>
+### Blocks.searchBlock(name, langCode)
+
+```js
+const value = await Blocks.searchBlock('my-marker', 'en_US')
+```
+
+> Quick search for block objects with limited output.
+
+Example return:
+
+```json
+[
+  {
+    "id": 1,
+    "name": "my block",
+    "identifier": "my-block"
+  }
+]
+```
+
+
+---
+
+## <h2 id="events"> Events </h2>
 
 ```js
 const { Events } = defineOneEntry('your-url');
@@ -1836,7 +1882,7 @@ const { Orders } = defineOneEntry('your-url');
 ### Orders.getOrderByMarker(marker, langCode)
 
 ```js
-const value = await Pages.getOrderByMarker('my-order', 'en_US')
+const value = await Orders.getOrderByMarker('my-order', 'en_US')
 ```
 
 > This method retrieves one order storage object by marker.
@@ -1895,8 +1941,7 @@ example:  [{ "identifier": "p1" }] <br>
     "formIdentifier": "order_form",
     "paymentAccountIdentifier": "stripe",
     "currency": "USD",
-    "formData": {
-        "en_US": [
+    "formData": [
             {
                 "marker": "name_order",
                 "value": "Alex"
@@ -1909,8 +1954,7 @@ example:  [{ "identifier": "p1" }] <br>
                 "marker": "email_order",
                 "value": "example@oneentry.cloud"
             }
-        ]
-    },
+    ],
     "products": [
         {
             "productId": 444,
@@ -1925,7 +1969,7 @@ example:  [{ "identifier": "p1" }] <br>
     ]
 }
 
-const value = await Pages.createOrder('my-order', body)
+const value = await Orders.createOrder('my-order', body)
 ```
 
 > This method retrieves one order storage object by marker. The method will add the default language to the request body. If you want to change the language, just pass it with the second argument
@@ -2016,61 +2060,161 @@ example: payment-1 <br>
 example: { "title": "Account 1" } <br>
 </details>
 
----
 
+### Orders.updateOrderByMarkerAndId(marker, data, langCode)
 
+```js
+const body = {
+    "formIdentifier": "order_form",
+    "paymentAccountIdentifier": "stripe",
+    "currency": "USD",
+    "formData": [
+        {
+            "marker": "name_order",
+            "value": "Alex"
+        },
+        {
+            "marker": "phone_order",
+            "value": "+19999999999"
+        },
+        {
+            "marker": "email_order",
+            "value": "example@oneentry.cloud"
+        }
+    ],
+    "products": [
+        {
+            "productId": 444,
+            "quantity": 1,
+            "price": "0.1"
+        },
+        {
+            "productId": 446,
+            "quantity": 3,
+            "price": "123"
+        }
+    ]
+}
 
-## <h2 id="pages"> Pages </h2>
+const value = await Orders.updateOrderByMarkerAndId('my-order', body)
+```
 
+> This method update one order storage object by marker. The method will add the default language to the request body. If you want to change the language, just pass it with the second argument
 
-```js
-const { Pages } = defineOneEntry('your-url');
+Example return:
+```json
+{
+  "id": 17,
+  "statusIdentifier": "inprogress",
+  "formIdentifier": "order-form",
+  "paymentIdentifier": "payment-1",
+  "formData": [
+    {
+      "marker": "name_1",
+      "value": "Name"
+    }
+  ],
+  "products": [
+    {
+      "id": 1,
+      "title": "Floorwood Maxima Laminate, 9811 Oak Mistral",
+      "sku": null,
+      "price": "1.00",
+      "quantity": 10,
+      "previewImage": [
+        {
+          "filename": "files/project/page/36/image/20240322_77c83b02-4c82-4bea-80eb-3763c469b00e.jpg",
+          "downloadLink": "http://my-site.com/files/project/page/36/image/20240322_77c83b02-4c82-4bea-80eb-3763c469b00e.jpg",
+          "size": 296391,
+          "previewLink": ""
+        }
+      ]
+    }
+  ],
+  "totalSum": "12.00",
+  "currency": "USD",
+  "createdDate": "2023-01-01 12:12",
+  "paymentAccountIdentifier": "payment-1",
+  "paymentAccountLocalizeInfos": {
+    "title": "Account 1"
+  }
+}
 ```
+<details>
+<summary>Schema</summary>
 
-### Pages.getRootPages(langCode)
+**statusIdentifier:**	string <br>
+*text identifier of the order status* <br>
+example: inprogress <br>
+
+**formIdentifier:**	string <br>
+*text identifier of the form status* <br>
+example: order-form <br>
+
+**paymentIdentifier** string <br>
+*text identifier of the order payment* <br>
+example: payment-1 <br>
+
+**formData** FormDataType <br>
+*data submitted by the form linked to the order store* <br>
+example: [{ "marker": "name_1", "value": "Name" } ] <br>
+
+**products**	Record<string, string | any>[] <br>
+*array of products added to order* <br>
+
+**totalSum** string <br>
+*total order amount* <br>
+example:  12.00 <br>
+
+**currency** string <br>
+*currency used to pay for the order* <br>
+example: USD <br>
+
+**createdDate** string <br>
+*date when the order was created* <br>
+example: 2023-01-01 12:12 <br>
+
+**price** number <br>
+*price of the product per unit (at the time of ordering)* <br>
+example: 20.00 <br>
+
+**paymentAccountIdentifier** string <br>
+*textual identifier for the order payment* <br>
+example: payment-1 <br>
+
+**paymentAccountLocalizeInfos** CommonLocalizeInfos <br>
+*payment account name considering localization* <br>
+example: { "title": "Account 1" } <br>
+</details>
+
+
+### Orders.getAllOrders(langCode, limit, offset)
 
 ```js
-const value = await Pages.getRootPages('en_US')
+const value = await Orders.getAllOrders()
 ```
 
-> 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.
+> This method getting all the order storage objects. The method will add the default language to the request body. If you want to change the language, just pass it with the second argument
 
 Example return:
-
 ```json
 [
   {
-      "id": 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
+    "id": 1764,
+    "localizeInfos": {
+        "title": "Order 1"
+    },
+    "identifier": "catalog",
+    "generalTypeId": 4,
+    "formIdentifier": "catalog-form",
+    "paymentAccountIdentifiers": [
+      {
+        "identifier": "p1"
+      }
+    ]
   }
 ]
 ```
-
 <details>
 <summary>Schema</summary>
 
@@ -2078,71 +2222,257 @@ Example return:
 *object identifier* <br>
 example: 1764 <br>
 
-**parentId** number <br>
-*parent page identifier, if null, it is a top-level page* <br>
-example: null <br>
-
-**config**	Record<string, number> <br>
-*output settings for catalog pages* <br>
-example: OrderedMap { "rowsPerPage": 1, "productsPerRow": 1 } <br>
-
-**pageUrl**	string <br>
-*unique page URL* <br>
-
-**depth** number <br>
-*page nesting depth relative to parentId* <br>
-example: 3 <br>
-
 **localizeInfos:**	Record<string, any> <br>
 *json description of the main page data object taking into account the language "en_US" (for example)* <br>
 example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } } <br>
 
-**isVisible:**	boolean <br>
-*Page visibility flag* <br>
-example: true <br>
-
-**products** number <br>
-*Number of products linked to the page* <br>
-example: 0 <br>
-
-**attributeSetId:**	number <br>
-*attribute set identifier* <br>
-example: 7 <br>
-
-**forms**	 <br>
-*Array of FormEntity object identifier values linked to the page (optional)* <br>
-
+**identifier** string <br>
+*textual identifier for the record field* <br>
+example: catalog <br>
 
-**blocks**	 <br>
-*Array of BlockEntity object identifier values linked to the page (optional)* <br>
+**generalTypeId** number <br>
+*type identifier* <br>
+example: 4 <br>
 
+**formIdentifier**	string <br>
+*textual identifier for the form used by the order storage* <br>
+example: catalog-form <br>
 
-**isSync:**	boolean <br>
-*indicator of page indexing (true or false)* <br>
-example: false <br>
+**paymentAccountIdentifiers** Array<{identifier:string} <br>
+*array of textual identifiers of payment accounts used by the order storage* <br>
+example:  [{ "identifier": "p1" }] <br>
 
-**templateIdentifier:**	string <br>
-*Custom identifier of the linked template* <br>
-example: my-template <br>
+</details>
 
-**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" } } } <br>
 
-**position:**	number <br>
-*position number for sorting (optional)* <br>
-example: 192 <br>
+### Orders.getAllOrdersByMarker(marker, langCode)
 
-**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 ] <br>
+```js
+const value = await Orders.getAllOrdersByMarker('my-order')
+```
 
+> This method getting all order storage object by marker. The method will add the default language to the request body. If you want to change the language, just pass it with the second argument
 
-**childrenCount:**	number <br>
-*number of nested pages* <br>
-example: 0 <br>
+Example return:
+```json
+{
+  "id": 17,
+  "statusIdentifier": "inprogress",
+  "formIdentifier": "order-form",
+  "paymentIdentifier": "payment-1",
+  "formData": [
+    {
+      "marker": "name_1",
+      "value": "Name"
+    }
+  ],
+  "products": [
+    {
+      "id": 1,
+      "title": "Floorwood Maxima Laminate, 9811 Oak Mistral",
+      "sku": null,
+      "price": "1.00",
+      "quantity": 10,
+      "previewImage": [
+        {
+          "filename": "files/project/page/36/image/20240322_77c83b02-4c82-4bea-80eb-3763c469b00e.jpg",
+          "downloadLink": "http://my-site.com/files/project/page/36/image/20240322_77c83b02-4c82-4bea-80eb-3763c469b00e.jpg",
+          "size": 296391,
+          "previewLink": ""
+        }
+      ]
+    }
+  ],
+  "totalSum": "12.00",
+  "currency": "USD",
+  "createdDate": "2023-01-01 12:12",
+  "price": 20,
+  "paymentAccountIdentifier": "payment-1",
+  "paymentAccountLocalizeInfos": {
+    "title": "Account 1"
+  },
+  "isHistory": true
+}
+```
+<details>
+<summary>Schema</summary>
+
+**statusIdentifier:**	string <br>
+*text identifier of the order status* <br>
+example: inprogress <br>
+
+**formIdentifier:**	string <br>
+*text identifier of the form status* <br>
+example: order-form <br>
+
+**paymentIdentifier** string <br>
+*text identifier of the order payment* <br>
+example: payment-1 <br>
+
+**formData** FormDataType <br>
+*data submitted by the form linked to the order store* <br>
+example: [{ "marker": "name_1", "value": "Name" } ] <br>
+
+**products**	Record<string, string | any>[] <br>
+*array of products added to order* <br>
+
+**totalSum** string <br>
+*total order amount* <br>
+example:  12.00 <br>
+
+**currency** string <br>
+*currency used to pay for the order* <br>
+example: USD <br>
+
+**createdDate** string <br>
+*date when the order was created* <br>
+example: 2023-01-01 12:12 <br>
+
+**price** number <br>
+*price of the product per unit (at the time of ordering)* <br>
+example: 20.00 <br>
+
+**paymentAccountIdentifier** string <br>
+*textual identifier for the order payment* <br>
+example: payment-1 <br>
+
+**paymentAccountLocalizeInfos** CommonLocalizeInfos <br>
+*payment account name considering localization* <br>
+example: { "title": "Account 1" } <br>
+
+**isHistory** boolean <br>
+*indicates that the order has been saved in the order history* <br>
+example: true <br>
+</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 <br>
+
+**parentId** number <br>
+*parent page identifier, if null, it is a top-level page* <br>
+example: null <br>
+
+**config**	Record<string, number> <br>
+*output settings for catalog pages* <br>
+example: OrderedMap { "rowsPerPage": 1, "productsPerRow": 1 } <br>
+
+**pageUrl**	string <br>
+*unique page URL* <br>
+
+**depth** number <br>
+*page nesting depth relative to parentId* <br>
+example: 3 <br>
+
+**localizeInfos:**	Record<string, any> <br>
+*json description of the main page data object taking into account the language "en_US" (for example)* <br>
+example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } } <br>
+
+**isVisible:**	boolean <br>
+*Page visibility flag* <br>
+example: true <br>
+
+**products** number <br>
+*Number of products linked to the page* <br>
+example: 0 <br>
+
+**attributeSetId:**	number <br>
+*attribute set identifier* <br>
+example: 7 <br>
+
+**forms**	 <br>
+*Array of FormEntity object identifier values linked to the page (optional)* <br>
+
+
+**blocks**	 <br>
+*Array of BlockEntity object identifier values linked to the page (optional)* <br>
+
+
+**isSync:**	boolean <br>
+*indicator of page indexing (true or false)* <br>
+example: false <br>
+
+**templateIdentifier:**	string <br>
+*Custom identifier of the linked template* <br>
+example: my-template <br>
+
+**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" } } } <br>
+
+**position:**	number <br>
+*position number for sorting (optional)* <br>
+example: 192 <br>
+
+**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 ] <br>
+
+
+**childrenCount:**	number <br>
+*number of nested pages* <br>
+example: 0 <br>
 
 </details>
 
@@ -3554,32 +3884,53 @@ 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",
-      "sku": "0-123",
-      "shortDescTemplateIdentifier": "my-template-short",
-      "attributeValues": {
+  {
+    "id": 1764,
+    "localizeInfos": {
+      "title": "Product"
+    },
+    "isVisible": true,
+    "statusId": 1,
+    "relatedIds": [
+      1,
+      2,
+      3
+    ],
+    "attributeSetId": 7,
+    "isSync": true,
+    "price": 0,
+    "additional": {
+      "prices": {
+        "min": 0,
+        "max": 100
+      }
+    },
+    "blocks": [
+      null
+    ],
+    "sku": "0-123",
+    "productPages": [
+      {
+        "id": 8997,
+        "pageId": 1176,
+        "productId": 8872
+      }
+    ],
+    "statusLocalizeInfos": {
+      "title": "Product"
+    },
+    "templateIdentifier": "my-template",
+    "shortDescTemplateIdentifier": "my-template-short",
+    "attributeValues": {
         "marker": {
           "value": "",
-          "type": "string"
-        }
-      },
-      "position": 1
-    }
+          "type": "string",
+          "position": 1,
+          "isProductPreview": false
+      }
+    },
+    "position": 1
+  }
 ]
 ```
 
@@ -3590,6 +3941,14 @@ Example return:
 *object identifier* <br>
 example: 1764 <br>
 
+**additional:**	Record<string, any> <br>
+*additional value from the index* <br>
+example: OrderedMap { "prices": OrderedMap { "min": 0, "max": 100 } } <br>
+
+**statusLocalizeInfos:**	CommonLocalizeInfos <br>
+*json description of the item status object, taking into account the language* <br>
+example: {  "title": "Product" <br>
+
 **localizeInfos:**	Record<string, any> <br>
 *json description of the main page data object taking into account the language "en_US" (for example)* <br>
 example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } } <br>
@@ -3657,33 +4016,53 @@ Example return:
 
 ```json
 [
-    {
-      "id": 1764,
-      "localizeInfos": {
-        "title": "Product"
-      },
-      "isVisible": true,
-      "statusId": 1,
-      "relatedIds": [
-        1,
-        2,
-        3
-      ],
-      "attributeSetId": 7,
-      "blocks": ["product_block"],
-      "isSync": true,
-      "price": 0,
-      "templateIdentifier": "my-template",
-      "shortDescTemplateIdentifier": "my-template-short",
-      "sku": "0-123",
-      "attributeValues": {
-        "marker": {
-          "value": "",
-          "type": "string"
-        }
-      },
-      "position": 1
-    }
+  {
+    "id": 1764,
+    "localizeInfos": {
+      "title": "Product"
+    },
+    "isVisible": true,
+    "statusId": 1,
+    "relatedIds": [
+      1,
+      2,
+      3
+    ],
+    "attributeSetId": 7,
+    "isSync": true,
+    "price": 0,
+    "additional": {
+      "prices": {
+        "min": 0,
+        "max": 100
+      }
+    },
+    "blocks": [
+      null
+    ],
+    "sku": "0-123",
+    "productPages": [
+      {
+        "id": 8997,
+        "pageId": 1176,
+        "productId": 8872
+      }
+    ],
+    "statusLocalizeInfos": {
+      "title": "Product"
+    },
+    "templateIdentifier": "my-template",
+    "shortDescTemplateIdentifier": "my-template-short",
+    "attributeValues": {
+      "marker": {
+        "value": "",
+        "type": "string",
+        "position": 1,
+        "isProductPreview": false
+      }
+    },
+    "position": 1
+  }
 ]
 ```
 <details>
@@ -3693,6 +4072,14 @@ Example return:
 *object identifier* <br>
 example: 1764 <br>
 
+**additional:**	Record<string, any> <br>
+*additional value from the index* <br>
+example: OrderedMap { "prices": OrderedMap { "min": 0, "max": 100 } } <br>
+
+**statusLocalizeInfos:**	CommonLocalizeInfos <br>
+*json description of the item status object, taking into account the language* <br>
+example: {  "title": "Product" <br>
+
 **localizeInfos:**	Record<string, any> <br>
 *json description of the main page data object taking into account the language "en_US" (for example)* <br>
 example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } } <br>
@@ -3775,6 +4162,19 @@ Example return:
     2,
     3
   ],
+  "attributeSetId": 7,
+  "isSync": true,
+  "price": 0,
+  "additional": {
+    "prices": {
+      "min": 0,
+      "max": 100
+    }
+  },
+  "blocks": [
+    null
+  ],
+  "sku": "0-123",
   "productPages": [
     {
       "id": 8997,
@@ -3782,18 +4182,17 @@ Example return:
       "productId": 8872
     }
   ],
-  "attributeSetId": 7,
-  "blocks": ["product_block"],
-  "version": 10,
-  "isSync": 0,
-  "price": 0,
+  "statusLocalizeInfos": {
+    "title": "Product"
+  },
   "templateIdentifier": "my-template",
   "shortDescTemplateIdentifier": "my-template-short",
-  "sku": "0-123",
   "attributeValues": {
     "marker": {
       "value": "",
-      "type": "string"
+      "type": "string",
+      "position": 1,
+      "isProductPreview": false
     }
   },
   "position": 1
@@ -3806,6 +4205,14 @@ Example return:
 *object identifier* <br>
 example: 1764 <br>
 
+**additional:**	Record<string, any> <br>
+*additional value from the index* <br>
+example: OrderedMap { "prices": OrderedMap { "min": 0, "max": 100 } } <br>
+
+**statusLocalizeInfos:**	CommonLocalizeInfos <br>
+*json description of the item status object, taking into account the language* <br>
+example: {  "title": "Product" <br>
+
 **localizeInfos:**	Record<string, any> <br>
 *json description of the main page data object taking into account the language "en_US" (for example)* <br>
 example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } } <br>
@@ -3887,6 +4294,19 @@ Example return:
     2,
     3
   ],
+  "attributeSetId": 7,
+  "isSync": true,
+  "price": 0,
+  "additional": {
+    "prices": {
+      "min": 0,
+      "max": 100
+    }
+  },
+  "blocks": [
+    null
+  ],
+  "sku": "0-123",
   "productPages": [
     {
       "id": 8997,
@@ -3894,18 +4314,17 @@ Example return:
       "productId": 8872
     }
   ],
-  "attributeSetId": 7,
-  "blocks": ["product_block"],
-  "version": 10,
-  "isSync": 0,
-  "price": 0,
+  "statusLocalizeInfos": {
+    "title": "Product"
+  },
   "templateIdentifier": "my-template",
   "shortDescTemplateIdentifier": "my-template-short",
-  "sku": "0-123",
   "attributeValues": {
     "marker": {
       "value": "",
-      "type": "string"
+      "type": "string",
+      "position": 1,
+      "isProductPreview": false
     }
   },
   "position": 1
@@ -3918,6 +4337,15 @@ Example return:
 *object identifier* <br>
 example: 1764 <br>
 
+**additional:**	Record<string, any> <br>
+*additional value from the index* <br>
+example: OrderedMap { "prices": OrderedMap { "min": 0, "max": 100 } } <br>
+
+**statusLocalizeInfos:**	CommonLocalizeInfos <br>
+*json description of the item status object, taking into account the language* <br>
+example: {  "title": "Product" <br>
+
+
 **localizeInfos:**	Record<string, any> <br>
 *json description of the main page data object taking into account the language "en_US" (for example)* <br>
 example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } } <br>
@@ -4000,16 +4428,36 @@ Example return:
     3
   ],
   "attributeSetId": 7,
-  "blocks": ["product_block"],
   "isSync": true,
   "price": 0,
+  "additional": {
+    "prices": {
+      "min": 0,
+      "max": 100
+    }
+  },
+  "blocks": [
+    null
+  ],
+  "sku": "0-123",
+  "productPages": [
+    {
+      "id": 8997,
+      "pageId": 1176,
+      "productId": 8872
+    }
+  ],
+  "statusLocalizeInfos": {
+    "title": "Product"
+  },
   "templateIdentifier": "my-template",
   "shortDescTemplateIdentifier": "my-template-short",
-  "sku": "0-123",
   "attributeValues": {
     "marker": {
       "value": "",
-      "type": "string"
+      "type": "string",
+      "position": 1,
+      "isProductPreview": false
     }
   },
   "position": 1
@@ -4022,6 +4470,14 @@ Example return:
 *object identifier* <br>
 example: 1764 <br>
 
+**additional:**	Record<string, any> <br>
+*additional value from the index* <br>
+example: OrderedMap { "prices": OrderedMap { "min": 0, "max": 100 } } <br>
+
+**statusLocalizeInfos:**	CommonLocalizeInfos <br>
+*json description of the item status object, taking into account the language* <br>
+example: {  "title": "Product" <br>
+
 **localizeInfos:**	Record<string, any> <br>
 *json description of the main page data object taking into account the language "en_US" (for example)* <br>
 example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } } <br>
@@ -4104,16 +4560,36 @@ Example return:
     3
   ],
   "attributeSetId": 7,
-  "blocks": ["product_block"],
   "isSync": true,
   "price": 0,
+  "additional": {
+    "prices": {
+      "min": 0,
+      "max": 100
+    }
+  },
+  "blocks": [
+    null
+  ],
+  "sku": "0-123",
+  "productPages": [
+    {
+      "id": 8997,
+      "pageId": 1176,
+      "productId": 8872
+    }
+  ],
+  "statusLocalizeInfos": {
+    "title": "Product"
+  },
   "templateIdentifier": "my-template",
   "shortDescTemplateIdentifier": "my-template-short",
-  "sku": "0-123",
   "attributeValues": {
     "marker": {
       "value": "",
-      "type": "string"
+      "type": "string",
+      "position": 1,
+      "isProductPreview": false
     }
   },
   "position": 1
@@ -4126,6 +4602,14 @@ Example return:
 *object identifier* <br>
 example: 1764 <br>
 
+**additional:**	Record<string, any> <br>
+*additional value from the index* <br>
+example: OrderedMap { "prices": OrderedMap { "min": 0, "max": 100 } } <br>
+
+**statusLocalizeInfos:**	CommonLocalizeInfos <br>
+*json description of the item status object, taking into account the language* <br>
+example: {  "title": "Product" <br>
+
 **localizeInfos:**	Record<string, any> <br>
 *json description of the main page data object taking into account the language "en_US" (for example)* <br>
 example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } } <br>
@@ -4233,6 +4717,19 @@ Example return:
     2,
     3
   ],
+  "attributeSetId": 7,
+  "isSync": true,
+  "price": 0,
+  "additional": {
+    "prices": {
+      "min": 0,
+      "max": 100
+    }
+  },
+  "blocks": [
+    null
+  ],
+  "sku": "0-123",
   "productPages": [
     {
       "id": 8997,
@@ -4240,18 +4737,17 @@ Example return:
       "productId": 8872
     }
   ],
-  "attributeSetId": 7,
-  "blocks": ["product_block"],
-  "version": 10,
-  "isSync": 0,
-  "price": 0,
+  "statusLocalizeInfos": {
+    "title": "Product"
+  },
   "templateIdentifier": "my-template",
   "shortDescTemplateIdentifier": "my-template-short",
-  "sku": "0-123",
   "attributeValues": {
     "marker": {
       "value": "",
-      "type": "string"
+      "type": "string",
+      "position": 1,
+      "isProductPreview": false
     }
   },
   "position": 1
@@ -4264,6 +4760,14 @@ Example return:
 *object identifier* <br>
 example: 1764 <br>
 
+**additional:**	Record<string, any> <br>
+*additional value from the index* <br>
+example: OrderedMap { "prices": OrderedMap { "min": 0, "max": 100 } } <br>
+
+**statusLocalizeInfos:**	CommonLocalizeInfos <br>
+*json description of the item status object, taking into account the language* <br>
+example: {  "title": "Product" <br>
+
 **localizeInfos:**	Record<string, any> <br>
 *json description of the main page data object taking into account the language "en_US" (for example)* <br>
 example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } } <br>
@@ -4335,40 +4839,52 @@ 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,
-  "blocks": ["product_block"],
-  "version": 10,
-  "isSync": 0,
-  "price": 0,
-  "templateIdentifier": "my-template",
-  "shortDescTemplateIdentifier": "my-template-short",
+    "id": 1764,
+    "localizeInfos": {
+      "title": "Product"
+    },
+    "isVisible": true,
+    "statusId": 1,
+    "relatedIds": [
+      1,
+      2,
+      3
+    ],
+    "attributeSetId": 7,
+    "isSync": true,
+    "price": 0,
+    "additional": {
+      "prices": {
+        "min": 0,
+        "max": 100
+      }
+    },
+    "blocks": [
+      null
+    ],
     "sku": "0-123",
+    "productPages": [
+      {
+        "id": 8997,
+        "pageId": 1176,
+        "productId": 8872
+      }
+    ],
+    "statusLocalizeInfos": {
+      "title": "Product"
+    },
+    "templateIdentifier": "my-template",
+    "shortDescTemplateIdentifier": "my-template-short",
     "attributeValues": {
-    "marker": {
-      "value": "",
-      "type": "string"
-    }
-  },
-  "position": 1
-}
+      "marker": {
+        "value": "",
+        "type": "string",
+        "position": 1,
+        "isProductPreview": false
+      }
+    },
+    "position": 1
+  }
 ]
 ```
 <details>
@@ -4378,6 +4894,14 @@ Example return:
 *object identifier* <br>
 example: 1764 <br>
 
+**additional:**	Record<string, any> <br>
+*additional value from the index* <br>
+example: OrderedMap { "prices": OrderedMap { "min": 0, "max": 100 } } <br>
+
+**statusLocalizeInfos:**	CommonLocalizeInfos <br>
+*json description of the item status object, taking into account the language* <br>
+example: {  "title": "Product" <br>
+
 **localizeInfos:**	Record<string, any> <br>
 *json description of the main page data object taking into account the language "en_US" (for example)* <br>
 example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } } <br>
@@ -4634,22 +5158,20 @@ 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"
+  {
+    "id": 1764,
+    "updatedDate": "2024-05-25T23:50:35.154Z",
+    "version": 10,
+    "identifier": "marker",
+    "generalType": {
+      "id": 4,
+      "type": "forCatalogPages"
+    },
+    "generalTypeId": 4,
+    "title": "Page template",
+    "position": 0,
+    "positionId": 12,
+    "generalTypeName": "forProductPreview"
   }
 ]
 ```
@@ -4679,9 +5201,9 @@ example: OrderedMap { "id": 4, "type": "forCatalogPages" } <br>
 *type identifier* <br>
 example: 4 <br>
 
-**localizeInfos:**	Record<string, any> <br>
-*json description of the main page data object taking into account the language "en_US" (for example)* <br>
-example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } } <br>
+**title:**	string<br>
+*template name* <br>
+example: page template <br>
 
 **position** object <br>
 *position number* <br>
@@ -4712,7 +5234,7 @@ Example return:
 [
   {
     "id": 1764,
-    "updatedDate": "2023-12-05T12:45:13.566Z",
+    "updatedDate": "2024-05-25T23:50:35.154Z",
     "version": 10,
     "identifier": "marker",
     "generalType": {
@@ -4720,9 +5242,7 @@ Example return:
       "type": "forCatalogPages"
     },
     "generalTypeId": 4,
-    "localizeInfos": {
-      "title": "Page template"
-    },
+    "title": "Page template",
     "position": 0,
     "positionId": 12,
     "generalTypeName": "forProductPreview"
@@ -4755,14 +5275,87 @@ example: OrderedMap { "id": 4, "type": "forCatalogPages" } <br>
 *type identifier* <br>
 example: 4 <br>
 
-**localizeInfos:**	Record<string, any> <br>
-*json description of the main page data object taking into account the language "en_US" (for example)* <br>
-example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } } <br>
+**title:**	string<br>
+*template name* <br>
+example: page template <br>
 
 **position** object <br>
 *position number* <br>
 example: 0 <br>
 
+**positionId:**	number <br>
+*position object identifier* <br>
+example: 12 <br>
+
+**generalTypeName**	string <br>
+*example: forProductPreview* <br>
+general type name <br>
+
+</details>
+
+
+### Templates.getTemplateById(id)
+
+```js
+const value = await Templates.getTemplateById(1)
+```
+
+> 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": "2024-05-25T23:50:35.154Z",
+    "version": 10,
+    "identifier": "marker",
+    "generalType": {
+      "id": 4,
+      "type": "forCatalogPages"
+    },
+    "generalTypeId": 4,
+    "title": "Page template",
+    "position": 0,
+    "positionId": 12,
+    "generalTypeName": "forProductPreview"
+  }
+]
+```
+<details>
+<summary>Schema</summary>
+
+**id:**	number <br>
+*object identifier* <br>
+example: 1764 <br>
+
+**updatedDate:**	string($date-time) <br>
+*object's date of modification* <br>
+
+**version**	number <br>
+*object's version number of modification* <br>
+example: 10 <br>
+
+**identifier:**	string <br>
+*textual identifier for a field in the record* <br>
+example: catalog <br>
+
+**generalType:**: object <br>
+*object type* <br>
+example: OrderedMap { "id": 4, "type": "forCatalogPages" } <br>
+
+**generalTypeId:**	number <br>
+*type identifier* <br>
+example: 4 <br>
+
+**title:**	string<br>
+*template name* <br>
+example: page template <br>
+
+**position** object <br>
+*position number* <br>
+example: 0 <br>
 
 **positionId:**	number <br>
 *position object identifier* <br>
@@ -4823,9 +5416,7 @@ Example return:
         "alignmentType": "center"
       }
     },
-    "localizeInfos": {
-      "title": "Page Template"
-    },
+    "title": "Page Template",
     "position": 0
   }
 ]
@@ -4852,9 +5443,9 @@ example: catalog <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" } } <br>
 
-**localizeInfos:**	Record<string, any> <br>
-*json description of the main page data object taking into account the language "en_US" (for example)* <br>
-example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } } <br>
+**title:**	string<br>
+*template name* <br>
+example: page template <br>
 
 **position** object <br>
 *position number* <br>
@@ -4906,9 +5497,7 @@ Example return:
       "alignmentType": "center"
     }
   },
-  "localizeInfos": {
-    "title": "Page Template"
-  },
+  "title": "Page Template",
   "position": 0
 }
 ```
@@ -4934,9 +5523,9 @@ example: catalog <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" } } <br>
 
-**localizeInfos:**	Record<string, any> <br>
-*json description of the main page data object taking into account the language "en_US" (for example)* <br>
-example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } } <br>
+**title:**	string<br>
+*template name* <br>
+example: page template <br>
 
 **position** object <br>
 *position number* <br>
@@ -4987,9 +5576,7 @@ Example return:
       "alignmentType": "center"
     }
   },
-  "localizeInfos": {
-    "title": "Page Template"
-  },
+  "title": "Page Template",
   "position": 0
 }
 ```
@@ -5015,9 +5602,9 @@ example: catalog <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" } } <br>
 
-**localizeInfos:**	Record<string, any> <br>
-*json description of the main page data object taking into account the language "en_US" (for example)* <br>
-example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } } <br>
+**title:**	string<br>
+*template name* <br>
+example: page template <br>
 
 **position** object <br>
 *position number* <br>
@@ -5032,7 +5619,7 @@ example: 12 <br>
 ---
 
 
-## <h2 id="templatepreviews"> Users </h2>
+## <h2 id="users"> Users </h2>
 
 
 ```js