@compassdigital/sdk.typescript 4.107.0 → 4.109.0

package/src/interface/consumer.ts

@@ -762,6 +762,27 @@ export interface PostReviewOrderItemsResponseDTO {
 	reviews: OrderItemReview[];
 }
 
+export interface HomePageRequest {
+	// site id
+	siteId: string;
+	// start date as a long
+	start: number;
+	// end date as a long
+	end: number;
+	// current date as a long
+	date: number;
+}
+
+export interface HomePageResponse {
+	// valid diverse greeting messages
+	greetingMessage: Record<string, any>[];
+	// valid hero images
+	heroImages: Record<string, any>[];
+	orders: Record<string, any>[][];
+	// location object for the site
+	location: Record<string, any>;
+}
+
 // GET /consumer/v1/health-check
 
 export interface HealthCheckControllerExecuteQuery {
@@ -824,3 +845,13 @@ export type PostReviewOrderItemsResponse = PostReviewOrderItemsResponseDTO;
 export interface PostReviewOrderItemsRequest extends BaseRequest {
 	body: PostReviewOrderItemsBody;
 }
+
+// POST /consumer/home - Provide the front end all the data required to render the home page
+
+export type PostHomePageBody = HomePageRequest;
+
+export type PostHomePageResponse = HomePageResponse;
+
+export interface PostHomePageRequest extends BaseRequest {
+	body: PostHomePageBody;
+}

package/src/interface/discount.ts

@@ -37,11 +37,12 @@ export interface DiscountMeta {
 }
 
 export interface GetDiscountResponseDTO {
+	// discount id
+	id: string;
 	// user id of discount creator
 	createdBy: string;
 	// user id of most recent update
 	updatedBy: string;
-	id: string;
 	createdAt: string;
 	updatedAt: string;
 	name: string;
@@ -50,6 +51,12 @@ export interface GetDiscountResponseDTO {
 	meta?: DiscountMeta;
 }
 
+export interface BadRequestErrorDTO {
+	message: string;
+	code: number;
+	data: Record<string, any>;
+}
+
 export interface UnauthorizedErrorDTO {
 	message: string;
 	code: number;
@@ -62,12 +69,15 @@ export interface NotFoundErrorDTO {
 	data: Record<string, any>;
 }
 
+export type InternalServerErrorException = Record<string, any>;
+
 export interface DiscountDTO {
+	// discount id
+	id: string;
 	// user id of discount creator
 	createdBy: string;
 	// user id of most recent update
 	updatedBy: string;
-	id: string;
 	createdAt: string;
 	updatedAt: string;
 	name: string;
@@ -80,30 +90,38 @@ export interface GetDiscountsResponseDTO {
 	discounts: DiscountDTO[];
 }
 
-export interface BadRequestErrorDTO {
-	message: string;
-	code: number;
-	data: Record<string, any>;
+export interface DiscountTaxonomy {
+	site?: string[];
+	brand?: string[];
 }
 
 export interface PostDiscountRequestDTO {
 	createdBy: string;
+	updatedBy?: string;
 	name: string;
+	status?: DiscountStatus;
+	is?: DiscountIs;
+	meta?: DiscountMeta;
+	taxonomy?: DiscountTaxonomy;
 }
 
 export interface PostDiscountResponseDTO {
-	createdBy: string;
-	name: string;
 	id: string;
 	createdAt: string;
 	updatedAt: string;
 	updatedBy: string;
+	name: string;
+	status?: DiscountStatus;
+	is?: DiscountIs;
+	meta?: DiscountMeta;
+	taxonomy?: DiscountTaxonomy;
+	createdBy: string;
 }
 
 export interface PutDiscountRequestDTO {
 	// user id of most recent update
 	updatedBy: string;
-	taxonomy?: Record<string, any>;
+	taxonomy?: DiscountTaxonomy;
 	name: string;
 	status?: DiscountStatus;
 	is?: DiscountIs;
@@ -111,11 +129,12 @@ export interface PutDiscountRequestDTO {
 }
 
 export interface PutDiscountResponseDTO {
+	// discount id
+	id: string;
 	// user id of discount creator
 	createdBy: string;
 	// user id of most recent update
 	updatedBy: string;
-	id: string;
 	createdAt: string;
 	updatedAt: string;
 	name: string;
@@ -124,24 +143,18 @@ export interface PutDiscountResponseDTO {
 	meta?: DiscountMeta;
 }
 
-export type InternalServerErrorException = Record<string, any>;
-
 export interface PutDiscountPublishRequestDTO {
 	// user id of most recent update
 	updatedBy: string;
-	taxonomy?: Record<string, any>;
-	name: string;
-	status?: DiscountStatus;
-	is?: DiscountIs;
-	meta?: DiscountMeta;
 }
 
 export interface PutDiscountPublishResponseDTO {
+	// discount id
+	id: string;
 	// user id of discount creator
 	createdBy: string;
 	// user id of most recent update
 	updatedBy: string;
-	id: string;
 	createdAt: string;
 	updatedAt: string;
 	name: string;
@@ -157,6 +170,7 @@ export interface DeleteDiscountResponseDTO {
 // GET /discount/{id} - Get a discount
 
 export interface GetDiscountPath {
+	// a discount id
 	id: string;
 }
 
@@ -202,7 +216,6 @@ export interface DeleteDiscountRequest extends BaseRequest, DeleteDiscountPath {
 
 export interface GetDiscountsQuery {
 	taxonomyFilter: string;
-	active: boolean;
 	// Graphql query string
 	_query?: string;
 }

package/src/interface/mealplan.ts

@@ -257,6 +257,7 @@ export interface PatchMealplanTenderBody {
 	// Amount for order paid by user
 	transaction_amount?: number;
 	terminal_id?: string;
+	card_data?: string;
 }
 
 export type PatchMealplanTenderResponse = Tender;

package/src/interface/menu.ts

@@ -723,6 +723,7 @@ export interface DraftItemToModifierGroupRelationshipDTO {
 	brand?: DraftBrandDTO;
 	changes?: ItemToModifierGroupRelationshipChangeDTO[];
 	vendor_metadata?: VendorMetadataDTO[];
+	is_global?: boolean;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }
@@ -768,6 +769,7 @@ export interface DraftModifierGroupToModifierRelationshipDTO {
 	brand?: DraftBrandDTO;
 	changes?: ModifierGroupToModifierRelationshipChangeDTO[];
 	vendor_metadata?: VendorMetadataDTO[];
+	is_global?: boolean;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }
@@ -829,7 +831,7 @@ export interface ReportingMetadataDTO {
 }
 
 export interface ReportingCategoryMetadataDTO {
-	primary?: 'Food' | 'Beverage' | 'Sundry' | 'Alcohol' | 'Snack';
+	primary?: 'Alcohol' | 'Beverage' | 'Food' | 'Gift Cards' | 'Snack' | 'Sundry';
 	secondary?: string;
 	[index: string]: any;
 }
@@ -1162,6 +1164,7 @@ export interface PublishedItemToModifierGroupRelationshipDTO {
 	item_id?: string;
 	brand_id?: string;
 	sequence?: number;
+	is_global?: boolean;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }
@@ -1191,6 +1194,7 @@ export interface PublishedModifierGroupToModifierRelationshipDTO {
 	modifier_group_id?: string;
 	brand_id?: string;
 	sequence?: number;
+	is_global?: boolean;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }
@@ -5573,6 +5577,7 @@ export interface PostMenuV3DraftItemRelationshipsModifierGroupBody {
 	brand?: DraftBrandDTO;
 	changes?: ItemToModifierGroupRelationshipChangeDTO[];
 	vendor_metadata?: VendorMetadataDTO[];
+	is_global?: boolean;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }
@@ -5629,6 +5634,7 @@ export interface PatchMenuV3DraftItemRelationshipsModifierGroupBody {
 	brand?: DraftBrandDTO;
 	changes?: ItemToModifierGroupRelationshipChangeDTO[];
 	vendor_metadata?: VendorMetadataDTO[];
+	is_global?: boolean;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }
@@ -5707,6 +5713,7 @@ export type PostMenuV3DraftItemRelationshipsModifierGroupsBody = {
 	brand?: DraftBrandDTO;
 	changes?: ItemToModifierGroupRelationshipChangeDTO[];
 	vendor_metadata?: VendorMetadataDTO[];
+	is_global?: boolean;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }[];
@@ -6208,6 +6215,7 @@ export interface PostMenuV3DraftModifierGroupRelationshipsModifierBody {
 	brand?: DraftBrandDTO;
 	changes?: ModifierGroupToModifierRelationshipChangeDTO[];
 	vendor_metadata?: VendorMetadataDTO[];
+	is_global?: boolean;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }
@@ -6264,6 +6272,7 @@ export interface PatchMenuV3DraftModifierGroupRelationshipsModifierBody {
 	brand?: DraftBrandDTO;
 	changes?: ModifierGroupToModifierRelationshipChangeDTO[];
 	vendor_metadata?: VendorMetadataDTO[];
+	is_global?: boolean;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }
@@ -6342,6 +6351,7 @@ export type PostMenuV3DraftModifierGroupRelationshipsModifiersBody = {
 	brand?: DraftBrandDTO;
 	changes?: ModifierGroupToModifierRelationshipChangeDTO[];
 	vendor_metadata?: VendorMetadataDTO[];
+	is_global?: boolean;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }[];
@@ -7037,7 +7047,7 @@ export interface PostMenuV3GlobalDiffRecoverRequest
 
 export interface GetMenuV3MenuworksQuery {
 	unit_id?: string;
-	MRN?: number;
+	MRN?: string;
 	// Graphql query string
 	_query?: string;
 }
@@ -7048,6 +7058,7 @@ export interface GetMenuV3MenuworksResponse {
 	name?: string;
 	short_name?: string;
 	description?: string;
+	portion_size: string;
 	MRN?: string;
 	portion_quantity?: number;
 	portion_unit_name?: string;
@@ -9280,6 +9291,7 @@ export type PostMenuV4ModifierGroupAttachModifiersBody = {
 	brand?: DraftBrandDTO;
 	changes?: ModifierGroupToModifierRelationshipChangeDTO[];
 	vendor_metadata?: VendorMetadataDTO[];
+	is_global?: boolean;
 	permissions?: Record<string, any>;
 	[index: string]: any;
 }[];
@@ -9571,6 +9583,7 @@ export interface PostMenuV4ScheduleMenuRequest extends BaseRequest {
 
 export interface PostMenuV4UnscheduleMenuBody {
 	menu_id: string;
+	station_id: string;
 	[index: string]: any;
 }
 

package/src/interface/promo.ts

@@ -149,6 +149,24 @@ export interface PromoValidateRequest {
 	};
 }
 
+export interface PromoVouchersValidateRequest {
+	codes?: string[];
+	email?: string;
+	app?: string;
+	realm?: string;
+	location_brand?: string;
+	shoppingcart?: {
+		id?: string;
+		date_created?: string;
+		items?: ItemResponse[];
+	};
+	totals?: {
+		amount?: number;
+		discount?: number;
+		currency?: string;
+	};
+}
+
 export interface PromoRedeemRequest {
 	code?: string;
 	email?: string;
@@ -169,6 +187,26 @@ export interface PromoRedeemRequest {
 	payment_request_id?: string;
 }
 
+export interface PromoRedeemVouchersRequest {
+	codes?: string[];
+	email?: string;
+	app?: string;
+	realm?: string;
+	location_brand?: string;
+	shoppingcart?: {
+		id?: string;
+		date_created?: string;
+		items?: ItemResponse[];
+	};
+	totals?: {
+		amount?: number;
+		discount?: number;
+		currency?: string;
+	};
+	provider_data?: FPValidationData;
+	payment_request_id?: string;
+}
+
 export interface CreateVoucher {
 	code?: string;
 	discount?: {
@@ -190,6 +228,19 @@ export interface Voucher {
 	discount?: AppliedDiscount;
 	app?: string;
 	provider_data?: FPValidationData;
+	redeemables?: Redeemable[];
+	[index: string]: any;
+}
+
+export interface Redeemable {
+	status?: string;
+	// redeemable
+	id?: string;
+	object?: string;
+	result?: {
+		discount?: AppliedDiscount;
+		[index: string]: any;
+	};
 	[index: string]: any;
 }
 
@@ -510,6 +561,16 @@ export interface PostPromoValidateVoucherRequest extends BaseRequest {
 	body: PostPromoValidateVoucherBody;
 }
 
+// POST /promo/validate/vouchers - Validate multiple promo vouchers
+
+export type PostPromoValidateVouchersBody = PromoVouchersValidateRequest;
+
+export type PostPromoValidateVouchersResponse = Voucher;
+
+export interface PostPromoValidateVouchersRequest extends BaseRequest {
+	body: PostPromoValidateVouchersBody;
+}
+
 // POST /promo/redeem/voucher - Redeem a promo voucher
 
 export type PostPromoRedeemVoucherBody = PromoRedeemRequest;
@@ -520,6 +581,18 @@ export interface PostPromoRedeemVoucherRequest extends BaseRequest {
 	body: PostPromoRedeemVoucherBody;
 }
 
+// POST /promo/redeem/vouchers - Redeem multiple promo vouchers
+
+export type PostPromoRedeemVouchersBody = PromoRedeemVouchersRequest;
+
+export interface PostPromoRedeemVouchersResponse {
+	redemptions?: Redemption[];
+}
+
+export interface PostPromoRedeemVouchersRequest extends BaseRequest {
+	body: PostPromoRedeemVouchersBody;
+}
+
 // POST /promo/voucher - Create new voucher
 
 export type PostPromoVoucherBody = CreateVoucher;

package/src/interface/search.ts

@@ -6,8 +6,8 @@ import { RequestQuery, BaseRequest } from './util';
 export interface MetaResultsDto {
 	limit: number;
 	page: number;
-	sortBy?: Record<string, any>;
-	sortOrder?: Record<string, any>;
+	sortBy?: string;
+	sortOrder?: string;
 	totalResults: number;
 	totalPages: number;
 	resultsCount: number;
@@ -84,6 +84,12 @@ export interface GetOrderPaginatedResult {
 	results: GetOrderDto[];
 }
 
+export interface UnauthorizedErrorDTO {
+	message: string;
+	code: number;
+	data: Record<string, any>;
+}
+
 export interface GetLocationDto {
 	source_id: string;
 	source_type: string;

package/src/interface/user.ts

@@ -322,6 +322,11 @@ export interface UserMeta {
 	[index: string]: any;
 }
 
+export interface Pagination {
+	last_key?: string;
+	count?: number;
+}
+
 // GET /user/auth - Gets the JWT token for a user
 
 export interface GetUserAuthQuery {
@@ -645,17 +650,24 @@ export interface GetUserRealmUsersPath {
 }
 
 export interface GetUserRealmUsersQuery {
-	// Max number of records to return. Defaults to 100
+	// Max number of records to return. Defaults to 100. Max 10,000.
 	max?: number;
 	// Last modified date greater than this parameter
 	lastmodified_start?: string;
 	// Use ACL permission system
 	acl?: boolean;
+	// If true, the response will include pagination metadata
+	paginate?: boolean;
+	// The last key from the previous response for pagination
+	last_key?: string;
 	// Graphql query string
 	_query?: string;
 }
 
-export type GetUserRealmUsersResponse = Users;
+export interface GetUserRealmUsersResponse {
+	users?: User[];
+	meta?: Pagination;
+}
 
 export interface GetUserRealmUsersRequest
 	extends BaseRequest,