mirror of
https://github.com/Abdulazizzn/n8n-enterprise-unlocked.git
synced 2025-12-20 03:12:15 +00:00
✨ Add HaloPSA node (#2620)
* added node ui * wip problems with auth * updated authentication * fixed linter error * added haloPSA request function * removed any return type * fixed linter errors * added CRUD functionalities * updating branch from master * updated create case for clients resource, added limit to getAll operation * added required fields when creating clients and sites, added methods for fetching data to dynamicly populate options when creating site or client * added required fields for users and invoices when operation is create * 🔨 Removed some commented code * 🐛 Fix bug in url formating * 🔨 fixed plural resources, fixed main for loop * 🔨 fix trailing coma * 🔨 fix for wrong resource endpoints * 🔨 fixed linter complain in Jenkings node * 🔨 replace custom fields with predefined * 🔨 updating resources optional fields * ⚡ Small improvement * 🔨 replaced fixedCollection to collection in resources description * 🔨 updated site and ticket descriptions, code clean up * 🔨 fixed accordingly to PR review * ⚡ Improvements * ⚡ Improvements * ⚡ Fix capitalization * 👕 Fix trailing comma * 🚧 node changes accordingly to review * ⚡ lint errors fix * ⚡ Activate simplify option by default * ⚡ Fix some more issues Co-authored-by: ricardo <ricardoespinoza105@gmail.com> Co-authored-by: Iván Ovejero <ivov.src@gmail.com> Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
This commit is contained in:
Michael Kret
252
packages/nodes-base/nodes/HaloPSA/GenericFunctions.ts
Normal file
252
packages/nodes-base/nodes/HaloPSA/GenericFunctions.ts
Normal file
@@ -0,0 +1,252 @@
|
||||
import { IExecuteFunctions, IHookFunctions } from 'n8n-core';
|
||||
|
||||
import {
|
||||
ICredentialDataDecryptedObject,
|
||||
ICredentialTestFunctions,
|
||||
IDataObject,
|
||||
IExecuteSingleFunctions,
|
||||
ILoadOptionsFunctions,
|
||||
IPollFunctions,
|
||||
JsonObject,
|
||||
NodeApiError,
|
||||
} from 'n8n-workflow';
|
||||
|
||||
import { OptionsWithUri } from 'request';
|
||||
|
||||
// Interfaces and Types -------------------------------------------------------------
|
||||
interface IHaloPSATokens {
|
||||
scope: string;
|
||||
token_type: string;
|
||||
access_token: string;
|
||||
expires_in: number;
|
||||
refresh_token: string;
|
||||
id_token: string;
|
||||
}
|
||||
|
||||
// API Requests ---------------------------------------------------------------------
|
||||
|
||||
export async function getAccessTokens(
|
||||
this: IExecuteFunctions | ILoadOptionsFunctions,
|
||||
): Promise<IHaloPSATokens> {
|
||||
const credentials = (await this.getCredentials('haloPSAApi')) as IDataObject;
|
||||
|
||||
const options: OptionsWithUri = {
|
||||
headers: {
|
||||
'Content-Type': 'application/x-www-form-urlencoded',
|
||||
},
|
||||
method: 'POST',
|
||||
form: {
|
||||
client_id: credentials.client_id,
|
||||
client_secret: credentials.client_secret,
|
||||
grant_type: 'client_credentials',
|
||||
scope: credentials.scope,
|
||||
},
|
||||
uri: getAuthUrl(credentials),
|
||||
json: true,
|
||||
};
|
||||
|
||||
try {
|
||||
const tokens = await this.helpers.request!(options);
|
||||
return tokens;
|
||||
} catch (error) {
|
||||
throw new NodeApiError(this.getNode(), error as JsonObject);
|
||||
}
|
||||
}
|
||||
|
||||
export async function haloPSAApiRequest(
|
||||
this:
|
||||
| IHookFunctions
|
||||
| IExecuteFunctions
|
||||
| IExecuteSingleFunctions
|
||||
| ILoadOptionsFunctions
|
||||
| IPollFunctions,
|
||||
method: string,
|
||||
resource: string,
|
||||
accessToken: string,
|
||||
body: IDataObject | IDataObject[] = {},
|
||||
qs: IDataObject = {},
|
||||
option: IDataObject = {},
|
||||
): Promise<any> { // tslint:disable-line:no-any
|
||||
const resourceApiUrl = ((await this.getCredentials('haloPSAApi')) as IDataObject)
|
||||
.resourceApiUrl as string;
|
||||
|
||||
try {
|
||||
let options: OptionsWithUri = {
|
||||
headers: {
|
||||
Authorization: `Bearer ${accessToken}`,
|
||||
'User-Agent': 'https://n8n.io',
|
||||
Connection: 'keep-alive',
|
||||
Accept: '*/*',
|
||||
'Accept-Encoding': 'gzip, deflate, br',
|
||||
'Content-Type': 'application/json',
|
||||
},
|
||||
method,
|
||||
qs,
|
||||
body,
|
||||
uri: `${resourceApiUrl}${resource}`,
|
||||
json: true,
|
||||
};
|
||||
options = Object.assign({}, options, option);
|
||||
if (Object.keys(body).length === 0) {
|
||||
delete options.body;
|
||||
}
|
||||
const result = await this.helpers.request!(options);
|
||||
if (method === 'DELETE' && result.id) {
|
||||
return { success: true };
|
||||
}
|
||||
return result;
|
||||
} catch (error) {
|
||||
const message = (error as JsonObject).message as string;
|
||||
if (method === 'DELETE' || 'GET' || ('UPDATE' && message)) {
|
||||
let newErrorMessage;
|
||||
if (message.includes('400')) {
|
||||
console.log(message);
|
||||
newErrorMessage = JSON.parse(message.split(' - ')[1]);
|
||||
(error as JsonObject).message = `For field ID, ${
|
||||
newErrorMessage.id || newErrorMessage['[0].id']
|
||||
}`;
|
||||
}
|
||||
if (message.includes('403')) {
|
||||
(
|
||||
error as JsonObject
|
||||
).message = `You don\'t have permissions to ${method.toLowerCase()} ${resource
|
||||
.split('/')[1]
|
||||
.toLowerCase()}.`;
|
||||
}
|
||||
}
|
||||
throw new NodeApiError(this.getNode(), error as JsonObject);
|
||||
}
|
||||
}
|
||||
|
||||
// export async function reasignTickets(
|
||||
// this:
|
||||
// | IHookFunctions
|
||||
// | IExecuteFunctions
|
||||
// | IExecuteSingleFunctions
|
||||
// | ILoadOptionsFunctions
|
||||
// | IPollFunctions,
|
||||
// clientId: string,
|
||||
// reasigmentCliendId: string,
|
||||
// accessToken: string,
|
||||
// ): Promise<any> {
|
||||
// const response = (await haloPSAApiRequest.call(
|
||||
// this,
|
||||
// 'GET',
|
||||
// `/tickets`,
|
||||
// accessToken,
|
||||
// {},
|
||||
// { client_id: reasigmentCliendId },
|
||||
// )) as IDataObject;
|
||||
|
||||
// const { tickets } = response;
|
||||
// console.log((tickets as IDataObject[]).map(t => t.id));
|
||||
// const body: IDataObject = {
|
||||
// id: clientId,
|
||||
// client_id: reasigmentCliendId,
|
||||
// };
|
||||
|
||||
// for (const ticket of (tickets as IDataObject[])) {
|
||||
// console.log(ticket.id);
|
||||
// await haloPSAApiRequest.call(this, 'DELETE', `/tickets/${ticket.id}`, accessToken);
|
||||
// }
|
||||
// }
|
||||
|
||||
export async function haloPSAApiRequestAllItems(
|
||||
this: IExecuteFunctions | ILoadOptionsFunctions | IHookFunctions,
|
||||
propertyName: string,
|
||||
method: string,
|
||||
endpoint: string,
|
||||
accessToken: string,
|
||||
body = {},
|
||||
query: IDataObject = {},
|
||||
): Promise<any> { // tslint:disable-line:no-any
|
||||
|
||||
const returnData: IDataObject[] = [];
|
||||
|
||||
let responseData: IDataObject;
|
||||
query.page_size = 100;
|
||||
query.page_no = 1;
|
||||
query.pageinate = true;
|
||||
|
||||
do {
|
||||
responseData = (await haloPSAApiRequest.call(
|
||||
this,
|
||||
method,
|
||||
endpoint,
|
||||
accessToken,
|
||||
body,
|
||||
query,
|
||||
)) as IDataObject;
|
||||
returnData.push.apply(returnData, responseData[propertyName] as IDataObject[]);
|
||||
query.page_no++;
|
||||
//@ts-ignore
|
||||
} while (returnData.length < responseData.record_count);
|
||||
|
||||
return returnData;
|
||||
}
|
||||
|
||||
// Utilities ------------------------------------------------------------------------
|
||||
function getAuthUrl(credentials: IDataObject) {
|
||||
return credentials.hostingType === 'on-premise'
|
||||
? `${credentials.appUrl}/auth/token`
|
||||
: `${credentials.authUrl}/token?tenant=${credentials.tenant}`;
|
||||
}
|
||||
|
||||
export function simplifyHaloPSAGetOutput(
|
||||
response: IDataObject[],
|
||||
fieldsList: string[],
|
||||
): IDataObject[] {
|
||||
const output = [];
|
||||
for (const item of response) {
|
||||
const simplifiedItem: IDataObject = {};
|
||||
Object.keys(item).forEach((key: string) => {
|
||||
if (fieldsList.includes(key)) {
|
||||
simplifiedItem[key] = item[key];
|
||||
}
|
||||
});
|
||||
output.push(simplifiedItem);
|
||||
}
|
||||
return output;
|
||||
}
|
||||
|
||||
export function qsSetStatus(status: string) {
|
||||
if (!status) return {};
|
||||
const qs: IDataObject = {};
|
||||
if (status === 'all') {
|
||||
qs['includeinactive'] = true;
|
||||
qs['includeactive'] = true;
|
||||
} else if (status === 'active') {
|
||||
qs['includeinactive'] = false;
|
||||
qs['includeactive'] = true;
|
||||
} else {
|
||||
qs['includeinactive'] = true;
|
||||
qs['includeactive'] = false;
|
||||
}
|
||||
return qs;
|
||||
}
|
||||
|
||||
// Validation -----------------------------------------------------------------------
|
||||
|
||||
export async function validateCrendetials(
|
||||
this: ICredentialTestFunctions,
|
||||
decryptedCredentials: ICredentialDataDecryptedObject,
|
||||
): Promise<IHaloPSATokens> {
|
||||
const credentials = decryptedCredentials;
|
||||
|
||||
const options: OptionsWithUri = {
|
||||
headers: {
|
||||
'Content-Type': 'application/x-www-form-urlencoded',
|
||||
},
|
||||
method: 'POST',
|
||||
form: {
|
||||
client_id: credentials.client_id,
|
||||
client_secret: credentials.client_secret,
|
||||
grant_type: 'client_credentials',
|
||||
scope: credentials.scope,
|
||||
},
|
||||
uri: getAuthUrl(credentials),
|
||||
json: true,
|
||||
};
|
||||
|
||||
return (await this.helpers.request!(options)) as IHaloPSATokens;
|
||||
}
|
||||
Reference in New Issue
Block a user