@compassdigital/sdk.typescript 4.108.0 → 4.109.0

package/src/interface/centricos.ts

@@ -50,6 +50,8 @@ export interface OrdersExportResponse {
 	fileName: string;
 }
 
+export type CompassLongID = Record<string, any>;
+
 export interface DayPart {
 	label: string;
 	start: string;
@@ -107,6 +109,28 @@ export interface GetSitesResponse {
 	results: Site[];
 }
 
+export interface PriceLevelStation {
+	id: string;
+	name: string;
+}
+
+export interface PriceLevelBusinessUnit {
+	id: string;
+	name: string;
+	unit_number: number;
+	stations: PriceLevelStation[];
+}
+
+export interface PriceLevelSite {
+	id: string;
+	name: string;
+	business_units: PriceLevelBusinessUnit[];
+}
+
+export interface GetPriceLevelSitesResponse {
+	sites: PriceLevelSite[];
+}
+
 export interface ReviewOrderItem {
 	// Order id
 	id: string;
@@ -190,76 +214,107 @@ export interface GetStationResponse {
 	closure_schedules: ClosureSchedule[];
 }
 
-export interface VoucherifyDiscountDTO {
+export interface DiscountRequestDTO {
+	// name of the discount
+	name: string;
+	// status of the discount
+	status?: Record<string, any>;
+	// user is of discount creator
+	createdBy?: string;
+	// last user who updated the discount
+	updatedBy?: string;
+	// creation timestamp
+	createdAt?: string;
+	// last update timestamp
+	updatedAt?: string;
+	// Voucherify metadata
+	meta?: Record<string, any>;
 	id?: string;
-	type?: string;
-	amountOff?: number;
-	percentOff?: number;
-}
-
-export interface VoucherifyMetaDataDTO {
-	code?: string;
-	discount?: VoucherifyDiscountDTO;
+	is?: Record<string, any>;
 }
 
-export interface DiscountStatus {
-	live?: boolean;
-	scheduled?: boolean;
-	archived?: boolean;
-}
-
-export interface DiscountIs {
-	badgepayPromo?: boolean;
-	mealplanPromo?: boolean;
-	decliningBalancePromo?: boolean;
-	voucherPromo?: boolean;
-}
-
-export interface DiscountRequestDTO {
-	meta?: {
-		[index: string]: any;
-	} & VoucherifyMetaDataDTO;
-	id?: string;
-	createdBy?: string;
-	name?: string;
-	status?: DiscountStatus;
-	is?: DiscountIs;
-	app?: string;
+export interface SiteDTO {
+	// The ID of the site
+	id: string;
+	// The name of the site
+	name: string;
 }
 
 export interface PutDiscountVoucherifyRequestDTO {
 	discount: DiscountRequestDTO;
-	sites?: string[];
+	sites?: SiteDTO[];
 }
 
 export interface DiscountResponseDTO {
 	// user is of discount creator
 	createdBy: string;
-	meta?: {
-		[index: string]: any;
-	} & VoucherifyMetaDataDTO;
+	// last user who updated the discount
+	updatedBy: string;
+	// name of the discount
+	name: string;
+	// status of the discount
+	status?: Record<string, any>;
+	// Voucherify metadata
+	meta?: Record<string, any>;
 	id: string;
 	createdAt: string;
 	updatedAt: string;
-	name?: string;
-	status?: DiscountStatus;
-	is?: DiscountIs;
-	app?: string;
+	is?: Record<string, any>;
 }
 
 export interface PutDiscountVoucherifyResponseDTO {
 	discount: DiscountResponseDTO;
-	sites?: string[];
+	sites?: SiteDTO[];
 }
 
-export interface PutDiscountVoucherifyPublishRequestDTO {
-	discount: DiscountRequestDTO;
-	sites?: string[];
-}
+export type DiscountValidationError = Record<string, any>;
+
+export type DiscountCreateError = Record<string, any>;
 
 export interface PutDiscountVoucherifyPublishResponseDTO {
-	discount: DiscountResponseDTO;
-	sites?: string[];
+	// user is of discount creator
+	createdBy: string;
+	// last user who updated the discount
+	updatedBy: string;
+	// name of the discount
+	name: string;
+	// status of the discount
+	status?: Record<string, any>;
+	// Voucherify metadata
+	meta?: Record<string, any>;
+	// List of sites where discount is published
+	sites?: SiteDTO[];
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+	is?: Record<string, any>;
+}
+
+export type DiscountPublishError = Record<string, any>;
+
+export interface DeleteDiscountsVoucherifyResponseDTO {
+	success: boolean;
+}
+
+export type DiscountDeleteError = Record<string, any>;
+
+export interface DiscountDTO {
+	// user is of discount creator
+	createdBy: string;
+	// last user who updated the discount
+	updatedBy: string;
+	// name of the discount
+	name: string;
+	// status of the discount
+	status?: Record<string, any>;
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+	is?: Record<string, any>;
+}
+
+export interface GetDiscountResponseDTO {
+	discount: DiscountDTO;
 }
 
 // POST /centricos/ai/item/description - Generate item description
@@ -338,7 +393,7 @@ export interface PostCentricosOrdersExportRequest
 // GET /centricos/report/group/{location_group}/config - Get report configuration for a location group. Times are in site's local timezone.
 
 export interface GetCentricosReportGroupConfigPath {
-	// TODO: add parameter to swagger.json
+	// TODO: cannot use CompassLongID as path parameter
 	location_group: string;
 }
 
@@ -357,7 +412,7 @@ export interface GetCentricosReportGroupConfigRequest
 // PUT /centricos/report/group/{location_group}/config - Update report configuration for a location group. Times are in site's local timezone.
 
 export interface PutCentricosReportGroupConfigPath {
-	// TODO: add parameter to swagger.json
+	// TODO: cannot use CompassLongID as path parameter
 	location_group: string;
 }
 
@@ -374,7 +429,7 @@ export interface PutCentricosReportGroupConfigRequest
 // DELETE /centricos/report/group/{location_group}/config - Delete report configuration for a location group. Times are in site's local timezone.
 
 export interface DeleteCentricosReportGroupConfigPath {
-	// TODO: add parameter to swagger.json
+	// TODO: cannot use CompassLongID as path parameter
 	location_group: string;
 }
 
@@ -387,7 +442,7 @@ export interface DeleteCentricosReportGroupConfigRequest
 // GET /centricos/report/group/{location_group}/config/default - Get default report configuration. Times are in site's local timezone.
 
 export interface GetCentricosReportConfigDefaultPath {
-	// TODO: add parameter to swagger.json
+	// TODO: cannot use CompassLongID as path parameter
 	location_group: string;
 }
 
@@ -455,6 +510,26 @@ export interface GetCentricosSitesRequest
 	extends BaseRequest,
 		RequestQuery<GetCentricosSitesQuery> {}
 
+// GET /centricos/sites/price-level/{price_level} - This returns specific properties from sites, locations, and stations connected to a menu price level. This does not support pagination, filtering, sorting, or searching.
+
+export interface GetSitesFromPriceLevelPath {
+	// TODO: cannot use CompassLongID as path parameter
+	price_level: string;
+}
+
+export interface GetSitesFromPriceLevelQuery {
+	local_menu_group?: string;
+	// Graphql query string
+	_query?: string;
+}
+
+export type GetSitesFromPriceLevelResponse = GetPriceLevelSitesResponse;
+
+export interface GetSitesFromPriceLevelRequest
+	extends BaseRequest,
+		RequestQuery<GetSitesFromPriceLevelQuery>,
+		GetSitesFromPriceLevelPath {}
+
 // GET /centricos/review/{orderId}/order-items - Get reviews for items in a given order in an array format
 
 export interface GetReviewOrderItemsPath {
@@ -476,7 +551,7 @@ export interface GetReviewOrderItemsRequest
 // GET /centricos/station/{station_id} - Get station details
 
 export interface GetCentricosStationPath {
-	// TODO: add parameter to swagger.json
+	// TODO: cannot use CompassLongID as path parameter
 	station_id: string;
 }
 
@@ -494,27 +569,55 @@ export interface GetCentricosStationRequest
 
 // PUT /centricos/discount/voucherify - Add or Update a voucherify discount and assign it to multiple sites
 
-export type PutDiscountVoucherifyBody = PutDiscountVoucherifyRequestDTO;
+export type PutCentricosDiscountVoucherifyBody = PutDiscountVoucherifyRequestDTO;
 
-export type PutDiscountVoucherifyResponse = PutDiscountVoucherifyResponseDTO;
+export type PutCentricosDiscountVoucherifyResponse = PutDiscountVoucherifyResponseDTO;
 
-export interface PutDiscountVoucherifyRequest extends BaseRequest {
-	body: PutDiscountVoucherifyBody;
+export interface PutCentricosDiscountVoucherifyRequest extends BaseRequest {
+	body: PutCentricosDiscountVoucherifyBody;
 }
 
 // PUT /centricos/discount/{id}/voucherify/publish - Update and publish a voucherify discount and assign it to multiple sites
 
-export interface PutDiscountVoucherifyPublishPath {
+export interface PutCentricosDiscountVoucherifyPublishPath {
 	// Discount ID
 	id: string;
 }
 
-export type PutDiscountVoucherifyPublishBody = PutDiscountVoucherifyPublishRequestDTO;
+export type PutCentricosDiscountVoucherifyPublishResponse = PutDiscountVoucherifyPublishResponseDTO;
+
+export interface PutCentricosDiscountVoucherifyPublishRequest
+	extends BaseRequest,
+		PutCentricosDiscountVoucherifyPublishPath {}
+
+// DELETE /centricos/discount/{id}/voucherify - Delete a discount from voucherify and all of its entity associations
+
+export interface DeleteCentricosDiscountsVoucherifyPath {
+	// Discount ID
+	id: string;
+}
 
-export type PutDiscountVoucherifyPublishResponse = PutDiscountVoucherifyPublishResponseDTO;
+export type DeleteCentricosDiscountsVoucherifyResponse = DeleteDiscountsVoucherifyResponseDTO;
 
-export interface PutDiscountVoucherifyPublishRequest
+export interface DeleteCentricosDiscountsVoucherifyRequest
 	extends BaseRequest,
-		PutDiscountVoucherifyPublishPath {
-	body: PutDiscountVoucherifyPublishBody;
+		DeleteCentricosDiscountsVoucherifyPath {}
+
+// GET /centricos/discount/{id} - Get discount information by ID
+
+export interface GetCentricosDiscountPath {
+	// ID of the discount to retrieve
+	id: string;
+}
+
+export interface GetCentricosDiscountQuery {
+	// Graphql query string
+	_query?: string;
 }
+
+export type GetCentricosDiscountResponse = GetDiscountResponseDTO;
+
+export interface GetCentricosDiscountRequest
+	extends BaseRequest,
+		RequestQuery<GetCentricosDiscountQuery>,
+		GetCentricosDiscountPath {}

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,19 +143,18 @@ export interface PutDiscountResponseDTO {
 	meta?: DiscountMeta;
 }
 
-export type InternalServerErrorException = Record<string, any>;
-
 export interface PutDiscountPublishRequestDTO {
 	// user id of most recent update
 	updatedBy: string;
 }
 
 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;
@@ -152,6 +170,7 @@ export interface DeleteDiscountResponseDTO {
 // GET /discount/{id} - Get a discount
 
 export interface GetDiscountPath {
+	// a discount id
 	id: string;
 }
 
@@ -197,7 +216,6 @@ export interface DeleteDiscountRequest extends BaseRequest, DeleteDiscountPath {
 
 export interface GetDiscountsQuery {
 	taxonomyFilter: string;
-	active: boolean;
 	// Graphql query string
 	_query?: string;
 }

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;
 }[];

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;