@voucherify/sdk 2.4.0 → 2.6.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,150 @@
1
1
  # @voucherify/sdk
2
2
 
3
+ ## 2.6.0
4
+
5
+ ### Minor Changes
6
+
7
+ - [`8a3bead`](https://github.com/voucherifyio/voucherify-js-sdk/commit/8a3bead11809f676778d53dddd0ef49f6f17358d) [#252](https://github.com/voucherifyio/voucherify-js-sdk/pull/252) Thanks [@p-zielinski](https://github.com/p-zielinski)! - Added support for new endpoints and adding missing types in Rewards API.
8
+
9
+ Added support for new endpoints:
10
+
11
+ - `/loyalties/{campaignId}/rewards/{assignmentId}`,
12
+ - `/loyalties/{campaignId}/tiers/{tierId}/rewards`,
13
+ - `/rewards/{rewardId}/assignments/{assignmentId}` (example available in readme.md)
14
+
15
+ New exported types/interfaces in `Loyalties.ts`:
16
+ Domain types:
17
+
18
+ - LoyaltyTierRewardItemParameters,
19
+ - LoyaltyTierRewardItemCampaignParameters,
20
+ - LoyaltyTierRewardItemCoinParameters,
21
+ - LoyaltyTierRewardItemMaterialParameters,
22
+ - LoyaltyTierRewardItemCampaignDiscountCoupons,
23
+ - LoyaltyTierRewardItemCampaignGiftVouchersAndLoyaltyProgram
24
+
25
+ 0-level types:
26
+
27
+ - LoyaltiesGetRewardAssignmentResponseBody,
28
+ - LoyaltiesListLoyaltyTierRewardsResponseBody
29
+
30
+ New exported types/interfaces in `Rewards.ts`:
31
+ Domain types:
32
+
33
+ - RewardAssignment (old `RewardsAssignmentObject`),
34
+ - RewardsAssignmentCampaignOrMaterialReward,
35
+ - RewardsAssignmentCoinReward
36
+ -
37
+
38
+ 0-level types:
39
+
40
+ - RewardsListAssignmentsRequestQuery (old `RewardsListAssignmentsParams`),
41
+ - RewardsListAssignmentsResponseBody (old `RewardsListAssignmentsResponse`),
42
+ - RewardsCreateAssignmentRequestBody (old `RewardsCreateAssignment`),
43
+ - RewardsCreateAssignmentCoinRewardRequestBody,
44
+ - RewardsCreateAssignmentCampaignOrMaterialRewardRequestBody,
45
+ - RewardsCreateAssignmentResponseBody (old `RewardsCreateAssignmentResponse`),
46
+ - RewardsUpdateAssignmentRequestBody (old `RewardsUpdateAssignment`),
47
+ - RewardsUpdateAssignmentResponseBody (old `RewardsUpdateAssignmentResponse`)
48
+ - RewardsGetAssignmentResponseBody (brand new)
49
+
50
+ ***
51
+
52
+ Added support for following endpoints:
53
+
54
+ - GET /vouchers/{code}/transactions (client.vouchers.listTransactions(code, query))
55
+ - POST /vouchers/{code}/transactions/export (client.vouchers.exportTransactions(code, body))
56
+ - GET /validation-rules-assignments (client.client.validationRules.listRulesAssignments(validationRuleId))
57
+
58
+ **New exported types/interfaces**
59
+ Domain types:
60
+
61
+ - GiftCardTransaction
62
+ - GiftCardTransactionBase
63
+ GiftCardTransactionDetails
64
+ - GiftCardTransactionRedemptionDetails
65
+ - GiftCardTransactionRefundDetails
66
+ - GiftCardTransactionAdditionDetails
67
+ - GiftCardTransactionRemovalDetails
68
+ - VoucherTransaction
69
+ - VoucherTransactionsExportFields
70
+ - ValidationRulesAssignment
71
+
72
+ 0-level types:
73
+
74
+ - VouchersListTransactionsRequestQuery
75
+ - VouchersListTransactionsResponseBody
76
+ - VouchersExportTransactionsRequestBody
77
+ - VouchersExportTransactionsResponseBody
78
+ - ValidationRulesListRulesAssignmentsRequestQuery
79
+ - ValidationRulesListRulesAssignmentsResponseBody
80
+
81
+ **Other changes**
82
+
83
+ - Use `VouchersExportTransactionsRequestBody` as `LoyaltiesExportCardTransactionsRequestBody` (these types are identical, both related to the export of loyalty card transactions)
84
+ - Use `VouchersExportTransactionsResponseBody` as `LoyaltiesExportCardTransactionsResponseBody` (these types are identical, both related to the export of loyalty card transactions)
85
+
86
+ ***
87
+
88
+ New exported types/interfaces in `Categories.ts`:
89
+
90
+ - CategoriesListRequestQuery
91
+
92
+ Added support for query parameters(CategoriesListRequestQuery) in `/categories` (categories.list method)
93
+
94
+ ***
95
+
96
+ Add support for few endpoints of Loyalties API:
97
+
98
+ - Added support for new endpoints: `GET /promotions/{campaignId}/stacks`, `GET /promotions/{campaignId}/stacks`, `GET PUT DELETE /promotions/{campaignId}/stacks/{stackId}`, `GET /promotions/stacks` [(examples of usage available in readme.md)](..%2F..%2Fpackages%2Fsdk%2FREADME.md)
99
+ - New exported types/interfaces: `PromotionsStacksListInCampaignResponseBody`, `PromotionsStacksListResponseBody`, `PromotionsStacksListRequestQuery`, `PromotionsStacksGetResponseBody`, `PromotionsStacksUpdateRequestBody`, `PromotionsStacksUpdateResponseBody`, `PromotionsStacksCreateInCampaignRequestBody`, `PromotionsStacksCreateInCampaignResponseBody`, `PromotionStackBase`, `PromotionStack`
100
+
101
+ ## 2.5.0
102
+
103
+ ### Minor Changes
104
+
105
+ - [`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.
106
+ - 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)
107
+ - New exported types/interfaces: `LoyaltiesGetRewardAssignmentResponseBody`, `LoyaltiesGetRewardDetailsResponseBody`, `LoyaltiesListTiersRequestQuery`, `LoyaltiesListLoyaltyTierEarningRulesRequestQuery`, `LoyaltiesGetTierResponseBody`, `LoyaltiesCreateTiersRequestBody`, `LoyaltiesCreateTiersResponseBody`,`LoyaltiesListTiersResponseBody`, `LoyaltiesListMemberLoyaltyTiersResponseBody`, `LoyaltiesListLoyaltyTierEarningRulesResponseBody`, `EarningRule`, `LoyaltyTier`, `CreateLoyaltyTier`, MappingMultiply`,`MappingFixed`
108
+
109
+ * [`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.
110
+ - 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)
111
+ - 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`
112
+
113
+ - [`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.
114
+ - Added support for new endpoints:
115
+ - `GET POST /product-collections`,
116
+ - `GET DELETE /product-collections/{productCollectionId}`,
117
+ - `GET /product-collections/${productCollectionId}/products` [(examples of usage available in readme.md)](..%2F..%2Fpackages%2Fsdk%2FREADME.md)
118
+ - New exported types/interfaces in `ProductCollections.ts`:
119
+ - Domain types:
120
+ - ProductIdentity
121
+ - SkuIdentity
122
+ - ProductBase
123
+ - SkuBase
124
+ - ProductSaved
125
+ - SkuSaved
126
+ - ProductOrSkuIdentity
127
+ - ProductCollectionIdentity
128
+ - ProductCollectionSaved
129
+ - ProductCollectionBase
130
+ - StaticProductCollectionBase
131
+ - DynamicProductCollectionBase
132
+ - Filter
133
+ - Junction
134
+ - AllowedFiltersKeys
135
+ - FiltersCondition
136
+ - 0-level types:
137
+ - ProductCollectionsCreateRequestBody
138
+ - ProductCollectionsCreateResponseBody
139
+ - ProductCollectionsListRequestQuery
140
+ - ProductCollectionsListResponseBody
141
+ - ProductCollectionsGetResponseBody
142
+ - ProductCollectionsListProductsRequestQuery
143
+ - ProductCollectionsListProductsResponseBody
144
+
145
+ * [`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`.
146
+ - 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`
147
+
3
148
  ## 2.4.0
4
149
 
5
150
  ### Minor Changes
package/README.md CHANGED
@@ -155,6 +155,8 @@ Methods are provided within `client.vouchers.*` namespace.
155
155
  - [Update Vouchers in bulk](#update-vouchers-in-bulk)
156
156
  - [Release Validation Session](#release-validation-session)
157
157
  - [Import Vouchers using CSV](#import-vouchers-using-csv)
158
+ - [List Voucher Transactions](#list-voucher-transactions)
159
+ - [Export Voucher Transactions](#export-voucher-transactions)
158
160
 
159
161
  #### [Create Voucher](https://docs.voucherify.io/reference/create-voucher)
160
162
 
@@ -244,6 +246,18 @@ client.vouchers.releaseValidationSession(code, sessionKey)
244
246
  client.vouchers.importCSV(filePath)
245
247
  ```
246
248
 
249
+ #### [List Voucher Transactions](https://docs.voucherify.io/reference/list-voucher-transactions)
250
+
251
+ ```javascript
252
+ client.vouchers.listTransactions(code, query)
253
+ ```
254
+
255
+ #### [Export Voucher Transactions](https://docs.voucherify.io/reference/export-voucher-transactions)
256
+
257
+ ```javascript
258
+ client.vouchers.exportTransactions(code, body)
259
+ ```
260
+
247
261
  ---
248
262
 
249
263
  ### Campaigns
@@ -341,6 +355,7 @@ client.campaigns.disable(campaignId)
341
355
  client.campaigns.qualifications.examine(body)
342
356
  client.campaigns.qualifications.examine(body, params)
343
357
  ```
358
+
344
359
  ---
345
360
 
346
361
  ### Distributions
@@ -348,6 +363,7 @@ client.campaigns.qualifications.examine(body, params)
348
363
  Methods are provided within `client.distributions.*` namespace.
349
364
 
350
365
  - [Create Export](#create-export)
366
+ - [List Exports](#list-exports)
351
367
  - [Get Export](#get-export)
352
368
  - [Delete Export](#delete-export)
353
369
  - [List publications](#list-publications)
@@ -361,6 +377,12 @@ client.distributions.exports.create(exportObject)
361
377
 
362
378
  Check [the export object](https://docs.voucherify.io/v1/reference/the-export-object).
363
379
 
380
+ #### [List Exports](https://docs.voucherify.io/reference/list-exports)
381
+
382
+ ```javascript
383
+ client.distributions.exports.list()
384
+ ```
385
+
364
386
  #### [Get Export](https://docs.voucherify.io/reference/get-export)
365
387
 
366
388
  ```javascript
@@ -890,6 +912,47 @@ client.products.importSkusCSV(filePath)
890
912
  client.products.importCSV(filePath)
891
913
  ```
892
914
 
915
+ ### Product Collections
916
+
917
+ Methods are provided within `client.productCollections.*` namespace.
918
+
919
+ - [List Product Collections](#list-product-collections)
920
+ - [Create Product Collections](#create-product-collection)
921
+ - [Get Product Collection](#get-product-collection)
922
+ - [Delete Product Collection](#delete-product-collection)
923
+ - [List Products in Collection](#list-products-in-collection)
924
+
925
+ #### [List Product Collections](https://docs.voucherify.io/reference/list-product-collections)
926
+
927
+ ```javascript
928
+ client.productCollections.list()
929
+ ```
930
+
931
+ #### [Create Product Collection](https://docs.voucherify.io/reference/create-product-collection)
932
+
933
+ ```javascript
934
+ client.productCollections.create(productCollection)
935
+ ```
936
+
937
+ #### [Get Product Collection](https://docs.voucherify.io/reference/get-product-collection)
938
+
939
+ ```javascript
940
+ client.productCollections.get(productCollectionId)
941
+ ```
942
+
943
+ #### [Delete Product Collection](https://docs.voucherify.io/reference/delete-product-collection)
944
+
945
+ ```javascript
946
+ client.productCollections.delete(productCollectionId)
947
+ ```
948
+
949
+
950
+ #### [List Products in Collection](https://docs.voucherify.io/reference/list-products-in-collection)
951
+
952
+ ```javascript
953
+ client.productCollections.listProducts(productCollectionId)
954
+ ```
955
+
893
956
  ---
894
957
 
895
958
  ### Rewards
@@ -901,6 +964,7 @@ Methods are provided within `client.rewards.*` namespace.
901
964
  - [Update Reward](#update-reward)
902
965
  - [Delete Reward](#delete-reward)
903
966
  - [List Rewards](#list-rewards)
967
+ - [Get Assignment](#get-reward-assignment)
904
968
  - [Create Reward Assignment](#create-reward-assignment)
905
969
  - [Update Reward Assignment](#update-reward-assignment)
906
970
  - [Delete Reward Assignment](#delete-reward-assignment)
@@ -939,13 +1003,19 @@ client.rewards.list()
939
1003
  client.rewards.list(params)
940
1004
  ```
941
1005
 
1006
+ #### [Get Reward Assignment](https://docs.voucherify.io/reference/get-reward-assignment)
1007
+
1008
+ ```javascript
1009
+ client.rewards.getAssignment(rewardId, assignment)
1010
+ ```
1011
+
942
1012
  #### [Create Reward Assignment](https://docs.voucherify.io/reference/create-reward-assignment)
943
1013
 
944
1014
  ```javascript
945
1015
  client.rewards.createAssignment(rewardId, assignment)
946
1016
  ```
947
1017
 
948
- Check [reward assignment object](https://docs.voucherify.io/reference/the-reward-assignment-object).
1018
+ Check [reward assignment object](https://docs.voucherify.io/reference/reward-assignment-object).
949
1019
 
950
1020
  #### [Update Reward Assignment](https://docs.voucherify.io/reference/update-reward-assignment)
951
1021
 
@@ -980,6 +1050,7 @@ Methods are provided within `client.loyalties.*` namespace.
980
1050
  - [Create Loyalty Program Reward Assignment](#create-loyalty-program-reward-assignment)
981
1051
  - [Update Loyalty Program Reward Assignment](#update-loyalty-program-reward-assignment)
982
1052
  - [Delete Loyalty Program Reward Assignment](#delete-loyalty-program-reward-assignment)
1053
+ - [Get Loyalty Program Reward Assignment](#get-loyalty-program-reward-assignment)
983
1054
  - [List Loyalty Program Reward Assignments](#list-loyalty-program-reward-assignments)
984
1055
  - [Create Loyalty Program Earning Rules](#create-loyalty-program-earning-rules)
985
1056
  - [Update Loyalty Program Earning Rule](#update-loyalty-program-earning-rule)
@@ -990,10 +1061,23 @@ Methods are provided within `client.loyalties.*` namespace.
990
1061
  - [List Loyalty Program Earning Rules](#list-loyalty-program-earning-rules)
991
1062
  - [Create Loyalty Program Member](#create-loyalty-program-member)
992
1063
  - [Get Loyalty Program Member](#get-loyalty-program-member)
993
- - [List Loyalty Program Members](#list-loyalty-members)
1064
+ - [List Loyalty Program Members](#list-loyalty-program-members)
994
1065
  - [Get Loyalty Program Member Activities](#get-loyalty-program-member-activities)
995
- - [Add Loyalty Card Balance](#add-loyalty-card-balance)
1066
+ - [Add Or Remove Loyalty Card Balance](#add-or-remove-loyalty-card-balance)
1067
+ - [[Deprecated] Add Loyalty Card Balance](#add-loyalty-card-balance)
1068
+ - [Transfer Loyalty Points](#transfer-loyalty-points)
1069
+ - [Get Loyalty Points Expiration](#get-loyalty-points-expiration)
996
1070
  - [Redeem Loyalty Card](#redeem-loyalty-card)
1071
+ - [List Loyalty Tier Rewards](#list-loyalty-tier-rewards)
1072
+ - [List Loyalty Card Transactions](#list-loyalty-card-transactions)
1073
+ - [[Export Loyalty Card Transactions](#export-loyalty-card-transactions)
1074
+ - [Get Reward Assignment](#get-reward-assignment)
1075
+ - [Get Reward Details](#get-reward-details)
1076
+ - [List Loyalty Tiers](#list-loyalty-tiers)
1077
+ - [Get Loyalty Tier](#get-loyalty-tier)
1078
+ - [Create Loyalty Tiers](#create-loyalty-tiers)
1079
+ - [List Loyalty Tier Earning Rules](#list-loyalty-tier-earning-rules)
1080
+ - [List Member Loyalty Tiers](#list-member-loyalty-tiers)
997
1081
 
998
1082
  #### [Create Loyalty Program](https://docs.voucherify.io/reference/create-loyalty-program)
999
1083
 
@@ -1044,6 +1128,13 @@ client.loyalties.updateRewardAssignment(campaignId, assignment)
1044
1128
  client.loyalties.deleteRewardAssignment(campaignId, assignmentId)
1045
1129
  ```
1046
1130
 
1131
+ #### [Get Loyalty Program Reward Assignment](https://docs.voucherify.io/reference/get-reward-assignment-2)
1132
+
1133
+ ```javascript
1134
+ client.loyalties.getRewardAssignment(campaignId, assignmentId)
1135
+ ```
1136
+
1137
+
1047
1138
  #### [List Loyalty Program Reward Assignments](https://docs.voucherify.io/reference/list-reward-assignments-1)
1048
1139
 
1049
1140
  ```javascript
@@ -1102,6 +1193,8 @@ client.loyalties.createMember(campaignId, member)
1102
1193
 
1103
1194
  #### [Get Loyalty Program Member](https://docs.voucherify.io/reference/get-member)
1104
1195
 
1196
+ 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
1197
+
1105
1198
  ```javascript
1106
1199
  client.loyalties.getMember(campaignId, memberId)
1107
1200
  ```
@@ -1115,13 +1208,36 @@ client.loyalties.listMembers(campaignId, params)
1115
1208
 
1116
1209
  #### [Get Loyalty Program Member Activities](https://docs.voucherify.io/reference#get-member-activities)
1117
1210
 
1211
+ 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
1212
+
1118
1213
  ```javascript
1119
1214
  client.loyalties.getMemberActivities(campaignId, memberId)
1120
1215
  ```
1121
1216
 
1122
1217
  `memberId` referrers to Loyalty Card code.
1123
1218
 
1124
- #### [Add Loyalty Card Balance](https://docs.voucherify.io/reference/add-loyalty-card-balance)
1219
+
1220
+ #### [List Member Rewards](https://docs.voucherify.io/reference/list-member-rewards)
1221
+
1222
+ ```javascript
1223
+ client.loyalties.listMemberRewards(memberId, params)
1224
+ ```
1225
+
1226
+ `memberId` referrers to Loyalty Card code.
1227
+
1228
+ ---
1229
+
1230
+ #### [Add Or Remove Loyalty Card Balance](https://docs.voucherify.io/reference/add-remove-loyalty-card-balance)
1231
+
1232
+ 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
1233
+
1234
+ ```javascript
1235
+ client.loyalties.addOrRemoveCardBalance(memberId, balance, campaignId)
1236
+ ```
1237
+
1238
+ `memberId` referrers to Loyalty Card code.
1239
+
1240
+ #### [Add Loyalty Card Balance](https://docs.voucherify.io/reference/add-loyalty-card-balance-1)
1125
1241
 
1126
1242
  ```javascript
1127
1243
  client.loyalties.addPoints(campaignId, memberId, balance)
@@ -1129,6 +1245,26 @@ client.loyalties.addPoints(campaignId, memberId, balance)
1129
1245
 
1130
1246
  `memberId` referrers to Loyalty Card code.
1131
1247
 
1248
+ #### [Transfer Loyalty Points](https://docs.voucherify.io/reference/transfer-points)
1249
+
1250
+ ```javascript
1251
+ client.loyalties.transferPoints(campaignId, memberId, transferLoyaltyPoints)
1252
+ ```
1253
+
1254
+ `memberId` referrers to Loyalty Card code.
1255
+
1256
+ ---
1257
+
1258
+ #### [Get Loyalty Points Expiration](https://docs.voucherify.io/reference/get-points-expiration)
1259
+
1260
+ ```javascript
1261
+ client.loyalties.getPointsExpiration(campaignId, memberId)
1262
+ ```
1263
+
1264
+ `memberId` referrers to Loyalty Card code.
1265
+
1266
+ ---
1267
+
1132
1268
  #### [Redeem Loyalty Card]
1133
1269
 
1134
1270
  ```javascript
@@ -1139,6 +1275,96 @@ client.loyalties.redeemReward(campaignId, memberId, params)
1139
1275
 
1140
1276
  When redeeming reward with type `COIN` you need to provide additional `order` object in the `params`
1141
1277
 
1278
+ #### [List Loyalty Tier Rewards](https://docs.voucherify.io/reference/list-loyalty-tier-rewards)
1279
+
1280
+ ```javascript
1281
+ client.loyalties.listLoyaltyTierRewards(campaignId, tierId)
1282
+ ```
1283
+
1284
+ ---
1285
+
1286
+ #### [List Loyalty Card Transactions](https://docs.voucherify.io/reference/list-loyalty-card-transactions)
1287
+
1288
+ 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
1289
+
1290
+ ```javascript
1291
+ client.loyalties.listCardTransactions(memberId, campaignId, params)
1292
+ ```
1293
+
1294
+ `memberId` referrers to Loyalty Card code.
1295
+
1296
+ ---
1297
+
1298
+ #### [Export Loyalty Card Transactions](https://docs.voucherify.io/reference/export-loyalty-card-transactions)
1299
+
1300
+ 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
1301
+
1302
+ ```javascript
1303
+ client.loyalties.exportCardTransactions(memberId, campaignId, params)
1304
+ ```
1305
+
1306
+ `memberId` referrers to Loyalty Card code.
1307
+
1308
+ ---
1309
+
1310
+ #### [Get Reward Assignment](https://docs.voucherify.io/reference/get-reward-assignment-1)
1311
+
1312
+ ```javascript
1313
+ client.loyalties.getRewardAssignment(campaignId, assignmentId)
1314
+ ```
1315
+
1316
+ ---
1317
+
1318
+ #### [Get Reward Details](https://docs.voucherify.io/reference/get-reward-details)
1319
+
1320
+ ```javascript
1321
+ client.loyalties.getRewardDetails(campaignId, assignmentId)
1322
+ ```
1323
+
1324
+ ---
1325
+
1326
+ #### [List Loyalty Tiers](https://docs.voucherify.io/reference/list-loyalty-tiers)
1327
+
1328
+ ```javascript
1329
+ client.loyalties.listTiers(campaignId, params)
1330
+ client.loyalties.listTiers(campaignId)
1331
+ ```
1332
+
1333
+ ---
1334
+
1335
+ #### [Get Loyalty Tier](https://docs.voucherify.io/reference/get-loyalty-tier)
1336
+
1337
+ ```javascript
1338
+ client.loyalties.getTier(campaignId, tierId)
1339
+ ```
1340
+
1341
+ ---
1342
+
1343
+ #### [Create Loyalty Tiers](https://docs.voucherify.io/reference/create-loyalty-tiers)
1344
+
1345
+ ```javascript
1346
+ client.loyalties.createTiers(campaignId, tiers)
1347
+ ```
1348
+
1349
+ ---
1350
+
1351
+ #### [List Loyalty Tier Earning Rules](https://docs.voucherify.io/reference/list-loyalty-tier-earning-rules)
1352
+
1353
+ ```javascript
1354
+ client.loyalties.listLoyaltyTierEarningRules(campaignId, tierId, params)
1355
+ client.loyalties.listLoyaltyTierEarningRules(campaignId, tierId)
1356
+ ```
1357
+
1358
+ ---
1359
+
1360
+ #### [List Member Loyalty Tiers](https://docs.voucherify.io/reference/get-member-loyalty-tier)
1361
+
1362
+ ```javascript
1363
+ client.loyalties.listMemberLoyaltyTiers(memberId)
1364
+ ```
1365
+
1366
+ `memberId` referrers to Loyalty Card code.
1367
+
1142
1368
  ---
1143
1369
 
1144
1370
  ### Segments
@@ -1182,7 +1408,8 @@ Methods are provided within `client.validationRules.*` namespace.
1182
1408
  - [Create Rule Assignment](#create-validation-rule-assignment)
1183
1409
  - [Delete Rule Assignment](#delete-validation-rule-assignment)
1184
1410
  - [List Rules](#list-validation-rules)
1185
- - [List Rule Assignments](#list-validation-rule-assignments)
1411
+ - [List Validation Rule Assignments](#list-validation-rule-assignments)
1412
+ - [List Validation Rules Assignments](#list-validation-rules-assignments)
1186
1413
 
1187
1414
  #### [Create Validation Rule](https://docs.voucherify.io/reference/create-validation-rules)
1188
1415
 
@@ -1236,6 +1463,13 @@ client.validationRules.listAssignments(validationRuleId)
1236
1463
  client.validationRules.listAssignments(validationRuleId, params)
1237
1464
  ```
1238
1465
 
1466
+ #### [List Validation Rules Assignments](https://docs.voucherify.io/reference/list-validation-rules-assignments)
1467
+
1468
+ ```javascript
1469
+ client.validationRules.listRulesAssignments(validationRuleId)
1470
+ client.validationRules.listRulesAssignments(validationRuleId, params)
1471
+ ```
1472
+
1239
1473
  ---
1240
1474
 
1241
1475
  ### Events
@@ -6,7 +6,7 @@ export declare class Categories {
6
6
  /**
7
7
  * @see https://docs.voucherify.io/reference/list-categories
8
8
  */
9
- list(): Promise<T.ListCategories>;
9
+ list(params?: T.CategoriesListRequestQuery): Promise<T.ListCategories>;
10
10
  /**
11
11
  * @see https://docs.voucherify.io/reference/create-category
12
12
  */
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
  */
@@ -39,6 +39,10 @@ export declare class Loyalties {
39
39
  * @see https://docs.voucherify.io/reference/delete-reward-assignment-1
40
40
  */
41
41
  deleteRewardAssignment(campaignId: string, assignmentId: string): Promise<unknown>;
42
+ /**
43
+ * @see https://docs.voucherify.io/reference/get-reward-assignment-2
44
+ */
45
+ getRewardAssignment(campaignId: string, assignmentId: string): Promise<import("./types").RewardAssignment>;
42
46
  /**
43
47
  * @see https://docs.voucherify.io/reference/list-earning-rules
44
48
  */
@@ -58,7 +62,7 @@ export declare class Loyalties {
58
62
  /**
59
63
  * @see https://docs.voucherify.io/reference/get-earning-rule
60
64
  */
61
- getEarningRule(campaignId: string, earningRuleId: string): Promise<T.LoyaltiesGetEarningRuleResponseBody>;
65
+ getEarningRule(campaignId: string, earningRuleId: string): Promise<T.EarningRule>;
62
66
  /**
63
67
  * @see https://docs.voucherify.io/reference/enable-earning-rule
64
68
  */
@@ -77,18 +81,75 @@ export declare class Loyalties {
77
81
  createMember(campaignId: string, member: T.LoyaltiesCreateMember): Promise<T.LoyaltiesVoucherResponse>;
78
82
  /**
79
83
  * @see https://docs.voucherify.io/reference/get-member
84
+ * @see https://docs.voucherify.io/reference/get-member-1
80
85
  */
81
- getMember(campaignId: string, memberId: string): Promise<T.LoyaltiesVoucherResponse>;
86
+ getMember(campaignId: string | null, memberId: string): Promise<T.LoyaltiesVoucherResponse>;
82
87
  /**
83
88
  * @see https://docs.voucherify.io/reference/get-member-activities
89
+ * @see https://docs.voucherify.io/reference/get-member-activities-1
90
+ */
91
+ getMemberActivities(campaignId: string | null, memberId: string): Promise<T.LoyaltiesGetMemberActivitiesResponse>;
92
+ /**
93
+ * @see https://docs.voucherify.io/reference/list-member-rewards
84
94
  */
85
- getMemberActivities(campaignId: string, memberId: string): Promise<T.LoyaltiesGetMemberActivitiesResponse>;
95
+ listMemberRewards(memberId: string, params?: T.LoyaltiesListMemberRewardsRequestQuery): Promise<T.LoyaltiesListMemberRewardsResponseBody>;
86
96
  /**
87
- * @see https://docs.voucherify.io/reference/add-loyalty-card-balance
97
+ * @see https://docs.voucherify.io/reference/add-remove-loyalty-card-balance
98
+ * @see https://docs.voucherify.io/reference/add-remove-loyalty-card-balance-1
99
+ */
100
+ addOrRemoveCardBalance(memberId: string, balance: T.LoyaltiesAddOrRemoveCardBalanceRequestBody, campaignId?: string): Promise<T.LoyaltiesAddOrRemoveCardBalanceResponseBody>;
101
+ /**
102
+ * @see https://docs.voucherify.io/reference/add-remove-loyalty-card-balance-1
88
103
  */
89
104
  addPoints(campaignId: string, memberId: string, balance: T.LoyaltiesAddPoints): Promise<T.LoyaltiesAddPointsResponse>;
105
+ /**
106
+ * @see https://docs.voucherify.io/reference/transfer-points
107
+ */
108
+ transferPoints(campaignId: string, memberId: string, loyaltiesTransferPoints: T.LoyaltiesTransferPointsRequestBody): Promise<T.LoyaltiesTransferPointsResponseBody>;
109
+ /**
110
+ * @see https://docs.voucherify.io/reference/get-points-expiration
111
+ */
112
+ getPointsExpiration(campaignId: string, memberId: string, params?: T.LoyaltiesGetPointsExpirationRequestQuery): Promise<T.LoyaltiesGetPointsExpirationResponseBody>;
90
113
  /**
91
114
  * @see https://docs.voucherify.io/reference/redeem-loyalty-card
92
115
  */
93
116
  redeemReward(campaignId: string, memberId: string, params: T.LoyaltiesRedeemRewardParams): Promise<T.LoyaltiesRedeemRewardResponse>;
117
+ /**
118
+ * @see https://docs.voucherify.io/reference/list-loyalty-tier-rewards
119
+ */
120
+ listLoyaltyTierRewards(campaignId: string, tierId: string): Promise<T.LoyaltiesListLoyaltyTierRewardsResponseBody>;
121
+ /**
122
+ * @see https://docs.voucherify.io/reference/list-loyalty-card-transactions
123
+ * @see https://docs.voucherify.io/reference/list-loyalty-card-transactions-1
124
+ */
125
+ listCardTransactions(memberId: string, campaignId: string | null, params?: T.LoyaltiesListCardTransactionsRequestQuery): Promise<T.LoyaltiesListCardTransactionsResponseBody>;
126
+ /**
127
+ * @see https://docs.voucherify.io/reference/export-loyalty-card-transactions
128
+ * @see https://docs.voucherify.io/reference/export-loyalty-card-transactions-1
129
+ */
130
+ exportCardTransactions(memberId: string, campaignId: string | null, params?: T.LoyaltiesExportCardTransactionsRequestBody): Promise<import("./types").VouchersExportTransactionsResponseBody>;
131
+ /**
132
+ * @see https://docs.voucherify.io/reference/get-reward-details
133
+ */
134
+ getRewardDetails(campaignId: string, assignmentId: string): Promise<import("./types").Reward>;
135
+ /**
136
+ * @see https://docs.voucherify.io/reference/list-loyalty-tiers
137
+ */
138
+ listTiers(campaignId: string, params?: T.LoyaltiesListTiersRequestQuery): Promise<T.LoyaltiesListTiersResponseBody>;
139
+ /**
140
+ * @see https://docs.voucherify.io/reference/get-loyalty-tier
141
+ */
142
+ getTier(campaignId: string, tierId: string): Promise<T.LoyaltyTier>;
143
+ /**
144
+ * @see https://docs.voucherify.io/reference/create-loyalty-tiers
145
+ */
146
+ createTiers(campaignId: string, tiers: T.LoyaltiesCreateTiersRequestBody): Promise<T.LoyaltiesCreateTiersResponseBody>;
147
+ /**
148
+ * @see https://docs.voucherify.io/reference/list-loyalty-tier-earning-rules
149
+ */
150
+ listLoyaltyTierEarningRules(campaignId: string, tierId: string, params?: T.LoyaltiesListLoyaltyTierEarningRulesRequestQuery): Promise<T.LoyaltiesListLoyaltyTierEarningRulesResponseBody>;
151
+ /**
152
+ * @see https://docs.voucherify.io/reference/get-member-loyalty-tier
153
+ */
154
+ listMemberLoyaltyTiers(memberId: string): Promise<T.LoyaltiesListMemberLoyaltyTiersResponseBody>;
94
155
  }
@@ -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
+ }