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

666 lines
13 KiB
TypeScript
Raw Normal View History

2020-06-22 18:39:21 -07:00
import {
INodeProperties,
} from 'n8n-workflow';
export const webinarOperations = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'webinar',
],
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create a webinar',
},
{
name: 'Delete',
value: 'delete',
description: 'Delete a webinar',
},
{
name: 'Get',
value: 'get',
description: 'Retrieve a webinar',
},
{
name: 'Get All',
value: 'getAll',
description: 'Retrieve all webinars',
},
{
name: 'Update',
value: 'update',
description: 'Update a webinar',
}
],
default: 'create',
description: 'The operation to perform.',
}
] as INodeProperties[];
export const webinarFields = [
/* -------------------------------------------------------------------------- */
/* webinar:create */
/* -------------------------------------------------------------------------- */
{
2020-06-23 14:26:00 -07:00
displayName: 'User ID',
2020-06-22 18:39:21 -07:00
name: 'userId',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: [
'create',
],
resource: [
'webinar',
],
},
},
2020-06-24 11:18:56 -07:00
description: 'User ID or email ID.',
2020-06-22 18:39:21 -07:00
},
{
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: [
'create',
],
resource: [
'webinar',
],
}
},
options: [
{
displayName: 'Agenda',
name: 'agenda',
type: 'string',
default: '',
description: 'Webinar agenda.',
},
{
displayName: 'Alternative Hosts',
2020-06-24 11:18:56 -07:00
name: 'alternativeHosts',
2020-06-22 18:39:21 -07:00
type: 'string',
default: '',
2020-06-23 14:26:00 -07:00
description: 'Alternative hosts email IDs.',
2020-06-22 18:39:21 -07:00
},
{
2020-06-24 10:47:35 -07:00
displayName: 'Approval Type',
2020-06-24 11:18:56 -07:00
name: 'approvalType',
2020-06-22 18:39:21 -07:00
type: 'options',
options: [
{
2020-06-24 10:47:35 -07:00
name: 'Automatically Approve',
2020-06-22 18:39:21 -07:00
value: 0,
},
{
2020-06-24 10:47:35 -07:00
name: 'Manually Approve',
2020-06-22 18:39:21 -07:00
value: 1,
},
{
2020-06-24 10:47:35 -07:00
name: 'No Registration Required',
2020-06-22 18:39:21 -07:00
value: 2,
},
],
default: 2,
description: 'Approval type.',
},
2020-06-23 12:14:04 -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 webinar.',
},
2020-06-22 18:39:21 -07:00
{
2020-06-24 10:47:35 -07:00
displayName: 'Auto Recording',
2020-06-24 11:18:56 -07:00
name: 'autoRecording',
2020-06-22 18:39:21 -07:00
type: 'options',
options: [
{
2020-06-24 10:47:35 -07:00
name: 'Record on Local',
2020-06-22 18:39:21 -07:00
value: 'local',
},
{
2020-06-24 10:47:35 -07:00
name: 'Record on Cloud',
2020-06-22 18:39:21 -07:00
value: 'cloud',
},
{
name: 'Disabled',
value: 'none',
},
],
default: 'none',
description: 'Auto recording.',
},
{
2020-06-23 12:14:04 -07:00
displayName: 'Duration',
name: 'duration',
type: 'string',
default: '',
description: 'Duration.',
},
{
displayName: 'Host Video',
2020-06-24 11:18:56 -07:00
name: 'hostVideo',
2020-06-23 12:14:04 -07:00
type: 'boolean',
default: false,
description: 'Start video when host joins the webinar.',
},
{
displayName: 'Panelists Video',
2020-06-24 11:18:56 -07:00
name: 'panelistsVideo',
2020-06-23 12:14:04 -07:00
type: 'boolean',
default: false,
description: 'Start video when panelists joins the webinar.',
},
{
displayName: 'Password',
name: 'password',
type: 'string',
default: '',
description: 'Password to join the webinar with maximum 10 characters.',
},
{
displayName: 'Practice Session',
2020-06-24 11:18:56 -07:00
name: 'practiceSession',
2020-06-23 12:14:04 -07:00
type: 'boolean',
default: false,
description: 'Enable Practice session.',
2020-06-22 18:39:21 -07:00
},
{
2020-06-24 10:47:35 -07:00
displayName: 'Registration Type',
2020-06-24 11:18:56 -07:00
name: 'registrationType',
2020-06-22 18:39:21 -07:00
type: 'options',
options: [
{
name: 'Attendees register once and can attend any of the occurences',
value: 1,
},
{
2020-06-23 13:40:43 -07:00
name: 'Attendees need to register for every occurrence',
2020-06-22 18:39:21 -07:00
value: 2,
},
{
2020-06-23 13:40:43 -07:00
name: 'Attendees register once and can choose one or more occurrences to attend',
2020-06-22 18:39:21 -07:00
value: 3,
},
],
default: 1,
description: 'Registration type. Used for recurring webinar with fixed time only',
},
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 webinar 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-24 10:47:35 -07:00
displayName: 'Webinar Topic',
2020-06-23 12:14:04 -07:00
name: 'topic',
type: 'string',
default: '',
description: `Webinar topic.`,
},
{
2020-06-24 10:47:35 -07:00
displayName: 'Webinar Type',
2020-06-23 12:14:04 -07:00
name: 'type',
type: 'options',
options: [
{
name: 'Webinar',
value: 5,
},
{
name: 'Recurring webinar with no fixed time',
value: 6,
},
{
2020-06-24 10:47:35 -07:00
name: 'Recurring webinar with fixed time',
2020-06-23 12:14:04 -07:00
value: 9,
},
],
default: 5,
2020-06-23 20:29:47 -07:00
description: 'Webinar type.',
2020-06-23 12:14:04 -07:00
},
2020-06-22 18:39:21 -07:00
],
},
/* -------------------------------------------------------------------------- */
/* webinar:get */
/* -------------------------------------------------------------------------- */
{
2020-06-23 14:26:00 -07:00
displayName: 'Webinar ID',
2020-06-22 18:39:21 -07:00
name: 'webinarId',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: [
'get',
],
resource: [
'webinar',
],
},
},
description: 'Webinar 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: [
'webinar',
],
},
},
options: [
{
2020-06-23 14:26:00 -07:00
displayName: 'Occurence ID',
2020-06-22 18:39:21 -07:00
name: 'occurenceId',
type: 'string',
default: '',
2020-06-23 13:40:43 -07:00
description: 'To view webinar details of a particular occurrence of the recurring webinar.',
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 webinar details of all previous occurrences of the recurring webinar.',
2020-06-22 18:39:21 -07:00
},
],
},
/* -------------------------------------------------------------------------- */
/* webinar:getAll */
/* -------------------------------------------------------------------------- */
{
2020-06-23 14:26:00 -07:00
displayName: 'User ID',
2020-06-22 18:39:21 -07:00
name: 'userId',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: [
'getAll',
],
resource: [
'webinar',
],
},
},
2020-06-23 14:26:00 -07:00
description: 'User ID or email-ID.',
2020-06-22 18:39:21 -07:00
},
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
displayOptions: {
show: {
operation: [
'getAll',
],
resource: [
'webinar',
],
},
},
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: [
'webinar',
],
returnAll: [
false,
],
},
},
typeOptions: {
minValue: 1,
2020-06-23 20:29:47 -07:00
maxValue: 300,
2020-06-22 18:39:21 -07:00
},
default: 30,
description: 'How many results to return.',
},
/* -------------------------------------------------------------------------- */
2020-06-23 13:40:43 -07:00
/* webinar:delete */
2020-06-22 18:39:21 -07:00
/* -------------------------------------------------------------------------- */
{
2020-06-23 14:26:00 -07:00
displayName: 'Webinar ID',
2020-06-22 18:39:21 -07:00
name: 'webinarId',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: [
2020-06-23 20:29:47 -07:00
'delete',
2020-06-22 18:39:21 -07:00
],
resource: [
'webinarId',
],
},
},
2020-06-23 14:26:00 -07:00
description: 'Webinar ID.',
2020-06-22 18:39:21 -07:00
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
operation: [
'delete',
],
resource: [
'webinar',
],
},
},
options: [
{
2020-06-23 14:26:00 -07:00
displayName: 'Occurrence ID',
2020-06-23 13:40:43 -07:00
name: 'occurrenceId',
2020-06-22 18:39:21 -07:00
type: 'string',
default: '',
2020-06-23 14:26:00 -07:00
description: 'Webinar occurrence ID.',
2020-06-22 18:39:21 -07:00
},
],
},
/* -------------------------------------------------------------------------- */
/* webinar:update */
/* -------------------------------------------------------------------------- */
{
2020-06-24 11:18:56 -07:00
displayName: 'Webinar ID',
name: 'webinarId',
2020-06-22 18:39:21 -07:00
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
operation: [
'update',
],
resource: [
'webinar',
],
},
},
description: 'User ID or email address of user.',
},
{
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: [
'update',
],
resource: [
'webinar',
],
2020-06-23 20:29:47 -07:00
},
2020-06-22 18:39:21 -07:00
},
options: [
{
displayName: 'Agenda',
name: 'agenda',
type: 'string',
default: '',
description: 'Webinar agenda.',
},
{
displayName: 'Alternative Hosts',
2020-06-24 11:25:07 -07:00
name: 'alternativeHosts',
2020-06-22 18:39:21 -07:00
type: 'string',
default: '',
2020-06-23 14:26:00 -07:00
description: 'Alternative hosts email IDs.',
2020-06-22 18:39:21 -07:00
},
{
2020-06-24 10:47:35 -07:00
displayName: 'Approval Type',
2020-06-24 11:25:07 -07:00
name: 'approvalType',
2020-06-22 18:39:21 -07:00
type: 'options',
options: [
{
2020-06-24 10:47:35 -07:00
name: 'Automatically Approve',
2020-06-22 18:39:21 -07:00
value: 0,
},
{
2020-06-24 10:47:35 -07:00
name: 'Manually Approve',
2020-06-22 18:39:21 -07:00
value: 1,
},
{
2020-06-24 10:47:35 -07:00
name: 'No Registration Required',
2020-06-22 18:39:21 -07:00
value: 2,
},
],
default: 2,
description: 'Approval type.',
},
{
2020-06-24 10:47:35 -07:00
displayName: 'Auto Recording',
2020-06-24 11:25:07 -07:00
name: 'autoRecording',
2020-06-22 18:39:21 -07:00
type: 'options',
options: [
{
2020-06-24 10:47:35 -07:00
name: 'Record on Local',
2020-06-22 18:39:21 -07:00
value: 'local',
},
{
2020-06-24 10:47:35 -07:00
name: 'Record on Cloud',
2020-06-22 18:39:21 -07:00
value: 'cloud',
},
{
name: 'Disabled',
value: 'none',
},
],
default: 'none',
description: 'Auto recording.',
},
{
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 webinar.',
},
2020-06-23 12:14:04 -07:00
{
displayName: 'Duration',
name: 'duration',
type: 'string',
default: '',
description: 'Duration.',
},
{
displayName: 'Host Video',
2020-06-24 11:25:07 -07:00
name: 'hostVideo',
2020-06-23 12:14:04 -07:00
type: 'boolean',
default: false,
description: 'Start video when host joins the webinar.',
},
{
2020-06-23 14:26:00 -07:00
displayName: 'Occurrence ID',
2020-06-24 11:25:07 -07:00
name: 'occurrenceId',
2020-06-23 12:14:04 -07:00
type: 'string',
default: '',
2020-06-23 14:26:00 -07:00
description: `Webinar occurrence ID.`,
2020-06-23 12:14:04 -07:00
},
{
displayName: 'Password',
name: 'password',
type: 'string',
default: '',
description: 'Password to join the webinar with maximum 10 characters.',
},
{
displayName: 'Panelists Video',
2020-06-24 11:25:07 -07:00
name: 'panelistsVideo',
2020-06-23 12:14:04 -07:00
type: 'boolean',
default: false,
description: 'Start video when panelists joins the webinar.',
},
{
displayName: 'Practice Session',
2020-06-24 11:25:07 -07:00
name: 'practiceSession',
2020-06-23 12:14:04 -07:00
type: 'boolean',
default: false,
description: 'Enable Practice session.',
},
2020-06-22 18:39:21 -07:00
{
2020-06-24 10:47:35 -07:00
displayName: 'Registration Type',
2020-06-24 11:25:07 -07:00
name: 'registrationType',
2020-06-22 18:39:21 -07:00
type: 'options',
options: [
{
2020-06-23 13:40:43 -07:00
name: 'Attendees register once and can attend any of the occurrences',
2020-06-22 18:39:21 -07:00
value: 1,
},
{
2020-06-23 13:40:43 -07:00
name: 'Attendees need to register for every occurrence',
2020-06-22 18:39:21 -07:00
value: 2,
},
{
2020-06-23 13:40:43 -07:00
name: 'Attendees register once and can choose one or more occurrences to attend',
2020-06-22 18:39:21 -07:00
value: 3,
},
],
default: 1,
2020-06-23 13:40:43 -07:00
description: 'Registration type. Used for recurring webinars with fixed time only.',
2020-06-22 18:39:21 -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: '',
2020-06-23 13:40:43 -07:00
description: 'Start time should be used only for scheduled or recurring webinar with fixed time.',
2020-06-23 12:14:04 -07:00
},
{
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-24 10:47:35 -07:00
displayName: 'Webinar Topic',
2020-06-23 12:14:04 -07:00
name: 'topic',
type: 'string',
default: '',
description: `Webinar topic.`,
},
{
2020-06-24 10:47:35 -07:00
displayName: 'Webinar Type',
2020-06-23 12:14:04 -07:00
name: 'type',
type: 'options',
options: [
{
name: 'Webinar',
value: 5,
},
{
name: 'Recurring webinar with no fixed time',
value: 6,
},
{
2020-06-24 10:47:35 -07:00
name: 'Recurring webinar with fixed time',
2020-06-23 12:14:04 -07:00
value: 9,
},
],
default: 5,
description: 'Webinar type.'
},
2020-06-22 18:39:21 -07:00
],
},
] as INodeProperties[];