oneentry 1.0.28 → 1.0.30

package/README.md

@@ -59,10 +59,10 @@ const api = defineOneEntry('your-url', 'your-token')
 const { Admins } = defineOneEntry('your-url')
 ```
 
-### Admins.getAdminsInfo()
+### Admins.getAdminsInfo(langCode, offset, limit)
 
 ```
-const value = await Admins.getAdminsInfo()
+const value = await Admins.getAdminsInfo('en_US', 0, 30)
 ```
 
 
@@ -71,28 +71,30 @@ const value = await Admins.getAdminsInfo()
 Example return:
 
 ```
-{
-  "id": 1764,
-  "identifier": "admin1",
-  "attributeSetId": 7,
-  "isSync": false,
-  "attributeValues": {
-    "en_US": {
-      "marker": {
-        "value": "",
-        "type": "string"
+[
+  {
+    "id": 1764,
+    "identifier": "admin1",
+    "attributeSetId": 7,
+    "isSync": false,
+    "attributeValues": {
+      "en_US": {
+        "marker": {
+          "value": "",
+          "type": "string"
+        }
       }
-    }
-  },
-  "position": 192
-}
+    },
+    "position": 192
+  }
+]
 ```
 
 ## FileUploading
 
 const { FileUploading } = defineOneEntry('your-url');
 
-### FileUploading.upload()
+### FileUploading.upload(data, fileQuery)
 
 ```
 const query = {
@@ -113,14 +115,16 @@ const value = await FileUploading.upload(data, query)
 Example return:
 
 ```
-{
-  "filename": "string",
-  "downloadLink": "string",
-  "size": 0
-}
+[
+  {
+    "filename": "string",
+    "downloadLink": "string",
+    "size": 0
+  }
+]
 ```
 
-### FileUploading.delete()
+### FileUploading.delete(filename, fileQuery)
 
 ```
 const query = {
@@ -135,14 +139,29 @@ 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)
+```
+const value = await FileUploading.getFile(123, 'page', 'editor', 'file.png')
+```
+
+> This method return file object by parameters.
+
+Example return:
+
+```
+{
+  "file": File,
+}
+```
+
 ## Forms
 
 const { Forms } = defineOneEntry('your-url');
 
-### Forms.getAllForms()
+### Forms.getAllForms(langCode, offset, limit)
 
 ```
-const value = await Forms.getAllForms()
+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.
@@ -157,7 +176,7 @@ Example return:
     "processingType": "email",
     "localizeInfos": {
       "en_US": {
-        "title": "My form",
+        "title": "My Form",
         "titleForSite": "",
         "successMessage": "",
         "unsuccessMessage": "",
@@ -167,25 +186,44 @@ Example return:
       }
     },
     "processingData": "Unknown Type: ProcessingData",
-    "attributeValues": {
-      "en_US": {
-        "marker": {
-          "value": "",
-          "type": "string"
-        }
-      }
-    },
     "version": 10,
     "identifier": "catalog",
-    "position": 192
+    "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"
+        }
+      }
+    ]
   }
 ]
 ```
 
-### Forms.getFormByMarker()
+### Forms.getFormByMarker(marker, langCode)
 
 ```
-const value = await Forms.getFormByMarker('My form')
+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.
@@ -199,7 +237,7 @@ Example return:
   "processingType": "email",
   "localizeInfos": {
     "en_US": {
-      "title": "My form",
+      "title": "My Form",
       "titleForSite": "",
       "successMessage": "",
       "unsuccessMessage": "",
@@ -209,17 +247,36 @@ Example return:
     }
   },
   "processingData": "Unknown Type: ProcessingData",
-  "attributeValues": {
-    "en_US": {
-      "marker": {
-        "value": "",
-        "type": "string"
-      }
-    }
-  },
   "version": 10,
   "identifier": "catalog",
-  "position": 192
+  "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"
+      }
+    }
+  ]
 }
 ```
 
@@ -227,7 +284,7 @@ Example return:
 
 const { FormData } = defineOneEntry('your-url');
 
-### FormData.postFormsData()
+### FormData.postFormsData(data)
 
 ```
 const value = await FormData.postFormsData(data)
@@ -253,10 +310,10 @@ Example return:
 }
 ```
 
-### FormData.getFormsData()
+### FormData.getFormsData(langCode, offset, limit)
 
 ```
-const value = await FormData.getFormsData()
+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.
@@ -264,27 +321,26 @@ const value = await FormData.getFormsData()
 Example return:
 
 ```
-[
-    {
-      "id": 1764,
-      "formIdentifier": "my-form",
-      "time": "2023-02-12 10:56",
-      "formData": {
-        "en_US": [
-          {
-            "marker": "naimenovanie_1",
-            "value": "Name"
-          }
-        ]
+{
+  "id": 1764,
+  "formIdentifier": "my-form",
+  "time": "2023-02-12 10:56",
+  "formData": {
+    "en_US": [
+      {
+        "marker": "name_1",
+        "value": "Name"
       }
-    }
-]
+    ]
+  },
+  "attributeSetIdentifier": "test-form"
+}
 ```
 
-### FormData.getFormsDataByMarker()
+### FormData.getFormsDataByMarker(marker, langCode, offset, limit)
 
 ```
-const value = await FormData.getFormsDataByMarker('my-marker')
+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.
@@ -303,7 +359,8 @@ Example return:
         "value": "Name"
       }
     ]
-  }
+  },
+  "attributeSetIdentifier": "test-form"
 }
 ```
 
@@ -367,10 +424,10 @@ Example return:
 const { Menus } = defineOneEntry('your-url')
 ```
 
-### Menus.getMenusByMarker()
+### Menus.getMenusByMarker(marker)
 
 ```
-const value = await Menus.getMenusByMarker('marker')
+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.
@@ -467,7 +524,7 @@ const value = await Pages.getRootPages([ 'en_US', 'it_IT' ])
  }
 ```
 
-### Pages.getRootPages()
+### Pages.getRootPages(langCode)
 
 ```
 const value = await Pages.getRootPages('en_US')
@@ -515,10 +572,10 @@ Example return:
 ]
 ```
 
-### Pages.getCatalogPages()
+### Pages.getCatalogPages(langCode, limit, offset)
 
 ```
-const value = await Pages.getCatalogPages(langCode = 'en_US', limit = 20, offset = 5)
+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.
@@ -563,7 +620,7 @@ Example return:
 ]
 ```
 
-### Pages.getPages()
+### Pages.getPages(langCode)
 
 ```
 const value = await Pages.getPages('en_US')
@@ -611,7 +668,7 @@ Example return:
 ]
 ```
 
-### Pages.getPageById()
+### Pages.getPageById(id, langCode)
 
 ```
 const value = await Pages.getPageById(1, 'en_US')
@@ -651,7 +708,7 @@ Example return:
 }
 ```
 
-### Pages.getPageByUrl()
+### Pages.getPageByUrl(url, langCode)
 
 ```
 const value = await Pages.getPageByUrl('shop', 'en_US')
@@ -691,7 +748,7 @@ Example return:
 }
 ```
 
-### Pages.getChildPagesByParentUrl()
+### Pages.getChildPagesByParentUrl(url, langCode)
 
 ```
 const value = await Pages.getChildPagesByParentUrl('shop', 'en_US')
@@ -733,7 +790,7 @@ Example return:
 ]
 ```
 
-### Pages.getFormsByPageUrl()
+### Pages.getFormsByPageUrl(url, langCode)
 
 ```
 const value = await Pages.getFormsByPageUrl('shop', 'en_US')
@@ -744,38 +801,58 @@ const value = await Pages.getFormsByPageUrl('shop', 'en_US')
 Example return:
 
 ```
-{
-  "id": 1764,
-  "version": 10,
-  "identifier": "catalog",
-  "attributeSetId": 0,
-  "processingType": "email",
-  "localizeInfos": {
-    "en_US": {
-      "title": "My form",
-      "titleForSite": "",
-      "successMessage": "",
-      "unsuccessMessage": "",
-      "urlAddress": "",
-      "database": "0",
-      "script": "0"
-    }
-  },
-  "processingData": {},
-  "position": 0,
-  "isSync": false,
-  "attributeValues": {
-    "en_US": {
-      "marker": {
-        "value": "",
-        "type": "string"
+[
+  {
+    "id": 1764,
+    "version": 10,
+    "identifier": "catalog",
+    "attributeSetId": 0,
+    "processingType": "email",
+    "localizeInfos": {
+      "en_US": {
+        "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"
+        }
+      }
+    ]
   }
-}
+]
 ```
 
-### Pages.getConfigPageByUrl()
+### Pages.getConfigPageByUrl(url)
 
 ```
 const value = await Pages.getConfigPageByUrl('shop')
@@ -792,7 +869,7 @@ Example return:
 }
 ```
 
-### Pages.searchPage()
+### Pages.searchPage(name, langCode)
 
 ```
 const value = await Pages.searchPage('cup', 'en_US')
@@ -845,7 +922,7 @@ const { Products } = defineOneEntry('your-url')
 Parameters:
 
 ```
-{
+const userQuery = {
     offset: 0,
     limit: 30,
     statusMarker: null,
@@ -931,10 +1008,10 @@ const value = await Products.getProducts([ 'en_US', 'it_IT' ])
  }
 ```
 
-### Products.getProducts()
+### Products.getProducts(langCode, userQuery)
 
 ```
-const value = await Products.getProducts('en_US')
+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[]).
@@ -975,10 +1052,10 @@ Example return:
 ]
 ```
 
-### Products.getProductsEmptyPage()
+### Products.getProductsEmptyPage(langCode, userQuery)
 
 ```
-const value = await Products.getProductsEmptyPage('en_US')
+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.
@@ -1019,10 +1096,10 @@ Example return:
 ]
 ```
 
-### Products.getProductsPageById()
+### Products.getProductsPageById(id, langCode, userQuery)
 
 ```
-const value = await Products.getProductsPageById(1, 'en_US')
+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.
@@ -1069,10 +1146,10 @@ Example return:
 }
 ```
 
-### Products.getProductsPageByUrl()
+### Products.getProductsPageByUrl(url, langCode, userQuery)
 
 ```
-const value = await Products.getProductsPageByUrl('cup', 'en_US')
+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.
@@ -1119,10 +1196,10 @@ Example return:
 }
 ```
 
-### Products.getRelatedProductsById()
+### Products.getRelatedProductsById(id, langCode, userQuery)
 
 ```
-const value = await Products.getRelatedProductsById(1, ''en_US'', {limit:20, offset: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.
@@ -1161,7 +1238,7 @@ Example return:
 }
 ```
 
-### Products.getProductById()
+### Products.getProductById(id, langCode)
 
 ```
 const value = await Products.getProductById(1, 'en_US')
@@ -1204,10 +1281,16 @@ Example return:
 
 ```
 
-### Products.filterProduct()
+### Products.filterProduct(data, langCode, userQuery)
 
 ```
-const value = await Products.filterProduct({conditionValue:1})
+  const data = {
+        attributeMarker: "price",
+        conditionMarker: "lth",
+        conditionValue: "200",
+    }
+
+const value = await Products.filterProduct(data, 'en_US', userQuery)
 ```
 
 Example body:
@@ -1273,7 +1356,7 @@ Example return:
 }
 ```
 
-### Products.searchProduct()
+### Products.searchProduct(name, langCode)
 
 ```
 const value = await Products.searchProduct('cup', 'en_US')
@@ -1357,7 +1440,7 @@ Example return:
 ]
 ```
 
-### ProductStatuses.getProductStatusesById()
+### ProductStatuses.getProductStatusesById(id)
 
 ```
 const value = await ProductStatuses.getProductStatusesById(1)
@@ -1381,10 +1464,10 @@ Example return:
 }
 ```
 
-### ProductStatuses.getProductsByStatusMarker()
+### ProductStatuses.getProductsByStatusMarker(marker)
 
 ```
-const value = await ProductStatuses.getProductsByStatusMarker('marker')
+const value = await ProductStatuses.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.
@@ -1405,7 +1488,7 @@ Example return:
 }
 ```
 
-### ProductStatuses.validateMarker()
+### ProductStatuses.validateMarker(marker)
 
 ```
 const value = await ProductStatuses.validateMarker('marker')
@@ -1460,9 +1543,9 @@ Example return:
 
 ```
 [
-  {
+   {
       "id": 1764,
-      "updatedDate": "2023-11-20T22:16:17.531Z",
+      "updatedDate": "2023-12-05T12:47:02.859Z",
       "version": 10,
       "identifier": "marker",
       "generalType": {
@@ -1482,7 +1565,7 @@ Example return:
 ]
 ```
 
-### Templates.getTemplateByType()
+### Templates.getTemplateByType(type)
 
 ```
 const value = await Templates.getTemplateByType('forCatalogProducts')
@@ -1496,25 +1579,22 @@ Example return:
 [
   {
     "id": 1764,
-    "identifier": "admin1",
-    "attributeSetId": 7,
-    "generalTypeId": 2,
-    "generalTypeName": "forCatalogProducts",
-    "localizeInfos": {
-      "en_US": {
-        "title": "Product"
-      }
+    "updatedDate": "2023-12-05T12:45:13.566Z",
+    "version": 10,
+    "identifier": "marker",
+    "generalType": {
+      "id": 4,
+      "type": "forCatalogPages"
     },
-    "isSync": false,
-    "attributeValues": {
+    "generalTypeId": 4,
+    "localizeInfos": {
       "en_US": {
-        "marker": {
-          "value": "",
-          "type": "string"
-        }
+        "title": "Page template"
       }
     },
-    "position": 192
+    "position": 0,
+    "positionId": 12,
+    "generalTypeName": "forProductPreview"
   }
 ]
 ```
@@ -1538,43 +1618,43 @@ Example return:
 ```
 [
   {
-      "id": 1764,
-      "updatedDate": "2023-11-20T22:18:25.344Z",
-      "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"
-        }
+    "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"
       },
-      "localizeInfos": {
-        "en_US": {
-          "title": "Page Template"
-        }
+      "vertical": {
+        "height": 10,
+        "weight": 200,
+        "marker": "vertical",
+        "title": "Vertical",
+        "alignmentType": "left"
       },
-      "position": 0
+      "square": {
+        "marker": "square",
+        "title": "Square",
+        "slide": 3,
+        "alignmentType": "center"
+      }
+    },
+    "localizeInfos": {
+      "en_US": {
+        "title": "Page Template"
+      }
+    },
+    "position": 0
   }
 ]
 ```
 
-### TemplatePreviews.getTemplatesPreviewById()
+### TemplatePreviews.getTemplatesPreviewById(id)
 
 ```
 const value = await TemplatePreviews.getTemplatesPreviewById(1)
@@ -1585,47 +1665,46 @@ const value = await TemplatePreviews.getTemplatesPreviewById(1)
 Example return:
 
 ```
-  {
-      "id": 1764,
-      "updatedDate": "2023-11-20T22:18:25.344Z",
-      "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": {
-        "en_US": {
-          "title": "Page Template"
-        }
-      },
-      "position": 0
-  }
- 
+{
+  "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": {
+    "en_US": {
+      "title": "Page Template"
+    }
+  },
+  "position": 0
+}
 ```
 
-### TemplatePreviews.getTemplatesPreviewByMarker()
+### TemplatePreviews.getTemplatesPreviewByMarker(marker)
 
 ```
-const value = await TemplatePreviews.getTemplatesPreviewByMarker('marker')
+const value = await TemplatePreviews.getTemplatesPreviewByMarker('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.
@@ -1635,7 +1714,7 @@ Example return:
 ```
 {
   "id": 1764,
-  "updatedDate": "2023-11-20T22:18:25.344Z",
+  "updatedDate": "2023-12-05T12:44:20.008Z",
   "version": 10,
   "identifier": "marker",
   "proportion": {