@compassdigital/sdk.typescript 4.475.0 → 4.477.0

package/package.json

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

package/src/index.ts

@@ -1308,6 +1308,8 @@ import {
 	GetCentricosMenuGlobalMenuGroupsResponse,
 	PostCentricosMenuBrandsFetchBody,
 	PostCentricosMenuBrandsFetchResponse,
+	ListSwapsBody,
+	ListSwapsResponse,
 } from './interface/centricos';
 
 import { TaxHealthCheckResponse, PostQuoteTaxBody, PostQuoteTaxResponse } from './interface/tax';
@@ -14944,6 +14946,23 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * POST /centricos/swaps/list - Fetch swap recommendations for a Centric brand
+	 *
+	 * @param body - Brand and site IDs
+	 * @param options - additional request options
+	 */
+	list_swaps(body: ListSwapsBody, options?: RequestOptions): ResponsePromise<ListSwapsResponse> {
+		return this.request(
+			'centricos',
+			'/centricos/swaps/list',
+			'POST',
+			`/centricos/swaps/list`,
+			body,
+			options,
+		);
+	}
+
 	/**
 	 * GET /tax/v1/health-check - Health Check
 	 *

package/src/interface/centricos.ts

@@ -878,7 +878,7 @@ export interface CentricMenuCategoryDTO {
 	id: string;
 	// The name of the entity
 	name: string;
-	items: CentricMenuEntityBaseDTO[];
+	items?: CentricMenuEntityBaseDTO[];
 }
 
 export interface CentricMenuDTO {
@@ -898,10 +898,66 @@ export interface MenuBrandResultDTO {
 }
 
 export interface PostMenuBrandsFetchResponseDTO {
-	meta?: PostMenuBrandsFetchMeta;
+	meta: PostMenuBrandsFetchMeta;
 	results: MenuBrandResultDTO[];
 }
 
+export interface SwapListRequestDto {
+	// Menu Brand ID
+	brand_id: string;
+	// Site ID
+	site_id: 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[];
+}
+
 // POST /centricos/ai/item/description - Generate item description
 
 export type PostCentricosAiItemDescriptionBody = AIItemDescriptionRequest;
@@ -1039,6 +1095,7 @@ export interface GetCentricosSitesQuery {
 	page: number;
 	sortOrder: 'ASC' | 'DESC';
 	sortBy?: string;
+	sector_name?: string;
 }
 
 export type GetCentricosSitesResponse = GetSitesResponse;
@@ -1218,3 +1275,9 @@ export type GetCentricosMenuGlobalMenuGroupsResponse = GetGlobalMenuGroupsRespon
 export type PostCentricosMenuBrandsFetchBody = PostMenuBrandsFetchRequestDTO;
 
 export type PostCentricosMenuBrandsFetchResponse = PostMenuBrandsFetchResponseDTO;
+
+// POST /centricos/swaps/list - Fetch swap recommendations for a Centric brand
+
+export type ListSwapsBody = SwapListRequestDto;
+
+export type ListSwapsResponse = SwapListResponseDto;