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: `/loyalties/members/{memberId}`, `/loyalties/members/{memberId}/activities`, `/loyalties/members/{memberId}/rewards`, `/loyalties/{campaignId}/members/{memberId}/transfers`, `/loyalties/{campaignId}/members/{memberId}/points-expiration`, `/loyalties/members/{memberId}/transactions`, `/loyalties/{campaignId}/members/{memberId}/transactions`, `/loyalties/members/{memberId}/transactions/export` and `/loyalties/{campaignId}/members/{memberId}/transactions/export` [(examples of usage available in readme.md)](..%2F..%2Fpackages%2Fsdk%2FREADME.md)
+- New exported types/interfaces: `ListMemberRewardsParams`, `LoyaltiesListMemberRewardsResponse`, `LoyaltiesTransferPoints`, `GetPointsExpirationParams`, `LoyaltiesGetPointsExpirationResponse`, `ListLoyaltyCardTransactionsParams`, `LoyaltiesListLoyaltyCardTransactionsResponse`, `LoyaltyCardTransactionsType`, `SimpleLoyaltyVoucher`, `LoyaltyCardTransactionsResponse`, `LoyaltyCardTransactionsFields`, `LoyaltiesExportLoyaltyCardTransactionsParams` and `LoyaltiesExportLoyaltyCardTransactionsResponse`

packages/sdk/README.md

@@ -966,10 +966,18 @@ 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)
+- [Get Loyalty Program Member Without CampaignId](#get-loyalty-program-member-without-campaignid)
+- [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)
+- [Get Loyalty Program Member Activities Without CampaignId](#get-loyalty-program-member-activities-without-campaignid)
+- [Add Or Remove Loyalty Card Balance](#add-or-remove-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)
+- [List Loyalty Card Transactions With CampaignId](#list-loyalty-card-transactions-with-campaignid)
+- [[Export Loyalty Card Transactions](#export-loyalty-card-transactions)
+- [Export Loyalty Card Transactions With CampaignId](#export-loyalty-card-transactions-with-campaignid)
 
 #### [Create Loyalty Program](https://docs.voucherify.io/reference/create-loyalty-program)
 
@@ -1064,6 +1072,12 @@ client.loyalties.createMember(campaignId, member)
 client.loyalties.getMember(campaignId, memberId)
 ```
 
+#### [Get Loyalty Program Member Without CampaignId](https://docs.voucherify.io/reference/get-member-1)
+
+```javascript
+client.loyalties.getMemberWithoutCampaignId(campaignId, memberId)
+```
+
 #### [List Loyalty Program Members](https://docs.voucherify.io/reference/list-members)
 
 ```javascript
@@ -1079,14 +1093,52 @@ client.loyalties.getMemberActivities(campaignId, memberId)
 
 `memberId` referrers to Loyalty Card code.
 
-#### [Add Loyalty Card Balance](https://docs.voucherify.io/reference/add-loyalty-card-balance)
+#### [Get Loyalty Program Member Activities Without CampaignId](https://docs.voucherify.io/reference#get-member-activities)
 
 ```javascript
-client.loyalties.addPoints(campaignId, memberId, balance)
+client.loyalties.getMemberActivitiesWithoutCampaignId(memberId)
 ```
 
 `memberId` referrers to Loyalty Card code.
 
+#### [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-1)
+
+```javascript
+client.loyalties.addOrRemoveLoyaltyCardBalance(memberId, balance, campaignId)
+```
+
+`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
@@ -1099,6 +1151,46 @@ 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)
+
+```javascript
+client.loyalties.listLoyaltyCardTransactions(memberId)
+```
+
+`memberId` referrers to Loyalty Card code.
+
+---
+
+#### [List Loyalty Card Transactions With CampaignId](https://docs.voucherify.io/reference/list-loyalty-card-transactions-1)
+
+```javascript
+client.loyalties.listLoyaltyCardTransactionsWithCampaignId(campaignId, memberId)
+```
+
+`memberId` referrers to Loyalty Card code.
+
+---
+
+#### [Export Loyalty Card Transactions](https://docs.voucherify.io/reference/export-loyalty-card-transactions)
+
+```javascript
+client.loyalties.exportLoyaltyCardTransactions(memberId, exportLoyaltyCardTransactionsParams)
+```
+
+`memberId` referrers to Loyalty Card code.
+
+---
+
+#### [Export Loyalty Card Transactions With CampaignId](https://docs.voucherify.io/reference/export-loyalty-card-transactions-1)
+
+```javascript
+client.loyalties.exportLoyaltyCardTransactionsWithCampaignId(campaignId, memberId, exportLoyaltyCardTransactionsParams)
+```
+
+`memberId` referrers to Loyalty Card code.
+
+---
+
 ### Segments
 
 Methods are provided within `client.segments.*` namespace.

packages/sdk/src/Loyalties.ts

@@ -120,6 +120,12 @@ export class Loyalties {
 	public getMember(campaignId: string, memberId: string) {
 		return this.client.get<T.LoyaltiesGetMemberResponse>(`/loyalties/${encode(campaignId)}/members/${memberId}`)
 	}
+	/**
+	 * @see https://docs.voucherify.io/reference/get-member
+	 */
+	public getMemberWithoutCampaignId(memberId: string) {
+		return this.client.get<T.LoyaltiesGetMemberActivitiesResponse>(`/loyalties/members/${memberId}`)
+	}
 	/**
 	 * @see https://docs.voucherify.io/reference/get-member-activities
 	 */
@@ -129,14 +135,54 @@ export class Loyalties {
 		)
 	}
 	/**
-	 * @see https://docs.voucherify.io/reference/add-loyalty-card-balance
+	 * @see https://docs.voucherify.io/reference/get-member-activities
 	 */
-	public addPoints(campaignId: string, memberId: string, balance: T.LoyaltiesAddPoints) {
+	public getMemberActivitiesWithoutCampaignId(memberId: string) {
+		return this.client.get<T.LoyaltiesGetMemberActivitiesResponse>(`/loyalties/members/${memberId}/activities`)
+	}
+	/**
+	 * @see https://docs.voucherify.io/reference/list-member-rewards
+	 */
+	public listMemberRewards(memberId: string, params?: T.ListMemberRewardsParams) {
+		return this.client.get<T.LoyaltiesListMemberRewardsResponse>(
+			`/loyalties/members/${encode(memberId)}/rewards`,
+			params,
+		)
+	}
+	/**
+	 * @see https://docs.voucherify.io/reference/add-remove-loyalty-card-balance-1
+	 */
+	public addOrRemoveLoyaltyCardBalance(memberId: string, balance: T.LoyaltiesAddPoints, campaignId?: string) {
 		return this.client.post<T.LoyaltiesAddPointsResponse>(
-			`/loyalties/${encode(campaignId)}/members/${memberId}/balance`,
+			campaignId
+				? `/loyalties/${encode(campaignId)}/members/${memberId}/balance`
+				: `/loyalties/members/${memberId}/balance`,
 			balance,
 		)
 	}
+
+	// Backward compatibility only. This method is not mentioned in readme anymore.
+	public addPoints(campaignId: string, memberId: string, balance: T.LoyaltiesAddPoints) {
+		return this.addOrRemoveLoyaltyCardBalance(memberId, balance, campaignId)
+	}
+	/**
+	 * @see https://docs.voucherify.io/reference/transfer-points
+	 */
+	public transferPoints(campaignId: string, memberId: string, transferLoyaltyPoints: T.LoyaltiesTransferPoints[]) {
+		return this.client.post<T.LoyaltiesTransferPointsResponse>(
+			`/loyalties/${encode(campaignId)}/members/${encode(memberId)}/transfers`,
+			transferLoyaltyPoints,
+		)
+	}
+	/**
+	 * @see https://docs.voucherify.io/reference/get-points-expiration
+	 */
+	public getPointsExpiration(campaignId: string, memberId: string, params?: T.GetPointsExpirationParams) {
+		return this.client.get<T.LoyaltiesGetPointsExpirationResponse>(
+			`/loyalties/${encode(campaignId)}/members/${memberId}/points-expiration`,
+			params,
+		)
+	}
 	/**
 	 * @see https://docs.voucherify.io/reference/redeem-loyalty-card
 	 */
@@ -146,4 +192,51 @@ export class Loyalties {
 			params,
 		)
 	}
+	/**
+	 * @see https://docs.voucherify.io/reference/list-loyalty-card-transactions
+	 */
+	public listLoyaltyCardTransactions(memberId: string, params?: T.ListLoyaltyCardTransactionsParams) {
+		return this.client.get<T.LoyaltiesListLoyaltyCardTransactionsResponse>(
+			`/loyalties/members/${encode(memberId)}/transactions`,
+			params,
+		)
+	}
+	/**
+	 * @see https://docs.voucherify.io/reference/list-loyalty-card-transactions-1
+	 */
+	public listLoyaltyCardTransactionsWithCampaignId(
+		campaignId: string,
+		memberId: string,
+		params?: T.ListLoyaltyCardTransactionsParams,
+	) {
+		return this.client.get<T.LoyaltiesListLoyaltyCardTransactionsResponse>(
+			`/loyalties/${encode(campaignId)}/members/${encode(memberId)}/transactions`,
+			params,
+		)
+	}
+	/**
+	 * @see https://docs.voucherify.io/reference/export-loyalty-card-transactions
+	 */
+	public exportLoyaltyCardTransactions(
+		memberId: string,
+		exportLoyaltyCardTransactionsParams: T.LoyaltiesExportLoyaltyCardTransactionsParams,
+	) {
+		return this.client.post<T.LoyaltiesExportLoyaltyCardTransactionsResponse>(
+			`/loyalties/members/${encode(memberId)}/transactions/export`,
+			exportLoyaltyCardTransactionsParams,
+		)
+	}
+	/**
+	 * @see https://docs.voucherify.io/reference/export-loyalty-card-transactions-1
+	 */
+	public exportLoyaltyCardTransactionsWithCampaignId(
+		campaignId: string,
+		memberId: string,
+		exportLoyaltyCardTransactionsParams: T.LoyaltiesExportLoyaltyCardTransactionsParams,
+	) {
+		return this.client.post<T.LoyaltiesExportLoyaltyCardTransactionsResponse>(
+			`/loyalties/${encode(campaignId)}/members/${encode(memberId)}/transactions/export`,
+			exportLoyaltyCardTransactionsParams,
+		)
+	}
 }