Interface: ReportScheduleRegistration
Defined in: server/insights/scheduling/report-schedule-queue.ts:56
The subset of a schedule the scheduler registration needs.
Properties
config
config:
| {
cadence: "daily";
format: "pdf" | "csv" | "xlsx";
recipients: string[];
timeOfDay: string;
timezone: string;
}
| {
cadence: "weekly";
format: "pdf" | "csv" | "xlsx";
recipients: string[];
timeOfDay: string;
timezone: string;
weekdays: number[];
}
| {
cadence: "monthly";
dayOfMonth: number | "last";
format: "pdf" | "csv" | "xlsx";
recipients: string[];
timeOfDay: string;
timezone: string;
}
| {
cadence: "custom";
cron: string;
format: "pdf" | "csv" | "xlsx";
recipients: string[];
timezone: string;
};Defined in: server/insights/scheduling/report-schedule-queue.ts:59
Union Members
Type Literal
{
cadence: "daily";
format: "pdf" | "csv" | "xlsx";
recipients: string[];
timeOfDay: string;
timezone: string;
}Type Literal
{
cadence: "weekly";
format: "pdf" | "csv" | "xlsx";
recipients: string[];
timeOfDay: string;
timezone: string;
weekdays: number[];
}cadence
cadence: "weekly";format
format: "pdf" | "csv" | "xlsx" = reportDeliveryFormatSchema;recipients
recipients: string[] = reportRecipientsSchema;timeOfDay
timeOfDay: string = timeOfDaySchema;timezone
timezone: string = timezoneSchema;weekdays
weekdays: number[];One or more weekdays; de-duplicated so [1,1] cannot double-fire.
Type Literal
{
cadence: "monthly";
dayOfMonth: number | "last";
format: "pdf" | "csv" | "xlsx";
recipients: string[];
timeOfDay: string;
timezone: string;
}Type Literal
{
cadence: "custom";
cron: string;
format: "pdf" | "csv" | "xlsx";
recipients: string[];
timezone: string;
}id
id: string;Defined in: server/insights/scheduling/report-schedule-queue.ts:57
mutationVersion
mutationVersion: number;Defined in: server/insights/scheduling/report-schedule-queue.ts:60
organizationId
organizationId: string;Defined in: server/insights/scheduling/report-schedule-queue.ts:58