@compassdigital/sdk.typescript 4.471.0 → 4.473.0

package/package.json

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

package/src/index.ts

@@ -1303,6 +1303,8 @@ import {
 	GetRecommendationsBySiteV2Response,
 	PostCentricosBusinessUnitValidateVertexResponse,
 	GetCentricosMenuGlobalMenuGroupsResponse,
+	PostCentricosMenuBrandsFetchBody,
+	PostCentricosMenuBrandsFetchResponse,
 } from './interface/centricos';
 
 import { TaxHealthCheckResponse, PostQuoteTaxBody, PostQuoteTaxResponse } from './interface/tax';
@@ -14877,6 +14879,26 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * POST /centricos/menu/brands/fetch - Fetch menu brands to receive an expanded menu > category > item hierarchy
+	 *
+	 * @param body
+	 * @param options - additional request options
+	 */
+	post_centricos_menu_brands_fetch(
+		body: PostCentricosMenuBrandsFetchBody,
+		options?: RequestOptions,
+	): ResponsePromise<PostCentricosMenuBrandsFetchResponse> {
+		return this.request(
+			'centricos',
+			'/centricos/menu/brands/fetch',
+			'POST',
+			`/centricos/menu/brands/fetch`,
+			body,
+			options,
+		);
+	}
+
 	/**
 	 * GET /tax/v1/health-check - Health Check
 	 *

package/src/interface/centricos.ts

@@ -341,52 +341,64 @@ export interface CentricDiscountChannelConfig {
 	volante: boolean;
 }
 
-export interface CentricItem {
+export interface CentricDiscountEntityBase {
+	// The id of the entity
 	id: string;
+	// The name of the entity
 	name: string;
 }
 
-export interface CentricCategory {
+export interface CentricDiscountMenuCategory {
+	// The id of the entity
 	id: string;
+	// The name of the entity
 	name: string;
-	items: CentricItem[];
+	items: CentricDiscountEntityBase[];
 }
 
-export interface CentricMenu {
+export interface CentricDiscountMenu {
+	// The id of the entity
 	id: string;
+	// The name of the entity
 	name: string;
-	categories: CentricCategory[];
+	categories: CentricDiscountMenuCategory[];
 }
 
-export interface CentricStation {
+export interface CentricDiscountItemConfigStation {
+	// The id of the entity
 	id: string;
+	// The name of the entity
 	name: string;
-	menus?: CentricMenu[];
+	menus?: CentricDiscountMenu[];
 }
 
-export interface CentricSite {
+export interface CentricDiscountItemConfigSite {
+	// The id of the entity
 	id: string;
+	// The name of the entity
 	name: string;
-	stations: CentricStation[];
+	stations: CentricDiscountItemConfigStation[];
 }
 
-export interface CentricMenuBrand {
+export interface CentricDiscountMenuBrand {
+	// The id of the entity
 	id: string;
+	// The name of the entity
 	name: string;
-	menus: CentricMenu[];
+	menus: CentricDiscountMenu[];
 }
 
-export interface CentricItemLevelConfigDetails {
+export interface CentricDiscountItemLevelConfigDetails {
 	// minimum number of items to satisfy the bundle
 	minimum: number;
 	bundleGroupName?: string;
-	sites?: CentricSite[];
-	menuBrands?: CentricMenuBrand[];
+	sites?: CentricDiscountItemConfigSite[];
+	menuBrands?: CentricDiscountMenuBrand[];
 }
 
-export interface CentricItemLevelConfig {
+export interface CentricDiscountItemLevelConfig {
 	// details of the item level config
-	details: CentricItemLevelConfigDetails[];
+	details: CentricDiscountItemLevelConfigDetails[];
 	globalMenuGroupId?: string;
 	globalMenuGroupName?: string;
 	sectorName?: string;
@@ -423,7 +435,7 @@ export interface PutDiscountVoucherifyRequestDiscount {
 	// what the discount applies to
 	appliesTo: 'order' | 'items';
 	// item level config of the discount
-	itemLevelConfig?: CentricItemLevelConfig;
+	itemLevelConfig?: CentricDiscountItemLevelConfig;
 	// Voucherify metadata
 	meta?: CentricVoucherifyMetaDataDiscount;
 	// discount schedule
@@ -522,7 +534,7 @@ export interface DiscountResponseDTO {
 	// type of the discount
 	type: 'Total Order' | 'Single Items' | 'Bundle';
 	// item level config of the discount
-	itemLevelConfig?: CentricItemLevelConfig;
+	itemLevelConfig?: CentricDiscountItemLevelConfig;
 	// number of sites associated with the discount
 	siteCount: number;
 	// number of brands associated with the discount
@@ -560,13 +572,6 @@ export interface CentricDiscountMeta {
 	provider: CentricMetaProvider;
 }
 
-export interface DiscountEntityDTO {
-	// The ID of the site
-	id: string;
-	// The name of the site
-	name: string;
-}
-
 export interface PutDiscountVoucherifyPublishResponseDTO {
 	// user is of discount creator
 	createdBy: string;
@@ -583,7 +588,7 @@ export interface PutDiscountVoucherifyPublishResponseDTO {
 	// type of the discount
 	type: 'Total Order' | 'Single Items' | 'Bundle';
 	// item level config of the discount
-	itemLevelConfig?: CentricItemLevelConfig;
+	itemLevelConfig?: CentricDiscountItemLevelConfig;
 	// number of sites associated with the discount
 	siteCount: number;
 	// number of brands associated with the discount
@@ -591,7 +596,7 @@ export interface PutDiscountVoucherifyPublishResponseDTO {
 	// Voucherify metadata
 	meta?: CentricDiscountMeta;
 	// List of sites where discount is published
-	sites?: DiscountEntityDTO[];
+	sites?: CentricDiscountEntityBase[];
 	id: string;
 	createdAt: string;
 	updatedAt: string;
@@ -619,7 +624,7 @@ export interface DiscountDTO {
 	// type of the discount
 	type: 'Total Order' | 'Single Items' | 'Bundle';
 	// item level config of the discount
-	itemLevelConfig?: CentricItemLevelConfig;
+	itemLevelConfig?: CentricDiscountItemLevelConfig;
 	// number of sites associated with the discount
 	siteCount: number;
 	// number of brands associated with the discount
@@ -636,9 +641,9 @@ export interface GetDiscountResponseDTO {
 	// The discount information
 	discount: DiscountDTO;
 	// The sites associated with the discount
-	sites: DiscountEntityDTO[];
+	sites: CentricDiscountEntityBase[];
 	// The brands associated with the discount
-	brands: DiscountEntityDTO[];
+	brands: CentricDiscountEntityBase[];
 }
 
 export interface PostDiscountActiveRequestDTO {
@@ -662,7 +667,7 @@ export interface PostDiscountActiveResponseDTO {
 	// type of the discount
 	type: 'Total Order' | 'Single Items' | 'Bundle';
 	// item level config of the discount
-	itemLevelConfig?: CentricItemLevelConfig;
+	itemLevelConfig?: CentricDiscountItemLevelConfig;
 	// number of sites associated with the discount
 	siteCount: number;
 	// number of brands associated with the discount
@@ -691,7 +696,7 @@ export interface GetDiscountsDiscountResponseDTO {
 	// type of the discount
 	type: 'Total Order' | 'Single Items' | 'Bundle';
 	// item level config of the discount
-	itemLevelConfig?: CentricItemLevelConfig;
+	itemLevelConfig?: CentricDiscountItemLevelConfig;
 	// number of sites associated with the discount
 	siteCount: number;
 	// number of brands associated with the discount
@@ -851,6 +856,52 @@ export interface GetGlobalMenuGroupsResponse {
 	meta?: MenuListMetadata;
 }
 
+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 CentricMenuEntityBaseDTO {
+	// The id of the entity
+	id: string;
+	// The name of the entity
+	name: string;
+}
+
+export interface CentricMenuCategoryDTO {
+	// The id of the entity
+	id: string;
+	// The name of the entity
+	name: string;
+	items: CentricMenuEntityBaseDTO[];
+}
+
+export interface CentricMenuDTO {
+	// The id of the entity
+	id: string;
+	// The name of the entity
+	name: string;
+	categories: CentricMenuCategoryDTO[];
+}
+
+export interface MenuBrandResultDTO {
+	// The id of the entity
+	id: string;
+	// The name of the entity
+	name: string;
+	menus: CentricMenuDTO[];
+}
+
+export interface PostMenuBrandsFetchResponseDTO {
+	meta?: PostMenuBrandsFetchMeta;
+	results: MenuBrandResultDTO[];
+}
+
 // POST /centricos/ai/item/description - Generate item description
 
 export type PostCentricosAiItemDescriptionBody = AIItemDescriptionRequest;
@@ -1161,3 +1212,9 @@ export type PostCentricosBusinessUnitValidateVertexResponse = ValidateVertexResp
 // GET /centricos/menu/global-menu-groups - Get a paginated list of global menu groups with filtering, sorting, and relationships
 
 export type GetCentricosMenuGlobalMenuGroupsResponse = GetGlobalMenuGroupsResponse;
+
+// POST /centricos/menu/brands/fetch - Fetch menu brands to receive an expanded menu > category > item hierarchy
+
+export type PostCentricosMenuBrandsFetchBody = PostMenuBrandsFetchRequestDTO;
+
+export type PostCentricosMenuBrandsFetchResponse = PostMenuBrandsFetchResponseDTO;

package/src/interface/menu.ts

@@ -2058,20 +2058,23 @@ export interface FetchMetaDTO {
 }
 
 export interface FetchEntityWithMenusDTO {
-	id?: string;
-	name?: string;
-	menus?: FetchMenuDTO[];
+	id: string;
+	name: string;
+	menus: FetchMenuDTO[];
+	[index: string]: any;
 }
 
 export interface FetchMenuDTO {
-	id?: string;
-	name?: string;
-	categories?: FetchCategoryDTO[];
+	id: string;
+	name: string;
+	categories: FetchCategoryDTO[];
+	[index: string]: any;
 }
 
 export interface FetchCategoryDTO {
-	id?: string;
-	name?: string;
+	id: string;
+	name: string;
+	[index: string]: any;
 }
 
 export interface FetchBrandItemsMenuBrandRequestDTO {
@@ -2095,26 +2098,30 @@ export interface FetchBrandItemsCategoryRequestDTO {
 }
 
 export interface FetchEntityWithMenusAndItemsDTO {
-	id?: string;
-	name?: string;
-	menus?: FetchMenuWithItemsDTO[];
+	id: string;
+	name: string;
+	menus: FetchMenuWithItemsDTO[];
+	[index: string]: any;
 }
 
 export interface FetchMenuWithItemsDTO {
-	id?: string;
-	name?: string;
-	categories?: FetchCategoryWithItemsDTO[];
+	id: string;
+	name: string;
+	categories: FetchCategoryWithItemsDTO[];
+	[index: string]: any;
 }
 
 export interface FetchCategoryWithItemsDTO {
-	id?: string;
-	name?: string;
-	items?: FetchItemDTO[];
+	id: string;
+	name: string;
+	items: FetchItemDTO[];
+	[index: string]: any;
 }
 
 export interface FetchItemDTO {
-	id?: string;
-	name?: string;
+	id: string;
+	name: string;
+	[index: string]: any;
 }
 
 export interface PartialItemDTO {
@@ -2221,21 +2228,23 @@ export interface MenuSizeDTO {
 }
 
 export interface FetchStationWithMenusDTO {
-	id?: string;
-	name?: string;
-	menus?: FetchStationMenuDTO[];
+	id: string;
+	name: string;
+	menus: FetchStationMenuDTO[];
+	[index: string]: any;
 }
 
 export interface FetchStationMenuDTO {
-	id?: string;
-	name?: string;
-	categories?: FetchStationCategoryDTO[];
+	id: string;
+	name: string;
+	categories: FetchStationCategoryDTO[];
+	[index: string]: any;
 }
 
 export interface FetchStationCategoryDTO {
-	items?: FetchItemDTO[];
-	id?: string;
-	name?: string;
+	id: string;
+	name: string;
+	items: FetchItemDTO[];
 	[index: string]: any;
 }
 
@@ -2267,21 +2276,24 @@ export interface FetchStationItemsSearchCategoryRequestDTO {
 }
 
 export interface FetchSiteWithStationsDTO {
-	id?: string;
-	name?: string;
-	stations?: FetchStationDTO[];
+	id: string;
+	name: string;
+	stations: FetchStationDTO[];
+	[index: string]: any;
 }
 
 export interface FetchStationDTO {
-	id?: string;
-	name?: string;
-	menus?: FetchStationItemStationMenuDTO[];
+	id: string;
+	name: string;
+	menus: FetchStationItemStationMenuDTO[];
+	[index: string]: any;
 }
 
 export interface FetchStationItemStationMenuDTO {
-	id?: string;
-	name?: string;
-	categories?: FetchCategoryWithItemsDTO[];
+	id: string;
+	name: string;
+	categories: FetchCategoryWithItemsDTO[];
+	[index: string]: any;
 }
 
 export interface HealthDependencyDTO {
@@ -8946,8 +8958,9 @@ export interface PostMenuV4BrandsFetchBody {
 }
 
 export interface PostMenuV4BrandsFetchResponse {
-	meta?: FetchMetaDTO;
-	results?: FetchEntityWithMenusDTO[];
+	meta: FetchMetaDTO;
+	results: FetchEntityWithMenusDTO[];
+	[index: string]: any;
 }
 
 export interface PostMenuV4BrandsFetchRequest extends BaseRequest {
@@ -8963,8 +8976,9 @@ export interface PostMenuV4BrandItemsSearchBody {
 }
 
 export interface PostMenuV4BrandItemsSearchResponse {
-	meta?: FetchMetaDTO;
-	results?: FetchEntityWithMenusAndItemsDTO[];
+	meta: FetchMetaDTO;
+	results: FetchEntityWithMenusAndItemsDTO[];
+	[index: string]: any;
 }
 
 export interface PostMenuV4BrandItemsSearchRequest extends BaseRequest {
@@ -11066,8 +11080,9 @@ export interface PostMenuV4StationsMenusFetchBody {
 }
 
 export interface PostMenuV4StationsMenusFetchResponse {
-	meta?: FetchMetaDTO;
-	results?: FetchStationWithMenusDTO[];
+	meta: FetchMetaDTO;
+	results: FetchStationWithMenusDTO[];
+	[index: string]: any;
 }
 
 export interface PostMenuV4StationsMenusFetchRequest extends BaseRequest {
@@ -11083,8 +11098,9 @@ export interface PostMenuV4StationItemsSearchBody {
 }
 
 export interface PostMenuV4StationItemsSearchResponse {
-	meta?: FetchMetaDTO;
-	results?: FetchSiteWithStationsDTO[];
+	meta: FetchMetaDTO;
+	results: FetchSiteWithStationsDTO[];
+	[index: string]: any;
 }
 
 export interface PostMenuV4StationItemsSearchRequest extends BaseRequest {