@voucherify/sdk 2.4.0 → 2.5.0
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/CHANGELOG.md +47 -0
- package/README.md +193 -3
- package/dist/Exports.d.ts +4 -0
- package/dist/Loyalties.d.ts +61 -4
- package/dist/ProductCollections.d.ts +26 -0
- package/dist/VoucherifyServerSide.d.ts +2 -0
- package/dist/types/Categories.d.ts +8 -0
- package/dist/types/Exports.d.ts +119 -0
- package/dist/types/Loyalties.d.ts +492 -3
- package/dist/types/ProductCollections.d.ts +95 -0
- package/dist/types/Rewards.d.ts +57 -1
- package/dist/types/UtilityTypes.d.ts +3 -0
- package/dist/voucherifysdk.esm.js +172 -5
- package/dist/voucherifysdk.esm.js.map +1 -1
- package/dist/voucherifysdk.umd.development.js +172 -5
- package/dist/voucherifysdk.umd.development.js.map +1 -1
- package/dist/voucherifysdk.umd.production.min.js +1 -1
- package/dist/voucherifysdk.umd.production.min.js.map +1 -1
- package/package.json +1 -1
|
@@ -397,6 +397,14 @@
|
|
|
397
397
|
create(exportResource) {
|
|
398
398
|
return this.client.post('/exports', exportResource);
|
|
399
399
|
}
|
|
400
|
+
/**
|
|
401
|
+
* @see https://docs.voucherify.io/reference/list-exports
|
|
402
|
+
*/
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
list(query = {}) {
|
|
406
|
+
return this.client.get('/exports', query);
|
|
407
|
+
}
|
|
400
408
|
/**
|
|
401
409
|
* @see https://docs.voucherify.io/reference/get-export
|
|
402
410
|
*/
|
|
@@ -1358,28 +1366,63 @@
|
|
|
1358
1366
|
}
|
|
1359
1367
|
/**
|
|
1360
1368
|
* @see https://docs.voucherify.io/reference/get-member
|
|
1369
|
+
* @see https://docs.voucherify.io/reference/get-member-1
|
|
1361
1370
|
*/
|
|
1362
1371
|
|
|
1363
1372
|
|
|
1364
1373
|
getMember(campaignId, memberId) {
|
|
1365
|
-
return this.client.get(`/loyalties/${encode(campaignId)}/members/${memberId}`);
|
|
1374
|
+
return this.client.get(campaignId ? `/loyalties/${encode(campaignId)}/members/${memberId}` : `/loyalties/members/${memberId}`);
|
|
1366
1375
|
}
|
|
1367
1376
|
/**
|
|
1368
1377
|
* @see https://docs.voucherify.io/reference/get-member-activities
|
|
1378
|
+
* @see https://docs.voucherify.io/reference/get-member-activities-1
|
|
1369
1379
|
*/
|
|
1370
1380
|
|
|
1371
1381
|
|
|
1372
1382
|
getMemberActivities(campaignId, memberId) {
|
|
1373
|
-
return this.client.get(`/loyalties/${encode(campaignId)}/members/${memberId}/activities`);
|
|
1383
|
+
return this.client.get(campaignId ? `/loyalties/${encode(campaignId)}/members/${memberId}/activities` : `/loyalties/members/${memberId}/activities`);
|
|
1384
|
+
}
|
|
1385
|
+
/**
|
|
1386
|
+
* @see https://docs.voucherify.io/reference/list-member-rewards
|
|
1387
|
+
*/
|
|
1388
|
+
|
|
1389
|
+
|
|
1390
|
+
listMemberRewards(memberId, params) {
|
|
1391
|
+
return this.client.get(`/loyalties/members/${encode(memberId)}/rewards`, params);
|
|
1392
|
+
}
|
|
1393
|
+
/**
|
|
1394
|
+
* @see https://docs.voucherify.io/reference/add-remove-loyalty-card-balance
|
|
1395
|
+
* @see https://docs.voucherify.io/reference/add-remove-loyalty-card-balance-1
|
|
1396
|
+
*/
|
|
1397
|
+
|
|
1398
|
+
|
|
1399
|
+
addOrRemoveCardBalance(memberId, balance, campaignId) {
|
|
1400
|
+
return this.client.post(campaignId ? `/loyalties/${encode(campaignId)}/members/${memberId}/balance` : `/loyalties/members/${memberId}/balance`, balance);
|
|
1374
1401
|
}
|
|
1375
1402
|
/**
|
|
1376
|
-
* @see https://docs.voucherify.io/reference/add-loyalty-card-balance
|
|
1403
|
+
* @see https://docs.voucherify.io/reference/add-remove-loyalty-card-balance-1
|
|
1377
1404
|
*/
|
|
1378
1405
|
|
|
1379
1406
|
|
|
1380
1407
|
addPoints(campaignId, memberId, balance) {
|
|
1381
1408
|
return this.client.post(`/loyalties/${encode(campaignId)}/members/${memberId}/balance`, balance);
|
|
1382
1409
|
}
|
|
1410
|
+
/**
|
|
1411
|
+
* @see https://docs.voucherify.io/reference/transfer-points
|
|
1412
|
+
*/
|
|
1413
|
+
|
|
1414
|
+
|
|
1415
|
+
transferPoints(campaignId, memberId, loyaltiesTransferPoints) {
|
|
1416
|
+
return this.client.post(`/loyalties/${encode(campaignId)}/members/${encode(memberId)}/transfers`, loyaltiesTransferPoints);
|
|
1417
|
+
}
|
|
1418
|
+
/**
|
|
1419
|
+
* @see https://docs.voucherify.io/reference/get-points-expiration
|
|
1420
|
+
*/
|
|
1421
|
+
|
|
1422
|
+
|
|
1423
|
+
getPointsExpiration(campaignId, memberId, params) {
|
|
1424
|
+
return this.client.get(`/loyalties/${encode(campaignId)}/members/${memberId}/points-expiration`, params);
|
|
1425
|
+
}
|
|
1383
1426
|
/**
|
|
1384
1427
|
* @see https://docs.voucherify.io/reference/redeem-loyalty-card
|
|
1385
1428
|
*/
|
|
@@ -1388,6 +1431,80 @@
|
|
|
1388
1431
|
redeemReward(campaignId, memberId, params) {
|
|
1389
1432
|
return this.client.post(`/loyalties/${encode(campaignId)}/members/${encode(memberId)}/redemption`, params);
|
|
1390
1433
|
}
|
|
1434
|
+
/**
|
|
1435
|
+
* @see https://docs.voucherify.io/reference/list-loyalty-card-transactions
|
|
1436
|
+
* @see https://docs.voucherify.io/reference/list-loyalty-card-transactions-1
|
|
1437
|
+
*/
|
|
1438
|
+
|
|
1439
|
+
|
|
1440
|
+
listCardTransactions(memberId, campaignId, params) {
|
|
1441
|
+
return this.client.get(campaignId ? `/loyalties/${encode(campaignId)}/members/${encode(memberId)}/transactions` : `/loyalties/members/${encode(memberId)}/transactions`, params);
|
|
1442
|
+
}
|
|
1443
|
+
/**
|
|
1444
|
+
* @see https://docs.voucherify.io/reference/export-loyalty-card-transactions
|
|
1445
|
+
* @see https://docs.voucherify.io/reference/export-loyalty-card-transactions-1
|
|
1446
|
+
*/
|
|
1447
|
+
|
|
1448
|
+
|
|
1449
|
+
exportCardTransactions(memberId, campaignId, params = {}) {
|
|
1450
|
+
return this.client.post(campaignId ? `/loyalties/${encode(campaignId)}/members/${encode(memberId)}/transactions/export` : `/loyalties/members/${encode(memberId)}/transactions/export`, params);
|
|
1451
|
+
}
|
|
1452
|
+
/**
|
|
1453
|
+
* @see https://docs.voucherify.io/reference/get-reward-assignment-1
|
|
1454
|
+
*/
|
|
1455
|
+
|
|
1456
|
+
|
|
1457
|
+
getRewardAssignment(campaignId, assignmentId) {
|
|
1458
|
+
return this.client.get(`/loyalties/${encode(campaignId)}/reward-assignments/${encode(assignmentId)}`);
|
|
1459
|
+
}
|
|
1460
|
+
/**
|
|
1461
|
+
* @see https://docs.voucherify.io/reference/get-reward-details
|
|
1462
|
+
*/
|
|
1463
|
+
|
|
1464
|
+
|
|
1465
|
+
getRewardDetails(campaignId, assignmentId) {
|
|
1466
|
+
return this.client.get(`/loyalties/${encode(campaignId)}/reward-assignments/${encode(assignmentId)}/reward`);
|
|
1467
|
+
}
|
|
1468
|
+
/**
|
|
1469
|
+
* @see https://docs.voucherify.io/reference/list-loyalty-tiers
|
|
1470
|
+
*/
|
|
1471
|
+
|
|
1472
|
+
|
|
1473
|
+
listTiers(campaignId, params) {
|
|
1474
|
+
return this.client.get(`/loyalties/${encode(campaignId)}/tiers`, params);
|
|
1475
|
+
}
|
|
1476
|
+
/**
|
|
1477
|
+
* @see https://docs.voucherify.io/reference/get-loyalty-tier
|
|
1478
|
+
*/
|
|
1479
|
+
|
|
1480
|
+
|
|
1481
|
+
getTier(campaignId, tierId) {
|
|
1482
|
+
return this.client.get(`/loyalties/${encode(campaignId)}/tiers/${encode(tierId)}`);
|
|
1483
|
+
}
|
|
1484
|
+
/**
|
|
1485
|
+
* @see https://docs.voucherify.io/reference/create-loyalty-tiers
|
|
1486
|
+
*/
|
|
1487
|
+
|
|
1488
|
+
|
|
1489
|
+
createTiers(campaignId, tiers) {
|
|
1490
|
+
return this.client.post(`/loyalties/${encode(campaignId)}/tiers`, tiers);
|
|
1491
|
+
}
|
|
1492
|
+
/**
|
|
1493
|
+
* @see https://docs.voucherify.io/reference/list-loyalty-tier-earning-rules
|
|
1494
|
+
*/
|
|
1495
|
+
|
|
1496
|
+
|
|
1497
|
+
listLoyaltyTierEarningRules(campaignId, tierId, params) {
|
|
1498
|
+
return this.client.get(`/loyalties/${encode(campaignId)}/tiers/${encode(tierId)}/earning-rules`, params);
|
|
1499
|
+
}
|
|
1500
|
+
/**
|
|
1501
|
+
* @see https://docs.voucherify.io/reference/get-member-loyalty-tier
|
|
1502
|
+
*/
|
|
1503
|
+
|
|
1504
|
+
|
|
1505
|
+
listMemberLoyaltyTiers(memberId) {
|
|
1506
|
+
return this.client.get(`/loyalties/members/${encode(memberId)}/tiers`);
|
|
1507
|
+
}
|
|
1391
1508
|
|
|
1392
1509
|
}
|
|
1393
1510
|
|
|
@@ -1616,6 +1733,54 @@
|
|
|
1616
1733
|
|
|
1617
1734
|
}
|
|
1618
1735
|
|
|
1736
|
+
class ProductCollections {
|
|
1737
|
+
constructor(client) {
|
|
1738
|
+
this.client = void 0;
|
|
1739
|
+
this.client = client;
|
|
1740
|
+
}
|
|
1741
|
+
/**
|
|
1742
|
+
* @see https://docs.voucherify.io/reference/create-product-collection
|
|
1743
|
+
*/
|
|
1744
|
+
|
|
1745
|
+
|
|
1746
|
+
create(productCollection) {
|
|
1747
|
+
return this.client.post(`/product-collections`, productCollection);
|
|
1748
|
+
}
|
|
1749
|
+
/**
|
|
1750
|
+
* @see https://docs.voucherify.io/reference/list-product-collections
|
|
1751
|
+
*/
|
|
1752
|
+
|
|
1753
|
+
|
|
1754
|
+
list(params) {
|
|
1755
|
+
return this.client.get(`/product-collections`, params);
|
|
1756
|
+
}
|
|
1757
|
+
/**
|
|
1758
|
+
* @see https://docs.voucherify.io/reference/delete-product-collection
|
|
1759
|
+
*/
|
|
1760
|
+
|
|
1761
|
+
|
|
1762
|
+
delete(productCollectionId) {
|
|
1763
|
+
return this.client.delete(`/product-collections/${encode(productCollectionId)}`);
|
|
1764
|
+
}
|
|
1765
|
+
/**
|
|
1766
|
+
* @see https://docs.voucherify.io/reference/get-product-collection
|
|
1767
|
+
*/
|
|
1768
|
+
|
|
1769
|
+
|
|
1770
|
+
get(productCollectionId) {
|
|
1771
|
+
return this.client.get(`/product-collections/${encode(productCollectionId)}`);
|
|
1772
|
+
}
|
|
1773
|
+
/**
|
|
1774
|
+
* @see https://docs.voucherify.io/reference/list-products-in-collection
|
|
1775
|
+
*/
|
|
1776
|
+
|
|
1777
|
+
|
|
1778
|
+
listProducts(productCollectionId, params) {
|
|
1779
|
+
return this.client.get(`/product-collections/${encode(productCollectionId)}/products`, params);
|
|
1780
|
+
}
|
|
1781
|
+
|
|
1782
|
+
}
|
|
1783
|
+
|
|
1619
1784
|
// apiLimitsHandler: ApiLimitsHandler
|
|
1620
1785
|
// campaigns: Campaigns
|
|
1621
1786
|
// consents: Consents
|
|
@@ -1646,7 +1811,7 @@
|
|
|
1646
1811
|
let headers = {
|
|
1647
1812
|
'X-App-Id': options.applicationId,
|
|
1648
1813
|
'X-App-Token': options.secretKey,
|
|
1649
|
-
'X-Voucherify-Channel': options.channel || `${environment()}-SDK-v${"2.
|
|
1814
|
+
'X-Voucherify-Channel': options.channel || `${environment()}-SDK-v${"2.5.0"}`,
|
|
1650
1815
|
'Content-Type': 'application/json'
|
|
1651
1816
|
};
|
|
1652
1817
|
|
|
@@ -1691,6 +1856,7 @@
|
|
|
1691
1856
|
const consents = new Consents(client);
|
|
1692
1857
|
const orders = new Orders(client);
|
|
1693
1858
|
const products = new Products(client);
|
|
1859
|
+
const productCollections = new ProductCollections(client);
|
|
1694
1860
|
const rewards = new Rewards(client);
|
|
1695
1861
|
const loyalties = new Loyalties(client);
|
|
1696
1862
|
const segments = new Segments(client);
|
|
@@ -1709,6 +1875,7 @@
|
|
|
1709
1875
|
consents,
|
|
1710
1876
|
orders,
|
|
1711
1877
|
products,
|
|
1878
|
+
productCollections,
|
|
1712
1879
|
rewards,
|
|
1713
1880
|
loyalties,
|
|
1714
1881
|
segments,
|
|
@@ -1899,7 +2066,7 @@
|
|
|
1899
2066
|
let headers = {
|
|
1900
2067
|
'X-Client-Application-Id': options.clientApplicationId,
|
|
1901
2068
|
'X-Client-Token': options.clientSecretKey,
|
|
1902
|
-
'X-Voucherify-Channel': `${environment()}-ClientSide-SDK-v${"2.
|
|
2069
|
+
'X-Voucherify-Channel': `${environment()}-ClientSide-SDK-v${"2.5.0"}`
|
|
1903
2070
|
};
|
|
1904
2071
|
|
|
1905
2072
|
if (environment().startsWith('Node')) {
|