mirror of
https://github.com/Abdulazizzn/n8n-enterprise-unlocked.git
synced 2025-12-17 10:02:05 +00:00
✨ Add Copper node (#1571)
* 🎉 Register regular node * 🎨 Replace PNG with SVG icon * ✨ Add Copper regular node * ⚡ Add user and customer sources * 👕 Appease linter * ⚡ Handle listings in getAll operations * ⚡ Implement continueOnFail * ⚡ Simplify pagination * 🔨 Fix fields adjustments for person * zap: Improvements * ⚡ Minor fixes * ⚡ Fix Lead Email update & Minor improvements Co-authored-by: ricardo <ricardoespinoza105@gmail.com> Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
This commit is contained in:
Iván Ovejero
@@ -1,5 +1,10 @@
|
||||
import { createHash } from 'crypto';
|
||||
import { OptionsWithUri } from 'request';
|
||||
import {
|
||||
createHash,
|
||||
} from 'crypto';
|
||||
|
||||
import {
|
||||
OptionsWithUri,
|
||||
} from 'request';
|
||||
|
||||
import {
|
||||
IExecuteFunctions,
|
||||
@@ -8,16 +13,37 @@ import {
|
||||
ILoadOptionsFunctions,
|
||||
IWebhookFunctions,
|
||||
} from 'n8n-core';
|
||||
|
||||
import {
|
||||
ICredentialDataDecryptedObject,
|
||||
IDataObject,
|
||||
} from 'n8n-workflow';
|
||||
|
||||
export async function copperApiRequest(this: IHookFunctions | IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions | IWebhookFunctions, method: string, resource: string, body: any = {}, qs: IDataObject = {}, uri?: string, option: IDataObject = {}): Promise<any> { // tslint:disable-line:no-any
|
||||
const credentials = this.getCredentials('copperApi');
|
||||
if (credentials === undefined) {
|
||||
throw new Error('No credentials got returned!');
|
||||
}
|
||||
import {
|
||||
flow,
|
||||
omit,
|
||||
} from 'lodash';
|
||||
|
||||
import {
|
||||
AddressFixedCollection,
|
||||
EmailFixedCollection,
|
||||
EmailsFixedCollection,
|
||||
PhoneNumbersFixedCollection,
|
||||
} from './utils/types';
|
||||
|
||||
/**
|
||||
* Make an authenticated API request to Copper.
|
||||
*/
|
||||
export async function copperApiRequest(
|
||||
this: IHookFunctions | IExecuteFunctions | IExecuteSingleFunctions | ILoadOptionsFunctions | IWebhookFunctions,
|
||||
method: string,
|
||||
resource: string,
|
||||
body: IDataObject = {},
|
||||
qs: IDataObject = {},
|
||||
uri = '',
|
||||
option: IDataObject = {},
|
||||
) {
|
||||
const credentials = this.getCredentials('copperApi') as { apiKey: string, email: string };
|
||||
|
||||
let options: OptionsWithUri = {
|
||||
headers: {
|
||||
@@ -29,10 +55,16 @@ export async function copperApiRequest(this: IHookFunctions | IExecuteFunctions
|
||||
method,
|
||||
qs,
|
||||
body,
|
||||
uri: uri ||`https://api.prosperworks.com/developer_api/v1${resource}`,
|
||||
uri: uri || `https://api.prosperworks.com/developer_api/v1${resource}`,
|
||||
json: true,
|
||||
};
|
||||
|
||||
options = Object.assign({}, options, option);
|
||||
|
||||
if (!Object.keys(qs).length) {
|
||||
delete options.qs;
|
||||
}
|
||||
|
||||
if (Object.keys(options.body).length === 0) {
|
||||
delete options.body;
|
||||
}
|
||||
@@ -41,11 +73,11 @@ export async function copperApiRequest(this: IHookFunctions | IExecuteFunctions
|
||||
return await this.helpers.request!(options);
|
||||
} catch (error) {
|
||||
let errorMessage = error.message;
|
||||
if (error.response.body && error.response.body.message) {
|
||||
if (error.response.body?.message) {
|
||||
errorMessage = error.response.body.message;
|
||||
}
|
||||
|
||||
throw new Error('Copper Error: ' + errorMessage);
|
||||
throw new Error(`Copper error response [${error.statusCode}]: ${errorMessage}`);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -61,3 +93,120 @@ export function getAutomaticSecret(credentials: ICredentialDataDecryptedObject)
|
||||
const data = `${credentials.email},${credentials.apiKey}`;
|
||||
return createHash('md5').update(data).digest('hex');
|
||||
}
|
||||
|
||||
export function adjustAddress(fixedCollection: AddressFixedCollection) {
|
||||
if (!fixedCollection.address) return fixedCollection;
|
||||
|
||||
const adjusted: { address?: object } = omit(fixedCollection, ['address']);
|
||||
|
||||
if (fixedCollection.address) {
|
||||
adjusted.address = fixedCollection.address.addressFields;
|
||||
}
|
||||
|
||||
return adjusted;
|
||||
}
|
||||
|
||||
export function adjustPhoneNumbers(fixedCollection: PhoneNumbersFixedCollection) {
|
||||
if (!fixedCollection.phone_numbers) return fixedCollection;
|
||||
|
||||
const adjusted: { phone_numbers?: object } = omit(fixedCollection, ['phone_numbers']);
|
||||
|
||||
if (fixedCollection.phone_numbers) {
|
||||
adjusted.phone_numbers = fixedCollection.phone_numbers.phoneFields;
|
||||
}
|
||||
|
||||
return adjusted;
|
||||
}
|
||||
|
||||
export function adjustEmails(fixedCollection: EmailsFixedCollection) {
|
||||
if (!fixedCollection.emails) return fixedCollection;
|
||||
|
||||
const adjusted: { emails?: object } = omit(fixedCollection, ['emails']);
|
||||
|
||||
if (fixedCollection.emails) {
|
||||
adjusted.emails = fixedCollection.emails.emailFields;
|
||||
}
|
||||
|
||||
return adjusted;
|
||||
}
|
||||
|
||||
export function adjustProjectIds(fields: { project_ids?: string }) {
|
||||
if (!fields.project_ids) return fields;
|
||||
|
||||
const adjusted: { project_ids?: string[] } = omit(fields, ['project_ids']);
|
||||
|
||||
adjusted.project_ids = fields.project_ids.includes(',')
|
||||
? fields.project_ids.split(',')
|
||||
: [fields.project_ids];
|
||||
|
||||
return adjusted;
|
||||
}
|
||||
|
||||
export function adjustEmail(fixedCollection: EmailFixedCollection) {
|
||||
if (!fixedCollection.email) return fixedCollection;
|
||||
|
||||
const adjusted: { email?: object } = omit(fixedCollection, ['email']);
|
||||
|
||||
if (fixedCollection.email) {
|
||||
adjusted.email = fixedCollection.email.emailFields;
|
||||
}
|
||||
|
||||
return adjusted;
|
||||
}
|
||||
|
||||
export const adjustCompanyFields = flow(adjustAddress, adjustPhoneNumbers);
|
||||
export const adjustLeadFields = flow(adjustCompanyFields, adjustEmail);
|
||||
export const adjustPersonFields = flow(adjustCompanyFields, adjustEmails);
|
||||
export const adjustTaskFields = flow(adjustLeadFields, adjustProjectIds);
|
||||
|
||||
/**
|
||||
* Handle a Copper listing by returning all items or up to a limit.
|
||||
*/
|
||||
export async function handleListing(
|
||||
this: IExecuteFunctions,
|
||||
method: string,
|
||||
endpoint: string,
|
||||
qs: IDataObject = {},
|
||||
body: IDataObject = {},
|
||||
uri = '',
|
||||
) {
|
||||
let responseData;
|
||||
|
||||
const returnAll = this.getNodeParameter('returnAll', 0);
|
||||
|
||||
const option = { resolveWithFullResponse: true };
|
||||
|
||||
if (returnAll) {
|
||||
return await copperApiRequestAllItems.call(this, method, endpoint, body, qs, uri, option);
|
||||
}
|
||||
|
||||
const limit = this.getNodeParameter('limit', 0) as number;
|
||||
responseData = await copperApiRequestAllItems.call(this, method, endpoint, body, qs, uri, option);
|
||||
return responseData.slice(0, limit);
|
||||
}
|
||||
|
||||
/**
|
||||
* Make an authenticated API request to Copper and return all items.
|
||||
*/
|
||||
export async function copperApiRequestAllItems(
|
||||
this: IHookFunctions | ILoadOptionsFunctions | IExecuteFunctions,
|
||||
method: string,
|
||||
resource: string,
|
||||
body: IDataObject = {},
|
||||
qs: IDataObject = {},
|
||||
uri = '',
|
||||
option: IDataObject = {},
|
||||
) {
|
||||
let responseData;
|
||||
qs.page_size = 200;
|
||||
let totalItems = 0;
|
||||
const returnData: IDataObject[] = [];
|
||||
|
||||
do {
|
||||
responseData = await copperApiRequest.call(this, method, resource, body, qs, uri, option);
|
||||
totalItems = responseData.headers['x-pw-total'];
|
||||
returnData.push(...responseData.body);
|
||||
} while (totalItems > returnData.length);
|
||||
|
||||
return returnData;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user