@compassdigital/sdk.typescript 4.472.0 → 4.474.0

package/package.json

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

package/src/index.ts

@@ -929,6 +929,9 @@ import {
 	PostMenuV4BrandCategoryAttachItemsResponse,
 	PostMenuV4BrandSwapCategoryItemsBody,
 	PostMenuV4BrandSwapCategoryItemsResponse,
+	GetMenuV4BrandCatalogBackupVersionsResponse,
+	PostMenuV4BrandCatalogBackupRestoreBody,
+	PostMenuV4BrandCatalogBackupRestoreResponse,
 	PostMenuV4BrandPublishResponse,
 	PostMenuV4BrandV3ToV4Query,
 	PostMenuV4BrandV3ToV4Response,
@@ -1303,6 +1306,8 @@ import {
 	GetRecommendationsBySiteV2Response,
 	PostCentricosBusinessUnitValidateVertexResponse,
 	GetCentricosMenuGlobalMenuGroupsResponse,
+	PostCentricosMenuBrandsFetchBody,
+	PostCentricosMenuBrandsFetchResponse,
 } from './interface/centricos';
 
 import { TaxHealthCheckResponse, PostQuoteTaxBody, PostQuoteTaxResponse } from './interface/tax';
@@ -10762,6 +10767,48 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * GET /menu/v4/brand/{id}/catalog-backup/versions
+	 *
+	 * @param id
+	 * @param options - additional request options
+	 */
+	get_menu_v4_brand_catalog_backup_versions(
+		id: string,
+		options?: RequestOptions,
+	): ResponsePromise<GetMenuV4BrandCatalogBackupVersionsResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/brand/{id}/catalog-backup/versions',
+			'GET',
+			`/menu/v4/brand/${id}/catalog-backup/versions`,
+			null,
+			options,
+		);
+	}
+
+	/**
+	 * POST /menu/v4/brand/{id}/catalog-backup/restore
+	 *
+	 * @param id
+	 * @param body
+	 * @param options - additional request options
+	 */
+	post_menu_v4_brand_catalog_backup_restore(
+		id: string,
+		body: PostMenuV4BrandCatalogBackupRestoreBody,
+		options?: RequestOptions,
+	): ResponsePromise<PostMenuV4BrandCatalogBackupRestoreResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/brand/{id}/catalog-backup/restore',
+			'POST',
+			`/menu/v4/brand/${id}/catalog-backup/restore`,
+			body,
+			options,
+		);
+	}
+
 	/**
 	 * POST /menu/v4/brand/{id}/publish
 	 *
@@ -14877,6 +14924,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

@@ -2053,6 +2053,11 @@ export interface SwappedCategoryDTO {
 	sequence?: number;
 }
 
+export interface CatalogBackupVersionDTO {
+	version_id?: string;
+	last_modified?: string;
+}
+
 export interface FetchMetaDTO {
 	result_count?: number;
 }
@@ -8767,6 +8772,82 @@ export interface PostMenuV4BrandSwapCategoryItemsRequest
 	body: PostMenuV4BrandSwapCategoryItemsBody;
 }
 
+// GET /menu/v4/brand/{id}/catalog-backup/versions
+
+export interface GetMenuV4BrandCatalogBackupVersionsPath {
+	id: string;
+}
+
+export interface GetMenuV4BrandCatalogBackupVersionsResponse {
+	versions?: CatalogBackupVersionDTO[];
+}
+
+export interface GetMenuV4BrandCatalogBackupVersionsRequest
+	extends BaseRequest,
+		GetMenuV4BrandCatalogBackupVersionsPath {}
+
+// POST /menu/v4/brand/{id}/catalog-backup/restore
+
+export interface PostMenuV4BrandCatalogBackupRestorePath {
+	id: string;
+}
+
+export interface PostMenuV4BrandCatalogBackupRestoreBody {
+	version_id: string;
+	[index: string]: any;
+}
+
+export interface PostMenuV4BrandCatalogBackupRestoreResponse {
+	parent?: DraftBrandDTO;
+	children?: DraftBrandDTO[];
+	menus?: DraftMenuDTO[];
+	categories?: DraftCategoryDTO[];
+	category_to_item_relationships?: DraftCategoryToItemRelationshipDTO[];
+	items?: DraftItemDTO[];
+	item_to_modifier_group_relationships?: DraftItemToModifierGroupRelationshipDTO[];
+	modifier_groups?: DraftModifierGroupDTO[];
+	modifier_group_to_modifier_relationships?: DraftModifierGroupToModifierRelationshipDTO[];
+	modifiers?: DraftModifierDTO[];
+	statuses?: BrandStatusDTO[];
+	audit_logs?: AuditDTO[];
+	catalog_id?: number;
+	published_catalog_id?: number;
+	stocks?: StockDTO[];
+	id: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
+	name: string;
+	description?: string;
+	is_active?: boolean;
+	type?: 'global' | 'local';
+	parent_id?: string;
+	local_menu_group_id?: string;
+	global_menu_group_id?: string;
+	posid_segment?: string;
+	auto_push_to_local?: boolean;
+	frictionless_partner?: string;
+	meta?: BrandMeta;
+	supported_languages?: SupportedLanguages;
+	archived_at?: string;
+	applied_diff_snapshot?: Record<string, any>;
+	version?: number;
+	changes?: BrandChangeDTO[];
+	local_menu_group?: LocalMenuGroupDTO;
+	global_menu_group?: GlobalMenuGroupDTO;
+	vendor_metadata?: VendorMetadataDTO[];
+	menu_category_items?: MenuCategoryItemsDTO[];
+	attachments?: FileAttachmentsDTO;
+	permissions?: Record<string, any>;
+	[index: string]: any;
+}
+
+export interface PostMenuV4BrandCatalogBackupRestoreRequest
+	extends BaseRequest,
+		PostMenuV4BrandCatalogBackupRestorePath {
+	body: PostMenuV4BrandCatalogBackupRestoreBody;
+}
+
 // POST /menu/v4/brand/{id}/publish
 
 export interface PostMenuV4BrandPublishPath {