@compassdigital/sdk.typescript 4.902.0 → 4.904.0

package/src/messages/events/CalendarEventCreatedEvent.ts

@@ -0,0 +1,81 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface Event {
+	data?: {
+		title?: string;
+		description?: string;
+		color?: string;
+		forecolor?: string;
+		icon?: string;
+		busy?: boolean;
+		calendar?: string;
+		location?: string;
+		id?: string;
+		menu?: string;
+		version?: number;
+		[index: string]: any;
+	};
+	schedule?: Schedule;
+	[index: string]: any;
+}
+
+export interface Schedule {
+	// Start timestamp in milliseconds (Unix epoch).
+	start?: number;
+	// End timestamp in milliseconds (Unix epoch). If omitted, the schedule continues indefinitely.
+	end?: number;
+	// Array of time strings specifying the start time of the event each day it occurs.
+	times?: string[];
+	// Duration of the event, combined with times to calculate the end time.
+	duration?: number;
+	// Duration unit for the schedule.
+	durationUnit?: 'minutes' | 'hours' | 'days' | 'weeks';
+	// Array of specific years when schedule applies (full year values, e.g., 2024).
+	year?: number[];
+	// Array of specific months when schedule applies (0-indexed, 0 = January, 11 = December).
+	month?: number[];
+	// Array of days of the week when this schedule is active.
+	dayOfWeek?: number[];
+	// Array of specific weeks of the month when schedule applies.
+	weekOfMonth?: number[];
+	// Array of specific weeks of the year when schedule applies (ISO week numbers).
+	weekOfYear?: number[];
+	// Array of week spans within the month (0-indexed week blocks).
+	weekspanOfMonth?: number[];
+	// Array of week spans within the year (0-indexed week blocks).
+	weekspanOfYear?: number[];
+	// Array of specific days of the year when schedule applies.
+	dayOfYear?: number[];
+	// Array of specific days of month when schedule applies.
+	dayOfMonth?: number[];
+	[index: string]: any;
+}
+
+export interface CalendarEventCreatedEvent {
+	id: string;
+	type: 'CalendarEventCreatedEvent';
+	version: '0.0.1';
+	timestamp: string;
+	traceContext: {
+		// W3C traceparent, injected by MessageBus from the active trace context
+		traceparent?: string;
+	};
+	source: string;
+	// Owning domain, optionally dotted for subdomains. Names the Kafka topic; absent keeps the superseded naming.
+	domain?: string;
+	// Whether other domains may integrate against this message. Absent means private.
+	visibility?: 'public' | 'private';
+	payload: {
+		// CDL-encoded location group (site) id of the station
+		site_id: string;
+		// CDL-encoded location brand (station) id. The calendar id is the same id
+		station_id: string;
+		// Calendar revision after the write. Matches `revision` returned by GET /calendar/{id} and the external-edge calendar endpoint
+		revision: number;
+		// Calendar event id (`data.id` of the event)
+		event_id: string;
+		// Calendar timezone, e.g. America/Toronto. Schedule times are interpreted in it
+		timezone?: string;
+		event: Event;
+	};
+}

package/src/messages/events/CalendarEventDeletedEvent.ts

@@ -0,0 +1,27 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface CalendarEventDeletedEvent {
+	id: string;
+	type: 'CalendarEventDeletedEvent';
+	version: '0.0.1';
+	timestamp: string;
+	traceContext: {
+		// W3C traceparent, injected by MessageBus from the active trace context
+		traceparent?: string;
+	};
+	source: string;
+	// Owning domain, optionally dotted for subdomains. Names the Kafka topic; absent keeps the superseded naming.
+	domain?: string;
+	// Whether other domains may integrate against this message. Absent means private.
+	visibility?: 'public' | 'private';
+	payload: {
+		// CDL-encoded location group (site) id of the station
+		site_id: string;
+		// CDL-encoded location brand (station) id. The calendar id is the same id
+		station_id: string;
+		// Calendar revision after the write. Matches `revision` returned by GET /calendar/{id} and the external-edge calendar endpoint
+		revision: number;
+		// Calendar event id (`data.id` of the event)
+		event_id: string;
+	};
+}

package/src/messages/events/CalendarEventUpdatedEvent.ts

@@ -0,0 +1,81 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface Event {
+	data?: {
+		title?: string;
+		description?: string;
+		color?: string;
+		forecolor?: string;
+		icon?: string;
+		busy?: boolean;
+		calendar?: string;
+		location?: string;
+		id?: string;
+		menu?: string;
+		version?: number;
+		[index: string]: any;
+	};
+	schedule?: Schedule;
+	[index: string]: any;
+}
+
+export interface Schedule {
+	// Start timestamp in milliseconds (Unix epoch).
+	start?: number;
+	// End timestamp in milliseconds (Unix epoch). If omitted, the schedule continues indefinitely.
+	end?: number;
+	// Array of time strings specifying the start time of the event each day it occurs.
+	times?: string[];
+	// Duration of the event, combined with times to calculate the end time.
+	duration?: number;
+	// Duration unit for the schedule.
+	durationUnit?: 'minutes' | 'hours' | 'days' | 'weeks';
+	// Array of specific years when schedule applies (full year values, e.g., 2024).
+	year?: number[];
+	// Array of specific months when schedule applies (0-indexed, 0 = January, 11 = December).
+	month?: number[];
+	// Array of days of the week when this schedule is active.
+	dayOfWeek?: number[];
+	// Array of specific weeks of the month when schedule applies.
+	weekOfMonth?: number[];
+	// Array of specific weeks of the year when schedule applies (ISO week numbers).
+	weekOfYear?: number[];
+	// Array of week spans within the month (0-indexed week blocks).
+	weekspanOfMonth?: number[];
+	// Array of week spans within the year (0-indexed week blocks).
+	weekspanOfYear?: number[];
+	// Array of specific days of the year when schedule applies.
+	dayOfYear?: number[];
+	// Array of specific days of month when schedule applies.
+	dayOfMonth?: number[];
+	[index: string]: any;
+}
+
+export interface CalendarEventUpdatedEvent {
+	id: string;
+	type: 'CalendarEventUpdatedEvent';
+	version: '0.0.1';
+	timestamp: string;
+	traceContext: {
+		// W3C traceparent, injected by MessageBus from the active trace context
+		traceparent?: string;
+	};
+	source: string;
+	// Owning domain, optionally dotted for subdomains. Names the Kafka topic; absent keeps the superseded naming.
+	domain?: string;
+	// Whether other domains may integrate against this message. Absent means private.
+	visibility?: 'public' | 'private';
+	payload: {
+		// CDL-encoded location group (site) id of the station
+		site_id: string;
+		// CDL-encoded location brand (station) id. The calendar id is the same id
+		station_id: string;
+		// Calendar revision after the write. Matches `revision` returned by GET /calendar/{id} and the external-edge calendar endpoint
+		revision: number;
+		// Calendar event id (`data.id` of the event)
+		event_id: string;
+		// Calendar timezone, e.g. America/Toronto. Schedule times are interpreted in it
+		timezone?: string;
+		event: Event;
+	};
+}

package/src/messages/events/index.ts

@@ -4,6 +4,12 @@ export { AuditEvent } from './AuditEvent';
 
 export { AvrideOrderStatusUpdatedEvent } from './AvrideOrderStatusUpdatedEvent';
 
+export { CalendarEventCreatedEvent } from './CalendarEventCreatedEvent';
+
+export { CalendarEventDeletedEvent } from './CalendarEventDeletedEvent';
+
+export { CalendarEventUpdatedEvent } from './CalendarEventUpdatedEvent';
+
 export { CampaignStatusChangedEvent } from './CampaignStatusChangedEvent';
 
 export { DeliveryDropOffLeaveWarningEvent } from './DeliveryDropOffLeaveWarningEvent';