n8n/packages/nodes-base/nodes/GoToWebinar/GenericFunctions.ts
Iván Ovejero 0dcaccefa7
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

*  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

*  Small improvement

*  Minor improvements

*  Improvements

*  Minor improvements

Co-authored-by: ricardo <ricardoespinoza105@gmail.com>
Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
2021-02-22 08:49:00 +01:00

287 lines
7.6 KiB
TypeScript

import {
IExecuteFunctions,
IHookFunctions,
} from 'n8n-core';
import {
IDataObject,
ILoadOptionsFunctions,
INodePropertyOptions,
} from 'n8n-workflow';
import {
OptionsWithUri,
} from 'request';
import * as moment from 'moment';
import * as losslessJSON from 'lossless-json';
/**
* Make an authenticated API request to GoToWebinar.
*/
export async function goToWebinarApiRequest(
this: IHookFunctions | IExecuteFunctions | ILoadOptionsFunctions,
method: string,
endpoint: string,
qs: IDataObject,
body: IDataObject | IDataObject[],
option: IDataObject = {},
) {
const operation = this.getNodeParameter('operation', 0) as string;
const resource = this.getNodeParameter('resource', 0) as string;
const options: OptionsWithUri = {
headers: {
'user-agent': 'n8n',
'Accept': 'application/json',
'Content-Type': 'application/json',
},
method,
uri: `https://api.getgo.com/G2W/rest/v2/${endpoint}`,
qs,
body: JSON.stringify(body),
json: false,
};
if (resource === 'session' && operation === 'getAll') {
options.headers!['Accept'] = 'application/vnd.citrix.g2wapi-v1.1+json';
}
if (['GET', 'DELETE'].includes(method)) {
delete options.body;
}
if (!Object.keys(qs).length) {
delete options.qs;
}
if (Object.keys(option)) {
Object.assign(options, option);
}
try {
const response = await this.helpers.requestOAuth2!.call(this, 'goToWebinarOAuth2Api', options, { tokenExpiredStatusCode: 403 });
if (response === '') {
return {};
}
// https://stackoverflow.com/questions/62190724/getting-gotowebinar-registrant
return losslessJSON.parse(response, convertLosslessNumber);
} catch (error) {
if (error?.response?.body) {
let errorMessage;
const body = JSON.parse(error.response.body);
if (Array.isArray(body.validationErrorCodes)) {
errorMessage = (body.validationErrorCodes as IDataObject[]).map((e) => e.description).join('|');
} else {
errorMessage = body.description;
}
throw new Error(`Go To Webinar error response [${error.statusCode}]: ${errorMessage}`);
}
throw error;
}
}
/**
* Make an authenticated API request to GoToWebinar and return all results.
*/
export async function goToWebinarApiRequestAllItems(
this: IHookFunctions | IExecuteFunctions | ILoadOptionsFunctions,
method: string,
endpoint: string,
qs: IDataObject,
body: IDataObject,
resource: string,
) {
const resourceToResponseKey: { [key: string]: string } = {
session: 'sessionInfoResources',
webinar: 'webinars',
};
const key = resourceToResponseKey[resource];
let returnData: IDataObject[] = [];
let responseData;
do {
responseData = await goToWebinarApiRequest.call(this, method, endpoint, qs, body);
if (responseData.page && parseInt(responseData.page.totalElements, 10) === 0) {
return [];
} else if (responseData._embedded && responseData._embedded[key]) {
returnData.push(...responseData._embedded[key]);
} else {
returnData.push(...responseData);
}
if (qs.limit && returnData.length >= qs.limit) {
returnData = returnData.splice(0, qs.limit as number);
return returnData;
}
} while (
responseData.totalElements && parseInt(responseData.totalElements, 10) > returnData.length
);
return returnData;
}
export async function handleGetAll(
this: IExecuteFunctions,
endpoint: string,
qs: IDataObject,
body: IDataObject,
resource: string) {
const returnAll = this.getNodeParameter('returnAll', 0) as boolean;
if (!returnAll) {
qs.limit = this.getNodeParameter('limit', 0) as number;
}
return await goToWebinarApiRequestAllItems.call(this, 'GET', endpoint, qs, body, resource);
}
export async function loadWebinars(this: ILoadOptionsFunctions) {
const { oauthTokenData } = this.getCredentials('goToWebinarOAuth2Api') as {
oauthTokenData: { account_key: string }
};
const endpoint = `accounts/${oauthTokenData.account_key}/webinars`;
const qs = {
fromTime: moment().subtract(1, 'years').format(),
toTime: moment().add(1, 'years').format(),
};
const resourceItems = await goToWebinarApiRequestAllItems.call(this, 'GET', endpoint, qs, {}, 'webinar');
const returnData: INodePropertyOptions[] = [];
resourceItems.forEach((item) => {
returnData.push({
name: item.subject as string,
value: item.webinarKey as string,
});
});
return returnData;
}
export async function loadWebinarSessions(this: ILoadOptionsFunctions) {
const { oauthTokenData } = this.getCredentials('goToWebinarOAuth2Api') as {
oauthTokenData: { organizer_key: string }
};
const webinarKey = this.getCurrentNodeParameter('webinarKey') as string;
const endpoint = `organizers/${oauthTokenData.organizer_key}/webinars/${webinarKey}/sessions`;
const resourceItems = await goToWebinarApiRequestAllItems.call(this, 'GET', endpoint, {}, {}, 'session');
const returnData: INodePropertyOptions[] = [];
resourceItems.forEach((item) => {
returnData.push({
name: `Date: ${moment(item.startTime as string).format('MM-DD-YYYY')} | From: ${moment(item.startTime as string).format('LT')} - To: ${moment(item.endTime as string).format('LT')}`,
value: item.sessionKey as string,
});
});
return returnData;
}
export async function loadRegistranSimpleQuestions(this: ILoadOptionsFunctions) {
const { oauthTokenData } = this.getCredentials('goToWebinarOAuth2Api') as {
oauthTokenData: { organizer_key: string }
};
const webinarkey = this.getNodeParameter('webinarKey') as string;
const endpoint = `organizers/${oauthTokenData.organizer_key}/webinars/${webinarkey}/registrants/fields`;
const { questions } = await goToWebinarApiRequest.call(this, 'GET', endpoint, {}, {});
const returnData: INodePropertyOptions[] = [];
questions.forEach((item: IDataObject) => {
if (item.type === 'shortAnswer') {
returnData.push({
name: item.question as string,
value: item.questionKey as string,
});
}
});
return returnData;
}
export async function loadAnswers(this: ILoadOptionsFunctions) {
const { oauthTokenData } = this.getCredentials('goToWebinarOAuth2Api') as {
oauthTokenData: { organizer_key: string }
};
const webinarKey = this.getCurrentNodeParameter('webinarKey') as string;
const questionKey = this.getCurrentNodeParameter('questionKey') as string;
const endpoint = `organizers/${oauthTokenData.organizer_key}/webinars/${webinarKey}/registrants/fields`;
const { questions } = await goToWebinarApiRequest.call(this, 'GET', endpoint, {}, {});
const returnData: INodePropertyOptions[] = [];
questions.forEach((item: IDataObject) => {
if (item.type === 'multiChoice' && item.questionKey === questionKey) {
for (const answer of item.answers as IDataObject[]) {
returnData.push({
name: answer.answer as string,
value: answer.answerKey as string,
});
}
}
});
return returnData;
}
export async function loadRegistranMultiChoiceQuestions(this: ILoadOptionsFunctions) {
const { oauthTokenData } = this.getCredentials('goToWebinarOAuth2Api') as {
oauthTokenData: { organizer_key: string }
};
const webinarkey = this.getNodeParameter('webinarKey') as string;
const endpoint = `organizers/${oauthTokenData.organizer_key}/webinars/${webinarkey}/registrants/fields`;
const { questions } = await goToWebinarApiRequest.call(this, 'GET', endpoint, {}, {});
const returnData: INodePropertyOptions[] = [];
questions.forEach((item: IDataObject) => {
if (item.type === 'multipleChoice') {
returnData.push({
name: item.question as string,
value: item.questionKey as string,
});
}
});
return returnData;
}
// tslint:disable-next-line: no-any
function convertLosslessNumber(key: any, value: any) {
if (value && value.isLosslessNumber) {
return value.toString();
}
else {
return value;
}
}