[DO_NOT_MERGE] Redeemables

.changeset/witty-insects-allow.md

@@ -0,0 +1,5 @@
+---
+'@voucherify/sdk': patch
+---
+
+New endpoints support - `customer-redeemable` and `referrals-redeemable-holders`

packages/sdk/README.md

@@ -654,6 +654,7 @@ Methods are provided within `client.customers.*` namespace.
 - [Update Customers in bulk](#update-customers-in-bulk)
 - [Update Customers' Metadata in bulk](#update-customers-metadata-in-bulk)
 - [Import and Update Customers using CSV](#import-and-update-customers-using-csv)
+- [List Redeemables](#list-redeemables)
 
 #### [Create Customer](https://docs.voucherify.io/reference/create-customer)
 
@@ -759,6 +760,12 @@ client.customers.updateInBulk(customers)
 client.customers.updateMetadataInBulk(sourceIdsAndMetadata)
 ```
 
+#### [List Redeemables](https://docs.voucherify.io/reference/list-customer-redeemables)
+
+```javascript
+client.customers.listRedeemables(id, params)
+```
+
 ---
 
 ### Consents
@@ -1541,6 +1548,22 @@ client.metadataSchemas.list()
 client.metadataSchemas.get(schemaName)
 ```
 
+---
+
+### Referrals
+
+Methods are provided within `client.referrals.*` namespace.
+
+#### [Get Referrals Redeemable Holders](https://docs.voucherify.io/reference/get-member)
+
+Depending on the parameters, this method sends requests to [v1/referrals/{id}/members/{memberId}/holders](https://docs.voucherify.io/reference/referrals-member-holders) or [v1/referrals/members/{memberId}/holders](https://docs.voucherify.io/reference/referrals-member-holders-1) API endpoint
+
+```javascript
+client.referrals.listHolders(campaignId, memberId)
+```
+
+---
+
 ### Api Limits Handler
 
 Methods are provided within `client.apiLimitsHandler.*` namespace.

packages/sdk/src/Customers.ts

@@ -131,6 +131,13 @@ class Customers {
 
 		return this.client.post<AAT.AsyncActionCreateResponse>(`/customers/importCSV`, form, undefined, headers)
 	}
+
+	/**
+	 * @see https://docs.voucherify.io/reference/list-customer-redeemables
+	 */
+	public listRedeemables(id: string, params?: T.CustomerRedeemablesListQueryParams) {
+		return this.client.get<T.CustomerRedeemablesListResponse>(`/customers/${encode(id)}/redeemables`, params)
+	}
 }
 
 export { Customers }

packages/sdk/src/Referrals.ts

@@ -0,0 +1,22 @@
+import type { RequestController } from './RequestController'
+import * as T from './types/Referrals'
+import { encode } from './helpers'
+
+class Referrals {
+	constructor(private client: RequestController) {}
+
+	/**
+	 * @see https://docs.voucherify.io/reference/referrals-member-holders
+	 * @see https://docs.voucherify.io/reference/referrals-member-holders-1
+	 */
+	public listHolders(campaignId: string | null, memberId: string, params?: T.RedeemableHoldersListQueryParams) {
+		return this.client.get<T.RedeemableHoldersListResponse>(
+			campaignId
+				? `/referrals/${encode(campaignId)}/members/${memberId}/holders`
+				: `/referrals/members/${memberId}/holders`,
+			params,
+		)
+	}
+}
+
+export { Referrals }

packages/sdk/src/VoucherifyServerSide.ts

@@ -25,6 +25,7 @@ import { Categories } from './Categories'
 import { PromotionsStacks } from './PromotionsStacks'
 import { ProductCollections } from './ProductCollections'
 import { Qualifications } from './Qualifications'
+import { Referrals } from './Referrals'
 
 export interface VoucherifyServerSideOptions {
 	/**
@@ -204,6 +205,7 @@ export function VoucherifyServerSide(options: VoucherifyServerSideOptions) {
 	const validationRules = new ValidationRules(client)
 	const apiLimitsHandler = new ApiLimitsHandler(client)
 	const metadataSchemas = new MetadataSchemas(client)
+	const referrals = new Referrals(client)
 
 	return {
 		vouchers,
@@ -227,5 +229,6 @@ export function VoucherifyServerSide(options: VoucherifyServerSideOptions) {
 		asyncActions,
 		apiLimitsHandler,
 		metadataSchemas,
+		referrals,
 	}
 }

packages/sdk/src/types/Customers.ts

@@ -1,4 +1,6 @@
 // Legacy code
+import { VouchersResponse } from './Vouchers'
+
 export interface SimpleCustomer {
 	id: string
 	name?: string
@@ -121,6 +123,40 @@ export interface CustomerActivitiesListResponse {
 	data: Record<string, any>[]
 }
 
+export interface CustomerRedeemablesListQueryParams {
+	limit?: number
+	page?: number
+	order?: 'created_at' | '-created_at' | 'id' | '-id'
+	starting_after_id?: string
+	filters?: Record<string, any>
+}
+
+export interface CustomerRedeemablesListResponse {
+	object: 'list'
+	total: number
+	data_ref: 'data'
+	data: Record<string, CustomerRedeemable>[]
+}
+
+export interface CustomerRedeemable {
+	id: string
+	created_at: string
+	redeemable_id: string
+	redeemable_object: string
+	customer_id: string
+	holder_role: 'OWNER' | 'REFERRER' | 'REFEREE'
+	campaign_id: string
+	campaign_type: 'LOYALTY_PROGRAM' | 'PROMOTION' | 'DISCOUNT_COUPONS' | 'GIFT_VOUCHERS' | 'REFERRAL_PROGRAM'
+	voucher_type: 'GIFT' | 'DISCOUNT' | 'LOYALTY_CARD' | 'LUCKY_DRAW'
+	redeemable: Redeemable
+}
+
+export interface Redeemable {
+	type: string
+	voucher: VouchersResponse
+	status: 'ACTIVE' | 'USED' | 'DISABLED' | 'NOT_ACTIVE' | 'EXPIRED' | 'NO_BALANCE'
+}
+
 export type CustomersCreateBody = CustomerRequest
 export type CustomersCreateResponse = CustomerObject | CustomerUnconfirmed
 

packages/sdk/src/types/Referrals.ts

@@ -0,0 +1,27 @@
+export interface RedeemableHoldersListQueryParams {
+	limit?: number
+	page?: number
+	order?: 'created_at' | '-created_at' | 'id' | '-id'
+	starting_after_id?: string
+	filters?: Record<string, any>
+}
+
+export interface RedeemableHoldersListResponse {
+	object: 'list'
+	total: number
+	data_ref: 'data'
+	data: Record<string, RedeemableHolder>[]
+}
+
+export interface RedeemableHolder {
+	id: string
+	created_at: string
+	redeemable_id: string
+	redeemable_object: string
+	customer_id: string
+	holder_role: 'OWNER' | 'REFERRER' | 'REFEREE'
+	campaign_id: string
+	campaign_type: 'LOYALTY_PROGRAM' | 'PROMOTION' | 'DISCOUNT_COUPONS' | 'GIFT_VOUCHERS' | 'REFERRAL_PROGRAM'
+	voucher_type: 'GIFT' | 'DISCOUNT' | 'LOYALTY_CARD' | 'LUCKY_DRAW'
+	object: 'redeemable_holder'
+}

packages/sdk/test/customers.spec.ts

@@ -1,6 +1,7 @@
 import { voucherifyClient as client } from './client'
 import { generateRandomString } from './utils/generateRandomString'
 import { generateCustomerCSV } from './utils/generateCustomerCSV'
+import { CustomerRequest, DiscountVouchersTypesEnum, DistributionsPublicationsCreateParams } from '@voucherify/sdk'
 
 jest.setTimeout(15000)
 
@@ -173,4 +174,34 @@ describe('Customers API', () => {
 		}
 		expect(updatedCustomerWithNoAddress.address).toEqual(removedAddress)
 	})
+
+	it('Should return redeemable for customer', async () => {
+		const createdCustomer: CustomerRequest = await client.customers.create({ source_id: generateRandomString() })
+
+		const discountCampaign = await client.campaigns.create({
+			campaign_type: 'DISCOUNT_COUPONS',
+			name: generateRandomString(),
+			type: 'AUTO_UPDATE',
+			voucher: {
+				code_config: {
+					length: 3,
+				},
+				type: 'DISCOUNT_VOUCHER',
+				discount: {
+					amount_off: 0,
+					type: DiscountVouchersTypesEnum.AMOUNT,
+				},
+			},
+		})
+
+		const distributionsPublicationsCreateParams: DistributionsPublicationsCreateParams = {
+			customer: createdCustomer,
+			campaign: discountCampaign,
+		}
+
+		await client.distributions.publications.create(distributionsPublicationsCreateParams)
+
+		const redeemables = await client.customers.listRedeemables(createdCustomer.id as string)
+		expect(redeemables.data).toBeDefined()
+	})
 })

packages/sdk/test/referrals.spec.ts

@@ -0,0 +1,41 @@
+import { voucherifyClient as client } from './client'
+import { generateRandomString } from './utils/generateRandomString'
+import { CustomerRequest, DiscountVouchersTypesEnum, DistributionsPublicationsCreateParams } from '@voucherify/sdk'
+
+jest.setTimeout(15000)
+
+describe('Referrals API', () => {
+	it('Should return redeemable holders for campaign and member', async () => {
+		const createdCustomer: CustomerRequest = await client.customers.create({ source_id: generateRandomString() })
+
+		const referralCampaign = await client.campaigns.create({
+			campaign_type: 'REFERRAL_PROGRAM',
+			name: generateRandomString(),
+			type: 'AUTO_UPDATE',
+			voucher: {
+				code_config: {
+					length: 3,
+				},
+				type: 'DISCOUNT_VOUCHER',
+				discount: {
+					amount_off: 0,
+					type: DiscountVouchersTypesEnum.AMOUNT,
+				},
+				is_referral_code: true,
+			},
+		})
+
+		const distributionsPublicationsCreateParams: DistributionsPublicationsCreateParams = {
+			customer: createdCustomer,
+			campaign: referralCampaign,
+		}
+
+		const publication = await client.distributions.publications.create(distributionsPublicationsCreateParams)
+
+		const redeemables = await client.referrals.listHolders(referralCampaign.id, publication.voucher.id)
+		expect(redeemables.data).toBeDefined()
+
+		const redeemables2 = await client.referrals.listHolders(null, publication.voucher.id)
+		expect(redeemables2.data).toBeDefined()
+	})
+})