@compassdigital/sdk.typescript 4.416.0 → 4.418.0

package/src/interface/consumer.ts

@@ -1176,11 +1176,17 @@ export interface ConsumerLocationMarketPlace {
 }
 
 export interface ConsumerAddress {
+	// Suite number of the address, if applicable
 	suite?: string;
+	// First line of the address, should include street number
 	address?: string;
+	// City of the address
 	city?: string;
+	// State of the address, also province in Canada
 	state?: string;
+	// Country of the address
 	country?: string;
+	// Zip code or postal code of the address
 	zip?: string;
 	coordinates?: {
 		latitude?: number;
@@ -1485,10 +1491,6 @@ export interface GetConsumerLocationGroupResponse {
 	};
 	// distance in meters from the group
 	distance?: number;
-	// list of locations
-	locations?: Record<string, any>[];
-	// location address
-	address?: Record<string, any>;
 	// meta data
 	meta?: Record<string, any>;
 	style?: {
@@ -1498,6 +1500,8 @@ export interface GetConsumerLocationGroupResponse {
 	};
 	// timezone
 	timezone?: string;
+	locations?: ConsumerLocation[];
+	address?: ConsumerAddress;
 }
 
 export interface GetConsumerLocationMultiGroupResponse {
@@ -3299,11 +3303,6 @@ export interface OpenAiChatResponse {
 
 // GET /consumer/v1/health-check
 
-export interface HealthCheckControllerExecuteQuery {
-	// Graphql query string
-	_query?: string;
-}
-
 export type HealthCheckControllerExecuteResponse = {};
 
 // GET /consumer/v1/payment-methods - List payment methods available in a given brand
@@ -3313,8 +3312,6 @@ export interface GetPaymentListByBrandQuery {
 	brandID?: string;
 	// Site ID as Encoded CDL ID
 	siteID?: string;
-	// Graphql query string
-	_query?: string;
 }
 
 export type GetPaymentListByBrandResponse = ListAvailablePaymentsResponseDTO;
@@ -3331,8 +3328,6 @@ export interface GetCustomerOrdersQuery {
 	start?: number;
 	// Filter orders by their requested date. Only return orders that have a date less than or equal to the date. Default is 24 hours from the current time in milliseconds. Please ensure to use a millisecond timestamp, not just an epoch timestamp
 	end?: number;
-	// Graphql query string
-	_query?: string;
 }
 
 export type GetCustomerOrdersResponse = GetCustomerOrdersResponseDTO;
@@ -3378,8 +3373,6 @@ export interface GetConsumerHomePageQuery {
 	timezoneOffset: string;
 	// reorder eligible
 	reorderEligible: boolean;
-	// Graphql query string
-	_query?: string;
 }
 
 export type GetConsumerHomePageResponse = HomePageResponse;
@@ -3390,11 +3383,6 @@ export interface GetConsumerFrictionlessCheckinPath {
 	id: string;
 }
 
-export interface GetConsumerFrictionlessCheckinQuery {
-	// Graphql query string
-	_query?: string;
-}
-
 export type GetConsumerFrictionlessCheckinResponse = FrictionlessCheckinResponse;
 
 // POST /consumer/frictionless/qrCode - Create a QR code for a frictionless checkin
@@ -3450,7 +3438,7 @@ export interface GetConsumerLocationGroupQuery {
 	non_scan_go?: boolean;
 	// Include estimated wait time
 	include_estimated_wait_time?: boolean;
-	// Graphql query string
+	// Graphql query
 	_query?: string;
 	// Latitude of the user
 	nocache?: boolean;
@@ -3484,7 +3472,6 @@ export interface GetConsumerLocationMultigroupQuery {
 	non_market_places?: boolean;
 	// Non scan go
 	non_scan_go?: boolean;
-	// Graphql query string
 	_query?: string;
 	nocache?: boolean;
 }
@@ -3507,8 +3494,6 @@ export interface GetConsumerActiveMenusQuery {
 	isPickUp?: boolean;
 	// is drop off
 	isDropOff?: boolean;
-	// Graphql query string
-	_query?: string;
 }
 
 export type GetConsumerActiveMenusResponse = ConsumerGetActiveMenusResponse;
@@ -3523,8 +3508,6 @@ export interface GetConsumerMenuRecommendedItemsPath {
 export interface GetConsumerMenuRecommendedItemsQuery {
 	// Comma-separated list of item IDs to exclude from recommendations
 	excludedItems?: string;
-	// Graphql query string
-	_query?: string;
 }
 
 export type GetConsumerMenuRecommendedItemsResponse$0 = GetConsumerMenuRecommendedItemsResponse;
@@ -3536,11 +3519,6 @@ export interface GetConsumerMenuPath {
 	id: string;
 }
 
-export interface GetConsumerMenuQuery {
-	// Graphql query string
-	_query?: string;
-}
-
 export type GetConsumerMenuResponse = GetMenuResponseConsumer;
 
 // GET /consumer/menu/{id}/items - Provide the front end with menu items
@@ -3557,8 +3535,6 @@ export interface GetConsumerMenuItemsQuery {
 	brand_id: string;
 	// GraphQL query
 	query: string;
-	// Graphql query string
-	_query?: string;
 }
 
 export type GetConsumerMenuItemsResponse$0 = GetConsumerMenuItemsResponse;
@@ -3626,11 +3602,6 @@ export interface GetConsumerUserPath {
 	id: string;
 }
 
-export interface GetConsumerUserQuery {
-	// Graphql query string
-	_query?: string;
-}
-
 export type GetConsumerUserResponse$0 = GetConsumerUserResponse;
 
 // DELETE /consumer/user/logout - Delete user
@@ -3684,11 +3655,6 @@ export interface GetConsumerShoppingcartPath {
 	id: string;
 }
 
-export interface GetConsumerShoppingcartQuery {
-	// Graphql query string
-	_query?: string;
-}
-
 export type GetConsumerShoppingcartResponse = GetConsumerShoppingCartResponse;
 
 // PUT /consumer/shoppingcart/{id} - Update a shopping cart by ID
@@ -3767,11 +3733,6 @@ export interface GetMealplanConsumerPath {
 	mealplanId: string;
 }
 
-export interface GetMealplanConsumerQuery {
-	// Graphql query string
-	_query?: string;
-}
-
 export type GetMealplanConsumerResponse = ConsumerGetMealplanResponse;
 
 // POST /consumer/mealplan/{mealplanId} - add mealplan
@@ -3814,11 +3775,6 @@ export interface GetConsumerConfigAppconfigPath {
 	app: string;
 }
 
-export interface GetConsumerConfigAppconfigQuery {
-	// Graphql query string
-	_query?: string;
-}
-
 export type GetConsumerConfigAppconfigResponse = GetConsumerAppConfigResponse;
 
 // PATCH /consumer/order/{orderId}/checkin - Patch checkin customer order
@@ -3836,11 +3792,6 @@ export interface GetConsumerAppThemePath {
 	siteId: string;
 }
 
-export interface GetConsumerAppThemeQuery {
-	// Graphql query string
-	_query?: string;
-}
-
 export type GetConsumerAppThemeResponse = GetAppThemeResponse;
 
 // GET /consumer/location/brand/{brandId}/timeslots/menu/{menuId} - Get location brand menu timeslots
@@ -3855,8 +3806,6 @@ export interface GetConsumerBrandMenuTimeslotsPath {
 export interface GetConsumerBrandMenuTimeslotsQuery {
 	// Date in milliseconds
 	date: number;
-	// Graphql query string
-	_query?: string;
 }
 
 export type GetConsumerBrandMenuTimeslotsResponse = GetConsumerLocationBrandMenuTimeslotsResponse;
@@ -3873,8 +3822,6 @@ export interface GetConsumerBrandMenuDeliveryTimeslotsPath {
 export interface GetConsumerBrandMenuDeliveryTimeslotsQuery {
 	// Date in milliseconds
 	date: number;
-	// Graphql query string
-	_query?: string;
 }
 
 export type GetConsumerBrandMenuDeliveryTimeslotsResponse =
@@ -3887,11 +3834,6 @@ export interface GetConsumerConfigPublicPath {
 	id: string;
 }
 
-export interface GetConsumerConfigPublicQuery {
-	// Graphql query string
-	_query?: string;
-}
-
 export type GetConsumerConfigPublicResponse$0 = GetConsumerConfigPublicResponse;
 
 // PUT /consumer/shoppingcart/{id}/paymentmethod - Update a shopping cart by ID
@@ -3941,11 +3883,6 @@ export interface GetConsumerStationDiscountsPath {
 	siteId: string;
 }
 
-export interface GetConsumerStationDiscountsQuery {
-	// Graphql query string
-	_query?: string;
-}
-
 export type GetConsumerStationDiscountsResponse = ConsumerGroup;
 
 // POST /consumer/shoppingcart/{id}/clone - clone a shopping cart
@@ -3972,7 +3909,7 @@ export interface GetConsumerLocationBrandQuery {
 	extended?: boolean;
 	// Include estimated wait time
 	include_estimated_wait_time?: boolean;
-	// Graphql query string
+	// Graphql query
 	_query?: string;
 	// No cache
 	nocache?: boolean;

package/src/interface/datalake.ts

@@ -27,13 +27,6 @@ export interface PostDatalakeSqlRequest extends BaseRequest {
 
 // GET /swagger.json
 
-export interface GetDatalakeSwaggerQuery {
-	// Graphql query string
-	_query?: string;
-}
-
 export type GetDatalakeSwaggerResponse = Record<string, any>;
 
-export interface GetDatalakeSwaggerRequest
-	extends BaseRequest,
-		RequestQuery<GetDatalakeSwaggerQuery> {}
+export interface GetDatalakeSwaggerRequest extends BaseRequest {}

package/src/interface/discount.ts

@@ -411,11 +411,6 @@ export interface GetDiscountPath {
 	id: string;
 }
 
-export interface GetDiscountQuery {
-	// Graphql query string
-	_query?: string;
-}
-
 export type GetDiscountResponse = GetDiscountResponseDTO;
 
 // PATCH /discount/{id} - Patch a discount
@@ -442,11 +437,6 @@ export type PutDiscountResponse = PutDiscountResponseDTO;
 
 // GET /discount/all - Get all discounts
 
-export interface GetDiscountsAllQuery {
-	// Graphql query string
-	_query?: string;
-}
-
 export type GetDiscountsAllResponse = GetAllDiscountsResponseDTO;
 
 // GET /discount - Get discounts by taxonomy
@@ -455,8 +445,6 @@ export interface GetDiscountsQuery {
 	taxonomyFilter: string;
 	statusFilter?: string;
 	validateSchedule?: boolean;
-	// Graphql query string
-	_query?: string;
 }
 
 export type GetDiscountsResponse = GetDiscountsResponseDTO;

package/src/interface/forecasting.ts

@@ -127,8 +127,6 @@ export type ProductionSheetControllerCreateSheetResponse = ProductionSheetRespon
 export interface ProductionSheetControllerGetScheduledMenuDataQuery {
 	siteId: string;
 	date: string;
-	// Graphql query string
-	_query?: string;
 }
 
 export type ProductionSheetControllerGetScheduledMenuDataResponse = {};
@@ -156,19 +154,12 @@ export type ProductionSheetControllerSendChatFeedbackResponse = {};
 
 export interface ProductionSheetControllerGetForecastMetaDataQuery {
 	site_id: string;
-	// Graphql query string
-	_query?: string;
 }
 
 export type ProductionSheetControllerGetForecastMetaDataResponse = {};
 
 // GET /forecasting/status
 
-export interface ProductionSheetControllerServiceStatusQuery {
-	// Graphql query string
-	_query?: string;
-}
-
 export type ProductionSheetControllerServiceStatusResponse = {};
 
 // POST /forecasting/chat-stream - Stream chat responses from Luna for forecasting chat

package/src/interface/frictionless.ts

@@ -200,11 +200,6 @@ export interface GetFrictionlessBrandFrictionlessStatusPath {
 	id_brand: string;
 }
 
-export interface GetFrictionlessBrandFrictionlessStatusQuery {
-	// Graphql query string
-	_query?: string;
-}
-
 export type GetFrictionlessBrandFrictionlessStatusResponse = FrictionlessSupportResponseDTO;
 
 // POST /frictionless/qrcode - Create Frictionless QR Code to make user able to check in
@@ -219,11 +214,6 @@ export interface GetFrictionlessCheckinStatusPath {
 	id_checkin: string;
 }
 
-export interface GetFrictionlessCheckinStatusQuery {
-	// Graphql query string
-	_query?: string;
-}
-
 export type GetFrictionlessCheckinStatusResponse = GetCheckInStatusResponseDTO;
 
 // GET /frictionless/checkin/{id_checkin} - Fetch CheckIn
@@ -232,11 +222,6 @@ export interface GetFrictionlessCheckinPath {
 	id_checkin: string;
 }
 
-export interface GetFrictionlessCheckinQuery {
-	// Graphql query string
-	_query?: string;
-}
-
 export type GetFrictionlessCheckinResponse = GetCheckinResponseDTO;
 
 // GET /frictionless/users/{user_id}/checkins/payment-issues - List check-ins with update payment required per user
@@ -245,20 +230,10 @@ export interface GetFrictionlessUsersPaymentIssuesPath {
 	user_id: string;
 }
 
-export interface GetFrictionlessUsersPaymentIssuesQuery {
-	// Graphql query string
-	_query?: string;
-}
-
 export type GetFrictionlessUsersPaymentIssuesResponse = CheckInPaymentRequiredDTO[];
 
 // GET /frictionless/failed-checkins - List check-ins on error
 
-export interface GetFrictionlessFailedCheckinsQuery {
-	// Graphql query string
-	_query?: string;
-}
-
 export type GetFrictionlessFailedCheckinsResponse = FailedCheckInDTO[];
 
 // POST /frictionless/checkins/{id_checkin}/reprocess - Reprocess checkin on error

package/src/interface/kds.ts

@@ -65,8 +65,6 @@ export interface GetKdsDevicesQuery {
 	unitNumber: string;
 	// Do not return cached device information
 	nocache?: boolean;
-	// Graphql query string
-	_query?: string;
 }
 
 export type GetKdsDevicesResponse = Units;
@@ -122,13 +120,8 @@ export interface DeleteKdsDeviceInfoRequest extends BaseRequest, DeleteKdsDevice
 
 // GET /kds/swagger.json - Get a swagger for kds service
 
-export interface GetKdsSwaggerQuery {
-	// Graphql query string
-	_query?: string;
-}
-
 export interface GetKdsSwaggerResponse {
 	[index: string]: any;
 }
 
-export interface GetKdsSwaggerRequest extends BaseRequest, RequestQuery<GetKdsSwaggerQuery> {}
+export interface GetKdsSwaggerRequest extends BaseRequest {}

package/src/interface/location.ts

@@ -563,8 +563,6 @@ export interface GetLocationSearchQuery {
 	long?: number;
 	// Operation id to be used
 	operation_id?: number;
-	// Graphql query string
-	_query?: string;
 }
 
 export type GetLocationSearchResponse = Locations;
@@ -588,8 +586,6 @@ export interface GetLocationQuery {
 	active_cafes?: string[];
 	// show additional hidden properties/entities
 	extended?: boolean;
-	// Graphql query string
-	_query?: string;
 	nocache?: boolean;
 }
 
@@ -648,8 +644,6 @@ export interface PostLocationBatchGetRequest extends BaseRequest {
 // GET /location/multigroup - Get all the top level multigroups
 
 export interface GetLocationMultigroupsQuery {
-	// Graphql query string
-	_query?: string;
 	nocache?: boolean;
 }
 
@@ -701,8 +695,6 @@ export interface GetLocationMultigroupQuery {
 	paginate?: boolean;
 	// The last key from the previous response for pagination
 	last_key?: string;
-	// Graphql query string
-	_query?: string;
 	nocache?: boolean;
 }
 
@@ -757,8 +749,6 @@ export interface GetLocationUserMultigroupPath {
 
 export interface GetLocationUserMultigroupQuery {
 	expanded?: boolean;
-	// Graphql query string
-	_query?: string;
 	nocache?: boolean;
 }
 
@@ -804,8 +794,6 @@ export interface GetLocationGroupQuery {
 	non_scan_go?: boolean;
 	// @deprecated
 	include_estimated_wait_time?: boolean;
-	// Graphql query string
-	_query?: string;
 	nocache?: boolean;
 }
 
@@ -856,16 +844,10 @@ export interface GetLocationGroupAppThemePath {
 	id: string;
 }
 
-export interface GetLocationGroupAppThemeQuery {
-	// Graphql query string
-	_query?: string;
-}
-
 export type GetLocationGroupAppThemeResponse = AppTheme;
 
 export interface GetLocationGroupAppThemeRequest
 	extends BaseRequest,
-		RequestQuery<GetLocationGroupAppThemeQuery>,
 		GetLocationGroupAppThemePath {}
 
 // POST /location/group/batch-get - Get multiple location groups by their IDs
@@ -888,8 +870,6 @@ export interface GetLocationGroupWaittimesPath {
 }
 
 export interface GetLocationGroupWaittimesQuery {
-	// Graphql query string
-	_query?: string;
 	nocache?: boolean;
 }
 
@@ -912,8 +892,6 @@ export interface GetLocationGroupDeliverydestinationsQuery {
 	name?: string;
 	// Only return in-use delivery destinations
 	active?: boolean;
-	// Graphql query string
-	_query?: string;
 }
 
 export interface GetLocationGroupDeliverydestinationsResponse {
@@ -996,8 +974,6 @@ export interface GetLocationGroupDeliverydestinationPath {
 export interface GetLocationGroupDeliverydestinationQuery {
 	// Return only in-use destinations
 	active?: boolean;
-	// Graphql query string
-	_query?: string;
 }
 
 export type GetLocationGroupDeliverydestinationResponse = DeliveryDestination;
@@ -1019,8 +995,6 @@ export interface GetLocationBrandTimeslotsQuery {
 	date?: number;
 	// Limit the number of timeslots returned
 	limit?: number;
-	// Graphql query string
-	_query?: string;
 }
 
 export type GetLocationBrandTimeslotsResponse = TimeSlots;
@@ -1082,8 +1056,6 @@ export interface GetLocationBrandMenuTimeslotsQuery {
 	date?: number;
 	// Limit the number of timeslots returned
 	limit?: number;
-	// Graphql query string
-	_query?: string;
 }
 
 export type GetLocationBrandMenuTimeslotsResponse = TimeSlots;
@@ -1105,8 +1077,6 @@ export interface GetLocationBrandDeliveryTimeslotsQuery {
 	date?: number;
 	// Limit the number of timeslots returned
 	limit?: number;
-	// Graphql query string
-	_query?: string;
 }
 
 export type GetLocationBrandDeliveryTimeslotsResponse = TimeSlots;
@@ -1130,8 +1100,6 @@ export interface GetLocationBrandMenuDeliveryTimeslostsQuery {
 	date?: number;
 	// Limit the number of timeslots returned
 	limit?: number;
-	// Graphql query string
-	_query?: string;
 }
 
 export type GetLocationBrandMenuDeliveryTimeslostsResponse = TimeSlots;
@@ -1264,8 +1232,6 @@ export interface PutLocationBrandRequest extends BaseRequest, PutLocationBrandPa
 // GET /location/sector - Get list of all the sectors
 
 export interface GetLocationSectorsQuery {
-	// Graphql query string
-	_query?: string;
 	nocache?: boolean;
 }
 
@@ -1295,8 +1261,6 @@ export interface GetLocationSectorPath {
 export interface GetLocationSectorQuery {
 	// Omits nested children of a sector if false
 	expanded?: boolean;
-	// Graphql query string
-	_query?: string;
 	nocache?: boolean;
 }
 
@@ -1358,8 +1322,6 @@ export interface GetLocationCompanyPath {
 
 export interface GetLocationCompanyQuery {
 	expanded?: boolean;
-	// Graphql query string
-	_query?: string;
 }
 
 export type GetLocationCompanyResponse = Company;
@@ -1424,8 +1386,6 @@ export interface GetLocationV2GroupsQuery {
 	include_hidden?: boolean;
 	// Include deleted brands in expanded query
 	include_deleted?: boolean;
-	// Graphql query string
-	_query?: string;
 }
 
 export interface GetLocationV2GroupsResponse {
@@ -1453,16 +1413,10 @@ export interface GetLocationMenuAssociationBrandPath {
 	id: string;
 }
 
-export interface GetLocationMenuAssociationBrandQuery {
-	// Graphql query string
-	_query?: string;
-}
-
 export type GetLocationMenuAssociationBrandResponse = MenuAssociations;
 
 export interface GetLocationMenuAssociationBrandRequest
 	extends BaseRequest,
-		RequestQuery<GetLocationMenuAssociationBrandQuery>,
 		GetLocationMenuAssociationBrandPath {}
 
 // GET /location/menu_association/{id}/menu - Get menu association for a brand

package/src/interface/mealplan.ts

@@ -135,8 +135,6 @@ export interface GetMealplanPath {
 export interface GetMealplanQuery {
 	// Retrieve all tenders from the get_mealplan call. Defaults to false
 	all_tenders?: boolean;
-	// Graphql query string
-	_query?: string;
 }
 
 export type GetMealplanResponse = TendersAndAuth;
@@ -204,17 +202,9 @@ export interface GetMealplanTenderPath {
 	tender: string;
 }
 
-export interface GetMealplanTenderQuery {
-	// Graphql query string
-	_query?: string;
-}
-
 export type GetMealplanTenderResponse = Tender;
 
-export interface GetMealplanTenderRequest
-	extends BaseRequest,
-		RequestQuery<GetMealplanTenderQuery>,
-		GetMealplanTenderPath {}
+export interface GetMealplanTenderRequest extends BaseRequest, GetMealplanTenderPath {}
 
 // DELETE /mealplan/{id}/tender/{tender} - Debit an amount from the tender balance
 
@@ -391,18 +381,11 @@ export interface PostMealplanInternalDebitRequest
 
 // GET /mealplan/institutions - Get list of institutions
 
-export interface GetMealplanInstitutionsQuery {
-	// Graphql query string
-	_query?: string;
-}
-
 export interface GetMealplanInstitutionsResponse {
 	institutions?: EAccountInstitutionListResponse;
 }
 
-export interface GetMealplanInstitutionsRequest
-	extends BaseRequest,
-		RequestQuery<GetMealplanInstitutionsQuery> {}
+export interface GetMealplanInstitutionsRequest extends BaseRequest {}
 
 // POST /mealplan/{id}/internal/refund - Refund an amount to the tender balance