@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
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,52 @@
|
|
|
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
|
+
|
|
3
50
|
## 2.4.0
|
|
4
51
|
|
|
5
52
|
### Minor Changes
|
package/README.md
CHANGED
|
@@ -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
|
|
@@ -890,6 +898,47 @@ client.products.importSkusCSV(filePath)
|
|
|
890
898
|
client.products.importCSV(filePath)
|
|
891
899
|
```
|
|
892
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
|
+
|
|
893
942
|
---
|
|
894
943
|
|
|
895
944
|
### Rewards
|
|
@@ -990,10 +1039,22 @@ Methods are provided within `client.loyalties.*` namespace.
|
|
|
990
1039
|
- [List Loyalty Program Earning Rules](#list-loyalty-program-earning-rules)
|
|
991
1040
|
- [Create Loyalty Program Member](#create-loyalty-program-member)
|
|
992
1041
|
- [Get Loyalty Program Member](#get-loyalty-program-member)
|
|
993
|
-
- [List Loyalty Program Members](#list-loyalty-members)
|
|
1042
|
+
- [List Loyalty Program Members](#list-loyalty-program-members)
|
|
994
1043
|
- [Get Loyalty Program Member Activities](#get-loyalty-program-member-activities)
|
|
995
|
-
- [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)
|
|
996
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)
|
|
997
1058
|
|
|
998
1059
|
#### [Create Loyalty Program](https://docs.voucherify.io/reference/create-loyalty-program)
|
|
999
1060
|
|
|
@@ -1102,6 +1163,8 @@ client.loyalties.createMember(campaignId, member)
|
|
|
1102
1163
|
|
|
1103
1164
|
#### [Get Loyalty Program Member](https://docs.voucherify.io/reference/get-member)
|
|
1104
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
|
+
|
|
1105
1168
|
```javascript
|
|
1106
1169
|
client.loyalties.getMember(campaignId, memberId)
|
|
1107
1170
|
```
|
|
@@ -1115,13 +1178,36 @@ client.loyalties.listMembers(campaignId, params)
|
|
|
1115
1178
|
|
|
1116
1179
|
#### [Get Loyalty Program Member Activities](https://docs.voucherify.io/reference#get-member-activities)
|
|
1117
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
|
+
|
|
1118
1183
|
```javascript
|
|
1119
1184
|
client.loyalties.getMemberActivities(campaignId, memberId)
|
|
1120
1185
|
```
|
|
1121
1186
|
|
|
1122
1187
|
`memberId` referrers to Loyalty Card code.
|
|
1123
1188
|
|
|
1124
|
-
|
|
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)
|
|
1125
1211
|
|
|
1126
1212
|
```javascript
|
|
1127
1213
|
client.loyalties.addPoints(campaignId, memberId, balance)
|
|
@@ -1129,6 +1215,26 @@ client.loyalties.addPoints(campaignId, memberId, balance)
|
|
|
1129
1215
|
|
|
1130
1216
|
`memberId` referrers to Loyalty Card code.
|
|
1131
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
|
+
|
|
1132
1238
|
#### [Redeem Loyalty Card]
|
|
1133
1239
|
|
|
1134
1240
|
```javascript
|
|
@@ -1141,6 +1247,90 @@ When redeeming reward with type `COIN` you need to provide additional `order` ob
|
|
|
1141
1247
|
|
|
1142
1248
|
---
|
|
1143
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
|
+
|
|
1144
1334
|
### Segments
|
|
1145
1335
|
|
|
1146
1336
|
Methods are provided within `client.segments.*` namespace.
|
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
|
*/
|
package/dist/Loyalties.d.ts
CHANGED
|
@@ -58,7 +58,7 @@ export declare class Loyalties {
|
|
|
58
58
|
/**
|
|
59
59
|
* @see https://docs.voucherify.io/reference/get-earning-rule
|
|
60
60
|
*/
|
|
61
|
-
getEarningRule(campaignId: string, earningRuleId: string): Promise<T.
|
|
61
|
+
getEarningRule(campaignId: string, earningRuleId: string): Promise<T.EarningRule>;
|
|
62
62
|
/**
|
|
63
63
|
* @see https://docs.voucherify.io/reference/enable-earning-rule
|
|
64
64
|
*/
|
|
@@ -77,18 +77,75 @@ export declare class Loyalties {
|
|
|
77
77
|
createMember(campaignId: string, member: T.LoyaltiesCreateMember): Promise<T.LoyaltiesVoucherResponse>;
|
|
78
78
|
/**
|
|
79
79
|
* @see https://docs.voucherify.io/reference/get-member
|
|
80
|
+
* @see https://docs.voucherify.io/reference/get-member-1
|
|
80
81
|
*/
|
|
81
|
-
getMember(campaignId: string, memberId: string): Promise<T.LoyaltiesVoucherResponse>;
|
|
82
|
+
getMember(campaignId: string | null, memberId: string): Promise<T.LoyaltiesVoucherResponse>;
|
|
82
83
|
/**
|
|
83
84
|
* @see https://docs.voucherify.io/reference/get-member-activities
|
|
85
|
+
* @see https://docs.voucherify.io/reference/get-member-activities-1
|
|
84
86
|
*/
|
|
85
|
-
getMemberActivities(campaignId: string, memberId: string): Promise<T.LoyaltiesGetMemberActivitiesResponse>;
|
|
87
|
+
getMemberActivities(campaignId: string | null, memberId: string): Promise<T.LoyaltiesGetMemberActivitiesResponse>;
|
|
86
88
|
/**
|
|
87
|
-
* @see https://docs.voucherify.io/reference/
|
|
89
|
+
* @see https://docs.voucherify.io/reference/list-member-rewards
|
|
90
|
+
*/
|
|
91
|
+
listMemberRewards(memberId: string, params?: T.LoyaltiesListMemberRewardsRequestQuery): Promise<T.LoyaltiesListMemberRewardsResponseBody>;
|
|
92
|
+
/**
|
|
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
|
|
88
99
|
*/
|
|
89
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>;
|
|
90
109
|
/**
|
|
91
110
|
* @see https://docs.voucherify.io/reference/redeem-loyalty-card
|
|
92
111
|
*/
|
|
93
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>;
|
|
94
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
|
+
};
|
package/dist/types/Exports.d.ts
CHANGED
|
@@ -28,3 +28,122 @@ export interface ExportsCreateResponse {
|
|
|
28
28
|
};
|
|
29
29
|
}
|
|
30
30
|
export declare type ExportsGetResponse = ExportsCreateResponse;
|
|
31
|
+
export interface ExportsListRequestQuery {
|
|
32
|
+
limit?: number;
|
|
33
|
+
order?: 'created_at' | '-created_at' | 'status' | '-status';
|
|
34
|
+
page?: number;
|
|
35
|
+
}
|
|
36
|
+
export interface ExportsListResponseBody {
|
|
37
|
+
object: 'list';
|
|
38
|
+
data_ref: 'exports';
|
|
39
|
+
exports: Export[];
|
|
40
|
+
total: number;
|
|
41
|
+
}
|
|
42
|
+
export interface ExportBase {
|
|
43
|
+
id: string;
|
|
44
|
+
object: 'export';
|
|
45
|
+
created_at: string;
|
|
46
|
+
status: 'SCHEDULED' | 'IN_PROGRESS' | 'DONE' | 'ERROR';
|
|
47
|
+
channel?: string;
|
|
48
|
+
result: {
|
|
49
|
+
url: string;
|
|
50
|
+
} | null;
|
|
51
|
+
user_id: string | null;
|
|
52
|
+
}
|
|
53
|
+
export declare type Export = ExportBase & (ExportVoucher | ExportRedemption | ExportCustomer | ExportPublication | ExportOrder | ExportPointsExpiration | ExportVoucherTransactionsExpiration);
|
|
54
|
+
export declare type FieldConditions = {
|
|
55
|
+
conditions?: Partial<Record<FiltersCondition, unknown>>;
|
|
56
|
+
};
|
|
57
|
+
export interface ExportVoucher {
|
|
58
|
+
exported_object: 'voucher';
|
|
59
|
+
parameters: {
|
|
60
|
+
order?: ExportVoucherOrder;
|
|
61
|
+
fields?: ExportVoucherFields[];
|
|
62
|
+
filters?: ExportVoucherFilters;
|
|
63
|
+
};
|
|
64
|
+
}
|
|
65
|
+
export declare type ExportVoucherFilters = {
|
|
66
|
+
junction?: Junction;
|
|
67
|
+
} & Partial<Record<ExportVoucherFields, FieldConditions>>;
|
|
68
|
+
export interface ExportRedemption {
|
|
69
|
+
exported_object: 'redemption';
|
|
70
|
+
parameters: {
|
|
71
|
+
order?: ExportRedemptionOrder;
|
|
72
|
+
fields?: ExportRedemptionFields[];
|
|
73
|
+
filters?: ExportRedemptionFilters;
|
|
74
|
+
};
|
|
75
|
+
}
|
|
76
|
+
export declare type ExportRedemptionFilters = {
|
|
77
|
+
junction?: Junction;
|
|
78
|
+
} & Partial<Record<ExportRedemptionFields, FieldConditions>>;
|
|
79
|
+
export interface ExportCustomer {
|
|
80
|
+
exported_object: 'customer';
|
|
81
|
+
parameters: {
|
|
82
|
+
order?: ExportCustomerOrder;
|
|
83
|
+
fields?: ExportCustomerFields[];
|
|
84
|
+
filters?: ExportCustomerFilters;
|
|
85
|
+
};
|
|
86
|
+
}
|
|
87
|
+
export declare type ExportCustomerFilters = {
|
|
88
|
+
junction?: Junction;
|
|
89
|
+
} & Partial<Record<ExportCustomerFields, FieldConditions>>;
|
|
90
|
+
export interface ExportPublication {
|
|
91
|
+
exported_object: 'publication';
|
|
92
|
+
parameters: {
|
|
93
|
+
order?: ExportPublicationOrder;
|
|
94
|
+
fields?: ExportPublicationFields[];
|
|
95
|
+
filters?: ExportPublicationFilters;
|
|
96
|
+
};
|
|
97
|
+
}
|
|
98
|
+
export declare type ExportPublicationFilters = {
|
|
99
|
+
junction?: Junction;
|
|
100
|
+
} & Partial<Record<ExportPublicationFields, FieldConditions>>;
|
|
101
|
+
export interface ExportOrder {
|
|
102
|
+
exported_object: 'order';
|
|
103
|
+
parameters: {
|
|
104
|
+
order?: ExportOrderOrder;
|
|
105
|
+
fields?: ExportOrderFields[];
|
|
106
|
+
filters?: ExportOrderFilters;
|
|
107
|
+
};
|
|
108
|
+
}
|
|
109
|
+
export declare type ExportOrderFilters = {
|
|
110
|
+
junction?: Junction;
|
|
111
|
+
} & Partial<Record<ExportOrderFields, FieldConditions>>;
|
|
112
|
+
export interface ExportPointsExpiration {
|
|
113
|
+
exported_object: 'points_expiration';
|
|
114
|
+
parameters: {
|
|
115
|
+
order?: ExportPointsExpirationOrder;
|
|
116
|
+
fields?: ExportPointsExpirationFields[];
|
|
117
|
+
filters?: ExportPointsExpirationFilters;
|
|
118
|
+
};
|
|
119
|
+
}
|
|
120
|
+
export declare type ExportPointsExpirationFilters = {
|
|
121
|
+
junction?: Junction;
|
|
122
|
+
} & Partial<Record<ExportPointsExpirationFields, FieldConditions>>;
|
|
123
|
+
export interface ExportVoucherTransactionsExpiration {
|
|
124
|
+
exported_object: 'voucher_transactions';
|
|
125
|
+
parameters: {
|
|
126
|
+
order?: ExportVoucherTransactionsOrder;
|
|
127
|
+
fields?: ExportVoucherTransactionsFields[];
|
|
128
|
+
filters?: ExportVoucherTransactionsFilters;
|
|
129
|
+
};
|
|
130
|
+
}
|
|
131
|
+
export declare type ExportVoucherTransactionsFilters = {
|
|
132
|
+
junction?: Junction;
|
|
133
|
+
} & Partial<Record<ExportVoucherTransactionsFields, FieldConditions>>;
|
|
134
|
+
export declare type Junction = 'and' | 'AND' | 'or' | 'OR';
|
|
135
|
+
export declare type FiltersCondition = '$in' | '$not_in' | '$is' | '$is_days_ago' | '$is_days_in_future' | '$is_not' | '$has_value' | '$is_unknown' | '$contains' | '$not_contain' | '$starts_with' | '$ends_with' | '$more_than' | '$less_than' | '$more_than_ago' | '$less_than_ago' | '$more_than_future' | '$less_than_future' | '$more_than_equal' | '$less_than_equal' | '$after' | '$before' | '$count' | '$count_less' | '$count_more';
|
|
136
|
+
export declare type ExportCustomerFields = 'name' | 'id' | 'description' | 'email' | 'source_id' | 'created_at' | 'address_city' | 'address_state' | 'address_line_1' | 'address_line_2' | 'address_country' | 'address_postal_code' | 'redemptions_total_redeemed' | 'redemptions_total_failed' | 'redemptions_total_succeeded' | 'redemptions_total_rolled_back' | 'redemptions_total_rollback_failed' | 'redemptions_total_rollback_succeeded' | 'orders_total_amount' | 'orders_total_count' | 'orders_average_amount' | 'orders_last_order_amount' | 'orders_last_order_date' | 'loyalty_points' | 'loyalty_referred_customers' | 'updated_at' | 'phone' | 'birthday' | 'metadata' | 'birthdate';
|
|
137
|
+
export declare type ExportCustomerOrder = ExportCustomerFields | '-name' | '-id' | '-description' | '-email' | '-source_id' | '-created_at' | '-address_city' | '-address_state' | '-address_line_1' | '-address_line_2' | '-address_country' | '-address_postal_code' | '-redemptions_total_redeemed' | '-redemptions_total_failed' | '-redemptions_total_succeeded' | '-redemptions_total_rolled_back' | '-redemptions_total_rollback_failed' | '-redemptions_total_rollback_succeeded' | '-orders_total_amount' | '-orders_total_count' | '-orders_average_amount' | '-orders_last_order_amount' | '-orders_last_order_date' | '-loyalty_points' | '-loyalty_referred_customers' | '-updated_at' | '-phone' | '-birthday' | '-metadata' | '-birthdate';
|
|
138
|
+
export declare type ExportPublicationFields = 'voucher_code' | 'customer_id' | 'customer_source_id' | 'date' | 'channel' | 'campaign' | 'is_winner' | 'metadata';
|
|
139
|
+
export declare type ExportPublicationOrder = ExportPublicationFields | '-voucher_code' | '-customer_id' | '-customer_source_id' | '-date' | '-channel' | '-campaign' | '-is_winner' | '-metadata';
|
|
140
|
+
export declare type ExportRedemptionFields = 'id' | 'object' | 'date' | 'voucher_code' | 'campaign' | 'promotion_tier_id' | 'customer_id' | 'customer_source_id' | 'customer_name' | 'tracking_id' | 'order_amount' | 'gift_amount' | 'loyalty_points' | 'result' | 'failure_code' | 'failure_message' | 'metadata';
|
|
141
|
+
export declare type ExportRedemptionOrder = ExportRedemptionFields | '-id' | '-object' | '-date' | '-voucher_code' | '-campaign' | '-promotion_tier_id' | '-customer_id' | '-customer_source_id' | '-customer_name' | '-tracking_id' | '-order_amount' | '-gift_amount' | '-loyalty_points' | '-result' | '-failure_code' | '-failure_message' | '-metadata';
|
|
142
|
+
export declare type ExportVoucherFields = 'code' | 'voucher_type' | 'value' | 'discount_type' | 'campaign' | 'category' | 'start_date' | 'expiration_date' | 'gift_balance' | 'loyalty_balance' | 'redemption_quantity' | 'redemption_count' | 'active' | 'qr_code' | 'bar_code' | 'metadata' | 'id' | 'is_referral_code' | 'created_at' | 'updated_at' | 'validity_timeframe_interval' | 'validity_timeframe_duration' | 'validity_day_of_week' | 'discount_amount_limit' | 'campaign_id' | 'additional_info' | 'customer_id' | 'discount_unit_type' | 'discount_unit_effect' | 'customer_source_id';
|
|
143
|
+
export declare type ExportVoucherOrder = ExportVoucherFields | '-code' | '-voucher_type' | '-value' | '-discount_type' | '-campaign' | '-category' | '-start_date' | '-expiration_date' | '-gift_balance' | '-loyalty_balance' | '-redemption_quantity' | '-redemption_count' | '-active' | '-qr_code' | '-bar_code' | '-metadata' | '-id' | '-is_referral_code' | '-created_at' | '-updated_at' | '-validity_timeframe_interval' | '-validity_timeframe_duration' | '-validity_day_of_week' | '-discount_amount_limit' | '-campaign_id' | '-additional_info' | '-customer_id' | '-discount_unit_type' | '-discount_unit_effect' | '-customer_source_id';
|
|
144
|
+
export declare type ExportOrderFields = 'id' | 'source_id' | 'created_at' | 'updated_at' | 'status' | 'amount' | 'discount_amount' | 'items_discount_amount' | 'total_discount_amount' | 'total_amount' | 'customer_id' | 'referrer_id' | 'metadata';
|
|
145
|
+
export declare type ExportOrderOrder = ExportOrderFields | '-id' | '-source_id' | '-created_at' | '-updated_at' | '-status' | '-amount' | '-discount_amount' | '-items_discount_amount' | '-total_discount_amount' | '-total_amount' | '-customer_id' | '-referrer_id' | '-metadata';
|
|
146
|
+
export declare type ExportPointsExpirationFields = 'id' | 'campaign_id' | 'voucher_id' | 'points' | 'status' | 'expires_at';
|
|
147
|
+
export declare type ExportPointsExpirationOrder = ExportPointsExpirationFields | '-id' | '-campaign_id' | '-voucher_id' | '-points' | '-status' | '-expires_at';
|
|
148
|
+
export declare type ExportVoucherTransactionsFields = 'id' | 'campaign_id' | 'voucher_id' | 'type' | 'source_id' | 'reason' | 'source' | 'balance' | 'amount' | 'related_transaction_id' | 'created_at' | 'details';
|
|
149
|
+
export declare type ExportVoucherTransactionsOrder = ExportVoucherTransactionsFields | '-id' | '-campaign_id' | '-voucher_id' | '-type' | '-source_id' | '-reason' | '-source' | '-balance' | '-amount' | '-related_transaction_id' | '-created_at' | '-details';
|