oneentry 1.0.21 → 1.0.23

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +9 -2
  2. package/package.json +2 -3
package/README.md CHANGED
@@ -184,7 +184,7 @@ const value = await FormData.postFormsData(data)
184
184
 
185
185
  >The method takes as a parameter request body
186
186
 
187
- Example
187
+ Example body:
188
188
  ```
189
189
  {
190
190
  "formIdentifier": "my-form",
@@ -374,7 +374,7 @@ const { Pages } = defineOneEntry('your-url')
374
374
  ```
375
375
  > 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"
376
376
 
377
- Example
377
+ Example:
378
378
 
379
379
  ```
380
380
  const value = await Pages.getRootPages('en_US')
@@ -591,6 +591,8 @@ const value = await Pages.getPageById(1, 'en_US')
591
591
 
592
592
  > 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.
593
593
 
594
+ Example return:
595
+
594
596
  ```
595
597
  {
596
598
  "id": 1764,
@@ -718,6 +720,8 @@ Example return:
718
720
  const value = await Pages.getFormsByPageUrl('shop', 'en_US')
719
721
  ```
720
722
  > Get PositionFormDto objects for a related form by url. Returns an array of PositionFormDto objects.
723
+
724
+ Example return:
721
725
  ```
722
726
  {
723
727
  "id": 1764,
@@ -822,6 +826,8 @@ const { Products } = defineOneEntry('your-url')
822
826
 
823
827
  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.
824
828
 
829
+ Parameters:
830
+
825
831
  ```
826
832
  {
827
833
  offset: 0,
@@ -834,6 +840,7 @@ This module accepts a set of user parameters called userQuery. If the parameters
834
840
  sortKey: 'id'
835
841
  }
836
842
  ```
843
+
837
844
  "conditionMarker" by which values are filtered (not set by default), possible values:
838
845
  > 'in' - Contains,
839
846
  >
package/package.json CHANGED
@@ -1,17 +1,16 @@
1
1
  {
2
2
  "name": "oneentry",
3
- "version": "1.0.21",
3
+ "version": "1.0.23",
4
4
  "description": "",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
7
7
  "files": [
8
8
  "/dist"
9
9
  ],
10
-
11
10
  "author": "ONEENTRY PORTAL CO.",
12
11
  "license": "ISC",
13
12
  "dependencies": {
14
13
  "jsdoc": "^4.0.2",
15
14
  "typescript": "^5.2.2"
16
15
  }
17
- }
16
+ }