@compassdigital/sdk.typescript 4.108.0 → 4.110.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,41 +214,33 @@ export interface GetStationResponse {
 	closure_schedules: ClosureSchedule[];
 }
 
-export interface VoucherifyDiscountDTO {
-	id?: string;
-	type?: string;
+export interface CentricVoucherifyMetaData {
+	// The type of the voucherify discount
+	type: string;
+	// The numeric value of discount for amount off
 	amountOff?: number;
+	// The percentage value of discount for percent off
 	percentOff?: number;
 }
 
-export interface VoucherifyMetaDataDTO {
-	code?: string;
-	discount?: VoucherifyDiscountDTO;
-}
-
-export interface DiscountStatus {
-	live?: boolean;
-	scheduled?: boolean;
-	archived?: boolean;
-}
-
-export interface DiscountIs {
-	badgepayPromo?: boolean;
-	mealplanPromo?: boolean;
-	decliningBalancePromo?: boolean;
-	voucherPromo?: boolean;
-}
-
 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;
 	meta?: {
 		[index: string]: any;
-	} & VoucherifyMetaDataDTO;
+	} & CentricVoucherifyMetaData;
 	id?: string;
-	createdBy?: string;
-	name?: string;
-	status?: DiscountStatus;
-	is?: DiscountIs;
-	app?: string;
+	is?: Record<string, any>;
 }
 
 export interface PutDiscountVoucherifyRequestDTO {
@@ -235,16 +251,19 @@ export interface PutDiscountVoucherifyRequestDTO {
 export interface DiscountResponseDTO {
 	// 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>;
 	meta?: {
 		[index: string]: any;
-	} & VoucherifyMetaDataDTO;
+	} & CentricVoucherifyMetaData;
 	id: string;
 	createdAt: string;
 	updatedAt: string;
-	name?: string;
-	status?: DiscountStatus;
-	is?: DiscountIs;
-	app?: string;
+	is?: Record<string, any>;
 }
 
 export interface PutDiscountVoucherifyResponseDTO {
@@ -252,14 +271,62 @@ export interface PutDiscountVoucherifyResponseDTO {
 	sites?: string[];
 }
 
-export interface PutDiscountVoucherifyPublishRequestDTO {
-	discount: DiscountRequestDTO;
-	sites?: string[];
+export type DiscountValidationError = Record<string, any>;
+
+export type DiscountCreateError = Record<string, any>;
+
+export interface SiteDTO {
+	// The ID of the site
+	id: string;
+	// The name of the site
+	name: string;
 }
 
 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>;
+	meta?: {
+		[index: string]: any;
+	} & CentricVoucherifyMetaData;
+	// 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
@@ -268,20 +335,12 @@ export type PostCentricosAiItemDescriptionBody = AIItemDescriptionRequest;
 
 export type PostCentricosAiItemDescriptionResponse = AIItemDescriptionResponse;
 
-export interface PostCentricosAiItemDescriptionRequest extends BaseRequest {
-	body: PostCentricosAiItemDescriptionBody;
-}
-
 // POST /centricos/ai/item/image - Generate item image
 
 export type PostCentricosAiItemImageBody = AIItemImageRequest;
 
 export type PostCentricosAiItemImageResponse = AIItemImageResponse;
 
-export interface PostCentricosAiItemImageRequest extends BaseRequest {
-	body: PostCentricosAiItemImageBody;
-}
-
 // GET /centricos/orders/export - Get orders in csv format
 
 export interface PostCentricosOrdersExportQuery {
@@ -331,14 +390,10 @@ export interface PostCentricosOrdersExportQuery {
 
 export type PostCentricosOrdersExportResponse = OrdersExportResponse;
 
-export interface PostCentricosOrdersExportRequest
-	extends BaseRequest,
-		RequestQuery<PostCentricosOrdersExportQuery> {}
-
 // 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;
 }
 
@@ -349,15 +404,10 @@ export interface GetCentricosReportGroupConfigQuery {
 
 export type GetCentricosReportGroupConfigResponse = ReportGroupConfigResponse;
 
-export interface GetCentricosReportGroupConfigRequest
-	extends BaseRequest,
-		RequestQuery<GetCentricosReportGroupConfigQuery>,
-		GetCentricosReportGroupConfigPath {}
-
 // 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;
 }
 
@@ -365,29 +415,19 @@ export type PutCentricosReportGroupConfigBody = ReportGroupConfigRequest;
 
 export type PutCentricosReportGroupConfigResponse = ReportGroupConfigResponse;
 
-export interface PutCentricosReportGroupConfigRequest
-	extends BaseRequest,
-		PutCentricosReportGroupConfigPath {
-	body: PutCentricosReportGroupConfigBody;
-}
-
 // 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;
 }
 
 export type DeleteCentricosReportGroupConfigResponse = ReportGroupConfigResponse;
 
-export interface DeleteCentricosReportGroupConfigRequest
-	extends BaseRequest,
-		DeleteCentricosReportGroupConfigPath {}
-
 // 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;
 }
 
@@ -398,11 +438,6 @@ export interface GetCentricosReportConfigDefaultQuery {
 
 export type GetCentricosReportConfigDefaultResponse = ReportGroupConfigResponse;
 
-export interface GetCentricosReportConfigDefaultRequest
-	extends BaseRequest,
-		RequestQuery<GetCentricosReportConfigDefaultQuery>,
-		GetCentricosReportConfigDefaultPath {}
-
 // GET /centricos/looker/embedurl - Get a signed URL for looker embeding
 
 export interface GetCentricosLookerEmbedurlQuery {
@@ -413,10 +448,6 @@ export interface GetCentricosLookerEmbedurlQuery {
 
 export type GetCentricosLookerEmbedurlResponse = LookerEmbedURLResponse;
 
-export interface GetCentricosLookerEmbedurlRequest
-	extends BaseRequest,
-		RequestQuery<GetCentricosLookerEmbedurlQuery> {}
-
 // GET /centricos/devices/{site_id} - Get site devices
 
 export interface GetSiteDevicesPath {
@@ -431,11 +462,6 @@ export interface GetSiteDevicesQuery {
 
 export type GetSiteDevicesResponse = SiteDevicesResponse;
 
-export interface GetSiteDevicesRequest
-	extends BaseRequest,
-		RequestQuery<GetSiteDevicesQuery>,
-		GetSiteDevicesPath {}
-
 // GET /centricos/sites - Get a list of sites. This endpoint is paginated and supports filtering, sorting, and searching.
 
 export interface GetCentricosSitesQuery {
@@ -451,9 +477,20 @@ export interface GetCentricosSitesQuery {
 
 export type GetCentricosSitesResponse = GetSitesResponse;
 
-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;
 
 // GET /centricos/review/{orderId}/order-items - Get reviews for items in a given order in an array format
 
@@ -468,15 +505,10 @@ export interface GetReviewOrderItemsQuery {
 
 export type GetReviewOrderItemsResponse = ReviewOrderItemsResponseDTO;
 
-export interface GetReviewOrderItemsRequest
-	extends BaseRequest,
-		RequestQuery<GetReviewOrderItemsQuery>,
-		GetReviewOrderItemsPath {}
-
 // 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;
 }
 
@@ -487,34 +519,40 @@ export interface GetCentricosStationQuery {
 
 export type GetCentricosStationResponse = GetStationResponse;
 
-export interface GetCentricosStationRequest
-	extends BaseRequest,
-		RequestQuery<GetCentricosStationQuery>,
-		GetCentricosStationPath {}
-
 // 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;
+// PUT /centricos/discount/{id}/voucherify/publish - Update and publish a voucherify discount and assign it to multiple sites
+
+export interface PutCentricosDiscountVoucherifyPublishPath {
+	// Discount ID
+	id: string;
 }
 
-// PUT /centricos/discount/{id}/voucherify/publish - Update and publish a voucherify discount and assign it to multiple sites
+export type PutCentricosDiscountVoucherifyPublishResponse = PutDiscountVoucherifyPublishResponseDTO;
+
+// DELETE /centricos/discount/{id}/voucherify - Delete a discount from voucherify and all of its entity associations
 
-export interface PutDiscountVoucherifyPublishPath {
+export interface DeleteCentricosDiscountsVoucherifyPath {
 	// Discount ID
 	id: string;
 }
 
-export type PutDiscountVoucherifyPublishBody = PutDiscountVoucherifyPublishRequestDTO;
+export type DeleteCentricosDiscountsVoucherifyResponse = DeleteDiscountsVoucherifyResponseDTO;
 
-export type PutDiscountVoucherifyPublishResponse = PutDiscountVoucherifyPublishResponseDTO;
+// GET /centricos/discount/{id} - Get discount information by ID
 
-export interface PutDiscountVoucherifyPublishRequest
-	extends BaseRequest,
-		PutDiscountVoucherifyPublishPath {
-	body: PutDiscountVoucherifyPublishBody;
+export interface GetCentricosDiscountPath {
+	// ID of the discount to retrieve
+	id: string;
 }
+
+export interface GetCentricosDiscountQuery {
+	// Graphql query string
+	_query?: string;
+}
+
+export type GetCentricosDiscountResponse = GetDiscountResponseDTO;