@compassdigital/sdk.typescript 4.798.0 → 4.799.0

package/src/interface/centricos.ts

@@ -778,7 +778,7 @@ export interface CentricDiscountSchedule {
 	endTime: string;
 }
 
-export interface PutDiscountVoucherifyRequestDiscount {
+export interface PutCentricDiscountRequestDiscount {
 	// name of the discount
 	name: string;
 	// Discount method configuration
@@ -788,7 +788,7 @@ export interface PutDiscountVoucherifyRequestDiscount {
 	// item level config of the discount
 	itemLevelConfig?: CentricDiscountItemLevelConfig;
 	is?: CentricDiscountIs;
-	// Voucherify metadata
+	// discount metadata
 	meta?: CentricVoucherifyMetaDataDiscount;
 	// discount schedule
 	schedule?: CentricDiscountSchedule;
@@ -849,9 +849,9 @@ export interface DiscountBrand {
 	meta: DiscountBrandMeta;
 }
 
-export interface PutDiscountVoucherifyRequestDTO {
+export interface PutCentricDiscountRequestDTO {
 	// Discount to update
-	discount: PutDiscountVoucherifyRequestDiscount;
+	discount: PutCentricDiscountRequestDiscount;
 	// List of sites with metadata
 	sites?: DiscountSite[];
 	// List of brands with metadata
@@ -886,7 +886,7 @@ export interface DiscountResponseDTO {
 	type: 'Total Order' | 'Single Items' | 'Bundle';
 	// item level config of the discount
 	itemLevelConfig?: CentricDiscountItemLevelConfig;
-	// Voucherify metadata
+	// discount metadata
 	meta?: CentricVoucherifyMetaDataDiscount;
 	id: string;
 	createdAt: string;
@@ -895,7 +895,7 @@ export interface DiscountResponseDTO {
 	schedule?: Record<string, any>;
 }
 
-export interface PutDiscountVoucherifyResponseDTO {
+export interface PutCentricDiscountResponseDTO {
 	// Discount details
 	discount: DiscountResponseDTO;
 	// List of sites with metadata
@@ -919,6 +919,73 @@ export interface CentricDiscountMeta {
 	provider: CentricMetaProvider;
 }
 
+export interface PutCentricDiscountPublishResponseDTO {
+	// 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: CentricDiscountStatus;
+	// Discount method configuration
+	method: CentricDiscountMethod;
+	// channel config of the discount
+	channelConfig: CentricDiscountChannelConfig;
+	// type of the discount
+	type: 'Total Order' | 'Single Items' | 'Bundle';
+	// item level config of the discount
+	itemLevelConfig?: CentricDiscountItemLevelConfig;
+	// discount metadata
+	meta?: CentricDiscountMeta;
+	// List of sites where discount is published
+	sites?: CentricDiscountEntityBase[];
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+	is?: CentricDiscountIs;
+	schedule?: Record<string, any>;
+}
+
+export interface PutDiscountVoucherifyRequestDiscount {
+	// name of the discount
+	name: string;
+	// Discount method configuration
+	method: CentricDiscountMethod;
+	// channel config of the discount
+	channelConfig: CentricDiscountChannelConfig;
+	// item level config of the discount
+	itemLevelConfig?: CentricDiscountItemLevelConfig;
+	is?: CentricDiscountIs;
+	// discount metadata
+	meta?: CentricVoucherifyMetaDataDiscount;
+	// discount schedule
+	schedule?: CentricDiscountSchedule;
+	id?: string;
+	// discount active status flag
+	active?: boolean;
+	// type of the discount
+	type?: 'Total Order' | 'Single Items' | 'Bundle';
+}
+
+export interface PutDiscountVoucherifyRequestDTO {
+	// Discount to update
+	discount: PutDiscountVoucherifyRequestDiscount;
+	// List of sites with metadata
+	sites?: DiscountSite[];
+	// List of brands with metadata
+	brands?: DiscountBrand[];
+}
+
+export interface PutDiscountVoucherifyResponseDTO {
+	// Discount details
+	discount: DiscountResponseDTO;
+	// List of sites with metadata
+	sites: DiscountSite[];
+	// List of brands with metadata
+	brands: DiscountBrand[];
+}
+
 export interface PutDiscountVoucherifyPublishResponseDTO {
 	// user is of discount creator
 	createdBy: string;
@@ -947,6 +1014,10 @@ export interface PutDiscountVoucherifyPublishResponseDTO {
 	schedule?: Record<string, any>;
 }
 
+export interface DeleteCentricDiscountResponseDTO {
+	success: boolean;
+}
+
 export interface DeleteDiscountsVoucherifyResponseDTO {
 	success: boolean;
 }
@@ -1146,6 +1217,36 @@ export interface DeleteBusinessUnitResponse {
 	success: boolean;
 }
 
+export interface BusinessUnitCustomTimeslotDto {
+	// Window start, HH:mm on a 24 hour clock
+	start_time: string;
+	// Window end, HH:mm on a 24 hour clock
+	end_time: string;
+	// Delivery destination names served during this window
+	destinations: string[];
+}
+
+export interface PutBusinessUnitDropOffRequest {
+	// How drop-off timeslots are generated for the business unit
+	mode?: 'automatic' | 'custom';
+	// Delivery destination names served all day. Replaces the stored list.
+	destinations?: string[];
+	// Caller-defined delivery windows. Replaces the stored list.
+	custom_timeslots?: BusinessUnitCustomTimeslotDto[];
+	// Whether guests see a single timeslot instead of a list
+	show_single_timeslot?: boolean;
+	// Whether guests can leave drop-off instructions
+	show_instructions?: boolean;
+	// Whether the runner app is enabled for the business unit
+	runner_app_enabled?: boolean;
+	// Delivery fee in dollars. Send null to remove it; omit to leave it as is.
+	fee?: number | null;
+}
+
+export interface PutBusinessUnitDropOffResponse {
+	success: boolean;
+}
+
 export interface GlobalMenuGroupPublishedBrand {
 	id: string;
 	name: string;
@@ -1708,6 +1809,21 @@ export interface DeleteCentricosStationIntegrationPath {
 
 export type DeleteCentricosStationIntegrationResponse = DeleteStationIntegrationResponse;
 
+// PUT /centricos/discount - Add or Update a discount and assign it to multiple sites
+
+export type PutCentricosDiscountBody = PutCentricDiscountRequestDTO;
+
+export type PutCentricosDiscountResponse = PutCentricDiscountResponseDTO;
+
+// PUT /centricos/discount/{id}/publish - Update and publish a discount and assign it to multiple sites
+
+export interface PutCentricosDiscountPublishPath {
+	// Discount ID
+	id: string;
+}
+
+export type PutCentricosDiscountPublishResponse = PutCentricDiscountPublishResponseDTO;
+
 // PUT /centricos/discount/voucherify - Add or Update a voucherify discount and assign it to multiple sites
 
 export type PutCentricosDiscountVoucherifyBody = PutDiscountVoucherifyRequestDTO;
@@ -1723,14 +1839,14 @@ export interface PutCentricosDiscountVoucherifyPublishPath {
 
 export type PutCentricosDiscountVoucherifyPublishResponse = PutDiscountVoucherifyPublishResponseDTO;
 
-// DELETE /centricos/discount/{id}/voucherify - Delete a discount from voucherify and all of its entity associations
+// DELETE /centricos/discount/{id} - Delete a discount and all of its entity associations
 
-export interface DeleteCentricosDiscountsVoucherifyPath {
+export interface DeleteCentricosDiscountPath {
 	// Discount ID
 	id: string;
 }
 
-export type DeleteCentricosDiscountsVoucherifyResponse = DeleteDiscountsVoucherifyResponseDTO;
+export type DeleteCentricosDiscountResponse = DeleteCentricDiscountResponseDTO;
 
 // GET /centricos/discount/{id} - Get discount information by ID
 
@@ -1741,6 +1857,15 @@ export interface GetCentricosDiscountPath {
 
 export type GetCentricosDiscountResponse = GetDiscountResponseDTO;
 
+// 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 DeleteCentricosDiscountsVoucherifyResponse = DeleteDiscountsVoucherifyResponseDTO;
+
 // GET /centricos/discounts - Get discounts with pagination and filtering
 
 export interface GetCentricosDiscountsQuery {
@@ -1846,6 +1971,17 @@ export interface DeleteCentricosBusinessUnitPath {
 
 export type DeleteCentricosBusinessUnitResponse = DeleteBusinessUnitResponse;
 
+// PUT /centricos/business-unit/{bu_id}/drop-off - Update shared drop-off settings for a business unit
+
+export interface PutCentricosBusinessUnitDropOffPath {
+	// TODO: cannot use CompassLongID as path parameter
+	bu_id: string;
+}
+
+export type PutCentricosBusinessUnitDropOffBody = PutBusinessUnitDropOffRequest;
+
+export type PutCentricosBusinessUnitDropOffResponse = PutBusinessUnitDropOffResponse;
+
 // GET /centricos/menu/global-menu-groups - Get a paginated list of global menu groups with filtering, sorting, and relationships
 
 export interface GetCentricosMenuGlobalMenuGroupsQuery {