oneentry 1.0.71 → 1.0.73

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
@@ -95,7 +95,8 @@ const api = defineOneEntry('https://my-project.oneentry.cloud', {
95
95
  langCode:'en_US',
96
96
  traficLimit: true,
97
97
  auth: {
98
- customAuth: true
98
+ customAuth: true,
99
+ refreshToken: localStorage.getItem('refreshToken')
99
100
  }
100
101
  })
101
102
  ```
@@ -449,8 +450,7 @@ Example return:
449
450
  "identifier": "catalog",
450
451
  "isActive": false,
451
452
  "authProviderId": 1,
452
- "formData": {
453
- "en_US": [
453
+ "formData": [
454
454
  {
455
455
  "marker": "login",
456
456
  "value": "test"
@@ -459,15 +459,14 @@ Example return:
459
459
  "marker": "f-name",
460
460
  "value": "Second name"
461
461
  }
462
- ]
463
- },
462
+ ],
464
463
  "notificationData": {
465
464
  "email": "test@test.com",
466
465
  "phonePush": "",
467
466
  "phoneSMS": "+9999999999"
468
467
  },
469
468
  "systemCode": {
470
- "value": "90ВDCX",
469
+ "value": "90BDCX",
471
470
  "expiredDate": "2024-05-07T21:02:00.000Z"
472
471
  }
473
472
  }
@@ -506,7 +505,7 @@ example: OrderedMap { "email": "test@test.zone", "phonePush": "", "phoneSMS": "
506
505
 
507
506
  **systemCode:** string <br>
508
507
  *system code for performing official actions (password reset, activation)* <br>
509
- example: OrderedMap { "value": "90ВDCX", "expiredDate": "2024-05-07T21:02:00.000Z" } <br>
508
+ example: OrderedMap { "value": "90BDCX", "expiredDate": "2024-05-07T21:02:00.000Z" } <br>
510
509
 
511
510
  **formIdentifier:** string <br>
512
511
  *the text identifier of the authorization provider's form* <br>
@@ -523,15 +522,24 @@ example: 1 <br>
523
522
  </details>
524
523
 
525
524
 
526
- ### AuthProvider.generateCode(marker, userIdentifier)
525
+ ### AuthProvider.generateCode(marker, userIdentifier, eventIdentifier)
527
526
 
528
527
 
529
528
  ```js
530
- const value = await AuthProvider.generateCode('email', 'test@trer.com')
529
+ const value = await AuthProvider.generateCode('email', 'test@trer.com', 'auth')
531
530
  ```
532
531
 
533
532
  > This method receives a code to activate the user. The code is returned via the appropriate user notification method
534
533
 
534
+ Example return:
535
+
536
+ ```json
537
+ {
538
+ "userIdentifier": "example@oneentry.cloud",
539
+ "eventIdentifier": "auth"
540
+ }
541
+ ```
542
+
535
543
 
536
544
  ### AuthProvider.checkCode(marker, userIdentifier, code)
537
545
 
@@ -697,16 +705,22 @@ Example return:
697
705
  ```json
698
706
  [
699
707
  {
700
- "id": 1764,
708
+ "id": 1,
701
709
  "localizeInfos": {
702
- "title": "My block"
710
+ "title": "email"
703
711
  },
704
- "version": 10,
705
- "identifier": "catalog",
706
- "isActive": false,
707
- "isCheckCode": false,
712
+ "config": {
713
+ "deleteNoneActiveUsersAfterDays": 2,
714
+ "systemCodeTlsSec": 120,
715
+ "systemCodeLength": 8,
716
+ "systemCodeOnlyNumbers": null
717
+ },
718
+ "version": 0,
719
+ "identifier": "email",
708
720
  "type": "email",
709
- "formIdentifier": null
721
+ "formIdentifier": "reg",
722
+ "isActive": true,
723
+ "isCheckCode": false
710
724
  }
711
725
  ]
712
726
  ```
@@ -760,18 +774,26 @@ const value = await AuthProvider.getMarker('email')
760
774
  Example return:
761
775
 
762
776
  ```json
763
- {
764
- "id": 1764,
765
- "localizeInfos": {
766
- "title": "My block"
767
- },
768
- "version": 10,
769
- "identifier": "catalog",
770
- "isActive": false,
771
- "isCheckCode": false,
772
- "type": "email",
773
- "formIdentifier": null
774
- }
777
+ [
778
+ {
779
+ "id": 1,
780
+ "localizeInfos": {
781
+ "title": "email"
782
+ },
783
+ "version": 0,
784
+ "identifier": "email",
785
+ "type": "email",
786
+ "formIdentifier": "reg",
787
+ "isActive": true,
788
+ "isCheckCode": false,
789
+ "config": {
790
+ "deleteNoneActiveUsersAfterDays": 2,
791
+ "systemCodeLength": 8,
792
+ "systemCodeOnlyNumbers": null,
793
+ "systemCodeTlsSec": 120
794
+ }
795
+ }
796
+ ]
775
797
  ```
776
798
  <details>
777
799
  <summary>Schema</summary>
@@ -823,7 +845,7 @@ const { Blocks } = defineOneEntry('your-url');
823
845
  ### Blocks.getBlocks(type, langCode, offset, limit)
824
846
 
825
847
  ```js
826
- const value = await Blocks.getBlocks()
848
+ const value = await Blocks.getBlocks('forTextBlock')
827
849
  ```
828
850
 
829
851
  > This method return array of all blocks object. Available values of type : forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, forOrder, service
@@ -833,57 +855,18 @@ Example return:
833
855
  ```json
834
856
  [
835
857
  {
836
- "id": 4,
858
+ "id": 1,
837
859
  "localizeInfos": {
838
- "title": "Name"
860
+ "title": "Block"
839
861
  },
840
862
  "version": 0,
841
- "position": 3,
842
- "identifier": "product",
843
- "type": "forProductBlock",
863
+ "position": 1,
864
+ "identifier": "block",
865
+ "type": "forTextBlock",
844
866
  "templateIdentifier": null,
845
867
  "isVisible": true,
846
- "attributeValues": {
847
- "attr": {
848
- "type": "string",
849
- "value": "",
850
- "position": 0,
851
- "isProductPreview": false
852
- }
853
- },
854
- "countElementsPerRow": 3,
855
- "products": [
856
- {
857
- "id": 446,
858
- "localizeInfos": {
859
- "title": "new product 3"
860
- },
861
- "relatedIds": [1, 2],
862
- "statusId": null,
863
- "attributeSetId": 11,
864
- "position": 3,
865
- "templateIdentifier": null,
866
- "shortDescTemplateIdentifier": null,
867
- "price": 543,
868
- "sku": "ggg",
869
- "isSync": true,
870
- "attributeValues": {
871
- "sku": {
872
- "type": "string",
873
- "value": "ggg",
874
- "position": 0,
875
- "isProductPreview": false
876
- },
877
- "images": {
878
- "type": "groupOfImages",
879
- "value": {},
880
- "position": 3,
881
- "isProductPreview": false
882
- }
883
- },
884
- "isVisible": true
885
- }
886
- ]
868
+ "attributeValues": {},
869
+ "countElementsPerRow": 0
887
870
  }
888
871
  ]
889
872
  ```
@@ -941,7 +924,7 @@ example: null <br>
941
924
  ### Blocks.getBlockByMarker(marker, langCode)
942
925
 
943
926
  ```js
944
- const value = await Blocks.getBlockByMarker('my-marker', 'en_US')
927
+ const value = await Blocks.getBlockByMarker('my-marker')
945
928
  ```
946
929
 
947
930
  > This method return one blocks object by marker.
@@ -958,6 +941,7 @@ Example return:
958
941
  "position": 1,
959
942
  "identifier": "block",
960
943
  "type": "forTextBlock",
944
+ "countElementsPerRow": 0,
961
945
  "templateIdentifier": null,
962
946
  "isVisible": true,
963
947
  "attributeValues": {}
@@ -1031,19 +1015,27 @@ Example return:
1031
1015
  "localizeInfos": {
1032
1016
  "title": "Box"
1033
1017
  },
1034
- "relatedIds": [],
1035
- "statusId": 2,
1036
- "attributeSetId": 5,
1018
+ "statusIdentifier": "sold",
1019
+ "statusLocalizeInfos": {
1020
+ "title": "Sold"
1021
+ },
1022
+ "attributeSetIdentifier": "products",
1037
1023
  "position": 1,
1038
1024
  "templateIdentifier": null,
1039
1025
  "shortDescTemplateIdentifier": null,
1040
- "price": 150,
1026
+ "price": 148,
1027
+ "additional": {
1028
+ "prices": {
1029
+ "min": 120,
1030
+ "max": 150
1031
+ }
1032
+ },
1041
1033
  "sku": null,
1042
1034
  "isSync": true,
1043
1035
  "attributeValues": {
1044
1036
  "price": {
1045
1037
  "type": "integer",
1046
- "value": "150",
1038
+ "value": "148",
1047
1039
  "position": 1,
1048
1040
  "isProductPreview": false
1049
1041
  },
@@ -1052,6 +1044,12 @@ Example return:
1052
1044
  "value": "Box text",
1053
1045
  "position": 0,
1054
1046
  "isProductPreview": false
1047
+ },
1048
+ "currency_products": {
1049
+ "type": "string",
1050
+ "value": "$",
1051
+ "position": 2,
1052
+ "isProductPreview": false
1055
1053
  }
1056
1054
  },
1057
1055
  "isVisible": true
@@ -1074,29 +1072,42 @@ Example return:
1074
1072
  ```json
1075
1073
  [
1076
1074
  {
1077
- "id": 446,
1075
+ "id": 3,
1078
1076
  "localizeInfos": {
1079
- "title": "new product 3"
1077
+ "title": "Product"
1080
1078
  },
1081
- "relatedIds": [1, 2],
1082
- "statusId": null,
1083
- "position": 3,
1079
+ "statusIdentifier": null,
1080
+ "statusLocalizeInfos": {},
1081
+ "attributeSetIdentifier": "products",
1082
+ "position": 1,
1084
1083
  "templateIdentifier": null,
1085
1084
  "shortDescTemplateIdentifier": null,
1086
- "price": 543,
1087
- "sku": "ggg",
1085
+ "price": 120,
1086
+ "additional": {
1087
+ "prices": {
1088
+ "min": 120,
1089
+ "max": 150
1090
+ }
1091
+ },
1092
+ "sku": null,
1088
1093
  "isSync": true,
1089
1094
  "attributeValues": {
1090
- "sku": {
1095
+ "price": {
1096
+ "type": "integer",
1097
+ "value": "120",
1098
+ "position": 1,
1099
+ "isProductPreview": false
1100
+ },
1101
+ "product-name": {
1091
1102
  "type": "string",
1092
- "value": "ggg",
1103
+ "value": "Prod",
1093
1104
  "position": 0,
1094
1105
  "isProductPreview": false
1095
1106
  },
1096
- "images": {
1097
- "type": "groupOfImages",
1098
- "value": {},
1099
- "position": 3,
1107
+ "currency_products": {
1108
+ "type": "string",
1109
+ "value": "$",
1110
+ "position": 2,
1100
1111
  "isProductPreview": false
1101
1112
  }
1102
1113
  },
@@ -1583,6 +1594,7 @@ Example with a simple type attribute "radioButton" or "list"
1583
1594
  "value": "1",
1584
1595
  "extended": {
1585
1596
  "value": "red",
1597
+ "type": "string",
1586
1598
  "type": "string"
1587
1599
  }
1588
1600
  }
@@ -1600,6 +1612,7 @@ const body = {
1600
1612
  formData: {
1601
1613
  marker: 'test',
1602
1614
  value: 'Test',
1615
+ "type": "string"
1603
1616
  },
1604
1617
  }
1605
1618
 
@@ -1619,7 +1632,8 @@ Example return:
1619
1632
  "time": "2023-02-12 10:56",
1620
1633
  "formData": {
1621
1634
  "marker": "name_1",
1622
- "value": "Name"
1635
+ "value": "Name",
1636
+ "type": "string"
1623
1637
  }
1624
1638
  }
1625
1639
  ```
@@ -1661,7 +1675,8 @@ Example return:
1661
1675
  "time": "2023-02-12 10:56",
1662
1676
  "formData": {
1663
1677
  "marker": "name_1",
1664
- "value": "Name"
1678
+ "value": "Name",
1679
+ "type": "string"
1665
1680
  },
1666
1681
  "attributeSetIdentifier": "test-form"
1667
1682
  }
@@ -1711,7 +1726,8 @@ Example return:
1711
1726
  "time": "2023-02-12 10:56",
1712
1727
  "formData": {
1713
1728
  "marker": "name_1",
1714
- "value": "Name"
1729
+ "value": "Name",
1730
+ "type": "string"
1715
1731
  },
1716
1732
  "attributeSetIdentifier": "test-form"
1717
1733
  }
@@ -1937,16 +1953,17 @@ const value = await Orders.getOrderByMarker('my-order')
1937
1953
  Example return:
1938
1954
  ```json
1939
1955
  {
1940
- "id": 1764,
1956
+ "id": 2,
1941
1957
  "localizeInfos": {
1942
- "title": "Order 1"
1958
+ "title": "My order"
1943
1959
  },
1944
- "identifier": "catalog",
1945
- "generalTypeId": 4,
1946
- "formIdentifier": "catalog-form",
1960
+ "position": 1,
1961
+ "identifier": "my_order",
1962
+ "formIdentifier": "orderForm",
1963
+ "generalTypeId": 21,
1947
1964
  "paymentAccountIdentifiers": [
1948
1965
  {
1949
- "identifier": "p1"
1966
+ "identifier": "cash"
1950
1967
  }
1951
1968
  ]
1952
1969
  }
@@ -1985,33 +2002,17 @@ example: [{ "identifier": "p1" }] <br>
1985
2002
 
1986
2003
  ```js
1987
2004
  const body = {
1988
- "formIdentifier": "order_form",
1989
- "paymentAccountIdentifier": "stripe",
1990
- "formData": [
1991
- {
1992
- "marker": "name_order",
1993
- "value": "Alex",
1994
- "type": "string"
1995
- },
1996
- {
1997
- "marker": "phone_order",
1998
- "value": "+19999999999",
1999
- "type": "string"
2000
- },
2001
- {
2002
- "marker": "email_order",
2003
- "value": "example@oneentry.cloud",
2004
- "type": "string"
2005
- }
2006
- ],
2005
+ "formIdentifier": "orderForm",
2006
+ "paymentAccountIdentifier": "cash",
2007
+ "formData": {
2008
+ "marker": "order_name",
2009
+ "value": "Ivan",
2010
+ "type": "string"
2011
+ },
2007
2012
  "products": [
2008
2013
  {
2009
- "productId": 444,
2010
- "quantity": 1,
2011
- },
2012
- {
2013
- "productId": 446,
2014
- "quantity": 3,
2014
+ "productId": 2,
2015
+ "quantity": 2
2015
2016
  }
2016
2017
  ]
2017
2018
  }
@@ -2029,10 +2030,11 @@ Example return:
2029
2030
  "statusIdentifier": "inprogress",
2030
2031
  "formData": [
2031
2032
  {
2032
- "marker": "Name",
2033
+ "marker": "naimenovanie_1",
2034
+ "type": "string",
2033
2035
  "value": "Name"
2034
2036
  }
2035
- ],
2037
+ ],
2036
2038
  "products": [
2037
2039
  {
2038
2040
  "productId": 1,
@@ -2043,7 +2045,7 @@ Example return:
2043
2045
  "quantity": 3
2044
2046
  }
2045
2047
  ],
2046
- "createdDate": "2024-06-04T09:57:38.328Z",
2048
+ "createdDate": "2024-06-21T09:42:54.848Z",
2047
2049
  "currency": "USD",
2048
2050
  "totalSum": 345
2049
2051
  }
@@ -2089,33 +2091,17 @@ example: 2023-01-01 12:12 <br>
2089
2091
 
2090
2092
  ```js
2091
2093
  const body = {
2092
- "formIdentifier": "order_form",
2093
- "paymentAccountIdentifier": "stripe",
2094
- "formData": [
2095
- {
2096
- "marker": "name_order",
2097
- "value": "Alex",
2098
- "type": "string"
2099
- },
2100
- {
2101
- "marker": "phone_order",
2102
- "value": "+19999999999",
2103
- "type": "string"
2104
- },
2105
- {
2106
- "marker": "email_order",
2107
- "value": "example@oneentry.cloud",
2108
- "type": "string"
2109
- }
2110
- ],
2094
+ "formIdentifier": "orderForm",
2095
+ "paymentAccountIdentifier": "cash",
2096
+ "formData": {
2097
+ "marker": "order_name",
2098
+ "value": "Ivan",
2099
+ "type": "string"
2100
+ },
2111
2101
  "products": [
2112
2102
  {
2113
- "productId": 444,
2114
- "quantity": 1,
2115
- },
2116
- {
2117
- "productId": 446,
2118
- "quantity": 3,
2103
+ "productId": 2,
2104
+ "quantity": 2
2119
2105
  }
2120
2106
  ]
2121
2107
  }
@@ -2133,10 +2119,11 @@ Example return:
2133
2119
  "statusIdentifier": "inprogress",
2134
2120
  "formData": [
2135
2121
  {
2136
- "marker": "Name",
2122
+ "marker": "naimenovanie_1",
2123
+ "type": "string",
2137
2124
  "value": "Name"
2138
2125
  }
2139
- ],
2126
+ ],
2140
2127
  "products": [
2141
2128
  {
2142
2129
  "productId": 1,
@@ -2147,7 +2134,7 @@ Example return:
2147
2134
  "quantity": 3
2148
2135
  }
2149
2136
  ],
2150
- "createdDate": "2024-06-04T09:57:38.328Z",
2137
+ "createdDate": "2024-06-21T09:42:54.848Z",
2151
2138
  "currency": "USD",
2152
2139
  "totalSum": 345
2153
2140
  }
@@ -2259,27 +2246,27 @@ Example return:
2259
2246
  ```json
2260
2247
  [
2261
2248
  {
2262
- "id": 17,
2249
+ "id": 1764,
2263
2250
  "statusIdentifier": "inprogress",
2264
- "paymentIdentifier": "payment-1",
2251
+ "formIdentifier": "order-form",
2265
2252
  "formData": [
2266
2253
  {
2267
- "marker": "name_1",
2268
- "value": "Name",
2269
- "type": "string"
2254
+ "marker": "naimenovanie_1",
2255
+ "type": "string",
2256
+ "value": "Name"
2270
2257
  }
2271
2258
  ],
2272
2259
  "products": [
2273
2260
  {
2274
2261
  "id": 1,
2275
- "title": "Floorwood Maxima Laminate, 9811 Oak Mistral",
2262
+ "title": "Laminate Floorwood Maxima, 9811 Oak Mistral",
2276
2263
  "sku": null,
2277
2264
  "price": "1.00",
2278
2265
  "quantity": 10,
2279
2266
  "previewImage": [
2280
2267
  {
2281
2268
  "filename": "files/project/page/36/image/20240322_77c83b02-4c82-4bea-80eb-3763c469b00e.jpg",
2282
- "downloadLink": "http://my-site.com/files/project/page/36/image/20240322_77c83b02-4c82-4bea-80eb-3763c469b00e.jpg",
2269
+ "downloadLink": "http://my-site.zone/files/project/page/36/image/20240322_77c83b02-4c82-4bea-80eb-3763c469b00e.jpg",
2283
2270
  "size": 296391,
2284
2271
  "previewLink": ""
2285
2272
  }
@@ -2289,10 +2276,8 @@ Example return:
2289
2276
  "totalSum": "12.00",
2290
2277
  "currency": "USD",
2291
2278
  "createdDate": "2023-01-01 12:12",
2292
- "price": 20,
2293
2279
  "paymentAccountIdentifier": "payment-1",
2294
- "paymentAccountLocalizeInfos": {
2295
- "title": "Account 1"
2280
+ "paymentAccountLocalizeInfos": {"title": "Account 1"
2296
2281
  },
2297
2282
  "isHistory": true
2298
2283
  }
@@ -2371,33 +2356,32 @@ Example return:
2371
2356
  ```json
2372
2357
  [
2373
2358
  {
2374
- "id": 1764,
2375
- "parentId": null,
2376
- "config": {
2377
- "rowsPerPage": 1,
2378
- "productsPerRow": 1
2379
- },
2380
- "pageUrl": "string",
2381
- "depth": 3,
2382
- "localizeInfos": {
2383
- "title": "Catalog",
2384
- "content": "Content for catalog",
2385
- "menuTitle": "Catalog"
2386
- },
2387
- "isVisible": true,
2388
- "products": 0,
2389
- "attributeSetId": 7,
2390
- "isSync": false,
2391
- "templateIdentifier": "my-template",
2392
- "attributeValues": {
2393
- "marker": {
2394
- "value": "",
2395
- "type": "string"
2396
- }
2397
- },
2398
- "position": 192,
2399
- "type": "forNewsPage",
2400
- "childrenCount": 0
2359
+ "id": 1,
2360
+ "config": {},
2361
+ "depth": 0,
2362
+ "parentId": null,
2363
+ "pageUrl": "blog",
2364
+ "attributeSetIdentifier": "page",
2365
+ "localizeInfos": {
2366
+ "title": "Blog",
2367
+ "menuTitle": "Blog",
2368
+ "htmlContent": "",
2369
+ "plainContent": ""
2370
+ },
2371
+ "position": 1,
2372
+ "isVisible": true,
2373
+ "products": 0,
2374
+ "childrenCount": 1,
2375
+ "type": "forUsualPage",
2376
+ "templateIdentifier": "template",
2377
+ "isSync": true,
2378
+ "attributeValues": {
2379
+ "text": {
2380
+ "type": "string",
2381
+ "value": "some text",
2382
+ "position": 0
2383
+ }
2384
+ }
2401
2385
  }
2402
2386
  ]
2403
2387
  ```
@@ -2477,46 +2461,46 @@ example: 0 <br>
2477
2461
 
2478
2462
  </details>
2479
2463
 
2480
- ### Pages.getCatalogPages(langCode, limit, offset)
2464
+
2465
+ ### Pages.getPages(langCode)
2481
2466
 
2482
2467
  ```js
2483
- const value = await Pages.getCatalogPages('en_US', 0, 30)
2468
+ const value = await Pages.getPages('en_US')
2484
2469
  ```
2485
2470
 
2486
- > This method retrieves all page objects with product information as an array from the API. It accepts two optional parameters limit and offset for pagination and language code parameter. It returns a Promise that resolves to an array of ContentIndexedPageDto objects or an empty array [] if there is no data.
2471
+ > This method retrieves all created pages as an array from the API. It returns a Promise that resolves to an array of ContentIndexedPageDto objects or an empty array [] if there is no data. Get required language parameter.
2487
2472
 
2488
2473
  Example return:
2489
2474
 
2490
2475
  ```json
2491
2476
  [
2492
2477
  {
2493
- "id": 1764,
2494
- "parentId": null,
2495
- "config": {
2496
- "rowsPerPage": 1,
2497
- "productsPerRow": 1
2498
- },
2499
- "pageUrl": "string",
2500
- "depth": 3,
2501
- "localizeInfos": {
2502
- "title": "Catalog",
2503
- "content": "Content for catalog",
2504
- "menuTitle": "Catalog"
2505
- },
2506
- "isVisible": true,
2507
- "products": 0,
2508
- "attributeSetId": 7,
2509
- "isSync": false,
2510
- "templateIdentifier": "my-template",
2511
- "attributeValues": {
2512
- "marker": {
2513
- "value": "",
2514
- "type": "string"
2515
- }
2516
- },
2517
- "position": 192,
2518
- "type": "forNewsPage",
2519
- "childrenCount": 0
2478
+ "id": 2,
2479
+ "config": {},
2480
+ "depth": 0,
2481
+ "parentId": null,
2482
+ "pageUrl": "catalog",
2483
+ "attributeSetIdentifier": "page",
2484
+ "localizeInfos": {
2485
+ "title": "Catalog",
2486
+ "menuTitle": "Catalog",
2487
+ "htmlContent": "",
2488
+ "plainContent": ""
2489
+ },
2490
+ "position": 3,
2491
+ "isVisible": true,
2492
+ "products": 3,
2493
+ "childrenCount": 0,
2494
+ "type": "forCatalogPages",
2495
+ "templateIdentifier": "template",
2496
+ "isSync": true,
2497
+ "attributeValues": {
2498
+ "text": {
2499
+ "type": "string",
2500
+ "value": "catalog text",
2501
+ "position": 0
2502
+ }
2503
+ }
2520
2504
  }
2521
2505
  ]
2522
2506
  ```
@@ -2595,49 +2579,42 @@ example: 0 <br>
2595
2579
 
2596
2580
  </details>
2597
2581
 
2598
-
2599
- ### Pages.getPages(langCode)
2582
+ ### Pages.getPageById(id, langCode)
2600
2583
 
2601
2584
  ```js
2602
- const value = await Pages.getPages('en_US')
2585
+ const value = await Pages.getPageById(1, 'en_US')
2603
2586
  ```
2604
2587
 
2605
- > This method retrieves all created pages as an array from the API. It returns a Promise that resolves to an array of ContentIndexedPageDto objects or an empty array [] if there is no data. Get required language parameter.
2588
+ > 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.
2606
2589
 
2607
2590
  Example return:
2608
2591
 
2609
2592
  ```json
2610
- [
2611
- {
2612
- "id": 1764,
2613
- "parentId": null,
2614
- "config": {
2615
- "rowsPerPage": 1,
2616
- "productsPerRow": 1
2617
- },
2618
- "pageUrl": "string",
2619
- "depth": 3,
2620
- "localizeInfos": {
2621
- "title": "Catalog",
2622
- "content": "Content for catalog",
2623
- "menuTitle": "Catalog"
2624
- },
2625
- "isVisible": true,
2626
- "products": 0,
2627
- "attributeSetId": 7,
2628
- "isSync": false,
2629
- "templateIdentifier": "my-template",
2630
- "attributeValues": {
2631
- "marker": {
2632
- "value": "",
2633
- "type": "string"
2634
- }
2635
- },
2636
- "position": 192,
2637
- "type": "forNewsPage",
2638
- "childrenCount": 0
2639
- }
2640
- ]
2593
+ {
2594
+ "id": 1,
2595
+ "parentId": null,
2596
+ "pageUrl": "blog",
2597
+ "depth": 0,
2598
+ "localizeInfos": {
2599
+ "title": "Blog",
2600
+ "menuTitle": "Blog",
2601
+ "htmlContent": "",
2602
+ "plainContent": ""
2603
+ },
2604
+ "isVisible": true,
2605
+ "forms": [],
2606
+ "blocks": [],
2607
+ "type": "forUsualPage",
2608
+ "templateIdentifier": "template",
2609
+ "attributeValues": {
2610
+ "text": {
2611
+ "type": "string",
2612
+ "value": "some text",
2613
+ "position": 0
2614
+ }
2615
+ },
2616
+ "isSync": true
2617
+ }
2641
2618
  ```
2642
2619
  <details>
2643
2620
  <summary>Schema</summary>
@@ -2650,10 +2627,6 @@ example: 1764 <br>
2650
2627
  *parent page identifier, if null, it is a top-level page* <br>
2651
2628
  example: null <br>
2652
2629
 
2653
- **config** Record<string, number> <br>
2654
- *output settings for catalog pages* <br>
2655
- example: OrderedMap { "rowsPerPage": 1, "productsPerRow": 1 } <br>
2656
-
2657
2630
  **pageUrl** string <br>
2658
2631
  *unique page URL* <br>
2659
2632
 
@@ -2669,9 +2642,20 @@ example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent":
2669
2642
  *Page visibility flag* <br>
2670
2643
  example: true <br>
2671
2644
 
2672
- **products** number <br>
2673
- *Number of products linked to the page* <br>
2674
- example: 0 <br>
2645
+ **position:** number <br>
2646
+ *position number (for sorting)* <br>
2647
+ example: 192 <br>
2648
+
2649
+ **type** string <br>
2650
+ *page type:* <br>
2651
+ example: forNewsPage <br>
2652
+ Enum:
2653
+ [ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ] <br>
2654
+
2655
+
2656
+ **templateIdentifier:** string <br>
2657
+ *custom identifier of the associated template* <br>
2658
+ example: my-template <br>
2675
2659
 
2676
2660
  **attributeSetId:** number <br>
2677
2661
  *attribute set identifier* <br>
@@ -2689,64 +2673,41 @@ example: 7 <br>
2689
2673
  *indicator of page indexing (true or false)* <br>
2690
2674
  example: false <br>
2691
2675
 
2692
- **templateIdentifier:** string <br>
2693
- *Custom identifier of the linked template* <br>
2694
- example: my-template <br>
2695
-
2696
- **attributeValues:** Record<string, string> <br>
2697
- *Array of attribute values from the index (presented as a pair of custom attribute identifier: attribute value)* <br>
2698
- example: OrderedMap { "en_US": OrderedMap { "marker": OrderedMap { "value": "", "type": "string" } } } <br>
2699
-
2700
- **position:** number <br>
2701
- *position number for sorting (optional)* <br>
2702
- example: 192 <br>
2703
-
2704
- **type:** string <br>
2705
- *Page type* <br>
2706
- example: forNewsPage <br>
2707
- Enum:
2708
- [ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ] <br>
2709
-
2710
-
2711
- **childrenCount:** number <br>
2712
- *number of nested pages* <br>
2676
+ **products** number <br>
2677
+ *number of products associated with the page* <br>
2713
2678
  example: 0 <br>
2714
2679
 
2715
2680
  </details>
2716
2681
 
2717
- ### Pages.getPageById(id, langCode)
2682
+ ### Pages.getPageByUrl(url, langCode)
2718
2683
 
2719
2684
  ```js
2720
- const value = await Pages.getPageById(1, 'en_US')
2685
+ const value = await Pages.getPageByUrl('shop', 'en_US')
2721
2686
  ```
2722
2687
 
2723
- > 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.
2688
+ > This method retrieves a single page object based on its URL (url) 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.
2724
2689
 
2725
2690
  Example return:
2726
2691
 
2727
2692
  ```json
2728
2693
  {
2729
- "id": 1764,
2730
- "parentId": null,
2731
- "pageUrl": "string",
2732
- "depth": 3,
2694
+ "id": 3,
2695
+ "parentId": 1,
2696
+ "pageUrl": "blog1",
2697
+ "depth": 1,
2733
2698
  "localizeInfos": {
2734
- "title": "Catalog",
2735
- "content": "Content for catalog",
2736
- "menuTitle": "Catalog"
2699
+ "title": "Blog 1",
2700
+ "menuTitle": "Blog 1",
2701
+ "htmlContent": "",
2702
+ "plainContent": ""
2737
2703
  },
2738
2704
  "isVisible": true,
2739
- "position": 192,
2740
- "type": "forNewsPage",
2741
- "templateIdentifier": "my-template",
2742
- "attributeSetId": 7,
2743
- "attributeValues": {
2744
- "marker": "description",
2745
- "type": "string",
2746
- "value": ""
2747
- },
2748
- "isSync": false,
2749
- "products": 0
2705
+ "forms": [],
2706
+ "blocks": [],
2707
+ "type": "forUsualPage",
2708
+ "templateIdentifier": null,
2709
+ "attributeValues": {},
2710
+ "isSync": false
2750
2711
  }
2751
2712
  ```
2752
2713
  <details>
@@ -2804,7 +2765,7 @@ example: 7 <br>
2804
2765
 
2805
2766
  **isSync:** boolean <br>
2806
2767
  *indicator of page indexing (true or false)* <br>
2807
- example: false <br>
2768
+ example: false
2808
2769
 
2809
2770
  **products** number <br>
2810
2771
  *number of products associated with the page* <br>
@@ -2812,109 +2773,11 @@ example: 0 <br>
2812
2773
 
2813
2774
  </details>
2814
2775
 
2815
- ### Pages.getPageByUrl(url, langCode)
2776
+
2777
+ ### Pages.getChildPagesByParentUrl(url, langCode)
2816
2778
 
2817
2779
  ```js
2818
- const value = await Pages.getPageByUrl('shop', 'en_US')
2819
- ```
2820
-
2821
- > This method retrieves a single page object based on its URL (url) 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.
2822
-
2823
- Example return:
2824
-
2825
- ```json
2826
- {
2827
- "id": 1764,
2828
- "parentId": null,
2829
- "pageUrl": "string",
2830
- "depth": 3,
2831
- "localizeInfos": {
2832
- "title": "Catalog",
2833
- "content": "Content for catalog",
2834
- "menuTitle": "Catalog"
2835
- },
2836
- "isVisible": true,
2837
- "position": 192,
2838
- "type": "forNewsPage",
2839
- "templateIdentifier": "my-template",
2840
- "attributeSetId": 7,
2841
- "attributeValues": {
2842
- "marker": "description",
2843
- "type": "string",
2844
- "value": ""
2845
- },
2846
- "isSync": false,
2847
- "products": 0
2848
- }
2849
- ```
2850
- <details>
2851
- <summary>Schema</summary>
2852
-
2853
- **id:** number <br>
2854
- *object identifier* <br>
2855
- example: 1764 <br>
2856
-
2857
- **parentId** number <br>
2858
- *parent page identifier, if null, it is a top-level page* <br>
2859
- example: null <br>
2860
-
2861
- **pageUrl** string <br>
2862
- *unique page URL* <br>
2863
-
2864
- **depth** number <br>
2865
- *page nesting depth relative to parentId* <br>
2866
- example: 3 <br>
2867
-
2868
- **localizeInfos:** Record<string, any> <br>
2869
- *json description of the main page data object taking into account the language "en_US" (for example)* <br>
2870
- example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } } <br>
2871
-
2872
- **isVisible:** boolean <br>
2873
- *Page visibility flag* <br>
2874
- example: true <br>
2875
-
2876
- **position:** number <br>
2877
- *position number (for sorting)* <br>
2878
- example: 192 <br>
2879
-
2880
- **type** string <br>
2881
- *page type:* <br>
2882
- example: forNewsPage <br>
2883
- Enum:
2884
- [ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ] <br>
2885
-
2886
-
2887
- **templateIdentifier:** string <br>
2888
- *custom identifier of the associated template* <br>
2889
- example: my-template <br>
2890
-
2891
- **attributeSetId:** number <br>
2892
- *attribute set identifier* <br>
2893
- example: 7 <br>
2894
-
2895
- **forms** <br>
2896
- *Array of FormEntity object identifier values linked to the page (optional)* <br>
2897
-
2898
-
2899
- **blocks** <br>
2900
- *Array of BlockEntity object identifier values linked to the page (optional)* <br>
2901
-
2902
-
2903
- **isSync:** boolean <br>
2904
- *indicator of page indexing (true or false)* <br>
2905
- example: false
2906
-
2907
- **products** number <br>
2908
- *number of products associated with the page* <br>
2909
- example: 0 <br>
2910
-
2911
- </details>
2912
-
2913
-
2914
- ### Pages.getChildPagesByParentUrl(url, langCode)
2915
-
2916
- ```js
2917
- const value = await Pages.getChildPagesByParentUrl('shop', 'en_US')
2780
+ const value = await Pages.getChildPagesByParentUrl('shop', 'en_US')
2918
2781
  ```
2919
2782
 
2920
2783
  > Getting child pages with information about products in the form of an array. Returns all created pages as an array of AdminIndexedPageDto objects or an empty array [] (if there is no data) for the selected parent.
@@ -2924,40 +2787,26 @@ Example return:
2924
2787
  ```json
2925
2788
  [
2926
2789
  {
2927
- "id": 1764,
2928
- "parentId": null,
2929
- "config": {
2930
- "rowsPerPage": 1,
2931
- "productsPerRow": 1
2932
- },
2933
- "pageUrl": "string",
2934
- "depth": 3,
2790
+ "id": 3,
2791
+ "config": {},
2792
+ "depth": 1,
2793
+ "parentId": 1,
2794
+ "pageUrl": "blog1",
2795
+ "attributeSetIdentifier": null,
2935
2796
  "localizeInfos": {
2936
- "title": "Catalog",
2937
- "plainContent": "Content for catalog",
2938
- "htmlContent": "<b>Content for catalog</b>",
2939
- "menuTitle": "Catalog"
2797
+ "title": "Blog 1",
2798
+ "menuTitle": "Blog 1",
2799
+ "htmlContent": "",
2800
+ "plainContent": ""
2940
2801
  },
2802
+ "position": 1,
2941
2803
  "isVisible": true,
2942
2804
  "products": 0,
2943
- "attributeSetId": 7,
2944
- "forms": [
2945
- null
2946
- ],
2947
- "blocks": [
2948
- null
2949
- ],
2805
+ "childrenCount": 0,
2806
+ "type": "forUsualPage",
2807
+ "templateIdentifier": null,
2950
2808
  "isSync": false,
2951
- "templateIdentifier": "my-template",
2952
- "attributeValues": {
2953
- "marker": {
2954
- "value": "",
2955
- "type": "string"
2956
- }
2957
- },
2958
- "position": 192,
2959
- "type": "forNewsPage",
2960
- "childrenCount": 0
2809
+ "attributeValues": {}
2961
2810
  }
2962
2811
  ]
2963
2812
  ```
@@ -3051,39 +2900,20 @@ Example return:
3051
2900
  ```json
3052
2901
  [
3053
2902
  {
3054
- "id": 1764,
3055
- "version": 10,
3056
- "identifier": "catalog",
3057
- "attributeSetId": 0,
2903
+ "id": 2,
3058
2904
  "localizeInfos": {
3059
- "title": "My block"
2905
+ "title": "test"
3060
2906
  },
3061
- "customSettings": {
3062
- "sliderDelay": 0,
3063
- "sliderDelayType": "",
3064
- "productQuantity": 4,
3065
- "productSortType": "By_ID",
3066
- "productSortOrder": "Descending",
3067
- "productCountElementsPerRow": 10,
3068
- "similarProductRules": [
3069
- {
3070
- "property": "Descending",
3071
- "includes": "",
3072
- "keywords": "",
3073
- "strict": ""
3074
- }
3075
- ]
3076
- },
3077
- "position": 0,
2907
+ "attributeSetIdentifier": "block",
2908
+ "version": 0,
2909
+ "position": 2,
2910
+ "identifier": "test",
2911
+ "type": "forTextBlock",
2912
+ "templateIdentifier": null,
2913
+ "isVisible": true,
3078
2914
  "isSync": false,
3079
- "attributeValues": {
3080
- "marker": {
3081
- "value": "",
3082
- "type": "string"
3083
- }
3084
- },
3085
- "type": "forNewsPage",
3086
- "templateIdentifier": null
2915
+ "attributeValues": {},
2916
+ "countElementsPerRow": 0
3087
2917
  }
3088
2918
  ]
3089
2919
  ```
@@ -3286,28 +3116,34 @@ Example return:
3286
3116
  ```json
3287
3117
  [
3288
3118
  {
3289
- "id": 1764,
3290
- "parentId": null,
3291
- "pageUrl": "string",
3292
- "depth": 3,
3293
- "localizeInfos": {
3294
- "title": "Catalog",
3295
- "content": "Content for catalog",
3296
- "menuTitle": "Catalog"
3297
- },
3298
- "isVisible": true,
3299
- "position": 192,
3300
- "type": "forNewsPage",
3301
- "templateIdentifier": "my-template",
3302
- "attributeSetId": 7,
3303
- "attributeValues": {
3304
- "marker": "description",
3119
+ "id": 2,
3120
+ "parentId": null,
3121
+ "pageUrl": "catalog",
3122
+ "depth": 0,
3123
+ "localizeInfos": {
3124
+ "title": "Catalog",
3125
+ "menuTitle": "Catalog",
3126
+ "htmlContent": "",
3127
+ "plainContent": ""
3128
+ },
3129
+ "isVisible": true,
3130
+ "forms": [],
3131
+ "blocks": [
3132
+ "test",
3133
+ "product_block"
3134
+ ],
3135
+ "type": "forCatalogPages",
3136
+ "templateIdentifier": "template",
3137
+ "attributeValues": {
3138
+ "text": {
3305
3139
  "type": "string",
3306
- "value": ""
3307
- },
3308
- "isSync": false,
3309
- "products": 0
3310
- }
3140
+ "value": "catalog text",
3141
+ "position": 0
3142
+ }
3143
+ },
3144
+ "products": 3,
3145
+ "isSync": true
3146
+ }
3311
3147
  ]
3312
3148
  ```
3313
3149
 
@@ -3323,7 +3159,7 @@ const { Payments } = defineOneEntry('your-url');
3323
3159
  ### Payments.getSessions(limit, offset)
3324
3160
 
3325
3161
  ```js
3326
- const value = await Payments.getSessions(30, 0)
3162
+ const value = await Payments.getSessions()
3327
3163
  ```
3328
3164
 
3329
3165
  > This method get list of a payment session. It returns a Promise that resolves to a payment session object.
@@ -3334,32 +3170,13 @@ Example return:
3334
3170
  [
3335
3171
  {
3336
3172
  "id": 1764,
3337
- "updatedDate": "2024-04-10T16:39:04.297Z",
3338
- "version": 10,
3339
- "identifier": "catalog",
3173
+ "updatedDate": "2024-06-21T09:51:57.785Z",
3340
3174
  "type": "session",
3341
- "lineItems": [
3342
- {
3343
- "quantity": 1,
3344
- "amount": 5,
3345
- "currency": "USD",
3346
- "name": "T-shirt",
3347
- "description": "White T-shirt"
3348
- }
3349
- ],
3175
+ "status": "completed",
3350
3176
  "orderId": 1,
3351
3177
  "paymentAccountId": 1,
3352
- "status": "completed",
3353
- "sessionId": "9BE88048TU058770M",
3354
- "paymentUrl": "https://www.sandbox.paypal.com/checkoutnow?token=9BE88048TU058770M",
3355
- "successUrl": "https://example.com/success",
3356
- "cancelUrl": "https://example.com/cancel",
3357
- "intent": {
3358
- "amount": 1,
3359
- "currency": "usd"
3360
- },
3361
- "intentId": 1,
3362
- "clientSecret": "pi_3Oyz2kQWzXG1R23w144qG7o4_secret_OeScuCwTpHmyOM1atbm7pWJw2"
3178
+ "paymentUrl": "https://checkout.stripe.com/c/pay/cs_test_a1iOHnSWAmeN3SN5IgYtPv8Fzv48vGUmKxFuhxD0FOjkOaTAlgiwNY9OYW#fid2BXKsdWBEZmZqcGtxJz8nZGZmcVo0VTZjazFUb2Z8YEBRYkxHJyknZHVsTmB8Jz8ndW5acWB2cVowNEpKcW43TVVBa1NSMU5ST3JfY3VcRGlRSUR8cVx0XFxOXG9Cbn1oM1V0QUExR0RRRnJwV0FCYlNcXUtGdGtzcndgcmJxQVNkQnxvcDBTY0ZpUjZCd319UTU1ME5rXDJIVjYnKSdjd2poVmB3c2B3Jz9xd3BgKSdpZHxqcHFRfHVgJz8ndmxrYmlgWmxxYGgnKSdga2RnaWBVaWRmYG1qaWFgd3YnP3F3cGB4JSUl",
3179
+ "clientSecret": "pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH"
3363
3180
  }
3364
3181
  ]
3365
3182
  ```
@@ -3443,32 +3260,13 @@ Example return:
3443
3260
  ```json
3444
3261
  {
3445
3262
  "id": 1764,
3446
- "updatedDate": "2024-04-10T16:39:04.297Z",
3447
- "version": 10,
3448
- "identifier": "catalog",
3263
+ "updatedDate": "2024-06-21T09:51:57.785Z",
3449
3264
  "type": "session",
3450
- "lineItems": [
3451
- {
3452
- "quantity": 1,
3453
- "amount": 5,
3454
- "currency": "USD",
3455
- "name": "T-shirt",
3456
- "description": "White T-shirt"
3457
- }
3458
- ],
3265
+ "status": "completed",
3459
3266
  "orderId": 1,
3460
3267
  "paymentAccountId": 1,
3461
- "status": "completed",
3462
- "sessionId": "9BE88048TU058770M",
3463
- "paymentUrl": "https://www.sandbox.paypal.com/checkoutnow?token=9BE88048TU058770M",
3464
- "successUrl": "https://example.com/success",
3465
- "cancelUrl": "https://example.com/cancel",
3466
- "intent": {
3467
- "amount": 1,
3468
- "currency": "usd"
3469
- },
3470
- "intentId": 1,
3471
- "clientSecret": "pi_3Oyz2kQWzXG1R23w144qG7o4_secret_OeScuCwTpHmyOM1atbm7pWJw2"
3268
+ "paymentUrl": "https://checkout.stripe.com/c/pay/cs_test_a1iOHnSWAmeN3SN5IgYtPv8Fzv48vGUmKxFuhxD0FOjkOaTAlgiwNY9OYW#fid2BXKsdWBEZmZqcGtxJz8nZGZmcVo0VTZjazFUb2Z8YEBRYkxHJyknZHVsTmB8Jz8ndW5acWB2cVowNEpKcW43TVVBa1NSMU5ST3JfY3VcRGlRSUR8cVx0XFxOXG9Cbn1oM1V0QUExR0RRRnJwV0FCYlNcXUtGdGtzcndgcmJxQVNkQnxvcDBTY0ZpUjZCd319UTU1ME5rXDJIVjYnKSdjd2poVmB3c2B3Jz9xd3BgKSdpZHxqcHFRfHVgJz8ndmxrYmlgWmxxYGgnKSdga2RnaWBVaWRmYG1qaWFgd3YnP3F3cGB4JSUl",
3269
+ "clientSecret": "pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH"
3472
3270
  }
3473
3271
  ```
3474
3272
  <details>
@@ -3551,32 +3349,9 @@ Example return:
3551
3349
  ```json
3552
3350
  {
3553
3351
  "id": 1764,
3554
- "updatedDate": "2024-04-10T16:39:04.297Z",
3352
+ "updatedDate": "2024-06-21T09:53:28.898Z",
3555
3353
  "version": 10,
3556
- "identifier": "catalog",
3557
- "type": "session",
3558
- "lineItems": [
3559
- {
3560
- "quantity": 1,
3561
- "amount": 5,
3562
- "currency": "USD",
3563
- "name": "T-shirt",
3564
- "description": "White T-shirt"
3565
- }
3566
- ],
3567
- "orderId": 1,
3568
- "paymentAccountId": 1,
3569
- "status": "completed",
3570
- "sessionId": "9BE88048TU058770M",
3571
- "paymentUrl": "https://www.sandbox.paypal.com/checkoutnow?token=9BE88048TU058770M",
3572
- "successUrl": "https://example.com/success",
3573
- "cancelUrl": "https://example.com/cancel",
3574
- "intent": {
3575
- "amount": 1,
3576
- "currency": "usd"
3577
- },
3578
- "intentId": 1,
3579
- "clientSecret": "pi_3Oyz2kQWzXG1R23w144qG7o4_secret_OeScuCwTpHmyOM1atbm7pWJw2"
3354
+ "identifier": "my-id"
3580
3355
  }
3581
3356
  ```
3582
3357
  <details>
@@ -3659,8 +3434,7 @@ Example return:
3659
3434
  ```json
3660
3435
  {
3661
3436
  "stripeAccountId": "acct_1OtRiIHTHOaLRCAa",
3662
- "stripePublishableKey": "pk_51OOvk2HPDnVW5KWJwZfiYAlTLAytYqYYKYjGkxm6PqDD4BATCwuRDGgVYXNCqnvwrewgtDVaGyju5VfClW3GrxxT005KnY7MS3",
3663
- "paypalAccountId": "4Q0BANTF5BE7N"
3437
+ "stripePublishableKey": "pk_51OOvk2HPDnVW5KWJwZfiYAlTLAytYqYYKYjGkxm6PqDD4BATCwuRDGgVYXNCqnvwrewgtDVaGyju5VfClW3GrxxT005KnY7MS3"
3664
3438
  }
3665
3439
  ```
3666
3440
  <details>
@@ -3694,13 +3468,11 @@ Example return:
3694
3468
  ```json
3695
3469
  [
3696
3470
  {
3697
- "id": 1764,
3698
- "updatedDate": "2024-04-10T17:02:20.707Z",
3699
- "version": 10,
3700
- "identifier": "catalog",
3471
+ "id": 2,
3701
3472
  "localizeInfos": {
3702
- "title": "Stripe"
3473
+ "title": "Stripe"
3703
3474
  },
3475
+ "identifier": "stripe",
3704
3476
  "type": "stripe",
3705
3477
  "isVisible": true
3706
3478
  }
@@ -3751,15 +3523,11 @@ Example return:
3751
3523
 
3752
3524
  ```json
3753
3525
  {
3754
- "id": 1764,
3755
- "updatedDate": "2024-04-10T17:12:20.233Z",
3756
- "version": 10,
3757
- "identifier": "catalog",
3526
+ "id": 2,
3758
3527
  "localizeInfos": {
3759
- "en_US": {
3760
- "title": "Stripe"
3761
- }
3528
+ "title": "Stripe"
3762
3529
  },
3530
+ "identifier": "stripe",
3763
3531
  "type": "stripe",
3764
3532
  "isVisible": true
3765
3533
  }
@@ -3805,16 +3573,6 @@ const value = await Payments.webhookStripe()
3805
3573
 
3806
3574
  > This method use webhook for Stripe. Returns true (in case of successful execution) or false (in case of unsuccessful execution).
3807
3575
 
3808
-
3809
-
3810
- ### Payments.webhookStripe()
3811
-
3812
- ```js
3813
- const value = await Payments.webhookPaypal()
3814
- ```
3815
-
3816
- > This method use webhook for Paypal. Returns true (in case of successful execution) or false (in case of unsuccessful execution).
3817
-
3818
3576
  ---
3819
3577
 
3820
3578
 
@@ -3893,51 +3651,46 @@ Example return:
3893
3651
  ```json
3894
3652
  [
3895
3653
  {
3896
- "id": 1764,
3654
+ "id": 4,
3897
3655
  "localizeInfos": {
3898
- "title": "Product"
3656
+ "title": "Cosmo"
3899
3657
  },
3900
- "isVisible": true,
3901
- "statusId": 1,
3902
- "relatedIds": [
3903
- 1,
3904
- 2,
3905
- 3
3906
- ],
3907
- "attributeSetId": 7,
3908
- "isSync": true,
3909
- "price": 0,
3658
+ "statusIdentifier": null,
3659
+ "statusLocalizeInfos": {},
3660
+ "attributeSetIdentifier": "products",
3661
+ "position": 1,
3662
+ "templateIdentifier": null,
3663
+ "shortDescTemplateIdentifier": null,
3664
+ "price": 150,
3910
3665
  "additional": {
3911
3666
  "prices": {
3912
- "min": 0,
3913
- "max": 100
3914
- }
3915
- },
3916
- "blocks": [
3917
- null
3918
- ],
3919
- "sku": "0-123",
3920
- "productPages": [
3921
- {
3922
- "id": 8997,
3923
- "pageId": 1176,
3924
- "productId": 8872
3667
+ "min": 120,
3668
+ "max": 150
3925
3669
  }
3926
- ],
3927
- "statusLocalizeInfos": {
3928
- "title": "Product"
3929
3670
  },
3930
- "templateIdentifier": "my-template",
3931
- "shortDescTemplateIdentifier": "my-template-short",
3671
+ "sku": null,
3672
+ "isSync": true,
3932
3673
  "attributeValues": {
3933
- "marker": {
3934
- "value": "",
3935
- "type": "string",
3674
+ "price": {
3675
+ "type": "integer",
3676
+ "value": "150",
3936
3677
  "position": 1,
3937
3678
  "isProductPreview": false
3679
+ },
3680
+ "product-name": {
3681
+ "type": "string",
3682
+ "value": "Cosmo",
3683
+ "position": 0,
3684
+ "isProductPreview": false
3685
+ },
3686
+ "currency_products": {
3687
+ "type": "string",
3688
+ "value": "",
3689
+ "position": 2,
3690
+ "isProductPreview": false
3938
3691
  }
3939
3692
  },
3940
- "position": 1
3693
+ "isVisible": true
3941
3694
  }
3942
3695
  ]
3943
3696
  ```
@@ -4028,51 +3781,46 @@ Example return:
4028
3781
  ```json
4029
3782
  [
4030
3783
  {
4031
- "id": 1764,
3784
+ "id": 4,
4032
3785
  "localizeInfos": {
4033
- "title": "Product"
3786
+ "title": "Cosmo"
4034
3787
  },
4035
- "isVisible": true,
4036
- "statusId": 1,
4037
- "relatedIds": [
4038
- 1,
4039
- 2,
4040
- 3
4041
- ],
4042
- "attributeSetId": 7,
4043
- "isSync": true,
4044
- "price": 0,
3788
+ "statusIdentifier": null,
3789
+ "statusLocalizeInfos": {},
3790
+ "attributeSetIdentifier": "products",
3791
+ "position": 1,
3792
+ "templateIdentifier": null,
3793
+ "shortDescTemplateIdentifier": null,
3794
+ "price": 150,
4045
3795
  "additional": {
4046
3796
  "prices": {
4047
- "min": 0,
4048
- "max": 100
3797
+ "min": 120,
3798
+ "max": 150
4049
3799
  }
4050
3800
  },
4051
- "blocks": [
4052
- null
4053
- ],
4054
- "sku": "0-123",
4055
- "productPages": [
4056
- {
4057
- "id": 8997,
4058
- "pageId": 1176,
4059
- "productId": 8872
4060
- }
4061
- ],
4062
- "statusLocalizeInfos": {
4063
- "title": "Product"
4064
- },
4065
- "templateIdentifier": "my-template",
4066
- "shortDescTemplateIdentifier": "my-template-short",
3801
+ "sku": null,
3802
+ "isSync": true,
4067
3803
  "attributeValues": {
4068
- "marker": {
4069
- "value": "",
4070
- "type": "string",
3804
+ "price": {
3805
+ "type": "integer",
3806
+ "value": "150",
4071
3807
  "position": 1,
4072
3808
  "isProductPreview": false
3809
+ },
3810
+ "product-name": {
3811
+ "type": "string",
3812
+ "value": "Cosmo",
3813
+ "position": 0,
3814
+ "isProductPreview": false
3815
+ },
3816
+ "currency_products": {
3817
+ "type": "string",
3818
+ "value": "",
3819
+ "position": 2,
3820
+ "isProductPreview": false
4073
3821
  }
4074
3822
  },
4075
- "position": 1
3823
+ "isVisible": true
4076
3824
  }
4077
3825
  ]
4078
3826
  ```
@@ -4183,51 +3931,49 @@ Example return:
4183
3931
  ```json
4184
3932
  [
4185
3933
  {
4186
- "id": 1764,
3934
+ "id": 2,
4187
3935
  "localizeInfos": {
4188
- "title": "Product"
3936
+ "title": "Box"
4189
3937
  },
4190
- "isVisible": true,
4191
- "statusId": 1,
4192
- "relatedIds": [
4193
- 1,
4194
- 2,
4195
- 3
4196
- ],
4197
- "attributeSetId": 7,
4198
- "isSync": true,
4199
- "price": 0,
3938
+ "statusIdentifier": "sold",
3939
+ "statusLocalizeInfos": {
3940
+ "title": "Sold"
3941
+ },
3942
+ "attributeSetIdentifier": "products",
3943
+ "position": 3,
3944
+ "templateIdentifier": null,
3945
+ "shortDescTemplateIdentifier": null,
3946
+ "price": 148,
4200
3947
  "additional": {
4201
3948
  "prices": {
4202
- "min": 0,
4203
- "max": 100
3949
+ "min": 120,
3950
+ "max": 150
4204
3951
  }
4205
3952
  },
4206
- "blocks": [
4207
- null
4208
- ],
4209
- "sku": "0-123",
4210
- "productPages": [
4211
- {
4212
- "id": 8997,
4213
- "pageId": 1176,
4214
- "productId": 8872
4215
- }
4216
- ],
4217
- "statusLocalizeInfos": {
4218
- "title": "Product"
4219
- },
4220
- "templateIdentifier": "my-template",
4221
- "shortDescTemplateIdentifier": "my-template-short",
3953
+ "sku": null,
3954
+ "isSync": true,
4222
3955
  "attributeValues": {
4223
- "marker": {
4224
- "value": "",
4225
- "type": "string",
3956
+ "price": {
3957
+ "type": "integer",
3958
+ "value": "148",
4226
3959
  "position": 1,
4227
3960
  "isProductPreview": false
3961
+ },
3962
+ "product-name": {
3963
+ "type": "string",
3964
+ "value": "Box text",
3965
+ "position": 0,
3966
+ "isProductPreview": false
3967
+ },
3968
+ "currency_products": {
3969
+ "type": "string",
3970
+ "value": "$",
3971
+ "position": 2,
3972
+ "isProductPreview": false
4228
3973
  }
4229
3974
  },
4230
- "position": 1
3975
+ "isVisible": true,
3976
+ "isPositionLocked": false
4231
3977
  }
4232
3978
  ]
4233
3979
  ```
@@ -4370,51 +4116,49 @@ Example return:
4370
4116
  ```json
4371
4117
  [
4372
4118
  {
4373
- "id": 1764,
4119
+ "id": 2,
4374
4120
  "localizeInfos": {
4375
- "title": "Product"
4121
+ "title": "Box"
4376
4122
  },
4377
- "isVisible": true,
4378
- "statusId": 1,
4379
- "relatedIds": [
4380
- 1,
4381
- 2,
4382
- 3
4383
- ],
4384
- "attributeSetId": 7,
4385
- "isSync": true,
4386
- "price": 0,
4123
+ "statusIdentifier": "sold",
4124
+ "statusLocalizeInfos": {
4125
+ "title": "Sold"
4126
+ },
4127
+ "attributeSetIdentifier": "products",
4128
+ "position": 3,
4129
+ "templateIdentifier": null,
4130
+ "shortDescTemplateIdentifier": null,
4131
+ "price": 148,
4387
4132
  "additional": {
4388
4133
  "prices": {
4389
- "min": 0,
4390
- "max": 100
4391
- }
4392
- },
4393
- "blocks": [
4394
- null
4395
- ],
4396
- "sku": "0-123",
4397
- "productPages": [
4398
- {
4399
- "id": 8997,
4400
- "pageId": 1176,
4401
- "productId": 8872
4134
+ "min": 120,
4135
+ "max": 150
4402
4136
  }
4403
- ],
4404
- "statusLocalizeInfos": {
4405
- "title": "Product"
4406
4137
  },
4407
- "templateIdentifier": "my-template",
4408
- "shortDescTemplateIdentifier": "my-template-short",
4138
+ "sku": null,
4139
+ "isSync": true,
4409
4140
  "attributeValues": {
4410
- "marker": {
4411
- "value": "",
4412
- "type": "string",
4141
+ "price": {
4142
+ "type": "integer",
4143
+ "value": "148",
4413
4144
  "position": 1,
4414
4145
  "isProductPreview": false
4146
+ },
4147
+ "product-name": {
4148
+ "type": "string",
4149
+ "value": "Box text",
4150
+ "position": 0,
4151
+ "isProductPreview": false
4152
+ },
4153
+ "currency_products": {
4154
+ "type": "string",
4155
+ "value": "$",
4156
+ "position": 2,
4157
+ "isProductPreview": false
4415
4158
  }
4416
4159
  },
4417
- "position": 1
4160
+ "isVisible": true,
4161
+ "isPositionLocked": false
4418
4162
  }
4419
4163
  ]
4420
4164
  ```
@@ -4504,51 +4248,49 @@ Example return:
4504
4248
 
4505
4249
  ```json
4506
4250
  {
4507
- "id": 1764,
4251
+ "id": 2,
4508
4252
  "localizeInfos": {
4509
- "title": "Product"
4253
+ "title": "Box"
4510
4254
  },
4511
- "isVisible": true,
4512
- "statusId": 1,
4513
- "relatedIds": [
4514
- 1,
4515
- 2,
4516
- 3
4517
- ],
4518
- "attributeSetId": 7,
4519
- "isSync": true,
4520
- "price": 0,
4255
+ "statusIdentifier": "sold",
4256
+ "statusLocalizeInfos": {
4257
+ "title": "Sold"
4258
+ },
4259
+ "attributeSetIdentifier": "products",
4260
+ "position": 3,
4261
+ "templateIdentifier": null,
4262
+ "shortDescTemplateIdentifier": null,
4263
+ "price": 148,
4521
4264
  "additional": {
4522
4265
  "prices": {
4523
- "min": 0,
4524
- "max": 100
4525
- }
4526
- },
4527
- "blocks": [
4528
- null
4529
- ],
4530
- "sku": "0-123",
4531
- "productPages": [
4532
- {
4533
- "id": 8997,
4534
- "pageId": 1176,
4535
- "productId": 8872
4266
+ "min": 120,
4267
+ "max": 150
4536
4268
  }
4537
- ],
4538
- "statusLocalizeInfos": {
4539
- "title": "Product"
4540
4269
  },
4541
- "templateIdentifier": "my-template",
4542
- "shortDescTemplateIdentifier": "my-template-short",
4270
+ "sku": null,
4271
+ "isSync": true,
4543
4272
  "attributeValues": {
4544
- "marker": {
4545
- "value": "",
4546
- "type": "string",
4273
+ "price": {
4274
+ "type": "integer",
4275
+ "value": "148",
4547
4276
  "position": 1,
4548
4277
  "isProductPreview": false
4278
+ },
4279
+ "product-name": {
4280
+ "type": "string",
4281
+ "value": "Box text",
4282
+ "position": 0,
4283
+ "isProductPreview": false
4284
+ },
4285
+ "currency_products": {
4286
+ "type": "string",
4287
+ "value": "$",
4288
+ "position": 2,
4289
+ "isProductPreview": false
4549
4290
  }
4550
4291
  },
4551
- "position": 1
4292
+ "isVisible": true,
4293
+ "isPositionLocked": false
4552
4294
  }
4553
4295
  ```
4554
4296
  <details>
@@ -4636,51 +4378,56 @@ Example return:
4636
4378
 
4637
4379
  ```json
4638
4380
  {
4639
- "id": 1764,
4381
+ "id": 3,
4640
4382
  "localizeInfos": {
4641
4383
  "title": "Product"
4642
4384
  },
4643
- "isVisible": true,
4644
- "statusId": 1,
4645
- "relatedIds": [
4646
- 1,
4647
- 2,
4648
- 3
4649
- ],
4650
- "attributeSetId": 7,
4651
- "isSync": true,
4652
- "price": 0,
4385
+ "statusIdentifier": null,
4386
+ "statusLocalizeInfos": {},
4387
+ "attributeSetIdentifier": "products",
4388
+ "position": 1,
4389
+ "templateIdentifier": null,
4390
+ "shortDescTemplateIdentifier": null,
4391
+ "price": 120,
4653
4392
  "additional": {
4654
4393
  "prices": {
4655
- "min": 0,
4656
- "max": 100
4657
- }
4658
- },
4659
- "blocks": [
4660
- null
4661
- ],
4662
- "sku": "0-123",
4663
- "productPages": [
4664
- {
4665
- "id": 8997,
4666
- "pageId": 1176,
4667
- "productId": 8872
4394
+ "min": 120,
4395
+ "max": 150
4668
4396
  }
4669
- ],
4670
- "statusLocalizeInfos": {
4671
- "title": "Product"
4672
4397
  },
4673
- "templateIdentifier": "my-template",
4674
- "shortDescTemplateIdentifier": "my-template-short",
4398
+ "sku": null,
4399
+ "isSync": true,
4675
4400
  "attributeValues": {
4676
- "marker": {
4677
- "value": "",
4678
- "type": "string",
4401
+ "price": {
4402
+ "type": "integer",
4403
+ "value": "120",
4679
4404
  "position": 1,
4680
4405
  "isProductPreview": false
4406
+ },
4407
+ "product-name": {
4408
+ "type": "string",
4409
+ "value": "Prod",
4410
+ "position": 0,
4411
+ "isProductPreview": false
4412
+ },
4413
+ "currency_products": {
4414
+ "type": "string",
4415
+ "value": "$",
4416
+ "position": 2,
4417
+ "isProductPreview": false
4681
4418
  }
4682
4419
  },
4683
- "position": 1
4420
+ "isVisible": true,
4421
+ "productPages": {
4422
+ "id": 3,
4423
+ "pageId": 2,
4424
+ "productId": 3,
4425
+ "positionId": 215
4426
+ },
4427
+ "blocks": [
4428
+ "product_block",
4429
+ "another"
4430
+ ]
4684
4431
  }
4685
4432
  ```
4686
4433
  <details>
@@ -4770,57 +4517,33 @@ Example return:
4770
4517
  ```json
4771
4518
  [
4772
4519
  {
4773
- "id": 4,
4520
+ "id": 3,
4521
+ "attributeSetIdentifier": null,
4774
4522
  "localizeInfos": {
4775
- "title": "Name"
4523
+ "title": "Product block"
4776
4524
  },
4777
4525
  "version": 0,
4778
- "position": 3,
4779
- "identifier": "product",
4526
+ "position": 1,
4527
+ "identifier": "product_block",
4780
4528
  "type": "forProductBlock",
4529
+ "customSettings": {
4530
+ "productConfig": {
4531
+ "quantity": "1",
4532
+ "countElementsPerRow": "1"
4533
+ },
4534
+ "similarProductRules": [],
4535
+ "condition": {
4536
+ "name": "cost",
4537
+ "costTo": 130,
4538
+ "costFrom": 0
4539
+ },
4540
+ "sliderDelay": null,
4541
+ "sliderDelayType": null
4542
+ },
4781
4543
  "templateIdentifier": null,
4782
4544
  "isVisible": true,
4783
- "attributeValues": {
4784
- "attr": {
4785
- "type": "string",
4786
- "value": "",
4787
- "position": 0,
4788
- "isProductPreview": false
4789
- }
4790
- },
4791
- "countElementsPerRow": 3,
4792
- "products": [
4793
- {
4794
- "id": 446,
4795
- "localizeInfos": {
4796
- "title": "new product 3"
4797
- },
4798
- "relatedIds": [1, 2],
4799
- "statusId": null,
4800
- "attributeSetId": 11,
4801
- "position": 3,
4802
- "templateIdentifier": null,
4803
- "shortDescTemplateIdentifier": null,
4804
- "price": 543,
4805
- "sku": "ggg",
4806
- "isSync": true,
4807
- "attributeValues": {
4808
- "sku": {
4809
- "type": "string",
4810
- "value": "ggg",
4811
- "position": 0,
4812
- "isProductPreview": false
4813
- },
4814
- "images": {
4815
- "type": "groupOfImages",
4816
- "value": {},
4817
- "position": 3,
4818
- "isProductPreview": false
4819
- }
4820
- },
4821
- "isVisible": true
4822
- }
4823
- ]
4545
+ "isSync": false,
4546
+ "attributeValues": {}
4824
4547
  }
4825
4548
  ]
4826
4549
  ```
@@ -4888,51 +4611,53 @@ Example return:
4888
4611
  ```json
4889
4612
  [
4890
4613
  {
4891
- "id": 1764,
4614
+ "id": 4,
4892
4615
  "localizeInfos": {
4893
- "title": "Product"
4616
+ "title": "Cosmo"
4894
4617
  },
4895
- "isVisible": true,
4896
- "statusId": 1,
4897
- "relatedIds": [
4898
- 1,
4899
- 2,
4900
- 3
4901
- ],
4902
- "attributeSetId": 7,
4903
- "isSync": true,
4904
- "price": 0,
4618
+ "statusIdentifier": null,
4619
+ "statusLocalizeInfos": {},
4620
+ "attributeSetIdentifier": "products",
4621
+ "position": 1,
4622
+ "templateIdentifier": null,
4623
+ "shortDescTemplateIdentifier": null,
4624
+ "price": 150,
4905
4625
  "additional": {
4906
4626
  "prices": {
4907
- "min": 0,
4908
- "max": 100
4909
- }
4910
- },
4911
- "blocks": [
4912
- null
4913
- ],
4914
- "sku": "0-123",
4915
- "productPages": [
4916
- {
4917
- "id": 8997,
4918
- "pageId": 1176,
4919
- "productId": 8872
4627
+ "min": 120,
4628
+ "max": 150
4920
4629
  }
4921
- ],
4922
- "statusLocalizeInfos": {
4923
- "title": "Product"
4924
4630
  },
4925
- "templateIdentifier": "my-template",
4926
- "shortDescTemplateIdentifier": "my-template-short",
4631
+ "sku": null,
4632
+ "isSync": true,
4927
4633
  "attributeValues": {
4928
- "marker": {
4929
- "value": "",
4930
- "type": "string",
4634
+ "price": {
4635
+ "type": "integer",
4636
+ "value": "150",
4931
4637
  "position": 1,
4932
4638
  "isProductPreview": false
4639
+ },
4640
+ "product-name": {
4641
+ "type": "string",
4642
+ "value": "Cosmo",
4643
+ "position": 0,
4644
+ "isProductPreview": false
4645
+ },
4646
+ "currency_products": {
4647
+ "type": "string",
4648
+ "value": "",
4649
+ "position": 2,
4650
+ "isProductPreview": false
4933
4651
  }
4934
4652
  },
4935
- "position": 1
4653
+ "isVisible": true,
4654
+ "productPages": {
4655
+ "id": 6,
4656
+ "pageId": 2,
4657
+ "productId": 4,
4658
+ "positionId": 229
4659
+ },
4660
+ "blocks": "product_block"
4936
4661
  }
4937
4662
  ]
4938
4663
  ```
@@ -5389,31 +5114,30 @@ Example return:
5389
5114
  ```json
5390
5115
  [
5391
5116
  {
5392
- "id": 1764,
5393
- "updatedDate": "2024-06-13T08:45:59.805Z",
5394
- "version": 10,
5395
- "identifier": "marker",
5117
+ "id": 1,
5118
+ "version": 0,
5119
+ "identifier": "preview-templates",
5396
5120
  "proportion": {
5397
- "horizontal": {
5398
- "height": 200,
5399
- "weight": 10,
5400
- "marker": "horizontal",
5401
- "alignmentType": "left"
5402
- },
5403
5121
  "vertical": {
5404
- "height": 10,
5405
- "weight": 200,
5406
- "marker": "vertical",
5407
- "alignmentType": "left"
5122
+ "width": "2",
5123
+ "height": "3",
5124
+ "alignmentType": "leftTop",
5125
+ "marker": "v"
5126
+ },
5127
+ "horizontal": {
5128
+ "width": "234",
5129
+ "height": "324",
5130
+ "alignmentType": "middleBottom",
5131
+ "marker": "h"
5408
5132
  },
5409
5133
  "square": {
5410
- "marker": "square",
5411
- "slide": 3,
5412
- "alignmentType": "center"
5134
+ "side": "3",
5135
+ "alignmentType": "middleBottom",
5136
+ "marker": "s"
5413
5137
  }
5414
5138
  },
5415
- "title": "Page template",
5416
- "position": 0
5139
+ "title": "Preview Templates",
5140
+ "position": 1
5417
5141
  }
5418
5142
  ]
5419
5143
  ```
@@ -5424,9 +5148,6 @@ Example return:
5424
5148
  *object identifier* <br>
5425
5149
  example: 1764 <br>
5426
5150
 
5427
- **updatedDate:** string($date-time) <br>
5428
- *object's date of modification* <br>
5429
-
5430
5151
  **version** number <br>
5431
5152
  *object's version number of modification* <br>
5432
5153
  example: 10 <br>
@@ -5466,32 +5187,31 @@ const value = await TemplatePreviews.getTemplatePreviewById(1764)
5466
5187
  Example return:
5467
5188
 
5468
5189
  ```json
5469
- {
5470
- "id": 1764,
5471
- "updatedDate": "2023-12-05T12:44:37.348Z",
5472
- "version": 10,
5473
- "identifier": "marker",
5190
+ {
5191
+ "id": 1,
5192
+ "version": 0,
5193
+ "identifier": "preview-templates",
5474
5194
  "proportion": {
5475
- "horizontal": {
5476
- "height": 200,
5477
- "weight": 10,
5478
- "marker": "horizontal",
5479
- "alignmentType": "left"
5480
- },
5481
5195
  "vertical": {
5482
- "height": 10,
5483
- "weight": 200,
5484
- "marker": "vertical",
5485
- "alignmentType": "left"
5196
+ "width": "2",
5197
+ "height": "3",
5198
+ "alignmentType": "leftTop",
5199
+ "marker": "v"
5200
+ },
5201
+ "horizontal": {
5202
+ "width": "234",
5203
+ "height": "324",
5204
+ "alignmentType": "middleBottom",
5205
+ "marker": "h"
5486
5206
  },
5487
5207
  "square": {
5488
- "marker": "square",
5489
- "slide": 3,
5490
- "alignmentType": "center"
5208
+ "side": "3",
5209
+ "alignmentType": "middleBottom",
5210
+ "marker": "s"
5491
5211
  }
5492
5212
  },
5493
- "title": "Page Template",
5494
- "positionId": 0
5213
+ "title": "Preview Templates",
5214
+ "position": 1
5495
5215
  }
5496
5216
  ```
5497
5217
  <details>
@@ -5501,9 +5221,6 @@ Example return:
5501
5221
  *object identifier* <br>
5502
5222
  example: 1764 <br>
5503
5223
 
5504
- **updatedDate:** string($date-time) <br>
5505
- *object's date of modification* <br>
5506
-
5507
5224
  **version** number <br>
5508
5225
  *object's version number of modification* <br>
5509
5226
  example: 10 <br>
@@ -5543,31 +5260,30 @@ Example return:
5543
5260
 
5544
5261
  ```json
5545
5262
  {
5546
- "id": 1764,
5547
- "updatedDate": "2023-12-05T12:44:20.008Z",
5548
- "version": 10,
5549
- "identifier": "my-marker",
5263
+ "id": 1,
5264
+ "version": 0,
5265
+ "identifier": "preview-templates",
5550
5266
  "proportion": {
5551
- "horizontal": {
5552
- "height": 200,
5553
- "weight": 10,
5554
- "marker": "horizontal",
5555
- "alignmentType": "left"
5556
- },
5557
5267
  "vertical": {
5558
- "height": 10,
5559
- "weight": 200,
5560
- "marker": "vertical",
5561
- "alignmentType": "left"
5268
+ "width": "2",
5269
+ "height": "3",
5270
+ "alignmentType": "leftTop",
5271
+ "marker": "v"
5272
+ },
5273
+ "horizontal": {
5274
+ "width": "234",
5275
+ "height": "324",
5276
+ "alignmentType": "middleBottom",
5277
+ "marker": "h"
5562
5278
  },
5563
5279
  "square": {
5564
- "marker": "square",
5565
- "slide": 3,
5566
- "alignmentType": "center"
5280
+ "side": "3",
5281
+ "alignmentType": "middleBottom",
5282
+ "marker": "s"
5567
5283
  }
5568
5284
  },
5569
- "title": "Page Template",
5570
- "positionId": 0
5285
+ "title": "Preview Templates",
5286
+ "position": 1
5571
5287
  }
5572
5288
  ```
5573
5289
  <details>
@@ -5577,9 +5293,6 @@ Example return:
5577
5293
  *object identifier* <br>
5578
5294
  example: 1764 <br>
5579
5295
 
5580
- **updatedDate:** string($date-time) <br>
5581
- *object's date of modification* <br>
5582
-
5583
5296
  **version** number <br>
5584
5297
  *object's version number of modification* <br>
5585
5298
  example: 10 <br>
@@ -5663,7 +5376,7 @@ example: List [ "group_1" ] <br>
5663
5376
  </details>
5664
5377
 
5665
5378
 
5666
- ### Users.getUser(langCode)
5379
+ ### Users.updateUser(langCode)
5667
5380
 
5668
5381
  ```js
5669
5382
  const data = {