@compassdigital/sdk.typescript 4.341.0 → 4.343.0

package/src/interface/consumer.ts

@@ -1296,9 +1296,9 @@ export interface ConsumerBrand {
 	hours?: ConsumerHours[];
 	deliveryHours?: ConsumerDeliveryHours[];
 	style?: {
-		logo?: string | null;
-		main_logo?: string | null;
-		alt_logo?: string | null;
+		logo?: string;
+		main_logo?: string;
+		alt_logo?: string;
 	};
 	pos?: string;
 	terminals?: Record<string, any>[];
@@ -1397,9 +1397,9 @@ export interface ConsumerGroup {
 	address?: ConsumerAddress;
 	meta?: Record<string, any>;
 	style?: {
-		logo?: string | null;
-		main_logo?: string | null;
-		alt_logo?: string | null;
+		logo?: string;
+		main_logo?: string;
+		alt_logo?: string;
 	};
 	timezone?: string;
 	date?: {
@@ -2853,6 +2853,77 @@ export interface PostConsumerShoppingCartCloneBodyRequest {
 	};
 }
 
+export interface ConsumerRewardWindowDTO {
+	// campaign start date
+	startsAt: string;
+	// campaign end date
+	endsAt: string;
+}
+
+export interface ConsumerNextRewardDTO {
+	// required points to earn the next reward
+	requiredPoints: number;
+	// progress towards the next reward
+	progress: number;
+}
+
+export interface ConsumerRewardDiscountDTO {
+	// discount type
+	type: 'AMOUNT_OFF' | 'PERCENT_OFF';
+	// percentage off for the discount
+	percentOff?: number;
+	// amount off for the discount
+	amountOff?: number;
+}
+
+export interface ConsumerRewardDTO {
+	// voucher id
+	voucherId: string;
+	// voucher code
+	voucherCode: string;
+	// campaign id
+	campaignId?: string;
+	// reward name
+	name: string;
+	// reward description
+	description?: string;
+	discount: ConsumerRewardDiscountDTO;
+	// when the voucher was issued
+	issuedAt: string;
+	// points required for this reward
+	requiredPoints: number;
+}
+
+export interface ConsumerRewardCampaignDTO {
+	// campaign id
+	campaignId: string;
+	// campaign name
+	name: string;
+	// campaign description
+	description?: string;
+	// associated brands with the campaign
+	associatedBrands?: string[];
+	// campaign status
+	active: boolean;
+	window: ConsumerRewardWindowDTO;
+	// number of points the customer has earned for this campaign
+	customerPoints: number;
+	nextReward: ConsumerNextRewardDTO;
+	// campaign rewards
+	rewards: ConsumerRewardDTO[];
+}
+
+export interface GetCustomerRewardsResponseDTO {
+	// customer id
+	customerId: string;
+	// site id
+	siteId: string;
+	// total number of rewards
+	rewardCount: number;
+	// eligible campaigns
+	campaigns: ConsumerRewardCampaignDTO[];
+}
+
 // GET /consumer/v1/health-check
 
 export interface HealthCheckControllerExecuteQuery {
@@ -3436,3 +3507,19 @@ export interface GetConsumerLocationBrandQuery {
 }
 
 export type GetConsumerLocationBrandResponse = ConsumerBrand;
+
+// GET /consumer/site/{id}/rewards - Get customer rewards for a specific site and customer
+
+export interface GetConsumerCustomerRewardsPath {
+	// Site ID
+	id: string;
+}
+
+export interface GetConsumerCustomerRewardsQuery {
+	// Customer ID as Encoded CDL ID
+	customerId?: string;
+	// Graphql query string
+	_query?: string;
+}
+
+export type GetConsumerCustomerRewardsResponse = GetCustomerRewardsResponseDTO;

package/src/interface/promo.ts

@@ -134,6 +134,7 @@ export interface Success {
 
 export interface PromoValidateRequest {
 	code?: string;
+	customer_id?: string;
 	email?: string;
 	app?: string;
 	realm?: string;
@@ -151,6 +152,7 @@ export interface PromoValidateRequest {
 
 export interface PromoVouchersValidateRequest {
 	codes?: string[];
+	customer_id?: string;
 	email?: string;
 	app?: string;
 	realm?: string;
@@ -169,6 +171,7 @@ export interface PromoVouchersValidateRequest {
 
 export interface PromoRedeemRequest {
 	code?: string;
+	customer_id?: string;
 	email?: string;
 	app?: string;
 	realm?: string;
@@ -189,6 +192,7 @@ export interface PromoRedeemRequest {
 
 export interface PromoRedeemVouchersRequest {
 	codes?: string[];
+	customer_id?: string;
 	email?: string;
 	app?: string;
 	realm?: string;