n8n/packages/nodes-base/nodes/GoToWebinar/descriptions/RegistrantDescription.ts

476 lines
8.8 KiB
TypeScript
Raw Normal View History

:sparkles: GoToWebinar node (#1422) * Create scaffolding for node * Add SVG logo * Create scaffolding for generic functions * Add index for descriptions * Simplify retrieval of details * Introduce minor fixes in generic functions * Add attendee description * Fix attendee description operation * Add coorganizer description * Add panelist description * Add registrant description * Add session description * Add webinar description * Register node and credentials * Add scaffolding for credentials * Minor creds fixes * Fix SVG icon size and position * Fix capitalization in description * Fix credentials connection * Add attendee fields * Populate webinar description * Remove organizer key from params * Add timezones array constant * Implement webinar:create * Implement webinar:delete * Convert times to fixed collection * Add missing segments to endpoints * Fix webinar:update operation * Implement all-items request * Add params for session:getAll * Add params for webinar:getAll * Implement session:getAll and webinar:getAll * Implement session:get and session:getDetails * Implement coorganizer:create * Implement coorganizer:delete * Implement coorganizer:getAll * Implement coorganizer:delete * Refactor time range for getAll operations * Implement coorganizer:reinvite * Implement panelist:create and panelist:getAll * Implement panelist:delete and panelist:reinvite * Remove array body helper types * Implement registrant:create and registrant:getAll * Implement registrant:delete * Prettify error handling * Add returnAll toggle and limit for all operations * Preload webinars * Preload webinar key in more fields * Refactor getAll as handler * Add descriptions for session * Add descriptions for attendee * Add descriptions for co-organizer * Add descriptions for panelist * Add descriptions for registrant * Add descriptions for webinar * Add 403 check for refresh token * Fix defaults for webinar loader * Add descriptions for webinar types * :zap: Improvements * Remove unneeded return type annotation * Add handler for continue on fail * Remove 403 check in error handler The Go To Webinar API returns 403 for a range of various errors, so this check ended up overriding more specific error messages not related to 403 Forbidden errors. * Remove logging * :zap: Small improvement * :zap: Minor improvements * :zap: Improvements * :zap: Minor improvements Co-authored-by: ricardo <ricardoespinoza105@gmail.com> Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
2021-02-21 23:49:00 -08:00
import {
INodeProperties,
} from 'n8n-workflow';
export const registrantOperations = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
default: 'get',
description: 'Operation to perform',
options: [
{
name: 'Create',
value: 'create',
},
{
name: 'Delete',
value: 'delete',
},
{
name: 'Get',
value: 'get',
},
{
name: 'Get All',
value: 'getAll',
},
],
displayOptions: {
show: {
resource: [
'registrant',
],
},
},
},
] as INodeProperties[];
export const registrantFields = [
// ----------------------------------
// registrant: create
// ----------------------------------
{
displayName: 'Webinar Key',
name: 'webinarKey',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getWebinars',
},
required: true,
default: [],
description: 'Key of the webinar of the registrant to create.',
displayOptions: {
show: {
resource: [
'registrant',
],
operation: [
'create',
],
},
},
},
{
displayName: 'First Name',
name: 'firstName',
type: 'string',
default: '',
description: 'First name of the registrant to create.',
displayOptions: {
show: {
resource: [
'registrant',
],
operation: [
'create',
],
},
},
},
{
displayName: 'Last Name',
name: 'lastName',
type: 'string',
default: '',
description: 'Last name of the registrant to create.',
displayOptions: {
show: {
resource: [
'registrant',
],
operation: [
'create',
],
},
},
},
{
displayName: 'Email',
name: 'email',
type: 'string',
default: '',
description: 'Email address of the registrant to create.',
displayOptions: {
show: {
resource: [
'registrant',
],
operation: [
'create',
],
},
},
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
resource: [
'registrant',
],
operation: [
'create',
],
},
},
default: {},
options: [
{
displayName: 'Full Address',
name: 'fullAddress',
placeholder: 'Add Address Fields',
type: 'fixedCollection',
description: 'Full address of the registrant to create.',
default: {},
options: [
{
displayName: 'Details',
name: 'details',
values: [
{
displayName: 'Address',
name: 'address',
type: 'string',
default: '',
},
{
displayName: 'City',
name: 'city',
type: 'string',
default: '',
},
{
displayName: 'State',
name: 'state',
type: 'string',
default: '',
},
{
displayName: 'Zip Code',
name: 'zipCode',
type: 'string',
default: '',
},
{
displayName: 'Country',
name: 'country',
type: 'string',
default: '',
},
],
},
],
},
{
displayName: 'Industry',
name: 'industry',
type: 'string',
default: '',
description: 'The type of industry the registrant\'s organization belongs to.',
},
{
displayName: 'Job Title',
name: 'jobTitle',
type: 'string',
default: '',
},
{
displayName: 'MultiChoice Responses',
name: 'multiChoiceResponses',
placeholder: 'Add MultiChoice Response',
type: 'fixedCollection',
typeOptions: {
multipleValues: true,
},
description: 'Set the answers to all questions.',
default: {},
options: [
{
displayName: 'Details',
name: 'details',
values: [
{
displayName: 'Question Key',
name: 'questionKey',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getRegistranMultiChoiceQuestions',
loadOptionsDependsOn: [
'webinarKey',
],
},
default: '',
},
{
displayName: 'Answer Key',
name: 'AnswerKey',
type: 'string',
default: '',
description: 'Answer ID of the question.',
},
],
},
],
},
{
displayName: 'Number of Employees',
name: 'numberOfEmployees',
type: 'string',
default: '',
description: 'The size in employees of the registrant\'s organization.',
},
{
displayName: 'Organization',
name: 'organization',
type: 'string',
default: '',
},
{
displayName: 'Telephone',
name: 'phone',
type: 'string',
default: '',
},
{
displayName: 'Purchasing Role',
name: 'purchasingRole',
type: 'string',
default: '',
description: 'Registrant\'s role in purchasing the product.',
},
{
displayName: 'Purchasing Time Frame',
name: 'purchasingTimeFrame',
type: 'string',
default: '',
description: 'Time frame within which the product will be purchased.',
},
{
displayName: 'Questions and Comments',
name: 'questionsAndComments',
type: 'string',
default: '',
description: 'Questions or comments made by the registrant during registration.',
},
{
displayName: 'Resend Confirmation',
name: 'resendConfirmation',
type: 'boolean',
default: false,
},
{
displayName: 'Simple Responses',
name: 'simpleResponses',
placeholder: 'Add Simple Response',
type: 'fixedCollection',
typeOptions: {
multipleValues: true,
},
description: 'Set the answers to all questions.',
default: {},
options: [
{
displayName: 'Details',
name: 'details',
values: [
{
displayName: 'Question Key',
name: 'questionKey',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getRegistranSimpleQuestions',
loadOptionsDependsOn: [
'webinarKey',
],
},
default: '',
},
{
displayName: 'Response Text',
name: 'responseText',
type: 'string',
default: '',
description: 'Text of the response to the question.',
},
],
},
],
},
{
displayName: 'Source',
name: 'source',
type: 'string',
default: '',
description: 'The source that led to the registration.',
},
],
},
// ----------------------------------
// registrant: getAll
// ----------------------------------
{
displayName: 'Webinar Key',
name: 'webinarKey',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getWebinars',
},
required: true,
default: [],
description: 'The key of the webinar to retrieve registrants from.',
displayOptions: {
show: {
resource: [
'registrant',
],
operation: [
'getAll',
],
},
},
},
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
default: false,
description: 'Return all results.',
displayOptions: {
show: {
resource: [
'registrant',
],
operation: [
'getAll',
],
},
},
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
default: 10,
description: 'The number of results to return.',
typeOptions: {
minValue: 1,
maxValue: 100,
},
displayOptions: {
show: {
resource: [
'registrant',
],
operation: [
'getAll',
],
returnAll: [
false,
],
},
},
},
// ----------------------------------
// registrant: delete
// ----------------------------------
{
displayName: 'Webinar Key',
name: 'webinarKey',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getWebinars',
},
required: true,
default: [],
description: 'Key of the webinar of the registrant to delete.',
displayOptions: {
show: {
resource: [
'registrant',
],
operation: [
'delete',
],
},
},
},
{
displayName: 'Registrant Key',
name: 'registrantKey',
type: 'string',
required: true,
default: '',
description: 'Key of the registrant to delete.',
displayOptions: {
show: {
resource: [
'registrant',
],
operation: [
'delete',
],
},
},
},
// ----------------------------------
// registrant: get
// ----------------------------------
{
displayName: 'Webinar Key',
name: 'webinarKey',
type: 'options',
typeOptions: {
loadOptionsMethod: 'getWebinars',
},
required: true,
default: [],
description: 'Key of the webinar of the registrant to retrieve.',
displayOptions: {
show: {
resource: [
'registrant',
],
operation: [
'get',
],
},
},
},
{
displayName: 'Registrant Key',
name: 'registrantKey',
type: 'string',
required: true,
default: '',
description: 'Key of the registrant to retrieve.',
displayOptions: {
show: {
resource: [
'registrant',
],
operation: [
'get',
],
},
},
},
] as INodeProperties[];