n8n-nodes-base
Version:
Base nodes of n8n
185 lines (180 loc) • 5.35 kB
text/typescript
/**
* Google Calendar Node - Version 1.3
* Discriminator: resource=event, operation=update
*/
interface Credentials {
googleCalendarOAuth2Api: CredentialReference;
}
/** Update an event */
export type GoogleCalendarV13EventUpdateParams = {
resource: 'event';
operation: 'update';
/**
* Google Calendar to operate on
* @default {"mode":"list","value":""}
*/
calendar?: { __rl: true; mode: 'list' | 'id'; value: string; cachedResultName?: string };
/**
* Event ID
*/
eventId?: string | Expression<string> | PlaceholderValue;
/**
* Modify
* @displayOptions.show { @tool: [false], eventId: [{"_cnd":{"includes":"_"}}] }
* @default instance
*/
modifyTarget?: 'instance' | 'event' | Expression<string>;
/**
* Use Default Reminders
* @default true
*/
useDefaultReminders?: boolean | Expression<boolean>;
/**
* Update Fields
* @default {}
*/
updateFields?: {
/** Whether the event is all day or not
* @default no
*/
allday?: 'yes' | 'no' | Expression<string>;
/** Attendees
* @default {"values":{"mode":"add","attendees":[]}}
*/
attendeesUi?: {
/** Values
*/
values?: {
/** Mode
* @default add
*/
mode?: 'add' | 'replace' | Expression<string>;
/** The attendees of the event. Multiple ones can be separated by comma.
*/
attendees?: string | Expression<string> | PlaceholderValue;
};
};
/** The attendees of the event. Multiple ones can be separated by comma.
*/
attendees?: string | Expression<string> | PlaceholderValue;
/** The color of the event. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code/expressions/">expression</a>.
*/
color?: string | Expression<string>;
/** Description
*/
description?: string | Expression<string> | PlaceholderValue;
/** End time of the event
*/
end?: string | Expression<string>;
/** Whether attendees other than the organizer can invite others to the event
* @default true
*/
guestsCanInviteOthers?: boolean | Expression<boolean>;
/** Whether attendees other than the organizer can modify the event
* @default false
*/
guestsCanModify?: boolean | Expression<boolean>;
/** Whether attendees other than the organizer can see who the event's attendees are
* @default true
*/
guestsCanSeeOtherGuests?: boolean | Expression<boolean>;
/** Opaque identifier of the event
*/
id?: string | Expression<string> | PlaceholderValue;
/** Geographic location of the event as free-form text
*/
location?: string | Expression<string> | PlaceholderValue;
/** The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned.
* @default 0
*/
maxAttendees?: number | Expression<number>;
/** Repeat Frequency
*/
repeatFrecuency?: 'Daily' | 'weekly' | 'monthly' | 'yearly' | Expression<string>;
/** Repeat How Many Times?
* @default 1
*/
repeatHowManyTimes?: number | Expression<number>;
/** Repeat Until
*/
repeatUntil?: string | Expression<string>;
/** Recurrence rule. When set, the parameters Repeat Frequency, Repeat How Many Times and Repeat Until are ignored.
*/
rrule?: string | Expression<string> | PlaceholderValue;
/** Whether to send notifications about the creation of the new event
*/
sendUpdates?: 'all' | 'externalOnly' | 'none' | Expression<string>;
/** Whether the event blocks time on the calendar
* @default opaque
*/
showMeAs?: 'transparent' | 'opaque' | Expression<string>;
/** Start time of the event
*/
start?: string | Expression<string>;
/** Title of the event
*/
summary?: string | Expression<string> | PlaceholderValue;
/** Visibility of the event
* @default default
*/
visibility?: 'confidential' | 'default' | 'public' | 'private' | Expression<string>;
};
/**
* If the event doesn't use the default reminders, this lists the reminders specific to the event
* @displayOptions.show { useDefaultReminders: [false] }
* @default {}
*/
remindersUi?: {
/** Reminder
*/
remindersValues?: Array<{
/** Method
*/
method?: 'email' | 'popup' | Expression<string>;
/** Minutes Before
* @default 0
*/
minutes?: number | Expression<number>;
}>;
};
};
export type GoogleCalendarV13EventUpdateOutput = {
created?: string;
creator?: {
email?: string;
self?: boolean;
};
end?: {
dateTime?: string;
timeZone?: string;
};
etag?: string;
eventType?: string;
htmlLink?: string;
iCalUID?: string;
id?: string;
kind?: string;
organizer?: {
displayName?: string;
email?: string;
self?: boolean;
};
reminders?: {
useDefault?: boolean;
};
sequence?: number;
start?: {
dateTime?: string;
timeZone?: string;
};
status?: string;
summary?: string;
updated?: string;
};
export type GoogleCalendarV13EventUpdateNode = {
type: 'n8n-nodes-base.googleCalendar';
version: 1.3;
credentials?: Credentials;
config: NodeConfig<GoogleCalendarV13EventUpdateParams>;
output?: Items<GoogleCalendarV13EventUpdateOutput>;
};