n8n-nodes-base/dist/node-definitions/nodes/n8n-nodes-base/googleCalendarTrigger/v1.ts

Base nodes of n8n

/**
 * Google Calendar Trigger Node - Version 1
 * Starts the workflow when Google Calendar events occur
 */


export interface GoogleCalendarTriggerV1Params {
/**
 * Time at which polling should occur
 * @default {"item":[{"mode":"everyMinute"}]}
 */
    pollTimes?: {
        /** Item
     */
    item?: Array<{
      /** How often to trigger.
       * @default everyDay
       */
      mode?: 'everyMinute' | 'everyHour' | 'everyDay' | 'everyWeek' | 'everyMonth' | 'everyX' | 'custom' | Expression<string>;
      /** The hour of the day to trigger (24h format)
       * @displayOptions.hide { mode: ["custom", "everyHour", "everyMinute", "everyX"] }
       * @default 14
       */
      hour?: number | Expression<number>;
      /** The minute of the day to trigger
       * @displayOptions.hide { mode: ["custom", "everyMinute", "everyX"] }
       * @default 0
       */
      minute?: number | Expression<number>;
      /** The day of the month to trigger
       * @displayOptions.show { mode: ["everyMonth"] }
       * @default 1
       */
      dayOfMonth?: number | Expression<number>;
      /** The weekday to trigger
       * @displayOptions.show { mode: ["everyWeek"] }
       * @default 1
       */
      weekday?: '1' | '2' | '3' | '4' | '5' | '6' | '0' | Expression<string>;
      /** Use custom cron expression. Values and ranges as follows:&lt;ul&gt;&lt;li&gt;Seconds: 0-59&lt;/li&gt;&lt;li&gt;Minutes: 0 - 59&lt;/li&gt;&lt;li&gt;Hours: 0 - 23&lt;/li&gt;&lt;li&gt;Day of Month: 1 - 31&lt;/li&gt;&lt;li&gt;Months: 0 - 11 (Jan - Dec)&lt;/li&gt;&lt;li&gt;Day of Week: 0 - 6 (Sun - Sat)&lt;/li&gt;&lt;/ul&gt;
       * @displayOptions.show { mode: ["custom"] }
       * @default * * * * * *
       */
      cronExpression?: string | Expression<string> | PlaceholderValue;
      /** All how many X minutes/hours it should trigger
       * @displayOptions.show { mode: ["everyX"] }
       * @default 2
       */
      value?: number | Expression<number>;
      /** If it should trigger all X minutes or hours
       * @displayOptions.show { mode: ["everyX"] }
       * @default hours
       */
      unit?: 'minutes' | 'hours' | Expression<string>;
    }>;
  };
/**
 * Google Calendar to operate on
 * @default {"mode":"list","value":""}
 */
    calendarId?: { __rl: true; mode: 'list' | 'id'; value: string; cachedResultName?: string };
  triggerOn?: 'eventCancelled' | 'eventCreated' | 'eventEnded' | 'eventStarted' | 'eventUpdated' | Expression<string>;
  options?: {
    /** Free text search terms to filter events that match these terms in any field, except for extended properties
     */
    matchTerm?: string | Expression<string> | PlaceholderValue;
  };
}

export interface GoogleCalendarTriggerV1Credentials {
  googleCalendarOAuth2Api: CredentialReference;
}

interface GoogleCalendarTriggerV1NodeBase {
  type: 'n8n-nodes-base.googleCalendarTrigger';
  version: 1;
  credentials?: GoogleCalendarTriggerV1Credentials;
  isTrigger: true;
}

export type GoogleCalendarTriggerV1ParamsNode = GoogleCalendarTriggerV1NodeBase & {
  config: NodeConfig<GoogleCalendarTriggerV1Params>;
};

export type GoogleCalendarTriggerV1Node = GoogleCalendarTriggerV1ParamsNode;