@compassdigital/sdk.typescript 4.92.0 → 4.94.0

package/src/interface/location.ts

@@ -4,7 +4,6 @@
 import { RequestQuery, BaseRequest } from './util';
 
 export interface MenuHours {
-	// menu
 	id?: string;
 	label?: {
 		en?: string;
@@ -18,7 +17,6 @@ export interface MenuHours {
 }
 
 export interface Hours {
-	// hours
 	id?: string;
 	date?: {
 		deleted?: string;
@@ -33,7 +31,6 @@ export interface Hours {
 }
 
 export interface DeliveryHours {
-	// hours
 	id?: string;
 	day?: {
 		start?: number;
@@ -45,7 +42,7 @@ export interface DeliveryHours {
 export interface Timeslot {
 	// timeslot id (optional)
 	id?: number;
-	// brand
+	// The CDL id representing the brand this timeslot belongs to
 	brand_id?: string;
 	start_time?: string;
 	duration?: string;
@@ -77,7 +74,7 @@ export interface Address {
 export interface Brand {
 	// brand
 	id?: string;
-	// sector
+	// The CDL id representing the sector this brand belongs to
 	sector?: string;
 	name?: string;
 	label?: {
@@ -103,7 +100,7 @@ export interface Brand {
 		main_logo?: string | null;
 		alt_logo?: string | null;
 	};
-	// pos
+	// The CDL id representing the PoS for this brand
 	pos?: string;
 	terminals?: Record<string, any>[];
 	device_mapping?: Record<
@@ -149,17 +146,17 @@ export interface Brand {
 		dining_hall?: boolean;
 		[index: string]: any;
 	};
-	// brand
+	// The CDL id representing the brand
 	brand?: string;
-	// location
+	// The CDL id representing the location of this brand
 	location?: string;
 	// location group
 	group?: string;
-	// payment
+	// The CDL id representing the payment provider of this brand
 	payment_provider?: string;
 	//@deprecated
 	location_description?: string;
-	// company
+	// The CDL id representing the company of this brand
 	company?: string;
 	config?: {
 		private?: Record<string, any>;
@@ -199,6 +196,10 @@ export interface Brand {
 		software_integrations?: {
 			system365?: string;
 			jwo?: string;
+			nextep?: {
+				mobile_app?: boolean;
+			};
+			time2eat?: string;
 		};
 		[index: string]: any;
 	};
@@ -222,7 +223,6 @@ export interface Brand {
 export type Brands = Brand[];
 
 export interface Location {
-	// location
 	id?: string;
 	operation_id?: number;
 	name?: string;
@@ -238,11 +238,11 @@ export interface Location {
 	brands?: Brand[];
 	meta?: Record<string, any>;
 	phone?: string;
-	// group
+	// The CDL is representing the group of this location
 	location_group?: string;
-	// multigroup
+	// The CDL id representing the multigroup of this location
 	location_multigroup?: string;
-	// sector
+	// The CDL id representing the sector of this location
 	sector?: string;
 	date?: {
 		deleted?: string;
@@ -260,6 +260,7 @@ export interface Location {
 		};
 		logo?: string;
 		is?: {
+			enabled?: boolean;
 			pickup_supported?: boolean;
 			delivery_supported?: boolean;
 		};
@@ -285,7 +286,6 @@ export interface Location {
 }
 
 export interface Group {
-	// group
 	id?: string;
 	name?: string;
 	label?: {
@@ -325,7 +325,6 @@ export interface Error {
 }
 
 export interface Sector {
-	// sector
 	id?: string;
 	name?: string;
 	label?: {
@@ -337,14 +336,13 @@ export interface Sector {
 }
 
 export interface Company {
-	// company
 	id?: string;
 	name?: string;
 	label?: {
 		en?: string;
 		fr?: string;
 	};
-	// sector
+	// The CDL id representing the sector of this company
 	sector?: string;
 	locations?: Location[];
 	is?: {
@@ -379,7 +377,6 @@ export interface PostDeliveryDestination {
 }
 
 export interface DeliveryDestination {
-	// delivery_destination
 	id: string;
 	// Name of the delivery destination
 	name: string;
@@ -423,9 +420,9 @@ export interface MarketPlace {
 }
 
 export interface Station {
-	// CDL id
+	// The CDL id representing the brand of the station object
 	brand?: string;
-	// CDL id
+	// The CDL id representing the menu of the station object
 	menu?: string;
 	[index: string]: any;
 }
@@ -457,26 +454,22 @@ export interface MenuAssociations {
 }
 
 export interface MenuAssociation {
-	// CDL id
 	id?: string;
-	// CDL id
+	// The CDL id representing the brand of the menu association
 	brand?: string;
-	// CDL id
+	// The CDL id representing the menu of the menu association
 	menu?: string;
-	// CDL id
+	// The CDL id representing the group of the menu association
 	group?: string;
 	created?: string;
 	[index: string]: any;
 }
 
 export interface WaitTimeResponse {
-	// group
 	id?: string;
 	locations?: {
-		// location
 		id?: string;
 		brands?: {
-			// location
 			id?: string;
 			estimated_wait_time?: {
 				delivery?: WaitTime;
@@ -525,6 +518,7 @@ export interface GetLocationPath {
 export interface GetLocationQuery {
 	// When fetching location, brands will come with private and public configs
 	include_brands_config?: boolean;
+	show_disabled_marketplace?: boolean;
 	// active cafes
 	active_cafes?: string[];
 	// show additional hidden properties/entities
@@ -741,6 +735,7 @@ export interface GetLocationGroupPath {
 
 export interface GetLocationGroupQuery {
 	latitude?: number;
+	show_disabled_marketplace?: boolean;
 	longitude?: number;
 	// When fetching a group, brands will come with private and public configs
 	include_brands_config?: boolean;
@@ -1280,7 +1275,7 @@ export interface PatchLocationSectorRequest
 export interface PostLocationCompanyBody {
 	// Sector name
 	name: string;
-	// sector
+	// The CDL id representing the sector this company belongs to
 	sector: string;
 	label?: Record<string, any>;
 	is?: {