@compassdigital/sdk.typescript 4.485.0 → 4.487.0

package/src/interface/centricos.ts

@@ -828,31 +828,31 @@ export interface GlobalMenuGroup {
 	// Format: global_menu_group_<uuid>
 	id: string;
 	name: string;
-	is_active?: boolean;
-	posid_segment?: string;
-	auto_push_to_local?: boolean;
-	price_levels?: Record<string, any>;
-	show_v4?: boolean;
-	menu_labels?: Record<string, any>;
-	menuworks_unit_ids?: string[];
+	isActive?: boolean;
+	posidSegment?: string;
+	autoPushToLocal?: boolean;
+	priceLevels?: Record<string, any>;
+	showV4?: boolean;
+	menuLabels?: Record<string, any>;
+	menuworksUnitIds?: string[];
 	// ISO date
-	created_at: string;
+	createdAt: string;
 	// ISO date
-	updated_at: string;
+	updatedAt: string;
 	// ISO date, present if soft deleted
-	deleted_at?: string;
+	deletedAt?: string;
 	version: number;
 }
 
 export interface MenuListMetadata {
-	total_results?: number;
-	total_pages?: number;
-	result_count?: number;
+	totalResults?: number;
+	totalPages?: number;
+	resultCount?: number;
 	limit?: number;
 	page?: number;
-	sort_by?: string;
-	sort_order?: 'DESC' | 'ASC';
-	soft_deleted?: 'include' | 'exclude' | 'only';
+	sortBy?: string;
+	sortOrder?: 'DESC' | 'ASC';
+	softDeleted?: 'include' | 'exclude' | 'only';
 }
 
 export interface GetGlobalMenuGroupsResponse {
@@ -860,191 +860,132 @@ export interface GetGlobalMenuGroupsResponse {
 	meta?: MenuListMetadata;
 }
 
-export interface BrandItemsCategoryRequestDTO {
+export interface CentricMenuEntityBaseDTO {
 	// The id of the entity
 	id: string;
 	// The name of the entity
 	name: string;
 }
 
-export interface BrandItemsMenuRequestDTO {
+export interface CentricMenuDTO {
 	// The id of the entity
 	id: string;
 	// The name of the entity
 	name: string;
-	categories?: BrandItemsCategoryRequestDTO[];
+	categories: CentricMenuEntityBaseDTO[];
 }
 
-export interface BrandItemsMenuBrandRequestDTO {
+export interface PostBrandItemsSearchMenuBrand {
 	// The id of the entity
 	id: string;
 	// The name of the entity
 	name: string;
-	menus?: BrandItemsMenuRequestDTO[];
+	menus: CentricMenuDTO[];
 }
 
-export interface PostBrandItemsSearchBody {
-	menuBrands: BrandItemsMenuBrandRequestDTO[];
+export interface PostMenuBrandItemsSearchRequestDTO {
+	menuBrands: PostBrandItemsSearchMenuBrand[];
 	searchTerm?: string;
 }
 
-export interface ItemSearchMetaDTO {
+export interface CentricMenuSearchMetaDTO {
 	// Number of results returned
-	result_count: number;
-}
-
-export interface ItemSearchItemDTO {
-	// The id of the entity
-	id: string;
-	// The name of the entity
-	name: string;
+	resultCount: number;
 }
 
-export interface ItemSearchCategoryDTO {
-	// The id of the entity
-	id: string;
-	// The name of the entity
-	name: string;
-	items: ItemSearchItemDTO[];
+export interface PostMenuBrandItemsSearchResponseDTO {
+	meta: CentricMenuSearchMetaDTO;
+	results: PostBrandItemsSearchMenuBrand[];
 }
 
-export interface ItemSearchMenuDTO {
+export interface StationItemsSearchStation {
 	// The id of the entity
 	id: string;
 	// The name of the entity
 	name: string;
-	categories: ItemSearchCategoryDTO[];
+	menus: CentricMenuDTO[];
 }
 
-export interface BrandItemsResultDTO {
+export interface StationItemsSearchSite {
 	// The id of the entity
 	id: string;
 	// The name of the entity
 	name: string;
-	menus: ItemSearchMenuDTO[];
+	stations: StationItemsSearchStation[];
 }
 
-export interface PostBrandItemsSearchResponse {
-	meta: ItemSearchMetaDTO;
-	results: BrandItemsResultDTO[];
-}
-
-export interface StationItemsCategoryRequestDTO {
-	// The id of the entity
-	id: string;
-	// The name of the entity
-	name: string;
+export interface PostStationItemsSearchRequestDTO {
+	sites: StationItemsSearchSite[];
+	searchTerm?: string;
 }
 
-export interface StationItemsMenuRequestDTO {
-	// The id of the entity
-	id: string;
-	// The name of the entity
-	name: string;
-	categories?: StationItemsCategoryRequestDTO[];
+export interface PostStationItemsSearchResponseDTO {
+	meta: CentricMenuSearchMetaDTO;
+	results: StationItemsSearchSite[];
 }
 
-export interface StationItemsStationRequestDTO {
-	// The id of the entity
-	id: string;
-	// The name of the entity
-	name: string;
-	menus: StationItemsMenuRequestDTO[];
+export interface PostMenuBrandsFetchRequestDTO {
+	// Array of menu brand ids to fetch
+	brandIds: string[];
 }
 
-export interface StationItemsSiteRequestDTO {
+export interface FetchMenuBrandCategory {
 	// The id of the entity
 	id: string;
 	// The name of the entity
 	name: string;
-	stations: StationItemsStationRequestDTO[];
 }
 
-export interface PostStationItemsSearchBody {
-	sites: StationItemsSiteRequestDTO[];
-	searchTerm?: string;
-}
-
-export interface StationItemsStationDTO {
+export interface FetchMenuBrandMenu {
 	// The id of the entity
 	id: string;
 	// The name of the entity
 	name: string;
-	menus: ItemSearchMenuDTO[];
+	categories: FetchMenuBrandCategory[];
 }
 
-export interface StationItemsSiteResultDTO {
+export interface MenuBrand {
 	// The id of the entity
 	id: string;
 	// The name of the entity
 	name: string;
-	stations: StationItemsStationDTO[];
+	menus: FetchMenuBrandMenu[];
 }
 
-export interface PostStationItemsSearchResponse {
-	meta: ItemSearchMetaDTO;
-	results: StationItemsSiteResultDTO[];
-}
-
-export interface PostMenuBrandsFetchRequestDTO {
-	// Array of menu brand ids to fetch
-	brand_ids: string[];
-}
-
-export interface PostMenuBrandsFetchMeta {
-	// Number of brands returned
-	result_count: number;
+export interface PostMenuBrandsFetchResponseDTO {
+	meta: CentricMenuSearchMetaDTO;
+	results: MenuBrand[];
 }
 
-export interface CentricMenuCategoryDTO {
-	// The id of the entity
-	id: string;
-	// The name of the entity
-	name: string;
+export interface PostMenuStationsMenusFetchRequestDTO {
+	// Array of menu stations ids to fetch
+	stationIds: string[];
 }
 
-export interface CentricMenuDTO {
+export interface FetchStationMenuCategory {
 	// The id of the entity
 	id: string;
 	// The name of the entity
 	name: string;
-	categories: CentricMenuCategoryDTO[];
 }
 
-export interface MenuBrandResultDTO {
+export interface FetchStationMenu {
 	// The id of the entity
 	id: string;
 	// The name of the entity
 	name: string;
-	menus: CentricMenuDTO[];
-}
-
-export interface PostMenuBrandsFetchResponseDTO {
-	meta: PostMenuBrandsFetchMeta;
-	results: MenuBrandResultDTO[];
-}
-
-export interface PostMenuStationsMenusFetchRequestDTO {
-	// Array of menu stations ids to fetch
-	station_ids: string[];
+	categories: FetchStationMenuCategory[];
 }
 
-export interface PostMenuStationsMenusFetchMeta {
-	// Number of stations menus returned
-	result_count: number;
-}
-
-export interface MenuStationMenusResultDTO {
+export interface MenuStation {
 	// The id of the entity
 	id: string;
-	// The name of the entity
-	name: string;
-	menus: CentricMenuDTO[];
+	menus: FetchStationMenu[];
 }
 
 export interface PostMenuStationsMenusFetchResponseDTO {
-	meta: PostMenuStationsMenusFetchMeta;
-	results: MenuStationMenusResultDTO[];
+	meta: CentricMenuSearchMetaDTO;
+	results: MenuStation[];
 }
 
 export interface SwapListRequestDto {
@@ -1103,6 +1044,62 @@ export interface SwapListResponseDto {
 	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;
+}
+
 // POST /centricos/ai/item/description - Generate item description
 
 export type PostCentricosAiItemDescriptionBody = AIItemDescriptionRequest;
@@ -1427,15 +1424,15 @@ export type GetCentricosMenuGlobalMenuGroupsResponse = GetGlobalMenuGroupsRespon
 
 // POST /centricos/menu/brand/items/search - Search for global items across brands, menus, and categories
 
-export type PostCentricosMenuBrandItemsSearchBody = PostBrandItemsSearchBody;
+export type PostCentricosMenuBrandItemsSearchBody = PostMenuBrandItemsSearchRequestDTO;
 
-export type PostCentricosMenuBrandItemsSearchResponse = PostBrandItemsSearchResponse;
+export type PostCentricosMenuBrandItemsSearchResponse = PostMenuBrandItemsSearchResponseDTO;
 
 // POST /centricos/menu/station/items/search - Search for items across sites, stations, menus, and categories
 
-export type PostCentricosMenuStationItemsSearchBody = PostStationItemsSearchBody;
+export type PostCentricosMenuStationItemsSearchBody = PostStationItemsSearchRequestDTO;
 
-export type PostCentricosMenuStationItemsSearchResponse = PostStationItemsSearchResponse;
+export type PostCentricosMenuStationItemsSearchResponse = PostStationItemsSearchResponseDTO;
 
 // POST /centricos/menu/brands/fetch - Fetch menu brands to receive an expanded menu > category > item hierarchy
 
@@ -1454,3 +1451,16 @@ export type PostCentricosStationsMenusFetchResponse = PostMenuStationsMenusFetch
 export type ListSwapsBody = SwapListRequestDto;
 
 export type ListSwapsResponse = SwapListResponseDto;
+
+// GET /centricos/swaps/details - Get detailed information about a swap recommendation
+
+export interface GetSwapDetailsQuery {
+	// Unique swap recommendation ID
+	recommendation_id: string;
+	// Centric item ID
+	item_id: string;
+	// Centric item POSID
+	pos_id: string;
+}
+
+export type GetSwapDetailsResponse = SwapDetailsResponseDto;