oneentry 1.0.19 → 1.0.21

package/README.md

@@ -18,7 +18,7 @@ To install the OneEntry Headless CMS SDK in your project, run the following comm
 ```
 npm install oneentry
 ```
-> 
+>
 
 # Usage
 
@@ -27,17 +27,17 @@ To use the OneEntry Headless CMS SDK in your project, import the defineOneEntry
 import { defineOneEntry } from 'oneentry'
 
 const {
-Product,
-Page,
-ProductStatus,
-Templates,
-TemplatesPreview,
-AttributeSet,
-Admins,
-GeneralTypes,
-Locales,
-Menus,
-Modules
+        Admins,
+        Forms,
+        FormData,
+        GeneralTypes,
+        Locales,
+        Menus,
+        Pages,
+        Products,
+        ProductStatuses,
+        Templates,
+        TemplatePreviews
 } = defineOneEntry('your-url')
 ```
 >
@@ -46,9 +46,6 @@ Modules
 ```
 const api = defineOneEntry('your-url')
 ```
-# Classes and Methods
-
-The OneEntry Headless CMS SDK contains two classes: ProductApi and PageApi.
 
 ## Admins
 
@@ -100,7 +97,7 @@ const value = await Forms.getAllForms()
 
 > This method retrieves all form objects from the API. It returns a Promise that resolves to an array of FormEntity objects.
 
-Example return: 
+Example return:
 ```
 [
   {
@@ -108,7 +105,7 @@ Example return:
     "attributeSetId": 0,
     "processingType": "email",
     "localizeInfos": {
-      "ru_RU": {
+      "en_US": {
         "title": "My form",
         "titleForSite": "",
         "successMessage": "",
@@ -150,8 +147,8 @@ Example return:
   "attributeSetId": 0,
   "processingType": "email",
   "localizeInfos": {
-    "ru_RU": {
-      "title": "Моя форма",
+    "en_US": {
+      "title": "My form",
       "titleForSite": "",
       "successMessage": "",
       "unsuccessMessage": "",
@@ -175,14 +172,30 @@ Example return:
 }
 ```
 
-## FormsData
+## FormData
 
-const { FormsData } = defineOneEntry('your-url');
+const { FormData } = defineOneEntry('your-url');
 
 ### postFormsData
 
 ```
-const value = await FormsData.postFormsData()
+const value = await FormData.postFormsData(data)
+```
+
+>The method takes as a parameter request body
+
+Example
+```
+{
+  "formIdentifier": "my-form",
+  "formData": [
+    {
+      "marker": "name_1",
+      "value": "Name",
+      "langCode": "en_US"
+    }
+  ]
+}
 ```
 
 > This method retrieves all form data objects from the API. It returns a Promise that resolves to an array of objects of type CreateFormDataDto.
@@ -197,7 +210,7 @@ Example return:
   "formData": {
     "en_US": [
       {
-        "marker": "naimenovanie_1",
+        "marker": "name_1",
         "value": "Name"
       }
     ]
@@ -208,7 +221,7 @@ Example return:
 ### getFormsData
 
 ```
-const value = await FormsData.getFormsData()
+const value = await FormData.getFormsData()
 ```
 
 > 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.
@@ -224,7 +237,7 @@ Example return:
     "formData": {
       "en_US": [
         {
-          "marker": "naimenovanie_1",
+          "marker": "name_1",
           "value": "Name"
         }
       ]
@@ -236,7 +249,7 @@ Example return:
 ### getFormsDataByMarker
 
 ```
-const value = await FormsData.getFormsDataByMarker('my-marker')
+const value = await FormData.getFormsDataByMarker('my-marker')
 ```
 
 > 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.
@@ -251,7 +264,7 @@ Example return:
   "formData": {
     "en_US": [
       {
-        "marker": "naimenovanie_1",
+        "marker": "name_1",
         "value": "Name"
       }
     ]
@@ -280,6 +293,7 @@ Example return:
   }
 ]
 ```
+
 ## Locales
 
 ```
@@ -358,6 +372,62 @@ Example return:
 ```
 const { Pages } = defineOneEntry('your-url')
 ```
+> In some methods, the langcode parameter can be either a string or an array of strings. It depends on which set of values will contain "attributeValues" and "localizeInfos" 
+
+Example 
+
+```
+ const value = await Pages.getRootPages('en_US')
+ 
+ "localizeInfos": {
+      {
+        "title": "Catalog",
+        "content": "Content from catalog",
+        "menuTitle": "Catalog"
+      }
+ },
+ "attributeValues": {
+      {
+        "marker": {
+          "value": "Value",
+          "type": "string"
+        }
+      }
+ }   
+ ```
+ Or
+```
+const value = await Pages.getRootPages([ 'en_US', 'it_IT' ])
+
+ "localizeInfos": {
+      en_US: {
+        "title": "Catalog",
+        "content": "Content from catalog",
+        "menuTitle": "Catalog"
+      },
+      it_IT: {
+        "title": "Catalogo",
+        "content": "Contenuto dal catalogo",
+        "menuTitle": "Catalogo"
+      }
+ },
+ "attributeValues": {
+      en_US: {
+        "marker": {
+          "value": "Value",
+          "type": "string"
+        }
+      },
+      it_IT: {
+        "marker": {
+          "value": "Valore",
+          "type": "string"
+        }
+      }
+ }
+```
+
+
 
 ### getRootPages
 
@@ -380,7 +450,7 @@ Example return:
     "pageUrl": "string",
     "depth": 3,
     "localizeInfos": {
-      "en_US": {
+      {
         "title": "Catalog",
         "content": "Content from catalog",
         "menuTitle": "Catalog"
@@ -398,7 +468,7 @@ Example return:
     ],
     "templateIdentifier": "my-template",
     "attributeValues": {
-      "en_US": {
+      {
         "marker": {
           "value": "",
           "type": "string"
@@ -413,7 +483,7 @@ Example return:
 ### getCatalogPages
 
 ```
-const value = await Pages.getCatalogPages({langCode:'en_US', limit:20, offset:5})
+const value = await Pages.getCatalogPages(langCode = 'en_US', limit = 20, offset = 5)
 ```
 
 > 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.
@@ -432,7 +502,7 @@ Example return:
     "pageUrl": "string",
     "depth": 3,
     "localizeInfos": {
-      "en_US": {
+      {
         "title": "Catalog",
         "content": "Content from catalog",
         "menuTitle": "Catalog"
@@ -450,7 +520,7 @@ Example return:
     ],
     "templateIdentifier": "my-template",
     "attributeValues": {
-      "en_US": {
+      {
         "marker": {
           "value": "",
           "type": "string"
@@ -483,7 +553,7 @@ Example return:
     "pageUrl": "string",
     "depth": 3,
     "localizeInfos": {
-      "en_US": {
+      {
         "title": "Catalog",
         "content": "Content for catalog",
         "menuTitle": "Catalog"
@@ -501,7 +571,7 @@ Example return:
     ],
     "templateIdentifier": "my-template",
     "attributeValues": {
-      "en_US": {
+      {
         "marker": {
           "value": "",
           "type": "string"
@@ -528,7 +598,7 @@ const value = await Pages.getPageById(1, 'en_US')
   "pageUrl": "string",
   "depth": 3,
   "localizeInfos": {
-    "en_US": {
+    {
       "title": "Catalog",
       "content": "Content from catalog",
       "menuTitle": "Catalog"
@@ -546,7 +616,7 @@ const value = await Pages.getPageById(1, 'en_US')
   "templateIdentifier": "my-template",
   "attributeSetId": 7,
   "attributeValues": {
-    "en_US": {
+    {
       "marker": "opisanine",
       "type": "string",
       "value": ""
@@ -571,7 +641,7 @@ Example return:
   "pageUrl": "string",
   "depth": 3,
   "localizeInfos": {
-    "en_US": {
+    {
       "title": "Catalog",
       "content": "Content from catalog",
       "menuTitle": "Catalog"
@@ -589,7 +659,7 @@ Example return:
   "templateIdentifier": "my-template",
   "attributeSetId": 7,
   "attributeValues": {
-    "en_US": {
+    {
       "marker": "opisanine",
       "type": "string",
       "value": ""
@@ -599,6 +669,85 @@ Example return:
 }
 ```
 
+### getChildPagesByParentUrl
+
+```
+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:
+```
+{
+  "id": 1764,
+  "parentId": 0,
+  "config": {
+    "rowsPerPage": 1,
+    "productsPerRow": 1
+  },
+  "pageUrl": "string",
+  "depth": 3,
+  "localizeInfos": {
+    "en_US": {
+      "title": "Catalog",
+      "content": "Content for catalog",
+      "menuTitle": "Catalog"
+    }
+  },
+  "isVisible": true,
+  "products": 0,
+  "attributeSetId": 7,
+  "isSync": true,
+  "isEdit": true,
+  "userEditId": 0,
+  "position": 0,
+  "generalTypeId": 2,
+  "templateId": 0,
+  "attributesSets": {
+    "id7": 7,
+    "string_id18": ""
+  },
+  "childrenCount": 0,
+  "showChildren": true,
+  "version": 10
+}
+```
+
+### getFormsByPageUrl
+```
+const value = await Pages.getFormsByPageUrl('shop', 'en_US')
+```
+> Get PositionFormDto objects for a related form by url. Returns an array of PositionFormDto objects.
+```
+{
+  "id": 1764,
+  "updatedDate": "2023-11-12T12:51:45.623Z",
+  "version": 10,
+  "identifier": "marker",
+  "attributesSets": {
+    "string_id19": "",
+    "string_id18": ""
+  },
+  "attributeSetId": 0,
+  "processingType": "db",
+  "localizeInfos": {
+    "en_US": {
+      "title": "My form",
+      "titleForSite": "",
+      "successMessage": "",
+      "unsuccessMessage": "",
+      "urlAddress": "",
+      "database": "0",
+      "script": "0"
+    }
+  },
+  "processingData": {},
+  "position": 0,
+  "positionId": 12
+}
+```
+
+
 ### getConfigPageByUrl
 
 ```
@@ -628,7 +777,7 @@ Example return:
   {
   "id": 1764,
   "localizeInfos": {
-    "en_US": {
+    {
       "title": "Product"
     }
   },
@@ -653,7 +802,7 @@ Example return:
   "templateIdentifier": "my-template",
   "shortDescTemplateIdentifier": "my-template-short",
   "attributeValues": {
-    "en_US": {
+    {
       "marker": {
         "value": "",
         "type": "string"
@@ -681,32 +830,87 @@ This module accepts a set of user parameters called userQuery. If the parameters
     conditionValue: null,
     conditionMarker: null,
     attributeMarker: null,
-    langCode: 'en_US',
     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
 
+In some methods, the langcode parameter (default 'en_US') can be either a string or an array of strings. It depends on which set of values will contain "attributeValues" and "localizeInfos"
+
+Example
+
+```
+ const value = await Products.getProducts('en_US')
+ 
+ "localizeInfos": {
+      {
+        "title": "Catalog",
+        "content": "Content from catalog",
+        "menuTitle": "Catalog"
+      }
+ },
+ "attributeValues": {
+      {
+        "marker": {
+          "value": "Value",
+          "type": "string"
+        }
+      }
+ }   
+ ```
+Or
+```
+const value = await Products.getProducts([ 'en_US', 'it_IT' ])
+
+ "localizeInfos": {
+      en_US: {
+        "title": "Catalog",
+        "content": "Content from catalog",
+        "menuTitle": "Catalog"
+      },
+      it_IT: {
+        "title": "Catalogo",
+        "content": "Contenuto dal catalogo",
+        "menuTitle": "Catalogo"
+      }
+ },
+ "attributeValues": {
+      en_US: {
+        "marker": {
+          "value": "Value",
+          "type": "string"
+        }
+      },
+      it_IT: {
+        "marker": {
+          "value": "Valore",
+          "type": "string"
+        }
+      }
+ }
+```
+
+
 ### getProducts
 
 ```
-const value = await Products.getProducts()
+const value = await Products.getProducts('en_US')
 ```
 
 > 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[]).
@@ -716,7 +920,7 @@ Example return:
 {
   "id": 1764,
   "localizeInfos": {
-    "en_US": {
+    {
       "title": "Product"
     }
   },
@@ -741,7 +945,7 @@ Example return:
   "templateIdentifier": "my-template",
   "shortDescTemplateIdentifier": "my-template-short",
   "attributeValues": {
-    "en_US": {
+    {
       "marker": {
         "value": "",
         "type": "string"
@@ -754,7 +958,7 @@ Example return:
 ### getProductsEmptyPage
 
 ```
-const value = await Products.getProductsEmptyPage()
+const value = await Products.getProductsEmptyPage('en_US')
 ```
 
 > 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.
@@ -765,7 +969,7 @@ Example return:
 {
   "id": 1764,
   "localizeInfos": {
-    "en_US": {
+    {
       "title": "Product"
     }
   },
@@ -790,7 +994,7 @@ Example return:
   "templateIdentifier": "my-template",
   "shortDescTemplateIdentifier": "my-template-short",
   "attributeValues": {
-    "en_US": {
+    {
       "marker": {
         "value": "",
         "type": "string"
@@ -804,7 +1008,7 @@ Example return:
 ### getProductsPageById
 
 ```
-const value = await Products.getProductsPageById(1)
+const value = await Products.getProductsPageById(1, 'en_US')
 ```
 
 > 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.
@@ -814,7 +1018,7 @@ Example return:
 {
   "id": 1764,
   "localizeInfos": {
-    "en_US": {
+    {
       "title": "Product"
     }
   },
@@ -839,7 +1043,7 @@ Example return:
   "templateIdentifier": "my-template",
   "shortDescTemplateIdentifier": "my-template-short",
   "attributeValues": {
-    "en_US": {
+    {
       "marker": {
         "value": "",
         "type": "string"
@@ -853,7 +1057,7 @@ Example return:
 ### getProductsPageByUrl
 
 ```
-const value = await Products.getProductsPageByUrl('cup')
+const value = await Products.getProductsPageByUrl('cup', 'en_US')
 ```
 
 > 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.
@@ -863,7 +1067,7 @@ Example return:
 {
   "id": 1764,
   "localizeInfos": {
-    "en_US": {
+    {
       "title": "Product"
     }
   },
@@ -888,7 +1092,7 @@ Example return:
   "templateIdentifier": "my-template",
   "shortDescTemplateIdentifier": "my-template-short",
   "attributeValues": {
-    "en_US": {
+    {
       "marker": {
         "value": "",
         "type": "string"
@@ -902,7 +1106,7 @@ Example return:
 ### getRelatedProductsById
 
 ```
-const value = await Products.getRelatedProductsById(1)
+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.
@@ -912,7 +1116,7 @@ Example return:
 {
   "id": 1764,
   "localizeInfos": {
-    "en_US": {
+    {
       "title": "Product"
     }
   },
@@ -937,7 +1141,7 @@ Example return:
   "templateIdentifier": "my-template",
   "shortDescTemplateIdentifier": "my-template-short",
   "attributeValues": {
-    "en_US": {
+    {
       "marker": {
         "value": "",
         "type": "string"
@@ -950,7 +1154,7 @@ Example return:
 ### getProductById
 
 ```
-const value = await Products.getProductById(1)
+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.
@@ -960,7 +1164,7 @@ Example return:
 {
   "id": 1764,
   "localizeInfos": {
-    "en_US": {
+    {
       "title": "Product"
     }
   },
@@ -985,7 +1189,7 @@ Example return:
   "templateIdentifier": "my-template",
   "shortDescTemplateIdentifier": "my-template-short",
   "attributeValues": {
-    "en_US": {
+    {
       "marker": {
         "value": "",
         "type": "string"
@@ -1026,7 +1230,7 @@ Example return:
 {
   "id": 1764,
   "localizeInfos": {
-    "en_US": {
+    {
       "title": "Product"
     }
   },
@@ -1051,7 +1255,7 @@ Example return:
   "templateIdentifier": "my-template",
   "shortDescTemplateIdentifier": "my-template-short",
   "attributeValues": {
-    "en_US": {
+    {
       "marker": {
         "value": "",
         "type": "string"
@@ -1064,7 +1268,7 @@ Example return:
 ### searchProduct
 
 ```
-const value = await Products.searchProduct('cup')
+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.
@@ -1075,7 +1279,7 @@ Example return:
   {
   "id": 1764,
   "localizeInfos": {
-    "en_US": {
+    {
       "title": "Product"
     }
   },
@@ -1100,7 +1304,7 @@ Example return:
   "templateIdentifier": "my-template",
   "shortDescTemplateIdentifier": "my-template-short",
   "attributeValues": {
-    "en_US": {
+    {
       "marker": {
         "value": "",
         "type": "string"
@@ -1112,16 +1316,16 @@ Example return:
 ]
 ```
 
-## ProductStatus
+## ProductStatuses
 
 ```
-const { ProductStatus } = defineOneEntry('your-url');
+const { ProductStatuses } = defineOneEntry('your-url');
 ```
 
 ### getProductStatuses
 
 ```
-const value = await ProductStatus.getProductStatuses()
+const value = await ProductStatuses.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.
@@ -1145,7 +1349,7 @@ Example return:
 ### getProductStatusesById
 
 ```
-const value = await ProductStatus.getProductStatusesById(1)
+const value = await ProductStatuses.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.
@@ -1167,7 +1371,7 @@ Example return:
 ### getProductsByStatusMarker
 
 ```
-const value = await ProductStatus.getProductsByStatusMarker('marker')
+const value = await ProductStatuses.getProductsByStatusMarker('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.
@@ -1189,7 +1393,7 @@ Example return:
 ### validateMarker
 
 ```
-const value = await ProductStatus.validateMarker('marker')
+const value = await ProductStatuses.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.
@@ -1222,7 +1426,7 @@ Example return:
     "generalTypeId": 2,
     "generalTypeName": "forProductPreview",
     "localizeInfos": {
-      "ru_RU": {
+      "en_US": {
         "title": "Product"
       }
     },
@@ -1257,7 +1461,7 @@ Example return:
     "generalTypeId": 2,
     "generalTypeName": "forCatalogProducts",
     "localizeInfos": {
-      "ru_RU": {
+      "en_US": {
         "title": "Product"
       }
     },
@@ -1275,16 +1479,16 @@ Example return:
 ]
 ```
 
-## TemplatesPreview
+## TemplatePreviews
 
 ```
-const { TemplatesPreview } = defineOneEntry('your-url')
+const { TemplatePreviews } = defineOneEntry('your-url')
 ```
 
 ### getTemplatesPreview
 
 ```
-const value = await TemplatesPreview.getTemplatesPreview()
+const value = await TemplatePreviews.getTemplatesPreview()
 ```
 
 > This method retrieves all template objects from the API. It returns a Promise that resolves to an array of TemplatePreviewsEntity template objects.
@@ -1320,7 +1524,7 @@ Example return:
 ### getTemplatesPreviewById
 
 ```
-const value = await TemplatesPreview.getTemplatesPreviewById(1)
+const value = await TemplatePreviews.getTemplatesPreviewById(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.
@@ -1355,7 +1559,7 @@ Example return:
 ### getTemplatesPreviewByMarker
 
 ```
-const value = await TemplatesPreview.getTemplatesPreviewByMarker('marker')
+const value = await TemplatePreviews.getTemplatesPreviewByMarker('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.