oneentry 1.0.34 → 1.0.36

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.
package/README.md CHANGED
@@ -33,6 +33,7 @@ const {
33
33
  FileUploading,
34
34
  GeneralTypes,
35
35
  Locales,
36
+ Markers,
36
37
  Menus,
37
38
  Pages,
38
39
  Products,
@@ -51,18 +52,34 @@ const api = defineOneEntry('your-url')
51
52
 
52
53
  >If you chose token protection to ensure connection security, just pass your token to the function as an optional parameter.
53
54
 
55
+ You can get a token as follows
56
+ 1) Log in to your personal account
57
+ 2) Go to the "Projects" tab and select a project
58
+ 3) Go to the "Access" tab
59
+ 4) Set the switch to "Security API Token"
60
+ 5) Log in to the project, go to the settings section and open the token tab
61
+ 6) Get and copy the token of your project
62
+
63
+ Also, you can connect a tls certificate to secure your project. In this case, do not transfer the "token" at all.
64
+ [Learn more about security](https://oneentry.ru/instructions.html#START)
65
+
66
+
54
67
  ```js
55
68
  const api = defineOneEntry('your-url', 'your-token')
56
69
  ```
57
70
 
71
+
72
+
58
73
  ## Admins
59
74
 
75
+
60
76
  ```js
61
77
  const { Admins } = defineOneEntry('your-url')
62
78
  ```
63
79
 
64
80
  ### Admins.getAdminsInfo(langCode, offset, limit)
65
81
 
82
+
66
83
  ```js
67
84
  const value = await Admins.getAdminsInfo('en_US', 0, 30)
68
85
  ```
@@ -70,6 +87,7 @@ const value = await Admins.getAdminsInfo('en_US', 0, 30)
70
87
 
71
88
  > This method retrieves all user objects of type admin from the API. It returns a Promise that resolves to an array of AdminEntity objects.
72
89
 
90
+
73
91
  Example return:
74
92
 
75
93
  ```json
@@ -80,17 +98,48 @@ Example return:
80
98
  "attributeSetId": 7,
81
99
  "isSync": false,
82
100
  "attributeValues": {
83
- "en_US": {
84
- "marker": {
85
- "value": "",
86
- "type": "string"
87
- }
101
+ "marker": {
102
+ "value": "",
103
+ "type": "string"
88
104
  }
89
105
  },
90
106
  "position": 192
91
107
  }
92
108
  ]
93
109
  ```
110
+ <details>
111
+ <summary>Schema</summary>
112
+
113
+ **id:** number <br>
114
+ *object identifier*
115
+ example: 1764 <br>
116
+
117
+ **identifier:** string <br>
118
+ *textual identifier for the record field* <br>
119
+ example: admin1 <br>
120
+ default: admin1 <br>
121
+
122
+ **attributeSetId:** number <br>
123
+ *Attribute set identifier* <br>
124
+ example: 7
125
+
126
+ **isSync** boolean <br>
127
+ *Page indexing flag (true or false)* <br>
128
+ example: false
129
+
130
+ **attributeValues:** Record<string, string> <br>
131
+ *Array of attribute values from the index (presented as a pair of user attribute identifier: attribute value)* <br>
132
+ example: OrderedMap { "en_US": OrderedMap { "marker": OrderedMap { "value": "", "type": "string" } } } <br>
133
+
134
+ **position:** number <br>
135
+ *Position number (for sorting)* <br>
136
+ example: 192
137
+
138
+ </details>
139
+
140
+ ---
141
+
142
+
94
143
 
95
144
  ## AttributesSets
96
145
 
@@ -106,8 +155,10 @@ const value = await AttributesSets.getAttributesByMarker('my-marker', 'en_US')
106
155
 
107
156
  > This method return all attributes with data from the attribute sets.
108
157
 
158
+
109
159
  Example return:
110
160
 
161
+
111
162
  ```json
112
163
  [
113
164
  {
@@ -145,6 +196,38 @@ Example return:
145
196
  ]
146
197
  ```
147
198
 
199
+ <details>
200
+ <summary>Schema</summary>
201
+
202
+ **type:** string <br>
203
+ *attribute type* <br>
204
+ example: list <br>
205
+
206
+ **marker:** string <br>
207
+ *textual identifier of the attribute (marker)* <br>
208
+ Enum:
209
+ [ string, text, textWithHeader, integer, real, float, dateTime, date, time, file, image, groupOfImages, radioButton, list, button ]
210
+ example: list1
211
+
212
+ **position:** number <br>
213
+ *position number for sorting* <br>
214
+ example: 192 <br>
215
+
216
+ **validators:** Record<string, any> <br>
217
+ *set of validators for validation* <br>
218
+ example: OrderedMap { "requiredValidator": OrderedMap { "strict": true }, "defaultValueValidator": OrderedMap { "fieldDefaultValue": 11 } }
219
+
220
+ **localizeInfos:** Record<string, any> <br>
221
+ *localization data for the set (name)* <br>
222
+ example: OrderedMap { "title": "My attribute" } <br>
223
+
224
+ **listTitles** Record<string, any> <br>
225
+ *array of values (with extended data) for list and radioButton attributes* <br>
226
+ example: List [ OrderedMap { "title": "red", "value": 1, "position": 1, "extendedValue": null, "extendedValueType": null }, OrderedMap { "title": "yellow", "value": 2, "position": 2, "extendedValue": null, "extendedValueType": null } ]
227
+
228
+ </details>
229
+
230
+
148
231
  ### AttributesSets.getSingleAttributeByMarkerSet(attributeMarker, setMarker, langCode)
149
232
 
150
233
  ```js
@@ -153,6 +236,7 @@ const value = await AttributesSets.getSingleAttributeByMarkerSet('list1', 'list1
153
236
 
154
237
  > This method return a single attribute with data from the attribute sets.
155
238
 
239
+
156
240
  Example return:
157
241
 
158
242
  ```json
@@ -189,65 +273,45 @@ Example return:
189
273
  ]
190
274
  }
191
275
  ```
276
+ <details>
277
+ <summary>Schema</summary>
192
278
 
279
+ **type:** string <br>
280
+ *attribute type* <br>
281
+ example: list <br>
193
282
 
194
- ## Blocks
283
+ **marker:** string <br>
284
+ *textual identifier of the attribute (marker)* <br>
285
+ Enum:
286
+ [ string, text, textWithHeader, integer, real, float, dateTime, date, time, file, image, groupOfImages, radioButton, list, button ]
287
+ example: list1
195
288
 
196
- ```js
197
- const { Blocks } = defineOneEntry('your-url');
198
- ```
289
+ **position:** number <br>
290
+ *position number for sorting* <br>
291
+ example: 192 <br>
199
292
 
200
- ### Blocks.getBlocks(langCode, offset, limit)
293
+ **validators:** Record<string, any> <br>
294
+ *set of validators for validation* <br>
295
+ example: OrderedMap { "requiredValidator": OrderedMap { "strict": true }, "defaultValueValidator": OrderedMap { "fieldDefaultValue": 11 } }
201
296
 
202
- ```js
203
- const value = await Blocks.getBlocks('en_US', 0, 30)
204
- ```
297
+ **localizeInfos:** Record<string, any> <br>
298
+ *localization data for the set (name)* <br>
299
+ example: OrderedMap { "title": "My attribute" } <br>
205
300
 
206
- > This method return all blocks objects.
301
+ **listTitles** Record<string, any> <br>
302
+ *array of values (with extended data) for list and radioButton attributes* <br>
303
+ example: List [ OrderedMap { "title": "red", "value": 1, "position": 1, "extendedValue": null, "extendedValueType": null }, OrderedMap { "title": "yellow", "value": 2, "position": 2, "extendedValue": null, "extendedValueType": null } ]
207
304
 
208
- Example return:
305
+ </details>
209
306
 
210
- ```json
211
- [
212
- {
213
- "id": 1764,
214
- "attributeSetId": 7,
215
- "localizeInfos": {
216
- "en_US": {
217
- "title": "My block"
218
- }
219
- },
220
- "customSettings": {
221
- "sliderDelay": 0,
222
- "sliderDelayType": "",
223
- "productQuantity": 4,
224
- "productSortType": "By_ID",
225
- "productSortOrder": "Descending",
226
- "productCountElementsPerRow": 10,
227
- "similarProductRules": [
228
- {
229
- "property": "Descending",
230
- "includes": "",
231
- "keywords": "",
232
- "strict": ""
233
- }
234
- ]
235
- },
236
- "version": 10,
237
- "identifier": "catalog",
238
- "position": 192,
239
- "attributeValues": {
240
- "en_US": {
241
- "marker": {
242
- "value": "",
243
- "type": "string"
244
- }
245
- }
246
- },
247
- "type": "forNewsPage",
248
- "templateIdentifier": null
249
- }
250
- ]
307
+ ---
308
+
309
+
310
+
311
+ ## Blocks
312
+
313
+ ```js
314
+ const { Blocks } = defineOneEntry('your-url');
251
315
  ```
252
316
 
253
317
  ### Blocks.getBlockByMarker(marker, langCode)
@@ -265,9 +329,7 @@ Example return:
265
329
  "id": 1764,
266
330
  "attributeSetId": 7,
267
331
  "localizeInfos": {
268
- "en_US": {
269
- "title": "My block"
270
- }
332
+ "title": "My block"
271
333
  },
272
334
  "customSettings": {
273
335
  "sliderDelay": 0,
@@ -289,11 +351,9 @@ Example return:
289
351
  "identifier": "catalog",
290
352
  "position": 192,
291
353
  "attributeValues": {
292
- "en_US": {
293
- "marker": {
294
- "value": "",
295
- "type": "string"
296
- }
354
+ "marker": {
355
+ "value": "",
356
+ "type": "string"
297
357
  }
298
358
  },
299
359
  "type": "forNewsPage",
@@ -301,6 +361,58 @@ Example return:
301
361
  }
302
362
  ```
303
363
 
364
+ <details>
365
+ <summary>Schema</summary>
366
+
367
+ **id:** number <br>
368
+ *object identifier*
369
+ example: 1764 <br>
370
+
371
+ **attributeSetId:** number <br>
372
+ *identifier for the used attribute set* <br>
373
+ example: 7
374
+
375
+ **localizeInfos:** CommonLocalizeInfos <br>
376
+ *block name with localization* <br>
377
+ example: OrderedMap { "en_US": OrderedMap { "title": "My block" } }
378
+
379
+ **customSettings:** BlockCustomSettings <br>
380
+ *custom settings for different block types* <br>
381
+ example: OrderedMap { "sliderDelay": 0, "sliderDelayType": "", "productQuantity": 4, "productSortType": "By_ID", "productSortOrder": "Descending", "productCountElementsPerRow": 10, "similarProductRules": List [ OrderedMap { "property": "Descending", "includes": "", "keywords": "", "strict": "" } ] }
382
+
383
+ **version:** number <br>
384
+ *object version number* <br>
385
+ example: 10
386
+
387
+ **identifier:** string <br>
388
+ *textual identifier for the field record* <br>
389
+ example: catalog <br>
390
+ default: marker
391
+
392
+ **position:** number <br>
393
+ *position number (for sorting)* <br>
394
+ example: 192
395
+
396
+ **attributeValues:** Record<string, string> <br>
397
+ *array of attribute values from the index (presented as a pair of custom attribute identifier: attribute value)* <br>
398
+ example: OrderedMap { "en_US": OrderedMap { "marker": OrderedMap { "value": "", "type": "string" } } }
399
+
400
+ **type:** string <br>
401
+ *block type* <br>
402
+ example: forNewsPage
403
+
404
+ **templateIdentifier:** string <br>
405
+ *template marker used by the block (can be null)* <br>
406
+ Enum:
407
+ [ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ]
408
+ example: null
409
+
410
+ </details>
411
+ ---
412
+
413
+
414
+
415
+
304
416
  ## FileUploading
305
417
 
306
418
  const { FileUploading } = defineOneEntry('your-url');
@@ -335,6 +447,20 @@ Example return:
335
447
  ]
336
448
  ```
337
449
 
450
+ <details>
451
+ <summary>Schema</summary>
452
+
453
+ **filename:** string <br>
454
+ *filename with relative path*
455
+
456
+ **downloadLink:** string <br>
457
+ *link for downloading the file*
458
+
459
+ **size** number <br>
460
+ *size of the file in bytes*
461
+
462
+ </details>
463
+
338
464
  ### FileUploading.delete(filename, fileQuery)
339
465
 
340
466
  ```js
@@ -366,6 +492,11 @@ Example return:
366
492
  }
367
493
  ```
368
494
 
495
+ ---
496
+
497
+
498
+
499
+
369
500
  ## Forms
370
501
 
371
502
  const { Forms } = defineOneEntry('your-url');
@@ -387,15 +518,13 @@ Example return:
387
518
  "attributeSetId": 0,
388
519
  "processingType": "email",
389
520
  "localizeInfos": {
390
- "en_US": {
391
- "title": "My Form",
392
- "titleForSite": "",
393
- "successMessage": "",
394
- "unsuccessMessage": "",
395
- "urlAddress": "",
396
- "database": "0",
397
- "script": "0"
398
- }
521
+ "title": "My Form",
522
+ "titleForSite": "",
523
+ "successMessage": "",
524
+ "unsuccessMessage": "",
525
+ "urlAddress": "",
526
+ "database": "0",
527
+ "script": "0"
399
528
  },
400
529
  "processingData": "Unknown Type: ProcessingData",
401
530
  "version": 10,
@@ -431,6 +560,48 @@ Example return:
431
560
  }
432
561
  ]
433
562
  ```
563
+ <details>
564
+ <summary>Schema</summary>
565
+
566
+ **id:** number <br>
567
+ *object identifier* <br>
568
+ example: 1764
569
+
570
+ **attributeSetId:** number <br>
571
+ *identifier of the attribute set used* <br>
572
+
573
+ **processingType:** string <br>
574
+ *form processing type* <br>
575
+ example: email
576
+
577
+ **localizeInfos:** FormLocalizeInfos <br>
578
+ *form name with localization* <br>
579
+ Enum:
580
+ [ db, email, script ]
581
+ example: OrderedMap { "en_US": OrderedMap { "title": "My Form", "titleForSite": "", "successMessage": "", "unsuccessMessage": "", "urlAddress": "", "database": "0", "script": "0" } }
582
+
583
+ **processingData:** ProcessingData <br>
584
+ *form data*
585
+
586
+ **version:** number <br>
587
+ *object version number* <br>
588
+ example: 10
589
+
590
+ **identifier:** string <br>
591
+ *textual identifier for the record field* <br>
592
+ example: catalog
593
+ default: marker
594
+
595
+ **position:** number <br>
596
+ *position number (for sorting)* <br>
597
+ example: 192
598
+
599
+ **attributes:** <br>
600
+ *array of attribute values from the used attribute set for displaying the form (taking into account the specified language)* <br>
601
+ 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" } } ]
602
+
603
+ </details>
604
+
434
605
 
435
606
  ### Forms.getFormByMarker(marker, langCode)
436
607
 
@@ -448,15 +619,13 @@ Example return:
448
619
  "attributeSetId": 0,
449
620
  "processingType": "email",
450
621
  "localizeInfos": {
451
- "en_US": {
452
- "title": "My Form",
453
- "titleForSite": "",
454
- "successMessage": "",
455
- "unsuccessMessage": "",
456
- "urlAddress": "",
457
- "database": "0",
458
- "script": "0"
459
- }
622
+ "title": "My Form",
623
+ "titleForSite": "",
624
+ "successMessage": "",
625
+ "unsuccessMessage": "",
626
+ "urlAddress": "",
627
+ "database": "0",
628
+ "script": "0"
460
629
  },
461
630
  "processingData": "Unknown Type: ProcessingData",
462
631
  "version": 10,
@@ -491,6 +660,51 @@ Example return:
491
660
  ]
492
661
  }
493
662
  ```
663
+ <details>
664
+ <summary>Schema</summary>
665
+
666
+ **id:** number <br>
667
+ *object identifier* <br>
668
+ example: 1764
669
+
670
+ **attributeSetId:** number <br>
671
+ *identifier of the attribute set used* <br>
672
+
673
+ **processingType:** string <br>
674
+ *form processing type* <br>
675
+ example: email
676
+
677
+ **localizeInfos:** FormLocalizeInfos <br>
678
+ *form name with localization* <br>
679
+ Enum:
680
+ [ db, email, script ]
681
+ example: OrderedMap { "en_US": OrderedMap { "title": "My Form", "titleForSite": "", "successMessage": "", "unsuccessMessage": "", "urlAddress": "", "database": "0", "script": "0" } }
682
+
683
+ **processingData:** ProcessingData <br>
684
+ *form data*
685
+
686
+ **version:** number <br>
687
+ *object version number* <br>
688
+ example: 10
689
+
690
+ **identifier:** string <br>
691
+ *textual identifier for the record field* <br>
692
+ example: catalog
693
+ default: marker
694
+
695
+ **position:** number <br>
696
+ *position number (for sorting)* <br>
697
+ example: 192
698
+
699
+ **attributes:** <br>
700
+ *array of attribute values from the used attribute set for displaying the form (taking into account the specified language)* <br>
701
+ 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" } } ]
702
+
703
+ </details>
704
+
705
+ ---
706
+
707
+
494
708
 
495
709
  ## FormData
496
710
 
@@ -512,15 +726,31 @@ Example return:
512
726
  "formIdentifier": "my-form",
513
727
  "time": "2023-02-12 10:56",
514
728
  "formData": {
515
- "en_US": [
516
- {
517
- "marker": "name_1",
518
- "value": "Name"
519
- }
520
- ]
729
+ "marker": "name_1",
730
+ "value": "Name"
521
731
  }
522
732
  }
523
733
  ```
734
+ <details>
735
+ <summary>Schema</summary>
736
+
737
+ **id:** number <br>
738
+ *object identifier* <br>
739
+ example: 1764
740
+
741
+ **formIdentifier:** string <br>
742
+ *Text identifier of the form object (marker)* <br>
743
+ example: my-form
744
+
745
+ **time:** Date <br>
746
+ *Date and time of form modification* <br>
747
+ example: 2023-02-12 10:56
748
+
749
+ **formData:** FormDataLangType <br>
750
+ *Data submitted by the form* <br>
751
+ example: OrderedMap { "en_US": List [ OrderedMap { "marker": "naimenovanie_1", "value": "Name" } ] }
752
+
753
+ </details>
524
754
 
525
755
  ### FormData.getFormsData(langCode, offset, limit)
526
756
 
@@ -538,17 +768,39 @@ Example return:
538
768
  "formIdentifier": "my-form",
539
769
  "time": "2023-02-12 10:56",
540
770
  "formData": {
541
- "en_US": [
542
- {
543
- "marker": "name_1",
544
- "value": "Name"
545
- }
546
- ]
771
+ "marker": "name_1",
772
+ "value": "Name"
547
773
  },
548
774
  "attributeSetIdentifier": "test-form"
549
775
  }
550
776
  ```
551
777
 
778
+ <details>
779
+ <summary>Schema</summary>
780
+
781
+ **id:** number <br>
782
+ *object identifier* <br>
783
+ example: 1764
784
+
785
+ **formIdentifier:** string <br>
786
+ *Text identifier of the form object (marker)* <br>
787
+ example: my-form
788
+
789
+ **time:** Date <br>
790
+ *Date and time of form modification* <br>
791
+ example: 2023-02-12 10:56
792
+
793
+ **formData:** FormDataLangType <br>
794
+ *Data submitted by the form* <br>
795
+ example: OrderedMap { "en_US": List [ OrderedMap { "marker": "naimenovanie_1", "value": "Name" } ] }
796
+
797
+ **attributeSetIdentifier:** string
798
+ *text identifier (marker) of the used attribute set*
799
+ example: test-form
800
+
801
+ </details>
802
+
803
+
552
804
  ### FormData.getFormsDataByMarker(marker, langCode, offset, limit)
553
805
 
554
806
  ```js
@@ -565,17 +817,42 @@ Example return:
565
817
  "formIdentifier": "my-form",
566
818
  "time": "2023-02-12 10:56",
567
819
  "formData": {
568
- "en_US": [
569
- {
570
- "marker": "name_1",
571
- "value": "Name"
572
- }
573
- ]
820
+ "marker": "name_1",
821
+ "value": "Name"
574
822
  },
575
823
  "attributeSetIdentifier": "test-form"
576
824
  }
577
825
  ```
578
826
 
827
+ <details>
828
+ <summary>Schema</summary>
829
+
830
+ **id:** number <br>
831
+ *object identifier* <br>
832
+ example: 1764
833
+
834
+ **formIdentifier:** string <br>
835
+ *Text identifier of the form object (marker)* <br>
836
+ example: my-form
837
+
838
+ **time:** Date <br>
839
+ *Date and time of form modification* <br>
840
+ example: 2023-02-12 10:56
841
+
842
+ **formData:** FormDataLangType <br>
843
+ *Data submitted by the form* <br>
844
+ example: OrderedMap { "en_US": List [ OrderedMap { "marker": "naimenovanie_1", "value": "Name" } ] }
845
+
846
+ **attributeSetIdentifier:** string
847
+ *text identifier (marker) of the used attribute set*
848
+ example: test-form
849
+
850
+ </details>
851
+
852
+ ---
853
+
854
+
855
+
579
856
  ## GeneralTypes
580
857
 
581
858
  const { GeneralTypes } = defineOneEntry('your-url');
@@ -598,6 +875,23 @@ Example return:
598
875
  }
599
876
  ]
600
877
  ```
878
+ <details>
879
+ <summary>Schema</summary>
880
+
881
+ **id:** number <br>
882
+ *object identifier* <br>
883
+ example: 1764
884
+
885
+ **type:** string <br>
886
+ *type value* <br>
887
+ example: forNewsPage <br>
888
+ Enum:
889
+ [ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ]
890
+
891
+ </details>
892
+ ---
893
+
894
+
601
895
 
602
896
  ## Locales
603
897
 
@@ -630,64 +924,296 @@ Example return:
630
924
  ]
631
925
  ```
632
926
 
633
- ## Menus
927
+ <details>
928
+ <summary>Schema</summary>
929
+
930
+ **id:** number <br>
931
+ *object identifier* <br>
932
+ example: 1764
933
+
934
+ **shortCode:** string <br>
935
+ *language code (short)* <br>
936
+ example: en
937
+
938
+ **code:** string <br>
939
+ *language code with country code* <br>
940
+ example: en_US
941
+
942
+ **name** string <br>
943
+ *Language name (in English)* <br>
944
+ example: Bengali
945
+
946
+ **nativeName** string <br>
947
+ *Language name (in native language)* <br>
948
+ example: বাংলা
949
+
950
+ **isActive:** boolean <br>
951
+ *Flag of usage* <br>
952
+ example: false
953
+
954
+ **image:** string
955
+ *Graphic image of the language (under development)*
956
+ example: 🇦🇨
957
+
958
+ **position:** {
959
+ description:position number
960
+ }
961
+ </details>
962
+ ---
963
+
964
+
965
+
966
+
967
+ ## Markers
634
968
 
635
969
  ```js
636
- const { Menus } = defineOneEntry('your-url')
970
+ const { Markers } = defineOneEntry('your-url')
637
971
  ```
638
972
 
639
- ### Menus.getMenusByMarker(marker)
973
+ ### Markers.getMarkers(offset, limit)
640
974
 
641
975
  ```js
642
- const value = await Menus.getMenusByMarker('my-marker')
976
+ const value = await Markers.getMarkers(0, 30)
643
977
  ```
644
978
 
645
- > 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.
979
+ >This method return an array of all objects MarkerEntity.
646
980
 
647
981
  Example return:
648
982
 
649
983
  ```json
650
- {
651
- "id": 1764,
652
- "identifier": "catalog",
653
- "localizeInfos": {
654
- "en_US": {
655
- "title": "Main Menu"
656
- }
657
- },
658
- "pages": [
659
- {
660
- "id": 11,
661
- "pageUrl": "122",
662
- "localizeInfos": {
663
- "en_US": {
664
- "title": "12",
665
- "content": "",
666
- "menuTitle": "12"
667
- }
668
- },
669
- "position": 0,
670
- "parentId": null
984
+ [
985
+ {
986
+ "id": 17,
987
+ "updatedDate": "2023-12-18T08:53:37.422Z",
988
+ "version": 10,
989
+ "identifier": "catalog",
990
+ "name": "string",
991
+ "marker": "string",
992
+ "localizeInfos": {
993
+ "title": "My marker"
671
994
  }
672
- ]
673
- }
995
+ }
996
+ ]
674
997
  ```
675
998
 
676
- ## Pages
999
+ <details>
1000
+ <summary>Schema</summary>
677
1001
 
678
- ```js
679
- const { Pages } = defineOneEntry('your-url')
680
- ```
1002
+ **id:** number <br>
1003
+ *object identifier* <br>
1004
+ example: 1764
681
1005
 
682
- > 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"
1006
+ **updatedDate:** string($date-time) <br>
1007
+ *object modification date* <br>
683
1008
 
684
- Example:
1009
+ **version:** number <br>
1010
+ *version number of the object change* <br>
1011
+ example: 10
685
1012
 
686
- ```
687
- const value = await Pages.getRootPages('en_US')
688
-
689
- "localizeInfos": {
690
- {
1013
+ **identifier?:** string <br>
1014
+ *textual identifier for a record field* <br>
1015
+ example: catalog
1016
+
1017
+ **name?:** string <br>
1018
+ *name*
1019
+
1020
+ **marker?:** string <br>
1021
+ *textual identifier*
1022
+
1023
+ **localizeInfos:** CommonLocalizeInfos <br>
1024
+ *localized marker name* <br>
1025
+ example: OrderedMap { "en_US": OrderedMap { "title": "My marker" } }
1026
+ </details>
1027
+
1028
+
1029
+ ### Markers.getMarkerById(id)
1030
+
1031
+ ```js
1032
+ const value = await Markers.getMarkerById(1)
1033
+ ```
1034
+
1035
+ >This method return one object of MarkerEntity by id.
1036
+
1037
+ Example return:
1038
+
1039
+ ```json
1040
+ {
1041
+ "id": 17,
1042
+ "updatedDate": "2023-12-18T08:55:22.581Z",
1043
+ "version": 10,
1044
+ "identifier": "catalog",
1045
+ "name": "string",
1046
+ "marker": "string",
1047
+ "localizeInfos": {
1048
+ "title": "My marker"
1049
+ }
1050
+ }
1051
+ ```
1052
+
1053
+ <details>
1054
+ <summary>Schema</summary>
1055
+
1056
+ **id:** number <br>
1057
+ *object identifier* <br>
1058
+ example: 1764
1059
+
1060
+ **updatedDate:** string($date-time) <br>
1061
+ *object modification date* <br>
1062
+
1063
+ **version:** number <br>
1064
+ *version number of the object change* <br>
1065
+ example: 10
1066
+
1067
+ **identifier?:** string <br>
1068
+ *textual identifier for a record field* <br>
1069
+ example: catalog
1070
+
1071
+ **name?:** string <br>
1072
+ *name*
1073
+
1074
+ **marker?:** string <br>
1075
+ *textual identifier*
1076
+
1077
+ **localizeInfos:** CommonLocalizeInfos <br>
1078
+ *localized marker name* <br>
1079
+ example: OrderedMap { "en_US": OrderedMap { "title": "My marker" } }
1080
+ </details>
1081
+
1082
+ ### Markers.getMarkerByMarker(marker)
1083
+
1084
+ ```js
1085
+ const value = await Markers.getMarkerByMarker('my-marker')
1086
+ ```
1087
+
1088
+ >This method return one object of MarkerEntity by marker.
1089
+
1090
+ Example return:
1091
+
1092
+ ```json
1093
+ {
1094
+ "id": 17,
1095
+ "updatedDate": "2023-12-18T08:59:42.006Z",
1096
+ "version": 10,
1097
+ "identifier": "catalog",
1098
+ "name": "string",
1099
+ "marker": "string",
1100
+ "localizeInfos": {
1101
+ "title": "My marker"
1102
+ }
1103
+ }
1104
+ ```
1105
+
1106
+ <details>
1107
+ <summary>Schema</summary>
1108
+
1109
+ **id:** number <br>
1110
+ *object identifier* <br>
1111
+ example: 1764
1112
+
1113
+ **updatedDate:** string($date-time) <br>
1114
+ *object modification date* <br>
1115
+
1116
+ **version:** number <br>
1117
+ *version number of the object change* <br>
1118
+ example: 10
1119
+
1120
+ **identifier?:** string <br>
1121
+ *textual identifier for a record field* <br>
1122
+ example: catalog
1123
+
1124
+ **name?:** string <br>
1125
+ *name*
1126
+
1127
+ **marker?:** string <br>
1128
+ *textual identifier*
1129
+
1130
+ **localizeInfos:** CommonLocalizeInfos <br>
1131
+ *localized marker name* <br>
1132
+ example: OrderedMap { "en_US": OrderedMap { "title": "My marker" } }
1133
+ </details>
1134
+
1135
+ ---
1136
+
1137
+
1138
+ ## Menus
1139
+
1140
+ ```js
1141
+ const { Menus } = defineOneEntry('your-url')
1142
+ ```
1143
+
1144
+ ### Menus.getMenusByMarker(marker)
1145
+
1146
+ ```js
1147
+ const value = await Menus.getMenusByMarker('my-marker')
1148
+ ```
1149
+
1150
+ > 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.
1151
+
1152
+ Example return:
1153
+
1154
+ ```json
1155
+ {
1156
+ "id": 1764,
1157
+ "identifier": "catalog",
1158
+ "localizeInfos": {
1159
+ "title": "Main Menu"
1160
+ },
1161
+ "pages": [
1162
+ {
1163
+ "id": 11,
1164
+ "pageUrl": "122",
1165
+ "localizeInfos": {
1166
+ "en_US": {
1167
+ "title": "12",
1168
+ "content": "",
1169
+ "menuTitle": "12"
1170
+ }
1171
+ },
1172
+ "position": 0,
1173
+ "parentId": null
1174
+ }
1175
+ ]
1176
+ }
1177
+ ```
1178
+
1179
+ <details>
1180
+ <summary>Schema</summary>
1181
+
1182
+ **id:** number <br>
1183
+ *object identifier* <br>
1184
+ example: 1764
1185
+
1186
+ **identifier:** string <br>
1187
+ *textual identifier for a record field* <br>
1188
+ example: catalog
1189
+
1190
+ **localizeInfos** Record<string, any> <br>
1191
+ *json object description of the menu item with the language "en_US" (for example)* <br>
1192
+ example: OrderedMap { "en_US": OrderedMap { "title": "Main Menu" } }
1193
+
1194
+ **pages:**
1195
+ *data of the pages included in the menu*
1196
+ 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 } ]
1197
+ </details>
1198
+
1199
+ ---
1200
+
1201
+
1202
+ ## Pages
1203
+
1204
+ ```js
1205
+ const { Pages } = defineOneEntry('your-url')
1206
+ ```
1207
+
1208
+ > 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"
1209
+
1210
+ Example:
1211
+
1212
+ ```
1213
+ const value = await Pages.getRootPages('en_US')
1214
+
1215
+ "localizeInfos": {
1216
+ {
691
1217
  "title": "Catalog",
692
1218
  "content": "Content from catalog",
693
1219
  "menuTitle": "Catalog"
@@ -758,11 +1284,9 @@ Example return:
758
1284
  "pageUrl": "string",
759
1285
  "depth": 3,
760
1286
  "localizeInfos": {
761
- "en_US": {
762
- "title": "Catalog",
763
- "content": "Content for catalog",
764
- "menuTitle": "Catalog"
765
- }
1287
+ "title": "Catalog",
1288
+ "content": "Content for catalog",
1289
+ "menuTitle": "Catalog"
766
1290
  },
767
1291
  "isVisible": true,
768
1292
  "products": 0,
@@ -770,11 +1294,9 @@ Example return:
770
1294
  "isSync": false,
771
1295
  "templateIdentifier": "my-template",
772
1296
  "attributeValues": {
773
- "en_US": {
774
- "marker": {
775
- "value": "",
776
- "type": "string"
777
- }
1297
+ "marker": {
1298
+ "value": "",
1299
+ "type": "string"
778
1300
  }
779
1301
  },
780
1302
  "position": 192,
@@ -784,6 +1306,81 @@ Example return:
784
1306
  ]
785
1307
  ```
786
1308
 
1309
+ <details>
1310
+ <summary>Schema</summary>
1311
+
1312
+ **id:** number <br>
1313
+ *object identifier* <br>
1314
+ example: 1764
1315
+
1316
+ **parentId** number <br>
1317
+ *parent page identifier, if null, it is a top-level page* <br>
1318
+ example: null
1319
+
1320
+ **config** Record<string, number> <br>
1321
+ *output settings for catalog pages* <br>
1322
+ example: OrderedMap { "rowsPerPage": 1, "productsPerRow": 1 }
1323
+
1324
+ **pageUrl** string <br>
1325
+ *unique page URL*
1326
+
1327
+ **depth** number <br>
1328
+ *page nesting depth relative to parentId* <br>
1329
+ example: 3
1330
+
1331
+ **localizeInfos:** Record<string, any> <br>
1332
+ *json description of the main page data object taking into account the language "en_US" (for example)* <br>
1333
+ example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
1334
+
1335
+ **isVisible:** boolean <br>
1336
+ *Page visibility flag* <br>
1337
+ example: true
1338
+
1339
+ **products** number <br>
1340
+ *Number of products linked to the page* <br>
1341
+ example: 0
1342
+
1343
+ **attributeSetId:** number <br>
1344
+ *attribute set identifier* <br>
1345
+ example: 7
1346
+
1347
+ **forms** <br>
1348
+ *Array of FormEntity object identifier values linked to the page (optional)*
1349
+
1350
+
1351
+ **blocks** <br>
1352
+ *Array of BlockEntity object identifier values linked to the page (optional)*
1353
+
1354
+
1355
+ **isSync:** boolean <br>
1356
+ *indicator of page indexing (true or false)* <br>
1357
+ example: false
1358
+
1359
+ **templateIdentifier:** string <br>
1360
+ *Custom identifier of the linked template* <br>
1361
+ example: my-template
1362
+
1363
+ **attributeValues:** Record<string, string> <br>
1364
+ *Array of attribute values from the index (presented as a pair of custom attribute identifier: attribute value)* <br>
1365
+ example: OrderedMap { "en_US": OrderedMap { "marker": OrderedMap { "value": "", "type": "string" } } }
1366
+
1367
+ **position:** number <br>
1368
+ *position number for sorting (optional)* <br>
1369
+ example: 192
1370
+
1371
+ **type:** string <br>
1372
+ *Page type* <br>
1373
+ example: forNewsPage
1374
+ Enum:
1375
+ [ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ]
1376
+
1377
+
1378
+ **childrenCount:** number <br>
1379
+ *number of nested pages* <br>
1380
+ example: 0
1381
+
1382
+ </details>
1383
+
787
1384
  ### Pages.getCatalogPages(langCode, limit, offset)
788
1385
 
789
1386
  ```js
@@ -806,11 +1403,9 @@ Example return:
806
1403
  "pageUrl": "string",
807
1404
  "depth": 3,
808
1405
  "localizeInfos": {
809
- "en_US": {
810
- "title": "Catalog",
811
- "content": "Content for catalog",
812
- "menuTitle": "Catalog"
813
- }
1406
+ "title": "Catalog",
1407
+ "content": "Content for catalog",
1408
+ "menuTitle": "Catalog"
814
1409
  },
815
1410
  "isVisible": true,
816
1411
  "products": 0,
@@ -818,11 +1413,9 @@ Example return:
818
1413
  "isSync": false,
819
1414
  "templateIdentifier": "my-template",
820
1415
  "attributeValues": {
821
- "en_US": {
822
- "marker": {
823
- "value": "",
824
- "type": "string"
825
- }
1416
+ "marker": {
1417
+ "value": "",
1418
+ "type": "string"
826
1419
  }
827
1420
  },
828
1421
  "position": 192,
@@ -831,6 +1424,80 @@ Example return:
831
1424
  }
832
1425
  ]
833
1426
  ```
1427
+ <details>
1428
+ <summary>Schema</summary>
1429
+
1430
+ **id:** number <br>
1431
+ *object identifier* <br>
1432
+ example: 1764
1433
+
1434
+ **parentId** number <br>
1435
+ *parent page identifier, if null, it is a top-level page* <br>
1436
+ example: null
1437
+
1438
+ **config** Record<string, number> <br>
1439
+ *output settings for catalog pages* <br>
1440
+ example: OrderedMap { "rowsPerPage": 1, "productsPerRow": 1 }
1441
+
1442
+ **pageUrl** string <br>
1443
+ *unique page URL*
1444
+
1445
+ **depth** number <br>
1446
+ *page nesting depth relative to parentId* <br>
1447
+ example: 3
1448
+
1449
+ **localizeInfos:** Record<string, any> <br>
1450
+ *json description of the main page data object taking into account the language "en_US" (for example)* <br>
1451
+ example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
1452
+
1453
+ **isVisible:** boolean <br>
1454
+ *Page visibility flag* <br>
1455
+ example: true
1456
+
1457
+ **products** number <br>
1458
+ *Number of products linked to the page* <br>
1459
+ example: 0
1460
+
1461
+ **attributeSetId:** number <br>
1462
+ *attribute set identifier* <br>
1463
+ example: 7
1464
+
1465
+ **forms** <br>
1466
+ *Array of FormEntity object identifier values linked to the page (optional)*
1467
+
1468
+
1469
+ **blocks** <br>
1470
+ *Array of BlockEntity object identifier values linked to the page (optional)*
1471
+
1472
+
1473
+ **isSync:** boolean <br>
1474
+ *indicator of page indexing (true or false)* <br>
1475
+ example: false
1476
+
1477
+ **templateIdentifier:** string <br>
1478
+ *Custom identifier of the linked template* <br>
1479
+ example: my-template
1480
+
1481
+ **attributeValues:** Record<string, string> <br>
1482
+ *Array of attribute values from the index (presented as a pair of custom attribute identifier: attribute value)* <br>
1483
+ example: OrderedMap { "en_US": OrderedMap { "marker": OrderedMap { "value": "", "type": "string" } } }
1484
+
1485
+ **position:** number <br>
1486
+ *position number for sorting (optional)* <br>
1487
+ example: 192
1488
+
1489
+ **type:** string <br>
1490
+ *Page type* <br>
1491
+ example: forNewsPage
1492
+ Enum:
1493
+ [ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ]
1494
+
1495
+
1496
+ **childrenCount:** number <br>
1497
+ *number of nested pages* <br>
1498
+ example: 0
1499
+
1500
+ </details>
834
1501
 
835
1502
  ### Pages.getPages(langCode)
836
1503
 
@@ -854,11 +1521,9 @@ Example return:
854
1521
  "pageUrl": "string",
855
1522
  "depth": 3,
856
1523
  "localizeInfos": {
857
- "en_US": {
858
- "title": "Catalog",
859
- "content": "Content for catalog",
860
- "menuTitle": "Catalog"
861
- }
1524
+ "title": "Catalog",
1525
+ "content": "Content for catalog",
1526
+ "menuTitle": "Catalog"
862
1527
  },
863
1528
  "isVisible": true,
864
1529
  "products": 0,
@@ -866,11 +1531,9 @@ Example return:
866
1531
  "isSync": false,
867
1532
  "templateIdentifier": "my-template",
868
1533
  "attributeValues": {
869
- "en_US": {
870
- "marker": {
871
- "value": "",
872
- "type": "string"
873
- }
1534
+ "marker": {
1535
+ "value": "",
1536
+ "type": "string"
874
1537
  }
875
1538
  },
876
1539
  "position": 192,
@@ -879,6 +1542,80 @@ Example return:
879
1542
  }
880
1543
  ]
881
1544
  ```
1545
+ <details>
1546
+ <summary>Schema</summary>
1547
+
1548
+ **id:** number <br>
1549
+ *object identifier* <br>
1550
+ example: 1764
1551
+
1552
+ **parentId** number <br>
1553
+ *parent page identifier, if null, it is a top-level page* <br>
1554
+ example: null
1555
+
1556
+ **config** Record<string, number> <br>
1557
+ *output settings for catalog pages* <br>
1558
+ example: OrderedMap { "rowsPerPage": 1, "productsPerRow": 1 }
1559
+
1560
+ **pageUrl** string <br>
1561
+ *unique page URL*
1562
+
1563
+ **depth** number <br>
1564
+ *page nesting depth relative to parentId* <br>
1565
+ example: 3
1566
+
1567
+ **localizeInfos:** Record<string, any> <br>
1568
+ *json description of the main page data object taking into account the language "en_US" (for example)* <br>
1569
+ example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
1570
+
1571
+ **isVisible:** boolean <br>
1572
+ *Page visibility flag* <br>
1573
+ example: true
1574
+
1575
+ **products** number <br>
1576
+ *Number of products linked to the page* <br>
1577
+ example: 0
1578
+
1579
+ **attributeSetId:** number <br>
1580
+ *attribute set identifier* <br>
1581
+ example: 7
1582
+
1583
+ **forms** <br>
1584
+ *Array of FormEntity object identifier values linked to the page (optional)*
1585
+
1586
+
1587
+ **blocks** <br>
1588
+ *Array of BlockEntity object identifier values linked to the page (optional)*
1589
+
1590
+
1591
+ **isSync:** boolean <br>
1592
+ *indicator of page indexing (true or false)* <br>
1593
+ example: false
1594
+
1595
+ **templateIdentifier:** string <br>
1596
+ *Custom identifier of the linked template* <br>
1597
+ example: my-template
1598
+
1599
+ **attributeValues:** Record<string, string> <br>
1600
+ *Array of attribute values from the index (presented as a pair of custom attribute identifier: attribute value)* <br>
1601
+ example: OrderedMap { "en_US": OrderedMap { "marker": OrderedMap { "value": "", "type": "string" } } }
1602
+
1603
+ **position:** number <br>
1604
+ *position number for sorting (optional)* <br>
1605
+ example: 192
1606
+
1607
+ **type:** string <br>
1608
+ *Page type* <br>
1609
+ example: forNewsPage
1610
+ Enum:
1611
+ [ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ]
1612
+
1613
+
1614
+ **childrenCount:** number <br>
1615
+ *number of nested pages* <br>
1616
+ example: 0
1617
+
1618
+ </details>
882
1619
 
883
1620
  ### Pages.getPageById(id, langCode)
884
1621
 
@@ -897,11 +1634,9 @@ Example return:
897
1634
  "pageUrl": "string",
898
1635
  "depth": 3,
899
1636
  "localizeInfos": {
900
- "en_US": {
901
- "title": "Catalog",
902
- "content": "Content for catalog",
903
- "menuTitle": "Catalog"
904
- }
1637
+ "title": "Catalog",
1638
+ "content": "Content for catalog",
1639
+ "menuTitle": "Catalog"
905
1640
  },
906
1641
  "isVisible": true,
907
1642
  "position": 192,
@@ -909,16 +1644,76 @@ Example return:
909
1644
  "templateIdentifier": "my-template",
910
1645
  "attributeSetId": 7,
911
1646
  "attributeValues": {
912
- "en_US": {
913
- "marker": "description",
914
- "type": "string",
915
- "value": ""
916
- }
1647
+ "marker": "description",
1648
+ "type": "string",
1649
+ "value": ""
917
1650
  },
918
1651
  "isSync": false,
919
1652
  "products": 0
920
1653
  }
921
1654
  ```
1655
+ <details>
1656
+ <summary>Schema</summary>
1657
+
1658
+ **id:** number <br>
1659
+ *object identifier* <br>
1660
+ example: 1764
1661
+
1662
+ **parentId** number <br>
1663
+ *parent page identifier, if null, it is a top-level page* <br>
1664
+ example: null
1665
+
1666
+ **pageUrl** string <br>
1667
+ *unique page URL*
1668
+
1669
+ **depth** number <br>
1670
+ *page nesting depth relative to parentId* <br>
1671
+ example: 3
1672
+
1673
+ **localizeInfos:** Record<string, any> <br>
1674
+ *json description of the main page data object taking into account the language "en_US" (for example)* <br>
1675
+ example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
1676
+
1677
+ **isVisible:** boolean <br>
1678
+ *Page visibility flag* <br>
1679
+ example: true
1680
+
1681
+ **position:** number <br>
1682
+ *position number (for sorting)* <br>
1683
+ example: 192
1684
+
1685
+ **type** string <br>
1686
+ *page type:* <br>
1687
+ example: forNewsPage <br>
1688
+ Enum:
1689
+ [ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ]
1690
+
1691
+
1692
+ **templateIdentifier:** string <br>
1693
+ *custom identifier of the associated template* <br>
1694
+ example: my-template
1695
+
1696
+ **attributeSetId:** number <br>
1697
+ *attribute set identifier* <br>
1698
+ example: 7
1699
+
1700
+ **forms** <br>
1701
+ *Array of FormEntity object identifier values linked to the page (optional)*
1702
+
1703
+
1704
+ **blocks** <br>
1705
+ *Array of BlockEntity object identifier values linked to the page (optional)*
1706
+
1707
+
1708
+ **isSync:** boolean <br>
1709
+ *indicator of page indexing (true or false)* <br>
1710
+ example: false
1711
+
1712
+ **products** number <br>
1713
+ *number of products associated with the page* <br>
1714
+ example: 0
1715
+
1716
+ </details>
922
1717
 
923
1718
  ### Pages.getPageByUrl(url, langCode)
924
1719
 
@@ -937,11 +1732,9 @@ Example return:
937
1732
  "pageUrl": "string",
938
1733
  "depth": 3,
939
1734
  "localizeInfos": {
940
- "en_US": {
941
- "title": "Catalog",
942
- "content": "Content for catalog",
943
- "menuTitle": "Catalog"
944
- }
1735
+ "title": "Catalog",
1736
+ "content": "Content for catalog",
1737
+ "menuTitle": "Catalog"
945
1738
  },
946
1739
  "isVisible": true,
947
1740
  "position": 192,
@@ -949,16 +1742,77 @@ Example return:
949
1742
  "templateIdentifier": "my-template",
950
1743
  "attributeSetId": 7,
951
1744
  "attributeValues": {
952
- "en_US": {
953
- "marker": "description",
954
- "type": "string",
955
- "value": ""
956
- }
1745
+ "marker": "description",
1746
+ "type": "string",
1747
+ "value": ""
957
1748
  },
958
1749
  "isSync": false,
959
1750
  "products": 0
960
1751
  }
961
1752
  ```
1753
+ <details>
1754
+ <summary>Schema</summary>
1755
+
1756
+ **id:** number <br>
1757
+ *object identifier* <br>
1758
+ example: 1764
1759
+
1760
+ **parentId** number <br>
1761
+ *parent page identifier, if null, it is a top-level page* <br>
1762
+ example: null
1763
+
1764
+ **pageUrl** string <br>
1765
+ *unique page URL*
1766
+
1767
+ **depth** number <br>
1768
+ *page nesting depth relative to parentId* <br>
1769
+ example: 3
1770
+
1771
+ **localizeInfos:** Record<string, any> <br>
1772
+ *json description of the main page data object taking into account the language "en_US" (for example)* <br>
1773
+ example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
1774
+
1775
+ **isVisible:** boolean <br>
1776
+ *Page visibility flag* <br>
1777
+ example: true
1778
+
1779
+ **position:** number <br>
1780
+ *position number (for sorting)* <br>
1781
+ example: 192
1782
+
1783
+ **type** string <br>
1784
+ *page type:* <br>
1785
+ example: forNewsPage <br>
1786
+ Enum:
1787
+ [ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ]
1788
+
1789
+
1790
+ **templateIdentifier:** string <br>
1791
+ *custom identifier of the associated template* <br>
1792
+ example: my-template
1793
+
1794
+ **attributeSetId:** number <br>
1795
+ *attribute set identifier* <br>
1796
+ example: 7
1797
+
1798
+ **forms** <br>
1799
+ *Array of FormEntity object identifier values linked to the page (optional)*
1800
+
1801
+
1802
+ **blocks** <br>
1803
+ *Array of BlockEntity object identifier values linked to the page (optional)*
1804
+
1805
+
1806
+ **isSync:** boolean <br>
1807
+ *indicator of page indexing (true or false)* <br>
1808
+ example: false
1809
+
1810
+ **products** number <br>
1811
+ *number of products associated with the page* <br>
1812
+ example: 0
1813
+
1814
+ </details>
1815
+
962
1816
 
963
1817
  ### Pages.getChildPagesByParentUrl(url, langCode)
964
1818
 
@@ -972,36 +1826,121 @@ Example return:
972
1826
 
973
1827
  ```json
974
1828
  [
975
- {
976
- "id": 1764,
977
- "parentId": null,
978
- "pageUrl": "string",
979
- "depth": 3,
980
- "localizeInfos": {
981
- "en_US": {
982
- "title": "Catalog",
983
- "content": "Content for catalog",
984
- "menuTitle": "Catalog"
985
- }
986
- },
987
- "isVisible": true,
988
- "position": 192,
989
- "type": "forNewsPage",
990
- "templateIdentifier": "my-template",
991
- "attributeSetId": 7,
992
- "attributeValues": {
993
- "en_US": {
994
- "marker": "description",
995
- "type": "string",
996
- "value": ""
997
- }
998
- },
999
- "isSync": false,
1000
- "products": 0
1001
- }
1829
+ {
1830
+ "id": 1764,
1831
+ "parentId": null,
1832
+ "config": {
1833
+ "rowsPerPage": 1,
1834
+ "productsPerRow": 1
1835
+ },
1836
+ "pageUrl": "string",
1837
+ "depth": 3,
1838
+ "localizeInfos": {
1839
+ "title": "Catalog",
1840
+ "plainContent": "Content for catalog",
1841
+ "htmlContent": "<b>Content for catalog</b>",
1842
+ "menuTitle": "Catalog"
1843
+ },
1844
+ "isVisible": true,
1845
+ "products": 0,
1846
+ "attributeSetId": 7,
1847
+ "forms": [
1848
+ null
1849
+ ],
1850
+ "blocks": [
1851
+ null
1852
+ ],
1853
+ "isSync": false,
1854
+ "templateIdentifier": "my-template",
1855
+ "attributeValues": {
1856
+ "marker": {
1857
+ "value": "",
1858
+ "type": "string"
1859
+ }
1860
+ },
1861
+ "position": 192,
1862
+ "type": "forNewsPage",
1863
+ "childrenCount": 0
1864
+ }
1002
1865
  ]
1003
1866
  ```
1004
1867
 
1868
+ <details>
1869
+ <summary>Schema</summary>
1870
+
1871
+ **id:** number <br>
1872
+ *object identifier* <br>
1873
+ example: 1764
1874
+
1875
+ **parentId** number <br>
1876
+ *parent page identifier, if null, it is a top-level page* <br>
1877
+ example: null
1878
+
1879
+ **config** Record<string, number> <br>
1880
+ *output settings for catalog pages* <br>
1881
+ example: OrderedMap { "rowsPerPage": 1, "productsPerRow": 1 }
1882
+
1883
+ **pageUrl** string <br>
1884
+ *unique page URL*
1885
+
1886
+ **depth** number <br>
1887
+ *page nesting depth relative to parentId* <br>
1888
+ example: 3
1889
+
1890
+ **localizeInfos:** Record<string, any> <br>
1891
+ *json description of the main page data object taking into account the language "en_US" (for example)* <br>
1892
+ example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
1893
+
1894
+ **isVisible:** boolean <br>
1895
+ *Page visibility flag* <br>
1896
+ example: true
1897
+
1898
+ **products** number <br>
1899
+ *Number of products linked to the page* <br>
1900
+ example: 0
1901
+
1902
+ **attributeSetId:** number <br>
1903
+ *attribute set identifier* <br>
1904
+ example: 7
1905
+
1906
+ **forms** <br>
1907
+ *Array of FormEntity object identifier values linked to the page (optional)*
1908
+
1909
+
1910
+ **blocks** <br>
1911
+ *Array of BlockEntity object identifier values linked to the page (optional)*
1912
+
1913
+
1914
+ **isSync:** boolean <br>
1915
+ *indicator of page indexing (true or false)* <br>
1916
+ example: false
1917
+
1918
+ **templateIdentifier:** string <br>
1919
+ *Custom identifier of the linked template* <br>
1920
+ example: my-template
1921
+
1922
+ **attributeValues:** Record<string, string> <br>
1923
+ *Array of attribute values from the index (presented as a pair of custom attribute identifier: attribute value)* <br>
1924
+ example: OrderedMap { "en_US": OrderedMap { "marker": OrderedMap { "value": "", "type": "string" } } }
1925
+
1926
+ **position:** number <br>
1927
+ *position number for sorting (optional)* <br>
1928
+ example: 192
1929
+
1930
+ **type:** string <br>
1931
+ *Page type* <br>
1932
+ example: forNewsPage
1933
+ Enum:
1934
+ [ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ]
1935
+
1936
+
1937
+ **childrenCount:** number <br>
1938
+ *number of nested pages* <br>
1939
+ example: 0
1940
+
1941
+ </details>
1942
+
1943
+
1005
1944
  ### Pages.getBlocksByPageUrl(url, langCode)
1006
1945
 
1007
1946
  ```js
@@ -1020,9 +1959,7 @@ Example return:
1020
1959
  "identifier": "catalog",
1021
1960
  "attributeSetId": 0,
1022
1961
  "localizeInfos": {
1023
- "en_US": {
1024
- "title": "My block"
1025
- }
1962
+ "title": "My block"
1026
1963
  },
1027
1964
  "customSettings": {
1028
1965
  "sliderDelay": 0,
@@ -1043,11 +1980,9 @@ Example return:
1043
1980
  "position": 0,
1044
1981
  "isSync": false,
1045
1982
  "attributeValues": {
1046
- "en_US": {
1047
- "marker": {
1048
- "value": "",
1049
- "type": "string"
1050
- }
1983
+ "marker": {
1984
+ "value": "",
1985
+ "type": "string"
1051
1986
  }
1052
1987
  },
1053
1988
  "type": "forNewsPage",
@@ -1056,6 +1991,58 @@ Example return:
1056
1991
  ]
1057
1992
  ```
1058
1993
 
1994
+ <details>
1995
+ <summary>Schema</summary>
1996
+
1997
+ **id:** number <br>
1998
+ *object identifier* <br>
1999
+ example: 1764
2000
+
2001
+ **version** number <br>
2002
+ *object version number* <br>
2003
+ example: 10
2004
+
2005
+ **identifier:** string <br>
2006
+ *text identifier for the record field* <br>
2007
+ example: catalog
2008
+
2009
+ **attributeSetId:** number <br>
2010
+ *attribute set identifier* <br>
2011
+ example: 7
2012
+
2013
+ **localizeInfos:** Record<string, any> <br>
2014
+ *json description of the main page data object taking into account the language "en_US" (for example)* <br>
2015
+ example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
2016
+
2017
+ **customSettings:** BlockCustomSettings <br>
2018
+ *custom settings for different types of blocks* <br>
2019
+ example: OrderedMap { "sliderDelay": 0, "sliderDelayType": "", "productQuantity": 4, "productSortType": "By_ID", "productSortOrder": "Descending", "productCountElementsPerRow": 10, "similarProductRules": List [ OrderedMap { "property": "Descending", "includes": "", "keywords": "", "strict": "" } ] }
2020
+
2021
+ **isSync:** boolean <br>
2022
+ *indicator of page indexing (true or false)* <br>
2023
+ example: false
2024
+
2025
+ **attributeValues:** Record<string, string> <br>
2026
+ *Array of attribute values from the index (presented as a pair of custom attribute identifier: attribute value)* <br>
2027
+ example: OrderedMap { "en_US": OrderedMap { "marker": OrderedMap { "value": "", "type": "string" } } }
2028
+
2029
+ **position:** number <br>
2030
+ *position number for sorting (optional)* <br>
2031
+ example: 192
2032
+
2033
+ **type:** string <br>
2034
+ *Page type* <br>
2035
+ example: forNewsPage
2036
+ Enum:
2037
+ [ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ]
2038
+
2039
+ **templateIdentifier:** string <br>
2040
+ *marker of the template used by the block (can be null)* <br>
2041
+ example: null
2042
+
2043
+ </details>
2044
+
2045
+
1059
2046
  ### Pages.getFormsByPageUrl(url, langCode)
1060
2047
 
1061
2048
  ```js
@@ -1075,15 +2062,13 @@ Example return:
1075
2062
  "attributeSetId": 0,
1076
2063
  "processingType": "email",
1077
2064
  "localizeInfos": {
1078
- "en_US": {
1079
- "title": "My form",
1080
- "titleForSite": "",
1081
- "successMessage": "",
1082
- "unsuccessMessage": "",
1083
- "urlAddress": "",
1084
- "database": "0",
1085
- "script": "0"
1086
- }
2065
+ "title": "My form",
2066
+ "titleForSite": "",
2067
+ "successMessage": "",
2068
+ "unsuccessMessage": "",
2069
+ "urlAddress": "",
2070
+ "database": "0",
2071
+ "script": "0"
1087
2072
  },
1088
2073
  "processingData": {},
1089
2074
  "position": 0,
@@ -1118,6 +2103,49 @@ Example return:
1118
2103
  ]
1119
2104
  ```
1120
2105
 
2106
+ <details>
2107
+ <summary>Schema</summary>
2108
+
2109
+ **id:** number <br>
2110
+ *object identifier* <br>
2111
+ example: 1764
2112
+
2113
+ **version** number <br>
2114
+ *object version number* <br>
2115
+ example: 10
2116
+
2117
+ **identifier:** string <br>
2118
+ *text identifier for the record field* <br>
2119
+ example: catalog
2120
+
2121
+ **attributeSetId:** number <br>
2122
+ *attribute set identifier* <br>
2123
+ example: 7
2124
+
2125
+ **processingType:** string <br>
2126
+ *form processing type* <br>
2127
+ example: email
2128
+ Enum:
2129
+ [ db, email, script ]
2130
+
2131
+ **localizeInfos:** Record<string, any> <br>
2132
+ *json description of the main page data object taking into account the language "en_US" (for example)* <br>
2133
+ example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
2134
+
2135
+ **processingData:** <br>
2136
+ *form data*
2137
+
2138
+
2139
+ **attributes:** Record<string, string> <br>
2140
+ *array of attribute values from the used attribute set for displaying the form (taking into account the specified language)* <br>
2141
+ 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" } } ]
2142
+
2143
+ **position:** number <br>
2144
+ *position number for sorting (optional)* <br>
2145
+ example: 192
2146
+
2147
+ </details>
2148
+
1121
2149
  ### Pages.getConfigPageByUrl(url)
1122
2150
 
1123
2151
  ```js
@@ -1134,6 +2162,19 @@ Example return:
1134
2162
  "productsPerRow": 10
1135
2163
  }
1136
2164
  ```
2165
+ <details>
2166
+ <summary>Schema</summary>
2167
+
2168
+ **rowsPerPage:** number
2169
+ *Number of rows per page*
2170
+ example: 10
2171
+
2172
+ **productsPerRow** number
2173
+ *Number of products per row*
2174
+ example: 10
2175
+
2176
+ </details>
2177
+
1137
2178
 
1138
2179
  ### Pages.searchPage(name, langCode)
1139
2180
 
@@ -1153,11 +2194,9 @@ Example return:
1153
2194
  "pageUrl": "string",
1154
2195
  "depth": 3,
1155
2196
  "localizeInfos": {
1156
- "en_US": {
1157
- "title": "Catalog",
1158
- "content": "Content for catalog",
1159
- "menuTitle": "Catalog"
1160
- }
2197
+ "title": "Catalog",
2198
+ "content": "Content for catalog",
2199
+ "menuTitle": "Catalog"
1161
2200
  },
1162
2201
  "isVisible": true,
1163
2202
  "position": 192,
@@ -1165,11 +2204,9 @@ Example return:
1165
2204
  "templateIdentifier": "my-template",
1166
2205
  "attributeSetId": 7,
1167
2206
  "attributeValues": {
1168
- "en_US": {
1169
- "marker": "description",
1170
- "type": "string",
1171
- "value": ""
1172
- }
2207
+ "marker": "description",
2208
+ "type": "string",
2209
+ "value": ""
1173
2210
  },
1174
2211
  "isSync": false,
1175
2212
  "products": 0
@@ -1177,6 +2214,10 @@ Example return:
1177
2214
  ]
1178
2215
  ```
1179
2216
 
2217
+ ---
2218
+
2219
+
2220
+
1180
2221
  ## Products
1181
2222
 
1182
2223
  ```js
@@ -1289,9 +2330,7 @@ Example return:
1289
2330
  {
1290
2331
  "id": 1764,
1291
2332
  "localizeInfos": {
1292
- "en_US": {
1293
- "title": "Product"
1294
- }
2333
+ "title": "Product"
1295
2334
  },
1296
2335
  "isVisible": true,
1297
2336
  "statusId": 1,
@@ -1306,11 +2345,9 @@ Example return:
1306
2345
  "templateIdentifier": "my-template",
1307
2346
  "shortDescTemplateIdentifier": "my-template-short",
1308
2347
  "attributeValues": {
1309
- "en_US": {
1310
- "marker": {
1311
- "value": "",
1312
- "type": "string"
1313
- }
2348
+ "marker": {
2349
+ "value": "",
2350
+ "type": "string"
1314
2351
  }
1315
2352
  },
1316
2353
  "position": 1
@@ -1318,6 +2355,64 @@ Example return:
1318
2355
  ]
1319
2356
  ```
1320
2357
 
2358
+ <details>
2359
+ <summary>Schema</summary>
2360
+
2361
+ **id:** number <br>
2362
+ *object identifier* <br>
2363
+ example: 1764
2364
+
2365
+ **localizeInfos:** Record<string, any> <br>
2366
+ *json description of the main page data object taking into account the language "en_US" (for example)* <br>
2367
+ example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
2368
+
2369
+ **isVisible:** boolean <br>
2370
+ *Page visibility flag* <br>
2371
+ example: true
2372
+
2373
+ **position:** number <br>
2374
+ *position number (for sorting)* <br>
2375
+ example: 192
2376
+
2377
+ **templateIdentifier:** string <br>
2378
+ *custom identifier of the associated template* <br>
2379
+ example: my-template
2380
+
2381
+ **attributeSetId:** number <br>
2382
+ *attribute set identifier* <br>
2383
+ example: 7
2384
+
2385
+ **isSync:** boolean <br>
2386
+ *indicator of page indexing (true or false)* <br>
2387
+ example: false
2388
+
2389
+ **attributeValues:** Record<string, string> <br>
2390
+ *Array of attribute values from the index (presented as a pair of custom attribute identifier: attribute value)* <br>
2391
+ example: OrderedMap { "en_US": OrderedMap { "marker": OrderedMap { "value": "", "type": "string" } } }
2392
+
2393
+ **statusId:** number <br>
2394
+ *status identifiers of the product page (can be null)* <br>
2395
+ example: 1
2396
+
2397
+ **relatedIds:** array <br>
2398
+ *identifiers of related product pages* <br>
2399
+ example: List [ 1, 2, 3 ]
2400
+
2401
+ **price:** number <br>
2402
+ *price value of the product page taken from the index* <br>
2403
+ example: 0
2404
+
2405
+ **templateIdentifier** string
2406
+ *custom identifier of the associated template*
2407
+ example: my-template
2408
+
2409
+ **shortDescTemplateIdentifier** string <br>
2410
+ *custom identifier of the associated template for short description* <br>
2411
+ example: my-template-short
2412
+
2413
+ </details>
2414
+
2415
+
1321
2416
  ### Products.getProductsEmptyPage(langCode, userQuery)
1322
2417
 
1323
2418
  ```js
@@ -1333,9 +2428,7 @@ Example return:
1333
2428
  {
1334
2429
  "id": 1764,
1335
2430
  "localizeInfos": {
1336
- "en_US": {
1337
- "title": "Product"
1338
- }
2431
+ "title": "Product"
1339
2432
  },
1340
2433
  "isVisible": true,
1341
2434
  "statusId": 1,
@@ -1350,17 +2443,72 @@ Example return:
1350
2443
  "templateIdentifier": "my-template",
1351
2444
  "shortDescTemplateIdentifier": "my-template-short",
1352
2445
  "attributeValues": {
1353
- "en_US": {
1354
- "marker": {
1355
- "value": "",
1356
- "type": "string"
1357
- }
2446
+ "marker": {
2447
+ "value": "",
2448
+ "type": "string"
1358
2449
  }
1359
2450
  },
1360
2451
  "position": 1
1361
2452
  }
1362
2453
  ]
1363
2454
  ```
2455
+ <details>
2456
+ <summary>Schema</summary>
2457
+
2458
+ **id:** number <br>
2459
+ *object identifier* <br>
2460
+ example: 1764
2461
+
2462
+ **localizeInfos:** Record<string, any> <br>
2463
+ *json description of the main page data object taking into account the language "en_US" (for example)* <br>
2464
+ example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
2465
+
2466
+ **isVisible:** boolean <br>
2467
+ *Page visibility flag* <br>
2468
+ example: true
2469
+
2470
+ **position:** number <br>
2471
+ *position number (for sorting)* <br>
2472
+ example: 192
2473
+
2474
+ **templateIdentifier:** string <br>
2475
+ *custom identifier of the associated template* <br>
2476
+ example: my-template
2477
+
2478
+ **attributeSetId:** number <br>
2479
+ *attribute set identifier* <br>
2480
+ example: 7
2481
+
2482
+ **isSync:** boolean <br>
2483
+ *indicator of page indexing (true or false)* <br>
2484
+ example: false
2485
+
2486
+ **attributeValues:** Record<string, string> <br>
2487
+ *Array of attribute values from the index (presented as a pair of custom attribute identifier: attribute value)* <br>
2488
+ example: OrderedMap { "en_US": OrderedMap { "marker": OrderedMap { "value": "", "type": "string" } } }
2489
+
2490
+ **statusId:** number <br>
2491
+ *status identifiers of the product page (can be null)* <br>
2492
+ example: 1
2493
+
2494
+ **relatedIds:** array <br>
2495
+ *identifiers of related product pages* <br>
2496
+ example: List [ 1, 2, 3 ]
2497
+
2498
+ **price:** number <br>
2499
+ *price value of the product page taken from the index* <br>
2500
+ example: 0
2501
+
2502
+ **templateIdentifier** string
2503
+ *custom identifier of the associated template*
2504
+ example: my-template
2505
+
2506
+ **shortDescTemplateIdentifier** string <br>
2507
+ *custom identifier of the associated template for short description* <br>
2508
+ example: my-template-short
2509
+
2510
+ </details>
2511
+
1364
2512
 
1365
2513
  ### Products.getProductsPageById(id, langCode, userQuery)
1366
2514
 
@@ -1407,6 +2555,62 @@ Example return:
1407
2555
  "position": 1
1408
2556
  }
1409
2557
  ```
2558
+ <details>
2559
+ <summary>Schema</summary>
2560
+
2561
+ **id:** number <br>
2562
+ *object identifier* <br>
2563
+ example: 1764
2564
+
2565
+ **localizeInfos:** Record<string, any> <br>
2566
+ *json description of the main page data object taking into account the language "en_US" (for example)* <br>
2567
+ example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
2568
+
2569
+ **isVisible:** boolean <br>
2570
+ *Page visibility flag* <br>
2571
+ example: true
2572
+
2573
+ **position:** number <br>
2574
+ *position number (for sorting)* <br>
2575
+ example: 192
2576
+
2577
+ **templateIdentifier:** string <br>
2578
+ *custom identifier of the associated template* <br>
2579
+ example: my-template
2580
+
2581
+ **attributeSetId:** number <br>
2582
+ *attribute set identifier* <br>
2583
+ example: 7
2584
+
2585
+ **isSync:** boolean <br>
2586
+ *indicator of page indexing (true or false)* <br>
2587
+ example: false
2588
+
2589
+ **attributeValues:** Record<string, string> <br>
2590
+ *Array of attribute values from the index (presented as a pair of custom attribute identifier: attribute value)* <br>
2591
+ example: OrderedMap { "en_US": OrderedMap { "marker": OrderedMap { "value": "", "type": "string" } } }
2592
+
2593
+ **statusId:** number <br>
2594
+ *status identifiers of the product page (can be null)* <br>
2595
+ example: 1
2596
+
2597
+ **relatedIds:** array <br>
2598
+ *identifiers of related product pages* <br>
2599
+ example: List [ 1, 2, 3 ]
2600
+
2601
+ **price:** number <br>
2602
+ *price value of the product page taken from the index* <br>
2603
+ example: 0
2604
+
2605
+ **templateIdentifier** string
2606
+ *custom identifier of the associated template*
2607
+ example: my-template
2608
+
2609
+ **shortDescTemplateIdentifier** string <br>
2610
+ *custom identifier of the associated template for short description* <br>
2611
+ example: my-template-short
2612
+
2613
+ </details>
1410
2614
 
1411
2615
  ### Products.getProductsPageByUrl(url, langCode, userQuery)
1412
2616
 
@@ -1421,7 +2625,8 @@ Example return:
1421
2625
  ```json
1422
2626
  {
1423
2627
  "id": 1764,
1424
- "localizeInfos": {"title": "Product"
2628
+ "localizeInfos": {
2629
+ "title": "Product"
1425
2630
  },
1426
2631
  "isVisible": true,
1427
2632
  "statusId": 1,
@@ -1452,6 +2657,62 @@ Example return:
1452
2657
  "position": 1
1453
2658
  }
1454
2659
  ```
2660
+ <details>
2661
+ <summary>Schema</summary>
2662
+
2663
+ **id:** number <br>
2664
+ *object identifier* <br>
2665
+ example: 1764
2666
+
2667
+ **localizeInfos:** Record<string, any> <br>
2668
+ *json description of the main page data object taking into account the language "en_US" (for example)* <br>
2669
+ example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
2670
+
2671
+ **isVisible:** boolean <br>
2672
+ *Page visibility flag* <br>
2673
+ example: true
2674
+
2675
+ **position:** number <br>
2676
+ *position number (for sorting)* <br>
2677
+ example: 192
2678
+
2679
+ **templateIdentifier:** string <br>
2680
+ *custom identifier of the associated template* <br>
2681
+ example: my-template
2682
+
2683
+ **attributeSetId:** number <br>
2684
+ *attribute set identifier* <br>
2685
+ example: 7
2686
+
2687
+ **isSync:** boolean <br>
2688
+ *indicator of page indexing (true or false)* <br>
2689
+ example: false
2690
+
2691
+ **attributeValues:** Record<string, string> <br>
2692
+ *Array of attribute values from the index (presented as a pair of custom attribute identifier: attribute value)* <br>
2693
+ example: OrderedMap { "en_US": OrderedMap { "marker": OrderedMap { "value": "", "type": "string" } } }
2694
+
2695
+ **statusId:** number <br>
2696
+ *status identifiers of the product page (can be null)* <br>
2697
+ example: 1
2698
+
2699
+ **relatedIds:** array <br>
2700
+ *identifiers of related product pages* <br>
2701
+ example: List [ 1, 2, 3 ]
2702
+
2703
+ **price:** number <br>
2704
+ *price value of the product page taken from the index* <br>
2705
+ example: 0
2706
+
2707
+ **templateIdentifier** string
2708
+ *custom identifier of the associated template*
2709
+ example: my-template
2710
+
2711
+ **shortDescTemplateIdentifier** string <br>
2712
+ *custom identifier of the associated template for short description* <br>
2713
+ example: my-template-short
2714
+
2715
+ </details>
1455
2716
 
1456
2717
  ### Products.getRelatedProductsById(id, langCode, userQuery)
1457
2718
 
@@ -1467,9 +2728,7 @@ Example return:
1467
2728
  {
1468
2729
  "id": 1764,
1469
2730
  "localizeInfos": {
1470
- "en_US": {
1471
- "title": "Product"
1472
- }
2731
+ "title": "Product"
1473
2732
  },
1474
2733
  "isVisible": true,
1475
2734
  "statusId": 1,
@@ -1484,16 +2743,70 @@ Example return:
1484
2743
  "templateIdentifier": "my-template",
1485
2744
  "shortDescTemplateIdentifier": "my-template-short",
1486
2745
  "attributeValues": {
1487
- "en_US": {
1488
- "marker": {
1489
- "value": "",
1490
- "type": "string"
1491
- }
2746
+ "marker": {
2747
+ "value": "",
2748
+ "type": "string"
1492
2749
  }
1493
2750
  },
1494
2751
  "position": 1
1495
2752
  }
1496
2753
  ```
2754
+ <details>
2755
+ <summary>Schema</summary>
2756
+
2757
+ **id:** number <br>
2758
+ *object identifier* <br>
2759
+ example: 1764
2760
+
2761
+ **localizeInfos:** Record<string, any> <br>
2762
+ *json description of the main page data object taking into account the language "en_US" (for example)* <br>
2763
+ example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
2764
+
2765
+ **isVisible:** boolean <br>
2766
+ *Page visibility flag* <br>
2767
+ example: true
2768
+
2769
+ **position:** number <br>
2770
+ *position number (for sorting)* <br>
2771
+ example: 192
2772
+
2773
+ **templateIdentifier:** string <br>
2774
+ *custom identifier of the associated template* <br>
2775
+ example: my-template
2776
+
2777
+ **attributeSetId:** number <br>
2778
+ *attribute set identifier* <br>
2779
+ example: 7
2780
+
2781
+ **isSync:** boolean <br>
2782
+ *indicator of page indexing (true or false)* <br>
2783
+ example: false
2784
+
2785
+ **attributeValues:** Record<string, string> <br>
2786
+ *Array of attribute values from the index (presented as a pair of custom attribute identifier: attribute value)* <br>
2787
+ example: OrderedMap { "en_US": OrderedMap { "marker": OrderedMap { "value": "", "type": "string" } } }
2788
+
2789
+ **statusId:** number <br>
2790
+ *status identifiers of the product page (can be null)* <br>
2791
+ example: 1
2792
+
2793
+ **relatedIds:** array <br>
2794
+ *identifiers of related product pages* <br>
2795
+ example: List [ 1, 2, 3 ]
2796
+
2797
+ **price:** number <br>
2798
+ *price value of the product page taken from the index* <br>
2799
+ example: 0
2800
+
2801
+ **templateIdentifier** string
2802
+ *custom identifier of the associated template*
2803
+ example: my-template
2804
+
2805
+ **shortDescTemplateIdentifier** string <br>
2806
+ *custom identifier of the associated template for short description* <br>
2807
+ example: my-template-short
2808
+
2809
+ </details>
1497
2810
 
1498
2811
  ### Products.getProductById(id, langCode)
1499
2812
 
@@ -1509,9 +2822,7 @@ Example return:
1509
2822
  {
1510
2823
  "id": 1764,
1511
2824
  "localizeInfos": {
1512
- "en_US": {
1513
- "title": "Product"
1514
- }
2825
+ "title": "Product"
1515
2826
  },
1516
2827
  "isVisible": true,
1517
2828
  "statusId": 1,
@@ -1526,17 +2837,71 @@ Example return:
1526
2837
  "templateIdentifier": "my-template",
1527
2838
  "shortDescTemplateIdentifier": "my-template-short",
1528
2839
  "attributeValues": {
1529
- "en_US": {
1530
- "marker": {
1531
- "value": "",
1532
- "type": "string"
1533
- }
2840
+ "marker": {
2841
+ "value": "",
2842
+ "type": "string"
1534
2843
  }
1535
2844
  },
1536
2845
  "position": 1
1537
2846
  }
1538
-
1539
2847
  ```
2848
+ <details>
2849
+ <summary>Schema</summary>
2850
+
2851
+ **id:** number <br>
2852
+ *object identifier* <br>
2853
+ example: 1764
2854
+
2855
+ **localizeInfos:** Record<string, any> <br>
2856
+ *json description of the main page data object taking into account the language "en_US" (for example)* <br>
2857
+ example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
2858
+
2859
+ **isVisible:** boolean <br>
2860
+ *Page visibility flag* <br>
2861
+ example: true
2862
+
2863
+ **position:** number <br>
2864
+ *position number (for sorting)* <br>
2865
+ example: 192
2866
+
2867
+ **templateIdentifier:** string <br>
2868
+ *custom identifier of the associated template* <br>
2869
+ example: my-template
2870
+
2871
+ **attributeSetId:** number <br>
2872
+ *attribute set identifier* <br>
2873
+ example: 7
2874
+
2875
+ **isSync:** boolean <br>
2876
+ *indicator of page indexing (true or false)* <br>
2877
+ example: false
2878
+
2879
+ **attributeValues:** Record<string, string> <br>
2880
+ *Array of attribute values from the index (presented as a pair of custom attribute identifier: attribute value)* <br>
2881
+ example: OrderedMap { "en_US": OrderedMap { "marker": OrderedMap { "value": "", "type": "string" } } }
2882
+
2883
+ **statusId:** number <br>
2884
+ *status identifiers of the product page (can be null)* <br>
2885
+ example: 1
2886
+
2887
+ **relatedIds:** array <br>
2888
+ *identifiers of related product pages* <br>
2889
+ example: List [ 1, 2, 3 ]
2890
+
2891
+ **price:** number <br>
2892
+ *price value of the product page taken from the index* <br>
2893
+ example: 0
2894
+
2895
+ **templateIdentifier** string
2896
+ *custom identifier of the associated template*
2897
+ example: my-template
2898
+
2899
+ **shortDescTemplateIdentifier** string <br>
2900
+ *custom identifier of the associated template for short description* <br>
2901
+ example: my-template-short
2902
+
2903
+ </details>
2904
+
1540
2905
 
1541
2906
  ### Products.filterProduct(data, langCode, userQuery)
1542
2907
 
@@ -1608,6 +2973,62 @@ Example return:
1608
2973
  "position": 1
1609
2974
  }
1610
2975
  ```
2976
+ <details>
2977
+ <summary>Schema</summary>
2978
+
2979
+ **id:** number <br>
2980
+ *object identifier* <br>
2981
+ example: 1764
2982
+
2983
+ **localizeInfos:** Record<string, any> <br>
2984
+ *json description of the main page data object taking into account the language "en_US" (for example)* <br>
2985
+ example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
2986
+
2987
+ **isVisible:** boolean <br>
2988
+ *Page visibility flag* <br>
2989
+ example: true
2990
+
2991
+ **position:** number <br>
2992
+ *position number (for sorting)* <br>
2993
+ example: 192
2994
+
2995
+ **templateIdentifier:** string <br>
2996
+ *custom identifier of the associated template* <br>
2997
+ example: my-template
2998
+
2999
+ **attributeSetId:** number <br>
3000
+ *attribute set identifier* <br>
3001
+ example: 7
3002
+
3003
+ **isSync:** boolean <br>
3004
+ *indicator of page indexing (true or false)* <br>
3005
+ example: false
3006
+
3007
+ **attributeValues:** Record<string, string> <br>
3008
+ *Array of attribute values from the index (presented as a pair of custom attribute identifier: attribute value)* <br>
3009
+ example: OrderedMap { "en_US": OrderedMap { "marker": OrderedMap { "value": "", "type": "string" } } }
3010
+
3011
+ **statusId:** number <br>
3012
+ *status identifiers of the product page (can be null)* <br>
3013
+ example: 1
3014
+
3015
+ **relatedIds:** array <br>
3016
+ *identifiers of related product pages* <br>
3017
+ example: List [ 1, 2, 3 ]
3018
+
3019
+ **price:** number <br>
3020
+ *price value of the product page taken from the index* <br>
3021
+ example: 0
3022
+
3023
+ **templateIdentifier** string
3024
+ *custom identifier of the associated template*
3025
+ example: my-template
3026
+
3027
+ **shortDescTemplateIdentifier** string <br>
3028
+ *custom identifier of the associated template for short description* <br>
3029
+ example: my-template-short
3030
+
3031
+ </details>
1611
3032
 
1612
3033
  ### Products.searchProduct(name, langCode)
1613
3034
 
@@ -1656,6 +3077,66 @@ Example return:
1656
3077
  }
1657
3078
  ]
1658
3079
  ```
3080
+ <details>
3081
+ <summary>Schema</summary>
3082
+
3083
+ **id:** number <br>
3084
+ *object identifier* <br>
3085
+ example: 1764
3086
+
3087
+ **localizeInfos:** Record<string, any> <br>
3088
+ *json description of the main page data object taking into account the language "en_US" (for example)* <br>
3089
+ example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
3090
+
3091
+ **isVisible:** boolean <br>
3092
+ *Page visibility flag* <br>
3093
+ example: true
3094
+
3095
+ **position:** number <br>
3096
+ *position number (for sorting)* <br>
3097
+ example: 192
3098
+
3099
+ **templateIdentifier:** string <br>
3100
+ *custom identifier of the associated template* <br>
3101
+ example: my-template
3102
+
3103
+ **attributeSetId:** number <br>
3104
+ *attribute set identifier* <br>
3105
+ example: 7
3106
+
3107
+ **isSync:** boolean <br>
3108
+ *indicator of page indexing (true or false)* <br>
3109
+ example: false
3110
+
3111
+ **attributeValues:** Record<string, string> <br>
3112
+ *Array of attribute values from the index (presented as a pair of custom attribute identifier: attribute value)* <br>
3113
+ example: OrderedMap { "en_US": OrderedMap { "marker": OrderedMap { "value": "", "type": "string" } } }
3114
+
3115
+ **statusId:** number <br>
3116
+ *status identifiers of the product page (can be null)* <br>
3117
+ example: 1
3118
+
3119
+ **relatedIds:** array <br>
3120
+ *identifiers of related product pages* <br>
3121
+ example: List [ 1, 2, 3 ]
3122
+
3123
+ **price:** number <br>
3124
+ *price value of the product page taken from the index* <br>
3125
+ example: 0
3126
+
3127
+ **templateIdentifier** string
3128
+ *custom identifier of the associated template*
3129
+ example: my-template
3130
+
3131
+ **shortDescTemplateIdentifier** string <br>
3132
+ *custom identifier of the associated template for short description* <br>
3133
+ example: my-template-short
3134
+
3135
+ </details>
3136
+
3137
+ ---
3138
+
3139
+
1659
3140
 
1660
3141
  ## ProductStatuses
1661
3142
 
@@ -1681,13 +3162,34 @@ Example return:
1681
3162
  "version": 10,
1682
3163
  "identifier": "catalog",
1683
3164
  "localizeInfos": {
1684
- "en_US": {
1685
- "title": "Status 1"
1686
- }
3165
+ "title": "Status 1"
1687
3166
  }
1688
3167
  }
1689
3168
  ]
1690
3169
  ```
3170
+ <details>
3171
+ <summary>Schema</summary>
3172
+
3173
+ **id:** number <br>
3174
+ *object identifier* <br>
3175
+ example: 1764
3176
+
3177
+ **updatedDate:** string($date-time) <br>
3178
+ *object's date of modification* <br>
3179
+
3180
+ **version** number <br>
3181
+ *object's version number of modification* <br>
3182
+ example: 10
3183
+
3184
+ **identifier:** string <br>
3185
+ *textual identifier for a field in the record* <br>
3186
+ example: catalog
3187
+
3188
+ **localizeInfos:** Record<string, any> <br>
3189
+ *json description of the main page data object taking into account the language "en_US" (for example)* <br>
3190
+ example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
3191
+
3192
+ </details>
1691
3193
 
1692
3194
  ### ProductStatuses.getProductStatusesById(id)
1693
3195
 
@@ -1706,12 +3208,33 @@ Example return:
1706
3208
  "version": 10,
1707
3209
  "identifier": "catalog",
1708
3210
  "localizeInfos": {
1709
- "en_US": {
1710
- "title": "Status 1"
1711
- }
3211
+ "title": "Status 1"
1712
3212
  }
1713
3213
  }
1714
3214
  ```
3215
+ <details>
3216
+ <summary>Schema</summary>
3217
+
3218
+ **id:** number <br>
3219
+ *object identifier* <br>
3220
+ example: 1764
3221
+
3222
+ **updatedDate:** string($date-time) <br>
3223
+ *object's date of modification* <br>
3224
+
3225
+ **version** number <br>
3226
+ *object's version number of modification* <br>
3227
+ example: 10
3228
+
3229
+ **identifier:** string <br>
3230
+ *textual identifier for a field in the record* <br>
3231
+ example: catalog
3232
+
3233
+ **localizeInfos:** Record<string, any> <br>
3234
+ *json description of the main page data object taking into account the language "en_US" (for example)* <br>
3235
+ example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
3236
+
3237
+ </details>
1715
3238
 
1716
3239
  ### ProductStatuses.getProductsByStatusMarker(marker)
1717
3240
 
@@ -1730,12 +3253,33 @@ Example return:
1730
3253
  "version": 10,
1731
3254
  "identifier": "catalog",
1732
3255
  "localizeInfos": {
1733
- "en_US": {
1734
- "title": "Status 1"
1735
- }
3256
+ "title": "Status 1"
1736
3257
  }
1737
3258
  }
1738
3259
  ```
3260
+ <details>
3261
+ <summary>Schema</summary>
3262
+
3263
+ **id:** number <br>
3264
+ *object identifier* <br>
3265
+ example: 1764
3266
+
3267
+ **updatedDate:** string($date-time) <br>
3268
+ *object's date of modification* <br>
3269
+
3270
+ **version** number <br>
3271
+ *object's version number of modification* <br>
3272
+ example: 10
3273
+
3274
+ **identifier:** string <br>
3275
+ *textual identifier for a field in the record* <br>
3276
+ example: catalog
3277
+
3278
+ **localizeInfos:** Record<string, any> <br>
3279
+ *json description of the main page data object taking into account the language "en_US" (for example)* <br>
3280
+ example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
3281
+
3282
+ </details>
1739
3283
 
1740
3284
  ### ProductStatuses.validateMarker(marker)
1741
3285
 
@@ -1751,6 +3295,10 @@ Example return:
1751
3295
  true
1752
3296
  ```
1753
3297
 
3298
+ ---
3299
+
3300
+
3301
+
1754
3302
  ## System
1755
3303
 
1756
3304
  ```js
@@ -1803,9 +3351,7 @@ Example return:
1803
3351
  },
1804
3352
  "generalTypeId": 4,
1805
3353
  "localizeInfos": {
1806
- "en_US": {
1807
- "title": "Page template"
1808
- }
3354
+ "title": "Page template"
1809
3355
  },
1810
3356
  "position": 0,
1811
3357
  "positionId": 12,
@@ -1813,6 +3359,50 @@ Example return:
1813
3359
  }
1814
3360
  ]
1815
3361
  ```
3362
+ <details>
3363
+ <summary>Schema</summary>
3364
+
3365
+ **id:** number <br>
3366
+ *object identifier* <br>
3367
+ example: 1764
3368
+
3369
+ **updatedDate:** string($date-time) <br>
3370
+ *object's date of modification* <br>
3371
+
3372
+ **version** number <br>
3373
+ *object's version number of modification* <br>
3374
+ example: 10
3375
+
3376
+ **identifier:** string <br>
3377
+ *textual identifier for a field in the record* <br>
3378
+ example: catalog
3379
+
3380
+ **generalType:**: object <br>
3381
+ *object type* <br>
3382
+ example: OrderedMap { "id": 4, "type": "forCatalogPages" }
3383
+
3384
+ **generalTypeId:** number
3385
+ *type identifier*
3386
+ example: 4
3387
+
3388
+ **localizeInfos:** Record<string, any> <br>
3389
+ *json description of the main page data object taking into account the language "en_US" (for example)* <br>
3390
+ example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
3391
+
3392
+ **position** object <br>
3393
+ *position number* <br>
3394
+ example: 0
3395
+
3396
+
3397
+ **positionId:** number <br>
3398
+ *position object identifier* <br>
3399
+ example: 12
3400
+
3401
+ **generalTypeName** string <br>
3402
+ *example: forProductPreview* <br>
3403
+ general type name
3404
+
3405
+ </details>
1816
3406
 
1817
3407
  ### Templates.getTemplateByType(type)
1818
3408
 
@@ -1837,9 +3427,7 @@ Example return:
1837
3427
  },
1838
3428
  "generalTypeId": 4,
1839
3429
  "localizeInfos": {
1840
- "en_US": {
1841
- "title": "Page template"
1842
- }
3430
+ "title": "Page template"
1843
3431
  },
1844
3432
  "position": 0,
1845
3433
  "positionId": 12,
@@ -1847,6 +3435,52 @@ Example return:
1847
3435
  }
1848
3436
  ]
1849
3437
  ```
3438
+ <details>
3439
+ <summary>Schema</summary>
3440
+
3441
+ **id:** number <br>
3442
+ *object identifier* <br>
3443
+ example: 1764
3444
+
3445
+ **updatedDate:** string($date-time) <br>
3446
+ *object's date of modification* <br>
3447
+
3448
+ **version** number <br>
3449
+ *object's version number of modification* <br>
3450
+ example: 10
3451
+
3452
+ **identifier:** string <br>
3453
+ *textual identifier for a field in the record* <br>
3454
+ example: catalog
3455
+
3456
+ **generalType:**: object <br>
3457
+ *object type* <br>
3458
+ example: OrderedMap { "id": 4, "type": "forCatalogPages" }
3459
+
3460
+ **generalTypeId:** number
3461
+ *type identifier*
3462
+ example: 4
3463
+
3464
+ **localizeInfos:** Record<string, any> <br>
3465
+ *json description of the main page data object taking into account the language "en_US" (for example)* <br>
3466
+ example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
3467
+
3468
+ **position** object <br>
3469
+ *position number* <br>
3470
+ example: 0
3471
+
3472
+
3473
+ **positionId:** number <br>
3474
+ *position object identifier* <br>
3475
+ example: 12
3476
+
3477
+ **generalTypeName** string <br>
3478
+ *example: forProductPreview* <br>
3479
+ general type name
3480
+
3481
+ </details>
3482
+
3483
+ ---
1850
3484
 
1851
3485
  ## TemplatePreviews
1852
3486
 
@@ -1894,14 +3528,49 @@ Example return:
1894
3528
  }
1895
3529
  },
1896
3530
  "localizeInfos": {
1897
- "en_US": {
1898
- "title": "Page Template"
1899
- }
3531
+ "title": "Page Template"
1900
3532
  },
1901
3533
  "position": 0
1902
3534
  }
1903
3535
  ]
1904
3536
  ```
3537
+ <details>
3538
+ <summary>Schema</summary>
3539
+
3540
+ **id:** number <br>
3541
+ *object identifier* <br>
3542
+ example: 1764
3543
+
3544
+ **updatedDate:** string($date-time) <br>
3545
+ *object's date of modification* <br>
3546
+
3547
+ **version** number <br>
3548
+ *object's version number of modification* <br>
3549
+ example: 10
3550
+
3551
+ **identifier:** string <br>
3552
+ *textual identifier for a field in the record* <br>
3553
+ example: catalog
3554
+
3555
+ **proportion** ITemplateProportionType <br>
3556
+ *template proportion parameters* <br>
3557
+ 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" } }
3558
+
3559
+ **localizeInfos:** Record<string, any> <br>
3560
+ *json description of the main page data object taking into account the language "en_US" (for example)* <br>
3561
+ example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
3562
+
3563
+ **position** object <br>
3564
+ *position number* <br>
3565
+ example: 0
3566
+
3567
+
3568
+ **positionId:** number <br>
3569
+ *position object identifier* <br>
3570
+ example: 12
3571
+
3572
+ </details>
3573
+
1905
3574
 
1906
3575
  ### TemplatePreviews.getTemplatesPreviewById(id)
1907
3576
 
@@ -1942,13 +3611,47 @@ Example return:
1942
3611
  }
1943
3612
  },
1944
3613
  "localizeInfos": {
1945
- "en_US": {
1946
- "title": "Page Template"
1947
- }
3614
+ "title": "Page Template"
1948
3615
  },
1949
3616
  "position": 0
1950
3617
  }
1951
3618
  ```
3619
+ <details>
3620
+ <summary>Schema</summary>
3621
+
3622
+ **id:** number <br>
3623
+ *object identifier* <br>
3624
+ example: 1764
3625
+
3626
+ **updatedDate:** string($date-time) <br>
3627
+ *object's date of modification* <br>
3628
+
3629
+ **version** number <br>
3630
+ *object's version number of modification* <br>
3631
+ example: 10
3632
+
3633
+ **identifier:** string <br>
3634
+ *textual identifier for a field in the record* <br>
3635
+ example: catalog
3636
+
3637
+ **proportion** ITemplateProportionType <br>
3638
+ *template proportion parameters* <br>
3639
+ 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" } }
3640
+
3641
+ **localizeInfos:** Record<string, any> <br>
3642
+ *json description of the main page data object taking into account the language "en_US" (for example)* <br>
3643
+ example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
3644
+
3645
+ **position** object <br>
3646
+ *position number* <br>
3647
+ example: 0
3648
+
3649
+
3650
+ **positionId:** number <br>
3651
+ *position object identifier* <br>
3652
+ example: 12
3653
+
3654
+ </details>
1952
3655
 
1953
3656
  ### TemplatePreviews.getTemplatesPreviewByMarker(marker)
1954
3657
 
@@ -1989,10 +3692,47 @@ Example return:
1989
3692
  }
1990
3693
  },
1991
3694
  "localizeInfos": {
1992
- "en_US": {
1993
- "title": "Page Template"
1994
- }
3695
+ "title": "Page Template"
1995
3696
  },
1996
3697
  "position": 0
1997
3698
  }
1998
- ```
3699
+ ```
3700
+ <details>
3701
+ <summary>Schema</summary>
3702
+
3703
+ **id:** number <br>
3704
+ *object identifier* <br>
3705
+ example: 1764
3706
+
3707
+ **updatedDate:** string($date-time) <br>
3708
+ *object's date of modification* <br>
3709
+
3710
+ **version** number <br>
3711
+ *object's version number of modification* <br>
3712
+ example: 10
3713
+
3714
+ **identifier:** string <br>
3715
+ *textual identifier for a field in the record* <br>
3716
+ example: catalog
3717
+
3718
+ **proportion** ITemplateProportionType <br>
3719
+ *template proportion parameters* <br>
3720
+ 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" } }
3721
+
3722
+ **localizeInfos:** Record<string, any> <br>
3723
+ *json description of the main page data object taking into account the language "en_US" (for example)* <br>
3724
+ example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } }
3725
+
3726
+ **position** object <br>
3727
+ *position number* <br>
3728
+ example: 0
3729
+
3730
+
3731
+ **positionId:** number <br>
3732
+ *position object identifier* <br>
3733
+ example: 12
3734
+
3735
+ </details>
3736
+ ---
3737
+
3738
+