@compassdigital/sdk.typescript 4.94.2 → 4.96.0

package/src/interface/menu.ts

@@ -668,6 +668,7 @@ export interface DraftCategoryToItemRelationshipDTO {
 }
 
 export interface DraftItemDTO {
+	is_published?: boolean;
 	parent?: Record<string, any>;
 	children?: Record<string, any>[];
 	modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
@@ -1452,6 +1453,7 @@ export interface LineRouteSuggestion {
 }
 
 export interface DraftItemEntityDTO {
+	is_published?: boolean;
 	parent?: DraftItemDTO;
 	children?: DraftItemDTO[];
 	modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
@@ -2451,6 +2453,41 @@ export interface PostMenuV3LocalMenuGroupImportBrandsRequest
 		RequestQuery<PostMenuV3LocalMenuGroupImportBrandsQuery>,
 		PostMenuV3LocalMenuGroupImportBrandsPath {}
 
+// POST /menu/v4/local-menu-group/{id}/import-brands
+
+export interface PostMenuV4LocalMenuGroupImportBrandsPath {
+	id: string;
+}
+
+export interface PostMenuV4LocalMenuGroupImportBrandsQuery {
+	// If specified, only the selected fields will be returned
+	select?: string[];
+	// List of relationships to load alongside this entity. Can load nested relationships using the pattern 'children.grand_children.foo'
+	relationships?: string[];
+	// The fields that filtering is allowed on
+	filter?: string;
+	'body.brand_ids'?: string[];
+	// Number of records to load per page
+	limit?: number;
+	page?: number;
+	// A field to sort the results based on
+	sort_by?: string;
+	sort_order?: 'DESC' | 'ASC';
+	// How soft deleted records should be shown in the list
+	soft_deleted?: 'include' | 'exclude' | 'only';
+}
+
+export interface PostMenuV4LocalMenuGroupImportBrandsResponse {
+	results: DraftBrandDTO[];
+	meta?: ListResponseMetadataDTO;
+	[index: string]: any;
+}
+
+export interface PostMenuV4LocalMenuGroupImportBrandsRequest
+	extends BaseRequest,
+		RequestQuery<PostMenuV4LocalMenuGroupImportBrandsQuery>,
+		PostMenuV4LocalMenuGroupImportBrandsPath {}
+
 // GET /menu/v3/local-menu-group/{id}/site
 
 export interface GetMenuV3LocalMenuGroupSitePath {
@@ -3411,8 +3448,8 @@ export interface PostMenuV3DraftBrandGlobalDiffsApplyRequest
 // POST /menu/v3/draft/brand/{id}/attachment/{name}
 
 export interface PostMenuV3DraftBrandAttachmentPath {
-	id: string;
 	name: 'thumbnail';
+	id: string;
 }
 
 export interface PostMenuV3DraftBrandAttachmentQuery {
@@ -3428,6 +3465,49 @@ export interface PostMenuV3DraftBrandAttachmentRequest
 		RequestQuery<PostMenuV3DraftBrandAttachmentQuery>,
 		PostMenuV3DraftBrandAttachmentPath {}
 
+// GET /menu/v3/draft/brand/{id}/export
+
+export interface GetMenuV3DraftBrandExportPath {
+	id: string;
+}
+
+export interface GetMenuV3DraftBrandExportQuery {
+	format?: 'xlsx';
+	// Graphql query string
+	_query?: string;
+}
+
+export interface GetMenuV3DraftBrandExportResponse {
+	s3_link: string;
+	[index: string]: any;
+}
+
+export interface GetMenuV3DraftBrandExportRequest
+	extends BaseRequest,
+		RequestQuery<GetMenuV3DraftBrandExportQuery>,
+		GetMenuV3DraftBrandExportPath {}
+
+// GET /menu/v3/draft/brand/{id}/import/link
+
+export interface GetMenuV3DraftBrandImportLinkPath {
+	id: string;
+}
+
+export interface GetMenuV3DraftBrandImportLinkQuery {
+	// Graphql query string
+	_query?: string;
+}
+
+export interface GetMenuV3DraftBrandImportLinkResponse {
+	upload_link: string;
+	[index: string]: any;
+}
+
+export interface GetMenuV3DraftBrandImportLinkRequest
+	extends BaseRequest,
+		RequestQuery<GetMenuV3DraftBrandImportLinkQuery>,
+		GetMenuV3DraftBrandImportLinkPath {}
+
 // POST /menu/v3/brand
 
 export interface PostMenuV3BrandQuery {
@@ -4838,6 +4918,7 @@ export interface PostMenuV3CategoryRelationshipsItemRecoverRequest
 // POST /menu/v3/draft/item
 
 export interface PostMenuV3DraftItemBody {
+	is_published?: boolean;
 	parent?: DraftItemDTO;
 	children?: DraftItemDTO[];
 	modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
@@ -4911,6 +4992,7 @@ export interface PatchMenuV3DraftItemPath {
 }
 
 export interface PatchMenuV3DraftItemBody {
+	is_published?: boolean;
 	parent?: DraftItemDTO;
 	children?: DraftItemDTO[];
 	modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
@@ -5025,6 +5107,7 @@ export interface GetMenuV3DraftItemsRequest
 // POST /menu/v3/draft/items
 
 export type PostMenuV3DraftItemsBody = {
+	is_published?: boolean;
 	parent?: DraftItemDTO;
 	children?: DraftItemDTO[];
 	modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
@@ -5128,6 +5211,7 @@ export interface GetMenuV3DraftItemLineRoutesRequest
 
 export interface PatchMenuV3DraftItemsBulkUpdateBody {
 	id_list: string[];
+	is_published?: boolean;
 	parent?: DraftItemDTO;
 	children?: DraftItemDTO[];
 	modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
@@ -7153,6 +7237,54 @@ export interface PostMenuV4BrandMenuRequest extends BaseRequest, PostMenuV4Brand
 	body: PostMenuV4BrandMenuBody;
 }
 
+// PATCH /menu/v4/brand/{brand_id}/menu/{menu_id}
+
+export interface PatchMenuV4BrandMenuPath {
+	brand_id: string;
+	menu_id: string;
+}
+
+export interface PatchMenuV4BrandMenuBody {
+	parent?: DraftMenuDTO;
+	children?: DraftMenuDTO[];
+	categories?: DraftCategoryDTO[];
+	id?: string;
+	parent_id?: string;
+	name?: string;
+	brand_id?: string;
+	applied_diff_snapshot?: Record<string, any>;
+	version?: number;
+	brand?: DraftBrandDTO;
+	changes?: MenuChangeDTO[];
+	vendor_metadata?: VendorMetadataDTO[];
+	permissions?: Record<string, any>;
+	[index: string]: any;
+}
+
+export interface PatchMenuV4BrandMenuResponse {
+	parent?: DraftMenuDTO;
+	children?: DraftMenuDTO[];
+	categories?: DraftCategoryDTO[];
+	id: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
+	parent_id?: string;
+	name: string;
+	brand_id: string;
+	applied_diff_snapshot?: Record<string, any>;
+	version?: number;
+	brand?: DraftBrandDTO;
+	changes?: MenuChangeDTO[];
+	vendor_metadata?: VendorMetadataDTO[];
+	permissions?: Record<string, any>;
+	[index: string]: any;
+}
+
+export interface PatchMenuV4BrandMenuRequest extends BaseRequest, PatchMenuV4BrandMenuPath {
+	body: PatchMenuV4BrandMenuBody;
+}
+
 // GET /menu/v4/brand/{id}/items
 
 export interface GetMenuV4BrandItemsPath {
@@ -7464,9 +7596,124 @@ export interface PostMenuV4BrandV3ToV4Response {
 
 export interface PostMenuV4BrandV3ToV4Request extends BaseRequest, PostMenuV4BrandV3ToV4Path {}
 
+// DELETE menu/v4/brand/{id}
+
+export interface DeleteMenuV4BrandPath {
+	id: string;
+}
+
+export interface DeleteMenuV4BrandResponse {
+	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[];
+	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;
+	is_simplified_view?: boolean;
+	frictionless_partner?: string;
+	catalog_id?: number;
+	meta?: BrandMeta;
+	applied_diff_snapshot?: Record<string, any>;
+	version?: number;
+	changes?: BrandChangeDTO[];
+	local_menu_group?: LocalMenuGroupDTO;
+	global_menu_group?: GlobalMenuGroupDTO;
+	vendor_metadata?: VendorMetadataDTO[];
+	attachments?: FileAttachmentsDTO;
+	permissions?: Record<string, any>;
+	[index: string]: any;
+}
+
+export interface DeleteMenuV4BrandRequest extends BaseRequest, DeleteMenuV4BrandPath {}
+
+// DELETE menu/v4/brand/{brand_id}/menu/{menu_id}
+
+export interface DeleteMenuV4BrandMenuPath {
+	brand_id: string;
+	menu_id: string;
+}
+
+export interface DeleteMenuV4BrandMenuResponse {
+	parent?: DraftMenuDTO;
+	children?: DraftMenuDTO[];
+	categories?: DraftCategoryDTO[];
+	id: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
+	parent_id?: string;
+	name: string;
+	brand_id: string;
+	applied_diff_snapshot?: Record<string, any>;
+	version?: number;
+	brand?: DraftBrandDTO;
+	changes?: MenuChangeDTO[];
+	vendor_metadata?: VendorMetadataDTO[];
+	permissions?: Record<string, any>;
+	[index: string]: any;
+}
+
+export interface DeleteMenuV4BrandMenuRequest extends BaseRequest, DeleteMenuV4BrandMenuPath {}
+
+// DELETE menu/v4/brand/{brand_id}/category/{category_id}
+
+export interface DeleteMenuV4BrandCategoryPath {
+	brand_id: string;
+	category_id: string;
+}
+
+export interface DeleteMenuV4BrandCategoryResponse {
+	parent?: DraftCategoryDTO;
+	children?: DraftCategoryDTO[];
+	id: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
+	parent_id?: string;
+	name: string;
+	label?: string;
+	sequence?: number;
+	is_active?: boolean;
+	brand_id: string;
+	menu_id: string;
+	applied_diff_snapshot?: Record<string, any>;
+	version?: number;
+	menu?: DraftMenuDTO;
+	items?: DraftCategoryToItemRelationshipDTO[];
+	brand?: DraftBrandDTO;
+	changes?: CategoryChangeDTO[];
+	vendor_metadata?: VendorMetadataDTO[];
+	attachments?: FileAttachmentsDTO;
+	permissions?: Record<string, any>;
+	[index: string]: any;
+}
+
+export interface DeleteMenuV4BrandCategoryRequest
+	extends BaseRequest,
+		DeleteMenuV4BrandCategoryPath {}
+
 // POST /menu/v4/item
 
 export interface PostMenuV4ItemBody {
+	is_published?: boolean;
 	parent?: DraftItemDTO;
 	children?: DraftItemDTO[];
 	modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
@@ -7507,6 +7754,7 @@ export interface PostMenuV4ItemBody {
 }
 
 export interface PostMenuV4ItemResponse {
+	is_published?: boolean;
 	parent?: DraftItemDTO;
 	children?: DraftItemDTO[];
 	modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
@@ -7566,6 +7814,7 @@ export interface GetMenuV4ItemQuery {
 }
 
 export interface GetMenuV4ItemResponse {
+	is_published?: boolean;
 	parent?: DraftItemDTO;
 	children?: DraftItemDTO[];
 	modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
@@ -7622,6 +7871,7 @@ export interface PatchMenuV4ItemPath {
 
 export interface PatchMenuV4ItemBody {
 	base_item_id?: string;
+	is_published?: boolean;
 	parent?: DraftItemDTO;
 	children?: DraftItemDTO[];
 	modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
@@ -7661,6 +7911,7 @@ export interface PatchMenuV4ItemBody {
 }
 
 export interface PatchMenuV4ItemResponse {
+	is_published?: boolean;
 	parent?: DraftItemDTO;
 	children?: DraftItemDTO[];
 	modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
@@ -7708,6 +7959,58 @@ export interface PatchMenuV4ItemRequest extends BaseRequest, PatchMenuV4ItemPath
 	body: PatchMenuV4ItemBody;
 }
 
+// DELETE /menu/v4/item/{id}
+
+export interface DeleteMenuV4ItemPath {
+	id: string;
+}
+
+export interface DeleteMenuV4ItemResponse {
+	parent?: DraftItemDTO;
+	children?: DraftItemDTO[];
+	modifier_groups?: DraftItemToModifierGroupRelationshipDTO[];
+	id: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
+	parent_id?: string;
+	name: string;
+	name_on_receipt?: string;
+	name_on_kds?: string;
+	label?: string;
+	description?: string;
+	reporting: ReportingMetadataDTO;
+	price: number;
+	barcode?: string;
+	calories?: number;
+	meal_value?: number;
+	is_active?: boolean;
+	posid?: string;
+	tax_tags?: string[];
+	brand_id: string;
+	line_route?: string;
+	posid_segment?: number;
+	menu_works?: MenuWorksDTO;
+	is_out_of_stock?: boolean;
+	tax_tag_code?: string;
+	tags?: string[];
+	is_featured?: boolean;
+	tax_jwo_code?: string;
+	unique_id?: number;
+	applied_diff_snapshot?: Record<string, any>;
+	version?: number;
+	brand?: DraftBrandDTO;
+	categories?: DraftCategoryToItemRelationshipDTO[];
+	changes?: ItemChangeDTO[];
+	vendor_metadata?: VendorMetadataDTO[];
+	attachments?: FileAttachmentsDTO;
+	weight?: WeightDTO;
+	permissions?: Record<string, any>;
+	[index: string]: any;
+}
+
+export interface DeleteMenuV4ItemRequest extends BaseRequest, DeleteMenuV4ItemPath {}
+
 // POST /menu/v4/modifier
 
 export interface PostMenuV4ModifierBody {
@@ -7951,6 +8254,58 @@ export interface PatchMenuV4ModifierRequest extends BaseRequest, PatchMenuV4Modi
 	body: PatchMenuV4ModifierBody;
 }
 
+// DELETE /menu/v4/modifier/{id}
+
+export interface DeleteMenuV4ModifierPath {
+	id: string;
+}
+
+export interface DeleteMenuV4ModifierResponse {
+	parent?: DraftModifierDTO;
+	children?: DraftModifierDTO[];
+	modifier_groups?: DraftModifierGroupToModifierRelationshipDTO[];
+	id: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
+	parent_id?: string;
+	name: string;
+	name_on_receipt?: string;
+	name_on_kds?: string;
+	label?: string;
+	description?: string;
+	price: number;
+	calories?: number;
+	tax_tags?: string[];
+	is_active?: boolean;
+	posid?: string;
+	reporting: ReportingMetadataDTO;
+	posid_segment?: number;
+	brand_id: string;
+	line_route?: string;
+	menu_works?: MenuWorksDTO;
+	is_out_of_stock?: boolean;
+	price_for_none?: number;
+	price_for_less?: number;
+	price_for_more?: number;
+	pre_surcharge?: number;
+	post_surcharge?: number;
+	tax_tag_code?: string;
+	tags?: string[];
+	unique_id?: number;
+	applied_diff_snapshot?: Record<string, any>;
+	version?: number;
+	brand?: DraftBrandDTO;
+	changes?: ModifierChangeDTO[];
+	vendor_metadata?: VendorMetadataDTO[];
+	weight?: WeightDTO;
+	attachments?: FileAttachmentsDTO;
+	permissions?: Record<string, any>;
+	[index: string]: any;
+}
+
+export interface DeleteMenuV4ModifierRequest extends BaseRequest, DeleteMenuV4ModifierPath {}
+
 // POST /menu/v4/modifier-group
 
 export interface PostMenuV4ModifierGroupBody {
@@ -8123,6 +8478,46 @@ export interface PatchMenuV4ModifierGroupRequest extends BaseRequest, PatchMenuV
 	body: PatchMenuV4ModifierGroupBody;
 }
 
+// DELETE /menu/v4/modifier-group/{id}
+
+export interface DeleteMenuV4ModifierGroupPath {
+	id: string;
+}
+
+export interface DeleteMenuV4ModifierGroupResponse {
+	parent?: DraftModifierGroupDTO;
+	children?: DraftModifierGroupDTO[];
+	modifiers?: DraftModifierGroupToModifierRelationshipDTO[];
+	items?: DraftItemToModifierGroupRelationshipDTO[];
+	id: string;
+	created_at?: string;
+	updated_at?: string;
+	deleted_at?: string;
+	parent_id?: string;
+	name: string;
+	label?: string;
+	min?: number;
+	max?: number;
+	is_active?: boolean;
+	limit?: number;
+	brand_id: string;
+	order_type?: 'selection' | 'option' | 'quantity';
+	sizing?: string;
+	is_out_of_stock?: boolean;
+	is_incremental?: boolean;
+	applied_diff_snapshot?: Record<string, any>;
+	version?: number;
+	brand?: DraftBrandDTO;
+	changes?: ModifierGroupChangeDTO[];
+	vendor_metadata?: VendorMetadataDTO[];
+	permissions?: Record<string, any>;
+	[index: string]: any;
+}
+
+export interface DeleteMenuV4ModifierGroupRequest
+	extends BaseRequest,
+		DeleteMenuV4ModifierGroupPath {}
+
 // POST /menu/v4/modifier-group/{id}/attach-modifiers
 
 export interface PostMenuV4ModifierGroupAttachModifiersPath {