Kaizen
Browse modulesInsightsinsights/schedulingInterfaces

Interface: CreateReportScheduleInput

Defined in: server/insights/scheduling/report-schedule-service.ts:83

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-service.ts:86

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;
}

enabled?

optional enabled?: boolean;

Defined in: server/insights/scheduling/report-schedule-service.ts:87


name?

optional name?: string | null;

Defined in: server/insights/scheduling/report-schedule-service.ts:85


savedReportId

savedReportId: string;

Defined in: server/insights/scheduling/report-schedule-service.ts:84

On this page