n8n-nodes-base
Version:
Base nodes of n8n
79 lines (73 loc) • 2.79 kB
text/typescript
/**
* Clockify Trigger Node - Version 1
* Listens to Clockify events
*/
export interface ClockifyTriggerV1Params {
/**
* 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:<ul><li>Seconds: 0-59</li><li>Minutes: 0 - 59</li><li>Hours: 0 - 23</li><li>Day of Month: 1 - 31</li><li>Months: 0 - 11 (Jan - Dec)</li><li>Day of Week: 0 - 6 (Sun - Sat)</li></ul>
* @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>;
}>;
};
/**
* Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code/expressions/">expression</a>
*/
workspaceId?: string | Expression<string>;
watchField?: 0 | Expression<number>;
}
export interface ClockifyTriggerV1Credentials {
clockifyApi: CredentialReference;
}
interface ClockifyTriggerV1NodeBase {
type: 'n8n-nodes-base.clockifyTrigger';
version: 1;
credentials?: ClockifyTriggerV1Credentials;
isTrigger: true;
}
export type ClockifyTriggerV1ParamsNode = ClockifyTriggerV1NodeBase & {
config: NodeConfig<ClockifyTriggerV1Params>;
};
export type ClockifyTriggerV1Node = ClockifyTriggerV1ParamsNode;