@compassdigital/sdk.typescript 4.334.0 → 4.336.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@compassdigital/sdk.typescript",
-	"version": "4.334.0",
+	"version": "4.336.0",
 	"description": "Compass Digital Labs TypeScript SDK",
 	"type": "commonjs",
 	"main": "./lib/index.js",

package/src/index.ts

@@ -1316,6 +1316,8 @@ import {
 	GetCentricosDiscountsResponse,
 	GetRecommendationsBySiteQuery,
 	GetRecommendationsBySiteResponse,
+	GetExpandedRecommendationsBySiteQuery,
+	GetExpandedRecommendationsBySiteResponse,
 	PostCentricosBusinessUnitValidateVertexResponse,
 } from './interface/centricos';
 
@@ -14354,6 +14356,28 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * GET /centricos/recommendations/{siteId}/details - Get expanded recommendations by site
+	 *
+	 * @param siteId
+	 * @param options - additional request options
+	 */
+	get_expanded_recommendations_by_site(
+		siteId: string,
+		options?: {
+			query?: GetExpandedRecommendationsBySiteQuery;
+		} & RequestOptions,
+	): ResponsePromise<GetExpandedRecommendationsBySiteResponse> {
+		return this.request(
+			'centricos',
+			'/centricos/recommendations/{siteId}/details',
+			'GET',
+			`/centricos/recommendations/${siteId}/details`,
+			null,
+			options,
+		);
+	}
+
 	/**
 	 * POST /centricos/business-unit/{bu_id}/validate-vertex - Validate vertex for business unit
 	 *

package/src/interface/centricos.ts

@@ -572,6 +572,119 @@ 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 GetExpandedRecommendationsResponseDto {
+	// CPG recommendation data
+	cpg?: CpgRecommendation;
+	// Expand recommendation data
+	expand?: ExpandRecommendation;
+	// Reduce recommendation data
+	reduce?: ReduceRecommendation;
+}
+
 export interface ValidateVertexResponse {
 	// Whether the vertex validation was successful
 	valid: boolean;
@@ -903,6 +1016,19 @@ export interface GetRecommendationsBySiteQuery {
 
 export type GetRecommendationsBySiteResponse = GetRecommendationsResponseDto[];
 
+// GET /centricos/recommendations/{siteId}/details - Get expanded recommendations by site
+
+export interface GetExpandedRecommendationsBySitePath {
+	siteId: string;
+}
+
+export interface GetExpandedRecommendationsBySiteQuery {
+	// Graphql query string
+	_query?: string;
+}
+
+export type GetExpandedRecommendationsBySiteResponse = GetExpandedRecommendationsResponseDto;
+
 // POST /centricos/business-unit/{bu_id}/validate-vertex - Validate vertex for business unit
 
 export interface PostCentricosBusinessUnitValidateVertexPath {

package/src/interface/menu.ts

@@ -593,6 +593,28 @@ export interface GetOneOptionsDTO {
 	[index: string]: any;
 }
 
+export interface LocalMenuLabelGroupDTO {
+	// Global menu group ID
+	gmg_id: string;
+	// Global menu group name
+	gmg_name: string;
+	// Menu labels array
+	labels: MenuLabelItemDTO[];
+	[index: string]: any;
+}
+
+export interface MenuLabelItemDTO {
+	// Menu label ID
+	id?: string;
+	// Menu label text
+	text: string;
+	// S3 link for menu label image
+	s3_link?: string;
+	// Base64 image data
+	image_data?: string;
+	[index: string]: any;
+}
+
 export interface NotFoundErrorDTO {
 	number: number;
 	message: string;
@@ -2523,6 +2545,8 @@ export interface GetMenuV3LocalMenuGroupQuery {
 export interface GetMenuV3LocalMenuGroupResponse {
 	// GMG IDs currently in use by child brands
 	global_menu_groups_in_use?: string[];
+	// Menu labels inherited from global menu groups in use
+	menu_labels?: LocalMenuLabelGroupDTO[];
 	name: string;
 	is_active?: boolean;
 	allowed_global_menu_groups?: GlobalMenuGroupDTO[];