@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
|
@@ -393,6 +393,14 @@ class Exports {
|
|
|
393
393
|
create(exportResource) {
|
|
394
394
|
return this.client.post('/exports', exportResource);
|
|
395
395
|
}
|
|
396
|
+
/**
|
|
397
|
+
* @see https://docs.voucherify.io/reference/list-exports
|
|
398
|
+
*/
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
list(query = {}) {
|
|
402
|
+
return this.client.get('/exports', query);
|
|
403
|
+
}
|
|
396
404
|
/**
|
|
397
405
|
* @see https://docs.voucherify.io/reference/get-export
|
|
398
406
|
*/
|
|
@@ -1354,28 +1362,63 @@ class Loyalties {
|
|
|
1354
1362
|
}
|
|
1355
1363
|
/**
|
|
1356
1364
|
* @see https://docs.voucherify.io/reference/get-member
|
|
1365
|
+
* @see https://docs.voucherify.io/reference/get-member-1
|
|
1357
1366
|
*/
|
|
1358
1367
|
|
|
1359
1368
|
|
|
1360
1369
|
getMember(campaignId, memberId) {
|
|
1361
|
-
return this.client.get(`/loyalties/${encode(campaignId)}/members/${memberId}`);
|
|
1370
|
+
return this.client.get(campaignId ? `/loyalties/${encode(campaignId)}/members/${memberId}` : `/loyalties/members/${memberId}`);
|
|
1362
1371
|
}
|
|
1363
1372
|
/**
|
|
1364
1373
|
* @see https://docs.voucherify.io/reference/get-member-activities
|
|
1374
|
+
* @see https://docs.voucherify.io/reference/get-member-activities-1
|
|
1365
1375
|
*/
|
|
1366
1376
|
|
|
1367
1377
|
|
|
1368
1378
|
getMemberActivities(campaignId, memberId) {
|
|
1369
|
-
return this.client.get(`/loyalties/${encode(campaignId)}/members/${memberId}/activities`);
|
|
1379
|
+
return this.client.get(campaignId ? `/loyalties/${encode(campaignId)}/members/${memberId}/activities` : `/loyalties/members/${memberId}/activities`);
|
|
1380
|
+
}
|
|
1381
|
+
/**
|
|
1382
|
+
* @see https://docs.voucherify.io/reference/list-member-rewards
|
|
1383
|
+
*/
|
|
1384
|
+
|
|
1385
|
+
|
|
1386
|
+
listMemberRewards(memberId, params) {
|
|
1387
|
+
return this.client.get(`/loyalties/members/${encode(memberId)}/rewards`, params);
|
|
1388
|
+
}
|
|
1389
|
+
/**
|
|
1390
|
+
* @see https://docs.voucherify.io/reference/add-remove-loyalty-card-balance
|
|
1391
|
+
* @see https://docs.voucherify.io/reference/add-remove-loyalty-card-balance-1
|
|
1392
|
+
*/
|
|
1393
|
+
|
|
1394
|
+
|
|
1395
|
+
addOrRemoveCardBalance(memberId, balance, campaignId) {
|
|
1396
|
+
return this.client.post(campaignId ? `/loyalties/${encode(campaignId)}/members/${memberId}/balance` : `/loyalties/members/${memberId}/balance`, balance);
|
|
1370
1397
|
}
|
|
1371
1398
|
/**
|
|
1372
|
-
* @see https://docs.voucherify.io/reference/add-loyalty-card-balance
|
|
1399
|
+
* @see https://docs.voucherify.io/reference/add-remove-loyalty-card-balance-1
|
|
1373
1400
|
*/
|
|
1374
1401
|
|
|
1375
1402
|
|
|
1376
1403
|
addPoints(campaignId, memberId, balance) {
|
|
1377
1404
|
return this.client.post(`/loyalties/${encode(campaignId)}/members/${memberId}/balance`, balance);
|
|
1378
1405
|
}
|
|
1406
|
+
/**
|
|
1407
|
+
* @see https://docs.voucherify.io/reference/transfer-points
|
|
1408
|
+
*/
|
|
1409
|
+
|
|
1410
|
+
|
|
1411
|
+
transferPoints(campaignId, memberId, loyaltiesTransferPoints) {
|
|
1412
|
+
return this.client.post(`/loyalties/${encode(campaignId)}/members/${encode(memberId)}/transfers`, loyaltiesTransferPoints);
|
|
1413
|
+
}
|
|
1414
|
+
/**
|
|
1415
|
+
* @see https://docs.voucherify.io/reference/get-points-expiration
|
|
1416
|
+
*/
|
|
1417
|
+
|
|
1418
|
+
|
|
1419
|
+
getPointsExpiration(campaignId, memberId, params) {
|
|
1420
|
+
return this.client.get(`/loyalties/${encode(campaignId)}/members/${memberId}/points-expiration`, params);
|
|
1421
|
+
}
|
|
1379
1422
|
/**
|
|
1380
1423
|
* @see https://docs.voucherify.io/reference/redeem-loyalty-card
|
|
1381
1424
|
*/
|
|
@@ -1384,6 +1427,80 @@ class Loyalties {
|
|
|
1384
1427
|
redeemReward(campaignId, memberId, params) {
|
|
1385
1428
|
return this.client.post(`/loyalties/${encode(campaignId)}/members/${encode(memberId)}/redemption`, params);
|
|
1386
1429
|
}
|
|
1430
|
+
/**
|
|
1431
|
+
* @see https://docs.voucherify.io/reference/list-loyalty-card-transactions
|
|
1432
|
+
* @see https://docs.voucherify.io/reference/list-loyalty-card-transactions-1
|
|
1433
|
+
*/
|
|
1434
|
+
|
|
1435
|
+
|
|
1436
|
+
listCardTransactions(memberId, campaignId, params) {
|
|
1437
|
+
return this.client.get(campaignId ? `/loyalties/${encode(campaignId)}/members/${encode(memberId)}/transactions` : `/loyalties/members/${encode(memberId)}/transactions`, params);
|
|
1438
|
+
}
|
|
1439
|
+
/**
|
|
1440
|
+
* @see https://docs.voucherify.io/reference/export-loyalty-card-transactions
|
|
1441
|
+
* @see https://docs.voucherify.io/reference/export-loyalty-card-transactions-1
|
|
1442
|
+
*/
|
|
1443
|
+
|
|
1444
|
+
|
|
1445
|
+
exportCardTransactions(memberId, campaignId, params = {}) {
|
|
1446
|
+
return this.client.post(campaignId ? `/loyalties/${encode(campaignId)}/members/${encode(memberId)}/transactions/export` : `/loyalties/members/${encode(memberId)}/transactions/export`, params);
|
|
1447
|
+
}
|
|
1448
|
+
/**
|
|
1449
|
+
* @see https://docs.voucherify.io/reference/get-reward-assignment-1
|
|
1450
|
+
*/
|
|
1451
|
+
|
|
1452
|
+
|
|
1453
|
+
getRewardAssignment(campaignId, assignmentId) {
|
|
1454
|
+
return this.client.get(`/loyalties/${encode(campaignId)}/reward-assignments/${encode(assignmentId)}`);
|
|
1455
|
+
}
|
|
1456
|
+
/**
|
|
1457
|
+
* @see https://docs.voucherify.io/reference/get-reward-details
|
|
1458
|
+
*/
|
|
1459
|
+
|
|
1460
|
+
|
|
1461
|
+
getRewardDetails(campaignId, assignmentId) {
|
|
1462
|
+
return this.client.get(`/loyalties/${encode(campaignId)}/reward-assignments/${encode(assignmentId)}/reward`);
|
|
1463
|
+
}
|
|
1464
|
+
/**
|
|
1465
|
+
* @see https://docs.voucherify.io/reference/list-loyalty-tiers
|
|
1466
|
+
*/
|
|
1467
|
+
|
|
1468
|
+
|
|
1469
|
+
listTiers(campaignId, params) {
|
|
1470
|
+
return this.client.get(`/loyalties/${encode(campaignId)}/tiers`, params);
|
|
1471
|
+
}
|
|
1472
|
+
/**
|
|
1473
|
+
* @see https://docs.voucherify.io/reference/get-loyalty-tier
|
|
1474
|
+
*/
|
|
1475
|
+
|
|
1476
|
+
|
|
1477
|
+
getTier(campaignId, tierId) {
|
|
1478
|
+
return this.client.get(`/loyalties/${encode(campaignId)}/tiers/${encode(tierId)}`);
|
|
1479
|
+
}
|
|
1480
|
+
/**
|
|
1481
|
+
* @see https://docs.voucherify.io/reference/create-loyalty-tiers
|
|
1482
|
+
*/
|
|
1483
|
+
|
|
1484
|
+
|
|
1485
|
+
createTiers(campaignId, tiers) {
|
|
1486
|
+
return this.client.post(`/loyalties/${encode(campaignId)}/tiers`, tiers);
|
|
1487
|
+
}
|
|
1488
|
+
/**
|
|
1489
|
+
* @see https://docs.voucherify.io/reference/list-loyalty-tier-earning-rules
|
|
1490
|
+
*/
|
|
1491
|
+
|
|
1492
|
+
|
|
1493
|
+
listLoyaltyTierEarningRules(campaignId, tierId, params) {
|
|
1494
|
+
return this.client.get(`/loyalties/${encode(campaignId)}/tiers/${encode(tierId)}/earning-rules`, params);
|
|
1495
|
+
}
|
|
1496
|
+
/**
|
|
1497
|
+
* @see https://docs.voucherify.io/reference/get-member-loyalty-tier
|
|
1498
|
+
*/
|
|
1499
|
+
|
|
1500
|
+
|
|
1501
|
+
listMemberLoyaltyTiers(memberId) {
|
|
1502
|
+
return this.client.get(`/loyalties/members/${encode(memberId)}/tiers`);
|
|
1503
|
+
}
|
|
1387
1504
|
|
|
1388
1505
|
}
|
|
1389
1506
|
|
|
@@ -1612,6 +1729,54 @@ class Categories {
|
|
|
1612
1729
|
|
|
1613
1730
|
}
|
|
1614
1731
|
|
|
1732
|
+
class ProductCollections {
|
|
1733
|
+
constructor(client) {
|
|
1734
|
+
this.client = void 0;
|
|
1735
|
+
this.client = client;
|
|
1736
|
+
}
|
|
1737
|
+
/**
|
|
1738
|
+
* @see https://docs.voucherify.io/reference/create-product-collection
|
|
1739
|
+
*/
|
|
1740
|
+
|
|
1741
|
+
|
|
1742
|
+
create(productCollection) {
|
|
1743
|
+
return this.client.post(`/product-collections`, productCollection);
|
|
1744
|
+
}
|
|
1745
|
+
/**
|
|
1746
|
+
* @see https://docs.voucherify.io/reference/list-product-collections
|
|
1747
|
+
*/
|
|
1748
|
+
|
|
1749
|
+
|
|
1750
|
+
list(params) {
|
|
1751
|
+
return this.client.get(`/product-collections`, params);
|
|
1752
|
+
}
|
|
1753
|
+
/**
|
|
1754
|
+
* @see https://docs.voucherify.io/reference/delete-product-collection
|
|
1755
|
+
*/
|
|
1756
|
+
|
|
1757
|
+
|
|
1758
|
+
delete(productCollectionId) {
|
|
1759
|
+
return this.client.delete(`/product-collections/${encode(productCollectionId)}`);
|
|
1760
|
+
}
|
|
1761
|
+
/**
|
|
1762
|
+
* @see https://docs.voucherify.io/reference/get-product-collection
|
|
1763
|
+
*/
|
|
1764
|
+
|
|
1765
|
+
|
|
1766
|
+
get(productCollectionId) {
|
|
1767
|
+
return this.client.get(`/product-collections/${encode(productCollectionId)}`);
|
|
1768
|
+
}
|
|
1769
|
+
/**
|
|
1770
|
+
* @see https://docs.voucherify.io/reference/list-products-in-collection
|
|
1771
|
+
*/
|
|
1772
|
+
|
|
1773
|
+
|
|
1774
|
+
listProducts(productCollectionId, params) {
|
|
1775
|
+
return this.client.get(`/product-collections/${encode(productCollectionId)}/products`, params);
|
|
1776
|
+
}
|
|
1777
|
+
|
|
1778
|
+
}
|
|
1779
|
+
|
|
1615
1780
|
// apiLimitsHandler: ApiLimitsHandler
|
|
1616
1781
|
// campaigns: Campaigns
|
|
1617
1782
|
// consents: Consents
|
|
@@ -1642,7 +1807,7 @@ function VoucherifyServerSide(options) {
|
|
|
1642
1807
|
let headers = {
|
|
1643
1808
|
'X-App-Id': options.applicationId,
|
|
1644
1809
|
'X-App-Token': options.secretKey,
|
|
1645
|
-
'X-Voucherify-Channel': options.channel || `${environment()}-SDK-v${"2.
|
|
1810
|
+
'X-Voucherify-Channel': options.channel || `${environment()}-SDK-v${"2.5.0"}`,
|
|
1646
1811
|
'Content-Type': 'application/json'
|
|
1647
1812
|
};
|
|
1648
1813
|
|
|
@@ -1687,6 +1852,7 @@ function VoucherifyServerSide(options) {
|
|
|
1687
1852
|
const consents = new Consents(client);
|
|
1688
1853
|
const orders = new Orders(client);
|
|
1689
1854
|
const products = new Products(client);
|
|
1855
|
+
const productCollections = new ProductCollections(client);
|
|
1690
1856
|
const rewards = new Rewards(client);
|
|
1691
1857
|
const loyalties = new Loyalties(client);
|
|
1692
1858
|
const segments = new Segments(client);
|
|
@@ -1705,6 +1871,7 @@ function VoucherifyServerSide(options) {
|
|
|
1705
1871
|
consents,
|
|
1706
1872
|
orders,
|
|
1707
1873
|
products,
|
|
1874
|
+
productCollections,
|
|
1708
1875
|
rewards,
|
|
1709
1876
|
loyalties,
|
|
1710
1877
|
segments,
|
|
@@ -1895,7 +2062,7 @@ function VoucherifyClientSide(options) {
|
|
|
1895
2062
|
let headers = {
|
|
1896
2063
|
'X-Client-Application-Id': options.clientApplicationId,
|
|
1897
2064
|
'X-Client-Token': options.clientSecretKey,
|
|
1898
|
-
'X-Voucherify-Channel': `${environment()}-ClientSide-SDK-v${"2.
|
|
2065
|
+
'X-Voucherify-Channel': `${environment()}-ClientSide-SDK-v${"2.5.0"}`
|
|
1899
2066
|
};
|
|
1900
2067
|
|
|
1901
2068
|
if (environment().startsWith('Node')) {
|