@compassdigital/sdk.typescript 4.110.0 → 4.112.0

package/src/events/LegacyDraftBrandDiffGenerateRequested.ts

@@ -0,0 +1,16 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface LegacyDraftBrandDiffGenerateRequestedEvent {
+	// Metadata related to the request, including authentication details.
+	meta: {
+		// JWT authentication token used for authorization.
+		auth_token: string;
+	};
+	// The main request body containing necessary identifiers.
+	body: {
+		// Unique identifier for the request.
+		id: string;
+	};
+	name: 'LegacyDraftBrandDiffGenerateRequested';
+	version: '0.0.1';
+}

package/src/events/LegacyDraftBrandGlobalDiffsApplyRequested.ts

@@ -0,0 +1,16 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface LegacyDraftBrandGlobalDiffsApplyRequestedEvent {
+	// Metadata related to the request, including authentication details.
+	meta: {
+		// JWT authentication token used for authorization.
+		auth_token: string;
+	};
+	// The main request body containing necessary identifiers.
+	body: {
+		// Unique identifier for the request.
+		id: string;
+	};
+	name: 'LegacyDraftBrandGlobalDiffsApplyRequested';
+	version: '0.0.1';
+}

package/src/events/LegacyDraftBrandPublishRequested.ts

@@ -0,0 +1,18 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface LegacyDraftBrandPublishRequestedEvent {
+	// Metadata related to the request, including authentication details.
+	meta: {
+		// JWT authentication token used for authorization.
+		auth_token: string;
+	};
+	// The main request body containing necessary identifiers.
+	body: {
+		// Unique identifier for the request.
+		id: string;
+		// Unique identifier for the process associated with this request.
+		process_id: string;
+	};
+	name: 'LegacyDraftBrandPublishRequested';
+	version: '0.0.1';
+}

package/src/events/LegacyDraftBrandPublished.ts

@@ -0,0 +1,18 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface LegacyDraftBrandPublishedEvent {
+	// Metadata related to the request, including authentication details.
+	meta: {
+		// JWT authentication token used for authorization.
+		auth_token: string;
+	};
+	// The main request body containing necessary identifiers.
+	body: {
+		// Unique identifier for the request.
+		id: string;
+		// Unique identifier for the process associated with this request.
+		process_id: string;
+	};
+	name: 'LegacyDraftBrandPublished';
+	version: '0.0.1';
+}

package/src/events/LegacyDraftMenuPublishedToV2Menu.ts

@@ -0,0 +1,18 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface LegacyDraftMenuPublishedToV2MenuEvent {
+	// Metadata related to the request, including authentication details.
+	meta: {
+		// JWT authentication token used for authorization.
+		auth_token: string;
+	};
+	// The main request body containing necessary identifiers.
+	body: {
+		// Unique identifier for the request.
+		id: string;
+		// Unique identifier for the process associated with this request.
+		process_id: string;
+	};
+	name: 'LegacyDraftMenuPublishedToV2Menu';
+	version: '0.0.1';
+}

package/src/events/LegacyGlobalMenuGroupDeleted.ts

@@ -0,0 +1,14 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface LegacyGlobalMenuGroupDeletedEvent {
+	meta: {
+		// JWT authentication token
+		auth_token: string;
+	};
+	body: {
+		// Unique identifier of the deleted global menu group
+		id: string;
+	};
+	name: 'LegacyGlobalMenuGroupDeleted';
+	version: '0.0.1';
+}

package/src/events/LegacyItemExcelImportRequested.ts

@@ -0,0 +1,16 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface LegacyItemExcelImportRequestedEvent {
+	meta: {
+		// JWT authentication token
+		auth_token: string;
+	};
+	body: {
+		// Unique identifier of the brand
+		brand_id: string;
+		// File path of the imported Excel file
+		path: string;
+	};
+	name: 'LegacyItemExcelImportRequested';
+	version: '0.0.1';
+}

package/src/events/LegacyItemExcelValidationRequested.ts

@@ -0,0 +1,18 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface LegacyItemExcelValidationRequestedEvent {
+	meta: {
+		// JWT authentication token
+		auth_token: string;
+	};
+	body: {
+		// Unique identifier of the brand
+		brand_id: string;
+		// URL link to the validation report JSON file
+		validation_report_link: string;
+		// File path of the imported Excel file
+		excel_path: string;
+	};
+	name: 'LegacyItemExcelValidationRequested';
+	version: '0.0.1';
+}

package/src/events/LegacyLocalMenuGroupDeleted.ts

@@ -0,0 +1,14 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface LegacyLocalMenuGroupDeletedEvent {
+	meta: {
+		// JWT authentication token
+		auth_token: string;
+	};
+	body: {
+		// Unique identifier of the deleted local menu group
+		id: string;
+	};
+	name: 'LegacyLocalMenuGroupDeleted';
+	version: '0.0.1';
+}

package/src/events/LegacyLocationCreated.ts

@@ -0,0 +1,100 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface LegacyLocationCreatedEvent {
+	// Unique identifier for the entity
+	id: string;
+	// Type of entity (e.g., brand, location, group, etc.)
+	type: string;
+	// Multi-group association
+	multigroup?: string;
+	// Group association
+	group?: string;
+	// Location identifier
+	location?: string;
+	// Sector identifier
+	sector?: string;
+	// Company identifier
+	company?: string;
+	name: 'LegacyLocationCreated';
+	date: {
+		// Creation timestamp
+		created: string;
+		// Last modification timestamp
+		modified: string;
+	};
+	// External identifier for cross-system references
+	external_id?: string;
+	address?: {
+		address?: string;
+		city?: string;
+		state?: string;
+		zip?: string;
+		country?: string;
+		coordinates?: {
+			latitude: number;
+			longitude: number;
+		};
+	};
+	// Labeling metadata
+	label?: Record<string, any>;
+	// Styling metadata
+	style?: Record<string, any>;
+	// Additional metadata
+	meta?: Record<string, any>;
+	// Device mapping information
+	device_mapping?: Record<string, any>;
+	// Flags indicating entity capabilities
+	is?: {
+		scan_and_go_supported?: boolean;
+		frictionless_supported?: boolean;
+		pickup_supported?: boolean;
+		delivery_supported?: boolean;
+		special_instructions_enabled?: boolean;
+		cafe360?: boolean;
+		hidden?: boolean;
+	};
+	timeslots?: {
+		averagePrepTime?: string;
+		customers_per_slot?: number;
+		time?: string;
+		delivery_prep_time?: string;
+		delivery_is_user_defined?: boolean;
+		delivery_time?: string;
+		delivery_destinations?: string[];
+		delivery_user_defined?: string[];
+		delivery_customers_per_slot?: number;
+	};
+	menus?: Record<string, any>[];
+	hours?: Record<string, any>[];
+	deliveryHours?: Record<string, any>[];
+	// Description data for the entity
+	descriptions?: Record<string, any>;
+	// Payment provider associated with the entity
+	payment_provider?: string;
+	// Latitude coordinate
+	latitude?: number;
+	// Longitude coordinate
+	longitude?: number;
+	// Timezone for the entity
+	timezone?: string;
+	// Geohash of the entity's location
+	geohash?: string;
+	// Associated operation ID
+	operation_id?: number;
+	// Description of the location
+	location_description?: string;
+	// Point-of-sale system identifier
+	pos?: string;
+	terminals?: Record<string, any>[];
+	// Marketplace information
+	market_place?: Record<string, any>;
+	// Indicates if the location has a food locker
+	foodlocker?: boolean;
+	// Indicates if the entity is archived
+	archived?: boolean;
+	// Sorting order for listings
+	sort_sequence?: number;
+	// Additional information
+	information?: string;
+	version: '0.0.1';
+}

package/src/events/LegacyLocationUpdated.ts

@@ -0,0 +1,102 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface LegacyLocationUpdatedEvent {
+	// Unique identifier for the entity
+	id: string;
+	// Type of entity (e.g., brand, location, group, etc.)
+	type: string;
+	// Multi-group association
+	multigroup?: string;
+	// Group association
+	group?: string;
+	// Location identifier
+	location?: string;
+	// Sector identifier
+	sector?: string;
+	// Company identifier
+	company?: string;
+	name: 'LegacyLocationUpdated';
+	date: {
+		// Creation timestamp
+		created: string;
+		// Last modification timestamp
+		modified: string;
+	};
+	// External identifier for cross-system references
+	external_id?: string;
+	address?: {
+		address?: string;
+		city?: string;
+		state?: string;
+		zip?: string;
+		country?: string;
+		coordinates?: {
+			latitude: number;
+			longitude: number;
+		};
+	};
+	// Labeling metadata
+	label?: Record<string, any>;
+	// Styling metadata
+	style?: Record<string, any>;
+	// Additional metadata
+	meta?: Record<string, any>;
+	// Device mapping information
+	device_mapping?: Record<string, any>;
+	// Flags indicating entity capabilities
+	is?: {
+		scan_and_go_supported?: boolean;
+		frictionless_supported?: boolean;
+		pickup_supported?: boolean;
+		delivery_supported?: boolean;
+		special_instructions_enabled?: boolean;
+		cafe360?: boolean;
+		hidden?: boolean;
+	};
+	timeslots?: {
+		averagePrepTime?: string;
+		customers_per_slot?: number;
+		time?: string;
+		delivery_prep_time?: string;
+		delivery_is_user_defined?: boolean;
+		delivery_time?: string;
+		delivery_destinations?: string[];
+		delivery_user_defined?: string[];
+		delivery_customers_per_slot?: number;
+	};
+	menus?: Record<string, any>[];
+	hours?: Record<string, any>[];
+	deliveryHours?: Record<string, any>[];
+	// Description data for the entity
+	descriptions?: Record<string, any>;
+	// Payment provider associated with the entity
+	payment_provider?: string;
+	// Latitude coordinate
+	latitude?: number;
+	// Longitude coordinate
+	longitude?: number;
+	// Timezone for the entity
+	timezone?: string;
+	// Geohash of the entity's location
+	geohash?: string;
+	// Associated operation ID
+	operation_id?: number;
+	// Description of the location
+	location_description?: string;
+	// Point-of-sale system identifier
+	pos?: string;
+	terminals?: Record<string, any>[];
+	// Marketplace information
+	market_place?: Record<string, any>;
+	// Indicates if the location has a food locker
+	foodlocker?: boolean;
+	// Indicates if the entity is archived
+	archived?: boolean;
+	// Sorting order for listings
+	sort_sequence?: number;
+	// Additional information
+	information?: string;
+	// Previous state of the entity before modification
+	_old?: Record<string, any>;
+	version: '0.0.1';
+}

package/src/events/LegacyMenuPublishToV2MenuRequested.ts

@@ -0,0 +1,16 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface LegacyMenuPublishToV2MenuRequestedEvent {
+	meta: {
+		// JWT authentication token
+		auth_token: string;
+	};
+	body: {
+		// Unique identifier of the menu being published
+		id: string;
+		// Unique identifier of the publishing process
+		process_id: string;
+	};
+	name: 'LegacyMenuPublishToV2MenuRequested';
+	version: '0.0.1';
+}

package/src/events/LegacyMenuUpdated.ts

@@ -0,0 +1,18 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface LegacyMenuUpdatedEvent {
+	meta: {
+		// JWT authentication token
+		auth_token: string;
+	};
+	body: {
+		// Unique identifier
+		id: string;
+		// Current status of the operation
+		status: 'initiated' | 'in_progress' | 'completed' | 'failed';
+		// Type of operation being performed
+		type: 'brand_cleanup' | 'other_types';
+	};
+	name: 'LegacyMenuUpdated';
+	version: '0.0.1';
+}

package/src/events/LegacyOrderCreated.ts

@@ -0,0 +1,69 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface LegacyOrderCreatedEvent {
+	date: {
+		started: string;
+		created: string;
+		modified: string;
+		should_start: string;
+		completion_warning: string;
+	};
+	pickup_name: string;
+	location_brand: string;
+	pickup: number;
+	is: {
+		in_progress: boolean;
+		accepted: boolean;
+		ready: boolean;
+		out_for_delivery: boolean;
+		delivered: boolean;
+	};
+	mealplan: {
+		id: string;
+		tender: string;
+		name: string;
+	};
+	pickup_id: string;
+	meta: {
+		source: string;
+		timeslot_id: number;
+		transaction: {
+			id: string;
+			balance: number;
+			name: string;
+			is: {
+				validated: boolean;
+			};
+			transaction_id: string;
+			drained_tender_name: string;
+			drained_tender_breakdown: Record<string, any>[];
+			amount: number;
+		};
+		kds_type: string;
+		is_canada: boolean;
+		cancel_eligible: boolean;
+		shoppingcart: {
+			total: {
+				amount: number;
+			};
+			original_total: {
+				amount: number;
+			};
+		};
+	};
+	requested_date: number;
+	shoppingcart: string;
+	details: {
+		name: string;
+		contact_number: string;
+		order_type: string;
+		duration: string;
+		display_id: string;
+		country_code: string;
+		destination: string;
+	};
+	id: string;
+	customer: string;
+	name: 'LegacyOrderCreated';
+	version: '0.0.1';
+}

package/src/events/LegacyOrderReadyStatusUpdate.ts

@@ -0,0 +1,135 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface LegacyOrderReadyStatusUpdateEvent {
+	date: {
+		ready: string;
+		pickup: string;
+		modified: string;
+		started: string;
+		created: string;
+		should_start: string;
+		completion_warning: string;
+	};
+	issue: {
+		id: string;
+		type: string;
+		reason: string;
+		meta: {
+			created_at: string;
+		};
+	};
+	pickup_name: string;
+	location_brand: string;
+	past_issues: Record<string, any>[];
+	pickup: number;
+	is: {
+		ready: boolean;
+		out_for_delivery: boolean;
+		in_progress: boolean;
+		accepted: boolean;
+		delivered: boolean;
+	};
+	pickup_id: string;
+	meta: {
+		language: string;
+		source: string;
+		timeslot_id: number;
+		delivery_app: string;
+		transaction: {
+			reasonCode: number;
+			ccCaptureReply: {
+				requestDateTime: string;
+				purchasingLevel3Enabled: string;
+				processorResponseCode: string;
+				processorTransactionID: string;
+				partialAmount: string;
+				amount: string;
+				reconciliationID: string;
+				enhancedDataEnabled: string;
+				reasonCode: number;
+				processorResponseMessage: string;
+			};
+			networkData: {
+				network: string;
+			};
+			decision: string;
+			merchantReferenceCode: string;
+			tokenInformation: {
+				accountNumberMasked: string;
+				brand: string;
+				cardType: string;
+				cardExpirationMonth: string;
+				cardExpirationYear: string;
+			};
+			requestID: string;
+			ccAuthReply: {
+				authorizedDateTime: string;
+				processorTransactionID: string;
+				reconciliationID: string;
+				partialAmount: string;
+				authorizationCode: string;
+				enhancedDataEnabled: string;
+				processorResponseCode: string;
+				reasonCode: number;
+				processorResponseMessage: string;
+				amount: string;
+				requestDateTime: string;
+			};
+			amount: number;
+			requestDateTime: string;
+			creditCard: {
+				last4: string;
+				cardType: string;
+			};
+			status: string;
+			success: boolean;
+			id: string;
+		};
+		discount: {
+			id: string;
+			date: string;
+			result: boolean;
+			code: string;
+			discount: {
+				type: string;
+				percent_off: number;
+			};
+			type: string;
+			app: string;
+		};
+		kds_type: string;
+		is_canada: boolean;
+		cancel_eligible: boolean;
+		shoppingcart: {
+			total: {
+				amount: number;
+			};
+			original_total: {
+				amount: number;
+			};
+		};
+	};
+	requested_date: number;
+	shoppingcart: string;
+	details: {
+		contact_number: string;
+		destination: string;
+		duration: string;
+		instructions: string;
+		name: string;
+		order_type: string;
+		display_id: string;
+		country_code: string;
+	};
+	payment: {
+		token: string;
+		credit_card: {
+			card_type: string;
+			last4: string;
+		};
+	};
+	id: string;
+	customer: string;
+	name: 'LegacyOrderReadyStatusUpdate';
+	version: '0.0.1';
+}

package/src/events/LegacyOrderUpdated.ts

@@ -0,0 +1,70 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface LegacyOrderUpdatedEvent {
+	date: {
+		started: string;
+		created: string;
+		modified: string;
+		should_start: string;
+		completion_warning: string;
+	};
+	pickup_name: string;
+	location_brand: string;
+	pickup: number;
+	is: {
+		in_progress: boolean;
+		accepted: boolean;
+		ready: boolean;
+		out_for_delivery: boolean;
+		delivered: boolean;
+	};
+	mealplan: {
+		id: string;
+		tender: string;
+		name: string;
+	};
+	pickup_id: string;
+	meta: {
+		source: string;
+		timeslot_id: number;
+		transaction: {
+			id: string;
+			balance: number;
+			name: string;
+			is: {
+				validated: boolean;
+			};
+			transaction_id: string;
+			drained_tender_name: string;
+			drained_tender_breakdown: Record<string, any>[];
+			amount: number;
+		};
+		kds_type: string;
+		is_canada: boolean;
+		cancel_eligible: boolean;
+		shoppingcart: {
+			total: {
+				amount: number;
+			};
+			original_total: {
+				amount: number;
+			};
+		};
+	};
+	requested_date: number;
+	shoppingcart: string;
+	details: {
+		name: string;
+		contact_number: string;
+		order_type: string;
+		duration: string;
+		display_id: string;
+		country_code: string;
+		destination: string;
+	};
+	id: string;
+	customer: string;
+	_action: string;
+	name: 'LegacyOrderUpdated';
+	version: '0.0.1';
+}

package/src/events/LegacyPopulateLocalBrandsRequested.ts

@@ -0,0 +1,15 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface LegacyPopulateLocalBrandsRequestedEvent {
+	meta: {
+		// JWT authentication token
+		auth_token: string;
+	};
+	body: {
+		// Unique identifier for the local menu group
+		local_menu_group_id: string;
+		local_brand_ids: string[];
+	};
+	name: 'LegacyPopulateLocalBrandsRequested';
+	version: '0.0.1';
+}