@compassdigital/sdk.typescript 4.527.0 → 4.528.1-beta.0

package/src/interface/menu.ts

@@ -1937,6 +1937,31 @@ export interface BusinessUnitDTO {
 	[index: string]: any;
 }
 
+export interface MenuWorksProductDTO {
+	mrn: string;
+	product_type?: string;
+	name?: string;
+	short_name?: string;
+	[index: string]: any;
+}
+
+export interface ProductsSyncStatusResponseDTO {
+	status: string;
+	items_ingested_count: number;
+	total_available?: number;
+	last_success_at?: string | string;
+	last_failure_at?: string | string;
+	started_at?: string | string;
+	message?: string;
+	[index: string]: any;
+}
+
+export interface ConflictErrorDTO {
+	number: number;
+	message: string;
+	[index: string]: any;
+}
+
 export interface UniversalItemWithoutIdDTO {
 	barcode: string;
 	name: string;
@@ -7790,6 +7815,54 @@ export interface GetMenuV3MenuworksBusinessUnitsResponse {
 
 export interface GetMenuV3MenuworksBusinessUnitsRequest extends BaseRequest {}
 
+// GET /menu/v3/menuworks/business_units/{unit_id}/products
+
+export interface GetMenuV3MenuworksBusinessUnitsProductsPath {
+	unit_id: string;
+}
+
+export interface GetMenuV3MenuworksBusinessUnitsProductsQuery {
+	q?: string;
+	// Number of records to load per page
+	limit?: number;
+	page?: number;
+	// 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[];
+	// 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 GetMenuV3MenuworksBusinessUnitsProductsResponse {
+	results: MenuWorksProductDTO[];
+	sync_status?: ProductsSyncStatusResponseDTO;
+	meta?: ListResponseMetadataDTO;
+	[index: string]: any;
+}
+
+export interface GetMenuV3MenuworksBusinessUnitsProductsRequest
+	extends BaseRequest,
+		RequestQuery<GetMenuV3MenuworksBusinessUnitsProductsQuery>,
+		GetMenuV3MenuworksBusinessUnitsProductsPath {}
+
+// POST /menu/v3/menuworks/business_units/{unit_id}/products/sync
+
+export interface PostMenuV3MenuworksBusinessUnitsProductsSyncPath {
+	unit_id: string;
+}
+
+export interface PostMenuV3MenuworksBusinessUnitsProductsSyncResponse {
+	triggered?: boolean;
+}
+
+export interface PostMenuV3MenuworksBusinessUnitsProductsSyncRequest
+	extends BaseRequest,
+		PostMenuV3MenuworksBusinessUnitsProductsSyncPath {}
+
 // GET /menu/v3/universal-items
 
 export interface GetMenuV3UniversalItemsQuery {