@compassdigital/sdk.typescript 4.82.0 → 4.84.0

package/manifest.json

@@ -70,7 +70,7 @@
         },
         {
             "name": "menu",
-            "swagger": "../../platform2/menu/service/swagger.json"
+            "swagger": "../../platform2/menu/swagger.json"
         },
         {
             "name": "notification",

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@compassdigital/sdk.typescript",
-	"version": "4.82.0",
+	"version": "4.84.0",
 	"description": "Compass Digital Labs TypeScript SDK",
 	"type": "commonjs",
 	"main": "./lib/index.js",
@@ -46,7 +46,7 @@
 	},
 	"devDependencies": {
 		"@compassdigital/review": "^7.3.0",
-		"@compassdigital/sdk.typescript.cli": "^4.27.0",
+		"@compassdigital/sdk.typescript.cli": "^4.30.0",
 		"@swc/core": "^1.4.1",
 		"@swc/jest": "^0.2.36",
 		"@types/jest": "^29.2.4",

package/src/index.ts

@@ -336,10 +336,8 @@ import {
 import {
 	PostAnnouncementBody,
 	PostAnnouncementResponse,
-	GetAnnouncementResourceQuery,
-	GetAnnouncementResourceResponse,
-	GetAnnouncementResourcesQuery,
-	GetAnnouncementResourcesResponse,
+	GetAnnouncementsQuery,
+	GetAnnouncementsResponse,
 	GetAnnouncementQuery,
 	GetAnnouncementResponse,
 	PutAnnouncementBody,
@@ -594,6 +592,7 @@ import {
 	GetMenuV3DraftBrandItemsTagsResponse,
 	GetMenuV3DraftBrandModifiersTagsQuery,
 	GetMenuV3DraftBrandModifiersTagsResponse,
+	PostMenuV3DraftBrandPublishQuery,
 	PostMenuV3DraftBrandPublishResponse,
 	PostMenuV3DraftBrandDiffGenerateResponse,
 	GetMenuV3DraftBrandDiffsQuery,
@@ -866,6 +865,10 @@ import {
 	PostMenuV3UniversalItemsVerifyBody,
 	PostMenuV3UniversalItemsVerifyResponse,
 	PostMenuV3TriggerUpdateResponse,
+	PostMenuV4BrandBody,
+	PostMenuV4BrandResponse,
+	GetMenuV4BrandQuery,
+	GetMenuV4BrandResponse,
 } from './interface/menu';
 
 import {
@@ -3871,45 +3874,16 @@ export class ServiceClient extends BaseServiceClient {
 	}
 
 	/**
-	 * GET /announcement/resource/{id} - Get Announcements
-	 *
-	 * @param id - Id of the entity to which announcement is specifically related.
-	 * @param options - additional request options
-	 */
-	get_announcement_resource(
-		id: string,
-		options?: {
-			query?: GetAnnouncementResourceQuery;
-		} & RequestOptions,
-	): ResponsePromise<GetAnnouncementResourceResponse> {
-		return this.request(
-			'announcement',
-			'/announcement/resource/{id}',
-			'get',
-			`/announcement/resource/${id}`,
-			null,
-			options,
-		);
-	}
-
-	/**
-	 * GET /announcement/resource - Get Announcements
+	 * GET /announcement - Get Announcements
 	 *
 	 * @param options - additional request options
 	 */
-	get_announcement_resources(
-		options?: {
-			query?: GetAnnouncementResourcesQuery;
+	get_announcements(
+		options: {
+			query: GetAnnouncementsQuery;
 		} & RequestOptions,
-	): ResponsePromise<GetAnnouncementResourcesResponse> {
-		return this.request(
-			'announcement',
-			'/announcement/resource',
-			'get',
-			`/announcement/resource`,
-			null,
-			options,
-		);
+	): ResponsePromise<GetAnnouncementsResponse> {
+		return this.request('announcement', '/announcement', 'get', `/announcement`, null, options);
 	}
 
 	/**
@@ -6282,7 +6256,9 @@ export class ServiceClient extends BaseServiceClient {
 	 */
 	post_menu_v3_draft_brand_publish(
 		id: string,
-		options?: RequestOptions,
+		options?: {
+			query?: PostMenuV3DraftBrandPublishQuery;
+		} & RequestOptions,
 	): ResponsePromise<PostMenuV3DraftBrandPublishResponse> {
 		return this.request(
 			'menu',
@@ -9169,6 +9145,41 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * POST /menu/v4/brand
+	 *
+	 * @param body
+	 * @param options - additional request options
+	 */
+	post_menu_v4_brand(
+		body: PostMenuV4BrandBody,
+		options?: RequestOptions,
+	): ResponsePromise<PostMenuV4BrandResponse> {
+		return this.request('menu', '/menu/v4/brand', 'post', `/menu/v4/brand`, body, options);
+	}
+
+	/**
+	 * GET /menu/v4/brand/{id}
+	 *
+	 * @param id
+	 * @param options - additional request options
+	 */
+	get_menu_v4_brand(
+		id: string,
+		options?: {
+			query?: GetMenuV4BrandQuery;
+		} & RequestOptions,
+	): ResponsePromise<GetMenuV4BrandResponse> {
+		return this.request(
+			'menu',
+			'/menu/v4/brand/{id}',
+			'get',
+			`/menu/v4/brand/${id}`,
+			null,
+			options,
+		);
+	}
+
 	/**
 	 * GET /notification - Get all notifications
 	 *

package/src/interface/announcement.ts

@@ -18,6 +18,10 @@ export interface Announcement {
 	id?: string;
 	// Name of Announcement
 	name?: string;
+	// Date created
+	created_at?: string;
+	// Date modified
+	last_modified?: string;
 	// Announcement Type
 	type?: string;
 	key?: string;
@@ -33,7 +37,21 @@ export interface Announcement {
 		en?: Announcement_info;
 		fr?: Announcement_info;
 	};
+	// Schedule details
+	schedule?: {
+		// If true, refer to `sites`, if false, refer to start/end times below
+		variable?: boolean;
+		start_datetime?: string;
+		end_datetime?: string;
+		sites?: {
+			// group
+			id: string;
+			start_datetime: string;
+			end_datetime: string;
+		}[];
+	};
 	date?: Record<string, any>;
+	author?: Author;
 	[index: string]: any;
 }
 
@@ -49,6 +67,14 @@ export interface Announcement_info {
 	button_text?: string;
 }
 
+export interface Author {
+	id: string;
+	name: {
+		first?: string;
+		last?: string;
+	};
+}
+
 // POST /announcement - Create Announcement
 
 export type PostAnnouncementBody = Announcement;
@@ -59,41 +85,41 @@ export interface PostAnnouncementRequest extends BaseRequest {
 	body: PostAnnouncementBody;
 }
 
-// GET /announcement/resource/{id} - Get Announcements
-
-export interface GetAnnouncementResourcePath {
-	// Id of the entity to which announcement is specifically related.
-	id: string;
-}
-
-export interface GetAnnouncementResourceQuery {
-	// Resource Id linked to announcement
-	allowed_resource_id?: string;
-	disabled?: boolean;
-	// Graphql query string
-	_query?: string;
-}
-
-export type GetAnnouncementResourceResponse = Announcements;
-
-export interface GetAnnouncementResourceRequest
-	extends BaseRequest,
-		RequestQuery<GetAnnouncementResourceQuery>,
-		GetAnnouncementResourcePath {}
-
-// GET /announcement/resource - Get Announcements
-
-export interface GetAnnouncementResourcesQuery {
-	disabled?: boolean;
+// GET /announcement - Get Announcements
+
+export interface GetAnnouncementsQuery {
+	// Filter by earliest creation date
+	created_at_start?: string;
+	// Filter by latest creation date
+	created_at_end?: string;
+	// Filter by earliest modified date
+	last_modified_start: string;
+	// Filter by latest modified date
+	last_modified_end?: string;
+	// Filter by earliest start date
+	start_date_start?: string;
+	// Filter by latest start date
+	start_date_end?: string;
+	// Filter by earliest end date
+	end_date_start?: string;
+	// Filter by latest end date
+	end_date_end?: string;
+	realm?: string;
+	// Filter by announcement name
+	name?: string;
+	// Filter by announcement position
+	position?: number;
+	// Filter by announcement enabled status
+	enabled?: boolean;
+	// Filter by announcement purpose
+	purpose?: string;
 	// Graphql query string
 	_query?: string;
 }
 
-export type GetAnnouncementResourcesResponse = Announcements;
+export type GetAnnouncementsResponse = Announcements;
 
-export interface GetAnnouncementResourcesRequest
-	extends BaseRequest,
-		RequestQuery<GetAnnouncementResourcesQuery> {}
+export interface GetAnnouncementsRequest extends BaseRequest, RequestQuery<GetAnnouncementsQuery> {}
 
 // GET /announcement/{id} - Get Announcement
 

package/src/interface/centricos.ts

@@ -73,9 +73,7 @@ export interface LookerEmbedURLResponse {
 }
 
 export interface SiteDevicesResponse {
-	site_devices: {
-		[index: string]: any;
-	};
+	site_devices: Record<string, any>;
 }
 
 export interface PageMetadata {

package/src/interface/datalake.ts

@@ -18,9 +18,7 @@ export interface QueryBody {
 export type PostDatalakeSqlBody = QueryBody;
 
 export interface PostDatalakeSqlResponse {
-	rows?: {
-		[index: string]: any;
-	}[];
+	rows?: Record<string, any>[];
 }
 
 export interface PostDatalakeSqlRequest extends BaseRequest {

package/src/interface/location.ts

@@ -106,13 +106,14 @@ export interface Brand {
 	// pos
 	pos?: string;
 	terminals?: Record<string, any>[];
-	device_mapping?: {
-		[index: string]: {
+	device_mapping?: Record<
+		string,
+		{
 			device_type: string;
 			site_device_id: string;
 			business_units: string[];
-		}[];
-	};
+		}[]
+	>;
 	timeslots?: {
 		time?: string;
 		averagePrepTime?: string;
@@ -235,9 +236,7 @@ export interface Location {
 	latitude?: number;
 	longitude?: number;
 	brands?: Brand[];
-	meta?: {
-		[index: string]: any;
-	};
+	meta?: Record<string, any>;
 	phone?: string;
 	// group
 	location_group?: string;
@@ -297,9 +296,7 @@ export interface Group {
 	distance?: number;
 	locations?: Location[];
 	address?: Address;
-	meta?: {
-		[index: string]: any;
-	};
+	meta?: Record<string, any>;
 	style?: {
 		logo?: string | null;
 		main_logo?: string | null;
@@ -336,9 +333,7 @@ export interface Sector {
 		fr?: string;
 	};
 	companies?: Company[];
-	meta?: {
-		[index: string]: any;
-	};
+	meta?: Record<string, any>;
 }
 
 export interface Company {
@@ -355,9 +350,7 @@ export interface Company {
 	is?: {
 		global_images_enabled?: boolean;
 	};
-	meta?: {
-		[index: string]: any;
-	};
+	meta?: Record<string, any>;
 }
 
 export interface Locations {

package/src/interface/mealplan.ts

@@ -32,6 +32,11 @@ export interface TendersAndAuth {
 	auth?: AuthPayload;
 }
 
+export interface DrainedTender {
+	name?: string;
+	amount?: number;
+}
+
 export interface VerifyEmail {
 	email?: string;
 }
@@ -45,9 +50,7 @@ export interface AuthPayload {
 		url?: string;
 		method?: string;
 		encoding?: string;
-		body?: {
-			[index: string]: any;
-		};
+		body?: Record<string, any>;
 	};
 	direct?: {
 		name?: {
@@ -233,6 +236,7 @@ export interface DeleteMealplanTenderResponse {
 	currency?: string;
 	transaction_amount?: number;
 	drained_tender_name?: string;
+	drained_tender_breakdown?: DrainedTender[];
 }
 
 export interface DeleteMealplanTenderRequest extends BaseRequest, DeleteMealplanTenderPath {

package/src/interface/menu.ts

@@ -153,6 +153,26 @@ export interface Item {
 			tax_rate?: number;
 			tax_amount?: number;
 		};
+		recipe?: {
+			// menuworks mrn
+			mrn?: string;
+			// menuworks unit id
+			unit_id?: string;
+			// menuworks portion quantity
+			portion_quantity?: string;
+			// menuworks portion unit name
+			portion_unit_name?: string;
+			// menuworks grams
+			grams?: string;
+			// menuworks cost (per serving)
+			cost?: string;
+			// menuworks ingredients
+			ingredients?: string[];
+			// menuworks smart tags
+			smart_tags?: string[];
+			// menuworks allergen tags
+			allergen_tags?: string[];
+		};
 		[index: string]: any;
 	};
 	category?: {
@@ -280,6 +300,26 @@ export interface Option {
 		tax?: {
 			tax_tag_code?: string;
 		};
+		recipe?: {
+			// menuworks mrn
+			mrn?: string;
+			// menuworks unit id
+			unit_id?: string;
+			// menuworks portion quantity
+			portion_quantity?: string;
+			// menuworks portion unit name
+			portion_unit_name?: string;
+			// menuworks grams
+			grams?: string;
+			// menuworks cost (per serving)
+			cost?: string;
+			// menuworks ingredients
+			ingredients?: string[];
+			// menuworks smart tags
+			smart_tags?: string[];
+			// menuworks allergen tags
+			allergen_tags?: string[];
+		};
 		[index: string]: any;
 	};
 	is?: {
@@ -336,9 +376,7 @@ export interface CreateOptionsGroup {
 		hidden?: boolean;
 		out_of_stock?: boolean;
 	};
-	meta?: {
-		[index: string]: any;
-	};
+	meta?: Record<string, any>;
 	// company
 	company: string;
 }
@@ -793,6 +831,9 @@ export interface MenuWorksDTO {
 	portion_unit_name?: string;
 	grams?: number;
 	cost?: number;
+	ingredients?: string[];
+	smart_tags?: string[];
+	allergen_tags?: string[];
 	[index: string]: any;
 }
 
@@ -886,6 +927,7 @@ export interface AuditDTO {
 	id?: string;
 	data?: Record<string, any>;
 	s3_link?: string;
+	email?: string;
 	brand?: DraftBrandDTO;
 	permissions?: Record<string, any>;
 	[index: string]: any;
@@ -930,6 +972,7 @@ export interface AuditListDraftItemDTO {
 	deleted_at?: string;
 	data?: Record<string, any>;
 	s3_link?: string;
+	email?: string;
 	version?: number;
 	brand?: DraftBrandDTO;
 	permissions?: Record<string, any>;
@@ -1295,9 +1338,7 @@ export interface V2ModifierGroupDTO {
 	min?: number;
 	max?: number;
 	is?: Record<string, any>;
-	meta?: {
-		[index: string]: any;
-	};
+	meta?: Record<string, any>;
 }
 
 export interface V2ModifierDTO {
@@ -3204,12 +3245,17 @@ export interface PostMenuV3DraftBrandPublishPath {
 	id: string;
 }
 
+export interface PostMenuV3DraftBrandPublishQuery {
+	process_id?: string;
+}
+
 export interface PostMenuV3DraftBrandPublishResponse {
 	status?: string;
 }
 
 export interface PostMenuV3DraftBrandPublishRequest
 	extends BaseRequest,
+		RequestQuery<PostMenuV3DraftBrandPublishQuery>,
 		PostMenuV3DraftBrandPublishPath {}
 
 // POST /menu/v3/draft/brand/{id}/diff/generate
@@ -6593,11 +6639,16 @@ export interface GetMenuV3MenuworksQuery {
 export interface GetMenuV3MenuworksResponse {
 	calories?: number;
 	unit_id?: string;
+	name?: string;
+	description?: string;
 	MRN?: string;
 	portion_quantity?: number;
 	portion_unit_name?: string;
 	grams?: number;
 	cost?: number;
+	ingredients?: string[];
+	smart_tags?: string[];
+	allergen_tags?: string[];
 	[index: string]: any;
 }
 
@@ -6739,3 +6790,105 @@ export interface PostMenuV3TriggerUpdateResponse {
 }
 
 export interface PostMenuV3TriggerUpdateRequest extends BaseRequest {}
+
+// POST /menu/v4/brand
+
+export interface PostMenuV4BrandBody {
+	name?: string;
+}
+
+export interface PostMenuV4BrandResponse {
+	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;
+	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 PostMenuV4BrandRequest extends BaseRequest {
+	body: PostMenuV4BrandBody;
+}
+
+// GET /menu/v4/brand/{id}
+
+export interface GetMenuV4BrandPath {
+	id: string;
+}
+
+export interface GetMenuV4BrandQuery {
+	// Graphql query string
+	_query?: string;
+}
+
+export interface GetMenuV4BrandResponse {
+	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;
+	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 GetMenuV4BrandRequest
+	extends BaseRequest,
+		RequestQuery<GetMenuV4BrandQuery>,
+		GetMenuV4BrandPath {}

package/src/interface/order.ts

@@ -62,9 +62,7 @@ export interface Issue {
 	id?: string;
 	type?: string;
 	//@deprecated
-	item?: {
-		[index: string]: any;
-	};
+	item?: Record<string, any>;
 	// Array of Items with issues
 	items?: ItemsWithIssue[];
 	// Optional additional explanation for issue: 5,10,15 for late issues, SOLD_OUT, MODIFICATION, DIETARY_RESTRICTION for see kitchen issues
@@ -213,6 +211,8 @@ export interface Order {
 			code?: string;
 			[index: string]: any;
 		};
+		// The type of kds that the brand uses
+		type_of_kds?: string;
 		[index: string]: any;
 	};
 	issue?: Issue;
@@ -302,9 +302,7 @@ export interface OrderIssue {
 	// Type of issue
 	type?: string;
 	//@deprecated
-	item?: {
-		[index: string]: any;
-	};
+	item?: Record<string, any>;
 	// Array of Items with issues
 	items?: ItemsWithIssue[];
 	// Optional additional explanation for issue: 5,10,15 for late issues, SOLD_OUT, MODIFICATION, DIETARY_RESTRICTION for see kitchen issues
@@ -331,9 +329,7 @@ export interface OrderedItem {
 	_promo?: {
 		amount?: number;
 	};
-	meta?: {
-		[index: string]: any;
-	};
+	meta?: Record<string, any>;
 	options?: {
 		label?: {
 			en?: string;