oneentry 1.0.114 → 1.0.116
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 +444 -48
- package/dist/admins/adminsInterfaces.d.ts +2 -2
- package/dist/attribute-sets/attributeSetsInterfaces.d.ts +9 -4
- package/dist/integration-collections/integrationCollectionsApi.d.ts +9 -0
- package/dist/integration-collections/integrationCollectionsApi.js +12 -0
- package/dist/integration-collections/integrationCollectionsInterfaces.d.ts +2 -0
- package/dist/payments/paymentsApi.d.ts +20 -0
- package/dist/payments/paymentsApi.js +23 -0
- package/dist/product-statuses/productStatusesInterfaces.d.ts +1 -0
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -244,6 +244,8 @@ const body = [
|
|
|
244
244
|
|
|
245
245
|
### Admins.getAdminsInfo(body, langCode, offset, limit)
|
|
246
246
|
|
|
247
|
+
Getting all objects of user-admins
|
|
248
|
+
|
|
247
249
|
```js
|
|
248
250
|
const value = await Admins.getAdminsInfo();
|
|
249
251
|
```
|
|
@@ -321,7 +323,7 @@ Example return:
|
|
|
321
323
|
><br>
|
|
322
324
|
></details>
|
|
323
325
|
|
|
324
|
-
#### Additional examples
|
|
326
|
+
#### Additional examples
|
|
325
327
|
|
|
326
328
|
Get admins with lang en_US
|
|
327
329
|
|
|
@@ -355,10 +357,13 @@ const result = await Admins.getAdminsInfo(body, 'en_US', 0, 30);
|
|
|
355
357
|
```js
|
|
356
358
|
const { AttributesSets } = defineOneEntry('your-url');
|
|
357
359
|
```
|
|
360
|
+
|
|
358
361
|
<br>
|
|
359
362
|
|
|
360
363
|
### AttributesSets.getAttributes(langCode, offset, limit, typeId, sortBy)
|
|
361
364
|
|
|
365
|
+
> Getting all attribute set objects
|
|
366
|
+
|
|
362
367
|
```js
|
|
363
368
|
const value = await AttributesSets.getAttributes()
|
|
364
369
|
```
|
|
@@ -480,6 +485,8 @@ Example return:
|
|
|
480
485
|
|
|
481
486
|
### AttributesSets.getAttributesByMarker(marker, langCode)
|
|
482
487
|
|
|
488
|
+
> Getting all attributes with data from the attribute set
|
|
489
|
+
|
|
483
490
|
```js
|
|
484
491
|
const value = await AttributesSets.getAttributesByMarker('my-marker')
|
|
485
492
|
```
|
|
@@ -591,6 +598,8 @@ Example return:
|
|
|
591
598
|
|
|
592
599
|
### AttributesSets.getSingleAttributeByMarkerSet(attributeMarker, setMarker, langCode)
|
|
593
600
|
|
|
601
|
+
> Getting one attribute with data from the attribute set
|
|
602
|
+
|
|
594
603
|
```js
|
|
595
604
|
const value = await AttributesSets.getSingleAttributeByMarkerSet('list1', 'list1')
|
|
596
605
|
```
|
|
@@ -688,6 +697,8 @@ Example return:
|
|
|
688
697
|
|
|
689
698
|
### AttributesSets.getAttributeSetByMarker(marker, langCode)
|
|
690
699
|
|
|
700
|
+
Getting a single object of attributes set by marker
|
|
701
|
+
|
|
691
702
|
```js
|
|
692
703
|
const value = await AttributesSets.getAttributeSetByMarker('my-marker')
|
|
693
704
|
```
|
|
@@ -788,6 +799,8 @@ const { AuthProvider } = defineOneEntry('your-url');
|
|
|
788
799
|
|
|
789
800
|
### AuthProvider.signUp(marker, body, langCode)
|
|
790
801
|
|
|
802
|
+
User registration (❗️For provider with user activation, activation code is sent through corresponding user notification method)
|
|
803
|
+
|
|
791
804
|
><details><br>
|
|
792
805
|
><summary>Schema</summary>
|
|
793
806
|
>
|
|
@@ -822,10 +835,10 @@ const { AuthProvider } = defineOneEntry('your-url');
|
|
|
822
835
|
"phoneSMS": "+99999999999"
|
|
823
836
|
}
|
|
824
837
|
}
|
|
825
|
-
|
|
838
|
+
><br>
|
|
826
839
|
>
|
|
827
840
|
>**langCode:** string <br>
|
|
828
|
-
>*
|
|
841
|
+
>*Language code* <br>
|
|
829
842
|
>example: en_US <br>
|
|
830
843
|
><br>
|
|
831
844
|
></details>
|
|
@@ -1404,6 +1417,8 @@ Example return:
|
|
|
1404
1417
|
|
|
1405
1418
|
### AuthProvider.generateCode(marker, userIdentifier, eventIdentifier)
|
|
1406
1419
|
|
|
1420
|
+
Getting the code to activate the user
|
|
1421
|
+
|
|
1407
1422
|
```js
|
|
1408
1423
|
const value = await AuthProvider.generateCode('email', 'example@oneentry.cloud', 'auth')
|
|
1409
1424
|
```
|
|
@@ -1429,8 +1444,10 @@ This method receives a code to activate the user. Code is returned through the c
|
|
|
1429
1444
|
|
|
1430
1445
|
### AuthProvider.checkCode(marker, userIdentifier, code)
|
|
1431
1446
|
|
|
1447
|
+
Checking the user activation code
|
|
1448
|
+
|
|
1432
1449
|
```js
|
|
1433
|
-
const value = await AuthProvider.checkCode('email', 'example@oneentry.cloud', 'WTGC9E')
|
|
1450
|
+
const value = await AuthProvider.checkCode('email', 'example@oneentry.cloud', 'auth', 'WTGC9E')
|
|
1434
1451
|
```
|
|
1435
1452
|
|
|
1436
1453
|
><details><br>
|
|
@@ -1464,6 +1481,8 @@ true
|
|
|
1464
1481
|
|
|
1465
1482
|
### AuthProvider.activateUser(marker, userIdentifier, code)
|
|
1466
1483
|
|
|
1484
|
+
User activation
|
|
1485
|
+
|
|
1467
1486
|
```js
|
|
1468
1487
|
const value = await AuthProvider.activateUser('email', 'example@oneentry.cloud', 'WTGC9E')
|
|
1469
1488
|
```
|
|
@@ -1495,6 +1514,8 @@ true
|
|
|
1495
1514
|
|
|
1496
1515
|
### AuthProvider.auth(marker, data)
|
|
1497
1516
|
|
|
1517
|
+
User authentication
|
|
1518
|
+
|
|
1498
1519
|
```js
|
|
1499
1520
|
const data = {
|
|
1500
1521
|
authData: [
|
|
@@ -1572,6 +1593,8 @@ Example return:
|
|
|
1572
1593
|
|
|
1573
1594
|
### AuthProvider.refresh(marker, token)
|
|
1574
1595
|
|
|
1596
|
+
Update user tokens
|
|
1597
|
+
|
|
1575
1598
|
```js
|
|
1576
1599
|
const value = await AuthProvider.refresh('email', '1714557670334-cb85112d-618d-4b2a-bad5-137b19c135b9')
|
|
1577
1600
|
```
|
|
@@ -1625,6 +1648,8 @@ Example return:
|
|
|
1625
1648
|
|
|
1626
1649
|
### AuthProvider.logout(marker, token)
|
|
1627
1650
|
|
|
1651
|
+
User account logout 🔐 This method requires authorization.
|
|
1652
|
+
|
|
1628
1653
|
```js
|
|
1629
1654
|
const value = await AuthProvider.logout('email', '1714557670334-cb85112d-618d-4b2a-bad5-137b19c135b9')
|
|
1630
1655
|
```
|
|
@@ -1652,6 +1677,8 @@ true
|
|
|
1652
1677
|
|
|
1653
1678
|
### AuthProvider.changePassword(marker, userIdentifier, type, code, newPassword, repeatPassword)
|
|
1654
1679
|
|
|
1680
|
+
User password change (only for activated account tariffs with Activation feature enabled)
|
|
1681
|
+
|
|
1655
1682
|
```js
|
|
1656
1683
|
const value = await AuthProvider.changePassword('email', 'example@oneentry.cloud', 1, 'EW32RF', 654321, 654321)
|
|
1657
1684
|
```
|
|
@@ -1695,6 +1722,8 @@ true
|
|
|
1695
1722
|
|
|
1696
1723
|
### AuthProvider.getAuthProviders(langCode, offset, limit)
|
|
1697
1724
|
|
|
1725
|
+
Get all auth providers objects
|
|
1726
|
+
|
|
1698
1727
|
```js
|
|
1699
1728
|
const value = await AuthProvider.getAuthProviders()
|
|
1700
1729
|
```
|
|
@@ -1785,6 +1814,8 @@ Example return:
|
|
|
1785
1814
|
|
|
1786
1815
|
### AuthProvider.getMarker(marker, langCode)
|
|
1787
1816
|
|
|
1817
|
+
Get one auth provider object by marker
|
|
1818
|
+
|
|
1788
1819
|
```js
|
|
1789
1820
|
const value = await AuthProvider.getMarker('email')
|
|
1790
1821
|
```
|
|
@@ -1802,8 +1833,6 @@ const value = await AuthProvider.getMarker('email')
|
|
|
1802
1833
|
><br>
|
|
1803
1834
|
></details>
|
|
1804
1835
|
|
|
1805
|
-
Getting a single token authorization provider object.
|
|
1806
|
-
|
|
1807
1836
|
Example return:
|
|
1808
1837
|
|
|
1809
1838
|
```json
|
|
@@ -1877,6 +1906,8 @@ const { Blocks } = defineOneEntry('your-url');
|
|
|
1877
1906
|
|
|
1878
1907
|
### Blocks.getBlocks(type, langCode, offset, limit)
|
|
1879
1908
|
|
|
1909
|
+
Getting all block objects
|
|
1910
|
+
|
|
1880
1911
|
```js
|
|
1881
1912
|
const value = await Blocks.getBlocks('forTextBlock')
|
|
1882
1913
|
```
|
|
@@ -1983,6 +2014,8 @@ Example return:
|
|
|
1983
2014
|
|
|
1984
2015
|
### Blocks.getBlockByMarker(marker, langCode, offset, limit)
|
|
1985
2016
|
|
|
2017
|
+
Getting a single block object by marker
|
|
2018
|
+
|
|
1986
2019
|
```js
|
|
1987
2020
|
const value = await Blocks.getBlockByMarker('my-marker')
|
|
1988
2021
|
```
|
|
@@ -2136,6 +2169,8 @@ example: OrderedMap { "sliderDelay": 0, "sliderDelayType": "", "productConfig":
|
|
|
2136
2169
|
|
|
2137
2170
|
### Blocks.searchBlock(name, langCode)
|
|
2138
2171
|
|
|
2172
|
+
Speedy search for limited display of block objects
|
|
2173
|
+
|
|
2139
2174
|
```js
|
|
2140
2175
|
const value = await Blocks.searchBlock('my-marker')
|
|
2141
2176
|
```
|
|
@@ -2177,6 +2212,8 @@ const { Events } = defineOneEntry('your-url');
|
|
|
2177
2212
|
|
|
2178
2213
|
### Events.getAllSubscriptions(offset, limit)
|
|
2179
2214
|
|
|
2215
|
+
Returns all subscriptions to products 🔐 This method requires authorization.
|
|
2216
|
+
|
|
2180
2217
|
```js
|
|
2181
2218
|
const value = await Events.getAllSubscriptions()
|
|
2182
2219
|
```
|
|
@@ -2226,6 +2263,8 @@ Example return:
|
|
|
2226
2263
|
|
|
2227
2264
|
### Events.subscribeByMarker(marker, userId, productId)
|
|
2228
2265
|
|
|
2266
|
+
Subscribe to an event on a product 🔐 This method requires authorization.
|
|
2267
|
+
|
|
2229
2268
|
```js
|
|
2230
2269
|
const value = await Events.subscribeByMarker('test_event', 1, 1)
|
|
2231
2270
|
```
|
|
@@ -2255,6 +2294,8 @@ This method subscribes to the product event. Returns nothing if the subscription
|
|
|
2255
2294
|
|
|
2256
2295
|
### Events.unsubscribeByMarker(marker, userId, productId)
|
|
2257
2296
|
|
|
2297
|
+
Unsubscribe from events on a product 🔐 This method requires authorization.
|
|
2298
|
+
|
|
2258
2299
|
```js
|
|
2259
2300
|
const value = await Events.unsubscribeByMarker('test_event', 1, 1)
|
|
2260
2301
|
```
|
|
@@ -2292,6 +2333,8 @@ const { FileUploading } = defineOneEntry('your-url');
|
|
|
2292
2333
|
|
|
2293
2334
|
### FileUploading.upload(data, fileQuery)
|
|
2294
2335
|
|
|
2336
|
+
File upload
|
|
2337
|
+
|
|
2295
2338
|
```js
|
|
2296
2339
|
const query = {
|
|
2297
2340
|
type:"page",
|
|
@@ -2339,6 +2382,10 @@ const value = await FileUploading.upload(data, query)
|
|
|
2339
2382
|
>**fileQuery.compress** boolean <br>
|
|
2340
2383
|
>*Optional flag of optimization (compression) for images* <br>
|
|
2341
2384
|
>example: true <br>
|
|
2385
|
+
>
|
|
2386
|
+
>**fileQuery.template** string <br>
|
|
2387
|
+
>*preview template identifier* <br>
|
|
2388
|
+
>example: 1 <br>
|
|
2342
2389
|
><br>
|
|
2343
2390
|
></details>
|
|
2344
2391
|
|
|
@@ -2376,6 +2423,8 @@ Example return:
|
|
|
2376
2423
|
|
|
2377
2424
|
### FileUploading.delete(filename, fileQuery)
|
|
2378
2425
|
|
|
2426
|
+
File deletion
|
|
2427
|
+
|
|
2379
2428
|
```js
|
|
2380
2429
|
const query = {
|
|
2381
2430
|
type:"page",
|
|
@@ -2408,6 +2457,10 @@ const value = await FileUploading.delete("file.png", query)
|
|
|
2408
2457
|
>**fileQuery.id** number <br>
|
|
2409
2458
|
>*Identifier of the object from which the file is uploaded, determines the folder name in the storage* <br>
|
|
2410
2459
|
>example: 3787 <br>
|
|
2460
|
+
>
|
|
2461
|
+
>**fileQuery.template** string <br>
|
|
2462
|
+
>*preview template identifier* <br>
|
|
2463
|
+
>example: 1 <br>
|
|
2411
2464
|
><br>
|
|
2412
2465
|
></details>
|
|
2413
2466
|
|
|
@@ -2415,6 +2468,8 @@ This void method delete a file from the cloud file storage.
|
|
|
2415
2468
|
|
|
2416
2469
|
### FileUploading.getFile(id, type, entity, filename)
|
|
2417
2470
|
|
|
2471
|
+
File search
|
|
2472
|
+
|
|
2418
2473
|
```js
|
|
2419
2474
|
const value = await FileUploading.getFile(123, 'page', 'editor', 'file.png')
|
|
2420
2475
|
```
|
|
@@ -2437,6 +2492,10 @@ const value = await FileUploading.getFile(123, 'page', 'editor', 'file.png')
|
|
|
2437
2492
|
>**filename:** string <br>
|
|
2438
2493
|
>*Filename* <br>
|
|
2439
2494
|
>example: file.png <br>
|
|
2495
|
+
>
|
|
2496
|
+
>**template:** string <br>
|
|
2497
|
+
>*preview template identifier* <br>
|
|
2498
|
+
>example: 1 <br>
|
|
2440
2499
|
><br>
|
|
2441
2500
|
></details>
|
|
2442
2501
|
|
|
@@ -2460,6 +2519,8 @@ const { Forms } = defineOneEntry('your-url');
|
|
|
2460
2519
|
|
|
2461
2520
|
### Forms.getAllForms(langCode, offset, limit)
|
|
2462
2521
|
|
|
2522
|
+
Get all form objects
|
|
2523
|
+
|
|
2463
2524
|
```js
|
|
2464
2525
|
const value = await Forms.getAllForms()
|
|
2465
2526
|
```
|
|
@@ -2585,6 +2646,8 @@ Example return:
|
|
|
2585
2646
|
|
|
2586
2647
|
### Forms.getFormByMarker(marker, langCode)
|
|
2587
2648
|
|
|
2649
|
+
Getting one form object by marker
|
|
2650
|
+
|
|
2588
2651
|
```js
|
|
2589
2652
|
const value = await Forms.getFormByMarker('my-form')
|
|
2590
2653
|
```
|
|
@@ -2889,6 +2952,8 @@ Example with attribute type "entity" (nested list)
|
|
|
2889
2952
|
|
|
2890
2953
|
### FormData.getFormsData(langCode, offset, limit)
|
|
2891
2954
|
|
|
2955
|
+
Creating an object of form data saving information
|
|
2956
|
+
|
|
2892
2957
|
```js
|
|
2893
2958
|
const value = await FormData.getFormsData()
|
|
2894
2959
|
```
|
|
@@ -2964,6 +3029,8 @@ Example return:
|
|
|
2964
3029
|
|
|
2965
3030
|
### FormData.postFormsData(data, langCode)
|
|
2966
3031
|
|
|
3032
|
+
Searching for all form data
|
|
3033
|
+
|
|
2967
3034
|
```js
|
|
2968
3035
|
const body = {
|
|
2969
3036
|
"formIdentifier": "reg",
|
|
@@ -3042,6 +3109,8 @@ Example return:
|
|
|
3042
3109
|
|
|
3043
3110
|
### FormData.getFormsDataByMarker(marker, langCode, offset, limit)
|
|
3044
3111
|
|
|
3112
|
+
Searching for form data by text identifier (marker)
|
|
3113
|
+
|
|
3045
3114
|
```js
|
|
3046
3115
|
const value = await FormData.getFormsDataByMarker('my-marker')
|
|
3047
3116
|
```
|
|
@@ -3130,6 +3199,8 @@ const { GeneralTypes } = defineOneEntry('your-url');
|
|
|
3130
3199
|
|
|
3131
3200
|
### GeneralTypes.getAllTypes()
|
|
3132
3201
|
|
|
3202
|
+
Getting all types
|
|
3203
|
+
|
|
3133
3204
|
```js
|
|
3134
3205
|
const value = await GeneralTypes.getAllTypes()
|
|
3135
3206
|
```
|
|
@@ -3172,6 +3243,8 @@ const { IntegrationCollections } = defineOneEntry('your-url');
|
|
|
3172
3243
|
|
|
3173
3244
|
### IntegrationCollections.getICollections(langCode, userQuery)
|
|
3174
3245
|
|
|
3246
|
+
Getting all collections
|
|
3247
|
+
|
|
3175
3248
|
```js
|
|
3176
3249
|
const result = await IntegrationCollections.getICollections();
|
|
3177
3250
|
```
|
|
@@ -3251,6 +3324,8 @@ Example return:
|
|
|
3251
3324
|
|
|
3252
3325
|
### IntegrationCollections.getICollectionById(id, langCode)
|
|
3253
3326
|
|
|
3327
|
+
Get collection by id.
|
|
3328
|
+
|
|
3254
3329
|
```js
|
|
3255
3330
|
const result = await IntegrationCollections.getICollectionById(1);
|
|
3256
3331
|
```
|
|
@@ -3268,8 +3343,6 @@ const result = await IntegrationCollections.getICollectionById(1);
|
|
|
3268
3343
|
><br>
|
|
3269
3344
|
></details>
|
|
3270
3345
|
|
|
3271
|
-
Get collection by id.
|
|
3272
|
-
|
|
3273
3346
|
Example return:
|
|
3274
3347
|
|
|
3275
3348
|
```json
|
|
@@ -3321,6 +3394,8 @@ Example return:
|
|
|
3321
3394
|
|
|
3322
3395
|
### IntegrationCollections.getICollectionRowsById(id, langCode, userQuery)
|
|
3323
3396
|
|
|
3397
|
+
Get all records belonging to the collection by collection id.
|
|
3398
|
+
|
|
3324
3399
|
```js
|
|
3325
3400
|
const result = await IntegrationCollections.getICollectionRowsById(1);
|
|
3326
3401
|
```
|
|
@@ -3339,6 +3414,14 @@ const result = await IntegrationCollections.getICollectionRowsById(1);
|
|
|
3339
3414
|
>**userQuery:** any <br>
|
|
3340
3415
|
>*Optional set query parameters* <br>
|
|
3341
3416
|
>
|
|
3417
|
+
>**userQuery.entityType:** any <br>
|
|
3418
|
+
>*Entity type* <br>
|
|
3419
|
+
>example: 1 <br>
|
|
3420
|
+
>
|
|
3421
|
+
>**userQuery.entityId:** any <br>
|
|
3422
|
+
>*Entity identifier* <br>
|
|
3423
|
+
>example: orders <br>
|
|
3424
|
+
>
|
|
3342
3425
|
>**userQuery.offset:** number <br>
|
|
3343
3426
|
>*Optional parameter for pagination, default is 0* <br>
|
|
3344
3427
|
>example: 0 <br>
|
|
@@ -3349,8 +3432,6 @@ const result = await IntegrationCollections.getICollectionRowsById(1);
|
|
|
3349
3432
|
><br>
|
|
3350
3433
|
></details>
|
|
3351
3434
|
|
|
3352
|
-
Get all records belonging to the collection by collection id.
|
|
3353
|
-
|
|
3354
3435
|
Example return:
|
|
3355
3436
|
|
|
3356
3437
|
```json
|
|
@@ -3359,15 +3440,18 @@ Example return:
|
|
|
3359
3440
|
"items": [
|
|
3360
3441
|
{
|
|
3361
3442
|
"id": 1764,
|
|
3362
|
-
"
|
|
3363
|
-
|
|
3364
|
-
"
|
|
3443
|
+
"formData": [
|
|
3444
|
+
{
|
|
3445
|
+
"marker": "naimenovanie_1",
|
|
3446
|
+
"type": "string",
|
|
3447
|
+
"value": "Name"
|
|
3365
3448
|
}
|
|
3366
|
-
|
|
3367
|
-
"
|
|
3368
|
-
"
|
|
3369
|
-
"
|
|
3370
|
-
"
|
|
3449
|
+
],
|
|
3450
|
+
"attributeSetIdentifier": "collection_form",
|
|
3451
|
+
"createdDate": "2025-03-02T16:17:23.970Z",
|
|
3452
|
+
"updatedDate": "2025-03-02T16:17:23.970Z",
|
|
3453
|
+
"entityType": "orders",
|
|
3454
|
+
"entityId": 1
|
|
3371
3455
|
}
|
|
3372
3456
|
]
|
|
3373
3457
|
}
|
|
@@ -3387,33 +3471,37 @@ Example return:
|
|
|
3387
3471
|
>*Object identifier* <br>
|
|
3388
3472
|
>example: 1764 <br>
|
|
3389
3473
|
>
|
|
3390
|
-
>**
|
|
3391
|
-
>*
|
|
3392
|
-
>example: OrderedMap { "
|
|
3474
|
+
>**formData*:** FormDataType <br>
|
|
3475
|
+
>*data submitted by the form attached to the collection* <br>
|
|
3476
|
+
>example: List [ OrderedMap { "marker": "naimenovanie_1", "type": "string", "value": "Name" } ] <br>
|
|
3393
3477
|
>
|
|
3394
|
-
>**
|
|
3395
|
-
>*
|
|
3396
|
-
>example:
|
|
3397
|
-
>default: marker <br>
|
|
3478
|
+
>**attributeSetIdentifier:** string <br>
|
|
3479
|
+
>*text identifier of the attribute set used* <br>
|
|
3480
|
+
>example: collection_form <br>
|
|
3398
3481
|
>
|
|
3399
|
-
>**
|
|
3400
|
-
>*
|
|
3401
|
-
>example:
|
|
3402
|
-
>default: <br>
|
|
3482
|
+
>**createdDate:** string($date-time) <br>
|
|
3483
|
+
>*date of record creation in the collection* <br>
|
|
3484
|
+
>example: 2025-03-02T16:17:23.970Z <br>
|
|
3403
3485
|
>
|
|
3404
|
-
>**
|
|
3405
|
-
>*
|
|
3486
|
+
>**updatedDate:** string($date-time) <br>
|
|
3487
|
+
>*date of record update in the collection* <br>
|
|
3488
|
+
>example: 2025-03-02T16:17:23.970Z <br>
|
|
3489
|
+
>
|
|
3490
|
+
>**entityType:** string <br>
|
|
3491
|
+
>*record type* <br>
|
|
3492
|
+
>example: orders <br>
|
|
3493
|
+
>
|
|
3494
|
+
>**entityId:** number <br>
|
|
3495
|
+
>*record identifier* <br>
|
|
3406
3496
|
>example: 1 <br>
|
|
3407
|
-
>default: <br>
|
|
3408
3497
|
>
|
|
3409
|
-
>**selectedAttributeMarkers:** string <br>
|
|
3410
|
-
>*Text identifiers of form object attributes for display in the data table* <br>
|
|
3411
|
-
>example: marker1, marker2 <br>
|
|
3412
3498
|
><br>
|
|
3413
3499
|
></details>
|
|
3414
3500
|
|
|
3415
3501
|
### IntegrationCollections.validateICollectionMarker(marker)
|
|
3416
3502
|
|
|
3503
|
+
Check for the existence of a text identifier (marker)
|
|
3504
|
+
|
|
3417
3505
|
```js
|
|
3418
3506
|
const result = await IntegrationCollections.validateICollectionMarker('test_collection');
|
|
3419
3507
|
```
|
|
@@ -3427,8 +3515,6 @@ const result = await IntegrationCollections.validateICollectionMarker('test_coll
|
|
|
3427
3515
|
><br>
|
|
3428
3516
|
></details>
|
|
3429
3517
|
|
|
3430
|
-
Check for the existence of a text identifier (marker)
|
|
3431
|
-
|
|
3432
3518
|
Example return:
|
|
3433
3519
|
|
|
3434
3520
|
```json
|
|
@@ -3446,8 +3532,63 @@ Example return:
|
|
|
3446
3532
|
><br>
|
|
3447
3533
|
></details>
|
|
3448
3534
|
|
|
3535
|
+
### IntegrationCollections.getICollectionRowsByMarker(marker, langCode)
|
|
3536
|
+
|
|
3537
|
+
Getting all records from the collection.
|
|
3538
|
+
|
|
3539
|
+
```js
|
|
3540
|
+
const result = await IntegrationCollections.getICollectionRowsByMarker('test_collection');
|
|
3541
|
+
```
|
|
3542
|
+
|
|
3543
|
+
><details><br>
|
|
3544
|
+
><summary>Schema</summary>
|
|
3545
|
+
>
|
|
3546
|
+
>**marker*:** string <br>
|
|
3547
|
+
>*Collection text identifier* <br>
|
|
3548
|
+
>example: test_collection <br>
|
|
3549
|
+
>
|
|
3550
|
+
>**langCode:** string <br>
|
|
3551
|
+
>*Language code* <br>
|
|
3552
|
+
>example: en_US <br>
|
|
3553
|
+
><br>
|
|
3554
|
+
></details>
|
|
3555
|
+
|
|
3556
|
+
Example return:
|
|
3557
|
+
|
|
3558
|
+
```json
|
|
3559
|
+
{
|
|
3560
|
+
"items": [
|
|
3561
|
+
{
|
|
3562
|
+
"id": 2,
|
|
3563
|
+
"entityId": null,
|
|
3564
|
+
"entityType": null,
|
|
3565
|
+
"createdDate": "2025-01-30T01:28:19.906Z",
|
|
3566
|
+
"updatedDate": "2025-01-30T01:28:19.906Z",
|
|
3567
|
+
"formData": [{ "marker": "c_marker", "type": "string", "value": "Value" }],
|
|
3568
|
+
"attributeSetIdentifier": null,
|
|
3569
|
+
},
|
|
3570
|
+
],
|
|
3571
|
+
"total": 1,
|
|
3572
|
+
}
|
|
3573
|
+
```
|
|
3574
|
+
|
|
3575
|
+
><details><br>
|
|
3576
|
+
><summary>Schema</summary>
|
|
3577
|
+
>
|
|
3578
|
+
>**total:** number <br>
|
|
3579
|
+
>*Total number of found records* <br>
|
|
3580
|
+
>example: 100 <br>
|
|
3581
|
+
>
|
|
3582
|
+
>**items:** ICollectionRow[] <br>
|
|
3583
|
+
>*Object identifier* <br>
|
|
3584
|
+
>example: 2 <br>
|
|
3585
|
+
>
|
|
3586
|
+
></details>
|
|
3587
|
+
|
|
3449
3588
|
### IntegrationCollections.getICollectionRowByMarkerAndId(marker, id, langCode)
|
|
3450
3589
|
|
|
3590
|
+
Getting one record from the collection.
|
|
3591
|
+
|
|
3451
3592
|
```js
|
|
3452
3593
|
const result = await IntegrationCollections.getICollectionRowByMarkerAndId('test_collection', 1);
|
|
3453
3594
|
```
|
|
@@ -3469,8 +3610,6 @@ const result = await IntegrationCollections.getICollectionRowByMarkerAndId('test
|
|
|
3469
3610
|
><br>
|
|
3470
3611
|
></details>
|
|
3471
3612
|
|
|
3472
|
-
Getting one record from the collection.
|
|
3473
|
-
|
|
3474
3613
|
Example return:
|
|
3475
3614
|
|
|
3476
3615
|
```json
|
|
@@ -3521,6 +3660,8 @@ Example return:
|
|
|
3521
3660
|
|
|
3522
3661
|
### IntegrationCollections.createICollectionRow(marker, body, langCode)
|
|
3523
3662
|
|
|
3663
|
+
Create a record in the collection
|
|
3664
|
+
|
|
3524
3665
|
```js
|
|
3525
3666
|
const body = {
|
|
3526
3667
|
"formIdentifier": "collection-form",
|
|
@@ -3565,8 +3706,6 @@ const result = await IntegrationCollections.createICollectionRow('test_collectio
|
|
|
3565
3706
|
><br>
|
|
3566
3707
|
></details>
|
|
3567
3708
|
|
|
3568
|
-
Create a record in the collection
|
|
3569
|
-
|
|
3570
3709
|
Example return:
|
|
3571
3710
|
|
|
3572
3711
|
```json
|
|
@@ -3599,6 +3738,8 @@ Example return:
|
|
|
3599
3738
|
|
|
3600
3739
|
### IntegrationCollections.updateICollectionRow(marker, body, langCode)
|
|
3601
3740
|
|
|
3741
|
+
Edit a record in the collection
|
|
3742
|
+
|
|
3602
3743
|
```js
|
|
3603
3744
|
const body = {
|
|
3604
3745
|
"formIdentifier": "collection-form",
|
|
@@ -3647,8 +3788,6 @@ const result = await IntegrationCollections.updateICollectionRow('test_collectio
|
|
|
3647
3788
|
><br>
|
|
3648
3789
|
></details>
|
|
3649
3790
|
|
|
3650
|
-
Edit a record in the collection
|
|
3651
|
-
|
|
3652
3791
|
Example return:
|
|
3653
3792
|
|
|
3654
3793
|
```json
|
|
@@ -3681,6 +3820,8 @@ Example return:
|
|
|
3681
3820
|
|
|
3682
3821
|
### IntegrationCollections.deleteICollectionRowByMarker(id, marker)
|
|
3683
3822
|
|
|
3823
|
+
Deletion of collection record object
|
|
3824
|
+
|
|
3684
3825
|
```js
|
|
3685
3826
|
const result = await IntegrationCollections.deleteICollectionRowByMarkerAndId('test_collection', 1);
|
|
3686
3827
|
```
|
|
@@ -3698,8 +3839,6 @@ const result = await IntegrationCollections.deleteICollectionRowByMarkerAndId('t
|
|
|
3698
3839
|
><br>
|
|
3699
3840
|
></details>
|
|
3700
3841
|
|
|
3701
|
-
Deletion of collection record object
|
|
3702
|
-
|
|
3703
3842
|
Returns true (in case of successful deletion) or false (in case of unsuccessful deletion) (permission "collections.row.delete" required for access)
|
|
3704
3843
|
|
|
3705
3844
|
---
|
|
@@ -3712,6 +3851,8 @@ const { Locales } = defineOneEntry('your-url');
|
|
|
3712
3851
|
|
|
3713
3852
|
### Locales.getLocales()
|
|
3714
3853
|
|
|
3854
|
+
Searching for all active objects of language localizations (available for use)
|
|
3855
|
+
|
|
3715
3856
|
```js
|
|
3716
3857
|
const value = await Locales.getLocales()
|
|
3717
3858
|
```
|
|
@@ -3782,6 +3923,8 @@ const { Menus } = defineOneEntry('your-url')
|
|
|
3782
3923
|
|
|
3783
3924
|
### Menus.getMenusByMarker(marker)
|
|
3784
3925
|
|
|
3926
|
+
Getting pages included in the menu by marker
|
|
3927
|
+
|
|
3785
3928
|
```js
|
|
3786
3929
|
const value = await Menus.getMenusByMarker('my-marker')
|
|
3787
3930
|
```
|
|
@@ -3857,6 +4000,8 @@ const { Orders } = defineOneEntry('your-url');
|
|
|
3857
4000
|
|
|
3858
4001
|
### Orders.getAllOrdersStorage(langCode, offset, limit)
|
|
3859
4002
|
|
|
4003
|
+
Getting all order storage objects 🔐 This method requires authorization.
|
|
4004
|
+
|
|
3860
4005
|
```js
|
|
3861
4006
|
const value = await Orders.getAllOrdersStorage()
|
|
3862
4007
|
```
|
|
@@ -3934,6 +4079,8 @@ Example return:
|
|
|
3934
4079
|
|
|
3935
4080
|
### Orders.getAllOrdersByMarker(marker, langCode, offset, limit)
|
|
3936
4081
|
|
|
4082
|
+
Getting all orders from the order storage object created by the user 🔐 This method requires authorization.
|
|
4083
|
+
|
|
3937
4084
|
```js
|
|
3938
4085
|
const value = await Orders.getAllOrdersByMarker('my-order')
|
|
3939
4086
|
```
|
|
@@ -4062,6 +4209,8 @@ Example return:
|
|
|
4062
4209
|
|
|
4063
4210
|
### Orders.getOrderByMarker(marker, langCode)
|
|
4064
4211
|
|
|
4212
|
+
Get one order storage object by marker 🔐 This method requires authorization.
|
|
4213
|
+
|
|
4065
4214
|
```js
|
|
4066
4215
|
const value = await Orders.getOrderByMarker('my-order')
|
|
4067
4216
|
```
|
|
@@ -4132,6 +4281,8 @@ Example return:
|
|
|
4132
4281
|
|
|
4133
4282
|
### Orders.getOrderByMarkerAndId(marker, id, langCode)
|
|
4134
4283
|
|
|
4284
|
+
Getting one order by marker and id from the order storage object created by the user 🔐 This method requires authorization.
|
|
4285
|
+
|
|
4135
4286
|
```js
|
|
4136
4287
|
const value = await Orders.getOrderByMarkerAndId('my-order', 1764)
|
|
4137
4288
|
```
|
|
@@ -4230,6 +4381,8 @@ Example return:
|
|
|
4230
4381
|
|
|
4231
4382
|
### Orders.createOrder(marker, body, langCode)
|
|
4232
4383
|
|
|
4384
|
+
Creating an order in the order storage 🔐 This method requires authorization.
|
|
4385
|
+
|
|
4233
4386
|
```js
|
|
4234
4387
|
const body = {
|
|
4235
4388
|
"formIdentifier": "orderForm",
|
|
@@ -4371,6 +4524,8 @@ Example return:
|
|
|
4371
4524
|
|
|
4372
4525
|
### Orders.updateOrderByMarkerAndId(marker, body, langCode)
|
|
4373
4526
|
|
|
4527
|
+
Order modification in the order storage 🔐 This method requires authorization.
|
|
4528
|
+
|
|
4374
4529
|
```js
|
|
4375
4530
|
const body = {
|
|
4376
4531
|
"formIdentifier": "orderForm",
|
|
@@ -4524,6 +4679,8 @@ const { Pages } = defineOneEntry('your-url');
|
|
|
4524
4679
|
|
|
4525
4680
|
### Pages.getRootPages(langCode)
|
|
4526
4681
|
|
|
4682
|
+
Getting all top-level page objects (parentId = null)
|
|
4683
|
+
|
|
4527
4684
|
```js
|
|
4528
4685
|
const value = await Pages.getRootPages()
|
|
4529
4686
|
```
|
|
@@ -4648,6 +4805,8 @@ Example return:
|
|
|
4648
4805
|
|
|
4649
4806
|
### Pages.getPages(langCode)
|
|
4650
4807
|
|
|
4808
|
+
Getting all page objects with product information as an array
|
|
4809
|
+
|
|
4651
4810
|
```js
|
|
4652
4811
|
const value = await Pages.getPages();
|
|
4653
4812
|
```
|
|
@@ -4774,6 +4933,8 @@ Example return:
|
|
|
4774
4933
|
|
|
4775
4934
|
### Pages.getPageById(id, langCode)
|
|
4776
4935
|
|
|
4936
|
+
Getting a single page object with information about forms, blocks, menus attached to the page
|
|
4937
|
+
|
|
4777
4938
|
```js
|
|
4778
4939
|
const value = await Pages.getPageById(1);
|
|
4779
4940
|
```
|
|
@@ -4888,6 +5049,8 @@ Example return:
|
|
|
4888
5049
|
|
|
4889
5050
|
### Pages.getPageByUrl(url, langCode)
|
|
4890
5051
|
|
|
5052
|
+
Getting a single page object with information about forms, blocks, menus attached to the page by URL
|
|
5053
|
+
|
|
4891
5054
|
```js
|
|
4892
5055
|
const value = await Pages.getPageByUrl('shop');
|
|
4893
5056
|
```
|
|
@@ -4993,6 +5156,8 @@ Example return:
|
|
|
4993
5156
|
|
|
4994
5157
|
### Pages.getChildPagesByParentUrl(url, langCode)
|
|
4995
5158
|
|
|
5159
|
+
Getting child pages with product information as an array
|
|
5160
|
+
|
|
4996
5161
|
```js
|
|
4997
5162
|
const value = await Pages.getChildPagesByParentUrl('shop');
|
|
4998
5163
|
```
|
|
@@ -5115,6 +5280,8 @@ Example return:
|
|
|
5115
5280
|
|
|
5116
5281
|
### Pages.getBlocksByPageUrl(url, langCode)
|
|
5117
5282
|
|
|
5283
|
+
Receiving objects ContentPageBlockDto for a related block by URL
|
|
5284
|
+
|
|
5118
5285
|
```js
|
|
5119
5286
|
const value = await Pages.getFormsByPageUrl('shop');
|
|
5120
5287
|
```
|
|
@@ -5210,6 +5377,8 @@ Example return:
|
|
|
5210
5377
|
|
|
5211
5378
|
### Pages.getFormsByPageUrl(url, langCode)
|
|
5212
5379
|
|
|
5380
|
+
Receiving objects ContentPageFormDto for a related form by URL
|
|
5381
|
+
|
|
5213
5382
|
```js
|
|
5214
5383
|
const value = await Pages.getFormsByPageUrl('shop')
|
|
5215
5384
|
```
|
|
@@ -5325,6 +5494,8 @@ Example return:
|
|
|
5325
5494
|
|
|
5326
5495
|
### Pages.getConfigPageByUrl(url)
|
|
5327
5496
|
|
|
5497
|
+
Getting settings for the page
|
|
5498
|
+
|
|
5328
5499
|
```js
|
|
5329
5500
|
const value = await Pages.getConfigPageByUrl('shop')
|
|
5330
5501
|
```
|
|
@@ -5364,6 +5535,8 @@ Example return:
|
|
|
5364
5535
|
|
|
5365
5536
|
### Pages.searchPage(name, langCode)
|
|
5366
5537
|
|
|
5538
|
+
Quick search for page objects with limited output
|
|
5539
|
+
|
|
5367
5540
|
```js
|
|
5368
5541
|
const value = await Pages.searchPage('cup')
|
|
5369
5542
|
```
|
|
@@ -5429,6 +5602,8 @@ const { Payments } = defineOneEntry('your-url');
|
|
|
5429
5602
|
|
|
5430
5603
|
### Payments.getSessions(offset, limit)
|
|
5431
5604
|
|
|
5605
|
+
Get list of payment sessions 🔐 This method requires authorization.
|
|
5606
|
+
|
|
5432
5607
|
```js
|
|
5433
5608
|
const value = await Payments.getSessions()
|
|
5434
5609
|
```
|
|
@@ -5536,6 +5711,8 @@ Example return:
|
|
|
5536
5711
|
|
|
5537
5712
|
### Payments.getSessionById(id)
|
|
5538
5713
|
|
|
5714
|
+
Get one payment session object by its identifier 🔐 This method requires authorization.
|
|
5715
|
+
|
|
5539
5716
|
```js
|
|
5540
5717
|
const value = await Payments.getSessionById(1764)
|
|
5541
5718
|
```
|
|
@@ -5561,8 +5738,8 @@ Example return:
|
|
|
5561
5738
|
"status": "completed",
|
|
5562
5739
|
"orderId": 1,
|
|
5563
5740
|
"paymentAccountId": 1,
|
|
5564
|
-
"paymentUrl": "https://checkout.stripe.com/c/pay/
|
|
5565
|
-
"clientSecret": "
|
|
5741
|
+
"paymentUrl": "https://checkout.stripe.com/c/pay/cs...",
|
|
5742
|
+
"clientSecret": "pi_3MtwBwLkdIwHu7ix28a3tqPa_secret..."
|
|
5566
5743
|
}
|
|
5567
5744
|
```
|
|
5568
5745
|
|
|
@@ -5628,12 +5805,171 @@ Example return:
|
|
|
5628
5805
|
>
|
|
5629
5806
|
>**clientSecret:** string <br>
|
|
5630
5807
|
>*client secret key* <br>
|
|
5631
|
-
>example:
|
|
5808
|
+
>example: pi_3Oyz2kQWz... <br>
|
|
5809
|
+
><br>
|
|
5810
|
+
></details>
|
|
5811
|
+
|
|
5812
|
+
### Payments.getSessionByOrderId(id)
|
|
5813
|
+
|
|
5814
|
+
Get one payment session object by order identifier 🔐 This method requires authorization.
|
|
5815
|
+
|
|
5816
|
+
```js
|
|
5817
|
+
const value = await Payments.getSessionByOrderId(1764)
|
|
5818
|
+
```
|
|
5819
|
+
|
|
5820
|
+
><details><br>
|
|
5821
|
+
><summary>Schema</summary>
|
|
5822
|
+
>
|
|
5823
|
+
>**id*:** number <br>
|
|
5824
|
+
>*Identifier of the retrieved payment session object* <br>
|
|
5825
|
+
>example: 1764 <br>
|
|
5826
|
+
><br>
|
|
5827
|
+
></details>
|
|
5828
|
+
|
|
5829
|
+
This method...
|
|
5830
|
+
|
|
5831
|
+
Example return:
|
|
5832
|
+
|
|
5833
|
+
```json
|
|
5834
|
+
{
|
|
5835
|
+
"id": 1764,
|
|
5836
|
+
"createdDate": "2025-03-02T21:56:53.600Z",
|
|
5837
|
+
"updatedDate": "2025-03-02T21:56:53.600Z",
|
|
5838
|
+
"type": "session",
|
|
5839
|
+
"status": "completed",
|
|
5840
|
+
"orderId": 1,
|
|
5841
|
+
"paymentAccountId": 1,
|
|
5842
|
+
"paymentUrl": "https://checkout.stripe.com/c/pay/cs_...",
|
|
5843
|
+
"clientSecret": "pi_3MtwBwLkdIwHu7ix28a3tq..."
|
|
5844
|
+
}
|
|
5845
|
+
```
|
|
5846
|
+
|
|
5847
|
+
><details><br>
|
|
5848
|
+
><summary>Schema</summary>
|
|
5849
|
+
>
|
|
5850
|
+
>**id:** number <br>
|
|
5851
|
+
>*object identifier* <br>
|
|
5852
|
+
>example: 1764 <br>
|
|
5853
|
+
>
|
|
5854
|
+
>**createdDate:** string($date-time) <br>
|
|
5855
|
+
>*Object creation date* <br>
|
|
5856
|
+
>
|
|
5857
|
+
>**updatedDate:** string($date-time) <br>
|
|
5858
|
+
>*Object modification date* <br>
|
|
5859
|
+
>
|
|
5860
|
+
>**type*:** string <br>
|
|
5861
|
+
>*Session type Enum: [ session, intent ]* <br>
|
|
5862
|
+
>example: session <br>
|
|
5863
|
+
>
|
|
5864
|
+
>**status*:** string <br>
|
|
5865
|
+
>*Payment status Enum: [ waiting, completed, canceled, expired ]* <br>
|
|
5866
|
+
>example: completed <br>
|
|
5867
|
+
>
|
|
5868
|
+
>**orderId*:** number <br>
|
|
5869
|
+
>*Order ID* <br>
|
|
5870
|
+
>example: 1 <br>
|
|
5871
|
+
>
|
|
5872
|
+
>**paymentAccountId*:** number <br>
|
|
5873
|
+
>*Payment account ID* <br>
|
|
5874
|
+
>example: 1 <br>
|
|
5875
|
+
>
|
|
5876
|
+
>**paymentUrl*:** string <br>
|
|
5877
|
+
>*Payment link* <br>
|
|
5878
|
+
>example: https://checkout.stripe.com/c/pay/cs_... <br>
|
|
5879
|
+
>
|
|
5880
|
+
>**clientSecret:** string <br>
|
|
5881
|
+
>*Secret key* <br>
|
|
5882
|
+
>example: pi_3MtwBwLkdIwHu7ix28a3tqPa_secret... <br>
|
|
5883
|
+
>
|
|
5884
|
+
><br>
|
|
5885
|
+
></details>
|
|
5886
|
+
|
|
5887
|
+
### Payments.updateSessionById(id, body)
|
|
5888
|
+
|
|
5889
|
+
This method Update payment session 🔐 This method requires authorization.
|
|
5890
|
+
|
|
5891
|
+
```js
|
|
5892
|
+
const body = {
|
|
5893
|
+
"status": "completed",
|
|
5894
|
+
"paymentUrl": "https://www.paypal.com/checkoutnow?token=6TC49050A66458205"
|
|
5895
|
+
};
|
|
5896
|
+
const value = await Payments.updateSessionById(10, body)
|
|
5897
|
+
```
|
|
5898
|
+
|
|
5899
|
+
><details><br>
|
|
5900
|
+
><summary>Schema (body)</summary>
|
|
5901
|
+
>
|
|
5902
|
+
>**status:** string <br>
|
|
5903
|
+
>*payment status Enum: [ waiting, completed, canceled, expired ]* <br>
|
|
5904
|
+
>example: completed <br>
|
|
5905
|
+
>
|
|
5906
|
+
>**paymentUrl*:** string <br>
|
|
5907
|
+
>*payment link* <br>
|
|
5908
|
+
>example: https://www.paypal.com/checkoutnow?token=6TC49050A66458205 <br>
|
|
5909
|
+
>
|
|
5910
|
+
><br>
|
|
5911
|
+
></details>
|
|
5912
|
+
|
|
5913
|
+
Example return:
|
|
5914
|
+
|
|
5915
|
+
```json
|
|
5916
|
+
{
|
|
5917
|
+
"id": 1764,
|
|
5918
|
+
"createdDate": "2025-03-02T22:11:25.315Z",
|
|
5919
|
+
"updatedDate": "2025-03-02T22:11:25.315Z",
|
|
5920
|
+
"type": "session",
|
|
5921
|
+
"status": "completed",
|
|
5922
|
+
"orderId": 1,
|
|
5923
|
+
"paymentAccountId": 1,
|
|
5924
|
+
"paymentUrl": "https://checkout.stripe.com/c/pay/cs_test_a1iOHnSWAmeN3SN5IgYtPv8Fzv48vGUmKxFuhxD0FOjkOaTAlgiwNY9OYW#fid2BXKsdWBEZmZqcGtxJz8nZGZmcVo0VTZjazFUb2Z8YEBRYkxHJyknZHVsTmB8Jz8ndW5acWB2cVowNEpKcW43TVVBa1NSMU5ST3JfY3VcRGlRSUR8cVx0XFxOXG9Cbn1oM1V0QUExR0RRRnJwV0FCYlNcXUtGdGtzcndgcmJxQVNkQnxvcDBTY0ZpUjZCd319UTU1ME5rXDJIVjYnKSdjd2poVmB3c2B3Jz9xd3BgKSdpZHxqcHFRfHVgJz8ndmxrYmlgWmxxYGgnKSdga2RnaWBVaWRmYG1qaWFgd3YnP3F3cGB4JSUl",
|
|
5925
|
+
"clientSecret": "pi_3MtwBwLkdIwHu7ix28a3tqPa_secret_YrKJUKribcBjcG8HVhfZluoGH"
|
|
5926
|
+
}
|
|
5927
|
+
```
|
|
5928
|
+
|
|
5929
|
+
><details><br>
|
|
5930
|
+
><summary>Schema</summary>
|
|
5931
|
+
>
|
|
5932
|
+
>**id*:** number <br>
|
|
5933
|
+
>*Object ID* <br>
|
|
5934
|
+
>example: 1764 <br>
|
|
5935
|
+
>
|
|
5936
|
+
>**createdDate:** string($date-time) <br>
|
|
5937
|
+
>*Object creation date* <br>
|
|
5938
|
+
>
|
|
5939
|
+
>**updatedDate:** string($date-time) <br>
|
|
5940
|
+
>*Object modification date* <br>
|
|
5941
|
+
>
|
|
5942
|
+
>**type*:** string <br>
|
|
5943
|
+
>*Session type Enum: [ session, intent ]* <br>
|
|
5944
|
+
>example: session <br>
|
|
5945
|
+
>
|
|
5946
|
+
>**status*:** string <br>
|
|
5947
|
+
>*Payment status Enum: [ waiting, completed, canceled, expired ]* <br>
|
|
5948
|
+
>example: completed <br>
|
|
5949
|
+
>
|
|
5950
|
+
>**orderId*:** number <br>
|
|
5951
|
+
>*Order ID* <br>
|
|
5952
|
+
>example: 1 <br>
|
|
5953
|
+
>
|
|
5954
|
+
>**paymentAccountId*:** number <br>
|
|
5955
|
+
>*Payment account ID* <br>
|
|
5956
|
+
>example: 1 <br>
|
|
5957
|
+
>
|
|
5958
|
+
>**paymentUrl*:** string <br>
|
|
5959
|
+
>*Payment link* <br>
|
|
5960
|
+
>example: https://checkout.stripe.com/c/pay/cs_... <br>
|
|
5961
|
+
>
|
|
5962
|
+
>**clientSecret:** string <br>
|
|
5963
|
+
>*Secret key* <br>
|
|
5964
|
+
>example: pi_3MtwBwLkdIwHu7i... <br>
|
|
5965
|
+
>
|
|
5632
5966
|
><br>
|
|
5633
5967
|
></details>
|
|
5634
5968
|
|
|
5635
5969
|
### Payments.createSession(orderId, type, automaticTaxEnabled)
|
|
5636
5970
|
|
|
5971
|
+
Create payment session 🔐 This method requires authorization.
|
|
5972
|
+
|
|
5637
5973
|
```js
|
|
5638
5974
|
const value = await Payments.createSession(1, 'session')
|
|
5639
5975
|
```
|
|
@@ -5737,6 +6073,8 @@ Example return:
|
|
|
5737
6073
|
|
|
5738
6074
|
### Payments.getConnected()
|
|
5739
6075
|
|
|
6076
|
+
Get payment settings 🔐 This method requires authorization.
|
|
6077
|
+
|
|
5740
6078
|
```js
|
|
5741
6079
|
const value = await Payments.getConnected()
|
|
5742
6080
|
```
|
|
@@ -5771,6 +6109,8 @@ Example return:
|
|
|
5771
6109
|
|
|
5772
6110
|
### Payments.getAccounts()
|
|
5773
6111
|
|
|
6112
|
+
Get all payment accounts as array
|
|
6113
|
+
|
|
5774
6114
|
```js
|
|
5775
6115
|
const value = await Payments.getAccounts()
|
|
5776
6116
|
```
|
|
@@ -5827,6 +6167,8 @@ Example return:
|
|
|
5827
6167
|
|
|
5828
6168
|
### Payments.getAccountById(id)
|
|
5829
6169
|
|
|
6170
|
+
Get one payment account object by its identifier 🔐 This method requires authorization.
|
|
6171
|
+
|
|
5830
6172
|
```js
|
|
5831
6173
|
const value = await Payments.getAccountById(1764)
|
|
5832
6174
|
```
|
|
@@ -5890,6 +6232,8 @@ Example return:
|
|
|
5890
6232
|
|
|
5891
6233
|
### Payments.webhookStripe()
|
|
5892
6234
|
|
|
6235
|
+
Webhook for Stripe
|
|
6236
|
+
|
|
5893
6237
|
```js
|
|
5894
6238
|
const value = await Payments.webhookStripe()
|
|
5895
6239
|
```
|
|
@@ -5951,6 +6295,8 @@ const userQuery = {
|
|
|
5951
6295
|
|
|
5952
6296
|
### Products.getProducts(body, langCode, userQuery)
|
|
5953
6297
|
|
|
6298
|
+
Search all product objects with pagination and filter
|
|
6299
|
+
|
|
5954
6300
|
```js
|
|
5955
6301
|
const body = [
|
|
5956
6302
|
{
|
|
@@ -6199,6 +6545,8 @@ Example return:
|
|
|
6199
6545
|
|
|
6200
6546
|
### Products.getProductsEmptyPage(langCode, userQuery)
|
|
6201
6547
|
|
|
6548
|
+
Search all product objects with pagination that do not have a category
|
|
6549
|
+
|
|
6202
6550
|
```js
|
|
6203
6551
|
const value = await Products.getProductsEmptyPage('en_US', userQuery)
|
|
6204
6552
|
```
|
|
@@ -6382,6 +6730,8 @@ Example return:
|
|
|
6382
6730
|
|
|
6383
6731
|
### Products.getProductsByPageId(id, body, langCode, userQuery)
|
|
6384
6732
|
|
|
6733
|
+
Search all product objects with pagination for selected category
|
|
6734
|
+
|
|
6385
6735
|
```js
|
|
6386
6736
|
const body = [
|
|
6387
6737
|
{
|
|
@@ -6635,6 +6985,8 @@ Example return:
|
|
|
6635
6985
|
|
|
6636
6986
|
### Products.getProductsPriceByPageUrl(url, userQuery)
|
|
6637
6987
|
|
|
6988
|
+
Search information about products and prices for selected category
|
|
6989
|
+
|
|
6638
6990
|
```js
|
|
6639
6991
|
|
|
6640
6992
|
const value = await Products.getProductsPriceByPageUrl('catalog')
|
|
@@ -6725,6 +7077,8 @@ Example return:
|
|
|
6725
7077
|
|
|
6726
7078
|
### Products.getProductsByPageUrl(url, body, langCode, userQuery)
|
|
6727
7079
|
|
|
7080
|
+
Search for all product objects with pagination for the selected category (by its URL)
|
|
7081
|
+
|
|
6728
7082
|
```js
|
|
6729
7083
|
const body = [
|
|
6730
7084
|
{
|
|
@@ -6976,6 +7330,8 @@ Example return:
|
|
|
6976
7330
|
|
|
6977
7331
|
### Products.getRelatedProductsById(id, langCode, userQuery)
|
|
6978
7332
|
|
|
7333
|
+
Search for all related product objects by page id
|
|
7334
|
+
|
|
6979
7335
|
```js
|
|
6980
7336
|
const value = await Products.getRelatedProductsById(1)
|
|
6981
7337
|
```
|
|
@@ -7151,6 +7507,8 @@ Example return:
|
|
|
7151
7507
|
|
|
7152
7508
|
### Products.getProductsByIds(ids, langCode, userQuery)
|
|
7153
7509
|
|
|
7510
|
+
Getting multiple products by its ids
|
|
7511
|
+
|
|
7154
7512
|
```js
|
|
7155
7513
|
const value = await Products.getProductsByIds('1, 5, 8', 'en_US')
|
|
7156
7514
|
```
|
|
@@ -7323,6 +7681,8 @@ Example return:
|
|
|
7323
7681
|
|
|
7324
7682
|
### Products.getProductById(id, langCode)
|
|
7325
7683
|
|
|
7684
|
+
Get one product object by id
|
|
7685
|
+
|
|
7326
7686
|
```js
|
|
7327
7687
|
const value = await Products.getProductById(1)
|
|
7328
7688
|
```
|
|
@@ -7474,6 +7834,8 @@ Example return:
|
|
|
7474
7834
|
|
|
7475
7835
|
### Products.getProductBlockById(id)
|
|
7476
7836
|
|
|
7837
|
+
Get ContentPageBlockDto objects by product identifier
|
|
7838
|
+
|
|
7477
7839
|
```js
|
|
7478
7840
|
const value = await Products.getProductBlockById(1764)
|
|
7479
7841
|
```
|
|
@@ -7575,6 +7937,8 @@ Example return:
|
|
|
7575
7937
|
|
|
7576
7938
|
### Products.searchProduct(name, langCode)
|
|
7577
7939
|
|
|
7940
|
+
Quick search for page objects with limited output
|
|
7941
|
+
|
|
7578
7942
|
```js
|
|
7579
7943
|
const value = await Products.searchProduct('cup')
|
|
7580
7944
|
```
|
|
@@ -7734,6 +8098,8 @@ const { ProductStatuses } = defineOneEntry('your-url');
|
|
|
7734
8098
|
|
|
7735
8099
|
### ProductStatuses.getProductStatuses(langCode)
|
|
7736
8100
|
|
|
8101
|
+
Search for all product status objects
|
|
8102
|
+
|
|
7737
8103
|
```js
|
|
7738
8104
|
const value = await ProductStatuses.getProductStatuses()
|
|
7739
8105
|
```
|
|
@@ -7788,6 +8154,8 @@ Example return:
|
|
|
7788
8154
|
|
|
7789
8155
|
### ProductStatuses.getProductStatusesById(id, langCode)
|
|
7790
8156
|
|
|
8157
|
+
Search for a single product status object by identifier
|
|
8158
|
+
|
|
7791
8159
|
```js
|
|
7792
8160
|
const value = await ProductStatuses.getProductStatusesById(1)
|
|
7793
8161
|
```
|
|
@@ -7844,6 +8212,8 @@ Example return:
|
|
|
7844
8212
|
|
|
7845
8213
|
### ProductStatuses.getProductsByStatusMarker(marker, langCode)
|
|
7846
8214
|
|
|
8215
|
+
Search for a product status object by its textual identifier (marker)
|
|
8216
|
+
|
|
7847
8217
|
```js
|
|
7848
8218
|
const value = await ProductStatuses.getProductsByStatusMarker('my-marker')
|
|
7849
8219
|
```
|
|
@@ -7900,6 +8270,8 @@ Example return:
|
|
|
7900
8270
|
|
|
7901
8271
|
### ProductStatuses.validateMarker(marker)
|
|
7902
8272
|
|
|
8273
|
+
Check the existence of a textual identifier (marker)
|
|
8274
|
+
|
|
7903
8275
|
```js
|
|
7904
8276
|
const value = await ProductStatuses.validateMarker('marker')
|
|
7905
8277
|
```
|
|
@@ -7955,6 +8327,8 @@ const { Templates } = defineOneEntry('your-url');
|
|
|
7955
8327
|
|
|
7956
8328
|
### Templates.getAllTemplates(langCode)
|
|
7957
8329
|
|
|
8330
|
+
Getting all template objects of a specific type
|
|
8331
|
+
|
|
7958
8332
|
```js
|
|
7959
8333
|
const value = await Templates.getAllTemplates()
|
|
7960
8334
|
```
|
|
@@ -8042,6 +8416,8 @@ Example return:
|
|
|
8042
8416
|
|
|
8043
8417
|
### Templates.getTemplateByType(type, langCode)
|
|
8044
8418
|
|
|
8419
|
+
Getting all template objects, grouped by types
|
|
8420
|
+
|
|
8045
8421
|
```js
|
|
8046
8422
|
const value = await Templates.getTemplateByType('forCatalogProducts')
|
|
8047
8423
|
```
|
|
@@ -8128,6 +8504,8 @@ Example return:
|
|
|
8128
8504
|
|
|
8129
8505
|
### Templates.getTemplateById(id, langCode)
|
|
8130
8506
|
|
|
8507
|
+
Get one template object by id.
|
|
8508
|
+
|
|
8131
8509
|
```js
|
|
8132
8510
|
const value = await Templates.getTemplateById(1)
|
|
8133
8511
|
```
|
|
@@ -8213,6 +8591,8 @@ Example return:
|
|
|
8213
8591
|
|
|
8214
8592
|
### Templates.getTemplateByMarker(marker, langCode)
|
|
8215
8593
|
|
|
8594
|
+
Getting one template object by marker
|
|
8595
|
+
|
|
8216
8596
|
```js
|
|
8217
8597
|
const value = await Templates.getTemplateByMarker('my-marker')
|
|
8218
8598
|
```
|
|
@@ -8305,6 +8685,8 @@ const { TemplatePreviews } = defineOneEntry('your-url');
|
|
|
8305
8685
|
|
|
8306
8686
|
### TemplatePreviews.getTemplatePreviews(langCode)
|
|
8307
8687
|
|
|
8688
|
+
Getting all template objects
|
|
8689
|
+
|
|
8308
8690
|
```js
|
|
8309
8691
|
const value = await TemplatePreviews.getTemplatePreviews()
|
|
8310
8692
|
```
|
|
@@ -8406,6 +8788,8 @@ Example return:
|
|
|
8406
8788
|
|
|
8407
8789
|
### TemplatePreviews.getTemplatesPreviewById(id, langCode)
|
|
8408
8790
|
|
|
8791
|
+
Getting one template object by id
|
|
8792
|
+
|
|
8409
8793
|
```js
|
|
8410
8794
|
const value = await TemplatePreviews.getTemplatePreviewById(1764)
|
|
8411
8795
|
```
|
|
@@ -8509,6 +8893,8 @@ Example return:
|
|
|
8509
8893
|
|
|
8510
8894
|
### TemplatePreviews.getTemplatesPreviewByMarker(marker, langCode)
|
|
8511
8895
|
|
|
8896
|
+
Getting one template object by marker
|
|
8897
|
+
|
|
8512
8898
|
```js
|
|
8513
8899
|
const value = await TemplatePreviews.getTemplatePreviewByMarker('my-marker')
|
|
8514
8900
|
```
|
|
@@ -8659,6 +9045,8 @@ const { Users } = defineOneEntry('your-url');
|
|
|
8659
9045
|
|
|
8660
9046
|
### Users.getUser(langCode)
|
|
8661
9047
|
|
|
9048
|
+
Getting data of an authorized user 🔐 This method requires authorization.
|
|
9049
|
+
|
|
8662
9050
|
```js
|
|
8663
9051
|
const value = await Users.getUser()
|
|
8664
9052
|
```
|
|
@@ -8718,6 +9106,8 @@ Example return:
|
|
|
8718
9106
|
|
|
8719
9107
|
### Users.updateUser(body, langCode)
|
|
8720
9108
|
|
|
9109
|
+
Updating a single user object 🔐 This method requires authorization.
|
|
9110
|
+
|
|
8721
9111
|
```js
|
|
8722
9112
|
const body = {
|
|
8723
9113
|
"formIdentifier": "reg",
|
|
@@ -8793,6 +9183,8 @@ true
|
|
|
8793
9183
|
|
|
8794
9184
|
### Users.deleteUser(body, langCode)
|
|
8795
9185
|
|
|
9186
|
+
Deleting a single user object 🔐 This method requires authorization.
|
|
9187
|
+
|
|
8796
9188
|
```js
|
|
8797
9189
|
const value = await Users.deleteUser(body)
|
|
8798
9190
|
```
|
|
@@ -8812,6 +9204,8 @@ const value = await Users.deleteUser(body)
|
|
|
8812
9204
|
|
|
8813
9205
|
### Users.addFCMToken(token)
|
|
8814
9206
|
|
|
9207
|
+
Adds FCM token for sending Push notifications 🔐 This method requires authorization.
|
|
9208
|
+
|
|
8815
9209
|
```js
|
|
8816
9210
|
const value = await Users.addFCMToken('my-token')
|
|
8817
9211
|
```
|
|
@@ -8835,6 +9229,8 @@ true
|
|
|
8835
9229
|
|
|
8836
9230
|
### Users.deleteFCMToken(token)
|
|
8837
9231
|
|
|
9232
|
+
Deletes FCM token 🔐 This method requires authorization.
|
|
9233
|
+
|
|
8838
9234
|
```js
|
|
8839
9235
|
const value = await Users.deleteFCMToken('my-token')
|
|
8840
9236
|
```
|
|
@@ -34,7 +34,7 @@ interface IPosition {
|
|
|
34
34
|
* @property {string} [identifier] - The textual identifier for the record field.
|
|
35
35
|
* @property {number} [attributeSetId] - The identifier of the attribute set being used.
|
|
36
36
|
* @property {boolean} [isSync] - Indication of page indexing.
|
|
37
|
-
* @property {Record<string, any>} [
|
|
37
|
+
* @property {Record<string, any>} [attributeValues] - The attributes with values used by the object.
|
|
38
38
|
* @property {number} [position] - The position of the object.
|
|
39
39
|
*/
|
|
40
40
|
interface IAdminEntity {
|
|
@@ -42,7 +42,7 @@ interface IAdminEntity {
|
|
|
42
42
|
identifier: string;
|
|
43
43
|
attributeSetId: number | null;
|
|
44
44
|
isSync: boolean;
|
|
45
|
-
|
|
45
|
+
attributeValues: Record<string, any>;
|
|
46
46
|
position: number | null;
|
|
47
47
|
[key: string]: any;
|
|
48
48
|
}
|
|
@@ -53,10 +53,15 @@ interface IAttributesSetsEntity {
|
|
|
53
53
|
/**
|
|
54
54
|
* Represents an interface object of IAttributeSetsEntity.
|
|
55
55
|
*
|
|
56
|
-
* @property {number} id
|
|
57
|
-
* @property {string} identifier
|
|
58
|
-
* @property {boolean} isVisible
|
|
59
|
-
* @property {
|
|
56
|
+
* @property {number} id -
|
|
57
|
+
* @property {string} identifier -
|
|
58
|
+
* @property {boolean} isVisible -
|
|
59
|
+
* @property {any} schema -
|
|
60
|
+
* @property {string} title -
|
|
61
|
+
* @property {any} type -
|
|
62
|
+
* @property {number} typeId -
|
|
63
|
+
* @property {string} updatedDate -
|
|
64
|
+
* @property {number} version -
|
|
60
65
|
*/
|
|
61
66
|
interface IAttributeSetsEntity {
|
|
62
67
|
id: number;
|
|
@@ -54,6 +54,15 @@ export default class IntegrationCollectionsApi extends AsyncModules implements I
|
|
|
54
54
|
validateICollectionMarker(marker: string): Promise<{
|
|
55
55
|
valid: boolean;
|
|
56
56
|
} | IError>;
|
|
57
|
+
/**
|
|
58
|
+
* Getting all records from the collection.
|
|
59
|
+
*
|
|
60
|
+
* @param {string} [marker] - Collection text identifier
|
|
61
|
+
* @param {string} [langCode] - Language code.
|
|
62
|
+
*
|
|
63
|
+
* @returns Returns CollectionRowEntity object.
|
|
64
|
+
*/
|
|
65
|
+
getICollectionRowsByMarker(marker: string, langCode?: string): Promise<any | IError>;
|
|
57
66
|
/**
|
|
58
67
|
* Getting one record from the collection.
|
|
59
68
|
*
|
|
@@ -75,6 +75,18 @@ class IntegrationCollectionsApi extends asyncModules_1.default {
|
|
|
75
75
|
const result = await this._fetchGet(`/marker-validation/${marker}/`);
|
|
76
76
|
return this._dataPostProcess(result);
|
|
77
77
|
}
|
|
78
|
+
/**
|
|
79
|
+
* Getting all records from the collection.
|
|
80
|
+
*
|
|
81
|
+
* @param {string} [marker] - Collection text identifier
|
|
82
|
+
* @param {string} [langCode] - Language code.
|
|
83
|
+
*
|
|
84
|
+
* @returns Returns CollectionRowEntity object.
|
|
85
|
+
*/
|
|
86
|
+
async getICollectionRowsByMarker(marker, langCode = this.state.lang) {
|
|
87
|
+
const result = await this._fetchGet(`/marker/${marker}/rows/?langCode=${langCode}`);
|
|
88
|
+
return this._dataPostProcess(result, langCode);
|
|
89
|
+
}
|
|
78
90
|
/**
|
|
79
91
|
* Getting one record from the collection.
|
|
80
92
|
*
|
|
@@ -28,6 +28,26 @@ export default class PaymentsApi extends AsyncModules implements IPaymentsApi {
|
|
|
28
28
|
* @returns Returns a single payment session object.
|
|
29
29
|
*/
|
|
30
30
|
getSessionById(id: number): Promise<ISessionEntity | IError>;
|
|
31
|
+
/**
|
|
32
|
+
* Get one payment session object by order identifier 🔐
|
|
33
|
+
*
|
|
34
|
+
* @param id - order identifier
|
|
35
|
+
* @returns
|
|
36
|
+
*/
|
|
37
|
+
getSessionByOrderId(id: number): Promise<IAccountsEntity | IError>;
|
|
38
|
+
/**
|
|
39
|
+
* Update payment session 🔐
|
|
40
|
+
*
|
|
41
|
+
* @param id - order identifier
|
|
42
|
+
* @param body - Request body
|
|
43
|
+
*
|
|
44
|
+
* @param body.status
|
|
45
|
+
* @param body.paymentUrl
|
|
46
|
+
*/
|
|
47
|
+
updateSessionById(id: number, body: {
|
|
48
|
+
status: string;
|
|
49
|
+
paymentUrl: string;
|
|
50
|
+
}): Promise<any | IError>;
|
|
31
51
|
/**
|
|
32
52
|
* Creation of payment session.
|
|
33
53
|
* @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
|
|
@@ -41,6 +41,29 @@ class PaymentsApi extends asyncModules_1.default {
|
|
|
41
41
|
const result = await this._fetchGet(`/sessions/${id}`);
|
|
42
42
|
return result;
|
|
43
43
|
}
|
|
44
|
+
/**
|
|
45
|
+
* Get one payment session object by order identifier 🔐
|
|
46
|
+
*
|
|
47
|
+
* @param id - order identifier
|
|
48
|
+
* @returns
|
|
49
|
+
*/
|
|
50
|
+
async getSessionByOrderId(id) {
|
|
51
|
+
const result = await this._fetchGet(`/sessions/order/${id}`);
|
|
52
|
+
return result;
|
|
53
|
+
}
|
|
54
|
+
/**
|
|
55
|
+
* Update payment session 🔐
|
|
56
|
+
*
|
|
57
|
+
* @param id - order identifier
|
|
58
|
+
* @param body - Request body
|
|
59
|
+
*
|
|
60
|
+
* @param body.status
|
|
61
|
+
* @param body.paymentUrl
|
|
62
|
+
*/
|
|
63
|
+
async updateSessionById(id, body) {
|
|
64
|
+
const result = await this._fetchPut(`/sessions/${id}`, body);
|
|
65
|
+
return this._normalizeData(result);
|
|
66
|
+
}
|
|
44
67
|
/**
|
|
45
68
|
* Creation of payment session.
|
|
46
69
|
* @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "oneentry",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.116",
|
|
4
4
|
"description": "OneEntry NPM package",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -47,19 +47,19 @@
|
|
|
47
47
|
"@microsoft/tsdoc": "^0.15.1",
|
|
48
48
|
"@types/eslint-config-prettier": "^6.11.3",
|
|
49
49
|
"@types/jest": "^29.5.14",
|
|
50
|
-
"@types/node": "^22.13.
|
|
50
|
+
"@types/node": "^22.13.11",
|
|
51
51
|
"@typescript-eslint/eslint-plugin": "^8.24.1",
|
|
52
52
|
"@typescript-eslint/parser": "^8.24.1",
|
|
53
53
|
"eslint": "^8.57.1",
|
|
54
|
-
"eslint-config-prettier": "^10.
|
|
54
|
+
"eslint-config-prettier": "^10.1.1",
|
|
55
55
|
"eslint-plugin-import": "^2.31.0",
|
|
56
56
|
"eslint-plugin-jest": "^28.11.0",
|
|
57
57
|
"eslint-plugin-prettier": "^5.2.3",
|
|
58
58
|
"eslint-plugin-simple-import-sort": "^12.1.1",
|
|
59
59
|
"jest": "^29.7.0",
|
|
60
60
|
"npm-run-all": "^4.1.5",
|
|
61
|
-
"prettier": "^3.5.
|
|
62
|
-
"ts-jest": "^29.2.
|
|
61
|
+
"prettier": "^3.5.3",
|
|
62
|
+
"ts-jest": "^29.2.6",
|
|
63
63
|
"typescript": "^5.7.3"
|
|
64
64
|
}
|
|
65
65
|
}
|