@compassdigital/sdk.typescript 4.396.0 → 4.398.0

package/src/interface/centricos.ts

@@ -76,6 +76,7 @@ export interface ReportGroupConfigResponse {
 	day_parts: DayPart[];
 	is_default: boolean;
 	modified: string;
+	timezone: string;
 }
 
 export type InternalServerErrorException = Record<string, any>;
@@ -566,18 +567,7 @@ export interface GetDiscountsResponseDTO {
 	meta: MetaResultsDTO;
 }
 
-export interface Transcript {
-	// Header text for the recommendation
-	header: string;
-	// Description text for the recommendation
-	description: string;
-	// CTA text for the recommendation
-	action: string;
-	// Link to relevant CentricOS page
-	actionUrl: string;
-}
-
-export interface GetRecommendationsResponseDto {
+export interface GetRecommendationsV1ResponseDto {
 	// UUID for the recommendation instance
 	recommendation_id: string;
 	// Start date of the recommendation timeframe
@@ -586,10 +576,6 @@ export interface GetRecommendationsResponseDto {
 	end_date: string;
 	// Type of recommendation
 	rec_type: string;
-	// Original raw HTML content of the recommendation
-	centric_html: string;
-	// Object containing the header, description, action, and actionUrl of the recommendation
-	parsed_transcript: Transcript;
 	// Link to relevant CentricOS page for action
 	url: string;
 	// Human-readable timeframe of the recommendation
@@ -598,117 +584,43 @@ export interface GetRecommendationsResponseDto {
 	visual: string;
 }
 
-export interface CpgTableItem {
-	// Manufacturer name
-	manufacturer: string;
-	// Product name
-	product: string;
-	// Quarter over quarter sales growth percentage
-	qoq_growth: number;
-	// Average case price
-	avg_case_price: number;
-	// Average spend monthly velocity in category
-	avg_spend_monthly_velocity_in_category: number;
-	// Average spend per customer in category
-	avg_spend_per_customer_in_category: number;
-	// Cases bought per customer
-	cases_bought_per_customer: number;
-	// Total number of customers
-	total_num_of_customers: number;
-	// Spend monthly velocity
-	spend_monthly_velocity: number;
-	// Spend per customer
-	spend_per_customer: number;
-	// Items bought per customer
-	items_bought_per_customer: number;
-}
-
-export interface CpgRecommendation {
-	// Complex key
-	complex_key: string;
-	// Site ID
-	p2_site_id: string;
-	// Table data for CPG recommendations
-	table: CpgTableItem[];
-	// Recommendation ID
-	recommendation_id: string;
-	// Expanded HTML content for recommendations
-	expand_html: string;
-}
-
-export interface ExpandTableItem {
-	// Item category
-	item_category: string;
-	// Item name
-	item: string;
-	// Stations offering the item
-	stations_offering_item: string;
-	// Daily sales revenue
-	daily_sales: number;
-	// Daily quantity sold
-	daily_qty_sold: number;
-	// Site average daily sales
-	site_avg_daily_sales: number;
-	// Site average quantity
-	site_avg_qty: number;
-	// Potential additional quantity
-	potential_additional_qty: number;
-	// Potential additional sales
-	potential_additional_sales: number;
-}
-
-export interface ExpandRecommendation {
-	// Complex key
-	complex_key: string;
-	// Site ID
-	p2_site_id: string;
-	// Table data for expand recommendations
-	table: ExpandTableItem[];
-	// Recommendation ID
-	recommendation_id: string;
-	// Expanded HTML content for the recommendation
-	expand_html: string;
-}
-
-export interface ReduceTableItem {
-	// Item category
-	item_category: string;
-	// Item name
-	item_name: string;
-	// Stations offering the item
-	stations_offering_item: string;
-	// Daily sales revenue
-	daily_sales: number;
-	// Daily quantity sold
-	daily_qty_sold: number;
-	// Site average daily sales
-	site_avg_daily_sales: number;
-	// Site average quantity
-	site_avg_qty: number;
-	// Revenue conservation
-	revenue_conservation: number;
-}
-
-export interface ReduceRecommendation {
-	// Complex key
-	complex_key: string;
-	// Platform 2 site ID
-	p2_site_id: string;
-	// Table data for reduce recommendations
-	table: ReduceTableItem[];
-	// Recommendation ID
-	recommendation_id: string;
-	// Expanded HTML content for the recommendation
-	expand_html: string;
+export interface VisualDataset {
+	// Label for the dataset
+	label: string;
+	// Unit type for formatting (currency, percent, etc)
+	unit: string;
+	// Data values for the chart
+	data: number[];
 }
 
-export interface GetExpandedRecommendationsResponseDto {
-	// CPG recommendation data
-	cpg?: CpgRecommendation;
-	// Expand recommendation data
-	expand?: ExpandRecommendation;
-	// Reduce recommendation data
-	reduce?: ReduceRecommendation;
+export interface RecommendationVisual {
+	// Title for the chart
+	plot_title: string;
+	// Labels for the chart x-axis
+	labels: string[];
+	// Datasets for the chart
+	datasets: VisualDataset[];
+	// Percentage difference for expand/reduce recommendations
+	revenue_pct_diff?: number;
+}
+
+export interface GetRecommendationsResponseDto {
+	// Recommendation ID
+	rec_id: string;
+	// Type of recommendation
+	rec_type: string;
+	// URL for action in CentricOS
+	url: string | null;
+	// Human-readable timeframe
+	timeframe_subfilter: string;
+	// Start date of the recommendation timeframe
+	start_date: string;
+	// End date of the recommendation timeframe
+	end_date: string;
+	// Visual/chart data for the recommendation
+	visual: RecommendationVisual;
+	// Table data for the recommendation (structure varies by rec_type)
+	table: Record<string, any>[];
 }
 
 export interface ValidateVertexResponse {
@@ -1031,7 +943,7 @@ export interface GetCentricosDiscountsQuery {
 
 export type GetCentricosDiscountsResponse = GetDiscountsResponseDTO;
 
-// GET /centricos/recommendations/{siteId} - Get recommendations by site
+// GET /centricos/recommendations/{siteId} - Get recommendations by site (V1 format)
 
 export interface GetRecommendationsBySitePath {
 	siteId: string;
@@ -1042,20 +954,20 @@ export interface GetRecommendationsBySiteQuery {
 	_query?: string;
 }
 
-export type GetRecommendationsBySiteResponse = GetRecommendationsResponseDto[];
+export type GetRecommendationsBySiteResponse = GetRecommendationsV1ResponseDto[];
 
-// GET /centricos/recommendations/{siteId}/details - Get expanded recommendations by site
+// GET /centricos/v2/recommendations/{siteId} - Get recommendations by site (V2 format)
 
-export interface GetExpandedRecommendationsBySitePath {
+export interface GetRecommendationsBySiteV2Path {
 	siteId: string;
 }
 
-export interface GetExpandedRecommendationsBySiteQuery {
+export interface GetRecommendationsBySiteV2Query {
 	// Graphql query string
 	_query?: string;
 }
 
-export type GetExpandedRecommendationsBySiteResponse = GetExpandedRecommendationsResponseDto;
+export type GetRecommendationsBySiteV2Response = GetRecommendationsResponseDto[];
 
 // POST /centricos/business-unit/{bu_id}/validate-vertex - Validate vertex for business unit
 

package/src/interface/consumer.ts

@@ -2882,6 +2882,8 @@ export interface PutConsumerShoppingCartPromoRequestDto {
 	code?: string;
 	// The email to apply to the shopping cart
 	email?: string;
+	// The associated brands for the reward code for the reward programs
+	associated_brands?: string[];
 }
 
 export interface DeleteConsumerShoppingcartCartItemsBody {