Pz/types 010 - loyalties members

.changeset/tidy-comics-five.md

@@ -0,0 +1,7 @@
+---
+'@voucherify/sdk': minor
+---
+
+Add support for few endpoints of Loyalties API.
+- 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)
+- 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`

packages/sdk/README.md

@@ -990,10 +990,15 @@ Methods are provided within `client.loyalties.*` namespace.
 - [List Loyalty Program Earning Rules](#list-loyalty-program-earning-rules)
 - [Create Loyalty Program Member](#create-loyalty-program-member)
 - [Get Loyalty Program Member](#get-loyalty-program-member)
-- [List Loyalty Program Members](#list-loyalty-members)
+- [List Loyalty Program Members](#list-loyalty-program-members)
 - [Get Loyalty Program Member Activities](#get-loyalty-program-member-activities)
-- [Add Loyalty Card Balance](#add-loyalty-card-balance)
+- [Add Or Remove Loyalty Card Balance](#add-or-remove-loyalty-card-balance)
+- [[Deprecated] Add Loyalty Card Balance](#add-loyalty-card-balance)
+- [Transfer Loyalty Points](#transfer-loyalty-points)
+- [Get Loyalty Points Expiration](#get-loyalty-points-expiration)
 - [Redeem Loyalty Card](#redeem-loyalty-card)
+- [List Loyalty Card Transactions](#list-loyalty-card-transactions)
+- [[Export Loyalty Card Transactions](#export-loyalty-card-transactions)
 
 #### [Create Loyalty Program](https://docs.voucherify.io/reference/create-loyalty-program)
 
@@ -1102,6 +1107,8 @@ client.loyalties.createMember(campaignId, member)
 
 #### [Get Loyalty Program Member](https://docs.voucherify.io/reference/get-member)
 
+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
+
 ```javascript
 client.loyalties.getMember(campaignId, memberId)
 ```
@@ -1115,20 +1122,63 @@ client.loyalties.listMembers(campaignId, params)
 
 #### [Get Loyalty Program Member Activities](https://docs.voucherify.io/reference#get-member-activities)
 
+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
+
 ```javascript
 client.loyalties.getMemberActivities(campaignId, memberId)
 ```
 
 `memberId` referrers to Loyalty Card code.
 
-#### [Add Loyalty Card Balance](https://docs.voucherify.io/reference/add-loyalty-card-balance)
+
+#### [List Member Rewards](https://docs.voucherify.io/reference/list-member-rewards)
+
+```javascript
+client.loyalties.listMemberRewards(memberId, params)
+```
+
+`memberId` referrers to Loyalty Card code.
+
+---
+
+#### [Add Or Remove Loyalty Card Balance](https://docs.voucherify.io/reference/add-remove-loyalty-card-balance)
+
+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
+
+```javascript
+client.loyalties.addOrRemoveCardBalance(memberId, balance, campaignId)
+```
+
+`memberId` referrers to Loyalty Card code.
+
+#### [Add Loyalty Card Balance](https://docs.voucherify.io/reference/add-loyalty-card-balance-1)
 
 ```javascript
 client.loyalties.addPoints(campaignId, memberId, balance)
 ```
 
 `memberId` referrers to Loyalty Card code.
 
+#### [Transfer Loyalty Points](https://docs.voucherify.io/reference/transfer-points)
+
+```javascript
+client.loyalties.transferPoints(campaignId, memberId, transferLoyaltyPoints)
+```
+
+`memberId` referrers to Loyalty Card code.
+
+---
+
+#### [Get Loyalty Points Expiration](https://docs.voucherify.io/reference/get-points-expiration)
+
+```javascript
+client.loyalties.getPointsExpiration(campaignId, memberId)
+```
+
+`memberId` referrers to Loyalty Card code.
+
+---
+
 #### [Redeem Loyalty Card]
 
 ```javascript
@@ -1141,6 +1191,30 @@ When redeeming reward with type `COIN` you need to provide additional `order` ob
 
 ---
 
+#### [List Loyalty Card Transactions](https://docs.voucherify.io/reference/list-loyalty-card-transactions)
+
+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
+
+```javascript
+client.loyalties.listCardTransactions(memberId, campaignId, params)
+```
+
+`memberId` referrers to Loyalty Card code.
+
+---
+
+#### [Export Loyalty Card Transactions](https://docs.voucherify.io/reference/export-loyalty-card-transactions)
+
+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
+
+```javascript
+client.loyalties.exportCardTransactions(memberId, campaignId, params)
+```
+
+`memberId` referrers to Loyalty Card code.
+
+---
+
 ### Segments
 
 Methods are provided within `client.segments.*` namespace.

packages/sdk/src/Loyalties.ts

@@ -142,27 +142,84 @@ export class Loyalties {
 	}
 	/**
 	 * @see https://docs.voucherify.io/reference/get-member
+	 * @see https://docs.voucherify.io/reference/get-member-1
 	 */
-	public getMember(campaignId: string, memberId: string) {
-		return this.client.get<T.LoyaltiesGetMemberResponse>(`/loyalties/${encode(campaignId)}/members/${memberId}`)
+	public getMember(campaignId: string | null, memberId: string) {
+		return this.client.get<T.LoyaltiesGetMemberResponse>(
+			campaignId ? `/loyalties/${encode(campaignId)}/members/${memberId}` : `/loyalties/members/${memberId}`,
+		)
 	}
 	/**
 	 * @see https://docs.voucherify.io/reference/get-member-activities
+	 * @see https://docs.voucherify.io/reference/get-member-activities-1
 	 */
-	public getMemberActivities(campaignId: string, memberId: string) {
+	public getMemberActivities(campaignId: string | null, memberId: string) {
 		return this.client.get<T.LoyaltiesGetMemberActivitiesResponse>(
-			`/loyalties/${encode(campaignId)}/members/${memberId}/activities`,
+			campaignId
+				? `/loyalties/${encode(campaignId)}/members/${memberId}/activities`
+				: `/loyalties/members/${memberId}/activities`,
+		)
+	}
+	/**
+	 * @see https://docs.voucherify.io/reference/list-member-rewards
+	 */
+	public listMemberRewards(memberId: string, params?: T.LoyaltiesListMemberRewardsRequestQuery) {
+		return this.client.get<T.LoyaltiesListMemberRewardsResponseBody>(
+			`/loyalties/members/${encode(memberId)}/rewards`,
+			params,
 		)
 	}
 	/**
-	 * @see https://docs.voucherify.io/reference/add-loyalty-card-balance
+	 * @see https://docs.voucherify.io/reference/add-remove-loyalty-card-balance
+	 * @see https://docs.voucherify.io/reference/add-remove-loyalty-card-balance-1
+	 */
+	public addOrRemoveCardBalance(
+		memberId: string,
+		balance: T.LoyaltiesAddOrRemoveCardBalanceRequestBody,
+		campaignId?: string,
+	) {
+		return this.client.post<T.LoyaltiesAddOrRemoveCardBalanceResponseBody>(
+			campaignId
+				? `/loyalties/${encode(campaignId)}/members/${memberId}/balance`
+				: `/loyalties/members/${memberId}/balance`,
+			balance,
+		)
+	}
+	/**
+	 * @see https://docs.voucherify.io/reference/add-remove-loyalty-card-balance-1
 	 */
 	public addPoints(campaignId: string, memberId: string, balance: T.LoyaltiesAddPoints) {
 		return this.client.post<T.LoyaltiesAddPointsResponse>(
 			`/loyalties/${encode(campaignId)}/members/${memberId}/balance`,
 			balance,
 		)
 	}
+	/**
+	 * @see https://docs.voucherify.io/reference/transfer-points
+	 */
+	public transferPoints(
+		campaignId: string,
+		memberId: string,
+		loyaltiesTransferPoints: T.LoyaltiesTransferPointsRequestBody,
+	) {
+		return this.client.post<T.LoyaltiesTransferPointsResponseBody>(
+			`/loyalties/${encode(campaignId)}/members/${encode(memberId)}/transfers`,
+			loyaltiesTransferPoints,
+		)
+	}
+	/**
+	 * @see https://docs.voucherify.io/reference/get-points-expiration
+	 */
+	public getPointsExpiration(
+		campaignId: string,
+		memberId: string,
+		params?: T.LoyaltiesGetPointsExpirationRequestQuery,
+	) {
+		return this.client.get<T.LoyaltiesGetPointsExpirationResponseBody>(
+			`/loyalties/${encode(campaignId)}/members/${memberId}/points-expiration`,
+			params,
+		)
+	}
 	/**
 	 * @see https://docs.voucherify.io/reference/redeem-loyalty-card
 	 */
@@ -172,4 +229,36 @@ export class Loyalties {
 			params,
 		)
 	}
+	/**
+	 * @see https://docs.voucherify.io/reference/list-loyalty-card-transactions
+	 * @see https://docs.voucherify.io/reference/list-loyalty-card-transactions-1
+	 */
+	public listCardTransactions(
+		memberId: string,
+		campaignId: string | null,
+		params?: T.LoyaltiesListCardTransactionsRequestQuery,
+	) {
+		return this.client.get<T.LoyaltiesListCardTransactionsResponseBody>(
+			campaignId
+				? `/loyalties/${encode(campaignId)}/members/${encode(memberId)}/transactions`
+				: `/loyalties/members/${encode(memberId)}/transactions`,
+			params,
+		)
+	}
+	/**
+	 * @see https://docs.voucherify.io/reference/export-loyalty-card-transactions
+	 * @see https://docs.voucherify.io/reference/export-loyalty-card-transactions-1
+	 */
+	public exportCardTransactions(
+		memberId: string,
+		campaignId: string | null,
+		params: T.LoyaltiesExportCardTransactionsRequestBody = {},
+	) {
+		return this.client.post<T.LoyaltiesExportCardTransactionsResponseBody>(
+			campaignId
+				? `/loyalties/${encode(campaignId)}/members/${encode(memberId)}/transactions/export`
+				: `/loyalties/members/${encode(memberId)}/transactions/export`,
+			params,
+		)
+	}
 }