n8n-nodes-base
Version:
Base nodes of n8n
115 lines (109 loc) • 4.32 kB
text/typescript
/**
* Microsoft OneDrive Trigger Node - Version 1
* Trigger for Microsoft OneDrive API.
*/
export interface MicrosoftOneDriveTriggerV1Params {
/**
* 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>;
}>;
};
event?: 'fileCreated' | 'fileUpdated' | 'folderCreated' | 'folderUpdated' | Expression<string>;
/**
* Whether to return a simplified version of the response instead of the raw data
* @default true
*/
simple?: boolean | Expression<boolean>;
/**
* Whether to watch for the created file in a given folder, rather than the entire OneDrive
* @displayOptions.show { event: ["fileCreated"] }
* @default false
*/
watchFolder?: boolean | Expression<boolean>;
/**
* How to select which file to watch
* @displayOptions.show { event: ["fileUpdated"] }
* @default anyFile
*/
watch?: 'anyFile' | 'selectedFolder' | 'selectedFile' | Expression<string>;
/**
* The file to operate on. The 'By URL' option only accepts URLs that start with 'https://onedrive.live.com'.
* @displayOptions.show { event: ["fileUpdated"], watch: ["selectedFile"] }
* @default {"mode":"id","value":""}
*/
fileId?: { __rl: true; mode: 'url' | 'id'; value: string; cachedResultName?: string };
/**
* The folder to operate on. The 'By URL' option only accepts URLs that start with 'https://onedrive.live.com'.
* @displayOptions.show { watch: ["selectedFolder", "oneSelectedFolder"] }
* @default {"mode":"id","value":"","cachedResultName":""}
*/
folderId?: { __rl: true; mode: 'url' | 'id'; value: string; cachedResultName?: string };
/**
* Options
* @displayOptions.show { watch: ["selectedFolder"] }
* @default {}
*/
options?: {
/** Whether to look for modified files/folders in all nested folders, rather than only direct descendants
* @default false
*/
folderChild?: boolean | Expression<boolean>;
};
}
export interface MicrosoftOneDriveTriggerV1Credentials {
microsoftOneDriveOAuth2Api: CredentialReference;
}
interface MicrosoftOneDriveTriggerV1NodeBase {
type: 'n8n-nodes-base.microsoftOneDriveTrigger';
version: 1;
credentials?: MicrosoftOneDriveTriggerV1Credentials;
isTrigger: true;
}
export type MicrosoftOneDriveTriggerV1ParamsNode = MicrosoftOneDriveTriggerV1NodeBase & {
config: NodeConfig<MicrosoftOneDriveTriggerV1Params>;
};
export type MicrosoftOneDriveTriggerV1Node = MicrosoftOneDriveTriggerV1ParamsNode;