@compassdigital/sdk.typescript 4.879.0 → 4.881.0

package/src/interface/consumer.ts

@@ -589,7 +589,7 @@ export interface ConsumerDiscountIs {
 }
 
 export interface ConsumerVoucherifyMetaDataDiscount {
-	type: 'AMOUNT_OFF' | 'PERCENT_OFF' | 'FIXED_PRICE';
+	type: 'AMOUNT_OFF' | 'PERCENT_OFF' | 'FIXED_PRICE' | 'FREE';
 	amountOff?: number;
 	percentOff?: number;
 	fixedPrice?: number;
@@ -1449,11 +1449,28 @@ export interface ConsumerDiscountSchedule {
 
 export interface ConsumerDiscountMethod {
 	// discount method name
-	name: Record<string, any>;
+	name: 'AMOUNT_OFF' | 'PERCENT_OFF' | 'FIXED_PRICE' | 'FREE';
 	// discount method value
 	value: number;
 }
 
+export interface ConsumerItemLevelConfigDetails {
+	// Marks the bundle group that receives the discount for Buy X Get Y.
+	isDiscounted?: boolean;
+	// How many extra items are discounted per qualified set for Buy X Get X. Applies to PERCENT_OFF, AMOUNT_OFF, and FREE.
+	discountedItemQuantity?: number;
+	bundleGroupName?: string;
+	bundleGroupId?: string;
+	minimum: number;
+}
+
+export interface ConsumerItemLevelConfig {
+	details: ConsumerItemLevelConfigDetails[];
+	// Lower integer = higher priority when multiple overlapping bundles exist.
+	bundlePriority?: number;
+	sectorName?: string;
+}
+
 export interface ConsumerDiscountChannelConfig {
 	// thrive channel
 	thrive: boolean;
@@ -1478,6 +1495,9 @@ export interface ConsumerDiscountDTO {
 	schedule?: ConsumerDiscountSchedule;
 	// discount method configuration
 	method: ConsumerDiscountMethod;
+	type: 'Total Order' | 'Single Items' | 'Bundle' | 'Buy X Get Y' | 'Buy X Get X';
+	// bundle groups of an item level discount
+	itemLevelConfig?: ConsumerItemLevelConfig;
 	createdAt: string;
 	updatedAt: string;
 	name: string;
@@ -1485,7 +1505,6 @@ export interface ConsumerDiscountDTO {
 	is?: ConsumerDiscountIs;
 	meta?: ConsumerDiscountMeta;
 	channelConfig: ConsumerDiscountChannelConfig;
-	type: Record<string, any>;
 }
 
 export interface ConsumerMenuHours {

package/src/messages/events/CampaignStatusChangedEvent.ts

@@ -0,0 +1,37 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface CampaignStatusChangedEvent {
+	id: string;
+	type: 'CampaignStatusChangedEvent';
+	version: '0.0.1';
+	timestamp: string;
+	traceContext: {
+		// W3C traceparent, injected by MessageBus from the active trace context
+		traceparent?: string;
+	};
+	source: string;
+	// Owning domain, optionally dotted for subdomains. Names the Kafka topic; absent keeps the superseded naming.
+	domain?: string;
+	// Whether other domains may integrate against this message. Absent means private.
+	visibility?: 'public' | 'private';
+	payload: {
+		// Id of the campaign whose status changed
+		campaignId: string;
+		// Id of the campaign status history row the transition wrote. One per transition, so consumers can drop a redelivered event by it
+		transitionId: string;
+		// Campaign status before the transition
+		previousStatus: 'draft' | 'active' | 'paused' | 'expired' | 'archived';
+		// Campaign status after the transition
+		status: 'draft' | 'active' | 'paused' | 'expired' | 'archived';
+		// Free-text reason the caller gave for the transition, null or absent when none was given
+		reason?: string | null;
+		// Location-service sector name the campaign is scoped to, e.g. Eurest. A name, not a sector id
+		sector: string;
+		// Country the campaign is scoped to
+		country: 'CA' | 'US';
+		// Subject of the authenticated caller that made the transition, typically a user id
+		changedBy: string;
+		// ISO 8601 time of the transition, the campaign's updatedAt as written by the status update
+		changedAt: string;
+	};
+}

package/src/messages/events/index.ts

@@ -4,6 +4,8 @@ export { AuditEvent } from './AuditEvent';
 
 export { AvrideOrderStatusUpdatedEvent } from './AvrideOrderStatusUpdatedEvent';
 
+export { CampaignStatusChangedEvent } from './CampaignStatusChangedEvent';
+
 export { DeliveryDropOffLeaveWarningEvent } from './DeliveryDropOffLeaveWarningEvent';
 
 export { DiscountCreatedEvent } from './DiscountCreatedEvent';