@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.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,74 @@
1
1
  # @voucherify/sdk
2
2
 
3
+ ## 2.5.0
4
+
5
+ ### Minor Changes
6
+
7
+ - [`c33499d`](https://github.com/voucherifyio/voucherify-js-sdk/commit/c33499d1a75a882c2528c873f260633969eecbdd) [#246](https://github.com/voucherifyio/voucherify-js-sdk/pull/246) Thanks [@p-zielinski](https://github.com/p-zielinski)! - Add support for few endpoints of Loyalties API.
8
+ - Added support for new endpoints: `GET /loyalties/{campaignId}/reward-assignments/{assignmentId}`, `GET /loyalties/{campaignId}/reward-assignments/{assignmentId}/reward`, `GET /loyalties/{campaignId}/tiers`, `GET /loyalties/{campaignId}/tiers/{tierId}`, `POST /loyalties/{campaignId}/tiers`, `GET /loyalties/{campaignId}/tiers/{tierId}/earning-rules`, `GET /loyalties/members/{memberId}/tiers` [(examples of usage available in readme.md)](..%2F..%2Fpackages%2Fsdk%2FREADME.md)
9
+ - New exported types/interfaces: `LoyaltiesGetRewardAssignmentResponseBody`, `LoyaltiesGetRewardDetailsResponseBody`, `LoyaltiesListTiersRequestQuery`, `LoyaltiesListLoyaltyTierEarningRulesRequestQuery`, `LoyaltiesGetTierResponseBody`, `LoyaltiesCreateTiersRequestBody`, `LoyaltiesCreateTiersResponseBody`,`LoyaltiesListTiersResponseBody`, `LoyaltiesListMemberLoyaltyTiersResponseBody`, `LoyaltiesListLoyaltyTierEarningRulesResponseBody`, `EarningRule`, `LoyaltyTier`, `CreateLoyaltyTier`, MappingMultiply`,`MappingFixed`
10
+
11
+ * [`2d5b050`](https://github.com/voucherifyio/voucherify-js-sdk/commit/2d5b050a5f8c2df1e710b647b3a13a29d857a8e2) [#238](https://github.com/voucherifyio/voucherify-js-sdk/pull/238) Thanks [@p-zielinski](https://github.com/p-zielinski)! - Add support for few endpoints of Loyalties API.
12
+ - Added support for new endpoints: `GET /loyalties/members/{memberId}`, `GET /loyalties/members/{memberId}/activities`, `GET /loyalties/members/{memberId}/rewards`, `POST /loyalties/{campaignId}/members/{memberId}/transfers`, `GET /loyalties/{campaignId}/members/{memberId}/points-expiration`, `GET /loyalties/members/{memberId}/transactions`, `GET /loyalties/{campaignId}/members/{memberId}/transactions`, `POST /loyalties/members/{memberId}/transactions/export` and `POST /loyalties/{campaignId}/members/{memberId}/transactions/export` [(examples of usage available in readme.md)](..%2F..%2Fpackages%2Fsdk%2FREADME.md)
13
+ - New exported types/interfaces: `LoyaltiesTransferPointsResponseBody`, `LoyaltiesTransferPointsRequestBody`, `LoyaltiesListMemberRewardsRequestQuery`, `LoyaltiesListMemberRewardsResponseBody`, `LoyaltiesGetPointsExpirationRequestQuery`, `LoyaltiesGetPointsExpirationResponseBody`, `LoyaltiesListCardTransactionsRequestQuery`, `LoyaltiesListCardTransactionsResponseBody`, `LoyaltiesExportCardTransactionsRequestBody`, `LoyaltiesExportCardTransactionsResponseBody`, `LoyaltiesAddOrRemoveCardBalanceRequestBody`, `LoyaltiesAddOrRemoveCardBalanceResponseBody`, `LoyaltyCardTransaction`, `SimpleLoyaltyVoucher`, `LoyaltiesTransferPoints`, `LoyaltyCardTransactionsFields`, `LoyaltyCardTransactionsType`, `Reward`, `RewardTypeCampaign`, `RewardTypeCoin`, `RewardTypeMaterial`, `RewardType`, `RewardAssignment`
14
+
15
+ - [`e135b17`](https://github.com/voucherifyio/voucherify-js-sdk/commit/e135b1766ef73bb272629e2ce93a9878e3ec90fd) [#242](https://github.com/voucherifyio/voucherify-js-sdk/pull/242) Thanks [@weronika-kurczyna](https://github.com/weronika-kurczyna)! - Added missing methods covering Product Collections API.
16
+ - Added support for new endpoints:
17
+ - `GET POST /product-collections`,
18
+ - `GET DELETE /product-collections/{productCollectionId}`,
19
+ - `GET /product-collections/${productCollectionId}/products` [(examples of usage available in readme.md)](..%2F..%2Fpackages%2Fsdk%2FREADME.md)
20
+ - New exported types/interfaces in `ProductCollections.ts`:
21
+ - Domain types:
22
+ - ProductIdentity
23
+ - SkuIdentity
24
+ - ProductBase
25
+ - SkuBase
26
+ - ProductSaved
27
+ - SkuSaved
28
+ - ProductOrSkuIdentity
29
+ - ProductCollectionIdentity
30
+ - ProductCollectionSaved
31
+ - ProductCollectionBase
32
+ - StaticProductCollectionBase
33
+ - DynamicProductCollectionBase
34
+ - Filter
35
+ - Junction
36
+ - AllowedFiltersKeys
37
+ - FiltersCondition
38
+ - 0-level types:
39
+ - ProductCollectionsCreateRequestBody
40
+ - ProductCollectionsCreateResponseBody
41
+ - ProductCollectionsListRequestQuery
42
+ - ProductCollectionsListResponseBody
43
+ - ProductCollectionsGetResponseBody
44
+ - ProductCollectionsListProductsRequestQuery
45
+ - ProductCollectionsListProductsResponseBody
46
+
47
+ * [`841b6d5`](https://github.com/voucherifyio/voucherify-js-sdk/commit/841b6d57f33ff288666fde79c46a6945ed565659) [#244](https://github.com/voucherifyio/voucherify-js-sdk/pull/244) Thanks [@p-zielinski](https://github.com/p-zielinski)! - Add support for endpoint `GET /exports`.
48
+ - New exported types/interfaces: `ExportsListRequestQuery`, `ExportsListResponseBody`, `ExportBase`, `ExportResourceResponse`, `FieldConditions`, `ExportVoucher`, `ExportVoucherFilters`, `ExportRedemption`, `ExportRedemptionFilters`, `ExportCustomer`, `ExportCustomerFilters`, `ExportPublication`, `ExportPublicationFilters`, `ExportOrder`, `ExportOrderFilters`, `ExportPointsExpiration`, `ExportPointsExpirationFilters`, `ExportVoucherTransactionsExpiration`, `ExportVoucherTransactionsFilters`, `Junction`, `FiltersCondition`, `ExportCustomerFields`, `ExportCustomerOrder`, `ExportPublicationFields`, `ExportPublicationOrder`, `ExportRedemptionFields`, `ExportRedemptionOrder`, `ExportVoucherFields`, `ExportVoucherOrder`, `ExportOrderFields`, `ExportOrderOrder`, `ExportPointsExpirationFields`, `ExportPointsExpirationOrder`, `ExportVoucherTransactionsFields`, `ExportVoucherTransactionsOrder`
49
+
50
+ ## 2.4.0
51
+
52
+ ### Minor Changes
53
+
54
+ - [`b11ce2c`](https://github.com/voucherifyio/voucherify-js-sdk/commit/b11ce2c6410c7441bd48fbbf33377b98c77af072) [#241](https://github.com/voucherifyio/voucherify-js-sdk/pull/241) Thanks [@p-zielinski](https://github.com/p-zielinski)! - Add support for 3 missing endpoints in loyalties api. Corrected a typo in one of loyalties api method.
55
+ - Added support for new endpoints: `GET /loyalties/{campaignId}/earning-rules/{earningRuleId}`, `POST /loyalties/{campaignId}/earning-rules/{earningRuleId}/enable` and `POST /loyalties/{campaignId}/earning-rules/{earningRuleId}/disable` [(examples available in readme.md)](..%2F..%2Fpackages%2Fsdk%2FREADME.md)
56
+ - New exported types/interfaces: `LoyaltiesGetEarningRuleResponseBody`, `LoyaltiesEnableEarningRulesResponseBody`, `LoyaltiesDisableEarningRulesResponseBody`, `EarningRuleEvent`, `EarningRuleBase`, `EarningRuleFixed`, `EarningRuleProportionalOrder`, `EarningRuleProportionalOrderAmount`, `EarningRuleProportionalOrderTotalAmount`, `EarningRuleProportionalOrderMetadata`, `EarningRuleProportionalOrderItems`, `EarningRuleProportionalOrderItemsQuantity`, `EarningRuleProportionalOrderItemsAmount`, `EarningRuleProportionalOrderItemsSubtotalAmount`, `EarningRuleProportionalCustomerMetadata`, `EarningRuleProportionalCustomEvent`, `EarningRuleProportional`
57
+ - Added optional parameter `calculation_type` to `LoyaltyProportional`
58
+
59
+ * [`5bb69da`](https://github.com/voucherifyio/voucherify-js-sdk/commit/5bb69daf95c1e16c48eb5070149b88f11bfe1a30) [#229](https://github.com/voucherifyio/voucherify-js-sdk/pull/229) Thanks [@marcin-slezak](https://github.com/marcin-slezak)! - Add missing methods covering Customers API.
60
+ - Added support for new endpoints:
61
+ - `POST /customers/{customerId}/permanent-deletion`,
62
+ - `POST /customers/bulk/async`,
63
+ - `POST /customers/metadata/async` [(examples of usage available in readme.md)](..%2F..%2Fpackages%2Fsdk%2FREADME.md)
64
+ - New domain types:
65
+ - `CustomerBase`
66
+ - `CustomerAddress`
67
+ - New exported types/interfaces:
68
+ - `CustomersUpdateInBulkRequestBody`,
69
+ - `CustomersUpdateMetadataInBulkRequestBody`,
70
+ - `CustomersDeletePermanentlyResponseBody`
71
+
3
72
  ## 2.3.0
4
73
 
5
74
  ### Minor Changes
package/README.md CHANGED
@@ -130,7 +130,7 @@ const client = VoucherifyServerSide({
130
130
  apiUrl: 'https://<region>.api.voucherify.io', // optional
131
131
  apiVersion: 'v2018-08-01', // optional
132
132
  channel: 'e-commerce', // optional
133
- customHeaders: { "MY_CUSTOM_HEADER": "my_value" } // optional
133
+ customHeaders: { "MY_CUSTOM_HEADER": "my_value" }, // optional
134
134
  timeoutMs: 10000 // optional
135
135
  })
136
136
  ```
@@ -341,6 +341,7 @@ client.campaigns.disable(campaignId)
341
341
  client.campaigns.qualifications.examine(body)
342
342
  client.campaigns.qualifications.examine(body, params)
343
343
  ```
344
+
344
345
  ---
345
346
 
346
347
  ### Distributions
@@ -348,6 +349,7 @@ client.campaigns.qualifications.examine(body, params)
348
349
  Methods are provided within `client.distributions.*` namespace.
349
350
 
350
351
  - [Create Export](#create-export)
352
+ - [List Exports](#list-exports)
351
353
  - [Get Export](#get-export)
352
354
  - [Delete Export](#delete-export)
353
355
  - [List publications](#list-publications)
@@ -361,6 +363,12 @@ client.distributions.exports.create(exportObject)
361
363
 
362
364
  Check [the export object](https://docs.voucherify.io/v1/reference/the-export-object).
363
365
 
366
+ #### [List Exports](https://docs.voucherify.io/reference/list-exports)
367
+
368
+ ```javascript
369
+ client.distributions.exports.list()
370
+ ```
371
+
364
372
  #### [Get Export](https://docs.voucherify.io/reference/get-export)
365
373
 
366
374
  ```javascript
@@ -574,7 +582,7 @@ Check [promotion's tier object](https://docs.voucherify.io/reference/the-promoti
574
582
 
575
583
  ```javascript
576
584
  client.promotions.tiers.listAll()
577
- client.promotions.tiers.listAll(params})
585
+ client.promotions.tiers.listAll(params)
578
586
  ```
579
587
 
580
588
  #### [Add Promotion Tier to Campaign](https://docs.voucherify.io/reference/add-promotion-tier-to-campaign)
@@ -611,9 +619,12 @@ Methods are provided within `client.customers.*` namespace.
611
619
  - [Get Customer](#get-customer)
612
620
  - [Update Customer](#update-customer)
613
621
  - [Delete Customer](#delete-customer)
622
+ - [Delete Customer Permanently](#delete-customer-permanently)
614
623
  - [List Customers](#list-customers)
615
624
  - [Update Customer's Consents](#update-customers-consents)
616
625
  - [List Customer's Activities](#list-customers-activities)
626
+ - [Update Customers in bulk](#update-customers-in-bulk)
627
+ - [Update Customers' Metadata in bulk](#update-customers-metadata-in-bulk)
617
628
  - [Import and Update Customers using CSV](#import-and-update-customers-using-csv)
618
629
 
619
630
  #### [Create Customer](https://docs.voucherify.io/reference/create-customer)
@@ -644,6 +655,12 @@ client.customers.update(customer)
644
655
  client.customers.delete(customerId)
645
656
  ```
646
657
 
658
+ #### [Delete Customer Permanently](https://docs.voucherify.io/reference/delete-customer-permanently)
659
+
660
+ ```javascript
661
+ client.customers.deletePermanently(customerId)
662
+ ```
663
+
647
664
  #### [List Customers](https://docs.voucherify.io/reference/list-customers)
648
665
 
649
666
  ```javascript
@@ -702,6 +719,18 @@ client.customers.listActivities(customerId, params)
702
719
  client.customers.importCSV(filePath)
703
720
  ```
704
721
 
722
+ #### [Update Customers in bulk](https://docs.voucherify.io/reference/update-customers-in-bulk)
723
+
724
+ ```javascript
725
+ client.customers.updateInBulk(customers)
726
+ ```
727
+
728
+ #### [Update Customers' Metadata in bulk](https://docs.voucherify.io/reference/update-customers-metadata-in-bulk)
729
+
730
+ ```javascript
731
+ client.customers.updateMetadataInBulk(sourceIdsAndMetadata)
732
+ ```
733
+
705
734
  ---
706
735
 
707
736
  ### Consents
@@ -869,6 +898,47 @@ client.products.importSkusCSV(filePath)
869
898
  client.products.importCSV(filePath)
870
899
  ```
871
900
 
901
+ ### Product Collections
902
+
903
+ Methods are provided within `client.productCollections.*` namespace.
904
+
905
+ - [List Product Collections](#list-product-collections)
906
+ - [Create Product Collections](#create-product-collection)
907
+ - [Get Product Collection](#get-product-collection)
908
+ - [Delete Product Collection](#delete-product-collection)
909
+ - [List Products in Collection](#list-products-in-collection)
910
+
911
+ #### [List Product Collections](https://docs.voucherify.io/reference/list-product-collections)
912
+
913
+ ```javascript
914
+ client.productCollections.list()
915
+ ```
916
+
917
+ #### [Create Product Collection](https://docs.voucherify.io/reference/create-product-collection)
918
+
919
+ ```javascript
920
+ client.productCollections.create(productCollection)
921
+ ```
922
+
923
+ #### [Get Product Collection](https://docs.voucherify.io/reference/get-product-collection)
924
+
925
+ ```javascript
926
+ client.productCollections.get(productCollectionId)
927
+ ```
928
+
929
+ #### [Delete Product Collection](https://docs.voucherify.io/reference/delete-product-collection)
930
+
931
+ ```javascript
932
+ client.productCollections.delete(productCollectionId)
933
+ ```
934
+
935
+
936
+ #### [List Products in Collection](https://docs.voucherify.io/reference/list-products-in-collection)
937
+
938
+ ```javascript
939
+ client.productCollections.listProducts(productCollectionId)
940
+ ```
941
+
872
942
  ---
873
943
 
874
944
  ### Rewards
@@ -963,13 +1033,28 @@ Methods are provided within `client.loyalties.*` namespace.
963
1033
  - [Create Loyalty Program Earning Rules](#create-loyalty-program-earning-rules)
964
1034
  - [Update Loyalty Program Earning Rule](#update-loyalty-program-earning-rule)
965
1035
  - [Delete Loyalty Program Earning Rule](#delete-loyalty-program-earning-rule)
1036
+ - [Get Loyalty Program Earning Rule](#get-loyalty-program-earning-rule)
1037
+ - [Enable Loyalty Program Earning Rule](#enable-loyalty-program-earning-rule)
1038
+ - [Disable Loyalty Program Earning Rule](#disable-loyalty-program-earning-rule)
966
1039
  - [List Loyalty Program Earning Rules](#list-loyalty-program-earning-rules)
967
1040
  - [Create Loyalty Program Member](#create-loyalty-program-member)
968
1041
  - [Get Loyalty Program Member](#get-loyalty-program-member)
969
- - [List Loyalty Program Members](#list-loyalty-members)
1042
+ - [List Loyalty Program Members](#list-loyalty-program-members)
970
1043
  - [Get Loyalty Program Member Activities](#get-loyalty-program-member-activities)
971
- - [Add Loyalty Card Balance](#add-loyalty-card-balance)
1044
+ - [Add Or Remove Loyalty Card Balance](#add-or-remove-loyalty-card-balance)
1045
+ - [[Deprecated] Add Loyalty Card Balance](#add-loyalty-card-balance)
1046
+ - [Transfer Loyalty Points](#transfer-loyalty-points)
1047
+ - [Get Loyalty Points Expiration](#get-loyalty-points-expiration)
972
1048
  - [Redeem Loyalty Card](#redeem-loyalty-card)
1049
+ - [List Loyalty Card Transactions](#list-loyalty-card-transactions)
1050
+ - [[Export Loyalty Card Transactions](#export-loyalty-card-transactions)
1051
+ - [Get Reward Assignment](#get-reward-assignment)
1052
+ - [Get Reward Details](#get-reward-details)
1053
+ - [List Loyalty Tiers](#list-loyalty-tiers)
1054
+ - [Get Loyalty Tier](#get-loyalty-tier)
1055
+ - [Create Loyalty Tiers](#create-loyalty-tiers)
1056
+ - [List Loyalty Tier Earning Rules](#list-loyalty-tier-earning-rules)
1057
+ - [List Member Loyalty Tiers](#list-member-loyalty-tiers)
973
1058
 
974
1059
  #### [Create Loyalty Program](https://docs.voucherify.io/reference/create-loyalty-program)
975
1060
 
@@ -1045,6 +1130,24 @@ client.loyalties.updateEarningRule(campaignId, earningRule)
1045
1130
  client.loyalties.deleteEarningRule(campaignId, earningRuleId)
1046
1131
  ```
1047
1132
 
1133
+ #### [Get Loyalty Program Earning Rule](https://docs.voucherify.io/reference/get-earning-rule)
1134
+
1135
+ ```javascript
1136
+ client.loyalties.getEarningRule(campaignId, earningRuleId)
1137
+ ```
1138
+
1139
+ #### [Enable Loyalty Program Earning Rule](https://docs.voucherify.io/reference/enable-earning-rule)
1140
+
1141
+ ```javascript
1142
+ client.loyalties.enableEarningRule(campaignId, earningRuleId)
1143
+ ```
1144
+
1145
+ #### [Disable Loyalty Program Earning Rule](https://docs.voucherify.io/reference/disable-earning-rule)
1146
+
1147
+ ```javascript
1148
+ client.loyalties.disableEarningRule(campaignId, earningRuleId)
1149
+ ```
1150
+
1048
1151
  #### [List Loyalty Program Earning Rules](https://docs.voucherify.io/reference/list-earning-rules)
1049
1152
 
1050
1153
  ```javascript
@@ -1060,6 +1163,8 @@ client.loyalties.createMember(campaignId, member)
1060
1163
 
1061
1164
  #### [Get Loyalty Program Member](https://docs.voucherify.io/reference/get-member)
1062
1165
 
1166
+ Depending on the parameters, this method sends requests to [v1/loyalties/members/{memberId}](https://docs.voucherify.io/reference/get-member) or [v1/loyalties/{campaignId}/members/{memberId}](https://docs.voucherify.io/reference/get-member-1) API endpoint
1167
+
1063
1168
  ```javascript
1064
1169
  client.loyalties.getMember(campaignId, memberId)
1065
1170
  ```
@@ -1073,13 +1178,36 @@ client.loyalties.listMembers(campaignId, params)
1073
1178
 
1074
1179
  #### [Get Loyalty Program Member Activities](https://docs.voucherify.io/reference#get-member-activities)
1075
1180
 
1181
+ Depending on the parameters, this method sends requests to [v1/loyalties/members/{memberId}/activities](https://docs.voucherify.io/reference/get-member-activities) or [v1/loyalties/{campaignId}/members/{memberId}/activities](https://docs.voucherify.io/reference/get-member-activities-1) API endpoint
1182
+
1076
1183
  ```javascript
1077
1184
  client.loyalties.getMemberActivities(campaignId, memberId)
1078
1185
  ```
1079
1186
 
1080
1187
  `memberId` referrers to Loyalty Card code.
1081
1188
 
1082
- #### [Add Loyalty Card Balance](https://docs.voucherify.io/reference/add-loyalty-card-balance)
1189
+
1190
+ #### [List Member Rewards](https://docs.voucherify.io/reference/list-member-rewards)
1191
+
1192
+ ```javascript
1193
+ client.loyalties.listMemberRewards(memberId, params)
1194
+ ```
1195
+
1196
+ `memberId` referrers to Loyalty Card code.
1197
+
1198
+ ---
1199
+
1200
+ #### [Add Or Remove Loyalty Card Balance](https://docs.voucherify.io/reference/add-remove-loyalty-card-balance)
1201
+
1202
+ Depending on the parameters, this method sends requests to [v1/loyalties/members/{memberId}/balance](https://docs.voucherify.io/reference/add-remove-loyalty-card-balance) or [v1/loyalties/{campaignId}/members/{memberId}/balance](https://docs.voucherify.io/reference/add-remove-loyalty-card-balance-1) API endpoint
1203
+
1204
+ ```javascript
1205
+ client.loyalties.addOrRemoveCardBalance(memberId, balance, campaignId)
1206
+ ```
1207
+
1208
+ `memberId` referrers to Loyalty Card code.
1209
+
1210
+ #### [Add Loyalty Card Balance](https://docs.voucherify.io/reference/add-loyalty-card-balance-1)
1083
1211
 
1084
1212
  ```javascript
1085
1213
  client.loyalties.addPoints(campaignId, memberId, balance)
@@ -1087,6 +1215,26 @@ client.loyalties.addPoints(campaignId, memberId, balance)
1087
1215
 
1088
1216
  `memberId` referrers to Loyalty Card code.
1089
1217
 
1218
+ #### [Transfer Loyalty Points](https://docs.voucherify.io/reference/transfer-points)
1219
+
1220
+ ```javascript
1221
+ client.loyalties.transferPoints(campaignId, memberId, transferLoyaltyPoints)
1222
+ ```
1223
+
1224
+ `memberId` referrers to Loyalty Card code.
1225
+
1226
+ ---
1227
+
1228
+ #### [Get Loyalty Points Expiration](https://docs.voucherify.io/reference/get-points-expiration)
1229
+
1230
+ ```javascript
1231
+ client.loyalties.getPointsExpiration(campaignId, memberId)
1232
+ ```
1233
+
1234
+ `memberId` referrers to Loyalty Card code.
1235
+
1236
+ ---
1237
+
1090
1238
  #### [Redeem Loyalty Card]
1091
1239
 
1092
1240
  ```javascript
@@ -1099,6 +1247,90 @@ When redeeming reward with type `COIN` you need to provide additional `order` ob
1099
1247
 
1100
1248
  ---
1101
1249
 
1250
+ #### [List Loyalty Card Transactions](https://docs.voucherify.io/reference/list-loyalty-card-transactions)
1251
+
1252
+ Depending on the parameters, this method sends requests to [v1/loyalties/members/{memberId}/transactions](https://docs.voucherify.io/reference/list-loyalty-card-transactions) or [v1/loyalties/{campaignId}/members/{memberId}/transactions](https://docs.voucherify.io/reference/list-loyalty-card-transactions-1) API endpoint
1253
+
1254
+ ```javascript
1255
+ client.loyalties.listCardTransactions(memberId, campaignId, params)
1256
+ ```
1257
+
1258
+ `memberId` referrers to Loyalty Card code.
1259
+
1260
+ ---
1261
+
1262
+ #### [Export Loyalty Card Transactions](https://docs.voucherify.io/reference/export-loyalty-card-transactions)
1263
+
1264
+ Depending on the parameters, this method sends requests to [v1/loyalties/members/{memberId}/transactions/export](https://docs.voucherify.io/reference/export-loyalty-card-transactions) or [v1/loyalties/{campaignId}/members/{memberId}/transactions/export](https://docs.voucherify.io/reference/export-loyalty-card-transactions-1) API endpoint
1265
+
1266
+ ```javascript
1267
+ client.loyalties.exportCardTransactions(memberId, campaignId, params)
1268
+ ```
1269
+
1270
+ `memberId` referrers to Loyalty Card code.
1271
+
1272
+ ---
1273
+
1274
+ #### [Get Reward Assignment](https://docs.voucherify.io/reference/get-reward-assignment-1)
1275
+
1276
+ ```javascript
1277
+ client.loyalties.getRewardAssignment(campaignId, assignmentId)
1278
+ ```
1279
+
1280
+ ---
1281
+
1282
+ #### [Get Reward Details](https://docs.voucherify.io/reference/get-reward-details)
1283
+
1284
+ ```javascript
1285
+ client.loyalties.getRewardDetails(campaignId, assignmentId)
1286
+ ```
1287
+
1288
+ ---
1289
+
1290
+ #### [List Loyalty Tiers](https://docs.voucherify.io/reference/list-loyalty-tiers)
1291
+
1292
+ ```javascript
1293
+ client.loyalties.listTiers(campaignId, params)
1294
+ client.loyalties.listTiers(campaignId)
1295
+ ```
1296
+
1297
+ ---
1298
+
1299
+ #### [Get Loyalty Tier](https://docs.voucherify.io/reference/get-loyalty-tier)
1300
+
1301
+ ```javascript
1302
+ client.loyalties.getTier(campaignId, tierId)
1303
+ ```
1304
+
1305
+ ---
1306
+
1307
+ #### [Create Loyalty Tiers](https://docs.voucherify.io/reference/create-loyalty-tiers)
1308
+
1309
+ ```javascript
1310
+ client.loyalties.createTiers(campaignId, tiers)
1311
+ ```
1312
+
1313
+ ---
1314
+
1315
+ #### [List Loyalty Tier Earning Rules](https://docs.voucherify.io/reference/list-loyalty-tier-earning-rules)
1316
+
1317
+ ```javascript
1318
+ client.loyalties.listLoyaltyTierEarningRules(campaignId, tierId, params)
1319
+ client.loyalties.listLoyaltyTierEarningRules(campaignId, tierId)
1320
+ ```
1321
+
1322
+ ---
1323
+
1324
+ #### [List Member Loyalty Tiers](https://docs.voucherify.io/reference/get-member-loyalty-tier)
1325
+
1326
+ ```javascript
1327
+ client.loyalties.listMemberLoyaltyTiers(memberId)
1328
+ ```
1329
+
1330
+ `memberId` referrers to Loyalty Card code.
1331
+
1332
+ ---
1333
+
1102
1334
  ### Segments
1103
1335
 
1104
1336
  Methods are provided within `client.segments.*` namespace.
@@ -32,10 +32,22 @@ declare class Customers {
32
32
  * @see https://docs.voucherify.io/reference/update-customer
33
33
  */
34
34
  update(customer: T.CustomersUpdateParams): Promise<T.CustomersCreateResponse>;
35
+ /**
36
+ * @see https://docs.voucherify.io/reference/update-customers-in-bulk
37
+ */
38
+ updateInBulk(customers: T.CustomersUpdateInBulkRequestBody): Promise<AAT.AsyncActionCreateResponse>;
39
+ /**
40
+ * @see https://docs.voucherify.io/reference/update-customers-metadata-in-bulk
41
+ */
42
+ updateMetadataInBulk(sourceIdsAndMetadata: T.CustomersUpdateMetadataInBulkRequestBody): Promise<AAT.AsyncActionCreateResponse>;
35
43
  /**
36
44
  * @see https://docs.voucherify.io/reference/delete-customer
37
45
  */
38
46
  delete(customerId: string): Promise<undefined>;
47
+ /**
48
+ * @see https://docs.voucherify.io/reference/delete-customer-permanently
49
+ */
50
+ deletePermanently(customerId: string): Promise<T.CustomersDeletePermanentlyResponseBody>;
39
51
  /**
40
52
  * @see https://docs.voucherify.io/reference/update-customers-consents
41
53
  */
package/dist/Exports.d.ts CHANGED
@@ -7,6 +7,10 @@ export declare class Exports {
7
7
  * @see https://docs.voucherify.io/reference/create-export
8
8
  */
9
9
  create(exportResource: T.ExportResource): Promise<T.ExportsCreateResponse>;
10
+ /**
11
+ * @see https://docs.voucherify.io/reference/list-exports
12
+ */
13
+ list(query?: T.ExportsListRequestQuery): Promise<T.ExportsListResponseBody>;
10
14
  /**
11
15
  * @see https://docs.voucherify.io/reference/get-export
12
16
  */
@@ -55,6 +55,18 @@ export declare class Loyalties {
55
55
  * @see https://docs.voucherify.io/reference/delete-earning-rule
56
56
  */
57
57
  deleteEarningRule(campaignId: string, earningRuleId: string): Promise<unknown>;
58
+ /**
59
+ * @see https://docs.voucherify.io/reference/get-earning-rule
60
+ */
61
+ getEarningRule(campaignId: string, earningRuleId: string): Promise<T.EarningRule>;
62
+ /**
63
+ * @see https://docs.voucherify.io/reference/enable-earning-rule
64
+ */
65
+ enableEarningRule(campaignId: string, earningRuleId: string): Promise<T.LoyaltiesEnableEarningRulesResponseBody>;
66
+ /**
67
+ * @see https://docs.voucherify.io/reference/disable-earning-rule
68
+ */
69
+ disableEarningRule(campaignId: string, earningRuleId: string): Promise<T.LoyaltiesDisableEarningRulesResponseBody>;
58
70
  /**
59
71
  * @see https://docs.voucherify.io/reference/list-members
60
72
  */
@@ -65,18 +77,75 @@ export declare class Loyalties {
65
77
  createMember(campaignId: string, member: T.LoyaltiesCreateMember): Promise<T.LoyaltiesVoucherResponse>;
66
78
  /**
67
79
  * @see https://docs.voucherify.io/reference/get-member
80
+ * @see https://docs.voucherify.io/reference/get-member-1
68
81
  */
69
- getMember(campaignId: string, memberId: string): Promise<T.LoyaltiesVoucherResponse>;
82
+ getMember(campaignId: string | null, memberId: string): Promise<T.LoyaltiesVoucherResponse>;
70
83
  /**
71
84
  * @see https://docs.voucherify.io/reference/get-member-activities
85
+ * @see https://docs.voucherify.io/reference/get-member-activities-1
86
+ */
87
+ getMemberActivities(campaignId: string | null, memberId: string): Promise<T.LoyaltiesGetMemberActivitiesResponse>;
88
+ /**
89
+ * @see https://docs.voucherify.io/reference/list-member-rewards
72
90
  */
73
- getMemberActivities(campaignId: string, memberId: string): Promise<T.LoyaltiesGetMemberActivitiesResponse>;
91
+ listMemberRewards(memberId: string, params?: T.LoyaltiesListMemberRewardsRequestQuery): Promise<T.LoyaltiesListMemberRewardsResponseBody>;
74
92
  /**
75
- * @see https://docs.voucherify.io/reference/add-loyalty-card-balance
93
+ * @see https://docs.voucherify.io/reference/add-remove-loyalty-card-balance
94
+ * @see https://docs.voucherify.io/reference/add-remove-loyalty-card-balance-1
95
+ */
96
+ addOrRemoveCardBalance(memberId: string, balance: T.LoyaltiesAddOrRemoveCardBalanceRequestBody, campaignId?: string): Promise<T.LoyaltiesAddOrRemoveCardBalanceResponseBody>;
97
+ /**
98
+ * @see https://docs.voucherify.io/reference/add-remove-loyalty-card-balance-1
76
99
  */
77
100
  addPoints(campaignId: string, memberId: string, balance: T.LoyaltiesAddPoints): Promise<T.LoyaltiesAddPointsResponse>;
101
+ /**
102
+ * @see https://docs.voucherify.io/reference/transfer-points
103
+ */
104
+ transferPoints(campaignId: string, memberId: string, loyaltiesTransferPoints: T.LoyaltiesTransferPointsRequestBody): Promise<T.LoyaltiesTransferPointsResponseBody>;
105
+ /**
106
+ * @see https://docs.voucherify.io/reference/get-points-expiration
107
+ */
108
+ getPointsExpiration(campaignId: string, memberId: string, params?: T.LoyaltiesGetPointsExpirationRequestQuery): Promise<T.LoyaltiesGetPointsExpirationResponseBody>;
78
109
  /**
79
110
  * @see https://docs.voucherify.io/reference/redeem-loyalty-card
80
111
  */
81
112
  redeemReward(campaignId: string, memberId: string, params: T.LoyaltiesRedeemRewardParams): Promise<T.LoyaltiesRedeemRewardResponse>;
113
+ /**
114
+ * @see https://docs.voucherify.io/reference/list-loyalty-card-transactions
115
+ * @see https://docs.voucherify.io/reference/list-loyalty-card-transactions-1
116
+ */
117
+ listCardTransactions(memberId: string, campaignId: string | null, params?: T.LoyaltiesListCardTransactionsRequestQuery): Promise<T.LoyaltiesListCardTransactionsResponseBody>;
118
+ /**
119
+ * @see https://docs.voucherify.io/reference/export-loyalty-card-transactions
120
+ * @see https://docs.voucherify.io/reference/export-loyalty-card-transactions-1
121
+ */
122
+ exportCardTransactions(memberId: string, campaignId: string | null, params?: T.LoyaltiesExportCardTransactionsRequestBody): Promise<T.LoyaltiesExportCardTransactionsResponseBody>;
123
+ /**
124
+ * @see https://docs.voucherify.io/reference/get-reward-assignment-1
125
+ */
126
+ getRewardAssignment(campaignId: string, assignmentId: string): Promise<import("./types").RewardAssignment>;
127
+ /**
128
+ * @see https://docs.voucherify.io/reference/get-reward-details
129
+ */
130
+ getRewardDetails(campaignId: string, assignmentId: string): Promise<import("./types").Reward>;
131
+ /**
132
+ * @see https://docs.voucherify.io/reference/list-loyalty-tiers
133
+ */
134
+ listTiers(campaignId: string, params?: T.LoyaltiesListTiersRequestQuery): Promise<T.LoyaltiesListTiersResponseBody>;
135
+ /**
136
+ * @see https://docs.voucherify.io/reference/get-loyalty-tier
137
+ */
138
+ getTier(campaignId: string, tierId: string): Promise<T.LoyaltyTier>;
139
+ /**
140
+ * @see https://docs.voucherify.io/reference/create-loyalty-tiers
141
+ */
142
+ createTiers(campaignId: string, tiers: T.LoyaltiesCreateTiersRequestBody): Promise<T.LoyaltiesCreateTiersResponseBody>;
143
+ /**
144
+ * @see https://docs.voucherify.io/reference/list-loyalty-tier-earning-rules
145
+ */
146
+ listLoyaltyTierEarningRules(campaignId: string, tierId: string, params?: T.LoyaltiesListLoyaltyTierEarningRulesRequestQuery): Promise<T.LoyaltiesListLoyaltyTierEarningRulesResponseBody>;
147
+ /**
148
+ * @see https://docs.voucherify.io/reference/get-member-loyalty-tier
149
+ */
150
+ listMemberLoyaltyTiers(memberId: string): Promise<T.LoyaltiesListMemberLoyaltyTiersResponseBody>;
82
151
  }
@@ -0,0 +1,26 @@
1
+ import * as T from './types/ProductCollections';
2
+ import type { RequestController } from './RequestController';
3
+ export declare class ProductCollections {
4
+ private client;
5
+ constructor(client: RequestController);
6
+ /**
7
+ * @see https://docs.voucherify.io/reference/create-product-collection
8
+ */
9
+ create(productCollection: T.ProductCollectionsCreateRequestBody): Promise<T.ProductCollectionsCreateResponseBody>;
10
+ /**
11
+ * @see https://docs.voucherify.io/reference/list-product-collections
12
+ */
13
+ list(params?: T.ProductCollectionsListRequestQuery): Promise<T.ProductCollectionsListResponseBody>;
14
+ /**
15
+ * @see https://docs.voucherify.io/reference/delete-product-collection
16
+ */
17
+ delete(productCollectionId: string): Promise<{}>;
18
+ /**
19
+ * @see https://docs.voucherify.io/reference/get-product-collection
20
+ */
21
+ get(productCollectionId: string): Promise<Required<T.StaticProductCollectionBase & T.ProductCollectionIdentity & T.ProductCollectionSaved> | Required<T.DynamicProductCollectionBase & T.ProductCollectionIdentity & T.ProductCollectionSaved>>;
22
+ /**
23
+ * @see https://docs.voucherify.io/reference/list-products-in-collection
24
+ */
25
+ listProducts(productCollectionId: string, params?: T.ProductCollectionsListProductsRequestQuery): Promise<T.ProductCollectionsListProductsResponseBody>;
26
+ }
@@ -17,6 +17,7 @@ import { Segments } from './Segments';
17
17
  import { ApiLimitsHandler } from './ApiLimitsHandler';
18
18
  import { MetadataSchemas } from './MetadataSchemas';
19
19
  import { Categories } from './Categories';
20
+ import { ProductCollections } from './ProductCollections';
20
21
  export interface VoucherifyServerSideOptions {
21
22
  /**
22
23
  * Optionally, you can add `apiUrl` to the client options if you want to use Voucherify running in a specific region.
@@ -116,6 +117,7 @@ export declare function VoucherifyServerSide(options: VoucherifyServerSideOption
116
117
  consents: Consents;
117
118
  orders: Orders;
118
119
  products: Products;
120
+ productCollections: ProductCollections;
119
121
  rewards: Rewards;
120
122
  loyalties: Loyalties;
121
123
  segments: Segments;
@@ -22,3 +22,11 @@ export declare type ResponseUpdateCategory = ResponseCreateCategory & {
22
22
  updated_at: string;
23
23
  };
24
24
  export declare type UpdateCategoryRequest = CreateCategory;
25
+ export declare type Category = {
26
+ id: string;
27
+ name: string;
28
+ hierarchy: number;
29
+ created_at: string;
30
+ updated_at?: string;
31
+ object: 'category';
32
+ };
@@ -124,4 +124,46 @@ declare type IdOrSourceId = {
124
124
  export declare type CustomersUpdateParams = CustomerRequest & IdOrSourceId;
125
125
  export declare type CustomersUpdateResponse = CustomerObject | CustomerUnconfirmed;
126
126
  export declare type CustomersUpdateConsentsBody = Record<string, boolean>;
127
+ declare type CustomerBase = {
128
+ name?: string | null;
129
+ description?: string | null;
130
+ email?: string | null;
131
+ phone?: string | null;
132
+ birthdate?: string | null;
133
+ metadata?: Record<string, unknown> | null;
134
+ };
135
+ declare type CustomerAddress = {
136
+ address?: {
137
+ city?: string | null;
138
+ state?: string | null;
139
+ line_1?: string | null;
140
+ line_2?: string | null;
141
+ country?: string | null;
142
+ postal_code?: string | null;
143
+ } | null;
144
+ };
145
+ export declare type CustomersUpdateInBulkRequestBody = (CustomerBase & CustomerAddress & {
146
+ source_id: string | null;
147
+ })[];
148
+ export interface CustomersUpdateMetadataInBulkRequestBody {
149
+ source_ids: string[];
150
+ metadata: Record<string, unknown>;
151
+ }
152
+ export interface CustomersDeletePermanentlyResponseBody {
153
+ id: string;
154
+ created_at: string;
155
+ related_object_id: string;
156
+ related_object: 'customer';
157
+ status: 'DONE';
158
+ data_json: {
159
+ events: number;
160
+ customer_events: number;
161
+ daily_events: number;
162
+ segments: number;
163
+ orders: number;
164
+ order_events: number;
165
+ customer: 1;
166
+ };
167
+ object: 'pernament_deletion';
168
+ }
127
169
  export {};