oneentry 1.0.115 → 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 +204 -27
- 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
|
|
@@ -3419,6 +3500,8 @@ Example return:
|
|
|
3419
3500
|
|
|
3420
3501
|
### IntegrationCollections.validateICollectionMarker(marker)
|
|
3421
3502
|
|
|
3503
|
+
Check for the existence of a text identifier (marker)
|
|
3504
|
+
|
|
3422
3505
|
```js
|
|
3423
3506
|
const result = await IntegrationCollections.validateICollectionMarker('test_collection');
|
|
3424
3507
|
```
|
|
@@ -3432,8 +3515,6 @@ const result = await IntegrationCollections.validateICollectionMarker('test_coll
|
|
|
3432
3515
|
><br>
|
|
3433
3516
|
></details>
|
|
3434
3517
|
|
|
3435
|
-
Check for the existence of a text identifier (marker)
|
|
3436
|
-
|
|
3437
3518
|
Example return:
|
|
3438
3519
|
|
|
3439
3520
|
```json
|
|
@@ -3453,6 +3534,8 @@ Example return:
|
|
|
3453
3534
|
|
|
3454
3535
|
### IntegrationCollections.getICollectionRowsByMarker(marker, langCode)
|
|
3455
3536
|
|
|
3537
|
+
Getting all records from the collection.
|
|
3538
|
+
|
|
3456
3539
|
```js
|
|
3457
3540
|
const result = await IntegrationCollections.getICollectionRowsByMarker('test_collection');
|
|
3458
3541
|
```
|
|
@@ -3470,8 +3553,6 @@ const result = await IntegrationCollections.getICollectionRowsByMarker('test_col
|
|
|
3470
3553
|
><br>
|
|
3471
3554
|
></details>
|
|
3472
3555
|
|
|
3473
|
-
Getting all records from the collection.
|
|
3474
|
-
|
|
3475
3556
|
Example return:
|
|
3476
3557
|
|
|
3477
3558
|
```json
|
|
@@ -3506,6 +3587,8 @@ Example return:
|
|
|
3506
3587
|
|
|
3507
3588
|
### IntegrationCollections.getICollectionRowByMarkerAndId(marker, id, langCode)
|
|
3508
3589
|
|
|
3590
|
+
Getting one record from the collection.
|
|
3591
|
+
|
|
3509
3592
|
```js
|
|
3510
3593
|
const result = await IntegrationCollections.getICollectionRowByMarkerAndId('test_collection', 1);
|
|
3511
3594
|
```
|
|
@@ -3527,8 +3610,6 @@ const result = await IntegrationCollections.getICollectionRowByMarkerAndId('test
|
|
|
3527
3610
|
><br>
|
|
3528
3611
|
></details>
|
|
3529
3612
|
|
|
3530
|
-
Getting one record from the collection.
|
|
3531
|
-
|
|
3532
3613
|
Example return:
|
|
3533
3614
|
|
|
3534
3615
|
```json
|
|
@@ -3579,6 +3660,8 @@ Example return:
|
|
|
3579
3660
|
|
|
3580
3661
|
### IntegrationCollections.createICollectionRow(marker, body, langCode)
|
|
3581
3662
|
|
|
3663
|
+
Create a record in the collection
|
|
3664
|
+
|
|
3582
3665
|
```js
|
|
3583
3666
|
const body = {
|
|
3584
3667
|
"formIdentifier": "collection-form",
|
|
@@ -3623,8 +3706,6 @@ const result = await IntegrationCollections.createICollectionRow('test_collectio
|
|
|
3623
3706
|
><br>
|
|
3624
3707
|
></details>
|
|
3625
3708
|
|
|
3626
|
-
Create a record in the collection
|
|
3627
|
-
|
|
3628
3709
|
Example return:
|
|
3629
3710
|
|
|
3630
3711
|
```json
|
|
@@ -3657,6 +3738,8 @@ Example return:
|
|
|
3657
3738
|
|
|
3658
3739
|
### IntegrationCollections.updateICollectionRow(marker, body, langCode)
|
|
3659
3740
|
|
|
3741
|
+
Edit a record in the collection
|
|
3742
|
+
|
|
3660
3743
|
```js
|
|
3661
3744
|
const body = {
|
|
3662
3745
|
"formIdentifier": "collection-form",
|
|
@@ -3705,8 +3788,6 @@ const result = await IntegrationCollections.updateICollectionRow('test_collectio
|
|
|
3705
3788
|
><br>
|
|
3706
3789
|
></details>
|
|
3707
3790
|
|
|
3708
|
-
Edit a record in the collection
|
|
3709
|
-
|
|
3710
3791
|
Example return:
|
|
3711
3792
|
|
|
3712
3793
|
```json
|
|
@@ -3739,6 +3820,8 @@ Example return:
|
|
|
3739
3820
|
|
|
3740
3821
|
### IntegrationCollections.deleteICollectionRowByMarker(id, marker)
|
|
3741
3822
|
|
|
3823
|
+
Deletion of collection record object
|
|
3824
|
+
|
|
3742
3825
|
```js
|
|
3743
3826
|
const result = await IntegrationCollections.deleteICollectionRowByMarkerAndId('test_collection', 1);
|
|
3744
3827
|
```
|
|
@@ -3756,8 +3839,6 @@ const result = await IntegrationCollections.deleteICollectionRowByMarkerAndId('t
|
|
|
3756
3839
|
><br>
|
|
3757
3840
|
></details>
|
|
3758
3841
|
|
|
3759
|
-
Deletion of collection record object
|
|
3760
|
-
|
|
3761
3842
|
Returns true (in case of successful deletion) or false (in case of unsuccessful deletion) (permission "collections.row.delete" required for access)
|
|
3762
3843
|
|
|
3763
3844
|
---
|
|
@@ -3770,6 +3851,8 @@ const { Locales } = defineOneEntry('your-url');
|
|
|
3770
3851
|
|
|
3771
3852
|
### Locales.getLocales()
|
|
3772
3853
|
|
|
3854
|
+
Searching for all active objects of language localizations (available for use)
|
|
3855
|
+
|
|
3773
3856
|
```js
|
|
3774
3857
|
const value = await Locales.getLocales()
|
|
3775
3858
|
```
|
|
@@ -3840,6 +3923,8 @@ const { Menus } = defineOneEntry('your-url')
|
|
|
3840
3923
|
|
|
3841
3924
|
### Menus.getMenusByMarker(marker)
|
|
3842
3925
|
|
|
3926
|
+
Getting pages included in the menu by marker
|
|
3927
|
+
|
|
3843
3928
|
```js
|
|
3844
3929
|
const value = await Menus.getMenusByMarker('my-marker')
|
|
3845
3930
|
```
|
|
@@ -3915,6 +4000,8 @@ const { Orders } = defineOneEntry('your-url');
|
|
|
3915
4000
|
|
|
3916
4001
|
### Orders.getAllOrdersStorage(langCode, offset, limit)
|
|
3917
4002
|
|
|
4003
|
+
Getting all order storage objects 🔐 This method requires authorization.
|
|
4004
|
+
|
|
3918
4005
|
```js
|
|
3919
4006
|
const value = await Orders.getAllOrdersStorage()
|
|
3920
4007
|
```
|
|
@@ -3992,6 +4079,8 @@ Example return:
|
|
|
3992
4079
|
|
|
3993
4080
|
### Orders.getAllOrdersByMarker(marker, langCode, offset, limit)
|
|
3994
4081
|
|
|
4082
|
+
Getting all orders from the order storage object created by the user 🔐 This method requires authorization.
|
|
4083
|
+
|
|
3995
4084
|
```js
|
|
3996
4085
|
const value = await Orders.getAllOrdersByMarker('my-order')
|
|
3997
4086
|
```
|
|
@@ -4120,6 +4209,8 @@ Example return:
|
|
|
4120
4209
|
|
|
4121
4210
|
### Orders.getOrderByMarker(marker, langCode)
|
|
4122
4211
|
|
|
4212
|
+
Get one order storage object by marker 🔐 This method requires authorization.
|
|
4213
|
+
|
|
4123
4214
|
```js
|
|
4124
4215
|
const value = await Orders.getOrderByMarker('my-order')
|
|
4125
4216
|
```
|
|
@@ -4190,6 +4281,8 @@ Example return:
|
|
|
4190
4281
|
|
|
4191
4282
|
### Orders.getOrderByMarkerAndId(marker, id, langCode)
|
|
4192
4283
|
|
|
4284
|
+
Getting one order by marker and id from the order storage object created by the user 🔐 This method requires authorization.
|
|
4285
|
+
|
|
4193
4286
|
```js
|
|
4194
4287
|
const value = await Orders.getOrderByMarkerAndId('my-order', 1764)
|
|
4195
4288
|
```
|
|
@@ -4288,6 +4381,8 @@ Example return:
|
|
|
4288
4381
|
|
|
4289
4382
|
### Orders.createOrder(marker, body, langCode)
|
|
4290
4383
|
|
|
4384
|
+
Creating an order in the order storage 🔐 This method requires authorization.
|
|
4385
|
+
|
|
4291
4386
|
```js
|
|
4292
4387
|
const body = {
|
|
4293
4388
|
"formIdentifier": "orderForm",
|
|
@@ -4429,6 +4524,8 @@ Example return:
|
|
|
4429
4524
|
|
|
4430
4525
|
### Orders.updateOrderByMarkerAndId(marker, body, langCode)
|
|
4431
4526
|
|
|
4527
|
+
Order modification in the order storage 🔐 This method requires authorization.
|
|
4528
|
+
|
|
4432
4529
|
```js
|
|
4433
4530
|
const body = {
|
|
4434
4531
|
"formIdentifier": "orderForm",
|
|
@@ -4582,6 +4679,8 @@ const { Pages } = defineOneEntry('your-url');
|
|
|
4582
4679
|
|
|
4583
4680
|
### Pages.getRootPages(langCode)
|
|
4584
4681
|
|
|
4682
|
+
Getting all top-level page objects (parentId = null)
|
|
4683
|
+
|
|
4585
4684
|
```js
|
|
4586
4685
|
const value = await Pages.getRootPages()
|
|
4587
4686
|
```
|
|
@@ -4706,6 +4805,8 @@ Example return:
|
|
|
4706
4805
|
|
|
4707
4806
|
### Pages.getPages(langCode)
|
|
4708
4807
|
|
|
4808
|
+
Getting all page objects with product information as an array
|
|
4809
|
+
|
|
4709
4810
|
```js
|
|
4710
4811
|
const value = await Pages.getPages();
|
|
4711
4812
|
```
|
|
@@ -4832,6 +4933,8 @@ Example return:
|
|
|
4832
4933
|
|
|
4833
4934
|
### Pages.getPageById(id, langCode)
|
|
4834
4935
|
|
|
4936
|
+
Getting a single page object with information about forms, blocks, menus attached to the page
|
|
4937
|
+
|
|
4835
4938
|
```js
|
|
4836
4939
|
const value = await Pages.getPageById(1);
|
|
4837
4940
|
```
|
|
@@ -4946,6 +5049,8 @@ Example return:
|
|
|
4946
5049
|
|
|
4947
5050
|
### Pages.getPageByUrl(url, langCode)
|
|
4948
5051
|
|
|
5052
|
+
Getting a single page object with information about forms, blocks, menus attached to the page by URL
|
|
5053
|
+
|
|
4949
5054
|
```js
|
|
4950
5055
|
const value = await Pages.getPageByUrl('shop');
|
|
4951
5056
|
```
|
|
@@ -5051,6 +5156,8 @@ Example return:
|
|
|
5051
5156
|
|
|
5052
5157
|
### Pages.getChildPagesByParentUrl(url, langCode)
|
|
5053
5158
|
|
|
5159
|
+
Getting child pages with product information as an array
|
|
5160
|
+
|
|
5054
5161
|
```js
|
|
5055
5162
|
const value = await Pages.getChildPagesByParentUrl('shop');
|
|
5056
5163
|
```
|
|
@@ -5173,6 +5280,8 @@ Example return:
|
|
|
5173
5280
|
|
|
5174
5281
|
### Pages.getBlocksByPageUrl(url, langCode)
|
|
5175
5282
|
|
|
5283
|
+
Receiving objects ContentPageBlockDto for a related block by URL
|
|
5284
|
+
|
|
5176
5285
|
```js
|
|
5177
5286
|
const value = await Pages.getFormsByPageUrl('shop');
|
|
5178
5287
|
```
|
|
@@ -5268,6 +5377,8 @@ Example return:
|
|
|
5268
5377
|
|
|
5269
5378
|
### Pages.getFormsByPageUrl(url, langCode)
|
|
5270
5379
|
|
|
5380
|
+
Receiving objects ContentPageFormDto for a related form by URL
|
|
5381
|
+
|
|
5271
5382
|
```js
|
|
5272
5383
|
const value = await Pages.getFormsByPageUrl('shop')
|
|
5273
5384
|
```
|
|
@@ -5383,6 +5494,8 @@ Example return:
|
|
|
5383
5494
|
|
|
5384
5495
|
### Pages.getConfigPageByUrl(url)
|
|
5385
5496
|
|
|
5497
|
+
Getting settings for the page
|
|
5498
|
+
|
|
5386
5499
|
```js
|
|
5387
5500
|
const value = await Pages.getConfigPageByUrl('shop')
|
|
5388
5501
|
```
|
|
@@ -5422,6 +5535,8 @@ Example return:
|
|
|
5422
5535
|
|
|
5423
5536
|
### Pages.searchPage(name, langCode)
|
|
5424
5537
|
|
|
5538
|
+
Quick search for page objects with limited output
|
|
5539
|
+
|
|
5425
5540
|
```js
|
|
5426
5541
|
const value = await Pages.searchPage('cup')
|
|
5427
5542
|
```
|
|
@@ -5487,7 +5602,7 @@ const { Payments } = defineOneEntry('your-url');
|
|
|
5487
5602
|
|
|
5488
5603
|
### Payments.getSessions(offset, limit)
|
|
5489
5604
|
|
|
5490
|
-
Get list of payment sessions.
|
|
5605
|
+
Get list of payment sessions 🔐 This method requires authorization.
|
|
5491
5606
|
|
|
5492
5607
|
```js
|
|
5493
5608
|
const value = await Payments.getSessions()
|
|
@@ -5596,7 +5711,7 @@ Example return:
|
|
|
5596
5711
|
|
|
5597
5712
|
### Payments.getSessionById(id)
|
|
5598
5713
|
|
|
5599
|
-
Get
|
|
5714
|
+
Get one payment session object by its identifier 🔐 This method requires authorization.
|
|
5600
5715
|
|
|
5601
5716
|
```js
|
|
5602
5717
|
const value = await Payments.getSessionById(1764)
|
|
@@ -5690,13 +5805,13 @@ Example return:
|
|
|
5690
5805
|
>
|
|
5691
5806
|
>**clientSecret:** string <br>
|
|
5692
5807
|
>*client secret key* <br>
|
|
5693
|
-
>example:
|
|
5808
|
+
>example: pi_3Oyz2kQWz... <br>
|
|
5694
5809
|
><br>
|
|
5695
5810
|
></details>
|
|
5696
5811
|
|
|
5697
5812
|
### Payments.getSessionByOrderId(id)
|
|
5698
5813
|
|
|
5699
|
-
Get one payment session object by order identifier 🔐
|
|
5814
|
+
Get one payment session object by order identifier 🔐 This method requires authorization.
|
|
5700
5815
|
|
|
5701
5816
|
```js
|
|
5702
5817
|
const value = await Payments.getSessionByOrderId(1764)
|
|
@@ -5771,7 +5886,7 @@ Example return:
|
|
|
5771
5886
|
|
|
5772
5887
|
### Payments.updateSessionById(id, body)
|
|
5773
5888
|
|
|
5774
|
-
This method Update payment session 🔐
|
|
5889
|
+
This method Update payment session 🔐 This method requires authorization.
|
|
5775
5890
|
|
|
5776
5891
|
```js
|
|
5777
5892
|
const body = {
|
|
@@ -5853,6 +5968,8 @@ Example return:
|
|
|
5853
5968
|
|
|
5854
5969
|
### Payments.createSession(orderId, type, automaticTaxEnabled)
|
|
5855
5970
|
|
|
5971
|
+
Create payment session 🔐 This method requires authorization.
|
|
5972
|
+
|
|
5856
5973
|
```js
|
|
5857
5974
|
const value = await Payments.createSession(1, 'session')
|
|
5858
5975
|
```
|
|
@@ -5956,6 +6073,8 @@ Example return:
|
|
|
5956
6073
|
|
|
5957
6074
|
### Payments.getConnected()
|
|
5958
6075
|
|
|
6076
|
+
Get payment settings 🔐 This method requires authorization.
|
|
6077
|
+
|
|
5959
6078
|
```js
|
|
5960
6079
|
const value = await Payments.getConnected()
|
|
5961
6080
|
```
|
|
@@ -5990,6 +6109,8 @@ Example return:
|
|
|
5990
6109
|
|
|
5991
6110
|
### Payments.getAccounts()
|
|
5992
6111
|
|
|
6112
|
+
Get all payment accounts as array
|
|
6113
|
+
|
|
5993
6114
|
```js
|
|
5994
6115
|
const value = await Payments.getAccounts()
|
|
5995
6116
|
```
|
|
@@ -6046,6 +6167,8 @@ Example return:
|
|
|
6046
6167
|
|
|
6047
6168
|
### Payments.getAccountById(id)
|
|
6048
6169
|
|
|
6170
|
+
Get one payment account object by its identifier 🔐 This method requires authorization.
|
|
6171
|
+
|
|
6049
6172
|
```js
|
|
6050
6173
|
const value = await Payments.getAccountById(1764)
|
|
6051
6174
|
```
|
|
@@ -6109,6 +6232,8 @@ Example return:
|
|
|
6109
6232
|
|
|
6110
6233
|
### Payments.webhookStripe()
|
|
6111
6234
|
|
|
6235
|
+
Webhook for Stripe
|
|
6236
|
+
|
|
6112
6237
|
```js
|
|
6113
6238
|
const value = await Payments.webhookStripe()
|
|
6114
6239
|
```
|
|
@@ -6170,6 +6295,8 @@ const userQuery = {
|
|
|
6170
6295
|
|
|
6171
6296
|
### Products.getProducts(body, langCode, userQuery)
|
|
6172
6297
|
|
|
6298
|
+
Search all product objects with pagination and filter
|
|
6299
|
+
|
|
6173
6300
|
```js
|
|
6174
6301
|
const body = [
|
|
6175
6302
|
{
|
|
@@ -6418,6 +6545,8 @@ Example return:
|
|
|
6418
6545
|
|
|
6419
6546
|
### Products.getProductsEmptyPage(langCode, userQuery)
|
|
6420
6547
|
|
|
6548
|
+
Search all product objects with pagination that do not have a category
|
|
6549
|
+
|
|
6421
6550
|
```js
|
|
6422
6551
|
const value = await Products.getProductsEmptyPage('en_US', userQuery)
|
|
6423
6552
|
```
|
|
@@ -6601,6 +6730,8 @@ Example return:
|
|
|
6601
6730
|
|
|
6602
6731
|
### Products.getProductsByPageId(id, body, langCode, userQuery)
|
|
6603
6732
|
|
|
6733
|
+
Search all product objects with pagination for selected category
|
|
6734
|
+
|
|
6604
6735
|
```js
|
|
6605
6736
|
const body = [
|
|
6606
6737
|
{
|
|
@@ -6854,6 +6985,8 @@ Example return:
|
|
|
6854
6985
|
|
|
6855
6986
|
### Products.getProductsPriceByPageUrl(url, userQuery)
|
|
6856
6987
|
|
|
6988
|
+
Search information about products and prices for selected category
|
|
6989
|
+
|
|
6857
6990
|
```js
|
|
6858
6991
|
|
|
6859
6992
|
const value = await Products.getProductsPriceByPageUrl('catalog')
|
|
@@ -6944,6 +7077,8 @@ Example return:
|
|
|
6944
7077
|
|
|
6945
7078
|
### Products.getProductsByPageUrl(url, body, langCode, userQuery)
|
|
6946
7079
|
|
|
7080
|
+
Search for all product objects with pagination for the selected category (by its URL)
|
|
7081
|
+
|
|
6947
7082
|
```js
|
|
6948
7083
|
const body = [
|
|
6949
7084
|
{
|
|
@@ -7195,6 +7330,8 @@ Example return:
|
|
|
7195
7330
|
|
|
7196
7331
|
### Products.getRelatedProductsById(id, langCode, userQuery)
|
|
7197
7332
|
|
|
7333
|
+
Search for all related product objects by page id
|
|
7334
|
+
|
|
7198
7335
|
```js
|
|
7199
7336
|
const value = await Products.getRelatedProductsById(1)
|
|
7200
7337
|
```
|
|
@@ -7370,6 +7507,8 @@ Example return:
|
|
|
7370
7507
|
|
|
7371
7508
|
### Products.getProductsByIds(ids, langCode, userQuery)
|
|
7372
7509
|
|
|
7510
|
+
Getting multiple products by its ids
|
|
7511
|
+
|
|
7373
7512
|
```js
|
|
7374
7513
|
const value = await Products.getProductsByIds('1, 5, 8', 'en_US')
|
|
7375
7514
|
```
|
|
@@ -7542,6 +7681,8 @@ Example return:
|
|
|
7542
7681
|
|
|
7543
7682
|
### Products.getProductById(id, langCode)
|
|
7544
7683
|
|
|
7684
|
+
Get one product object by id
|
|
7685
|
+
|
|
7545
7686
|
```js
|
|
7546
7687
|
const value = await Products.getProductById(1)
|
|
7547
7688
|
```
|
|
@@ -7693,6 +7834,8 @@ Example return:
|
|
|
7693
7834
|
|
|
7694
7835
|
### Products.getProductBlockById(id)
|
|
7695
7836
|
|
|
7837
|
+
Get ContentPageBlockDto objects by product identifier
|
|
7838
|
+
|
|
7696
7839
|
```js
|
|
7697
7840
|
const value = await Products.getProductBlockById(1764)
|
|
7698
7841
|
```
|
|
@@ -7794,6 +7937,8 @@ Example return:
|
|
|
7794
7937
|
|
|
7795
7938
|
### Products.searchProduct(name, langCode)
|
|
7796
7939
|
|
|
7940
|
+
Quick search for page objects with limited output
|
|
7941
|
+
|
|
7797
7942
|
```js
|
|
7798
7943
|
const value = await Products.searchProduct('cup')
|
|
7799
7944
|
```
|
|
@@ -7953,6 +8098,8 @@ const { ProductStatuses } = defineOneEntry('your-url');
|
|
|
7953
8098
|
|
|
7954
8099
|
### ProductStatuses.getProductStatuses(langCode)
|
|
7955
8100
|
|
|
8101
|
+
Search for all product status objects
|
|
8102
|
+
|
|
7956
8103
|
```js
|
|
7957
8104
|
const value = await ProductStatuses.getProductStatuses()
|
|
7958
8105
|
```
|
|
@@ -8007,6 +8154,8 @@ Example return:
|
|
|
8007
8154
|
|
|
8008
8155
|
### ProductStatuses.getProductStatusesById(id, langCode)
|
|
8009
8156
|
|
|
8157
|
+
Search for a single product status object by identifier
|
|
8158
|
+
|
|
8010
8159
|
```js
|
|
8011
8160
|
const value = await ProductStatuses.getProductStatusesById(1)
|
|
8012
8161
|
```
|
|
@@ -8063,6 +8212,8 @@ Example return:
|
|
|
8063
8212
|
|
|
8064
8213
|
### ProductStatuses.getProductsByStatusMarker(marker, langCode)
|
|
8065
8214
|
|
|
8215
|
+
Search for a product status object by its textual identifier (marker)
|
|
8216
|
+
|
|
8066
8217
|
```js
|
|
8067
8218
|
const value = await ProductStatuses.getProductsByStatusMarker('my-marker')
|
|
8068
8219
|
```
|
|
@@ -8119,6 +8270,8 @@ Example return:
|
|
|
8119
8270
|
|
|
8120
8271
|
### ProductStatuses.validateMarker(marker)
|
|
8121
8272
|
|
|
8273
|
+
Check the existence of a textual identifier (marker)
|
|
8274
|
+
|
|
8122
8275
|
```js
|
|
8123
8276
|
const value = await ProductStatuses.validateMarker('marker')
|
|
8124
8277
|
```
|
|
@@ -8174,6 +8327,8 @@ const { Templates } = defineOneEntry('your-url');
|
|
|
8174
8327
|
|
|
8175
8328
|
### Templates.getAllTemplates(langCode)
|
|
8176
8329
|
|
|
8330
|
+
Getting all template objects of a specific type
|
|
8331
|
+
|
|
8177
8332
|
```js
|
|
8178
8333
|
const value = await Templates.getAllTemplates()
|
|
8179
8334
|
```
|
|
@@ -8261,6 +8416,8 @@ Example return:
|
|
|
8261
8416
|
|
|
8262
8417
|
### Templates.getTemplateByType(type, langCode)
|
|
8263
8418
|
|
|
8419
|
+
Getting all template objects, grouped by types
|
|
8420
|
+
|
|
8264
8421
|
```js
|
|
8265
8422
|
const value = await Templates.getTemplateByType('forCatalogProducts')
|
|
8266
8423
|
```
|
|
@@ -8347,6 +8504,8 @@ Example return:
|
|
|
8347
8504
|
|
|
8348
8505
|
### Templates.getTemplateById(id, langCode)
|
|
8349
8506
|
|
|
8507
|
+
Get one template object by id.
|
|
8508
|
+
|
|
8350
8509
|
```js
|
|
8351
8510
|
const value = await Templates.getTemplateById(1)
|
|
8352
8511
|
```
|
|
@@ -8432,6 +8591,8 @@ Example return:
|
|
|
8432
8591
|
|
|
8433
8592
|
### Templates.getTemplateByMarker(marker, langCode)
|
|
8434
8593
|
|
|
8594
|
+
Getting one template object by marker
|
|
8595
|
+
|
|
8435
8596
|
```js
|
|
8436
8597
|
const value = await Templates.getTemplateByMarker('my-marker')
|
|
8437
8598
|
```
|
|
@@ -8524,6 +8685,8 @@ const { TemplatePreviews } = defineOneEntry('your-url');
|
|
|
8524
8685
|
|
|
8525
8686
|
### TemplatePreviews.getTemplatePreviews(langCode)
|
|
8526
8687
|
|
|
8688
|
+
Getting all template objects
|
|
8689
|
+
|
|
8527
8690
|
```js
|
|
8528
8691
|
const value = await TemplatePreviews.getTemplatePreviews()
|
|
8529
8692
|
```
|
|
@@ -8625,6 +8788,8 @@ Example return:
|
|
|
8625
8788
|
|
|
8626
8789
|
### TemplatePreviews.getTemplatesPreviewById(id, langCode)
|
|
8627
8790
|
|
|
8791
|
+
Getting one template object by id
|
|
8792
|
+
|
|
8628
8793
|
```js
|
|
8629
8794
|
const value = await TemplatePreviews.getTemplatePreviewById(1764)
|
|
8630
8795
|
```
|
|
@@ -8728,6 +8893,8 @@ Example return:
|
|
|
8728
8893
|
|
|
8729
8894
|
### TemplatePreviews.getTemplatesPreviewByMarker(marker, langCode)
|
|
8730
8895
|
|
|
8896
|
+
Getting one template object by marker
|
|
8897
|
+
|
|
8731
8898
|
```js
|
|
8732
8899
|
const value = await TemplatePreviews.getTemplatePreviewByMarker('my-marker')
|
|
8733
8900
|
```
|
|
@@ -8878,6 +9045,8 @@ const { Users } = defineOneEntry('your-url');
|
|
|
8878
9045
|
|
|
8879
9046
|
### Users.getUser(langCode)
|
|
8880
9047
|
|
|
9048
|
+
Getting data of an authorized user 🔐 This method requires authorization.
|
|
9049
|
+
|
|
8881
9050
|
```js
|
|
8882
9051
|
const value = await Users.getUser()
|
|
8883
9052
|
```
|
|
@@ -8937,6 +9106,8 @@ Example return:
|
|
|
8937
9106
|
|
|
8938
9107
|
### Users.updateUser(body, langCode)
|
|
8939
9108
|
|
|
9109
|
+
Updating a single user object 🔐 This method requires authorization.
|
|
9110
|
+
|
|
8940
9111
|
```js
|
|
8941
9112
|
const body = {
|
|
8942
9113
|
"formIdentifier": "reg",
|
|
@@ -9012,6 +9183,8 @@ true
|
|
|
9012
9183
|
|
|
9013
9184
|
### Users.deleteUser(body, langCode)
|
|
9014
9185
|
|
|
9186
|
+
Deleting a single user object 🔐 This method requires authorization.
|
|
9187
|
+
|
|
9015
9188
|
```js
|
|
9016
9189
|
const value = await Users.deleteUser(body)
|
|
9017
9190
|
```
|
|
@@ -9031,6 +9204,8 @@ const value = await Users.deleteUser(body)
|
|
|
9031
9204
|
|
|
9032
9205
|
### Users.addFCMToken(token)
|
|
9033
9206
|
|
|
9207
|
+
Adds FCM token for sending Push notifications 🔐 This method requires authorization.
|
|
9208
|
+
|
|
9034
9209
|
```js
|
|
9035
9210
|
const value = await Users.addFCMToken('my-token')
|
|
9036
9211
|
```
|
|
@@ -9054,6 +9229,8 @@ true
|
|
|
9054
9229
|
|
|
9055
9230
|
### Users.deleteFCMToken(token)
|
|
9056
9231
|
|
|
9232
|
+
Deletes FCM token 🔐 This method requires authorization.
|
|
9233
|
+
|
|
9057
9234
|
```js
|
|
9058
9235
|
const value = await Users.deleteFCMToken('my-token')
|
|
9059
9236
|
```
|
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
|
}
|