Support for new endpoints: List Member Activity (#282)

* Support for new endpoints: List Member Activity

* requested changes

Author: p-zielinski

.changeset/five-dancers-fetch.md

@@ -0,0 +1,5 @@
+---
+'@voucherify/sdk': minor
+---
+
+Support for new endpoints: List Member Activity

packages/sdk/src/Loyalties.ts

@@ -158,8 +158,19 @@ export class Loyalties {
 		)
 	}
 	/**
-	 * @see https://docs.voucherify.io/reference/get-member-activities
-	 * @see https://docs.voucherify.io/reference/get-member-activities-1
+	 * @see https://docs.voucherify.io/reference/list-member-activity
+	 * @see https://docs.voucherify.io/reference/list-member-activity-1
+	 */
+	public listMemberActivity(campaignId: string | null, memberId: string, params?: T.LoyaltiesListMemberActivityParams) {
+		return this.client.get<T.LoyaltiesListMemberActivityResponse>(
+			campaignId
+				? `/loyalties/${encode(campaignId)}/members/${memberId}/activity`
+				: `/loyalties/members/${memberId}/activity`,
+			params,
+		)
+	}
+	/**
+	 * @deprecated This method is deprecated in favor of the `listMemberActivity` method. We’re removing this method in next major version.
 	 */
 	public getMemberActivities(campaignId: string | null, memberId: string) {
 		return this.client.get<T.LoyaltiesGetMemberActivitiesResponse>(

packages/sdk/src/types/Loyalties.ts

@@ -320,6 +320,26 @@ export type LoyaltiesCreateMemberResponse = LoyaltiesVoucherResponse
 
 export type LoyaltiesGetMemberResponse = LoyaltiesCreateMemberResponse
 
+export type LoyaltiesListMemberActivityParams = {
+	order?: 'created_at' | '-created_at'
+	starting_after_id?: string
+	limit?: number //max 100
+}
+
+export type LoyaltiesListMemberActivityResponse = {
+	object: 'list'
+	data_ref: 'data'
+	data: {
+		id: string
+		type: string
+		data: any
+		created_at: string
+		group_id: string
+	}[]
+	has_more: boolean
+	more_starting_after?: string
+}
+
 export interface LoyaltiesGetMemberActivitiesResponse {
 	object: 'list'
 	data_ref: 'activities'
@@ -712,11 +732,6 @@ export interface LoyaltiesGetPointsExpirationResponseBody {
 	total: number
 }
 
-export interface LoyaltiesListCardTransactionsRequestQuery {
-	limit?: number
-	page?: number
-}
-
 export type LoyaltiesExportCardTransactionsResponseBody = VouchersExportTransactionsResponseBody
 
 export interface LoyaltiesAddOrRemoveCardBalanceRequestBody {
@@ -904,6 +919,7 @@ export interface LoyaltyCardTransaction {
 			type: 'loyalty_card'
 			total: number
 			object: 'balance'
+			operation_type: 'MANUAL' | 'AUTOMATIC'
 			points: number
 			balance: number
 			related_object: {

packages/sdk/test/loyalties.spec.ts

@@ -159,7 +159,7 @@ describe('Loyalties API', () => {
 		} as LoyaltiesAddPointsResponse)
 	})
 
-	it('Should list members activities', async () => {
+	it('Should list member transactions', async () => {
 		const memberCardTransactions = await client.loyalties.listCardTransactions(loyaltiesMember.code, null)
 		expect(memberCardTransactions).toEqual({
 			object: 'list',
@@ -174,14 +174,15 @@ describe('Loyalties API', () => {
 					reason: null,
 					type: 'POINTS_ADDITION',
 					details: {
-						balance: expect.objectContaining({
+						balance: {
 							type: 'loyalty_card',
 							total: startBalance + addPoints,
+							operation_type: 'MANUAL',
 							object: 'balance',
 							points: addPoints,
 							balance: startBalance + addPoints,
 							related_object: { id: expect.stringMatching(/^v_.*/), type: 'voucher' },
-						}),
+						},
 					},
 					related_transaction_id: null,
 					created_at: expect.stringMatching(isoRegex),
@@ -192,6 +193,22 @@ describe('Loyalties API', () => {
 		} as LoyaltiesListCardTransactionsResponseBody)
 	})
 
+	it('Should list member activity', async () => {
+		const listMemberActivityResponse = await client.loyalties.listMemberActivity(null, loyaltiesMember.code, {
+			limit: 1,
+		})
+		expect(listMemberActivityResponse).toEqual(
+			expect.objectContaining({
+				object: 'list',
+				data_ref: 'data',
+				has_more: true,
+				more_starting_after: expect.stringMatching(/.*/),
+			}),
+		)
+		expect(listMemberActivityResponse.data.length).toEqual(1)
+		expect(typeof listMemberActivityResponse.data[0].type).toEqual('string')
+	})
+
 	it('Should generate and update campaign stack', async () => {
 		const campaign = await client.campaigns.create({
 			campaign_type: 'PROMOTION',

packages/sdk/test/vouchers.spec.ts

@@ -52,7 +52,7 @@ describe('Vouchers API', () => {
 			}
 		})
 		it('should return all the required fields, the `filters` object and should not return `order` and `fields` if they were not passed in request body', async () => {
-			const code = (await generateGiftVoucher()).code
+			const { code } = await generateGiftVoucher()
 			const response = await client.vouchers.exportTransactions(code, { parameters: {} })
 			expect(typeof response.parameters.filters).toBe('object')
 			expect(response.parameters).not.toContain('order')