@compassdigital/sdk.typescript 4.833.0 → 4.835.0

package/src/interface/centricos.ts

@@ -666,10 +666,18 @@ export interface DeleteStationIntegrationResponse {
 	success: boolean;
 }
 
+export const DiscountMethodName = {
+	FIXED_PRICE: 'FIXED_PRICE',
+	AMOUNT_OFF: 'AMOUNT_OFF',
+	PERCENT_OFF: 'PERCENT_OFF',
+	FREE: 'FREE',
+} as const;
+export type DiscountMethodName = (typeof DiscountMethodName)[keyof typeof DiscountMethodName];
+
 export interface CentricDiscountMethod {
-	// How the discount is applied: FIXED_PRICE (fixed bundle price), AMOUNT_OFF (dollar amount off) or PERCENT_OFF (percentage off)
-	name: 'FIXED_PRICE' | 'AMOUNT_OFF' | 'PERCENT_OFF';
-	// The discount value: a dollar amount stored in cents for FIXED_PRICE and AMOUNT_OFF, or a percentage for PERCENT_OFF
+	// How the discount is applied: FIXED_PRICE (fixed bundle price), AMOUNT_OFF (dollar amount off), PERCENT_OFF (percentage off) or FREE (free item)
+	name: DiscountMethodName;
+	// The discount value: a dollar amount stored in cents for FIXED_PRICE and AMOUNT_OFF, a percentage for PERCENT_OFF, or 0 for FREE
 	value: number;
 }
 
@@ -740,6 +748,10 @@ export interface CentricDiscountItemConfigSite {
 export interface CentricDiscountItemLevelConfigDetails {
 	// minimum number of items to satisfy the bundle
 	minimum: number;
+	// Marks the group that receives the discount for Buy X Get Y. At least one group must be true, but not all groups, when publishing.
+	isDiscounted?: boolean;
+	// How many extra items are discounted per qualified set for Buy X Get X. Required when publishing Buy X Get X; must be less than the group minimum. Applies to every method (PERCENT_OFF, AMOUNT_OFF, FREE).
+	discountedItemQuantity?: number;
 	// Global menu groups for bundle / single-item scope; menu brands are nested per group
 	globalMenuGroups?: CentricDiscountGlobalMenuGroup[];
 	bundleGroupName?: string;
@@ -760,9 +772,17 @@ export interface CentricDiscountIs {
 	mealplanPromo?: boolean;
 }
 
+export const DiscountMetaType = {
+	AMOUNT_OFF: 'AMOUNT_OFF',
+	PERCENT_OFF: 'PERCENT_OFF',
+	FIXED_PRICE: 'FIXED_PRICE',
+	FREE: 'FREE',
+} as const;
+export type DiscountMetaType = (typeof DiscountMetaType)[keyof typeof DiscountMetaType];
+
 export interface CentricVoucherifyMetaDataDiscount {
 	// The type of the voucherify discount
-	type: 'AMOUNT_OFF' | 'PERCENT_OFF' | 'FIXED_PRICE';
+	type: DiscountMetaType;
 	// The numeric value of discount for amount off
 	amountOff?: number;
 	// The fixed price value of the bundle for fixed price discounts
@@ -771,15 +791,35 @@ export interface CentricVoucherifyMetaDataDiscount {
 	percentOff?: number;
 }
 
+export const DiscountDay = {
+	MON: 'mon',
+	TUE: 'tue',
+	WED: 'wed',
+	THU: 'thu',
+	FRI: 'fri',
+	SAT: 'sat',
+	SUN: 'sun',
+} as const;
+export type DiscountDay = (typeof DiscountDay)[keyof typeof DiscountDay];
+
 export interface CentricDiscountSchedule {
 	// The days of the week for the discount to be active
-	days: ('mon' | 'tue' | 'wed' | 'thu' | 'fri' | 'sat' | 'sun')[];
+	days: DiscountDay[];
 	startDate?: string;
 	endDate?: string;
 	startTime: string;
 	endTime: string;
 }
 
+export const DiscountType = {
+	TOTAL_ORDER: 'Total Order',
+	SINGLE_ITEMS: 'Single Items',
+	BUNDLE: 'Bundle',
+	BUY_X_GET_Y: 'Buy X Get Y',
+	BUY_X_GET_X: 'Buy X Get X',
+} as const;
+export type DiscountType = (typeof DiscountType)[keyof typeof DiscountType];
+
 export interface PutCentricDiscountRequestDiscount {
 	// name of the discount
 	name: string;
@@ -798,7 +838,7 @@ export interface PutCentricDiscountRequestDiscount {
 	// discount active status flag
 	active?: boolean;
 	// type of the discount
-	type?: 'Total Order' | 'Single Items' | 'Bundle';
+	type?: DiscountType;
 }
 
 export interface DiscountBrandReference {
@@ -885,7 +925,7 @@ export interface DiscountResponseDTO {
 	// channel config of the discount
 	channelConfig: CentricDiscountChannelConfig;
 	// type of the discount
-	type: 'Total Order' | 'Single Items' | 'Bundle';
+	type: DiscountType;
 	// item level config of the discount
 	itemLevelConfig?: CentricDiscountItemLevelConfig;
 	// discount metadata
@@ -935,7 +975,7 @@ export interface PutCentricDiscountPublishResponseDTO {
 	// channel config of the discount
 	channelConfig: CentricDiscountChannelConfig;
 	// type of the discount
-	type: 'Total Order' | 'Single Items' | 'Bundle';
+	type: DiscountType;
 	// item level config of the discount
 	itemLevelConfig?: CentricDiscountItemLevelConfig;
 	// discount metadata
@@ -967,7 +1007,7 @@ export interface PutDiscountVoucherifyRequestDiscount {
 	// discount active status flag
 	active?: boolean;
 	// type of the discount
-	type?: 'Total Order' | 'Single Items' | 'Bundle';
+	type?: DiscountType;
 }
 
 export interface PutDiscountVoucherifyRequestDTO {
@@ -1002,7 +1042,7 @@ export interface PutDiscountVoucherifyPublishResponseDTO {
 	// channel config of the discount
 	channelConfig: CentricDiscountChannelConfig;
 	// type of the discount
-	type: 'Total Order' | 'Single Items' | 'Bundle';
+	type: DiscountType;
 	// item level config of the discount
 	itemLevelConfig?: CentricDiscountItemLevelConfig;
 	// Voucherify metadata
@@ -1038,7 +1078,7 @@ export interface DiscountDTO {
 	// channel config of the discount
 	channelConfig: CentricDiscountChannelConfig;
 	// type of the discount
-	type: 'Total Order' | 'Single Items' | 'Bundle';
+	type: DiscountType;
 	// item level config of the discount
 	itemLevelConfig?: CentricDiscountItemLevelConfig;
 	id: string;
@@ -1070,7 +1110,7 @@ export interface GetDiscountsDiscountResponseDTO {
 	// channel config of the discount
 	channelConfig: CentricDiscountChannelConfig;
 	// type of the discount
-	type: 'Total Order' | 'Single Items' | 'Bundle';
+	type: DiscountType;
 	// item level config of the discount
 	itemLevelConfig?: CentricDiscountItemLevelConfig;
 	sites: string[];
@@ -1421,118 +1461,6 @@ export interface PostMenuStationsMenusFetchResponseDTO {
 	results: MenuStation[];
 }
 
-export interface SwapListRequestDto {
-	// Menu Brand ID
-	brand_id: string;
-	// Array of Site IDs
-	site_ids: string[];
-}
-
-export interface ProjectedRevenue {
-	// Revenue last 30 days
-	revenue: number;
-	// Projected revenue if selected swaps are not published
-	projected_revenue: number;
-	// Projected revenue if selected swaps are published
-	swaps_published_revenue: number;
-}
-
-export interface RevenueImpact {
-	// Extra revenue per month if this swap is applied
-	extra_revenue_per_month: number;
-	// Percentage increase in revenue if this swap is applied
-	percentage_increase: number;
-}
-
-export interface SwapItem {
-	// Centric item ID
-	item_id: string;
-	// Centric item name
-	name: string;
-	// Centric item POSID
-	posid: string;
-}
-
-export interface SwapRecommendation {
-	// Unique swap recommendation identifier
-	recommendation_id: string;
-	// Revenue impact if this swap is applied
-	revenue_impact: RevenueImpact;
-	// Centric Brand ID
-	brand_id: string;
-	// Centric Menu ID
-	menu_id: string;
-	// IDs of the categories where this swap will be applied
-	categories: string[];
-	// Category item to swap out
-	swap_out: SwapItem;
-	// Category item to swap in
-	swap_in: SwapItem;
-}
-
-export interface SwapListResponseDto {
-	// Projected revenue metrics if this swap is applied
-	projected_revenue: ProjectedRevenue;
-	// List of swap recommendations
-	swaps: SwapRecommendation[];
-}
-
-export interface SwapRevenueOut {
-	// Item revenue from the last 30 days
-	revenue_last_30_days: number;
-	// Item projected revenue for the next 30 days
-	projected_revenue_next_30_days: number;
-}
-
-export interface SwapRevenueIn {
-	// Projected revenue for the next 30 days if swap is applied
-	projected_revenue_next_30_days: number;
-}
-
-export interface SwapRevenueDetails {
-	// Revenue data for the item being swapped out
-	swap_out: SwapRevenueOut;
-	// Revenue data for the item being swapped in
-	swap_in: SwapRevenueIn;
-}
-
-export interface SwapOrderOut {
-	// Number of orders in the last 30 days
-	orders_last_30_days: number;
-	// Forecasted orders for the next 30 days
-	orders_forecast_next_30_days: number;
-}
-
-export interface SwapOrderIn {
-	// Forecasted orders for the next 30 days
-	orders_forecast_next_30_days: number;
-}
-
-export interface SwapOrderDetails {
-	// Order data for the item being removed
-	swap_out: SwapOrderOut;
-	// Order data for the item being added
-	swap_in: SwapOrderIn;
-}
-
-export interface SwapPriceDetails {
-	// Price of the item being swapped out
-	swap_out: number;
-	// Price of the item being swapped in
-	swap_in: number;
-}
-
-export interface SwapDetailsResponseDto {
-	// Revenue metrics for swap items
-	revenue: SwapRevenueDetails;
-	// Order volume metrics for swap items
-	orders: SwapOrderDetails;
-	// Price comparison for swap items
-	price: SwapPriceDetails;
-	// Site profile description explaining why this swap was recommended
-	site_profile: string;
-}
-
 export interface RecommendationItem {
 	// Centric item id, or null when the upstream forecast could not resolve one
 	item_id: string | null;
@@ -1938,7 +1866,7 @@ export interface GetCentricosDiscountsQuery {
 	// Filter by updatedBy (partial match)
 	updatedBy?: string;
 	// Filter by amount off or percentage off
-	type?: string;
+	type?: DiscountMetaType;
 	// Filter by created date start (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss)
 	createdAtStart?: string;
 	// Filter by created date end (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss)
@@ -2069,21 +1997,6 @@ export type PostCentricosStationsMenusFetchBody = PostMenuStationsMenusFetchRequ
 
 export type PostCentricosStationsMenusFetchResponse = PostMenuStationsMenusFetchResponseDTO;
 
-// POST /centricos/swaps/list - Fetch swap recommendations for a Centric brand
-
-export type ListSwapsBody = SwapListRequestDto;
-
-export type ListSwapsResponse = SwapListResponseDto;
-
-// GET /centricos/swaps/details/{recommendation_id} - Get detailed information about a swap recommendation
-
-export interface GetSwapDetailsPath {
-	// Unique swap recommendation ID
-	recommendation_id: string;
-}
-
-export type GetSwapDetailsResponse = SwapDetailsResponseDto;
-
 // GET /centricos/menu-optimizer/brand/{brand_id}/recommendations - Get the latest ROM recommendations for a brand
 
 export interface GetCentricosMenuOptimizerBrandRecommendationsPath {