n8n/packages/nodes-base/nodes/Zoom/MeetingDescription.ts

741 lines
16 KiB
TypeScript
Raw Normal View History

2020-06-22 11:51:15 -07:00
import {
INodeProperties,
} from 'n8n-workflow';
export const meetingOperations = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'meeting',
],
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create a meeting',
},
{
name: 'Delete',
value: 'delete',
description: 'Delete a meeting',
},
{
name: 'Get',
value: 'get',
description: 'Retrieve a meeting',
},
{
name: 'Get All',
value: 'getAll',
description: 'Retrieve all meetings',
},
{
name: 'Update',
value: 'update',
description: 'Update a meeting',
2020-06-23 20:29:47 -07:00
},
2020-06-22 11:51:15 -07:00
],
default: 'create',
description: 'The operation to perform.',
2020-06-24 16:28:08 -07:00
},
2020-06-22 11:51:15 -07:00
] as INodeProperties[];
export const meetingFields = [
/* -------------------------------------------------------------------------- */
2020-06-24 16:28:08 -07:00
/* meeting:create */
2020-06-22 11:51:15 -07:00
/* -------------------------------------------------------------------------- */
{
2020-06-24 10:47:35 -07:00
displayName: 'Additional Fields',
2020-06-22 11:51:15 -07:00
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
operation: [
'create',
],
resource: [
'meeting',
],
2020-06-23 20:29:47 -07:00
},
2020-06-22 11:51:15 -07:00
},
options: [
{
2020-06-23 12:14:04 -07:00
displayName: 'Agenda',
name: 'agenda',
2020-06-22 11:51:15 -07:00
type: 'string',
2020-06-24 16:28:08 -07:00
typeOptions: {
alwaysOpenEditWindow: true,
},
2020-06-22 11:51:15 -07:00
default: '',
2020-06-23 12:14:04 -07:00
description: 'Meeting agenda.',
2020-06-22 11:51:15 -07:00
},
{
displayName: 'Duration',
name: 'duration',
type: 'number',
2020-06-24 16:28:08 -07:00
typeOptions: {
minValue: 0,
},
default: 0,
description: 'Meeting duration (minutes).',
2020-06-22 11:51:15 -07:00
},
{
2020-06-24 10:47:35 -07:00
displayName: 'Meeting Topic',
2020-06-23 12:14:04 -07:00
name: 'topic',
2020-06-22 11:51:15 -07:00
type: 'string',
2020-06-24 16:28:08 -07:00
typeOptions: {
alwaysOpenEditWindow: true,
},
2020-06-22 11:51:15 -07:00
default: '',
2020-06-23 12:14:04 -07:00
description: `Meeting topic.`,
2020-06-22 11:51:15 -07:00
},
{
2020-06-24 10:47:35 -07:00
displayName: 'Meeting Type',
2020-06-23 12:14:04 -07:00
name: 'type',
2020-06-22 11:51:15 -07:00
type: 'options',
options: [
{
2020-06-23 12:14:04 -07:00
name: 'Instant Meeting',
value: 1,
2020-06-22 11:51:15 -07:00
},
{
2020-06-23 12:14:04 -07:00
name: 'Scheduled Meeting',
value: 2,
2020-06-22 11:51:15 -07:00
},
{
2020-06-24 10:47:35 -07:00
name: 'Recurring Meeting with no fixed time',
2020-06-23 12:14:04 -07:00
value: 3,
2020-06-22 11:51:15 -07:00
},
{
2020-06-24 10:47:35 -07:00
name: 'Recurring Meeting with fixed time',
2020-06-23 12:14:04 -07:00
value: 8,
2020-06-22 11:51:15 -07:00
},
],
2020-06-23 12:14:04 -07:00
default: 2,
2020-06-23 20:29:47 -07:00
description: 'Meeting type.',
2020-06-23 12:14:04 -07:00
},
{
displayName: 'Password',
name: 'password',
type: 'string',
default: '',
description: 'Password to join the meeting with maximum 10 characters.',
2020-06-22 11:51:15 -07:00
},
{
2020-06-24 16:28:08 -07:00
displayName: 'Schedule For',
name: 'scheduleFor',
type: 'string',
default: '',
description: 'Schedule meeting for someone else from your account, provide their email ID.',
},
{
displayName: 'Settings',
name: 'settings',
type: 'collection',
placeholder: 'Add Setting',
default: {},
2020-06-22 11:51:15 -07:00
options: [
{
2020-06-24 16:28:08 -07:00
displayName: 'Audio',
name: 'audio',
type: 'options',
options: [
{
name: 'Both Telephony and VoiP',
value: 'both',
},
{
name: 'Telephony',
value: 'telephony',
},
{
name: 'VOIP',
value: 'voip',
},
],
default: 'both',
description: 'Determine how participants can join audio portion of the meeting.',
2020-06-22 11:51:15 -07:00
},
{
2020-06-24 16:28:08 -07:00
displayName: 'Alternative Hosts',
name: 'alternativeHosts',
type: 'string',
default: '',
description: 'Alternative hosts email IDs.',
2020-06-22 11:51:15 -07:00
},
{
2020-06-24 16:28:08 -07:00
displayName: 'Auto Recording',
name: 'autoRecording',
type: 'options',
options: [
{
name: 'Record on Local',
value: 'local',
},
{
name: 'Record on Cloud',
value: 'cloud',
},
{
name: 'Disabled',
value: 'none',
},
],
default: 'none',
description: 'Auto recording.',
},
{
displayName: 'Host Meeting in China',
name: 'cnMeeting',
type: 'boolean',
default: false,
description: 'Host Meeting in China.',
},
{
displayName: 'Host Meeting in India',
name: 'inMeeting',
type: 'boolean',
default: false,
description: 'Host Meeting in India.',
},
{
displayName: 'Host Video',
name: 'hostVideo',
type: 'boolean',
default: false,
description: 'Start video when host joins the meeting.',
},
{
displayName: 'Join Before Host',
name: 'joinBeforeHost',
type: 'boolean',
default: false,
description: 'Allow participants to join the meeting before host starts it.',
},
{
displayName: 'Muting Upon Entry',
name: 'muteUponEntry',
type: 'boolean',
default: false,
description: 'Mute participants upon entry.',
},
{
displayName: 'Participant Video',
name: 'participantVideo',
type: 'boolean',
default: false,
description: 'Start video when participant joins the meeting.',
},
{
displayName: 'Registration Type',
name: 'registrationType',
type: 'options',
options: [
{
name: 'Attendees register once and can attend any of the occurences',
value: 1,
},
{
name: 'Attendees need to register for every occurrence',
value: 2,
},
{
name: 'Attendees register once and can choose one or more occurrences to attend',
value: 3,
},
],
default: 1,
description: 'Registration type. Used for recurring meetings with fixed time only',
},
{
displayName: 'Watermark',
name: 'watermark',
type: 'boolean',
default: false,
description: 'Adds watermark when viewing a shared screen.',
2020-06-22 11:51:15 -07:00
},
],
2020-06-23 12:14:04 -07:00
},
{
2020-06-24 10:47:35 -07:00
displayName: 'Start Time',
2020-06-23 12:14:04 -07:00
name: 'startTime',
type: 'dateTime',
default: '',
description: 'Start time should be used only for scheduled or recurring meetings with fixed time',
},
{
displayName: 'Timezone',
name: 'timeZone',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getTimezones',
},
default: '',
description: `Time zone used in the response. The default is the time zone of the calendar.`,
},
2020-06-22 11:51:15 -07:00
],
},
/* -------------------------------------------------------------------------- */
/* meeting:get */
/* -------------------------------------------------------------------------- */
{
2020-06-23 14:26:00 -07:00
displayName: 'Meeting ID',
2020-06-22 18:39:21 -07:00
name: 'meetingId',
2020-06-22 11:51:15 -07:00
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: [
'get',
],
resource: [
'meeting',
],
},
},
2020-06-22 18:39:21 -07:00
description: 'Meeting ID.',
},
{
2020-06-24 10:47:35 -07:00
displayName: 'Additional Fields',
2020-06-22 18:39:21 -07:00
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
operation: [
'get',
],
resource: [
'meeting',
],
},
},
options: [
{
2020-06-23 13:40:43 -07:00
displayName: 'Occurrence ID',
name: 'occurrenceId',
2020-06-22 18:39:21 -07:00
type: 'string',
default: '',
2020-06-23 13:40:43 -07:00
description: 'To view meeting details of a particular occurrence of the recurring meeting.',
2020-06-22 18:39:21 -07:00
},
{
2020-06-23 13:40:43 -07:00
displayName: 'Show Previous Occurrences',
name: 'showPreviousOccurrences',
2020-06-22 18:39:21 -07:00
type: 'boolean',
default: '',
2020-06-23 13:40:43 -07:00
description: 'To view meeting details of all previous occurrences of the recurring meeting.',
2020-06-22 18:39:21 -07:00
},
],
2020-06-22 11:51:15 -07:00
},
/* -------------------------------------------------------------------------- */
2020-06-24 16:28:08 -07:00
/* meeting:getAll */
2020-06-22 11:51:15 -07:00
/* -------------------------------------------------------------------------- */
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
displayOptions: {
show: {
operation: [
'getAll',
],
resource: [
'meeting',
],
},
},
default: false,
description: 'If all results should be returned or only up to a given limit.',
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
displayOptions: {
show: {
operation: [
'getAll',
],
resource: [
'meeting',
],
returnAll: [
false,
],
},
},
typeOptions: {
minValue: 1,
2020-06-23 20:29:47 -07:00
maxValue: 300,
2020-06-22 11:51:15 -07:00
},
default: 30,
description: 'How many results to return.',
},
{
2020-06-24 16:28:08 -07:00
displayName: 'Filters',
name: 'filters',
2020-06-22 11:51:15 -07:00
type: 'collection',
2020-06-24 16:28:08 -07:00
placeholder: 'Add Filter',
2020-06-22 11:51:15 -07:00
default: {},
displayOptions: {
show: {
operation: [
'getAll',
],
resource: [
'meeting',
],
2020-06-22 18:39:21 -07:00
},
2020-06-22 11:51:15 -07:00
},
options: [
{
displayName: 'Type',
name: 'type',
type: 'options',
options: [
{
name: 'Scheduled',
value: 'scheduled',
2020-06-24 16:28:08 -07:00
description: 'This includes all valid past meetings, live meetings and upcoming scheduled meetings'
2020-06-22 11:51:15 -07:00
},
{
name: 'Live',
value: 'live',
2020-06-24 16:28:08 -07:00
description: 'All ongoing meetings',
2020-06-22 11:51:15 -07:00
},
{
name: 'Upcoming',
value: 'upcoming',
2020-06-24 16:28:08 -07:00
description: 'All upcoming meetings including live meetings',
2020-06-22 11:51:15 -07:00
},
],
default: 'live',
description: `Meeting type.`,
},
2020-06-24 16:28:08 -07:00
],
2020-06-22 11:51:15 -07:00
},
/* -------------------------------------------------------------------------- */
2020-06-24 16:28:08 -07:00
/* meeting:delete */
2020-06-22 11:51:15 -07:00
/* -------------------------------------------------------------------------- */
{
2020-06-23 14:26:00 -07:00
displayName: 'Meeting ID',
2020-06-22 11:51:15 -07:00
name: 'meetingId',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: [
2020-06-23 20:29:47 -07:00
'delete',
2020-06-22 11:51:15 -07:00
],
resource: [
'meeting',
],
},
},
description: 'Meeting ID.',
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
operation: [
'delete',
],
resource: [
'meeting',
],
},
},
options: [
{
2020-06-23 13:40:43 -07:00
displayName: 'Occurence ID',
name: 'occurrenceId',
2020-06-22 11:51:15 -07:00
type: 'string',
default: '',
2020-06-23 13:40:43 -07:00
description: 'Meeting occurrence ID.',
2020-06-22 11:51:15 -07:00
},
{
2020-06-24 10:47:35 -07:00
displayName: 'Schedule Reminder',
2020-06-22 11:51:15 -07:00
name: 'scheduleForReminder',
type: 'boolean',
default: false,
2020-06-22 18:39:21 -07:00
description: 'Notify hosts and alternative hosts about meeting cancellation via email',
2020-06-22 11:51:15 -07:00
},
],
},
/* -------------------------------------------------------------------------- */
2020-06-24 16:28:08 -07:00
/* meeting:update */
2020-06-22 11:51:15 -07:00
/* -------------------------------------------------------------------------- */
{
2020-06-23 13:40:43 -07:00
displayName: 'Meeting ID',
2020-06-22 11:51:15 -07:00
name: 'meetingId',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: [
'update',
],
resource: [
'meeting',
],
},
},
description: 'Meeting ID.',
},
{
2020-06-24 16:28:08 -07:00
displayName: 'Update Fields',
name: 'updateFields',
2020-06-22 11:51:15 -07:00
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
operation: [
'update',
],
resource: [
'meeting',
],
2020-06-22 18:39:21 -07:00
},
2020-06-22 11:51:15 -07:00
},
options: [
2020-06-22 18:39:21 -07:00
{
2020-06-23 12:14:04 -07:00
displayName: 'Agenda',
name: 'agenda',
2020-06-22 18:39:21 -07:00
type: 'string',
2020-06-24 16:28:08 -07:00
typeOptions: {
alwaysOpenEditWindow: true,
},
2020-06-22 18:39:21 -07:00
default: '',
2020-06-23 12:14:04 -07:00
description: 'Meeting agenda.',
2020-06-22 18:39:21 -07:00
},
2020-06-22 11:51:15 -07:00
{
displayName: 'Duration',
name: 'duration',
type: 'number',
2020-06-24 16:28:08 -07:00
typeOptions: {
minValue: 0,
},
default: 0,
description: 'Meeting duration (minutes).',
2020-06-22 11:51:15 -07:00
},
{
2020-06-24 10:47:35 -07:00
displayName: 'Meeting Topic',
2020-06-23 12:14:04 -07:00
name: 'topic',
2020-06-22 11:51:15 -07:00
type: 'string',
default: '',
2020-06-23 12:14:04 -07:00
description: `Meeting topic.`,
2020-06-22 11:51:15 -07:00
},
{
2020-06-24 10:47:35 -07:00
displayName: 'Meeting Type',
2020-06-23 12:14:04 -07:00
name: 'type',
2020-06-22 11:51:15 -07:00
type: 'options',
options: [
{
2020-06-23 12:14:04 -07:00
name: 'Instant Meeting',
value: 1,
2020-06-22 11:51:15 -07:00
},
{
2020-06-23 12:14:04 -07:00
name: 'Scheduled Meeting',
value: 2,
2020-06-22 11:51:15 -07:00
},
{
2020-06-24 10:47:35 -07:00
name: 'Recurring Meeting with no fixed time',
2020-06-23 12:14:04 -07:00
value: 3,
2020-06-22 11:51:15 -07:00
},
{
2020-06-24 10:47:35 -07:00
name: 'Recurring Meeting with fixed time',
2020-06-23 12:14:04 -07:00
value: 8,
2020-06-22 11:51:15 -07:00
},
2020-06-23 12:14:04 -07:00
2020-06-22 11:51:15 -07:00
],
2020-06-23 12:14:04 -07:00
default: 2,
2020-06-23 20:29:47 -07:00
description: 'Meeting type.',
2020-06-23 12:14:04 -07:00
},
{
displayName: 'Password',
name: 'password',
type: 'string',
default: '',
description: 'Password to join the meeting with maximum 10 characters.',
},
{
2020-06-24 16:28:08 -07:00
displayName: 'Schedule For',
name: 'scheduleFor',
type: 'string',
default: '',
description: 'Schedule meeting for someone else from your account, provide their email ID.',
2020-06-22 11:51:15 -07:00
},
{
2020-06-24 16:28:08 -07:00
displayName: 'Settings',
name: 'settings',
type: 'collection',
placeholder: 'Add Setting',
default: {},
2020-06-22 11:51:15 -07:00
options: [
{
2020-06-24 16:28:08 -07:00
displayName: 'Audio',
name: 'audio',
type: 'options',
options: [
{
name: 'Both Telephony and VoiP',
value: 'both',
},
{
name: 'Telephony',
value: 'telephony',
},
{
name: 'VOIP',
value: 'voip',
},
],
default: 'both',
description: 'Determine how participants can join audio portion of the meeting.',
2020-06-22 11:51:15 -07:00
},
{
2020-06-24 16:28:08 -07:00
displayName: 'Alternative Hosts',
name: 'alternativeHosts',
type: 'string',
default: '',
description: 'Alternative hosts email IDs.',
2020-06-22 11:51:15 -07:00
},
{
2020-06-24 16:28:08 -07:00
displayName: 'Auto Recording',
name: 'autoRecording',
type: 'options',
options: [
{
name: 'Record on Local',
value: 'local',
},
{
name: 'Record on Cloud',
value: 'cloud',
},
{
name: 'Disabled',
value: 'none',
},
],
default: 'none',
description: 'Auto recording.',
},
{
displayName: 'Host Meeting in China',
name: 'cnMeeting',
type: 'boolean',
default: false,
description: 'Host Meeting in China.',
},
{
displayName: 'Host Meeting in India',
name: 'inMeeting',
type: 'boolean',
default: false,
description: 'Host Meeting in India.',
},
{
displayName: 'Host Video',
name: 'hostVideo',
type: 'boolean',
default: false,
description: 'Start video when host joins the meeting.',
},
{
displayName: 'Join Before Host',
name: 'joinBeforeHost',
type: 'boolean',
default: false,
description: 'Allow participants to join the meeting before host starts it.',
},
{
displayName: 'Muting Upon Entry',
name: 'muteUponEntry',
type: 'boolean',
default: false,
description: 'Mute participants upon entry.',
},
{
displayName: 'Participant Video',
name: 'participantVideo',
type: 'boolean',
default: false,
description: 'Start video when participant joins the meeting.',
},
{
displayName: 'Registration Type',
name: 'registrationType',
type: 'options',
options: [
{
name: 'Attendees register once and can attend any of the occurences',
value: 1,
},
{
name: 'Attendees need to register for every occurrence',
value: 2,
},
{
name: 'Attendees register once and can choose one or more occurrences to attend',
value: 3,
},
],
default: 1,
description: 'Registration type. Used for recurring meetings with fixed time only',
},
{
displayName: 'Watermark',
name: 'watermark',
type: 'boolean',
default: false,
description: 'Adds watermark when viewing a shared screen.',
2020-06-22 11:51:15 -07:00
},
],
2020-06-23 12:14:04 -07:00
},
{
2020-06-24 10:47:35 -07:00
displayName: 'Start Time',
2020-06-23 12:14:04 -07:00
name: 'startTime',
type: 'dateTime',
default: '',
description: 'Start time should be used only for scheduled or recurring meetings with fixed time',
},
{
displayName: 'Timezone',
name: 'timeZone',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getTimezones',
},
default: '',
description: `Time zone used in the response. The default is the time zone of the calendar.`,
},
2020-06-22 11:51:15 -07:00
],
},
] as INodeProperties[];