oneentry 1.0.109 → 1.0.110
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 +440 -422
- package/dist/auth-provider/authProviderApi.d.ts +1 -1
- package/dist/auth-provider/authProviderApi.js +2 -2
- package/dist/events/eventsApi.js +1 -1
- package/dist/formsData/formsDataApi.d.ts +1 -1
- package/dist/formsData/formsDataApi.js +1 -1
- package/dist/integration-collections/integrationCollectionsApi.d.ts +4 -4
- package/dist/integration-collections/integrationCollectionsApi.js +4 -4
- package/package.json +2 -2
- package/readme.js +0 -103
package/README.md
CHANGED
|
@@ -245,10 +245,10 @@ const body = [
|
|
|
245
245
|
### Admins.getAdminsInfo(body, langCode, offset, limit)
|
|
246
246
|
|
|
247
247
|
```js
|
|
248
|
-
const value = await Admins.getAdminsInfo(
|
|
248
|
+
const value = await Admins.getAdminsInfo();
|
|
249
249
|
```
|
|
250
250
|
|
|
251
|
-
><details>
|
|
251
|
+
><details><br>
|
|
252
252
|
><summary>Schema</summary>
|
|
253
253
|
>
|
|
254
254
|
>**body:** array <br>
|
|
@@ -266,9 +266,9 @@ const value = await Admins.getAdminsInfo([], 'en_US', 30, 0 )
|
|
|
266
266
|
>**limit** number <br>
|
|
267
267
|
>*parameter for pagination, default 30* <br>
|
|
268
268
|
>example: 30 <br>
|
|
269
|
-
>
|
|
269
|
+
><br>
|
|
270
270
|
></details>
|
|
271
|
-
|
|
271
|
+
<br>
|
|
272
272
|
This method retrieves user objects of type admin from the API. It returns a Promise that resolves to an array of AdminEntity objects.
|
|
273
273
|
|
|
274
274
|
Example return:
|
|
@@ -291,7 +291,7 @@ Example return:
|
|
|
291
291
|
]
|
|
292
292
|
```
|
|
293
293
|
|
|
294
|
-
><details>
|
|
294
|
+
><details><br>
|
|
295
295
|
><summary>Schema</summary>
|
|
296
296
|
>
|
|
297
297
|
>**id:** number <br>
|
|
@@ -318,9 +318,36 @@ Example return:
|
|
|
318
318
|
>**position:** number <br>
|
|
319
319
|
>*Position number (for sorting)* <br>
|
|
320
320
|
>example: 192 <br>
|
|
321
|
-
>
|
|
321
|
+
><br>
|
|
322
322
|
></details>
|
|
323
323
|
|
|
324
|
+
#### Additional examples:
|
|
325
|
+
|
|
326
|
+
Get admins with lang en_US
|
|
327
|
+
|
|
328
|
+
```js
|
|
329
|
+
const result = await Admins.getAdminsInfo([], 'en_US', 0, 30);
|
|
330
|
+
```
|
|
331
|
+
|
|
332
|
+
Get admins with lang ru_RU
|
|
333
|
+
|
|
334
|
+
```js
|
|
335
|
+
const result = await Admins.getAdminsInfo([], 'ru_RU', 0, 30);
|
|
336
|
+
```
|
|
337
|
+
|
|
338
|
+
Get admins with filter by attributeMarker
|
|
339
|
+
|
|
340
|
+
```js
|
|
341
|
+
const body = [
|
|
342
|
+
{
|
|
343
|
+
attributeMarker: 'string_id1',
|
|
344
|
+
conditionMarker: 'in',
|
|
345
|
+
conditionValue: 1,
|
|
346
|
+
},
|
|
347
|
+
]
|
|
348
|
+
const result = await Admins.getAdminsInfo(body, 'en_US', 0, 30);
|
|
349
|
+
```
|
|
350
|
+
|
|
324
351
|
---
|
|
325
352
|
|
|
326
353
|
## <h2 id="attributesets"> AttributesSets </h2>
|
|
@@ -328,6 +355,7 @@ Example return:
|
|
|
328
355
|
```js
|
|
329
356
|
const { AttributesSets } = defineOneEntry('your-url');
|
|
330
357
|
```
|
|
358
|
+
<br>
|
|
331
359
|
|
|
332
360
|
### AttributesSets.getAttributes(langCode, offset, limit, typeId, sortBy)
|
|
333
361
|
|
|
@@ -335,7 +363,7 @@ const { AttributesSets } = defineOneEntry('your-url');
|
|
|
335
363
|
const value = await AttributesSets.getAttributes()
|
|
336
364
|
```
|
|
337
365
|
|
|
338
|
-
><details>
|
|
366
|
+
><details><br>
|
|
339
367
|
><summary>Schema</summary>
|
|
340
368
|
>
|
|
341
369
|
>**langCode:** string <br>
|
|
@@ -357,8 +385,9 @@ const value = await AttributesSets.getAttributes()
|
|
|
357
385
|
>**sortBy:** string <br>
|
|
358
386
|
>*sorting key*<br>
|
|
359
387
|
>example: id <br>
|
|
360
|
-
>
|
|
388
|
+
><br>
|
|
361
389
|
></details>
|
|
390
|
+
<br>
|
|
362
391
|
|
|
363
392
|
This method return all attribute sets objects and total.
|
|
364
393
|
|
|
@@ -399,7 +428,7 @@ Example return:
|
|
|
399
428
|
}
|
|
400
429
|
```
|
|
401
430
|
|
|
402
|
-
><details>
|
|
431
|
+
><details><br>
|
|
403
432
|
><summary>Schema</summary>
|
|
404
433
|
>
|
|
405
434
|
>**total:** number <br>
|
|
@@ -425,7 +454,7 @@ Example return:
|
|
|
425
454
|
>*Text identifier for record field* <br>
|
|
426
455
|
>example: 'my-id' <br>
|
|
427
456
|
>
|
|
428
|
-
>**title:**
|
|
457
|
+
>**title:** string <br>
|
|
429
458
|
>*Attribute set name* <br>
|
|
430
459
|
>example: Set for pages <br>
|
|
431
460
|
>
|
|
@@ -433,29 +462,29 @@ Example return:
|
|
|
433
462
|
>*Schema JSON description (attributes used by the set) of the attribute set* <br>
|
|
434
463
|
>example: OrderedMap { "attribute1": OrderedMap { "id": 1, "type": "string", "isPrice": false, "original": true, "identifier": "stroka", "localizeInfos": OrderedMap { "en_US": OrderedMap { "title": "String" } } } } <br>
|
|
435
464
|
>
|
|
436
|
-
>**title:**
|
|
465
|
+
>**title:** string <br>
|
|
437
466
|
>*Attribute set name* <br>
|
|
438
467
|
>example: Set for pages <br>
|
|
439
468
|
>
|
|
440
|
-
>**isVisible:**
|
|
469
|
+
>**isVisible:** boolean <br>
|
|
441
470
|
>*Visibility flag of the set* <br>
|
|
442
471
|
>
|
|
443
|
-
>**type:**
|
|
472
|
+
>**type:** object <br>
|
|
444
473
|
>*Object of set type* <br>
|
|
445
474
|
>
|
|
446
|
-
>**position:**
|
|
475
|
+
>**position:** number <br>
|
|
447
476
|
>*Position number* <br>
|
|
448
477
|
>example: 1 <br>
|
|
449
|
-
>
|
|
478
|
+
><br>
|
|
450
479
|
></details>
|
|
451
480
|
|
|
452
481
|
### AttributesSets.getAttributesByMarker(marker, langCode)
|
|
453
482
|
|
|
454
483
|
```js
|
|
455
|
-
const value = await AttributesSets.getAttributesByMarker('my-marker'
|
|
484
|
+
const value = await AttributesSets.getAttributesByMarker('my-marker')
|
|
456
485
|
```
|
|
457
486
|
|
|
458
|
-
><details>
|
|
487
|
+
><details><br>
|
|
459
488
|
><summary>Schema</summary>
|
|
460
489
|
>
|
|
461
490
|
>**marker*:** string <br>
|
|
@@ -465,9 +494,9 @@ const value = await AttributesSets.getAttributesByMarker('my-marker', 'en_US')
|
|
|
465
494
|
>**langCode:** string <br>
|
|
466
495
|
>*language code* <br>
|
|
467
496
|
>example: en_US <br>
|
|
468
|
-
>
|
|
497
|
+
><br>
|
|
469
498
|
></details>
|
|
470
|
-
|
|
499
|
+
<br>
|
|
471
500
|
This method return all attributes with data from the attribute set
|
|
472
501
|
|
|
473
502
|
Example return:
|
|
@@ -521,7 +550,7 @@ Example return:
|
|
|
521
550
|
]
|
|
522
551
|
```
|
|
523
552
|
|
|
524
|
-
><details>
|
|
553
|
+
><details><br>
|
|
525
554
|
><summary>Schema</summary>
|
|
526
555
|
>
|
|
527
556
|
>**type:** string <br>
|
|
@@ -557,16 +586,16 @@ Example return:
|
|
|
557
586
|
>**additionalFields:** Record<string, AttributeInSetDto> <br>
|
|
558
587
|
>*example: List [ OrderedMap { "type": "string", "value": "Your Name", "marker": "placeholder" } ]* <br>
|
|
559
588
|
>example: OrderedMap {} <br>
|
|
560
|
-
>
|
|
589
|
+
><br>
|
|
561
590
|
></details>
|
|
562
591
|
|
|
563
592
|
### AttributesSets.getSingleAttributeByMarkerSet(attributeMarker, setMarker, langCode)
|
|
564
593
|
|
|
565
594
|
```js
|
|
566
|
-
const value = await AttributesSets.getSingleAttributeByMarkerSet('list1', 'list1'
|
|
595
|
+
const value = await AttributesSets.getSingleAttributeByMarkerSet('list1', 'list1')
|
|
567
596
|
```
|
|
568
597
|
|
|
569
|
-
><details>
|
|
598
|
+
><details><br>
|
|
570
599
|
><summary>Schema</summary>
|
|
571
600
|
>
|
|
572
601
|
>**setMarker*:** number <br>
|
|
@@ -580,9 +609,9 @@ const value = await AttributesSets.getSingleAttributeByMarkerSet('list1', 'list1
|
|
|
580
609
|
>**langCode:** string <br>
|
|
581
610
|
>*language code* <br>
|
|
582
611
|
>example: en_US <br>
|
|
583
|
-
>
|
|
612
|
+
><br>
|
|
584
613
|
></details>
|
|
585
|
-
|
|
614
|
+
<br>
|
|
586
615
|
This method return a single attribute with data from the attribute sets.
|
|
587
616
|
|
|
588
617
|
Example return:
|
|
@@ -626,7 +655,7 @@ Example return:
|
|
|
626
655
|
}
|
|
627
656
|
```
|
|
628
657
|
|
|
629
|
-
><details>
|
|
658
|
+
><details><br>
|
|
630
659
|
><summary>Schema</summary>
|
|
631
660
|
>
|
|
632
661
|
>**type:** string <br>
|
|
@@ -652,7 +681,7 @@ Example return:
|
|
|
652
681
|
>**listTitles** Record<string, any> <br>
|
|
653
682
|
>*array of values (with extended data) for list and radioButton attributes* <br>
|
|
654
683
|
>example: List [ OrderedMap { "title": "red", "value": 1, "position": 1, "extendedValue": null, "extendedValueType": null }, OrderedMap { "title": "yellow", "value": 2, "position": 2, "extendedValue": null, "extendedValueType": null } ] <br>
|
|
655
|
-
>
|
|
684
|
+
><br>
|
|
656
685
|
></details>
|
|
657
686
|
|
|
658
687
|
---
|
|
@@ -660,10 +689,10 @@ Example return:
|
|
|
660
689
|
### AttributesSets.getAttributeSetByMarker(marker, langCode)
|
|
661
690
|
|
|
662
691
|
```js
|
|
663
|
-
const value = await AttributesSets.getAttributeSetByMarker('my-marker'
|
|
692
|
+
const value = await AttributesSets.getAttributeSetByMarker('my-marker')
|
|
664
693
|
```
|
|
665
694
|
|
|
666
|
-
><details>
|
|
695
|
+
><details><br>
|
|
667
696
|
><summary>Schema</summary>
|
|
668
697
|
>
|
|
669
698
|
>**marker*:** string <br>
|
|
@@ -673,9 +702,9 @@ const value = await AttributesSets.getAttributeSetByMarker('my-marker', 'en_US')
|
|
|
673
702
|
>**langCode:** string <br>
|
|
674
703
|
>*language code* <br>
|
|
675
704
|
>example: en_US <br>
|
|
676
|
-
>
|
|
705
|
+
><br>
|
|
677
706
|
></details>
|
|
678
|
-
|
|
707
|
+
<br>
|
|
679
708
|
This method return one attribute with data from the attribute set
|
|
680
709
|
|
|
681
710
|
Example return:
|
|
@@ -710,7 +739,7 @@ Example return:
|
|
|
710
739
|
}
|
|
711
740
|
```
|
|
712
741
|
|
|
713
|
-
><details>
|
|
742
|
+
><details><br>
|
|
714
743
|
><summary>Schema</summary>
|
|
715
744
|
>
|
|
716
745
|
>**id:** number <br>
|
|
@@ -746,9 +775,11 @@ Example return:
|
|
|
746
775
|
>**position*:** number <br>
|
|
747
776
|
>*Position number* <br>
|
|
748
777
|
>example: 1 <br>
|
|
749
|
-
>
|
|
778
|
+
><br>
|
|
750
779
|
></details>
|
|
751
780
|
|
|
781
|
+
---
|
|
782
|
+
|
|
752
783
|
## <h2 id="authprovider"> User Auth Provider </h2>
|
|
753
784
|
|
|
754
785
|
```js
|
|
@@ -757,7 +788,7 @@ const { AuthProvider } = defineOneEntry('your-url');
|
|
|
757
788
|
|
|
758
789
|
### AuthProvider.signUp(marker, body, langCode)
|
|
759
790
|
|
|
760
|
-
><details>
|
|
791
|
+
><details><br>
|
|
761
792
|
><summary>Schema</summary>
|
|
762
793
|
>
|
|
763
794
|
>**marker*:** string <br>
|
|
@@ -796,7 +827,7 @@ const { AuthProvider } = defineOneEntry('your-url');
|
|
|
796
827
|
>**langCode:** string <br>
|
|
797
828
|
>*language code* <br>
|
|
798
829
|
>example: en_US <br>
|
|
799
|
-
>
|
|
830
|
+
><br>
|
|
800
831
|
></details>
|
|
801
832
|
|
|
802
833
|
Method accept the body as a parameter.
|
|
@@ -1239,7 +1270,7 @@ const body = {
|
|
|
1239
1270
|
const value = await AuthProvider.signUp('email', body)
|
|
1240
1271
|
```
|
|
1241
1272
|
|
|
1242
|
-
><details>
|
|
1273
|
+
><details><br>
|
|
1243
1274
|
><summary>Schema</summary>
|
|
1244
1275
|
>
|
|
1245
1276
|
>**formIdentifier:** string <br>
|
|
@@ -1283,9 +1314,12 @@ const value = await AuthProvider.signUp('email', body)
|
|
|
1283
1314
|
>**authProviderId:** number <br>
|
|
1284
1315
|
>*ID of the authorization provider* <br>
|
|
1285
1316
|
>example: 1 <br>
|
|
1286
|
-
>
|
|
1317
|
+
><br>
|
|
1287
1318
|
></details>
|
|
1288
|
-
|
|
1319
|
+
|
|
1320
|
+
<br>
|
|
1321
|
+
|
|
1322
|
+
This method will register a new user. Returns the registered user's object.
|
|
1289
1323
|
|
|
1290
1324
|
Example return:
|
|
1291
1325
|
|
|
@@ -1319,7 +1353,7 @@ Example return:
|
|
|
1319
1353
|
}
|
|
1320
1354
|
```
|
|
1321
1355
|
|
|
1322
|
-
><details>
|
|
1356
|
+
><details><br>
|
|
1323
1357
|
><summary>Schema</summary>
|
|
1324
1358
|
>
|
|
1325
1359
|
>**id:** number <br>
|
|
@@ -1365,7 +1399,7 @@ Example return:
|
|
|
1365
1399
|
>**authProviderId:** number <br>
|
|
1366
1400
|
>*ID of the authorization provider* <br>
|
|
1367
1401
|
>example: 1 <br>
|
|
1368
|
-
>
|
|
1402
|
+
><br>
|
|
1369
1403
|
></details>
|
|
1370
1404
|
|
|
1371
1405
|
### AuthProvider.generateCode(marker, userIdentifier, eventIdentifier)
|
|
@@ -1374,7 +1408,7 @@ Example return:
|
|
|
1374
1408
|
const value = await AuthProvider.generateCode('email', 'example@oneentry.cloud', 'auth')
|
|
1375
1409
|
```
|
|
1376
1410
|
|
|
1377
|
-
><details>
|
|
1411
|
+
><details><br>
|
|
1378
1412
|
><summary>Schema</summary>
|
|
1379
1413
|
>
|
|
1380
1414
|
>**marker*:** array <br>
|
|
@@ -1388,7 +1422,7 @@ const value = await AuthProvider.generateCode('email', 'example@oneentry.cloud',
|
|
|
1388
1422
|
>**eventIdentifier*:** string <br>
|
|
1389
1423
|
>*Text identifier of the event object for which the code is generated* <br>
|
|
1390
1424
|
>example: auth <br>
|
|
1391
|
-
>
|
|
1425
|
+
><br>
|
|
1392
1426
|
></details>
|
|
1393
1427
|
|
|
1394
1428
|
This method receives a code to activate the user. Code is returned through the corresponding user notification method
|
|
@@ -1399,7 +1433,7 @@ This method receives a code to activate the user. Code is returned through the c
|
|
|
1399
1433
|
const value = await AuthProvider.checkCode('email', 'example@oneentry.cloud', 'WTGC9E')
|
|
1400
1434
|
```
|
|
1401
1435
|
|
|
1402
|
-
><details>
|
|
1436
|
+
><details><br>
|
|
1403
1437
|
><summary>Schema</summary>
|
|
1404
1438
|
>
|
|
1405
1439
|
>**marker*:** string <br>
|
|
@@ -1417,7 +1451,7 @@ const value = await AuthProvider.checkCode('email', 'example@oneentry.cloud', 'W
|
|
|
1417
1451
|
>**code*:** string <br>
|
|
1418
1452
|
>*Service code* <br>
|
|
1419
1453
|
>example: WTGC9E <br>
|
|
1420
|
-
>
|
|
1454
|
+
><br>
|
|
1421
1455
|
></details>
|
|
1422
1456
|
|
|
1423
1457
|
This method checks the user's code. Returns true (if the code is correct) or false (if it is incorrect).
|
|
@@ -1434,7 +1468,7 @@ true
|
|
|
1434
1468
|
const value = await AuthProvider.activateUser('email', 'example@oneentry.cloud', 'WTGC9E')
|
|
1435
1469
|
```
|
|
1436
1470
|
|
|
1437
|
-
><details>
|
|
1471
|
+
><details><br>
|
|
1438
1472
|
><summary>Schema</summary>
|
|
1439
1473
|
>
|
|
1440
1474
|
>**marker*:** string <br>
|
|
@@ -1448,7 +1482,7 @@ const value = await AuthProvider.activateUser('email', 'example@oneentry.cloud',
|
|
|
1448
1482
|
>**code*:** string <br>
|
|
1449
1483
|
>*Service code* <br>
|
|
1450
1484
|
>example: WTGC9E <br>
|
|
1451
|
-
>
|
|
1485
|
+
><br>
|
|
1452
1486
|
></details>
|
|
1453
1487
|
|
|
1454
1488
|
This method activates the user by code. If successful, it will return true.
|
|
@@ -1478,7 +1512,7 @@ const data = {
|
|
|
1478
1512
|
const value = await AuthProvider.auth('email', data)
|
|
1479
1513
|
```
|
|
1480
1514
|
|
|
1481
|
-
><details>
|
|
1515
|
+
><details><br>
|
|
1482
1516
|
><summary>Schema</summary>
|
|
1483
1517
|
>
|
|
1484
1518
|
>**marker:** string <br>
|
|
@@ -1488,18 +1522,18 @@ const value = await AuthProvider.auth('email', data)
|
|
|
1488
1522
|
>**data:** IAuthPostBody <br>
|
|
1489
1523
|
>*Array of objects contains auth information* <br>
|
|
1490
1524
|
>example: { authData: [{marker: "login",value: "test"},{marker: "password",value: "12345"}]} <br>
|
|
1491
|
-
>
|
|
1525
|
+
><br>
|
|
1492
1526
|
></details>
|
|
1493
1527
|
|
|
1494
1528
|
<br>
|
|
1495
1529
|
|
|
1496
|
-
><details>
|
|
1530
|
+
><details><br>
|
|
1497
1531
|
><summary>Schema</summary>
|
|
1498
1532
|
>
|
|
1499
1533
|
>**authData:** string <br>
|
|
1500
1534
|
>*Authorization data taken from the form attached to the authorization provider*
|
|
1501
1535
|
>example: List [ OrderedMap { "marker": "login", "value": "test" }, OrderedMap { "marker": "password", "value": "12345" } ] <br>
|
|
1502
|
-
>
|
|
1536
|
+
><br>
|
|
1503
1537
|
></details>
|
|
1504
1538
|
|
|
1505
1539
|
This method performs user authorization. Returns an object with a set of tokens.
|
|
@@ -1515,7 +1549,7 @@ Example return:
|
|
|
1515
1549
|
}
|
|
1516
1550
|
```
|
|
1517
1551
|
|
|
1518
|
-
><details>
|
|
1552
|
+
><details><br>
|
|
1519
1553
|
><summary>Schema</summary>
|
|
1520
1554
|
>
|
|
1521
1555
|
>**userIdentifier:** string <br>
|
|
@@ -1533,7 +1567,7 @@ Example return:
|
|
|
1533
1567
|
>**refreshToken:** string <br>
|
|
1534
1568
|
>*refresh token* <br>
|
|
1535
1569
|
>example: 1714557670334-cb85112d-618d-4b2a-bad5-137b19c135b9 <br>
|
|
1536
|
-
>
|
|
1570
|
+
><br>
|
|
1537
1571
|
></details>
|
|
1538
1572
|
|
|
1539
1573
|
### AuthProvider.refresh(marker, token)
|
|
@@ -1542,7 +1576,7 @@ Example return:
|
|
|
1542
1576
|
const value = await AuthProvider.refresh('email', '1714557670334-cb85112d-618d-4b2a-bad5-137b19c135b9')
|
|
1543
1577
|
```
|
|
1544
1578
|
|
|
1545
|
-
><details>
|
|
1579
|
+
><details><br>
|
|
1546
1580
|
><summary>Schema</summary>
|
|
1547
1581
|
>
|
|
1548
1582
|
>**marker*:** string <br>
|
|
@@ -1552,7 +1586,7 @@ const value = await AuthProvider.refresh('email', '1714557670334-cb85112d-618d-4
|
|
|
1552
1586
|
>**token*:** string <br>
|
|
1553
1587
|
>*Refresh token* <br>
|
|
1554
1588
|
>example: 1714557670334-cb85112d-618d-4b2a-bad5-137b19c135b9 <br>
|
|
1555
|
-
>
|
|
1589
|
+
><br>
|
|
1556
1590
|
></details>
|
|
1557
1591
|
|
|
1558
1592
|
This method updates the user's token. Returns an object with a set of tokens.
|
|
@@ -1568,8 +1602,8 @@ Example return:
|
|
|
1568
1602
|
}
|
|
1569
1603
|
```
|
|
1570
1604
|
|
|
1571
|
-
><details>
|
|
1572
|
-
><summary
|
|
1605
|
+
><details><br>
|
|
1606
|
+
><summary>Schema</summary>
|
|
1573
1607
|
>
|
|
1574
1608
|
>**userIdentifier:** string <br>
|
|
1575
1609
|
>*user identifier*
|
|
@@ -1586,7 +1620,7 @@ Example return:
|
|
|
1586
1620
|
>**refreshToken:** string <br>
|
|
1587
1621
|
>*refresh token* <br>
|
|
1588
1622
|
>example: 1714557670334-cb85112d-618d-4b2a-bad5-137b19c135b9 <br>
|
|
1589
|
-
>
|
|
1623
|
+
><br>
|
|
1590
1624
|
></details>
|
|
1591
1625
|
|
|
1592
1626
|
### AuthProvider.logout(marker, token)
|
|
@@ -1595,7 +1629,7 @@ Example return:
|
|
|
1595
1629
|
const value = await AuthProvider.logout('email', '1714557670334-cb85112d-618d-4b2a-bad5-137b19c135b9')
|
|
1596
1630
|
```
|
|
1597
1631
|
|
|
1598
|
-
><details>
|
|
1632
|
+
><details><br>
|
|
1599
1633
|
><summary>Schema</summary>
|
|
1600
1634
|
>
|
|
1601
1635
|
>**marker*:** string <br>
|
|
@@ -1605,7 +1639,7 @@ const value = await AuthProvider.logout('email', '1714557670334-cb85112d-618d-4b
|
|
|
1605
1639
|
>**token*:** string <br>
|
|
1606
1640
|
>*Refresh token* <br>
|
|
1607
1641
|
>example: 1714557670334-cb85112d-618d-4b2a-bad5-137b19c135b9 <br>
|
|
1608
|
-
>
|
|
1642
|
+
><br>
|
|
1609
1643
|
></details>
|
|
1610
1644
|
|
|
1611
1645
|
This method performs a user logout. If successful, it will return true. This method requires user authorization.
|
|
@@ -1622,7 +1656,7 @@ true
|
|
|
1622
1656
|
const value = await AuthProvider.changePassword('email', 'example@oneentry.cloud', 1, 'EW32RF', 654321, 654321)
|
|
1623
1657
|
```
|
|
1624
1658
|
|
|
1625
|
-
><details>
|
|
1659
|
+
><details><br>
|
|
1626
1660
|
><summary>Schema</summary>
|
|
1627
1661
|
>
|
|
1628
1662
|
>**marker*:** string <br>
|
|
@@ -1633,7 +1667,7 @@ const value = await AuthProvider.changePassword('email', 'example@oneentry.cloud
|
|
|
1633
1667
|
>*The text identifier of the user's object (user login)* <br>
|
|
1634
1668
|
>example: example@oneentry.cloud <br>
|
|
1635
1669
|
>
|
|
1636
|
-
>**type*:**
|
|
1670
|
+
>**type*:** string <br>
|
|
1637
1671
|
>*Operation type (1 - for changing password, 2 - for recovery)* <br>
|
|
1638
1672
|
>example: 1 <br>
|
|
1639
1673
|
>
|
|
@@ -1648,7 +1682,7 @@ const value = await AuthProvider.changePassword('email', 'example@oneentry.cloud
|
|
|
1648
1682
|
>**repeatPassword:** string <br>
|
|
1649
1683
|
>*Optional variable contains repeat new password for validation* <br>
|
|
1650
1684
|
>example: 654321 <br>
|
|
1651
|
-
>
|
|
1685
|
+
><br>
|
|
1652
1686
|
></details>
|
|
1653
1687
|
|
|
1654
1688
|
This method changes the password of an authorized user. If successful, it will return true.
|
|
@@ -1665,7 +1699,7 @@ true
|
|
|
1665
1699
|
const value = await AuthProvider.getAuthProviders()
|
|
1666
1700
|
```
|
|
1667
1701
|
|
|
1668
|
-
><details>
|
|
1702
|
+
><details><br>
|
|
1669
1703
|
><summary>Schema</summary>
|
|
1670
1704
|
>
|
|
1671
1705
|
>**langCode:** string <br>
|
|
@@ -1679,7 +1713,7 @@ const value = await AuthProvider.getAuthProviders()
|
|
|
1679
1713
|
>**limit:** number <br>
|
|
1680
1714
|
>*parameter for pagination, default 30* <br>
|
|
1681
1715
|
>example: 30 <br>
|
|
1682
|
-
>
|
|
1716
|
+
><br>
|
|
1683
1717
|
></details>
|
|
1684
1718
|
|
|
1685
1719
|
<br>
|
|
@@ -1711,8 +1745,8 @@ Example return:
|
|
|
1711
1745
|
]
|
|
1712
1746
|
```
|
|
1713
1747
|
|
|
1714
|
-
><details>
|
|
1715
|
-
><summary
|
|
1748
|
+
><details><br>
|
|
1749
|
+
><summary>Schema</summary>
|
|
1716
1750
|
>
|
|
1717
1751
|
>**id:** number <br>
|
|
1718
1752
|
>*object identifier*
|
|
@@ -1746,7 +1780,7 @@ Example return:
|
|
|
1746
1780
|
>**formIdentifier:** string <br>
|
|
1747
1781
|
>*the marker of the form used by the provider (may be null)* <br>
|
|
1748
1782
|
>example: email <br>
|
|
1749
|
-
>
|
|
1783
|
+
><br>
|
|
1750
1784
|
></details>
|
|
1751
1785
|
|
|
1752
1786
|
### AuthProvider.getMarker(marker, langCode)
|
|
@@ -1755,7 +1789,7 @@ Example return:
|
|
|
1755
1789
|
const value = await AuthProvider.getMarker('email')
|
|
1756
1790
|
```
|
|
1757
1791
|
|
|
1758
|
-
><details>
|
|
1792
|
+
><details><br>
|
|
1759
1793
|
><summary>Schema</summary>
|
|
1760
1794
|
>
|
|
1761
1795
|
>**marker*:** string <br>
|
|
@@ -1765,7 +1799,7 @@ const value = await AuthProvider.getMarker('email')
|
|
|
1765
1799
|
>**langCode:** string <br>
|
|
1766
1800
|
>*language code* <br>
|
|
1767
1801
|
>example: en_US <br>
|
|
1768
|
-
>
|
|
1802
|
+
><br>
|
|
1769
1803
|
></details>
|
|
1770
1804
|
|
|
1771
1805
|
Getting a single token authorization provider object.
|
|
@@ -1795,7 +1829,7 @@ Example return:
|
|
|
1795
1829
|
]
|
|
1796
1830
|
```
|
|
1797
1831
|
|
|
1798
|
-
><details>
|
|
1832
|
+
><details><br>
|
|
1799
1833
|
><summary>Schema</summary>
|
|
1800
1834
|
>
|
|
1801
1835
|
>**id:** number <br>
|
|
@@ -1830,7 +1864,7 @@ Example return:
|
|
|
1830
1864
|
>**formIdentifier:** string <br>
|
|
1831
1865
|
>*the marker of the form used by the provider (may be null)* <br>
|
|
1832
1866
|
>example: email <br>
|
|
1833
|
-
>
|
|
1867
|
+
><br>
|
|
1834
1868
|
></details>
|
|
1835
1869
|
|
|
1836
1870
|
---
|
|
@@ -1847,7 +1881,7 @@ const { Blocks } = defineOneEntry('your-url');
|
|
|
1847
1881
|
const value = await Blocks.getBlocks('forTextBlock')
|
|
1848
1882
|
```
|
|
1849
1883
|
|
|
1850
|
-
><details>
|
|
1884
|
+
><details><br>
|
|
1851
1885
|
><summary>Schema</summary>
|
|
1852
1886
|
>
|
|
1853
1887
|
>**type*:** BlockType <br>
|
|
@@ -1865,7 +1899,7 @@ const value = await Blocks.getBlocks('forTextBlock')
|
|
|
1865
1899
|
>**limit:** number <br>
|
|
1866
1900
|
>*Parameter for pagination. Default 30* <br>
|
|
1867
1901
|
>example: 30 <br>
|
|
1868
|
-
>
|
|
1902
|
+
><br>
|
|
1869
1903
|
></details>
|
|
1870
1904
|
|
|
1871
1905
|
This method return array of all blocks object and total.
|
|
@@ -1893,8 +1927,8 @@ Example return:
|
|
|
1893
1927
|
}
|
|
1894
1928
|
```
|
|
1895
1929
|
|
|
1896
|
-
><details>
|
|
1897
|
-
><summary
|
|
1930
|
+
><details><br>
|
|
1931
|
+
><summary>Schema</summary>
|
|
1898
1932
|
>
|
|
1899
1933
|
>**total:** number <br>
|
|
1900
1934
|
>*total number of found records* <br>
|
|
@@ -1942,7 +1976,7 @@ Example return:
|
|
|
1942
1976
|
>Enum:
|
|
1943
1977
|
>[ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ] <br>
|
|
1944
1978
|
>example: null <br>
|
|
1945
|
-
>
|
|
1979
|
+
><br>
|
|
1946
1980
|
></details>
|
|
1947
1981
|
|
|
1948
1982
|
---
|
|
@@ -1953,7 +1987,7 @@ Example return:
|
|
|
1953
1987
|
const value = await Blocks.getBlockByMarker('my-marker')
|
|
1954
1988
|
```
|
|
1955
1989
|
|
|
1956
|
-
><details>
|
|
1990
|
+
><details><br>
|
|
1957
1991
|
><summary>Schema</summary>
|
|
1958
1992
|
>
|
|
1959
1993
|
>**marker*:** string <br>
|
|
@@ -1971,7 +2005,7 @@ const value = await Blocks.getBlockByMarker('my-marker')
|
|
|
1971
2005
|
>**limit:** number <br>
|
|
1972
2006
|
>*Parameter for pagination. Default 30* <br>
|
|
1973
2007
|
>example: 30 <br>
|
|
1974
|
-
>
|
|
2008
|
+
><br>
|
|
1975
2009
|
></details>
|
|
1976
2010
|
|
|
1977
2011
|
This method return one blocks object by marker.
|
|
@@ -2037,7 +2071,7 @@ Example return:
|
|
|
2037
2071
|
}
|
|
2038
2072
|
```
|
|
2039
2073
|
|
|
2040
|
-
><details>
|
|
2074
|
+
><details><br>
|
|
2041
2075
|
><summary>Schema</summary>
|
|
2042
2076
|
>
|
|
2043
2077
|
>**id:** number <br>
|
|
@@ -2095,7 +2129,7 @@ example: OrderedMap { "sliderDelay": 0, "sliderDelayType": "", "productConfig":
|
|
|
2095
2129
|
>**templateIdentifier:** string <br>
|
|
2096
2130
|
>*Template marker used by the block (can be null)* <br>
|
|
2097
2131
|
>example: null <br>
|
|
2098
|
-
>
|
|
2132
|
+
><br>
|
|
2099
2133
|
></details>
|
|
2100
2134
|
|
|
2101
2135
|
---
|
|
@@ -2106,7 +2140,7 @@ example: OrderedMap { "sliderDelay": 0, "sliderDelayType": "", "productConfig":
|
|
|
2106
2140
|
const value = await Blocks.searchBlock('my-marker')
|
|
2107
2141
|
```
|
|
2108
2142
|
|
|
2109
|
-
><details>
|
|
2143
|
+
><details><br>
|
|
2110
2144
|
><summary>Schema</summary>
|
|
2111
2145
|
>
|
|
2112
2146
|
>**marker*:** string <br>
|
|
@@ -2116,7 +2150,7 @@ const value = await Blocks.searchBlock('my-marker')
|
|
|
2116
2150
|
>**langCode:** string <br>
|
|
2117
2151
|
>*Language code* <br>
|
|
2118
2152
|
>example: en_US <br>
|
|
2119
|
-
>
|
|
2153
|
+
><br>
|
|
2120
2154
|
></details>
|
|
2121
2155
|
|
|
2122
2156
|
Quick search for block objects with limited output.
|
|
@@ -2144,10 +2178,10 @@ const { Events } = defineOneEntry('your-url');
|
|
|
2144
2178
|
### Events.getAllSubscriptions(offset, limit)
|
|
2145
2179
|
|
|
2146
2180
|
```js
|
|
2147
|
-
const value = await Events.getAllSubscriptions(
|
|
2181
|
+
const value = await Events.getAllSubscriptions()
|
|
2148
2182
|
```
|
|
2149
2183
|
|
|
2150
|
-
><details>
|
|
2184
|
+
><details><br>
|
|
2151
2185
|
><summary>Schema</summary>
|
|
2152
2186
|
>
|
|
2153
2187
|
>**offset:** number <br>
|
|
@@ -2157,7 +2191,7 @@ const value = await Events.getAllSubscriptions(0, 30)
|
|
|
2157
2191
|
>**limit:** number <br>
|
|
2158
2192
|
>*Pagination parameter, default is 30* <br>
|
|
2159
2193
|
>example: 30 <br>
|
|
2160
|
-
>
|
|
2194
|
+
><br>
|
|
2161
2195
|
></details>
|
|
2162
2196
|
|
|
2163
2197
|
This method return all subscriptions to product.
|
|
@@ -2177,7 +2211,7 @@ Example return:
|
|
|
2177
2211
|
```
|
|
2178
2212
|
|
|
2179
2213
|
><details>
|
|
2180
|
-
><summary
|
|
2214
|
+
><summary>Schema</summary>
|
|
2181
2215
|
>
|
|
2182
2216
|
>**total:** number <br>
|
|
2183
2217
|
>*Total number of records found* <br>
|
|
@@ -2196,7 +2230,7 @@ Example return:
|
|
|
2196
2230
|
const value = await Events.subscribeByMarker('test_event', 1, 1)
|
|
2197
2231
|
```
|
|
2198
2232
|
|
|
2199
|
-
><details>
|
|
2233
|
+
><details><br>
|
|
2200
2234
|
><summary>Schema</summary>
|
|
2201
2235
|
>
|
|
2202
2236
|
>**marker*:** string <br>
|
|
@@ -2214,7 +2248,7 @@ const value = await Events.subscribeByMarker('test_event', 1, 1)
|
|
|
2214
2248
|
>**threshold:** number <br>
|
|
2215
2249
|
>*Threshold value for comparing numerical value* <br>
|
|
2216
2250
|
>example: 0 <br>
|
|
2217
|
-
>
|
|
2251
|
+
><br>
|
|
2218
2252
|
></details>
|
|
2219
2253
|
|
|
2220
2254
|
This method subscribes to the product event. Returns nothing if the subscription was successful. This method requires user authorization.
|
|
@@ -2225,7 +2259,7 @@ This method subscribes to the product event. Returns nothing if the subscription
|
|
|
2225
2259
|
const value = await Events.unsubscribeByMarker('test_event', 1, 1)
|
|
2226
2260
|
```
|
|
2227
2261
|
|
|
2228
|
-
><details>
|
|
2262
|
+
><details><br>
|
|
2229
2263
|
><summary>Schema</summary>
|
|
2230
2264
|
>
|
|
2231
2265
|
>**marker*:** string <br>
|
|
@@ -2243,7 +2277,7 @@ const value = await Events.unsubscribeByMarker('test_event', 1, 1)
|
|
|
2243
2277
|
>**threshold:** number <br>
|
|
2244
2278
|
>*Threshold value for comparing numerical value* <br>
|
|
2245
2279
|
>example: 0 <br>
|
|
2246
|
-
>
|
|
2280
|
+
><br>
|
|
2247
2281
|
></details>
|
|
2248
2282
|
|
|
2249
2283
|
This method unsubscribes to the product event. Returns nothing if the unsubscription was successful.
|
|
@@ -2271,7 +2305,7 @@ const query = {
|
|
|
2271
2305
|
const value = await FileUploading.upload(data, query)
|
|
2272
2306
|
```
|
|
2273
2307
|
|
|
2274
|
-
><details>
|
|
2308
|
+
><details><br>
|
|
2275
2309
|
><summary>Schema</summary>
|
|
2276
2310
|
>
|
|
2277
2311
|
>**data*:** File <br>
|
|
@@ -2305,7 +2339,7 @@ const value = await FileUploading.upload(data, query)
|
|
|
2305
2339
|
>**fileQuery.compress** boolean <br>
|
|
2306
2340
|
>*Optional flag of optimization (compression) for images* <br>
|
|
2307
2341
|
>example: true <br>
|
|
2308
|
-
>
|
|
2342
|
+
><br>
|
|
2309
2343
|
></details>
|
|
2310
2344
|
|
|
2311
2345
|
This method uploads a file to a cloud file storage. Pass to the date the value obtained from input type "file".
|
|
@@ -2326,8 +2360,8 @@ Example return:
|
|
|
2326
2360
|
]
|
|
2327
2361
|
```
|
|
2328
2362
|
|
|
2329
|
-
><details>
|
|
2330
|
-
><summary
|
|
2363
|
+
><details><br>
|
|
2364
|
+
><summary>Schema</summary>
|
|
2331
2365
|
>
|
|
2332
2366
|
>**filename:** string <br>
|
|
2333
2367
|
>*filename with relative path* <br>
|
|
@@ -2337,7 +2371,7 @@ Example return:
|
|
|
2337
2371
|
>
|
|
2338
2372
|
>**size** number <br>
|
|
2339
2373
|
>*size of the file in bytes* <br>
|
|
2340
|
-
>
|
|
2374
|
+
><br>
|
|
2341
2375
|
></details>
|
|
2342
2376
|
|
|
2343
2377
|
### FileUploading.delete(filename, fileQuery)
|
|
@@ -2352,7 +2386,7 @@ const query = {
|
|
|
2352
2386
|
const value = await FileUploading.delete("file.png", query)
|
|
2353
2387
|
```
|
|
2354
2388
|
|
|
2355
|
-
><details>
|
|
2389
|
+
><details><br>
|
|
2356
2390
|
><summary>Schema</summary>
|
|
2357
2391
|
>
|
|
2358
2392
|
>**filename:** string <br>
|
|
@@ -2374,7 +2408,7 @@ const value = await FileUploading.delete("file.png", query)
|
|
|
2374
2408
|
>**fileQuery.id** number <br>
|
|
2375
2409
|
>*Identifier of the object from which the file is uploaded, determines the folder name in the storage* <br>
|
|
2376
2410
|
>example: 3787 <br>
|
|
2377
|
-
>
|
|
2411
|
+
><br>
|
|
2378
2412
|
></details>
|
|
2379
2413
|
|
|
2380
2414
|
This void method delete a file from the cloud file storage.
|
|
@@ -2385,7 +2419,7 @@ This void method delete a file from the cloud file storage.
|
|
|
2385
2419
|
const value = await FileUploading.getFile(123, 'page', 'editor', 'file.png')
|
|
2386
2420
|
```
|
|
2387
2421
|
|
|
2388
|
-
><details>
|
|
2422
|
+
><details><br>
|
|
2389
2423
|
><summary>Schema</summary>
|
|
2390
2424
|
>
|
|
2391
2425
|
>**id:** number <br>
|
|
@@ -2403,7 +2437,7 @@ const value = await FileUploading.getFile(123, 'page', 'editor', 'file.png')
|
|
|
2403
2437
|
>**filename:** string <br>
|
|
2404
2438
|
>*Filename* <br>
|
|
2405
2439
|
>example: file.png <br>
|
|
2406
|
-
>
|
|
2440
|
+
><br>
|
|
2407
2441
|
></details>
|
|
2408
2442
|
|
|
2409
2443
|
This method return file object by parameters.
|
|
@@ -2430,7 +2464,7 @@ const { Forms } = defineOneEntry('your-url');
|
|
|
2430
2464
|
const value = await Forms.getAllForms()
|
|
2431
2465
|
```
|
|
2432
2466
|
|
|
2433
|
-
><details>
|
|
2467
|
+
><details><br>
|
|
2434
2468
|
><summary>Schema</summary>
|
|
2435
2469
|
>
|
|
2436
2470
|
>**langCode** string <br>
|
|
@@ -2444,7 +2478,7 @@ const value = await Forms.getAllForms()
|
|
|
2444
2478
|
>**limit** number <br>
|
|
2445
2479
|
>*Parameter for pagination. Default 30* <br>
|
|
2446
2480
|
>example: 30 <br>
|
|
2447
|
-
>
|
|
2481
|
+
><br>
|
|
2448
2482
|
></details>
|
|
2449
2483
|
|
|
2450
2484
|
This method retrieves all form objects from the API. It returns a Promise that resolves to an array of FormEntity objects.
|
|
@@ -2503,8 +2537,8 @@ Example return:
|
|
|
2503
2537
|
]
|
|
2504
2538
|
```
|
|
2505
2539
|
|
|
2506
|
-
><details>
|
|
2507
|
-
><summary
|
|
2540
|
+
><details><br>
|
|
2541
|
+
><summary>Schema</summary>
|
|
2508
2542
|
>
|
|
2509
2543
|
>**id:** number <br>
|
|
2510
2544
|
>*object identifier* <br>
|
|
@@ -2555,7 +2589,7 @@ Example return:
|
|
|
2555
2589
|
const value = await Forms.getFormByMarker('my-form')
|
|
2556
2590
|
```
|
|
2557
2591
|
|
|
2558
|
-
><details>
|
|
2592
|
+
><details><br>
|
|
2559
2593
|
><summary>Schema</summary>
|
|
2560
2594
|
>
|
|
2561
2595
|
>**marker*:** string <br>
|
|
@@ -2565,7 +2599,7 @@ const value = await Forms.getFormByMarker('my-form')
|
|
|
2565
2599
|
>**langCode:** string <br>
|
|
2566
2600
|
>*Language code. Default "en_US"* <br>
|
|
2567
2601
|
>example: en_US <br>
|
|
2568
|
-
>
|
|
2602
|
+
><br>
|
|
2569
2603
|
></details>
|
|
2570
2604
|
|
|
2571
2605
|
This method retrieves a single form object based on its textual identifier (marker) from the API. It returns a Promise that resolves to a FormEntity object.
|
|
@@ -2622,8 +2656,8 @@ Example return:
|
|
|
2622
2656
|
}
|
|
2623
2657
|
```
|
|
2624
2658
|
|
|
2625
|
-
><details>
|
|
2626
|
-
><summary
|
|
2659
|
+
><details><br>
|
|
2660
|
+
><summary>Schema</summary>
|
|
2627
2661
|
>
|
|
2628
2662
|
>**id:** number <br>
|
|
2629
2663
|
>*object identifier* <br>
|
|
@@ -2665,7 +2699,7 @@ Example return:
|
|
|
2665
2699
|
>**attributes:** <br>
|
|
2666
2700
|
>*array of attribute values from the used attribute set for displaying the form (taking into account the specified language)* <br>
|
|
2667
2701
|
>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" } } ] <br>
|
|
2668
|
-
>
|
|
2702
|
+
><br>
|
|
2669
2703
|
></details>
|
|
2670
2704
|
|
|
2671
2705
|
---
|
|
@@ -2859,7 +2893,7 @@ Example with attribute type "entity" (nested list)
|
|
|
2859
2893
|
const value = await FormData.getFormsData()
|
|
2860
2894
|
```
|
|
2861
2895
|
|
|
2862
|
-
><details>
|
|
2896
|
+
><details><br>
|
|
2863
2897
|
><summary>Schema</summary>
|
|
2864
2898
|
>
|
|
2865
2899
|
>**langCode:** string <br>
|
|
@@ -2873,7 +2907,7 @@ const value = await FormData.getFormsData()
|
|
|
2873
2907
|
>**limit:** number <br>
|
|
2874
2908
|
>*Parameter for pagination. Default 30* <br>
|
|
2875
2909
|
>example: 30 <br>
|
|
2876
|
-
>
|
|
2910
|
+
><br>
|
|
2877
2911
|
></details>
|
|
2878
2912
|
|
|
2879
2913
|
This method creates form data objects by sending a request to the API. It accepts an array of objects of type IFormsPost as the request body to provide the necessary form data. It returns a Promise that resolves to the created CreateFormDataDto objects.
|
|
@@ -2899,8 +2933,8 @@ Example return:
|
|
|
2899
2933
|
}
|
|
2900
2934
|
```
|
|
2901
2935
|
|
|
2902
|
-
><details>
|
|
2903
|
-
><summary
|
|
2936
|
+
><details><br>
|
|
2937
|
+
><summary>Schema</summary>
|
|
2904
2938
|
>
|
|
2905
2939
|
>**total:** number <br>
|
|
2906
2940
|
>*total number of found records* <br>
|
|
@@ -2925,7 +2959,7 @@ Example return:
|
|
|
2925
2959
|
>**attributeSetIdentifier:** string <br>
|
|
2926
2960
|
>*text identifier (marker) of the used attribute set* <br>
|
|
2927
2961
|
>example: test-form <br>
|
|
2928
|
-
>
|
|
2962
|
+
><br>
|
|
2929
2963
|
></details>
|
|
2930
2964
|
|
|
2931
2965
|
### FormData.postFormsData(data, langCode)
|
|
@@ -2938,7 +2972,7 @@ const body = {
|
|
|
2938
2972
|
{
|
|
2939
2973
|
"marker": "last_name",
|
|
2940
2974
|
"type": "string",
|
|
2941
|
-
"value": "
|
|
2975
|
+
"value": "Andrey"
|
|
2942
2976
|
}
|
|
2943
2977
|
]
|
|
2944
2978
|
}
|
|
@@ -2948,7 +2982,7 @@ const value = await FormData.postFormsData(body)
|
|
|
2948
2982
|
```
|
|
2949
2983
|
|
|
2950
2984
|
><details>
|
|
2951
|
-
><summary
|
|
2985
|
+
><summary>Schema (body)</summary>
|
|
2952
2986
|
>
|
|
2953
2987
|
<!-- >**id:** number <br>
|
|
2954
2988
|
>*Data object identifier* <br>
|
|
@@ -2985,8 +3019,8 @@ Example return:
|
|
|
2985
3019
|
}
|
|
2986
3020
|
```
|
|
2987
3021
|
|
|
2988
|
-
><details>
|
|
2989
|
-
><summary
|
|
3022
|
+
><details><br>
|
|
3023
|
+
><summary>Schema</summary>
|
|
2990
3024
|
>
|
|
2991
3025
|
>**id:** number <br>
|
|
2992
3026
|
>*object identifier* <br>
|
|
@@ -3003,7 +3037,7 @@ Example return:
|
|
|
3003
3037
|
>**formData:** FormDataLangType <br>
|
|
3004
3038
|
>*Data submitted by the form* <br>
|
|
3005
3039
|
>example: OrderedMap { "en_US": List [ OrderedMap { "marker": "naimenovanie_1", "value": "Name" } ] } <br>
|
|
3006
|
-
>
|
|
3040
|
+
><br>
|
|
3007
3041
|
></details>
|
|
3008
3042
|
|
|
3009
3043
|
### FormData.getFormsDataByMarker(marker, langCode, offset, limit)
|
|
@@ -3012,7 +3046,7 @@ Example return:
|
|
|
3012
3046
|
const value = await FormData.getFormsDataByMarker('my-marker')
|
|
3013
3047
|
```
|
|
3014
3048
|
|
|
3015
|
-
><details>
|
|
3049
|
+
><details><br>
|
|
3016
3050
|
><summary>Schema</summary>
|
|
3017
3051
|
>
|
|
3018
3052
|
>**marker*:** string <br>
|
|
@@ -3030,7 +3064,7 @@ const value = await FormData.getFormsDataByMarker('my-marker')
|
|
|
3030
3064
|
>**limit:** number <br>
|
|
3031
3065
|
>*Parameter for pagination. Default 30"* <br>
|
|
3032
3066
|
>example: 30 <br>
|
|
3033
|
-
>
|
|
3067
|
+
><br>
|
|
3034
3068
|
></details>
|
|
3035
3069
|
|
|
3036
3070
|
This method retrieves a specific form data object by its marker from the API. It accepts a marker parameter as the marker of the form data. It returns a Promise that resolves to an array of objects of type FormDataEntity.
|
|
@@ -3056,7 +3090,7 @@ Example return:
|
|
|
3056
3090
|
}
|
|
3057
3091
|
```
|
|
3058
3092
|
|
|
3059
|
-
><details>
|
|
3093
|
+
><details><br>
|
|
3060
3094
|
><summary>Schema</summary>
|
|
3061
3095
|
>
|
|
3062
3096
|
>
|
|
@@ -3083,7 +3117,7 @@ Example return:
|
|
|
3083
3117
|
>**attributeSetIdentifier:** string <br>
|
|
3084
3118
|
>*text identifier (marker) of the used attribute set* <br>
|
|
3085
3119
|
>example: test-form <br>
|
|
3086
|
-
>
|
|
3120
|
+
><br>
|
|
3087
3121
|
></details>
|
|
3088
3122
|
|
|
3089
3123
|
---
|
|
@@ -3113,7 +3147,7 @@ Example return:
|
|
|
3113
3147
|
]
|
|
3114
3148
|
```
|
|
3115
3149
|
|
|
3116
|
-
><details>
|
|
3150
|
+
><details><br>
|
|
3117
3151
|
><summary>Schema</summary>
|
|
3118
3152
|
>
|
|
3119
3153
|
>**id:** number <br>
|
|
@@ -3125,7 +3159,7 @@ Example return:
|
|
|
3125
3159
|
>example: forNewsPage <br>
|
|
3126
3160
|
>Enum:
|
|
3127
3161
|
>[ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ] <br>
|
|
3128
|
-
>
|
|
3162
|
+
><br>
|
|
3129
3163
|
></details>
|
|
3130
3164
|
|
|
3131
3165
|
---
|
|
@@ -3142,7 +3176,7 @@ const { IntegrationCollections } = defineOneEntry('your-url');
|
|
|
3142
3176
|
const result = await IntegrationCollections.getICollections();
|
|
3143
3177
|
```
|
|
3144
3178
|
|
|
3145
|
-
><details>
|
|
3179
|
+
><details><br>
|
|
3146
3180
|
><summary>Schema</summary>
|
|
3147
3181
|
>
|
|
3148
3182
|
>**langCode:** string <br>
|
|
@@ -3159,7 +3193,7 @@ const result = await IntegrationCollections.getICollections();
|
|
|
3159
3193
|
>**userQuery.offset:** number <br>
|
|
3160
3194
|
>*Optional parameter for pagination, default is 30* <br>
|
|
3161
3195
|
>example: 30 <br>
|
|
3162
|
-
>
|
|
3196
|
+
><br>
|
|
3163
3197
|
></details>
|
|
3164
3198
|
|
|
3165
3199
|
Get all collections.
|
|
@@ -3183,7 +3217,7 @@ Example return:
|
|
|
3183
3217
|
]
|
|
3184
3218
|
```
|
|
3185
3219
|
|
|
3186
|
-
><details>
|
|
3220
|
+
><details><br>
|
|
3187
3221
|
><summary>Schema</summary>
|
|
3188
3222
|
>
|
|
3189
3223
|
>**id:** number <br>
|
|
@@ -3212,7 +3246,7 @@ Example return:
|
|
|
3212
3246
|
>*Text identifiers of form object attributes for display in the data table* <br>
|
|
3213
3247
|
>example: marker1, marker2 <br>
|
|
3214
3248
|
>default: <br>
|
|
3215
|
-
>
|
|
3249
|
+
><br>
|
|
3216
3250
|
></details>
|
|
3217
3251
|
|
|
3218
3252
|
### IntegrationCollections.getICollectionById(id, langCode)
|
|
@@ -3221,7 +3255,7 @@ Example return:
|
|
|
3221
3255
|
const result = await IntegrationCollections.getICollectionById(1);
|
|
3222
3256
|
```
|
|
3223
3257
|
|
|
3224
|
-
><details>
|
|
3258
|
+
><details><br>
|
|
3225
3259
|
><summary>Schema</summary>
|
|
3226
3260
|
>
|
|
3227
3261
|
>**id*:** number <br>
|
|
@@ -3231,7 +3265,7 @@ const result = await IntegrationCollections.getICollectionById(1);
|
|
|
3231
3265
|
>**langCode:** string <br>
|
|
3232
3266
|
>*Language code* <br>
|
|
3233
3267
|
>example: en_US <br>
|
|
3234
|
-
>
|
|
3268
|
+
><br>
|
|
3235
3269
|
></details>
|
|
3236
3270
|
|
|
3237
3271
|
Get collection by id.
|
|
@@ -3253,7 +3287,7 @@ Example return:
|
|
|
3253
3287
|
}
|
|
3254
3288
|
```
|
|
3255
3289
|
|
|
3256
|
-
><details>
|
|
3290
|
+
><details><br>
|
|
3257
3291
|
><summary>Schema</summary>
|
|
3258
3292
|
>
|
|
3259
3293
|
>**id:** number <br>
|
|
@@ -3282,7 +3316,7 @@ Example return:
|
|
|
3282
3316
|
>**selectedAttributeMarkers:** string <br>
|
|
3283
3317
|
>*Text identifiers of form object attributes for display in the data table* <br>
|
|
3284
3318
|
>example: marker1, marker2 <br>
|
|
3285
|
-
>
|
|
3319
|
+
><br>
|
|
3286
3320
|
></details>
|
|
3287
3321
|
|
|
3288
3322
|
### IntegrationCollections.getICollectionRowsById(id, langCode, userQuery)
|
|
@@ -3291,7 +3325,7 @@ Example return:
|
|
|
3291
3325
|
const result = await IntegrationCollections.getICollectionRowsById(1);
|
|
3292
3326
|
```
|
|
3293
3327
|
|
|
3294
|
-
><details>
|
|
3328
|
+
><details><br>
|
|
3295
3329
|
><summary>Schema</summary>
|
|
3296
3330
|
>
|
|
3297
3331
|
>**id*:** number <br>
|
|
@@ -3312,7 +3346,7 @@ const result = await IntegrationCollections.getICollectionRowsById(1);
|
|
|
3312
3346
|
>**userQuery.limit:** number <br>
|
|
3313
3347
|
>*Optional parameter for pagination, default is 30* <br>
|
|
3314
3348
|
>example: 30 <br>
|
|
3315
|
-
>
|
|
3349
|
+
><br>
|
|
3316
3350
|
></details>
|
|
3317
3351
|
|
|
3318
3352
|
Get all records belonging to the collection by collection id.
|
|
@@ -3339,7 +3373,7 @@ Example return:
|
|
|
3339
3373
|
}
|
|
3340
3374
|
```
|
|
3341
3375
|
|
|
3342
|
-
><details>
|
|
3376
|
+
><details><br>
|
|
3343
3377
|
><summary>Schema</summary>
|
|
3344
3378
|
>
|
|
3345
3379
|
>**total:** number <br>
|
|
@@ -3375,7 +3409,7 @@ Example return:
|
|
|
3375
3409
|
>**selectedAttributeMarkers:** string <br>
|
|
3376
3410
|
>*Text identifiers of form object attributes for display in the data table* <br>
|
|
3377
3411
|
>example: marker1, marker2 <br>
|
|
3378
|
-
>
|
|
3412
|
+
><br>
|
|
3379
3413
|
></details>
|
|
3380
3414
|
|
|
3381
3415
|
### IntegrationCollections.validateICollectionMarker(marker)
|
|
@@ -3384,13 +3418,13 @@ Example return:
|
|
|
3384
3418
|
const result = await IntegrationCollections.validateICollectionMarker('test_collection');
|
|
3385
3419
|
```
|
|
3386
3420
|
|
|
3387
|
-
><details>
|
|
3421
|
+
><details><br>
|
|
3388
3422
|
><summary>Schema</summary>
|
|
3389
3423
|
>
|
|
3390
3424
|
>**marker*:** string <br>
|
|
3391
3425
|
>*Collection marker* <br>
|
|
3392
3426
|
>example: test_collection <br>
|
|
3393
|
-
>
|
|
3427
|
+
><br>
|
|
3394
3428
|
></details>
|
|
3395
3429
|
|
|
3396
3430
|
Check for the existence of a text identifier (marker)
|
|
@@ -3403,13 +3437,13 @@ Example return:
|
|
|
3403
3437
|
}
|
|
3404
3438
|
```
|
|
3405
3439
|
|
|
3406
|
-
><details>
|
|
3440
|
+
><details><br>
|
|
3407
3441
|
><summary>Schema</summary>
|
|
3408
3442
|
>
|
|
3409
3443
|
>**valid:** boolean <br>
|
|
3410
3444
|
>*Valid marker* <br>
|
|
3411
3445
|
>example: <br>
|
|
3412
|
-
>
|
|
3446
|
+
><br>
|
|
3413
3447
|
></details>
|
|
3414
3448
|
|
|
3415
3449
|
### IntegrationCollections.getICollectionRowByMarkerAndId(marker, id, langCode)
|
|
@@ -3418,7 +3452,7 @@ Example return:
|
|
|
3418
3452
|
const result = await IntegrationCollections.getICollectionRowByMarkerAndId('test_collection', 1);
|
|
3419
3453
|
```
|
|
3420
3454
|
|
|
3421
|
-
><details>
|
|
3455
|
+
><details><br>
|
|
3422
3456
|
><summary>Schema</summary>
|
|
3423
3457
|
>
|
|
3424
3458
|
>**marker*:** string <br>
|
|
@@ -3432,7 +3466,7 @@ const result = await IntegrationCollections.getICollectionRowByMarkerAndId('test
|
|
|
3432
3466
|
>**langCode:** string <br>
|
|
3433
3467
|
>*Language code* <br>
|
|
3434
3468
|
>example: en_US <br>
|
|
3435
|
-
>
|
|
3469
|
+
><br>
|
|
3436
3470
|
></details>
|
|
3437
3471
|
|
|
3438
3472
|
Getting one record from the collection.
|
|
@@ -3458,7 +3492,7 @@ Example return:
|
|
|
3458
3492
|
}
|
|
3459
3493
|
```
|
|
3460
3494
|
|
|
3461
|
-
><details>
|
|
3495
|
+
><details><br>
|
|
3462
3496
|
><summary>Schema</summary>
|
|
3463
3497
|
>
|
|
3464
3498
|
>**id:** number <br>
|
|
@@ -3482,7 +3516,7 @@ Example return:
|
|
|
3482
3516
|
>**formData:** FormDataLangType <br>
|
|
3483
3517
|
>*Data submitted by the form attached to the collection* <br>
|
|
3484
3518
|
>example: OrderedMap { "en_US": List [ OrderedMap { "marker": "naimenovanie_1", "type": "string", "value": "Title" } ] } <br>
|
|
3485
|
-
>
|
|
3519
|
+
><br>
|
|
3486
3520
|
></details>
|
|
3487
3521
|
|
|
3488
3522
|
### IntegrationCollections.createICollectionRow(marker, body, langCode)
|
|
@@ -3503,7 +3537,7 @@ const body = {
|
|
|
3503
3537
|
const result = await IntegrationCollections.createICollectionRow('test_collection', body);
|
|
3504
3538
|
```
|
|
3505
3539
|
|
|
3506
|
-
><details>
|
|
3540
|
+
><details><br>
|
|
3507
3541
|
><summary>Schema</summary>
|
|
3508
3542
|
>
|
|
3509
3543
|
>**marker*:** string <br>
|
|
@@ -3517,9 +3551,9 @@ const result = await IntegrationCollections.createICollectionRow('test_collectio
|
|
|
3517
3551
|
"formData": {
|
|
3518
3552
|
"en_US": [
|
|
3519
3553
|
{
|
|
3520
|
-
"marker": "
|
|
3554
|
+
"marker": "collection_marker",
|
|
3521
3555
|
"type": "string",
|
|
3522
|
-
"value": "
|
|
3556
|
+
"value": "Collection marker"
|
|
3523
3557
|
}
|
|
3524
3558
|
]
|
|
3525
3559
|
}
|
|
@@ -3528,7 +3562,7 @@ const result = await IntegrationCollections.createICollectionRow('test_collectio
|
|
|
3528
3562
|
>**langCode:** string <br>
|
|
3529
3563
|
>*Language code* <br>
|
|
3530
3564
|
>example: en_US <br>
|
|
3531
|
-
>
|
|
3565
|
+
><br>
|
|
3532
3566
|
></details>
|
|
3533
3567
|
|
|
3534
3568
|
Create a record in the collection
|
|
@@ -3550,7 +3584,7 @@ Example return:
|
|
|
3550
3584
|
}
|
|
3551
3585
|
```
|
|
3552
3586
|
|
|
3553
|
-
><details>
|
|
3587
|
+
><details><br>
|
|
3554
3588
|
><summary>Schema</summary>
|
|
3555
3589
|
>
|
|
3556
3590
|
>**formIdentifier:** string <br>
|
|
@@ -3560,7 +3594,7 @@ Example return:
|
|
|
3560
3594
|
>**formData:** FormDataLangType <br>
|
|
3561
3595
|
>*Data submitted by the form attached to the collection* <br>
|
|
3562
3596
|
>example: OrderedMap { "en_US": List [ OrderedMap { "marker": "naimenovanie_1", "type": "string", "value": "Name" } ] } <br>
|
|
3563
|
-
>
|
|
3597
|
+
><br>
|
|
3564
3598
|
></details>
|
|
3565
3599
|
|
|
3566
3600
|
### IntegrationCollections.updateICollectionRow(marker, body, langCode)
|
|
@@ -3571,9 +3605,9 @@ const body = {
|
|
|
3571
3605
|
"formData": {
|
|
3572
3606
|
"en_US": [
|
|
3573
3607
|
{
|
|
3574
|
-
"marker": "
|
|
3608
|
+
"marker": "collection_marker",
|
|
3575
3609
|
"type": "string",
|
|
3576
|
-
"value": "
|
|
3610
|
+
"value": "Collection marker"
|
|
3577
3611
|
}
|
|
3578
3612
|
]
|
|
3579
3613
|
}
|
|
@@ -3581,7 +3615,7 @@ const body = {
|
|
|
3581
3615
|
const result = await IntegrationCollections.updateICollectionRow('test_collection', body);
|
|
3582
3616
|
```
|
|
3583
3617
|
|
|
3584
|
-
><details>
|
|
3618
|
+
><details><br>
|
|
3585
3619
|
><summary>Schema</summary>
|
|
3586
3620
|
>
|
|
3587
3621
|
>**marker:** string <br>
|
|
@@ -3599,9 +3633,9 @@ const result = await IntegrationCollections.updateICollectionRow('test_collectio
|
|
|
3599
3633
|
"formData": {
|
|
3600
3634
|
"en_US": [
|
|
3601
3635
|
{
|
|
3602
|
-
"marker": "
|
|
3636
|
+
"marker": "collection_marker",
|
|
3603
3637
|
"type": "string",
|
|
3604
|
-
"value": "
|
|
3638
|
+
"value": "Collection marker"
|
|
3605
3639
|
}
|
|
3606
3640
|
]
|
|
3607
3641
|
}
|
|
@@ -3609,8 +3643,8 @@ const result = await IntegrationCollections.updateICollectionRow('test_collectio
|
|
|
3609
3643
|
>
|
|
3610
3644
|
>**langCode:** string <br>
|
|
3611
3645
|
>*language code* <br>
|
|
3612
|
-
>example:
|
|
3613
|
-
>
|
|
3646
|
+
>example: en_US <br>
|
|
3647
|
+
><br>
|
|
3614
3648
|
></details>
|
|
3615
3649
|
|
|
3616
3650
|
Edit a record in the collection
|
|
@@ -3632,7 +3666,7 @@ Example return:
|
|
|
3632
3666
|
}
|
|
3633
3667
|
```
|
|
3634
3668
|
|
|
3635
|
-
><details>
|
|
3669
|
+
><details><br>
|
|
3636
3670
|
><summary>Schema</summary>
|
|
3637
3671
|
>
|
|
3638
3672
|
>**formIdentifier:** string <br>
|
|
@@ -3642,7 +3676,7 @@ Example return:
|
|
|
3642
3676
|
>**formData:** FormDataLangType <br>
|
|
3643
3677
|
>*Data submitted by the form attached to the collection* <br>
|
|
3644
3678
|
>example: OrderedMap { "en_US": List [ OrderedMap { "marker": "naimenovanie_1", "type": "string", "value": "Name" } ] } <br>
|
|
3645
|
-
>
|
|
3679
|
+
><br>
|
|
3646
3680
|
></details>
|
|
3647
3681
|
|
|
3648
3682
|
### IntegrationCollections.deleteICollectionRowByMarker(id, marker)
|
|
@@ -3651,7 +3685,7 @@ Example return:
|
|
|
3651
3685
|
const result = await IntegrationCollections.deleteICollectionRowByMarkerAndId('test_collection', 1);
|
|
3652
3686
|
```
|
|
3653
3687
|
|
|
3654
|
-
><details>
|
|
3688
|
+
><details><br>
|
|
3655
3689
|
><summary>Schema</summary>
|
|
3656
3690
|
>
|
|
3657
3691
|
>**marker*:** string <br>
|
|
@@ -3661,7 +3695,7 @@ const result = await IntegrationCollections.deleteICollectionRowByMarkerAndId('t
|
|
|
3661
3695
|
>**id:** number <br>
|
|
3662
3696
|
>*record identifier in the collection* <br>
|
|
3663
3697
|
>example: 12 <br>
|
|
3664
|
-
>
|
|
3698
|
+
><br>
|
|
3665
3699
|
></details>
|
|
3666
3700
|
|
|
3667
3701
|
Deletion of collection record object
|
|
@@ -3701,8 +3735,8 @@ Example return:
|
|
|
3701
3735
|
]
|
|
3702
3736
|
```
|
|
3703
3737
|
|
|
3704
|
-
><details>
|
|
3705
|
-
><summary
|
|
3738
|
+
><details><br>
|
|
3739
|
+
><summary>Schema</summary>
|
|
3706
3740
|
>
|
|
3707
3741
|
>**id:** number <br>
|
|
3708
3742
|
>*object identifier* <br>
|
|
@@ -3735,7 +3769,7 @@ Example return:
|
|
|
3735
3769
|
>**position:** {
|
|
3736
3770
|
>description:position number
|
|
3737
3771
|
>} <br>
|
|
3738
|
-
>
|
|
3772
|
+
><br>
|
|
3739
3773
|
></details>
|
|
3740
3774
|
|
|
3741
3775
|
---
|
|
@@ -3752,7 +3786,7 @@ const { Menus } = defineOneEntry('your-url')
|
|
|
3752
3786
|
const value = await Menus.getMenusByMarker('my-marker')
|
|
3753
3787
|
```
|
|
3754
3788
|
|
|
3755
|
-
><details>
|
|
3789
|
+
><details><br>
|
|
3756
3790
|
><summary>Schema</summary>
|
|
3757
3791
|
>
|
|
3758
3792
|
>**marker*:** string <br>
|
|
@@ -3762,7 +3796,7 @@ const value = await Menus.getMenusByMarker('my-marker')
|
|
|
3762
3796
|
>**langCode:** string <br>
|
|
3763
3797
|
>*Language code* <br>
|
|
3764
3798
|
>example: en_US <br>
|
|
3765
|
-
>
|
|
3799
|
+
><br>
|
|
3766
3800
|
></details>
|
|
3767
3801
|
|
|
3768
3802
|
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.
|
|
@@ -3792,7 +3826,7 @@ Example return:
|
|
|
3792
3826
|
}
|
|
3793
3827
|
```
|
|
3794
3828
|
|
|
3795
|
-
><details>
|
|
3829
|
+
><details><br>
|
|
3796
3830
|
><summary>Schema</summary>
|
|
3797
3831
|
>
|
|
3798
3832
|
>**id:** number <br>
|
|
@@ -3810,7 +3844,7 @@ Example return:
|
|
|
3810
3844
|
>**pages:** <br>
|
|
3811
3845
|
>*data of the pages included in the menu* <br>
|
|
3812
3846
|
>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 } ] <br>
|
|
3813
|
-
>
|
|
3847
|
+
><br>
|
|
3814
3848
|
></details>
|
|
3815
3849
|
|
|
3816
3850
|
---
|
|
@@ -3827,7 +3861,7 @@ const { Orders } = defineOneEntry('your-url');
|
|
|
3827
3861
|
const value = await Orders.getAllOrdersStorage()
|
|
3828
3862
|
```
|
|
3829
3863
|
|
|
3830
|
-
><details>
|
|
3864
|
+
><details><br>
|
|
3831
3865
|
><summary>Schema</summary>
|
|
3832
3866
|
>
|
|
3833
3867
|
>**langCode:** number <br>
|
|
@@ -3841,7 +3875,7 @@ const value = await Orders.getAllOrdersStorage()
|
|
|
3841
3875
|
>**limit:** number <br>
|
|
3842
3876
|
>*Optional parameter for pagination, default is 30* <br>
|
|
3843
3877
|
>example: 30 <br>
|
|
3844
|
-
>
|
|
3878
|
+
><br>
|
|
3845
3879
|
></details>
|
|
3846
3880
|
|
|
3847
3881
|
This method getting all the order storage objects. The method will add the default language to the request body. If you want to change the language, just pass it with the second argument
|
|
@@ -3867,8 +3901,8 @@ Example return:
|
|
|
3867
3901
|
]
|
|
3868
3902
|
```
|
|
3869
3903
|
|
|
3870
|
-
><details>
|
|
3871
|
-
><summary
|
|
3904
|
+
><details><br>
|
|
3905
|
+
><summary>Schema</summary>
|
|
3872
3906
|
>
|
|
3873
3907
|
>**id:** number <br>
|
|
3874
3908
|
>*object identifier* <br>
|
|
@@ -3893,7 +3927,7 @@ Example return:
|
|
|
3893
3927
|
>**paymentAccountIdentifiers** Array<{identifier:string} <br>
|
|
3894
3928
|
>*array of textual identifiers of payment accounts used by the order storage* <br>
|
|
3895
3929
|
>example: [{ "identifier": "p1" }] <br>
|
|
3896
|
-
>
|
|
3930
|
+
><br>
|
|
3897
3931
|
></details>
|
|
3898
3932
|
|
|
3899
3933
|
---
|
|
@@ -3904,7 +3938,7 @@ Example return:
|
|
|
3904
3938
|
const value = await Orders.getAllOrdersByMarker('my-order')
|
|
3905
3939
|
```
|
|
3906
3940
|
|
|
3907
|
-
><details>
|
|
3941
|
+
><details><br>
|
|
3908
3942
|
><summary>Schema</summary>
|
|
3909
3943
|
>
|
|
3910
3944
|
>**marker*:** string <br>
|
|
@@ -3922,7 +3956,7 @@ const value = await Orders.getAllOrdersByMarker('my-order')
|
|
|
3922
3956
|
>**limit:** number <br>
|
|
3923
3957
|
>*Limit parameter. Default 30* <br>
|
|
3924
3958
|
>example: 30 <br>
|
|
3925
|
-
>
|
|
3959
|
+
><br>
|
|
3926
3960
|
></details>
|
|
3927
3961
|
|
|
3928
3962
|
This method getting all order storage object by marker. The method will add the default language to the request body. If you want to change the language, just pass it with the second argument
|
|
@@ -3974,8 +4008,8 @@ Example return:
|
|
|
3974
4008
|
}
|
|
3975
4009
|
```
|
|
3976
4010
|
|
|
3977
|
-
><details>
|
|
3978
|
-
><summary
|
|
4011
|
+
><details><br>
|
|
4012
|
+
><summary>Schema</summary>
|
|
3979
4013
|
>
|
|
3980
4014
|
>**total:** number <br>
|
|
3981
4015
|
>*total number of found records* <br>
|
|
@@ -3989,7 +4023,6 @@ Example return:
|
|
|
3989
4023
|
>*text identifier of the form status* <br>
|
|
3990
4024
|
>example: order-form <br>
|
|
3991
4025
|
>
|
|
3992
|
-
>
|
|
3993
4026
|
>**formData** FormDataType <br>
|
|
3994
4027
|
>*data submitted by the form linked to the order store* <br>
|
|
3995
4028
|
>example: [{ "marker": "name_1", "value": "Name" } ] <br>
|
|
@@ -4024,7 +4057,7 @@ Example return:
|
|
|
4024
4057
|
>**isHistory** boolean <br>
|
|
4025
4058
|
>*indicates that the order has been saved in the order history* <br>
|
|
4026
4059
|
>example: true <br>
|
|
4027
|
-
>
|
|
4060
|
+
><br>
|
|
4028
4061
|
></details>
|
|
4029
4062
|
|
|
4030
4063
|
### Orders.getOrderByMarker(marker, langCode)
|
|
@@ -4033,7 +4066,7 @@ Example return:
|
|
|
4033
4066
|
const value = await Orders.getOrderByMarker('my-order')
|
|
4034
4067
|
```
|
|
4035
4068
|
|
|
4036
|
-
><details>
|
|
4069
|
+
><details><br>
|
|
4037
4070
|
><summary>Schema</summary>
|
|
4038
4071
|
>
|
|
4039
4072
|
>**marker*:** string <br>
|
|
@@ -4043,7 +4076,7 @@ const value = await Orders.getOrderByMarker('my-order')
|
|
|
4043
4076
|
>**langCode:** string <br>
|
|
4044
4077
|
>*Optional language field* <br>
|
|
4045
4078
|
>example: en_US <br>
|
|
4046
|
-
>
|
|
4079
|
+
><br>
|
|
4047
4080
|
></details>
|
|
4048
4081
|
|
|
4049
4082
|
This method retrieves one order storage object by marker.
|
|
@@ -4068,7 +4101,7 @@ Example return:
|
|
|
4068
4101
|
}
|
|
4069
4102
|
```
|
|
4070
4103
|
|
|
4071
|
-
><details>
|
|
4104
|
+
><details><br>
|
|
4072
4105
|
><summary>Schema</summary>
|
|
4073
4106
|
>
|
|
4074
4107
|
>**id:** number <br>
|
|
@@ -4094,7 +4127,7 @@ Example return:
|
|
|
4094
4127
|
>**paymentAccountIdentifiers** Array<{identifier:string} <br>
|
|
4095
4128
|
>*array of textual identifiers of payment accounts used by the order storage* <br>
|
|
4096
4129
|
>example: [{ "identifier": "p1" }] <br>
|
|
4097
|
-
>
|
|
4130
|
+
><br>
|
|
4098
4131
|
></details>
|
|
4099
4132
|
|
|
4100
4133
|
### Orders.getOrderByMarkerAndId(marker, id, langCode)
|
|
@@ -4103,7 +4136,7 @@ Example return:
|
|
|
4103
4136
|
const value = await Orders.getOrderByMarkerAndId('my-order', 1764)
|
|
4104
4137
|
```
|
|
4105
4138
|
|
|
4106
|
-
><details>
|
|
4139
|
+
><details><br>
|
|
4107
4140
|
><summary>Schema</summary>
|
|
4108
4141
|
>
|
|
4109
4142
|
>**marker*:** string <br>
|
|
@@ -4117,7 +4150,7 @@ const value = await Orders.getOrderByMarkerAndId('my-order', 1764)
|
|
|
4117
4150
|
>**langCode:** string <br>
|
|
4118
4151
|
>*Optional language field* <br>
|
|
4119
4152
|
>example: en_US <br>
|
|
4120
|
-
>
|
|
4153
|
+
><br>
|
|
4121
4154
|
></details>
|
|
4122
4155
|
|
|
4123
4156
|
This method retrieves one order storage object by marker and id.
|
|
@@ -4166,7 +4199,7 @@ Example return:
|
|
|
4166
4199
|
}
|
|
4167
4200
|
```
|
|
4168
4201
|
|
|
4169
|
-
><details>
|
|
4202
|
+
><details><br>
|
|
4170
4203
|
><summary>Schema</summary>
|
|
4171
4204
|
>
|
|
4172
4205
|
>**id:** number <br>
|
|
@@ -4191,8 +4224,8 @@ Example return:
|
|
|
4191
4224
|
>
|
|
4192
4225
|
>**paymentAccountIdentifiers** Array<{identifier:string} <br>
|
|
4193
4226
|
>*array of textual identifiers of payment accounts used by the order storage* <br>
|
|
4194
|
-
>example:
|
|
4195
|
-
>
|
|
4227
|
+
>example: [{ "identifier": "p1" }] <br>
|
|
4228
|
+
><br>
|
|
4196
4229
|
></details>
|
|
4197
4230
|
|
|
4198
4231
|
### Orders.createOrder(marker, body, langCode)
|
|
@@ -4217,7 +4250,7 @@ Example return:
|
|
|
4217
4250
|
const value = await Orders.createOrder('my-order', body)
|
|
4218
4251
|
```
|
|
4219
4252
|
|
|
4220
|
-
><details>
|
|
4253
|
+
><details><br>
|
|
4221
4254
|
><summary>Schema</summary>
|
|
4222
4255
|
>
|
|
4223
4256
|
>**marker*:** string <br>
|
|
@@ -4231,12 +4264,12 @@ const value = await Orders.createOrder('my-order', body)
|
|
|
4231
4264
|
>**langCode:** String <br>
|
|
4232
4265
|
>*Optional language field* <br>
|
|
4233
4266
|
>example: en_US <br>
|
|
4234
|
-
>
|
|
4267
|
+
><br>
|
|
4235
4268
|
></details>
|
|
4236
4269
|
|
|
4237
4270
|
<br>
|
|
4238
4271
|
|
|
4239
|
-
><details>
|
|
4272
|
+
><details><br>
|
|
4240
4273
|
><summary>Schema (body)</summary>
|
|
4241
4274
|
>
|
|
4242
4275
|
>**formIdentifier:** string <br>
|
|
@@ -4265,7 +4298,7 @@ const value = await Orders.createOrder('my-order', body)
|
|
|
4265
4298
|
>**quantity:** number <br>
|
|
4266
4299
|
>*quantity of the product* <br>
|
|
4267
4300
|
>example: 1 <br>
|
|
4268
|
-
>
|
|
4301
|
+
><br>
|
|
4269
4302
|
></details>
|
|
4270
4303
|
|
|
4271
4304
|
This method retrieves one order storage object by marker. The method will add the default language to the request body. If you want to change the language, just pass it with the second argument
|
|
@@ -4300,7 +4333,7 @@ Example return:
|
|
|
4300
4333
|
}
|
|
4301
4334
|
```
|
|
4302
4335
|
|
|
4303
|
-
><details>
|
|
4336
|
+
><details><br>
|
|
4304
4337
|
><summary>Schema</summary>
|
|
4305
4338
|
>
|
|
4306
4339
|
>**statusIdentifier:** string <br>
|
|
@@ -4333,7 +4366,7 @@ Example return:
|
|
|
4333
4366
|
>**createdDate** string <br>
|
|
4334
4367
|
>*date when the order was created* <br>
|
|
4335
4368
|
>example: 2023-01-01 12:12 <br>
|
|
4336
|
-
>
|
|
4369
|
+
><br>
|
|
4337
4370
|
></details>
|
|
4338
4371
|
|
|
4339
4372
|
### Orders.updateOrderByMarkerAndId(marker, body, langCode)
|
|
@@ -4358,7 +4391,7 @@ const body = {
|
|
|
4358
4391
|
const value = await Orders.updateOrderByMarkerAndId('my-order', 1, body)
|
|
4359
4392
|
```
|
|
4360
4393
|
|
|
4361
|
-
><details>
|
|
4394
|
+
><details><br>
|
|
4362
4395
|
><summary>Schema</summary>
|
|
4363
4396
|
>
|
|
4364
4397
|
>**marker*:** string <br>
|
|
@@ -4376,12 +4409,12 @@ const value = await Orders.updateOrderByMarkerAndId('my-order', 1, body)
|
|
|
4376
4409
|
>**langCode:** string <br>
|
|
4377
4410
|
>*Optional language field* <br>
|
|
4378
4411
|
>example: en_US <br>
|
|
4379
|
-
>
|
|
4412
|
+
><br>
|
|
4380
4413
|
></details>
|
|
4381
4414
|
|
|
4382
4415
|
<br>
|
|
4383
4416
|
|
|
4384
|
-
><details>
|
|
4417
|
+
><details><br>
|
|
4385
4418
|
><summary>Schema (body)</summary>
|
|
4386
4419
|
>
|
|
4387
4420
|
>**formIdentifier:** string <br>
|
|
@@ -4410,7 +4443,7 @@ const value = await Orders.updateOrderByMarkerAndId('my-order', 1, body)
|
|
|
4410
4443
|
>**quantity** number <br>
|
|
4411
4444
|
>*quantity of the product* <br>
|
|
4412
4445
|
>example: 1<br>
|
|
4413
|
-
>
|
|
4446
|
+
><br>
|
|
4414
4447
|
></details>
|
|
4415
4448
|
|
|
4416
4449
|
This method update one order storage object by marker. The method will add the default language to the request body. If you want to change the language, just pass it with the second argument
|
|
@@ -4445,8 +4478,8 @@ Example return:
|
|
|
4445
4478
|
}
|
|
4446
4479
|
```
|
|
4447
4480
|
|
|
4448
|
-
><details>
|
|
4449
|
-
><summary
|
|
4481
|
+
><details><br>
|
|
4482
|
+
><summary>Schema</summary>
|
|
4450
4483
|
>
|
|
4451
4484
|
>**statusIdentifier:** string <br>
|
|
4452
4485
|
>*text identifier of the order status* <br>
|
|
@@ -4478,7 +4511,7 @@ Example return:
|
|
|
4478
4511
|
>**createdDate** string <br>
|
|
4479
4512
|
>*date when the order was created* <br>
|
|
4480
4513
|
>example: 2023-01-01 12:12 <br>
|
|
4481
|
-
>
|
|
4514
|
+
><br>
|
|
4482
4515
|
></details>
|
|
4483
4516
|
|
|
4484
4517
|
---
|
|
@@ -4495,13 +4528,13 @@ const { Pages } = defineOneEntry('your-url');
|
|
|
4495
4528
|
const value = await Pages.getRootPages()
|
|
4496
4529
|
```
|
|
4497
4530
|
|
|
4498
|
-
><details>
|
|
4531
|
+
><details><br>
|
|
4499
4532
|
><summary>Schema</summary>
|
|
4500
4533
|
>
|
|
4501
4534
|
>**langCode:** string <br>
|
|
4502
4535
|
>*lang code* <br>
|
|
4503
4536
|
>example: en_US <br>
|
|
4504
|
-
>
|
|
4537
|
+
><br>
|
|
4505
4538
|
></details>
|
|
4506
4539
|
|
|
4507
4540
|
This method retrieves all top-level page objects 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.
|
|
@@ -4541,8 +4574,8 @@ Example return:
|
|
|
4541
4574
|
]
|
|
4542
4575
|
```
|
|
4543
4576
|
|
|
4544
|
-
><details>
|
|
4545
|
-
><summary
|
|
4577
|
+
><details><br>
|
|
4578
|
+
><summary>Schema</summary>
|
|
4546
4579
|
>
|
|
4547
4580
|
>**id:** number <br>
|
|
4548
4581
|
>*object identifier* <br>
|
|
@@ -4582,11 +4615,9 @@ Example return:
|
|
|
4582
4615
|
>**forms** <br>
|
|
4583
4616
|
>*Array of FormEntity object identifier values linked to the page (optional)* <br>
|
|
4584
4617
|
>
|
|
4585
|
-
>
|
|
4586
4618
|
>**blocks** <br>
|
|
4587
4619
|
>*Array of BlockEntity object identifier values linked to the page (optional)* <br>
|
|
4588
4620
|
>
|
|
4589
|
-
>
|
|
4590
4621
|
>**isSync:** boolean <br>
|
|
4591
4622
|
>*indicator of page indexing (true or false)* <br>
|
|
4592
4623
|
>example: false <br>
|
|
@@ -4609,11 +4640,10 @@ Example return:
|
|
|
4609
4640
|
>Enum:
|
|
4610
4641
|
>[ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ] <br>
|
|
4611
4642
|
>
|
|
4612
|
-
>
|
|
4613
4643
|
>**childrenCount:** number <br>
|
|
4614
4644
|
>*number of nested pages* <br>
|
|
4615
4645
|
>example: 0 <br>
|
|
4616
|
-
>
|
|
4646
|
+
><br>
|
|
4617
4647
|
></details>
|
|
4618
4648
|
|
|
4619
4649
|
### Pages.getPages(langCode)
|
|
@@ -4622,13 +4652,13 @@ Example return:
|
|
|
4622
4652
|
const value = await Pages.getPages();
|
|
4623
4653
|
```
|
|
4624
4654
|
|
|
4625
|
-
><details>
|
|
4655
|
+
><details><br>
|
|
4626
4656
|
><summary>Schema</summary>
|
|
4627
4657
|
>
|
|
4628
4658
|
>**langCode:** string <br>
|
|
4629
4659
|
>*lang code* <br>
|
|
4630
4660
|
>example: en_US <br>
|
|
4631
|
-
>
|
|
4661
|
+
><br>
|
|
4632
4662
|
></details>
|
|
4633
4663
|
|
|
4634
4664
|
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.
|
|
@@ -4668,7 +4698,7 @@ Example return:
|
|
|
4668
4698
|
]
|
|
4669
4699
|
```
|
|
4670
4700
|
|
|
4671
|
-
><details>
|
|
4701
|
+
><details><br>
|
|
4672
4702
|
><summary>Schema</summary>
|
|
4673
4703
|
>
|
|
4674
4704
|
>**id:** number <br>
|
|
@@ -4736,11 +4766,10 @@ Example return:
|
|
|
4736
4766
|
>Enum:
|
|
4737
4767
|
>[ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ] <br>
|
|
4738
4768
|
>
|
|
4739
|
-
>
|
|
4740
4769
|
>**childrenCount:** number <br>
|
|
4741
4770
|
>*number of nested pages* <br>
|
|
4742
4771
|
>example: 0 <br>
|
|
4743
|
-
>
|
|
4772
|
+
><br>
|
|
4744
4773
|
></details>
|
|
4745
4774
|
|
|
4746
4775
|
### Pages.getPageById(id, langCode)
|
|
@@ -4749,7 +4778,7 @@ Example return:
|
|
|
4749
4778
|
const value = await Pages.getPageById(1);
|
|
4750
4779
|
```
|
|
4751
4780
|
|
|
4752
|
-
><details>
|
|
4781
|
+
><details><br>
|
|
4753
4782
|
><summary>Schema</summary>
|
|
4754
4783
|
>
|
|
4755
4784
|
>**id*:** <br>
|
|
@@ -4759,7 +4788,7 @@ const value = await Pages.getPageById(1);
|
|
|
4759
4788
|
>**langCode:** <br>
|
|
4760
4789
|
>*lang code* <br>
|
|
4761
4790
|
>example: en_US <br>
|
|
4762
|
-
>
|
|
4791
|
+
><br>
|
|
4763
4792
|
></details>
|
|
4764
4793
|
|
|
4765
4794
|
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.
|
|
@@ -4863,7 +4892,7 @@ Example return:
|
|
|
4863
4892
|
const value = await Pages.getPageByUrl('shop');
|
|
4864
4893
|
```
|
|
4865
4894
|
|
|
4866
|
-
><details>
|
|
4895
|
+
><details><br>
|
|
4867
4896
|
><summary>Schema</summary>
|
|
4868
4897
|
>
|
|
4869
4898
|
>**url*:** string <br>
|
|
@@ -4873,7 +4902,7 @@ const value = await Pages.getPageByUrl('shop');
|
|
|
4873
4902
|
>**langCode:** string <br>
|
|
4874
4903
|
>*lang code* <br>
|
|
4875
4904
|
>example: en_US <br>
|
|
4876
|
-
>
|
|
4905
|
+
><br>
|
|
4877
4906
|
></details>
|
|
4878
4907
|
|
|
4879
4908
|
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.
|
|
@@ -4902,7 +4931,7 @@ Example return:
|
|
|
4902
4931
|
}
|
|
4903
4932
|
```
|
|
4904
4933
|
|
|
4905
|
-
><details>
|
|
4934
|
+
><details><br>
|
|
4906
4935
|
><summary>Schema</summary>
|
|
4907
4936
|
>
|
|
4908
4937
|
>**id:** number <br>
|
|
@@ -4938,7 +4967,6 @@ Example return:
|
|
|
4938
4967
|
>Enum:
|
|
4939
4968
|
>[ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ] <br>
|
|
4940
4969
|
>
|
|
4941
|
-
>
|
|
4942
4970
|
>**templateIdentifier:** string <br>
|
|
4943
4971
|
>*custom identifier of the associated template* <br>
|
|
4944
4972
|
>example: my-template <br>
|
|
@@ -4950,11 +4978,9 @@ Example return:
|
|
|
4950
4978
|
>**forms** <br>
|
|
4951
4979
|
>*Array of FormEntity object identifier values linked to the page (optional)* <br>
|
|
4952
4980
|
>
|
|
4953
|
-
>
|
|
4954
4981
|
>**blocks** <br>
|
|
4955
4982
|
>*Array of BlockEntity object identifier values linked to the page (optional)* <br>
|
|
4956
4983
|
>
|
|
4957
|
-
>
|
|
4958
4984
|
>**isSync:** boolean <br>
|
|
4959
4985
|
>*indicator of page indexing (true or false)* <br>
|
|
4960
4986
|
>example: false
|
|
@@ -4962,7 +4988,7 @@ Example return:
|
|
|
4962
4988
|
>**products** number <br>
|
|
4963
4989
|
>*number of products associated with the page* <br>
|
|
4964
4990
|
>example: 0 <br>
|
|
4965
|
-
>
|
|
4991
|
+
><br>
|
|
4966
4992
|
></details>
|
|
4967
4993
|
|
|
4968
4994
|
### Pages.getChildPagesByParentUrl(url, langCode)
|
|
@@ -4971,7 +4997,7 @@ Example return:
|
|
|
4971
4997
|
const value = await Pages.getChildPagesByParentUrl('shop');
|
|
4972
4998
|
```
|
|
4973
4999
|
|
|
4974
|
-
><details>
|
|
5000
|
+
><details><br>
|
|
4975
5001
|
><summary>Schema</summary>
|
|
4976
5002
|
>
|
|
4977
5003
|
>**url*:** string <br>
|
|
@@ -4981,7 +5007,7 @@ const value = await Pages.getChildPagesByParentUrl('shop');
|
|
|
4981
5007
|
>**langCode:** string <br>
|
|
4982
5008
|
>*Required parameter lang code* <br>
|
|
4983
5009
|
>example: en_US <br>
|
|
4984
|
-
>
|
|
5010
|
+
><br>
|
|
4985
5011
|
></details>
|
|
4986
5012
|
|
|
4987
5013
|
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.
|
|
@@ -5015,8 +5041,8 @@ Example return:
|
|
|
5015
5041
|
]
|
|
5016
5042
|
```
|
|
5017
5043
|
|
|
5018
|
-
><details>
|
|
5019
|
-
><summary
|
|
5044
|
+
><details><br>
|
|
5045
|
+
><summary>Schema</summary>
|
|
5020
5046
|
>
|
|
5021
5047
|
>**id:** number <br>
|
|
5022
5048
|
>*object identifier* <br>
|
|
@@ -5056,11 +5082,9 @@ Example return:
|
|
|
5056
5082
|
>**forms** <br>
|
|
5057
5083
|
>*Array of FormEntity object identifier values linked to the page (optional)*
|
|
5058
5084
|
>
|
|
5059
|
-
>
|
|
5060
5085
|
>**blocks** <br>
|
|
5061
5086
|
>*Array of BlockEntity object identifier values linked to the page (optional)*
|
|
5062
5087
|
>
|
|
5063
|
-
>
|
|
5064
5088
|
>**isSync:** boolean <br>
|
|
5065
5089
|
>*indicator of page indexing (true or false)* <br>
|
|
5066
5090
|
>example: false <br>
|
|
@@ -5083,11 +5107,10 @@ Example return:
|
|
|
5083
5107
|
>Enum:
|
|
5084
5108
|
>[ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ] <br>
|
|
5085
5109
|
>
|
|
5086
|
-
>
|
|
5087
5110
|
>**childrenCount:** number <br>
|
|
5088
5111
|
>*number of nested pages* <br>
|
|
5089
5112
|
>example: 0 <br>
|
|
5090
|
-
>
|
|
5113
|
+
><br>
|
|
5091
5114
|
></details>
|
|
5092
5115
|
|
|
5093
5116
|
### Pages.getBlocksByPageUrl(url, langCode)
|
|
@@ -5096,7 +5119,7 @@ Example return:
|
|
|
5096
5119
|
const value = await Pages.getFormsByPageUrl('shop');
|
|
5097
5120
|
```
|
|
5098
5121
|
|
|
5099
|
-
><details>
|
|
5122
|
+
><details><br>
|
|
5100
5123
|
><summary>Schema</summary>
|
|
5101
5124
|
>
|
|
5102
5125
|
>**url*:** string <br>
|
|
@@ -5106,7 +5129,7 @@ const value = await Pages.getFormsByPageUrl('shop');
|
|
|
5106
5129
|
>**langCode:** string <br>
|
|
5107
5130
|
>*lang code* <br>
|
|
5108
5131
|
>example: en_US <br>
|
|
5109
|
-
>
|
|
5132
|
+
><br>
|
|
5110
5133
|
></details>
|
|
5111
5134
|
|
|
5112
5135
|
Get PositionBlock objects for a related form by url. Returns an array of PositionBlock objects.
|
|
@@ -5134,7 +5157,7 @@ Example return:
|
|
|
5134
5157
|
]
|
|
5135
5158
|
```
|
|
5136
5159
|
|
|
5137
|
-
><details>
|
|
5160
|
+
><details><br>
|
|
5138
5161
|
><summary>Schema</summary>
|
|
5139
5162
|
>
|
|
5140
5163
|
>**id:** number <br>
|
|
@@ -5182,7 +5205,7 @@ Example return:
|
|
|
5182
5205
|
>**templateIdentifier:** string <br>
|
|
5183
5206
|
>*marker of the template used by the block (can be null)* <br>
|
|
5184
5207
|
>example: null <br>
|
|
5185
|
-
>
|
|
5208
|
+
><br>
|
|
5186
5209
|
></details>
|
|
5187
5210
|
|
|
5188
5211
|
### Pages.getFormsByPageUrl(url, langCode)
|
|
@@ -5191,7 +5214,7 @@ Example return:
|
|
|
5191
5214
|
const value = await Pages.getFormsByPageUrl('shop')
|
|
5192
5215
|
```
|
|
5193
5216
|
|
|
5194
|
-
><details>
|
|
5217
|
+
><details><br>
|
|
5195
5218
|
><summary>Schema</summary>
|
|
5196
5219
|
>
|
|
5197
5220
|
>**url*:** string <br>
|
|
@@ -5201,7 +5224,7 @@ const value = await Pages.getFormsByPageUrl('shop')
|
|
|
5201
5224
|
>**langCode:** string <br>
|
|
5202
5225
|
>*lang code* <br>
|
|
5203
5226
|
>example: en_US <br>
|
|
5204
|
-
>
|
|
5227
|
+
><br>
|
|
5205
5228
|
></details>
|
|
5206
5229
|
|
|
5207
5230
|
Get PositionForm objects for a related form by url. Returns an array of PositionForm objects.
|
|
@@ -5258,8 +5281,8 @@ Example return:
|
|
|
5258
5281
|
]
|
|
5259
5282
|
```
|
|
5260
5283
|
|
|
5261
|
-
><details>
|
|
5262
|
-
><summary
|
|
5284
|
+
><details><br>
|
|
5285
|
+
><summary>Schema</summary>
|
|
5263
5286
|
>
|
|
5264
5287
|
>**id:** number <br>
|
|
5265
5288
|
>*object identifier* <br>
|
|
@@ -5287,10 +5310,9 @@ Example return:
|
|
|
5287
5310
|
>*json description of the main page data object taking into account the language "en_US" (for example)* <br>
|
|
5288
5311
|
>example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } } <br>
|
|
5289
5312
|
>
|
|
5290
|
-
>**processingData:**
|
|
5313
|
+
>**processingData:** <br>
|
|
5291
5314
|
>*form data* <br>
|
|
5292
5315
|
>
|
|
5293
|
-
>
|
|
5294
5316
|
>**attributes:** Record<string, string> <br>
|
|
5295
5317
|
>*array of attribute values from the used attribute set for displaying the form (taking into account the specified language)* <br>
|
|
5296
5318
|
>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" } } ] <br>
|
|
@@ -5298,7 +5320,7 @@ Example return:
|
|
|
5298
5320
|
>**position:** number <br>
|
|
5299
5321
|
>*position number for sorting (optional)* <br>
|
|
5300
5322
|
>example: 192 <br>
|
|
5301
|
-
>
|
|
5323
|
+
><br>
|
|
5302
5324
|
></details>
|
|
5303
5325
|
|
|
5304
5326
|
### Pages.getConfigPageByUrl(url)
|
|
@@ -5307,13 +5329,13 @@ Example return:
|
|
|
5307
5329
|
const value = await Pages.getConfigPageByUrl('shop')
|
|
5308
5330
|
```
|
|
5309
5331
|
|
|
5310
|
-
><details>
|
|
5332
|
+
><details><br>
|
|
5311
5333
|
><summary>Schema</summary>
|
|
5312
5334
|
>
|
|
5313
5335
|
>**url*:** string <br>
|
|
5314
5336
|
>*Page URL* <br>
|
|
5315
5337
|
>example: shop <br>
|
|
5316
|
-
>
|
|
5338
|
+
><br>
|
|
5317
5339
|
></details>
|
|
5318
5340
|
|
|
5319
5341
|
This method retrieves the settings for a specific page based on its URL (url). It returns a Promise that resolves to a ConfigPageDto object with page display settings.
|
|
@@ -5327,7 +5349,7 @@ Example return:
|
|
|
5327
5349
|
}
|
|
5328
5350
|
```
|
|
5329
5351
|
|
|
5330
|
-
><details>
|
|
5352
|
+
><details><br>
|
|
5331
5353
|
><summary>Schema</summary>
|
|
5332
5354
|
>
|
|
5333
5355
|
>**rowsPerPage:** number <br>
|
|
@@ -5337,7 +5359,7 @@ Example return:
|
|
|
5337
5359
|
>**productsPerRow** number <br>
|
|
5338
5360
|
>*Number of products per row* <br>
|
|
5339
5361
|
>example: 10 <br>
|
|
5340
|
-
>
|
|
5362
|
+
><br>
|
|
5341
5363
|
></details>
|
|
5342
5364
|
|
|
5343
5365
|
### Pages.searchPage(name, langCode)
|
|
@@ -5346,7 +5368,7 @@ Example return:
|
|
|
5346
5368
|
const value = await Pages.searchPage('cup')
|
|
5347
5369
|
```
|
|
5348
5370
|
|
|
5349
|
-
><details>
|
|
5371
|
+
><details><br>
|
|
5350
5372
|
><summary>Schema</summary>
|
|
5351
5373
|
>
|
|
5352
5374
|
>**name*:** string <br>
|
|
@@ -5356,7 +5378,7 @@ const value = await Pages.searchPage('cup')
|
|
|
5356
5378
|
>**langCode:** string <br>
|
|
5357
5379
|
>*lang code* <br>
|
|
5358
5380
|
>example: en_US <br>
|
|
5359
|
-
>
|
|
5381
|
+
><br>
|
|
5360
5382
|
></details>
|
|
5361
5383
|
|
|
5362
5384
|
This method performs a quick search for page objects based on a text query (name). It returns a Promise that resolves to a ContentIndexedPageDto objects or an empty array []. Get required language parameter.
|
|
@@ -5411,7 +5433,7 @@ const { Payments } = defineOneEntry('your-url');
|
|
|
5411
5433
|
const value = await Payments.getSessions()
|
|
5412
5434
|
```
|
|
5413
5435
|
|
|
5414
|
-
><details>
|
|
5436
|
+
><details><br>
|
|
5415
5437
|
><summary>Schema</summary>
|
|
5416
5438
|
>
|
|
5417
5439
|
>**offset:** number <br>
|
|
@@ -5421,7 +5443,7 @@ const value = await Payments.getSessions()
|
|
|
5421
5443
|
>**limit:** number <br>
|
|
5422
5444
|
>*Optional parameter for pagination, default is 30* <br>
|
|
5423
5445
|
>example: 30 <br>
|
|
5424
|
-
>
|
|
5446
|
+
><br>
|
|
5425
5447
|
></details>
|
|
5426
5448
|
|
|
5427
5449
|
This method get list of a payment session. It returns a Promise that resolves to a payment session object.
|
|
@@ -5446,7 +5468,7 @@ Example return:
|
|
|
5446
5468
|
}
|
|
5447
5469
|
```
|
|
5448
5470
|
|
|
5449
|
-
><details>
|
|
5471
|
+
><details><br>
|
|
5450
5472
|
><summary>Schema</summary>
|
|
5451
5473
|
>
|
|
5452
5474
|
>**id:** number <br>
|
|
@@ -5509,7 +5531,7 @@ Example return:
|
|
|
5509
5531
|
>**clientSecret** string <br>
|
|
5510
5532
|
>*client secret key* <br>
|
|
5511
5533
|
>example: pi_3Oyz2kQWzXG1R23w144qG7o4_secret_OeScuCwTpHmyOM1atbm7pWJw2 <br>
|
|
5512
|
-
>
|
|
5534
|
+
><br>
|
|
5513
5535
|
></details>
|
|
5514
5536
|
|
|
5515
5537
|
### Payments.getSessionById(id)
|
|
@@ -5518,13 +5540,13 @@ Example return:
|
|
|
5518
5540
|
const value = await Payments.getSessionById(1764)
|
|
5519
5541
|
```
|
|
5520
5542
|
|
|
5521
|
-
><details>
|
|
5543
|
+
><details><br>
|
|
5522
5544
|
><summary>Schema</summary>
|
|
5523
5545
|
>
|
|
5524
5546
|
>**id*:** number <br>
|
|
5525
5547
|
>*Identifier of the retrieved payment session object* <br>
|
|
5526
5548
|
>example: 12 <br>
|
|
5527
|
-
>
|
|
5549
|
+
><br>
|
|
5528
5550
|
></details>
|
|
5529
5551
|
|
|
5530
5552
|
This method get a single payment session object by its identifier. It returns a Promise that resolves to a payment session object.
|
|
@@ -5544,7 +5566,7 @@ Example return:
|
|
|
5544
5566
|
}
|
|
5545
5567
|
```
|
|
5546
5568
|
|
|
5547
|
-
><details>
|
|
5569
|
+
><details><br>
|
|
5548
5570
|
><summary>Schema</summary>
|
|
5549
5571
|
>
|
|
5550
5572
|
>**id:** number <br>
|
|
@@ -5607,7 +5629,7 @@ Example return:
|
|
|
5607
5629
|
>**clientSecret:** string <br>
|
|
5608
5630
|
>*client secret key* <br>
|
|
5609
5631
|
>example: pi_3Oyz2kQWzXG1R23w144qG7o4_secret_OeScuCwTpHmyOM1atbm7pWJw2 <br>
|
|
5610
|
-
>
|
|
5632
|
+
><br>
|
|
5611
5633
|
></details>
|
|
5612
5634
|
|
|
5613
5635
|
### Payments.createSession(orderId, type, automaticTaxEnabled)
|
|
@@ -5616,7 +5638,7 @@ Example return:
|
|
|
5616
5638
|
const value = await Payments.createSession(1, 'session')
|
|
5617
5639
|
```
|
|
5618
5640
|
|
|
5619
|
-
><details>
|
|
5641
|
+
><details><br>
|
|
5620
5642
|
><summary>Schema</summary>
|
|
5621
5643
|
>
|
|
5622
5644
|
>**orderId*:** number <br>
|
|
@@ -5630,7 +5652,7 @@ const value = await Payments.createSession(1, 'session')
|
|
|
5630
5652
|
>**automaticTaxEnabled:** boolean <br>
|
|
5631
5653
|
>*Automatic calculation of the tax rate* <br>
|
|
5632
5654
|
>example: false <br>
|
|
5633
|
-
>
|
|
5655
|
+
><br>
|
|
5634
5656
|
></details>
|
|
5635
5657
|
|
|
5636
5658
|
This method creation of a payment session. It returns a Promise that resolves to a payment session object.
|
|
@@ -5647,8 +5669,8 @@ Example return:
|
|
|
5647
5669
|
}
|
|
5648
5670
|
```
|
|
5649
5671
|
|
|
5650
|
-
><details>
|
|
5651
|
-
><summary
|
|
5672
|
+
><details><br>
|
|
5673
|
+
><summary>Schema</summary>
|
|
5652
5674
|
>
|
|
5653
5675
|
>**id:** number <br>
|
|
5654
5676
|
>*object identifier* <br>
|
|
@@ -5710,7 +5732,7 @@ Example return:
|
|
|
5710
5732
|
>**clientSecret:** string <br>
|
|
5711
5733
|
>*client secret key* <br>
|
|
5712
5734
|
>example: pi_3Oyz2kQWzXG1R23w144qG7o4_secret_OeScuCwTpHmyOM1atbm7pWJw2 <br>
|
|
5713
|
-
>
|
|
5735
|
+
><br>
|
|
5714
5736
|
></details>
|
|
5715
5737
|
|
|
5716
5738
|
### Payments.getConnected()
|
|
@@ -5730,7 +5752,7 @@ Example return:
|
|
|
5730
5752
|
}
|
|
5731
5753
|
```
|
|
5732
5754
|
|
|
5733
|
-
><details>
|
|
5755
|
+
><details><br>
|
|
5734
5756
|
><summary>Schema</summary>
|
|
5735
5757
|
>
|
|
5736
5758
|
>**stripeAccountId:** string <br>
|
|
@@ -5744,7 +5766,7 @@ Example return:
|
|
|
5744
5766
|
>**paypalAccountId:** string <br>
|
|
5745
5767
|
>*Identifier of connected Paypal account* <br>
|
|
5746
5768
|
>example: 4Q0BANTF5BE7N <br>
|
|
5747
|
-
>
|
|
5769
|
+
><br>
|
|
5748
5770
|
></details>
|
|
5749
5771
|
|
|
5750
5772
|
### Payments.getAccounts()
|
|
@@ -5771,8 +5793,8 @@ Example return:
|
|
|
5771
5793
|
]
|
|
5772
5794
|
```
|
|
5773
5795
|
|
|
5774
|
-
><details>
|
|
5775
|
-
><summary
|
|
5796
|
+
><details><br>
|
|
5797
|
+
><summary>Schema</summary>
|
|
5776
5798
|
>
|
|
5777
5799
|
>**id:** number <br>
|
|
5778
5800
|
>*object identifier* <br>
|
|
@@ -5800,7 +5822,7 @@ Example return:
|
|
|
5800
5822
|
>**isVisible:** boolean <br>
|
|
5801
5823
|
>*visibility indicator of the payment account* <br>
|
|
5802
5824
|
>example: true <br>
|
|
5803
|
-
>
|
|
5825
|
+
><br>
|
|
5804
5826
|
></details>
|
|
5805
5827
|
|
|
5806
5828
|
### Payments.getAccountById(id)
|
|
@@ -5809,13 +5831,13 @@ Example return:
|
|
|
5809
5831
|
const value = await Payments.getAccountById(1764)
|
|
5810
5832
|
```
|
|
5811
5833
|
|
|
5812
|
-
><details>
|
|
5834
|
+
><details><br>
|
|
5813
5835
|
><summary>Schema</summary>
|
|
5814
5836
|
>
|
|
5815
5837
|
>**id*:** number <br>
|
|
5816
5838
|
>*Identifier of the retrieved payment account object* <br>
|
|
5817
5839
|
>example: 1764 <br>
|
|
5818
|
-
>
|
|
5840
|
+
><br>
|
|
5819
5841
|
></details>
|
|
5820
5842
|
|
|
5821
5843
|
This method get a single payment account object by its identifier. It returns a Promise that resolves to a payment account object.
|
|
@@ -5834,8 +5856,8 @@ Example return:
|
|
|
5834
5856
|
}
|
|
5835
5857
|
```
|
|
5836
5858
|
|
|
5837
|
-
><details>
|
|
5838
|
-
><summary
|
|
5859
|
+
><details><br>
|
|
5860
|
+
><summary>Schema</summary>
|
|
5839
5861
|
>
|
|
5840
5862
|
>**id:** number <br>
|
|
5841
5863
|
>*object identifier* <br>
|
|
@@ -5863,7 +5885,7 @@ Example return:
|
|
|
5863
5885
|
>**isVisible:** boolean <br>
|
|
5864
5886
|
>*visibility indicator of the payment account* <br>
|
|
5865
5887
|
>example: true <br>
|
|
5866
|
-
>
|
|
5888
|
+
><br>
|
|
5867
5889
|
></details>
|
|
5868
5890
|
|
|
5869
5891
|
### Payments.webhookStripe()
|
|
@@ -5895,7 +5917,7 @@ const userQuery = {
|
|
|
5895
5917
|
}
|
|
5896
5918
|
```
|
|
5897
5919
|
|
|
5898
|
-
><details>
|
|
5920
|
+
><details><br>
|
|
5899
5921
|
><summary>Schema</summary>
|
|
5900
5922
|
>
|
|
5901
5923
|
>**offset:** number <br>
|
|
@@ -5913,7 +5935,7 @@ const userQuery = {
|
|
|
5913
5935
|
>**sortOrder:** string <br>
|
|
5914
5936
|
>*sorting order DESC | ASC (default DESC)* <br>
|
|
5915
5937
|
>example: "DESC" <br>
|
|
5916
|
-
>
|
|
5938
|
+
><br>
|
|
5917
5939
|
></details>
|
|
5918
5940
|
|
|
5919
5941
|
"conditionMarker" by which values are filtered (not set by default), possible values:
|
|
@@ -5957,7 +5979,7 @@ const body = [
|
|
|
5957
5979
|
const value = await Products.getProducts(body)
|
|
5958
5980
|
```
|
|
5959
5981
|
|
|
5960
|
-
><details>
|
|
5982
|
+
><details><br>
|
|
5961
5983
|
><summary>Schema</summary>
|
|
5962
5984
|
>
|
|
5963
5985
|
>**body*:** IFilterParams[] <br>
|
|
@@ -6006,12 +6028,12 @@ const value = await Products.getProducts(body)
|
|
|
6006
6028
|
>**userQuery.attributeMarker:** string <br>
|
|
6007
6029
|
>*Optional text identifier of the indexed attribute by which values are filtered* <br>
|
|
6008
6030
|
>example: price <br>
|
|
6009
|
-
>
|
|
6031
|
+
><br>
|
|
6010
6032
|
></details>
|
|
6011
6033
|
|
|
6012
6034
|
<br>
|
|
6013
6035
|
|
|
6014
|
-
><details>
|
|
6036
|
+
><details><br>
|
|
6015
6037
|
><summary>Schema (body)</summary>
|
|
6016
6038
|
>
|
|
6017
6039
|
>**attributeMarker:** string <br>
|
|
@@ -6040,7 +6062,7 @@ const value = await Products.getProducts(body)
|
|
|
6040
6062
|
>**isNested:** boolean <br>
|
|
6041
6063
|
>*search indicator for all nested categories (pageUrls)* <br>
|
|
6042
6064
|
>example: false <br>
|
|
6043
|
-
>
|
|
6065
|
+
><br>
|
|
6044
6066
|
></details>
|
|
6045
6067
|
|
|
6046
6068
|
This method searches for all products objects with pagination that do not have a category, based on the provided query parameters (userQuery). It returns a Promise that resolves to an array of items, where each item is a ContentIndexedProductDto object.
|
|
@@ -6098,7 +6120,7 @@ Example return:
|
|
|
6098
6120
|
}
|
|
6099
6121
|
```
|
|
6100
6122
|
|
|
6101
|
-
><details>
|
|
6123
|
+
><details><br>
|
|
6102
6124
|
><summary>Schema</summary>
|
|
6103
6125
|
>
|
|
6104
6126
|
>**total:** number <br>
|
|
@@ -6115,7 +6137,7 @@ Example return:
|
|
|
6115
6137
|
>
|
|
6116
6138
|
>**statusLocalizeInfos:** CommonLocalizeInfos <br>
|
|
6117
6139
|
>*json description of the item status object, taking into account the language* <br>
|
|
6118
|
-
>example: {
|
|
6140
|
+
>example: { "title": "Product" } <br>
|
|
6119
6141
|
>
|
|
6120
6142
|
>**localizeInfos:** Record<string, any> <br>
|
|
6121
6143
|
>*json description of the main page data object taking into account the language "en_US" (for example)* <br>
|
|
@@ -6172,7 +6194,7 @@ Example return:
|
|
|
6172
6194
|
>**shortDescTemplateIdentifier** string <br>
|
|
6173
6195
|
>*custom identifier of the associated template for short description* <br>
|
|
6174
6196
|
>example: my-template-short <br>
|
|
6175
|
-
>
|
|
6197
|
+
><br>
|
|
6176
6198
|
></details>
|
|
6177
6199
|
|
|
6178
6200
|
### Products.getProductsEmptyPage(langCode, userQuery)
|
|
@@ -6181,7 +6203,7 @@ Example return:
|
|
|
6181
6203
|
const value = await Products.getProductsEmptyPage('en_US', userQuery)
|
|
6182
6204
|
```
|
|
6183
6205
|
|
|
6184
|
-
><details>
|
|
6206
|
+
><details><br>
|
|
6185
6207
|
><summary>Schema</summary>
|
|
6186
6208
|
>
|
|
6187
6209
|
>**langCode:** string <br>
|
|
@@ -6222,7 +6244,7 @@ const value = await Products.getProductsEmptyPage('en_US', userQuery)
|
|
|
6222
6244
|
>**userQuery.sortKey:** string <br>
|
|
6223
6245
|
>*Optional field to sort by (id, title, date, price, position, status)* <br>
|
|
6224
6246
|
>example: id <br>
|
|
6225
|
-
>
|
|
6247
|
+
><br>
|
|
6226
6248
|
></details>
|
|
6227
6249
|
|
|
6228
6250
|
This method searches for product page objects with pagination that do not have a category, based on the provided query parameters (userQuery). It returns a Promise that resolves to an array of items, where each item is a ContentIndexedProductDto object.
|
|
@@ -6281,7 +6303,7 @@ Example return:
|
|
|
6281
6303
|
}
|
|
6282
6304
|
```
|
|
6283
6305
|
|
|
6284
|
-
><details>
|
|
6306
|
+
><details><br>
|
|
6285
6307
|
><summary>Schema</summary>
|
|
6286
6308
|
>
|
|
6287
6309
|
>**total:** number <br>
|
|
@@ -6298,7 +6320,7 @@ Example return:
|
|
|
6298
6320
|
>
|
|
6299
6321
|
>**statusLocalizeInfos:** CommonLocalizeInfos <br>
|
|
6300
6322
|
>*json description of the item status object, taking into account the language* <br>
|
|
6301
|
-
>example: {
|
|
6323
|
+
>example: { "title": "Product" } <br>
|
|
6302
6324
|
>
|
|
6303
6325
|
>**localizeInfos:** Record<string, any> <br>
|
|
6304
6326
|
>*json description of the main page data object taking into account the language "en_US" (for example)* <br>
|
|
@@ -6355,7 +6377,7 @@ Example return:
|
|
|
6355
6377
|
>**shortDescTemplateIdentifier** string <br>
|
|
6356
6378
|
>*custom identifier of the associated template for short description* <br>
|
|
6357
6379
|
>example: my-template-short <br>
|
|
6358
|
-
>
|
|
6380
|
+
><br>
|
|
6359
6381
|
></details>
|
|
6360
6382
|
|
|
6361
6383
|
### Products.getProductsByPageId(id, body, langCode, userQuery)
|
|
@@ -6388,7 +6410,7 @@ const body = [
|
|
|
6388
6410
|
const value = await Products.getProductsByPageId(1764, body);
|
|
6389
6411
|
```
|
|
6390
6412
|
|
|
6391
|
-
><details>
|
|
6413
|
+
><details><br>
|
|
6392
6414
|
><summary>Schema</summary>
|
|
6393
6415
|
>
|
|
6394
6416
|
>**id*:** number <br>
|
|
@@ -6438,12 +6460,12 @@ const value = await Products.getProductsByPageId(1764, body);
|
|
|
6438
6460
|
>**userQuery.sortKey:** string <br>
|
|
6439
6461
|
>*Optional field to sort by (id, title, date, price, position, status)* <br>
|
|
6440
6462
|
>example: id <br>
|
|
6441
|
-
>
|
|
6463
|
+
><br>
|
|
6442
6464
|
></details>
|
|
6443
6465
|
|
|
6444
6466
|
<br>
|
|
6445
6467
|
|
|
6446
|
-
><details>
|
|
6468
|
+
><details><br>
|
|
6447
6469
|
><summary>Schema (body)</summary>
|
|
6448
6470
|
>
|
|
6449
6471
|
>**attributeMarker:** string <br>
|
|
@@ -6472,7 +6494,7 @@ const value = await Products.getProductsByPageId(1764, body);
|
|
|
6472
6494
|
>**isNested:** boolean <br>
|
|
6473
6495
|
>*search indicator for all nested categories (pageUrls)* <br>
|
|
6474
6496
|
>example: false <br>
|
|
6475
|
-
>
|
|
6497
|
+
><br>
|
|
6476
6498
|
></details>
|
|
6477
6499
|
|
|
6478
6500
|
This method searches for all products objects with pagination for the selected category, based on the provided query parameters (userQuery). It returns a Promise that resolves to an array of items, where each item is a ContentIndexedProductDto object.
|
|
@@ -6534,7 +6556,7 @@ Example return:
|
|
|
6534
6556
|
}
|
|
6535
6557
|
```
|
|
6536
6558
|
|
|
6537
|
-
><details>
|
|
6559
|
+
><details><br>
|
|
6538
6560
|
><summary>Schema</summary>
|
|
6539
6561
|
>
|
|
6540
6562
|
>**total:** number <br>
|
|
@@ -6551,7 +6573,7 @@ Example return:
|
|
|
6551
6573
|
>
|
|
6552
6574
|
>**statusLocalizeInfos:** CommonLocalizeInfos <br>
|
|
6553
6575
|
>*json description of the item status object, taking into account the language* <br>
|
|
6554
|
-
>example: {
|
|
6576
|
+
>example: { "title": "Product" } <br>
|
|
6555
6577
|
>
|
|
6556
6578
|
>**localizeInfos:** Record<string, any> <br>
|
|
6557
6579
|
>*json description of the main page data object taking into account the language "en_US" (for example)* <br>
|
|
@@ -6608,7 +6630,7 @@ Example return:
|
|
|
6608
6630
|
>**shortDescTemplateIdentifier** string <br>
|
|
6609
6631
|
>*custom identifier of the associated template for short description* <br>
|
|
6610
6632
|
>example: my-template-short <br>
|
|
6611
|
-
>
|
|
6633
|
+
><br>
|
|
6612
6634
|
></details>
|
|
6613
6635
|
|
|
6614
6636
|
### Products.getProductsPriceByPageUrl(url, userQuery)
|
|
@@ -6618,7 +6640,7 @@ Example return:
|
|
|
6618
6640
|
const value = await Products.getProductsPriceByPageUrl('catalog')
|
|
6619
6641
|
```
|
|
6620
6642
|
|
|
6621
|
-
><details>
|
|
6643
|
+
><details><br>
|
|
6622
6644
|
><summary>Schema</summary>
|
|
6623
6645
|
>
|
|
6624
6646
|
>**url*:** string <br>
|
|
@@ -6663,7 +6685,7 @@ const value = await Products.getProductsPriceByPageUrl('catalog')
|
|
|
6663
6685
|
>**userQuery.sortKey:** string <br>
|
|
6664
6686
|
>*Optional field to sort by (id, title, date, price, position, status)* <br>
|
|
6665
6687
|
>example: id <br>
|
|
6666
|
-
>
|
|
6688
|
+
><br>
|
|
6667
6689
|
></details>
|
|
6668
6690
|
|
|
6669
6691
|
<br>
|
|
@@ -6684,8 +6706,8 @@ Example return:
|
|
|
6684
6706
|
}
|
|
6685
6707
|
```
|
|
6686
6708
|
|
|
6687
|
-
><details>
|
|
6688
|
-
><summary
|
|
6709
|
+
><details><br>
|
|
6710
|
+
><summary>Schema</summary>
|
|
6689
6711
|
>
|
|
6690
6712
|
>**total:** number <br>
|
|
6691
6713
|
>*total number of found records* <br>
|
|
@@ -6698,7 +6720,7 @@ Example return:
|
|
|
6698
6720
|
>**price:** number <br>
|
|
6699
6721
|
>*price value of the product page taken from the index* <br>
|
|
6700
6722
|
>example: 0 <br>
|
|
6701
|
-
>
|
|
6723
|
+
><br>
|
|
6702
6724
|
></details>
|
|
6703
6725
|
|
|
6704
6726
|
### Products.getProductsByPageUrl(url, body, langCode, userQuery)
|
|
@@ -6731,7 +6753,7 @@ const body = [
|
|
|
6731
6753
|
const value = await Products.getProductsByPageUrl('catalog', body)
|
|
6732
6754
|
```
|
|
6733
6755
|
|
|
6734
|
-
><details>
|
|
6756
|
+
><details><br>
|
|
6735
6757
|
><summary>Schema</summary>
|
|
6736
6758
|
>
|
|
6737
6759
|
>**url*:** string <br>
|
|
@@ -6780,12 +6802,12 @@ const value = await Products.getProductsByPageUrl('catalog', body)
|
|
|
6780
6802
|
>**userQuery.sortKey:** string <br>
|
|
6781
6803
|
>*Optional field to sort by (id, title, date, price, position, status)* <br>
|
|
6782
6804
|
>example: id <br>
|
|
6783
|
-
>
|
|
6805
|
+
><br>
|
|
6784
6806
|
></details>
|
|
6785
6807
|
|
|
6786
6808
|
<br>
|
|
6787
6809
|
|
|
6788
|
-
><details>
|
|
6810
|
+
><details><br>
|
|
6789
6811
|
><summary>Schema (body)</summary>
|
|
6790
6812
|
>
|
|
6791
6813
|
>**attributeMarker:** string <br>
|
|
@@ -6814,7 +6836,7 @@ const value = await Products.getProductsByPageUrl('catalog', body)
|
|
|
6814
6836
|
>**isNested:** boolean <br>
|
|
6815
6837
|
>*search indicator for all nested categories (pageUrls)* <br>
|
|
6816
6838
|
>example: false <br>
|
|
6817
|
-
>
|
|
6839
|
+
><br>
|
|
6818
6840
|
></details>
|
|
6819
6841
|
|
|
6820
6842
|
This method searches for all products objects with pagination for the selected category, based on the provided query parameters (userQuery). It returns a Promise that resolves to an array of items, where each item is a ContentIndexedProductDto object.
|
|
@@ -6875,8 +6897,8 @@ Example return:
|
|
|
6875
6897
|
}
|
|
6876
6898
|
```
|
|
6877
6899
|
|
|
6878
|
-
><details>
|
|
6879
|
-
><summary
|
|
6900
|
+
><details><br>
|
|
6901
|
+
><summary>Schema</summary>
|
|
6880
6902
|
>
|
|
6881
6903
|
>**total:** number <br>
|
|
6882
6904
|
>*total number of found records* <br>
|
|
@@ -6949,7 +6971,7 @@ Example return:
|
|
|
6949
6971
|
>**shortDescTemplateIdentifier** string <br>
|
|
6950
6972
|
>*custom identifier of the associated template for short description* <br>
|
|
6951
6973
|
>example: my-template-short <br>
|
|
6952
|
-
>
|
|
6974
|
+
><br>
|
|
6953
6975
|
></details>
|
|
6954
6976
|
|
|
6955
6977
|
### Products.getRelatedProductsById(id, langCode, userQuery)
|
|
@@ -6958,7 +6980,7 @@ Example return:
|
|
|
6958
6980
|
const value = await Products.getRelatedProductsById(1)
|
|
6959
6981
|
```
|
|
6960
6982
|
|
|
6961
|
-
><details>
|
|
6983
|
+
><details><br>
|
|
6962
6984
|
><summary>Schema</summary>
|
|
6963
6985
|
>
|
|
6964
6986
|
>**id*:** number <br>
|
|
@@ -6988,7 +7010,7 @@ const value = await Products.getRelatedProductsById(1)
|
|
|
6988
7010
|
>**userQuery.sortKey:** string <br>
|
|
6989
7011
|
>*Optional field to sort by (id, title, date, price, position, status)* <br>
|
|
6990
7012
|
>example: id <br>
|
|
6991
|
-
>
|
|
7013
|
+
><br>
|
|
6992
7014
|
></details>
|
|
6993
7015
|
|
|
6994
7016
|
This method retrieves all related product page objects for a specific product based on its identifier (id) from the API. It accepts an optional userQuery parameter for additional query parameters such as offset, limit, sortOrder, and sortKey. It returns a Promise that resolves to an array of ContentIndexedProductDto objects.
|
|
@@ -7050,8 +7072,8 @@ Example return:
|
|
|
7050
7072
|
}
|
|
7051
7073
|
```
|
|
7052
7074
|
|
|
7053
|
-
><details>
|
|
7054
|
-
><summary
|
|
7075
|
+
><details><br>
|
|
7076
|
+
><summary>Schema</summary>
|
|
7055
7077
|
>
|
|
7056
7078
|
>**total:** number <br>
|
|
7057
7079
|
>*total number of found records* <br>
|
|
@@ -7067,7 +7089,7 @@ Example return:
|
|
|
7067
7089
|
>
|
|
7068
7090
|
>**statusLocalizeInfos:** CommonLocalizeInfos <br>
|
|
7069
7091
|
>*json description of the item status object, taking into account the language* <br>
|
|
7070
|
-
>example: {
|
|
7092
|
+
>example: { "title": "Product" } <br>
|
|
7071
7093
|
>
|
|
7072
7094
|
>**localizeInfos:** Record<string, any> <br>
|
|
7073
7095
|
>*json description of the main page data object taking into account the language "en_US" (for example)* <br>
|
|
@@ -7124,7 +7146,7 @@ Example return:
|
|
|
7124
7146
|
>**shortDescTemplateIdentifier** string <br>
|
|
7125
7147
|
>*custom identifier of the associated template for short description* <br>
|
|
7126
7148
|
>example: my-template-short <br>
|
|
7127
|
-
>
|
|
7149
|
+
><br>
|
|
7128
7150
|
></details>
|
|
7129
7151
|
|
|
7130
7152
|
### Products.getProductsByIds(ids, langCode, userQuery)
|
|
@@ -7133,7 +7155,7 @@ Example return:
|
|
|
7133
7155
|
const value = await Products.getProductsByIds('1, 5, 8', 'en_US')
|
|
7134
7156
|
```
|
|
7135
7157
|
|
|
7136
|
-
><details>
|
|
7158
|
+
><details><br>
|
|
7137
7159
|
><summary>Schema</summary>
|
|
7138
7160
|
>
|
|
7139
7161
|
>**ids*:** string <br>
|
|
@@ -7163,7 +7185,7 @@ const value = await Products.getProductsByIds('1, 5, 8', 'en_US')
|
|
|
7163
7185
|
>**userQuery.sortKey:** string <br>
|
|
7164
7186
|
>*Optional field to sort by (id, title, date, price, position, status)* <br>
|
|
7165
7187
|
>example: id <br>
|
|
7166
|
-
>
|
|
7188
|
+
><br>
|
|
7167
7189
|
></details>
|
|
7168
7190
|
|
|
7169
7191
|
This method retrieves a products objects based on its identifiers (ids) from the API. It returns a Promise that resolves to a IProductsEntity objects for the product.
|
|
@@ -7230,8 +7252,8 @@ Example return:
|
|
|
7230
7252
|
]
|
|
7231
7253
|
```
|
|
7232
7254
|
|
|
7233
|
-
><details>
|
|
7234
|
-
><summary
|
|
7255
|
+
><details><br>
|
|
7256
|
+
><summary>Schema</summary>
|
|
7235
7257
|
>
|
|
7236
7258
|
>**id:** number <br>
|
|
7237
7259
|
>*object identifier* <br>
|
|
@@ -7296,17 +7318,16 @@ Example return:
|
|
|
7296
7318
|
>**position:** number <br>
|
|
7297
7319
|
>*position number (for sorting)* <br>
|
|
7298
7320
|
>example: 1 <br>
|
|
7299
|
-
>
|
|
7321
|
+
><br>
|
|
7300
7322
|
></details>
|
|
7301
7323
|
|
|
7302
|
-
|
|
7303
7324
|
### Products.getProductById(id, langCode)
|
|
7304
7325
|
|
|
7305
7326
|
```js
|
|
7306
7327
|
const value = await Products.getProductById(1)
|
|
7307
7328
|
```
|
|
7308
7329
|
|
|
7309
|
-
><details>
|
|
7330
|
+
><details><br>
|
|
7310
7331
|
><summary>Schema</summary>
|
|
7311
7332
|
>
|
|
7312
7333
|
>**id*:** Product id <br>
|
|
@@ -7316,7 +7337,7 @@ const value = await Products.getProductById(1)
|
|
|
7316
7337
|
>**langCode:** <br>
|
|
7317
7338
|
>*Language code parameter. Default "en_US"* <br>
|
|
7318
7339
|
>example: en_US <br>
|
|
7319
|
-
>
|
|
7340
|
+
><br>
|
|
7320
7341
|
></details>
|
|
7321
7342
|
|
|
7322
7343
|
This method retrieves a single product object based on its identifier (id) from the API. It returns a Promise that resolves to a ContentIndexedProductDto object for the product.
|
|
@@ -7378,8 +7399,8 @@ Example return:
|
|
|
7378
7399
|
}
|
|
7379
7400
|
```
|
|
7380
7401
|
|
|
7381
|
-
><details>
|
|
7382
|
-
><summary
|
|
7402
|
+
><details><br>
|
|
7403
|
+
><summary>Schema</summary>
|
|
7383
7404
|
>
|
|
7384
7405
|
>**id:** number <br>
|
|
7385
7406
|
>*object identifier* <br>
|
|
@@ -7448,7 +7469,7 @@ Example return:
|
|
|
7448
7469
|
>**shortDescTemplateIdentifier** string <br>
|
|
7449
7470
|
>*custom identifier of the associated template for short description* <br>
|
|
7450
7471
|
>example: my-template-short <br>
|
|
7451
|
-
>
|
|
7472
|
+
><br>
|
|
7452
7473
|
></details>
|
|
7453
7474
|
|
|
7454
7475
|
### Products.getProductBlockById(id)
|
|
@@ -7457,13 +7478,13 @@ Example return:
|
|
|
7457
7478
|
const value = await Products.getProductBlockById(1764)
|
|
7458
7479
|
```
|
|
7459
7480
|
|
|
7460
|
-
><details>
|
|
7481
|
+
><details><br>
|
|
7461
7482
|
><summary>Schema</summary>
|
|
7462
7483
|
>
|
|
7463
7484
|
>**id*:** number <br>
|
|
7464
7485
|
>*Product id* <br>
|
|
7465
7486
|
>example: 1764 <br>
|
|
7466
|
-
>
|
|
7487
|
+
><br>
|
|
7467
7488
|
></details>
|
|
7468
7489
|
|
|
7469
7490
|
This method Getting a product block object by product id.
|
|
@@ -7504,7 +7525,7 @@ Example return:
|
|
|
7504
7525
|
]
|
|
7505
7526
|
```
|
|
7506
7527
|
|
|
7507
|
-
><details>
|
|
7528
|
+
><details><br>
|
|
7508
7529
|
><summary>Schema</summary>
|
|
7509
7530
|
>
|
|
7510
7531
|
>**id:** number <br>
|
|
@@ -7549,7 +7570,7 @@ Example return:
|
|
|
7549
7570
|
>Enum:
|
|
7550
7571
|
>[ forCatalogProducts, forBasketPage, forErrorPage, forCatalogPages, forProductPreview, forProductPage, forSimilarProductBlock, forStatisticProductBlock, forProductBlock, forForm, forFormField, forNewsPage, forNewsBlock, forNewsPreview, forOneNewsPage, forUsualPage, forTextBlock, forSlider, service ] <br>
|
|
7551
7572
|
>example: null <br>
|
|
7552
|
-
>
|
|
7573
|
+
><br>
|
|
7553
7574
|
></details>
|
|
7554
7575
|
|
|
7555
7576
|
### Products.searchProduct(name, langCode)
|
|
@@ -7558,7 +7579,7 @@ Example return:
|
|
|
7558
7579
|
const value = await Products.searchProduct('cup')
|
|
7559
7580
|
```
|
|
7560
7581
|
|
|
7561
|
-
><details>
|
|
7582
|
+
><details><br>
|
|
7562
7583
|
><summary>Schema</summary>
|
|
7563
7584
|
>
|
|
7564
7585
|
>**name*:** string <br>
|
|
@@ -7568,7 +7589,7 @@ const value = await Products.searchProduct('cup')
|
|
|
7568
7589
|
>**langCode:** string <br>
|
|
7569
7590
|
>*Language code. Default "en_US"* <br>
|
|
7570
7591
|
>example: en_US <br>
|
|
7571
|
-
>
|
|
7592
|
+
><br>
|
|
7572
7593
|
></details>
|
|
7573
7594
|
|
|
7574
7595
|
This method performs a quick search for product page objects based on a text query name. The search is performed on the title field of the localizeInfos object, taking the specified lang language code into consideration. It returns a Promise that resolves to an array of ContentIndexedProductDto objects.
|
|
@@ -7630,7 +7651,7 @@ Example return:
|
|
|
7630
7651
|
]
|
|
7631
7652
|
```
|
|
7632
7653
|
|
|
7633
|
-
><details>
|
|
7654
|
+
><details><br>
|
|
7634
7655
|
><summary>Schema</summary>
|
|
7635
7656
|
>
|
|
7636
7657
|
>**id:** number <br>
|
|
@@ -7643,7 +7664,7 @@ Example return:
|
|
|
7643
7664
|
>
|
|
7644
7665
|
>**statusLocalizeInfos:** CommonLocalizeInfos <br>
|
|
7645
7666
|
>*json description of the item status object, taking into account the language* <br>
|
|
7646
|
-
>example: {
|
|
7667
|
+
>example: { "title": "Product" } <br>
|
|
7647
7668
|
>
|
|
7648
7669
|
>**localizeInfos:** Record<string, any> <br>
|
|
7649
7670
|
>*json description of the main page data object taking into account the language "en_US" (for example)* <br>
|
|
@@ -7700,7 +7721,7 @@ Example return:
|
|
|
7700
7721
|
>**shortDescTemplateIdentifier** string <br>
|
|
7701
7722
|
>*custom identifier of the associated template for short description* <br>
|
|
7702
7723
|
>example: my-template-short <br>
|
|
7703
|
-
>
|
|
7724
|
+
><br>
|
|
7704
7725
|
></details>
|
|
7705
7726
|
|
|
7706
7727
|
---
|
|
@@ -7717,13 +7738,13 @@ const { ProductStatuses } = defineOneEntry('your-url');
|
|
|
7717
7738
|
const value = await ProductStatuses.getProductStatuses()
|
|
7718
7739
|
```
|
|
7719
7740
|
|
|
7720
|
-
><details>
|
|
7741
|
+
><details><br>
|
|
7721
7742
|
><summary>Schema</summary>
|
|
7722
7743
|
>
|
|
7723
7744
|
>**langCode:** string <br>
|
|
7724
7745
|
>*language code* <br>
|
|
7725
7746
|
>example: en_US <br>
|
|
7726
|
-
>
|
|
7747
|
+
><br>
|
|
7727
7748
|
></details>
|
|
7728
7749
|
|
|
7729
7750
|
This method searches for all product status objects from the API. It returns a Promise that resolves to an array of product status objects.
|
|
@@ -7744,8 +7765,8 @@ Example return:
|
|
|
7744
7765
|
]
|
|
7745
7766
|
```
|
|
7746
7767
|
|
|
7747
|
-
><details>
|
|
7748
|
-
><summary
|
|
7768
|
+
><details><br>
|
|
7769
|
+
><summary>Schema</summary>
|
|
7749
7770
|
>
|
|
7750
7771
|
>**id:** number <br>
|
|
7751
7772
|
>*object identifier* <br>
|
|
@@ -7762,7 +7783,7 @@ Example return:
|
|
|
7762
7783
|
>**localizeInfos:** Record<string, any> <br>
|
|
7763
7784
|
>*json description of the main page data object taking into account the language "en_US" (for example)* <br>
|
|
7764
7785
|
>example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } } <br>
|
|
7765
|
-
>
|
|
7786
|
+
><br>
|
|
7766
7787
|
></details>
|
|
7767
7788
|
|
|
7768
7789
|
### ProductStatuses.getProductStatusesById(id, langCode)
|
|
@@ -7771,7 +7792,7 @@ Example return:
|
|
|
7771
7792
|
const value = await ProductStatuses.getProductStatusesById(1)
|
|
7772
7793
|
```
|
|
7773
7794
|
|
|
7774
|
-
><details>
|
|
7795
|
+
><details><br>
|
|
7775
7796
|
><summary>Schema</summary>
|
|
7776
7797
|
>
|
|
7777
7798
|
>**id*:** number <br>
|
|
@@ -7781,7 +7802,7 @@ const value = await ProductStatuses.getProductStatusesById(1)
|
|
|
7781
7802
|
>**langCode:** string <br>
|
|
7782
7803
|
>*language code* <br>
|
|
7783
7804
|
>example: en_US <br>
|
|
7784
|
-
>
|
|
7805
|
+
><br>
|
|
7785
7806
|
></details>
|
|
7786
7807
|
|
|
7787
7808
|
This method searches for a product status object based on its identifier (id) from the API. It returns a Promise that resolves to a product status object.
|
|
@@ -7800,7 +7821,7 @@ Example return:
|
|
|
7800
7821
|
}
|
|
7801
7822
|
```
|
|
7802
7823
|
|
|
7803
|
-
><details>
|
|
7824
|
+
><details><br>
|
|
7804
7825
|
><summary>Schema</summary>
|
|
7805
7826
|
>
|
|
7806
7827
|
>**id:** number <br>
|
|
@@ -7818,7 +7839,7 @@ Example return:
|
|
|
7818
7839
|
>**localizeInfos:** Record<string, any> <br>
|
|
7819
7840
|
>*json description of the main page data object taking into account the language "en_US" (for example)* <br>
|
|
7820
7841
|
>example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } } <br>
|
|
7821
|
-
>
|
|
7842
|
+
><br>
|
|
7822
7843
|
></details>
|
|
7823
7844
|
|
|
7824
7845
|
### ProductStatuses.getProductsByStatusMarker(marker, langCode)
|
|
@@ -7827,7 +7848,7 @@ Example return:
|
|
|
7827
7848
|
const value = await ProductStatuses.getProductsByStatusMarker('my-marker')
|
|
7828
7849
|
```
|
|
7829
7850
|
|
|
7830
|
-
><details>
|
|
7851
|
+
><details><br>
|
|
7831
7852
|
><summary>Schema</summary>
|
|
7832
7853
|
>
|
|
7833
7854
|
>**marker*:** string <br>
|
|
@@ -7837,7 +7858,7 @@ const value = await ProductStatuses.getProductsByStatusMarker('my-marker')
|
|
|
7837
7858
|
>**langCode:** string <br>
|
|
7838
7859
|
>*language code* <br>
|
|
7839
7860
|
>example: en_US <br>
|
|
7840
|
-
>
|
|
7861
|
+
><br>
|
|
7841
7862
|
></details>
|
|
7842
7863
|
|
|
7843
7864
|
This method searches for a product status object based on its textual identifier (marker) from the API. It returns a Promise that resolves to a product status object.
|
|
@@ -7856,7 +7877,7 @@ Example return:
|
|
|
7856
7877
|
}
|
|
7857
7878
|
```
|
|
7858
7879
|
|
|
7859
|
-
><details>
|
|
7880
|
+
><details><br>
|
|
7860
7881
|
><summary>Schema</summary>
|
|
7861
7882
|
>
|
|
7862
7883
|
>**id:** number <br>
|
|
@@ -7874,7 +7895,7 @@ Example return:
|
|
|
7874
7895
|
>**localizeInfos:** Record<string, any> <br>
|
|
7875
7896
|
>*json description of the main page data object taking into account the language "en_US" (for example)* <br>
|
|
7876
7897
|
>example: OrderedMap { "en_US": OrderedMap { "title": "Catalog", "plainContent": "Content for catalog", "htmlContent": "<b>Content for catalog</b>", "menuTitle": "Catalog" } } <br>
|
|
7877
|
-
>
|
|
7898
|
+
><br>
|
|
7878
7899
|
></details>
|
|
7879
7900
|
|
|
7880
7901
|
### ProductStatuses.validateMarker(marker)
|
|
@@ -7883,13 +7904,13 @@ Example return:
|
|
|
7883
7904
|
const value = await ProductStatuses.validateMarker('marker')
|
|
7884
7905
|
```
|
|
7885
7906
|
|
|
7886
|
-
><details>
|
|
7907
|
+
><details><br>
|
|
7887
7908
|
><summary>Schema</summary>
|
|
7888
7909
|
>
|
|
7889
7910
|
>**marker*:** string <br>
|
|
7890
7911
|
>*Product marker* <br>
|
|
7891
7912
|
>example: marker <br>
|
|
7892
|
-
>
|
|
7913
|
+
><br>
|
|
7893
7914
|
></details>
|
|
7894
7915
|
|
|
7895
7916
|
This method checks the existence of a textual identifier (marker). It takes a marker parameter as input, representing the product marker to validate. It returns a Promise that resolves to true if the textual identifier (marker) exists or false if it doesn't.
|
|
@@ -7938,13 +7959,13 @@ const { Templates } = defineOneEntry('your-url');
|
|
|
7938
7959
|
const value = await Templates.getAllTemplates()
|
|
7939
7960
|
```
|
|
7940
7961
|
|
|
7941
|
-
><details>
|
|
7962
|
+
><details><br>
|
|
7942
7963
|
><summary>Schema</summary>
|
|
7943
7964
|
>
|
|
7944
7965
|
>**langCode:** string <br>
|
|
7945
7966
|
>*Optional parameter language code* <br>
|
|
7946
|
-
>example:
|
|
7947
|
-
>
|
|
7967
|
+
>example: en_US <br>
|
|
7968
|
+
><br>
|
|
7948
7969
|
></details>
|
|
7949
7970
|
|
|
7950
7971
|
This method retrieves all template objects grouped by types from the API. It returns a Promise that resolves to an object GroupedTemplatesObject, which contains an array of template objects.
|
|
@@ -7985,7 +8006,7 @@ Example return:
|
|
|
7985
8006
|
}
|
|
7986
8007
|
```
|
|
7987
8008
|
|
|
7988
|
-
><details>
|
|
8009
|
+
><details><br>
|
|
7989
8010
|
><summary>Schema</summary>
|
|
7990
8011
|
>
|
|
7991
8012
|
>**id:** number <br>
|
|
@@ -8016,7 +8037,7 @@ Example return:
|
|
|
8016
8037
|
>**generalTypeName** string <br>
|
|
8017
8038
|
>*example: forProductPreview* <br>
|
|
8018
8039
|
>general type name <br>
|
|
8019
|
-
>
|
|
8040
|
+
><br>
|
|
8020
8041
|
></details>
|
|
8021
8042
|
|
|
8022
8043
|
### Templates.getTemplateByType(type, langCode)
|
|
@@ -8025,7 +8046,7 @@ Example return:
|
|
|
8025
8046
|
const value = await Templates.getTemplateByType('forCatalogProducts')
|
|
8026
8047
|
```
|
|
8027
8048
|
|
|
8028
|
-
><details>
|
|
8049
|
+
><details><br>
|
|
8029
8050
|
><summary>Schema</summary>
|
|
8030
8051
|
>
|
|
8031
8052
|
>**type*:** Types <br>
|
|
@@ -8035,7 +8056,7 @@ const value = await Templates.getTemplateByType('forCatalogProducts')
|
|
|
8035
8056
|
>**langCode:** string <br>
|
|
8036
8057
|
>*Optional parameter language code* <br>
|
|
8037
8058
|
>example: en_US <br>
|
|
8038
|
-
>
|
|
8059
|
+
><br>
|
|
8039
8060
|
></details>
|
|
8040
8061
|
|
|
8041
8062
|
This method retrieves a single template object based on its identifier (id) from the API. It returns a Promise that resolves to a template object.
|
|
@@ -8072,8 +8093,8 @@ Example return:
|
|
|
8072
8093
|
]
|
|
8073
8094
|
```
|
|
8074
8095
|
|
|
8075
|
-
><details>
|
|
8076
|
-
><summary
|
|
8096
|
+
><details><br>
|
|
8097
|
+
><summary>Schema</summary>
|
|
8077
8098
|
>
|
|
8078
8099
|
>**id:** number <br>
|
|
8079
8100
|
>*object identifier* <br>
|
|
@@ -8102,7 +8123,7 @@ Example return:
|
|
|
8102
8123
|
>**generalTypeName** string <br>
|
|
8103
8124
|
>*example: forProductPreview* <br>
|
|
8104
8125
|
>general type name <br>
|
|
8105
|
-
>
|
|
8126
|
+
><br>
|
|
8106
8127
|
></details>
|
|
8107
8128
|
|
|
8108
8129
|
### Templates.getTemplateById(id, langCode)
|
|
@@ -8111,7 +8132,7 @@ Example return:
|
|
|
8111
8132
|
const value = await Templates.getTemplateById(1)
|
|
8112
8133
|
```
|
|
8113
8134
|
|
|
8114
|
-
><details>
|
|
8135
|
+
><details><br>
|
|
8115
8136
|
><summary>Schema</summary>
|
|
8116
8137
|
>
|
|
8117
8138
|
>**id*:** number <br>
|
|
@@ -8121,7 +8142,7 @@ const value = await Templates.getTemplateById(1)
|
|
|
8121
8142
|
>**langCode:** string <br>
|
|
8122
8143
|
>*Optional parameter language code* <br>
|
|
8123
8144
|
>example: en_US <br>
|
|
8124
|
-
>
|
|
8145
|
+
><br>
|
|
8125
8146
|
></details>
|
|
8126
8147
|
|
|
8127
8148
|
This method retrieves a single template object based on its identifier (id) from the API. It returns a Promise that resolves to a template object.
|
|
@@ -8156,8 +8177,8 @@ Example return:
|
|
|
8156
8177
|
}
|
|
8157
8178
|
```
|
|
8158
8179
|
|
|
8159
|
-
><details>
|
|
8160
|
-
><summary
|
|
8180
|
+
><details><br>
|
|
8181
|
+
><summary>Schema</summary>
|
|
8161
8182
|
>
|
|
8162
8183
|
>**id:** number <br>
|
|
8163
8184
|
>*object identifier* <br>
|
|
@@ -8187,7 +8208,7 @@ Example return:
|
|
|
8187
8208
|
>**generalTypeName** string <br>
|
|
8188
8209
|
>*example: forProductPreview* <br>
|
|
8189
8210
|
>general type name <br>
|
|
8190
|
-
>
|
|
8211
|
+
><br>
|
|
8191
8212
|
></details>
|
|
8192
8213
|
|
|
8193
8214
|
### Templates.getTemplateByMarker(marker, langCode)
|
|
@@ -8196,7 +8217,7 @@ Example return:
|
|
|
8196
8217
|
const value = await Templates.getTemplateByMarker('my-marker')
|
|
8197
8218
|
```
|
|
8198
8219
|
|
|
8199
|
-
><details>
|
|
8220
|
+
><details><br>
|
|
8200
8221
|
><summary>Schema</summary>
|
|
8201
8222
|
>
|
|
8202
8223
|
>**marker*:** number <br>
|
|
@@ -8206,7 +8227,7 @@ const value = await Templates.getTemplateByMarker('my-marker')
|
|
|
8206
8227
|
>**langCode:** string <br>
|
|
8207
8228
|
>*Optional parameter language code* <br>
|
|
8208
8229
|
>example: en_US <br>
|
|
8209
|
-
>
|
|
8230
|
+
><br>
|
|
8210
8231
|
></details>
|
|
8211
8232
|
|
|
8212
8233
|
This method retrieves a single template object based on its identifier (marker) from the API. It returns a Promise that resolves to a template object.
|
|
@@ -8241,8 +8262,8 @@ Example return:
|
|
|
8241
8262
|
}
|
|
8242
8263
|
```
|
|
8243
8264
|
|
|
8244
|
-
><details>
|
|
8245
|
-
><summary
|
|
8265
|
+
><details><br>
|
|
8266
|
+
><summary>Schema</summary>
|
|
8246
8267
|
>
|
|
8247
8268
|
>**id:** number <br>
|
|
8248
8269
|
>*object identifier* <br>
|
|
@@ -8271,7 +8292,7 @@ Example return:
|
|
|
8271
8292
|
>**generalTypeName** string <br>
|
|
8272
8293
|
>*example: forProductPreview* <br>
|
|
8273
8294
|
>general type name <br>
|
|
8274
|
-
>
|
|
8295
|
+
><br>
|
|
8275
8296
|
></details>
|
|
8276
8297
|
|
|
8277
8298
|
---
|
|
@@ -8288,13 +8309,13 @@ const { TemplatePreviews } = defineOneEntry('your-url');
|
|
|
8288
8309
|
const value = await TemplatePreviews.getTemplatePreviews()
|
|
8289
8310
|
```
|
|
8290
8311
|
|
|
8291
|
-
><details>
|
|
8312
|
+
><details><br>
|
|
8292
8313
|
><summary>Schema</summary>
|
|
8293
8314
|
>
|
|
8294
8315
|
>**langCode:** string <br>
|
|
8295
8316
|
>*Optional parameter language code* <br>
|
|
8296
8317
|
>example: en_US <br>
|
|
8297
|
-
>
|
|
8318
|
+
><br>
|
|
8298
8319
|
></details>
|
|
8299
8320
|
|
|
8300
8321
|
This method retrieves all template objects from the API. It returns a Promise that resolves to an array of TemplatePreviewsEntity template objects.
|
|
@@ -8350,7 +8371,7 @@ Example return:
|
|
|
8350
8371
|
]
|
|
8351
8372
|
```
|
|
8352
8373
|
|
|
8353
|
-
><details>
|
|
8374
|
+
><details><br>
|
|
8354
8375
|
><summary>Schema</summary>
|
|
8355
8376
|
>
|
|
8356
8377
|
>**id:** number <br>
|
|
@@ -8377,11 +8398,10 @@ Example return:
|
|
|
8377
8398
|
>*position number* <br>
|
|
8378
8399
|
>example: 0 <br>
|
|
8379
8400
|
>
|
|
8380
|
-
>
|
|
8381
8401
|
>**positionId:** number <br>
|
|
8382
8402
|
>*position object identifier* <br>
|
|
8383
8403
|
>example: 12 <br>
|
|
8384
|
-
>
|
|
8404
|
+
><br>
|
|
8385
8405
|
></details>
|
|
8386
8406
|
|
|
8387
8407
|
### TemplatePreviews.getTemplatesPreviewById(id, langCode)
|
|
@@ -8390,7 +8410,7 @@ Example return:
|
|
|
8390
8410
|
const value = await TemplatePreviews.getTemplatePreviewById(1764)
|
|
8391
8411
|
```
|
|
8392
8412
|
|
|
8393
|
-
><details>
|
|
8413
|
+
><details><br>
|
|
8394
8414
|
><summary>Schema</summary>
|
|
8395
8415
|
>
|
|
8396
8416
|
>**id*:** number <br>
|
|
@@ -8400,7 +8420,7 @@ const value = await TemplatePreviews.getTemplatePreviewById(1764)
|
|
|
8400
8420
|
>**langCode:** string <br>
|
|
8401
8421
|
>*Optional parameter language code* <br>
|
|
8402
8422
|
>example: en_US <br>
|
|
8403
|
-
>
|
|
8423
|
+
><br>
|
|
8404
8424
|
></details>
|
|
8405
8425
|
|
|
8406
8426
|
This method retrieves a single template object based on its identifier (id) from the API. It returns a Promise that resolves to a TemplatePreviewsEntity object.
|
|
@@ -8454,8 +8474,8 @@ Example return:
|
|
|
8454
8474
|
}
|
|
8455
8475
|
```
|
|
8456
8476
|
|
|
8457
|
-
><details>
|
|
8458
|
-
><summary
|
|
8477
|
+
><details><br>
|
|
8478
|
+
><summary>Schema</summary>
|
|
8459
8479
|
>
|
|
8460
8480
|
>**id:** number <br>
|
|
8461
8481
|
>*object identifier* <br>
|
|
@@ -8481,11 +8501,10 @@ Example return:
|
|
|
8481
8501
|
>*position number* <br>
|
|
8482
8502
|
>example: 0 <br>
|
|
8483
8503
|
>
|
|
8484
|
-
>
|
|
8485
8504
|
>**positionId:** number <br>
|
|
8486
8505
|
>*position object identifier* <br>
|
|
8487
8506
|
>example: 12 <br>
|
|
8488
|
-
>
|
|
8507
|
+
><br>
|
|
8489
8508
|
></details>
|
|
8490
8509
|
|
|
8491
8510
|
### TemplatePreviews.getTemplatesPreviewByMarker(marker, langCode)
|
|
@@ -8494,7 +8513,7 @@ Example return:
|
|
|
8494
8513
|
const value = await TemplatePreviews.getTemplatePreviewByMarker('my-marker')
|
|
8495
8514
|
```
|
|
8496
8515
|
|
|
8497
|
-
><details>
|
|
8516
|
+
><details><br>
|
|
8498
8517
|
><summary>Schema</summary>
|
|
8499
8518
|
>
|
|
8500
8519
|
>**marker*:** string <br>
|
|
@@ -8504,7 +8523,7 @@ const value = await TemplatePreviews.getTemplatePreviewByMarker('my-marker')
|
|
|
8504
8523
|
>**langCode:** string <br>
|
|
8505
8524
|
>*Optional parameter language code* <br>
|
|
8506
8525
|
>example: en_US <br>
|
|
8507
|
-
>
|
|
8526
|
+
><br>
|
|
8508
8527
|
></details>
|
|
8509
8528
|
|
|
8510
8529
|
This method retrieves a single template object based on its textual identifier (marker) from the API. It returns a Promise that resolves to a TemplatePreviewsEntity object.
|
|
@@ -8556,8 +8575,8 @@ Example return:
|
|
|
8556
8575
|
}
|
|
8557
8576
|
```
|
|
8558
8577
|
|
|
8559
|
-
><details>
|
|
8560
|
-
><summary
|
|
8578
|
+
><details><br>
|
|
8579
|
+
><summary>Schema</summary>
|
|
8561
8580
|
>
|
|
8562
8581
|
>**id:** number <br>
|
|
8563
8582
|
>*object identifier* <br>
|
|
@@ -8583,11 +8602,10 @@ Example return:
|
|
|
8583
8602
|
>*position number* <br>
|
|
8584
8603
|
>example: 0 <br>
|
|
8585
8604
|
>
|
|
8586
|
-
>
|
|
8587
8605
|
>**positionId:** number <br>
|
|
8588
8606
|
>*position object identifier* <br>
|
|
8589
8607
|
>example: 12 <br>
|
|
8590
|
-
>
|
|
8608
|
+
><br>
|
|
8591
8609
|
></details>
|
|
8592
8610
|
|
|
8593
8611
|
---
|
|
@@ -8600,28 +8618,28 @@ An example in which we add information to the user about how many orders he has
|
|
|
8600
8618
|
|
|
8601
8619
|
```js
|
|
8602
8620
|
const data = {
|
|
8603
|
-
|
|
8604
|
-
|
|
8605
|
-
|
|
8606
|
-
|
|
8607
|
-
|
|
8608
|
-
|
|
8609
|
-
|
|
8610
|
-
|
|
8611
|
-
|
|
8612
|
-
|
|
8613
|
-
|
|
8614
|
-
|
|
8615
|
-
}
|
|
8616
|
-
],
|
|
8617
|
-
"notificationData": {
|
|
8618
|
-
"email": "example@oneentry.cloud",
|
|
8619
|
-
"phonePush": ["+99999999999"],
|
|
8620
|
-
"phoneSMS": "+99999999999"
|
|
8621
|
-
},
|
|
8622
|
-
"state": {
|
|
8623
|
-
"orderCount": 1
|
|
8621
|
+
"formIdentifier": "reg",
|
|
8622
|
+
"authData": [
|
|
8623
|
+
{
|
|
8624
|
+
"marker": "password",
|
|
8625
|
+
"value": "12345"
|
|
8626
|
+
}
|
|
8627
|
+
],
|
|
8628
|
+
"formData": [
|
|
8629
|
+
{
|
|
8630
|
+
"marker": "last_name",
|
|
8631
|
+
"type": "string",
|
|
8632
|
+
"value": "Username"
|
|
8624
8633
|
}
|
|
8634
|
+
],
|
|
8635
|
+
"notificationData": {
|
|
8636
|
+
"email": "example@oneentry.cloud",
|
|
8637
|
+
"phonePush": ["+99999999999"],
|
|
8638
|
+
"phoneSMS": "+99999999999"
|
|
8639
|
+
},
|
|
8640
|
+
"state": {
|
|
8641
|
+
"orderCount": 1
|
|
8642
|
+
}
|
|
8625
8643
|
}
|
|
8626
8644
|
|
|
8627
8645
|
const value = await Users.updateUser(data)
|
|
@@ -8645,13 +8663,13 @@ const { Users } = defineOneEntry('your-url');
|
|
|
8645
8663
|
const value = await Users.getUser()
|
|
8646
8664
|
```
|
|
8647
8665
|
|
|
8648
|
-
><details>
|
|
8666
|
+
><details><br>
|
|
8649
8667
|
><summary>Schema</summary>
|
|
8650
8668
|
>
|
|
8651
8669
|
>**langCode:** string <br>
|
|
8652
8670
|
>*lang code* <br>
|
|
8653
8671
|
>example: en_US <br>
|
|
8654
|
-
>
|
|
8672
|
+
><br>
|
|
8655
8673
|
></details>
|
|
8656
8674
|
|
|
8657
8675
|
This method sends a request to get the data of an authorized user. Returns the authorized user's data object.
|
|
@@ -8673,7 +8691,7 @@ Example return:
|
|
|
8673
8691
|
}
|
|
8674
8692
|
```
|
|
8675
8693
|
|
|
8676
|
-
><details>
|
|
8694
|
+
><details><br>
|
|
8677
8695
|
><summary>Schema</summary>
|
|
8678
8696
|
>
|
|
8679
8697
|
>**id:** number <br>
|
|
@@ -8695,7 +8713,7 @@ Example return:
|
|
|
8695
8713
|
>**groups** string[] <br>
|
|
8696
8714
|
>*An array of values for the text identifiers of the groups that the user belongs to* <br>
|
|
8697
8715
|
>example: List [ "group_1" ] <br>
|
|
8698
|
-
>
|
|
8716
|
+
><br>
|
|
8699
8717
|
></details>
|
|
8700
8718
|
|
|
8701
8719
|
### Users.updateUser(body, langCode)
|
|
@@ -8729,7 +8747,7 @@ const body = {
|
|
|
8729
8747
|
const value = await Users.updateUser(body)
|
|
8730
8748
|
```
|
|
8731
8749
|
|
|
8732
|
-
><details>
|
|
8750
|
+
><details><br>
|
|
8733
8751
|
><summary>Schema</summary>
|
|
8734
8752
|
>
|
|
8735
8753
|
>**body*:** object <br>
|
|
@@ -8739,13 +8757,13 @@ const value = await Users.updateUser(body)
|
|
|
8739
8757
|
>**langCode:** string <br>
|
|
8740
8758
|
>*Optional language field* <br>
|
|
8741
8759
|
>example: en_US <br>
|
|
8742
|
-
>
|
|
8760
|
+
><br>
|
|
8743
8761
|
></details>
|
|
8744
8762
|
|
|
8745
8763
|
<br>
|
|
8746
8764
|
|
|
8747
|
-
><details>
|
|
8748
|
-
><summary
|
|
8765
|
+
><details><br>
|
|
8766
|
+
><summary>Schema (body)</summary>
|
|
8749
8767
|
>
|
|
8750
8768
|
>**formIdentifier** string <br>
|
|
8751
8769
|
>*the text identifier of the form linked to the authorization provider* <br>
|
|
@@ -8762,7 +8780,7 @@ const value = await Users.updateUser(body)
|
|
|
8762
8780
|
>**notificationData** UserNotificationDataType <br>
|
|
8763
8781
|
>*Data for notifying the user* <br>
|
|
8764
8782
|
>example: OrderedMap { "email": "<example@oneentry.cloud>", "phonePush": "", "phoneSMS": "+9999999999" } <br>
|
|
8765
|
-
>
|
|
8783
|
+
><br>
|
|
8766
8784
|
></details>
|
|
8767
8785
|
|
|
8768
8786
|
This method updates the authorized user's data object. Returns true (in case of successful update) or false (in case of unsuccessful update).
|
|
@@ -8779,7 +8797,7 @@ true
|
|
|
8779
8797
|
const value = await Users.deleteUser(body)
|
|
8780
8798
|
```
|
|
8781
8799
|
|
|
8782
|
-
><details>
|
|
8800
|
+
><details><br>
|
|
8783
8801
|
><summary>Schema</summary>
|
|
8784
8802
|
>
|
|
8785
8803
|
>**body*:** object <br>
|
|
@@ -8789,7 +8807,7 @@ const value = await Users.deleteUser(body)
|
|
|
8789
8807
|
>**langCode:** string <br>
|
|
8790
8808
|
>*Optional language field* <br>
|
|
8791
8809
|
>example: en_US <br>
|
|
8792
|
-
>
|
|
8810
|
+
><br>
|
|
8793
8811
|
></details>
|
|
8794
8812
|
|
|
8795
8813
|
### Users.addFCMToken(token)
|
|
@@ -8798,13 +8816,13 @@ const value = await Users.deleteUser(body)
|
|
|
8798
8816
|
const value = await Users.addFCMToken('my-token')
|
|
8799
8817
|
```
|
|
8800
8818
|
|
|
8801
|
-
><details>
|
|
8819
|
+
><details><br>
|
|
8802
8820
|
><summary>Schema</summary>
|
|
8803
8821
|
>
|
|
8804
8822
|
>**token*:** string <br>
|
|
8805
8823
|
>*Cloud messaging token* <br>
|
|
8806
8824
|
>example: xxxx-xxxxx-xxxxx <br>
|
|
8807
|
-
>
|
|
8825
|
+
><br>
|
|
8808
8826
|
></details>
|
|
8809
8827
|
|
|
8810
8828
|
This method adds FCM token for sending Push notifications. Return true in case of successful token update.
|
|
@@ -8821,13 +8839,13 @@ true
|
|
|
8821
8839
|
const value = await Users.deleteFCMToken('my-token')
|
|
8822
8840
|
```
|
|
8823
8841
|
|
|
8824
|
-
><details>
|
|
8842
|
+
><details><br>
|
|
8825
8843
|
><summary>Schema</summary>
|
|
8826
8844
|
>
|
|
8827
8845
|
>**token*:** string <br>
|
|
8828
8846
|
>*Cloud messaging token* <br>
|
|
8829
8847
|
>example: xxxx-xxxxx-xxxxx <br>
|
|
8830
|
-
>
|
|
8848
|
+
><br>
|
|
8831
8849
|
></details>
|
|
8832
8850
|
|
|
8833
8851
|
This method delete FCM token for sending Push notifications. Return true in case of successful token deletion.
|
|
@@ -8879,17 +8897,17 @@ Example:
|
|
|
8879
8897
|
}
|
|
8880
8898
|
```
|
|
8881
8899
|
|
|
8882
|
-
><details>
|
|
8883
|
-
><summary
|
|
8900
|
+
><details><br>
|
|
8901
|
+
><summary>Schema</summary>
|
|
8884
8902
|
>
|
|
8885
8903
|
>**message** string <br>
|
|
8886
8904
|
>*Text message* <br>
|
|
8887
8905
|
>example: Message <br>
|
|
8888
8906
|
>
|
|
8889
8907
|
>**attributes:** Record<string, any> <br>
|
|
8890
|
-
|
|
8908
|
+
>*Contains event attributes* <br>
|
|
8891
8909
|
>example: { { "company": { "identifier": "company", "type": "string", "value": "OneEntry" } }}<br>
|
|
8892
|
-
>
|
|
8910
|
+
><br>
|
|
8893
8911
|
></details>
|
|
8894
8912
|
|
|
8895
8913
|
Product Example:
|