@voucherify/sdk 2.3.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.
@@ -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
  */
@@ -873,6 +881,22 @@
873
881
  const customerWithoutId = omit(customer, ['id']);
874
882
  return this.client.put(`/customers/${encode(id)}`, customerWithoutId);
875
883
  }
884
+ /**
885
+ * @see https://docs.voucherify.io/reference/update-customers-in-bulk
886
+ */
887
+
888
+
889
+ updateInBulk(customers) {
890
+ return this.client.post(`/customers/bulk/async`, customers);
891
+ }
892
+ /**
893
+ * @see https://docs.voucherify.io/reference/update-customers-metadata-in-bulk
894
+ */
895
+
896
+
897
+ updateMetadataInBulk(sourceIdsAndMetadata) {
898
+ return this.client.post(`/customers/metadata/async`, sourceIdsAndMetadata);
899
+ }
876
900
  /**
877
901
  * @see https://docs.voucherify.io/reference/delete-customer
878
902
  */
@@ -881,6 +905,14 @@
881
905
  delete(customerId) {
882
906
  return this.client.delete(`/customers/${encode(customerId)}`);
883
907
  }
908
+ /**
909
+ * @see https://docs.voucherify.io/reference/delete-customer-permanently
910
+ */
911
+
912
+
913
+ deletePermanently(customerId) {
914
+ return this.client.post(`/customers/${encode(customerId)}/permanent-deletion`, {});
915
+ }
884
916
  /**
885
917
  * @see https://docs.voucherify.io/reference/update-customers-consents
886
918
  */
@@ -1292,6 +1324,30 @@
1292
1324
  deleteEarningRule(campaignId, earningRuleId) {
1293
1325
  return this.client.delete(`/loyalties/${encode(campaignId)}/earning-rules/${earningRuleId}`);
1294
1326
  }
1327
+ /**
1328
+ * @see https://docs.voucherify.io/reference/get-earning-rule
1329
+ */
1330
+
1331
+
1332
+ getEarningRule(campaignId, earningRuleId) {
1333
+ return this.client.get(`/loyalties/${encode(campaignId)}/earning-rules/${encode(earningRuleId)}`);
1334
+ }
1335
+ /**
1336
+ * @see https://docs.voucherify.io/reference/enable-earning-rule
1337
+ */
1338
+
1339
+
1340
+ enableEarningRule(campaignId, earningRuleId) {
1341
+ return this.client.post(`/loyalties/${encode(campaignId)}/earning-rules/${earningRuleId}/enable`, {});
1342
+ }
1343
+ /**
1344
+ * @see https://docs.voucherify.io/reference/disable-earning-rule
1345
+ */
1346
+
1347
+
1348
+ disableEarningRule(campaignId, earningRuleId) {
1349
+ return this.client.post(`/loyalties/${encode(campaignId)}/earning-rules/${earningRuleId}/disable`, {});
1350
+ }
1295
1351
  /**
1296
1352
  * @see https://docs.voucherify.io/reference/list-members
1297
1353
  */
@@ -1310,28 +1366,63 @@
1310
1366
  }
1311
1367
  /**
1312
1368
  * @see https://docs.voucherify.io/reference/get-member
1369
+ * @see https://docs.voucherify.io/reference/get-member-1
1313
1370
  */
1314
1371
 
1315
1372
 
1316
1373
  getMember(campaignId, memberId) {
1317
- return this.client.get(`/loyalties/${encode(campaignId)}/members/${memberId}`);
1374
+ return this.client.get(campaignId ? `/loyalties/${encode(campaignId)}/members/${memberId}` : `/loyalties/members/${memberId}`);
1318
1375
  }
1319
1376
  /**
1320
1377
  * @see https://docs.voucherify.io/reference/get-member-activities
1378
+ * @see https://docs.voucherify.io/reference/get-member-activities-1
1321
1379
  */
1322
1380
 
1323
1381
 
1324
1382
  getMemberActivities(campaignId, memberId) {
1325
- 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`);
1326
1384
  }
1327
1385
  /**
1328
- * @see https://docs.voucherify.io/reference/add-loyalty-card-balance
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);
1401
+ }
1402
+ /**
1403
+ * @see https://docs.voucherify.io/reference/add-remove-loyalty-card-balance-1
1329
1404
  */
1330
1405
 
1331
1406
 
1332
1407
  addPoints(campaignId, memberId, balance) {
1333
1408
  return this.client.post(`/loyalties/${encode(campaignId)}/members/${memberId}/balance`, balance);
1334
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
+ }
1335
1426
  /**
1336
1427
  * @see https://docs.voucherify.io/reference/redeem-loyalty-card
1337
1428
  */
@@ -1340,6 +1431,80 @@
1340
1431
  redeemReward(campaignId, memberId, params) {
1341
1432
  return this.client.post(`/loyalties/${encode(campaignId)}/members/${encode(memberId)}/redemption`, params);
1342
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
+ }
1343
1508
 
1344
1509
  }
1345
1510
 
@@ -1568,6 +1733,54 @@
1568
1733
 
1569
1734
  }
1570
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
+
1571
1784
  // apiLimitsHandler: ApiLimitsHandler
1572
1785
  // campaigns: Campaigns
1573
1786
  // consents: Consents
@@ -1598,7 +1811,7 @@
1598
1811
  let headers = {
1599
1812
  'X-App-Id': options.applicationId,
1600
1813
  'X-App-Token': options.secretKey,
1601
- 'X-Voucherify-Channel': options.channel || `${environment()}-SDK-v${"2.3.0"}`,
1814
+ 'X-Voucherify-Channel': options.channel || `${environment()}-SDK-v${"2.5.0"}`,
1602
1815
  'Content-Type': 'application/json'
1603
1816
  };
1604
1817
 
@@ -1643,6 +1856,7 @@
1643
1856
  const consents = new Consents(client);
1644
1857
  const orders = new Orders(client);
1645
1858
  const products = new Products(client);
1859
+ const productCollections = new ProductCollections(client);
1646
1860
  const rewards = new Rewards(client);
1647
1861
  const loyalties = new Loyalties(client);
1648
1862
  const segments = new Segments(client);
@@ -1661,6 +1875,7 @@
1661
1875
  consents,
1662
1876
  orders,
1663
1877
  products,
1878
+ productCollections,
1664
1879
  rewards,
1665
1880
  loyalties,
1666
1881
  segments,
@@ -1851,7 +2066,7 @@
1851
2066
  let headers = {
1852
2067
  'X-Client-Application-Id': options.clientApplicationId,
1853
2068
  'X-Client-Token': options.clientSecretKey,
1854
- 'X-Voucherify-Channel': `${environment()}-ClientSide-SDK-v${"2.3.0"}`
2069
+ 'X-Voucherify-Channel': `${environment()}-ClientSide-SDK-v${"2.5.0"}`
1855
2070
  };
1856
2071
 
1857
2072
  if (environment().startsWith('Node')) {