Add Syncromsp node (#2477)

* Init Node

* Added get customer details api for syncomsp-node

* Fixed formatting bug 🐛

* Updated description for query params, and removed redundant condition in router

* Changed default value for page parameter

* 🚢 Added tickets API

* 🚢 Added contacts API

* 🚢 Added RMM Alerts API

* Add customer API

* Updates post code review

* Rename SyncroMspAPI.credentials.ts to SyncroMspApi.credentials.ts

* added create and delete method to customers module

* fix liniting issue

* Added Update method to customer module

* Code Review Changes

* 🚢 Added CRUD for contacts endpoint

* 🚢 Added CRUD for RMM Alert endpoint

* Added options for status field

* 🐛 fix linting issues

* Init Node

* Added get customer details api for syncomsp-node

* Fixed formatting bug 🐛

* Updated description for query params, and removed redundant condition in router

* Changed default value for page parameter

* 🚢 Added tickets API

* 🚢 Added contacts API

* 🚢 Added RMM Alerts API

* Updates post code review

* Add customer API

* added create and delete method to customers module

* fix liniting issue

* Added Update method to customer module

* Rename SyncroMspAPI.credentials.ts to SyncroMspApi.credentials.ts

* Code Review Changes

* 🚢 Added CRUD for contacts endpoint

* 🚢 Added CRUD for RMM Alert endpoint

* Added options for status field

* 🐛 fix linting issues

* 🚢 Added CRUD for ticket endpoint

* :tag: update get customer module

* :tag: update get customer module

* Minor bug fixes

* Changed response for ticket update

* 👕 Fix lint issue

* Alphabetically ordered all options

* 🐛 Fixed build issue

* 🐛 Fixed Server.ts build issue, rebased from master

*  Fix node issues

*  Fix more issues

*  Fixed all operations with the standard convention

* 👕 Fix lint

* Fix reviewed changes

* update border color

*  minor fixes

* minor fixes

* Added fallback when port in use

*  Minor Fixes

*  Hide addtional paramerts when return all is active

*  Fix issues with Tickets

*  Fix issues with Rmm

*  Fix issues with Customer

* 👕 Fix lint

*  Fix issues with Contact

* 👕 Fixed formatting issue

*  Return 404 in ID not found

* 👕 Fixed formatting issue

*  Improvements

*  Improvements

*  Improvements

*  Add credentials verification

*  Improvements

*  Improvements

*  Additional improvements

Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
Co-authored-by: ricardo <ricardoespinoza105@gmail.com>
This commit is contained in:
Anuj Kapoor 2022-01-07 22:49:24 +05:30 committed by GitHub
parent 57016624b8
commit 214dd5061e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
78 changed files with 2915 additions and 0 deletions

View file

@ -0,0 +1,24 @@
import {
ICredentialType,
INodeProperties,
} from 'n8n-workflow';
export class SyncroMspApi implements ICredentialType {
name = 'syncroMspApi';
displayName = 'SyncroMSP API';
documentationUrl = 'syncromsp';
properties: INodeProperties[] = [
{
displayName: 'API Key',
name: 'apiKey',
type: 'string',
default: '',
},
{
displayName: 'Subdomain',
name: 'subdomain',
type: 'string',
default: '',
},
];
}

View file

@ -0,0 +1,28 @@
import {
INodeTypeBaseDescription,
INodeVersionedType,
} from 'n8n-workflow';
import { NodeVersionedType } from '../../src/NodeVersionedType';
import { SyncroMspV1 } from './v1/SyncroMspV1.node';
export class SyncroMsp extends NodeVersionedType {
constructor() {
const baseDescription: INodeTypeBaseDescription = {
displayName: 'SyncroMSP',
name: 'syncroMsp',
icon: 'file:syncromsp.png',
group: ['output'],
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
description: 'Manage contacts, tickets and more from Syncro MSP',
defaultVersion: 1,
};
const nodeVersions: INodeVersionedType['nodeVersions'] = {
1: new SyncroMspV1(baseDescription),
};
super(nodeVersions, baseDescription);
}
}

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.2 KiB

View file

@ -0,0 +1,57 @@
import {
IExecuteFunctions,
} from 'n8n-core';
import {
ICredentialDataDecryptedObject,
ICredentialsDecrypted,
ICredentialTestFunctions,
INodeType,
INodeTypeBaseDescription,
INodeTypeDescription,
NodeCredentialTestResult,
} from 'n8n-workflow';
import { versionDescription } from './actions/versionDescription';
import { loadOptions } from './methods';
import { router } from './actions/router';
import { validateCredentials } from './transport';
export class SyncroMspV1 implements INodeType {
description: INodeTypeDescription;
constructor(baseDescription: INodeTypeBaseDescription) {
this.description = {
...baseDescription,
...versionDescription,
};
}
methods = {
loadOptions,
credentialTest: {
async syncroMspApiCredentialTest(this: ICredentialTestFunctions, credential: ICredentialsDecrypted): Promise<NodeCredentialTestResult> {
try {
await validateCredentials.call(this, credential.data as ICredentialDataDecryptedObject);
} catch (error) {
if (error.statusCode === 401) {
return {
status: 'Error',
message: 'The API Key included in the request is invalid',
};
}
}
return {
status: 'OK',
message: 'Connection successful!',
};
},
},
};
async execute(this: IExecuteFunctions) {
return await router.call(this);
}
}

View file

@ -0,0 +1,33 @@
import {
AllEntities,
Entity,
PropertiesOf,
} from 'n8n-workflow';
type SyncroMspMap = {
contact: 'create'|'delete'|'get'|'getAll'|'update';
customer: 'create'|'delete'|'get'|'getAll'|'update';
rmm: 'create'|'delete'|'get'|'getAll'|'mute' ;
ticket: 'create'|'delete'|'get'|'getAll'|'update';
};
export type SyncroMsp = AllEntities<SyncroMspMap>;
export type SyncroMspMapContact = Entity<SyncroMspMap, 'contact'>;
export type SyncroMspMapCustomer = Entity<SyncroMspMap, 'customer'>;
export type SyncroMspMapRmm = Entity<SyncroMspMap, 'rmm'>;
export type SyncroMspMapTicket = Entity<SyncroMspMap, 'ticket'>;
export type ContactProperties = PropertiesOf<SyncroMspMapContact>;
export type CustomerProperties = PropertiesOf<SyncroMspMapCustomer>;
export type RmmProperties = PropertiesOf<SyncroMspMapRmm>;
export type TicketProperties = PropertiesOf<SyncroMspMapTicket>;
export interface IAttachment {
fields: {
item?: object[];
};
actions: {
item?: object[];
};
}

View file

@ -0,0 +1,81 @@
import {
ContactProperties,
} from '../../Interfaces';
import {
addressFixedCollection
} from '../../../methods/sharedFields';
export const contactCreateDescription: ContactProperties = [
{
displayName: 'Customer ID',
name: 'customerId',
type: 'string',
required: true,
displayOptions: {
show: {
resource: [
'contact',
],
operation: [
'create',
],
},
},
default: '',
},
{
displayName: 'Email',
name: 'email',
type: 'string',
displayOptions: {
show: {
resource: [
'contact',
],
operation: [
'create',
],
},
},
default: '',
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
resource: [
'contact',
],
operation: [
'create',
],
},
},
default: {},
options: [
addressFixedCollection,
{
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
},
{
displayName: 'Notes',
name: 'notes',
type: 'string',
default: '',
},
{
displayName: 'Phone',
name: 'phone',
type: 'string',
default: '',
},
],
},
];

View file

@ -0,0 +1,44 @@
import {
IExecuteFunctions,
} from 'n8n-core';
import {
IDataObject,
INodeExecutionData,
} from 'n8n-workflow';
import {
apiRequest,
} from '../../../transport';
export async function createContact(this: IExecuteFunctions, index: number): Promise<INodeExecutionData[]> {
const id = this.getNodeParameter('customerId', index) as IDataObject;
const email = this.getNodeParameter('email', index) as IDataObject;
const { address, notes, phone, name } = this.getNodeParameter('additionalFields', index) as IDataObject;
const qs = {} as IDataObject;
const requestMethod = 'POST';
const endpoint = 'contacts';
let body = {} as IDataObject;
let addressData = address as IDataObject;
if (addressData) {
addressData = addressData['addressFields'] as IDataObject;
addressData.address1 = addressData.address;
}
body = {
...addressData,
customer_id: id,
email,
name,
notes,
phone,
};
let responseData;
responseData = await apiRequest.call(this, requestMethod, endpoint, body, qs);
return this.helpers.returnJsonArray(responseData);
}

View file

@ -0,0 +1,7 @@
import { createContact as execute } from './execute';
import { contactCreateDescription as description } from './description';
export {
description,
execute,
};

View file

@ -0,0 +1,24 @@
import {
ContactProperties,
} from '../../Interfaces';
export const contactDeleteDescription: ContactProperties = [
{
displayName: 'Contact ID',
name: 'contactId',
type: 'string',
required: true,
displayOptions: {
show: {
resource: [
'contact',
],
operation: [
'delete',
],
},
},
default: '',
description: 'Delete a specific contact by ID',
},
];

View file

@ -0,0 +1,26 @@
import {
IExecuteFunctions,
} from 'n8n-core';
import {
IDataObject,
INodeExecutionData,
} from 'n8n-workflow';
import {
apiRequest
} from '../../../transport';
export async function deleteContact(this: IExecuteFunctions, index: number): Promise<INodeExecutionData[]> {
const id = this.getNodeParameter('contactId', index) as string;
const qs = {} as IDataObject;
const requestMethod = 'DELETE';
const endpoint = `contacts/${id}`;
const body = {} as IDataObject;
let responseData;
responseData = await apiRequest.call(this, requestMethod, endpoint, body, qs);
return this.helpers.returnJsonArray(responseData);
}

View file

@ -0,0 +1,7 @@
import { deleteContact as execute } from './execute';
import { contactDeleteDescription as description } from './description';
export {
description,
execute,
};

View file

@ -0,0 +1,24 @@
import {
ContactProperties,
} from '../../Interfaces';
export const contactGetDescription: ContactProperties = [
{
displayName: 'Contact ID',
name: 'contactId',
type: 'string',
required: true,
displayOptions: {
show: {
resource: [
'contact',
],
operation: [
'get',
],
},
},
default: '',
description: 'Get specific contact by ID',
},
];

View file

@ -0,0 +1,26 @@
import {
IExecuteFunctions,
} from 'n8n-core';
import {
IDataObject,
INodeExecutionData,
} from 'n8n-workflow';
import {
apiRequest
} from '../../../transport';
export async function getContact(this: IExecuteFunctions, index: number): Promise<INodeExecutionData[]> {
const id = this.getNodeParameter('contactId', index) as string;
const qs = {} as IDataObject;
const requestMethod = 'GET';
const endpoint = `contacts/${id}`;
const body = {} as IDataObject;
let responseData;
responseData = await apiRequest.call(this, requestMethod, endpoint, body, qs);
return this.helpers.returnJsonArray(responseData);
}

View file

@ -0,0 +1,7 @@
import { getContact as execute } from './execute';
import { contactGetDescription as description } from './description';
export {
description,
execute,
};

View file

@ -0,0 +1,43 @@
import {
ContactProperties,
} from '../../Interfaces';
export const contactGetAllDescription: ContactProperties = [
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
displayOptions: {
show: {
resource: [
'contact',
],
operation: [
'getAll',
],
},
},
noDataExpression: true,
default: false,
description: 'If all results should be returned or only up to a given limit',
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
displayOptions: {
show: {
resource: [
'contact',
],
operation: [
'getAll',
],
returnAll: [
false,
],
},
},
default: 25,
},
];

View file

@ -0,0 +1,31 @@
import {
IExecuteFunctions,
} from 'n8n-core';
import {
IDataObject,
INodeExecutionData,
} from 'n8n-workflow';
import {
apiRequest, apiRequestAllItems
} from '../../../transport';
export async function getAll(this: IExecuteFunctions, index: number): Promise<INodeExecutionData[]> {
const returnAll = this.getNodeParameter('returnAll', index) as boolean;
const qs = {} as IDataObject;
const requestMethod = 'GET';
const endpoint = 'contacts';
const body = {} as IDataObject;
let responseData;
if (returnAll) {
responseData = await apiRequestAllItems.call(this, requestMethod, endpoint, body, qs);
return this.helpers.returnJsonArray(responseData);
} else {
const limit = this.getNodeParameter('limit', index) as IDataObject;
responseData = await apiRequest.call(this, requestMethod, endpoint, body, qs);
return this.helpers.returnJsonArray((responseData.contacts).splice(0, limit));
}
}

View file

@ -0,0 +1,7 @@
import { getAll as execute } from './execute';
import { contactGetAllDescription as description } from './description';
export {
description,
execute,
};

View file

@ -0,0 +1,66 @@
import * as getAll from './getAll';
import * as create from './create';
import * as get from './get';
import * as update from './update';
import * as del from './del';
import { INodeProperties } from 'n8n-workflow';
export {
getAll,
create,
del as delete,
update,
get,
};
export const descriptions = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'contact',
],
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create new contact',
},
{
name: 'Delete',
value: 'delete',
description: 'Delete contact',
},
{
name: 'Get',
value: 'get',
description: 'Retrieve contact',
},
{
name: 'Get All',
value: 'getAll',
description: 'Retrieve all contacts',
},
{
name: 'Update',
value: 'update',
description: 'Update contact',
},
],
default: 'getAll',
description: '',
},
...getAll.description,
...create.description,
...get.description,
...update.description,
...del.description,
] as INodeProperties[];

View file

@ -0,0 +1,76 @@
import {
ContactProperties,
} from '../../Interfaces';
import {
addressFixedCollection
} from '../../../methods/sharedFields';
export const contactUpdateDescription: ContactProperties = [
{
displayName: 'Contact ID',
name: 'contactId',
type: 'string',
displayOptions: {
show: {
resource: [
'contact',
],
operation: [
'update',
],
},
},
default: '',
},
{
displayName: 'Update Fields',
name: 'updateFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
resource: [
'contact',
],
operation: [
'update',
],
},
},
default: {},
options: [
addressFixedCollection,
{
displayName: 'Customer ID',
name: 'customerId',
type: 'string',
default: '',
},
{
displayName: 'Email',
name: 'email',
type: 'string',
default: '',
},
{
displayName: 'Name',
name: 'name',
type: 'string',
default: '',
},
{
displayName: 'Notes',
name: 'notes',
type: 'string',
default: '',
},
{
displayName: 'Phone',
name: 'phone',
type: 'string',
default: '',
},
],
},
];

View file

@ -0,0 +1,44 @@
import {
IExecuteFunctions,
} from 'n8n-core';
import {
IDataObject,
INodeExecutionData,
} from 'n8n-workflow';
import {
apiRequest,
} from '../../../transport';
export async function updateContact(this: IExecuteFunctions, index: number): Promise<INodeExecutionData[]> {
const id = this.getNodeParameter('contactId', index) as IDataObject;
const { address, customerId, email, name, notes, phone } = this.getNodeParameter('updateFields', index) as IDataObject;
const qs = {} as IDataObject;
const requestMethod = 'PUT';
const endpoint = `contacts/${id}`;
let body = {} as IDataObject;
let addressData = address as IDataObject;
if (addressData) {
addressData = addressData['addressFields'] as IDataObject;
addressData.address1 = addressData.address;
}
body = {
...addressData,
contact_id: id,
customer_id: customerId,
email,
name,
notes,
phone,
};
let responseData;
responseData = await apiRequest.call(this, requestMethod, endpoint, body, qs);
return this.helpers.returnJsonArray(responseData);
}

View file

@ -0,0 +1,7 @@
import { updateContact as execute } from './execute';
import { contactUpdateDescription as description } from './description';
export {
description,
execute,
};

View file

@ -0,0 +1,118 @@
import {
CustomerProperties,
} from '../../Interfaces';
import {
addressFixedCollection
} from '../../../methods/sharedFields';
export const customerCreateDescription: CustomerProperties = [
{
displayName: 'Email',
name: 'email',
type: 'string',
displayOptions: {
show: {
resource: [
'customer',
],
operation: [
'create',
],
},
},
default: '',
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
resource: [
'customer',
],
operation: [
'create',
],
},
},
default: {},
options: [
addressFixedCollection,
{
displayName: 'Business Name',
name: 'businessName',
type: 'string',
default: '',
},
{
displayName: 'First Name',
name: 'firstName',
type: 'string',
default: '',
},
{
displayName: 'Get SMS',
name: 'getSms',
type: 'boolean',
default: false,
},
{
displayName: 'Invoice Emails',
name: 'invoiceCcEmails',
type: 'string',
typeOptions: {
multipleValues: true,
multipleValueButtonText: 'Add Email',
},
default: '',
},
{
displayName: 'Last Name',
name: 'lastname',
type: 'string',
default: '',
},
{
displayName: 'No Email',
name: 'noEmail',
type: 'boolean',
default: false,
},
{
displayName: 'Notes',
name: 'notes',
type: 'string',
default: '',
},
{
displayName: 'Notification Email',
name: 'notificationEmail',
type: 'string',
default: '',
displayOptions: {
show: {
noEmail: [
false,
],
},
},
},
{
displayName: 'Phone',
name: 'phone',
type: 'string',
default: '',
},
{
displayName: 'Referred By',
name: 'referredBy',
type: 'string',
default: '',
description: 'Source from which customer is referred to the platform like Linkedin, Google, Customer name etc.',
},
],
},
];

View file

@ -0,0 +1,48 @@
import {
IExecuteFunctions,
} from 'n8n-core';
import {
IDataObject,
INodeExecutionData,
} from 'n8n-workflow';
import {
apiRequest,
} from '../../../transport';
export async function addCustomer(this: IExecuteFunctions, index: number): Promise<INodeExecutionData[]> {
const email = this.getNodeParameter('email', index) as IDataObject;
const { address, getSms, businessName, lastname, firstName, invoiceCcEmails, noEmail, notes, notificationEmail, phone, referredBy } = this.getNodeParameter('additionalFields', index) as IDataObject;
const qs = {} as IDataObject;
const requestMethod = 'POST';
const endpoint = 'customers';
let body = {} as IDataObject;
let addressData = address as IDataObject;
if (addressData) {
addressData = addressData['addressFields'] as IDataObject;
addressData.address_2 = addressData.address2;
}
body = {
...addressData,
business_name: businessName,
email,
firstname: firstName,
get_sms: getSms,
invoice_cc_emails: (invoiceCcEmails as string[] || []).join(','),
lastname,
no_email: noEmail,
notes,
notification_email: notificationEmail,
phone,
referred_by: referredBy,
};
let responseData;
responseData = await apiRequest.call(this, requestMethod, endpoint, body, qs);
return this.helpers.returnJsonArray(responseData.customer);
}

View file

@ -0,0 +1,7 @@
import { addCustomer as execute } from './execute';
import { customerCreateDescription as description } from './description';
export {
description,
execute,
};

View file

@ -0,0 +1,24 @@
import {
CustomerProperties,
} from '../../Interfaces';
export const customerDeleteDescription: CustomerProperties = [
{
displayName: 'Customer ID',
name: 'customerId',
type: 'string',
required: true,
displayOptions: {
show: {
resource: [
'customer',
],
operation: [
'delete',
],
},
},
default: '',
description: 'Delete a specific customer by ID',
},
];

View file

@ -0,0 +1,26 @@
import {
IExecuteFunctions,
} from 'n8n-core';
import {
IDataObject,
INodeExecutionData,
} from 'n8n-workflow';
import {
apiRequest
} from '../../../transport';
export async function deleteCustomer(this: IExecuteFunctions, index: number): Promise<INodeExecutionData[]> {
const id = this.getNodeParameter('customerId', index) as string;
const qs = {} as IDataObject;
const requestMethod = 'DELETE';
const endpoint = `customers/${id}`;
const body = {} as IDataObject;
let responseData;
responseData = await apiRequest.call(this, requestMethod, endpoint, body, qs);
return this.helpers.returnJsonArray(responseData);
}

View file

@ -0,0 +1,7 @@
import { deleteCustomer as execute } from './execute';
import { customerDeleteDescription as description } from './description';
export {
description,
execute,
};

View file

@ -0,0 +1,24 @@
import {
CustomerProperties,
} from '../../Interfaces';
export const customerGetDescription: CustomerProperties = [
{
displayName: 'Cutomer ID',
name: 'customerId',
type: 'string',
required: true,
displayOptions: {
show: {
resource: [
'customer',
],
operation: [
'get',
],
},
},
default: '',
description: 'Get specific customer by ID',
},
];

View file

@ -0,0 +1,26 @@
import {
IExecuteFunctions,
} from 'n8n-core';
import {
IDataObject,
INodeExecutionData,
} from 'n8n-workflow';
import {
apiRequest
} from '../../../transport';
export async function getCustomer(this: IExecuteFunctions, index: number): Promise<INodeExecutionData[]> {
const id = this.getNodeParameter('customerId', index) as string;
const qs = {} as IDataObject;
const requestMethod = 'GET';
const endpoint = `customers/${id}`;
const body = {} as IDataObject;
let responseData;
responseData = await apiRequest.call(this, requestMethod, endpoint, body, qs);
return this.helpers.returnJsonArray(responseData.customer);
}

View file

@ -0,0 +1,7 @@
import { getCustomer as execute } from './execute';
import { customerGetDescription as description } from './description';
export {
description,
execute,
};

View file

@ -0,0 +1,109 @@
import {
CustomerProperties,
} from '../../Interfaces';
export const customerGetAllDescription: CustomerProperties = [
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
displayOptions: {
show: {
resource: [
'customer',
],
operation: [
'getAll',
],
},
},
default: false,
noDataExpression: true,
description: 'If all results should be returned or only up to a given limit',
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
displayOptions: {
show: {
resource: [
'customer',
],
operation: [
'getAll',
],
returnAll: [
false,
],
},
},
default: 25,
description: 'Limit the number of rows returned',
},
{
displayName: 'Filters',
name: 'filters',
type: 'collection',
placeholder: 'Add Filter',
displayOptions: {
show: {
resource: [
'customer',
],
operation: [
'getAll',
],
},
},
default: {},
options: [
{
displayName: 'Business Name',
name: 'businessName',
type: 'string',
default: '',
},
{
displayName: 'Email',
name: 'email',
type: 'string',
default: '',
},
{
displayName: 'First Name',
name: 'firstName',
type: 'string',
default: '',
},
{
displayName: 'Include Disabled',
name: 'includeDisabled',
type: 'boolean',
default: false,
},
{
displayName: 'Last Name',
name: 'lastname',
type: 'string',
default: '',
},
{
displayName: 'Search Query',
name: 'query',
type: 'string',
default: '',
placeholder: 'John Doe',
description: 'Search query, it can be anything related to customer data like name etc.',
},
{
displayName: 'Sort',
name: 'sort',
type: 'string',
default: '',
placeholder: 'firstname ASC',
description: 'customer field to order by, eg: "firstname ASC", "city DESC" etc.',
},
],
},
];

View file

@ -0,0 +1,46 @@
import {
IExecuteFunctions,
} from 'n8n-core';
import {
IDataObject,
INodeExecutionData,
} from 'n8n-workflow';
import {
apiRequest, apiRequestAllItems
} from '../../../transport';
export async function getAll(this: IExecuteFunctions, index: number): Promise<INodeExecutionData[]> {
const returnAll = this.getNodeParameter('returnAll', index) as boolean;
const filters = this.getNodeParameter('filters', index) as IDataObject;
let qs = {} as IDataObject;
const requestMethod = 'GET';
const endpoint = 'customers';
const body = {} as IDataObject;
if (filters) {
qs = filters;
if (qs.businessName) {
qs.business_name = qs.businessName;
}
if (qs.includeDisabled) {
qs.include_disabled = qs.includeDisabled;
}
}
if (returnAll === false) {
qs.per_page = this.getNodeParameter('limit', index) as number;
}
let responseData;
if (returnAll) {
responseData = await apiRequestAllItems.call(this, requestMethod, endpoint, body, qs);
return this.helpers.returnJsonArray(responseData);
} else {
responseData = await apiRequest.call(this, requestMethod, endpoint, body, qs);
return this.helpers.returnJsonArray(responseData.customers);
}
}

View file

@ -0,0 +1,7 @@
import { getAll as execute } from './execute';
import { customerGetAllDescription as description } from './description';
export {
description,
execute,
};

View file

@ -0,0 +1,67 @@
import * as getAll from './getAll';
import * as create from './create';
import * as del from './del';
import * as update from './update';
import * as get from './get';
import { INodeProperties } from 'n8n-workflow';
export {
getAll,
create,
del as delete,
update,
get,
};
export const descriptions = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'customer',
],
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create new customer',
},
{
name: 'Delete',
value: 'delete',
description: 'Delete customer',
},
{
name: 'Get',
value: 'get',
description: 'Retrieve customer',
},
{
name: 'Get All',
value: 'getAll',
description: 'Retrieve all customers',
},
{
name: 'Update',
value: 'update',
description: 'Update customer',
},
],
default: 'getAll',
description: '',
},
...getAll.description,
...get.description,
...create.description,
...del.description,
...update.description,
] as INodeProperties[];

View file

@ -0,0 +1,124 @@
import {
CustomerProperties,
} from '../../Interfaces';
import {
addressFixedCollection
} from '../../../methods/sharedFields';
export const customerUpdateDescription: CustomerProperties = [
{
displayName: 'Customer ID',
name: 'customerId',
type: 'string',
displayOptions: {
show: {
resource: [
'customer',
],
operation: [
'update',
],
},
},
default: '',
},
{
displayName: 'Update Fields',
name: 'updateFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
resource: [
'customer',
],
operation: [
'update',
],
},
},
default: {},
options: [
addressFixedCollection,
{
displayName: 'Business Name',
name: 'businessName',
type: 'string',
default: '',
},
{
displayName: 'Email',
name: 'email',
type: 'string',
default: '',
},
{
displayName: 'First Name',
name: 'firstName',
type: 'string',
default: '',
},
{
displayName: 'Get SMS',
name: 'getSms',
type: 'boolean',
default: true,
},
{
displayName: 'Invoice Emails',
name: 'invoiceCcEmails',
type: 'string',
typeOptions: {
multipleValues: true,
multipleValueButtonText: 'Add Email',
},
default: '',
},
{
displayName: 'Last Name',
name: 'lastName',
type: 'string',
default: '',
},
{
displayName: 'No Email',
name: 'noEmail',
type: 'boolean',
default: false,
},
{
displayName: 'Notes',
name: 'notes',
type: 'string',
default: '',
},
{
displayName: 'Notification Email',
name: 'notificationEmail',
type: 'string',
default: '',
displayOptions: {
show: {
noEmail: [
false,
],
},
},
},
{
displayName: 'Phone',
name: 'phone',
type: 'string',
default: '',
},
{
displayName: 'Referred By',
name: 'referredBy',
type: 'string',
default: '',
description: 'Source from which customer is referred to the platform like Linkedin, Google, Customer name etc.',
},
],
},
];

View file

@ -0,0 +1,53 @@
import {
IExecuteFunctions,
} from 'n8n-core';
import {
IDataObject,
INodeExecutionData,
NodeApiError,
} from 'n8n-workflow';
import {
apiRequest,
} from '../../../transport';
export async function updateCustomer(this: IExecuteFunctions, index: number): Promise<INodeExecutionData[]> {
const id = this.getNodeParameter('customerId', index) as IDataObject;
const { address, businessName, email, firstName, getSms, invoiceCcEmails,
lastName, noEmail, notes, notificationEmail, phone, referredBy } = this.getNodeParameter('updateFields', index) as IDataObject;
const qs = {} as IDataObject;
const requestMethod = 'PUT';
const endpoint = `customers/${id}`;
let body = {} as IDataObject;
let addressData = address as IDataObject;
if (addressData) {
addressData = addressData['addressFields'] as IDataObject;
addressData.address_2 = addressData.address2;
}
body = {
...addressData,
business_name: businessName,
email,
firstname: firstName,
get_sms: getSms,
invoice_cc_emails: (invoiceCcEmails as string[] || []).join(','),
lastname: lastName,
no_email: noEmail,
notes,
notification_email: notificationEmail,
phone,
referred_by: referredBy,
};
let responseData;
responseData = await apiRequest.call(this, requestMethod, endpoint, body, qs);
if (!responseData.customer) {
throw new NodeApiError(this.getNode(), responseData, { httpCode: '404', message: 'Customer ID not found' });
}
return this.helpers.returnJsonArray(responseData.customer);
}

View file

@ -0,0 +1,7 @@
import { updateCustomer as execute } from './execute';
import { customerUpdateDescription as description } from './description';
export {
description,
execute,
};

View file

@ -0,0 +1,79 @@
import {
RmmProperties,
} from '../../Interfaces';
export const rmmCreateDescription: RmmProperties = [
{
displayName: 'Asset ID',
name: 'assetId',
type: 'string',
displayOptions: {
show: {
resource: [
'rmm',
],
operation: [
'create',
],
},
},
default: '',
},
{
displayName: 'Customer ID',
name: 'customerId',
type: 'string',
displayOptions: {
show: {
resource: [
'rmm',
],
operation: [
'create',
],
},
},
default: '',
},
{
displayName: 'Description',
name: 'description',
type: 'string',
displayOptions: {
show: {
resource: [
'rmm',
],
operation: [
'create',
],
},
},
default: '',
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
resource: [
'rmm',
],
operation: [
'create',
],
},
},
default: {},
options: [
{
displayName: 'Resolved',
name: 'resolved',
type: 'boolean',
default: false,
},
],
},
];

View file

@ -0,0 +1,38 @@
import {
IExecuteFunctions,
} from 'n8n-core';
import {
IDataObject,
INodeExecutionData,
} from 'n8n-workflow';
import {
apiRequest,
} from '../../../transport';
export async function addAlert(this: IExecuteFunctions, index: number): Promise<INodeExecutionData[]> {
const customerId = this.getNodeParameter('customerId', index) as IDataObject;
const assetId = this.getNodeParameter('assetId', index) as IDataObject;
const description = this.getNodeParameter('description', index) as IDataObject;
const additionalFields = this.getNodeParameter('additionalFields', index) as IDataObject;
const qs = {} as IDataObject;
const requestMethod = 'POST';
const endpoint = 'rmm_alerts';
let body = {} as IDataObject;
if (additionalFields) {
body = additionalFields;
}
body.customer_id = customerId;
body.asset_id = assetId;
body.description = description;
let responseData;
responseData = await apiRequest.call(this, requestMethod, endpoint, body, qs);
return this.helpers.returnJsonArray(responseData.alert);
}

View file

@ -0,0 +1,7 @@
import { addAlert as execute } from './execute';
import { rmmCreateDescription as description } from './description';
export {
description,
execute,
};

View file

@ -0,0 +1,24 @@
import {
RmmProperties,
} from '../../Interfaces';
export const rmmDeleteDescription: RmmProperties = [
{
displayName: 'RMM Alert ID',
name: 'alertId',
type: 'string',
required: true,
displayOptions: {
show: {
resource: [
'rmm',
],
operation: [
'delete',
],
},
},
default: '',
description: 'Delete the RMM alert by ID',
},
];

View file

@ -0,0 +1,26 @@
import {
IExecuteFunctions,
} from 'n8n-core';
import {
IDataObject,
INodeExecutionData,
} from 'n8n-workflow';
import {
apiRequest
} from '../../../transport';
export async function deleteAlert(this: IExecuteFunctions, index: number): Promise<INodeExecutionData[]> {
const id = this.getNodeParameter('alertId', index) as string;
const qs = {} as IDataObject;
const requestMethod = 'DELETE';
const endpoint = `rmm_alerts/${id}`;
const body = {} as IDataObject;
let responseData;
responseData = await apiRequest.call(this, requestMethod, endpoint, body, qs);
return this.helpers.returnJsonArray(responseData);
}

View file

@ -0,0 +1,7 @@
import { deleteAlert as execute } from './execute';
import { rmmDeleteDescription as description } from './description';
export {
description,
execute,
};

View file

@ -0,0 +1,24 @@
import {
RmmProperties,
} from '../../Interfaces';
export const rmmGetDescription: RmmProperties = [
{
displayName: 'RMM Alert ID',
name: 'alertId',
type: 'string',
required: true,
displayOptions: {
show: {
resource: [
'rmm',
],
operation: [
'get',
],
},
},
default: '',
description: 'Get specific RMM alert by ID',
},
];

View file

@ -0,0 +1,26 @@
import {
IExecuteFunctions,
} from 'n8n-core';
import {
IDataObject,
INodeExecutionData,
} from 'n8n-workflow';
import {
apiRequest
} from '../../../transport';
export async function getAlert(this: IExecuteFunctions, index: number): Promise<INodeExecutionData[]> {
const id = this.getNodeParameter('alertId', index) as string;
const qs = {} as IDataObject;
const requestMethod = 'GET';
const endpoint = `rmm_alerts/${id}`;
const body = {} as IDataObject;
let responseData;
responseData = await apiRequest.call(this, requestMethod, endpoint, body, qs);
return this.helpers.returnJsonArray(responseData.rmm_alert);
}

View file

@ -0,0 +1,7 @@
import { getAlert as execute } from './execute';
import { rmmGetDescription as description } from './description';
export {
description,
execute,
};

View file

@ -0,0 +1,83 @@
import {
RmmProperties,
} from '../../Interfaces';
export const rmmGetAllDescription: RmmProperties = [
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
displayOptions: {
show: {
resource: [
'rmm',
],
operation: [
'getAll',
],
},
},
default: false,
noDataExpression: true,
description: 'If all results should be returned or only up to a given limit',
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
displayOptions: {
show: {
resource: [
'rmm',
],
operation: [
'getAll',
],
returnAll: [
false,
],
},
},
default: 25,
description: 'Limit the number of rows returned',
},
{
displayName: 'Filters',
name: 'filters',
type: 'collection',
placeholder: 'Add Filter',
displayOptions: {
show: {
resource: [
'rmm',
],
operation: [
'getAll',
],
},
},
default: {},
options: [
{
displayName: 'Status',
name: 'status',
type: 'options',
options: [
{
name: 'Active',
value: 'active',
},
{
name: 'All',
value: 'all',
},
{
name: 'Resolved',
value: 'resolved',
},
],
default: 'all',
},
],
},
];

View file

@ -0,0 +1,43 @@
import {
IExecuteFunctions,
} from 'n8n-core';
import {
IDataObject,
INodeExecutionData,
} from 'n8n-workflow';
import {
apiRequest, apiRequestAllItems
} from '../../../transport';
export async function getAll(this: IExecuteFunctions, index: number): Promise<INodeExecutionData[]> {
const returnAll = this.getNodeParameter('returnAll', index) as boolean;
const filters = this.getNodeParameter('filters', index) as IDataObject;
let qs = {} as IDataObject;
const requestMethod = 'GET';
const endpoint = 'rmm_alerts';
const body = {} as IDataObject;
if (filters) {
qs = filters;
}
if (qs.status === undefined) {
qs.status = 'all';
}
if (returnAll === false) {
qs.per_page = this.getNodeParameter('limit', index) as number;
}
let responseData;
if (returnAll) {
responseData = await apiRequestAllItems.call(this, requestMethod, endpoint, body, qs);
return this.helpers.returnJsonArray(responseData);
} else {
responseData = await apiRequest.call(this, requestMethod, endpoint, body, qs);
return this.helpers.returnJsonArray(responseData.rmm_alerts);
}
}

View file

@ -0,0 +1,7 @@
import { getAll as execute } from './execute';
import { rmmGetAllDescription as description } from './description';
export {
description,
execute,
};

View file

@ -0,0 +1,66 @@
import * as get from './get';
import * as getAll from './getAll';
import * as create from './create';
import * as del from './del';
import * as mute from './mute';
import { INodeProperties } from 'n8n-workflow';
export {
getAll,
get,
mute,
del as delete,
create,
};
export const descriptions = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'rmm',
],
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create new RMM Alert',
},
{
name: 'Delete',
value: 'delete',
description: 'Delete RMM Alert',
},
{
name: 'Get',
value: 'get',
description: 'Retrieve RMM Alert',
},
{
name: 'Get All',
value: 'getAll',
description: 'Retrieve all RMM Alerts',
},
{
name: 'Mute',
value: 'mute',
description: 'Mute RMM Alert',
},
],
default: 'getAll',
description: '',
},
...getAll.description,
...get.description,
...create.description,
...del.description,
...mute.description,
] as INodeProperties[];

View file

@ -0,0 +1,71 @@
import {
RmmProperties,
} from '../../Interfaces';
export const rmmMuteDescription: RmmProperties = [
{
displayName: 'RMM Alert ID',
name: 'alertId',
type: 'string',
required: true,
displayOptions: {
show: {
resource: [
'rmm',
],
operation: [
'mute',
],
},
},
default: '',
description: 'Mute the RMM alert by ID',
},
{
displayName: 'Mute Period',
name: 'muteFor',
type: 'options',
displayOptions: {
show: {
resource: [
'rmm',
],
operation: [
'mute',
],
},
},
options: [
{
name: '1 hour',
value: '1-hour',
},
{
name: '1 day',
value: '1-day',
},
{
name: '2 days',
value: '2-days',
},
{
name: '1 week',
value: '1-week',
},
{
name: '2 weeks',
value: '2-weeks',
},
{
name: '1 month',
value: '1-month',
},
{
name: 'Forever',
value: 'forever',
},
],
default: '',
description: 'Length of time to mute alert for',
},
];

View file

@ -0,0 +1,30 @@
import {
IExecuteFunctions,
} from 'n8n-core';
import {
IDataObject,
INodeExecutionData,
} from 'n8n-workflow';
import {
apiRequest
} from '../../../transport';
export async function muteAlert(this: IExecuteFunctions, index: number): Promise<INodeExecutionData[]> {
const id = this.getNodeParameter('alertId', index) as string;
const mute = this.getNodeParameter('muteFor', index) as string;
const qs = {} as IDataObject;
const requestMethod = 'POST';
const endpoint = `rmm_alerts/${id}/mute`;
const body = {} as IDataObject;
body.id = id;
body.mute_for = mute;
let responseData;
responseData = await apiRequest.call(this, requestMethod, endpoint, body, qs);
return this.helpers.returnJsonArray(responseData);
}

View file

@ -0,0 +1,7 @@
import { muteAlert as execute } from './execute';
import { rmmMuteDescription as description } from './description';
export {
description,
execute,
};

View file

@ -0,0 +1,52 @@
import {
IExecuteFunctions,
} from 'n8n-core';
import {
INodeExecutionData, NodeApiError,
} from 'n8n-workflow';
import * as customer from './customer';
import * as ticket from './ticket';
import * as contact from './contact';
import * as rmm from './rmm';
import { SyncroMsp } from './Interfaces';
export async function router(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const items = this.getInputData();
const operationResult: INodeExecutionData[] = [];
for (let i = 0; i < items.length; i++) {
const resource = this.getNodeParameter<SyncroMsp>('resource', i);
let operation = this.getNodeParameter('operation', i);
if (operation === 'del') {
operation = 'delete';
}
const syncroMsp = {
resource,
operation,
} as SyncroMsp;
try {
if (syncroMsp.resource === 'customer') {
operationResult.push(...await customer[syncroMsp.operation].execute.call(this, i));
} else if (syncroMsp.resource === 'ticket') {
operationResult.push(...await ticket[syncroMsp.operation].execute.call(this, i));
} else if (syncroMsp.resource === 'contact') {
operationResult.push(...await contact[syncroMsp.operation].execute.call(this, i));
} else if (syncroMsp.resource === 'rmm') {
operationResult.push(...await rmm[syncroMsp.operation].execute.call(this, i));
}
} catch (err) {
if (this.continueOnFail()) {
operationResult.push({ json: this.getInputData(i)[0].json, error: err });
} else {
throw new NodeApiError(this.getNode(), err);
}
}
}
return [operationResult];
}

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.2 KiB

View file

@ -0,0 +1,144 @@
import {
TicketProperties,
} from '../../Interfaces';
export const ticketCreateDescription: TicketProperties = [
{
displayName: 'Customer ID',
name: 'customerId',
type: 'string',
required: true,
displayOptions: {
show: {
resource: [
'ticket',
],
operation: [
'create',
],
},
},
default: '',
},
{
displayName: 'Subject',
name: 'subject',
type: 'string',
required: true,
displayOptions: {
show: {
resource: [
'ticket',
],
operation: [
'create',
],
},
},
default: '',
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
resource: [
'ticket',
],
operation: [
'create',
],
},
},
default: {},
options: [
{
displayName: 'Asset ID',
name: 'assetId',
type: 'string',
default: '',
},
{
displayName: 'Assign to Contact',
name: 'contactId',
type: 'string',
default: '',
description: 'The ID of the contact you want to assign the ticket to',
},
// {
// displayName: 'Due Date',
// name: 'dueDate',
// type: 'dateTime',
// default: '',
// },
{
displayName: 'Issue Type',
name: 'issueType',
type: 'options',
options: [
{
name: 'Contract Work',
value: 'Contract Work',
},
{
name: 'Network Project',
value: 'Network Project',
},
{
name: 'Other',
value: 'Other',
},
{
name: 'Regular Maintenance',
value: 'Regular Maintenance',
},
{
name: 'Remote Support',
value: 'Remote Support',
},
],
default: '',
},
{
displayName: 'Status',
name: 'status',
type: 'options',
options: [
{
name: 'Customer Reply',
value: 'Customer Reply',
},
{
name: 'In Progress',
value: 'In Progress',
},
{
name: 'New',
value: 'New',
},
{
name: 'Resolved',
value: 'Resolved',
},
{
name: 'Scheduled',
value: 'Scheduled',
},
{
name: 'Waiting for Parts',
value: 'Waiting for Parts',
},
{
name: 'Waiting on Customer',
value: 'Waiting on Customer',
},
],
default: 'New',
description: 'If used along the parameter Search Query, only Search Query will be applied',
},
],
},
];

View file

@ -0,0 +1,40 @@
import {
IExecuteFunctions,
} from 'n8n-core';
import {
IDataObject,
INodeExecutionData,
} from 'n8n-workflow';
import {
apiRequest,
} from '../../../transport';
export async function createTicket(this: IExecuteFunctions, index: number): Promise<INodeExecutionData[]> {
const id = this.getNodeParameter('customerId', index) as IDataObject;
const subject = this.getNodeParameter('subject', index) as IDataObject;
const { assetId, dueDate, issueType, status, contactId } = this.getNodeParameter('additionalFields', index) as IDataObject;
const qs = {} as IDataObject;
const requestMethod = 'POST';
const endpoint = 'tickets';
let body = {} as IDataObject;
body = {
asset_id: assetId,
//due_date: dueDate,
problem_type: issueType,
status,
contact_id: contactId,
};
body.customer_id = id;
body.subject = subject;
let responseData;
responseData = await apiRequest.call(this, requestMethod, endpoint, body, qs);
return this.helpers.returnJsonArray(responseData.ticket);
}

View file

@ -0,0 +1,7 @@
import { createTicket as execute } from './execute';
import { ticketCreateDescription as description } from './description';
export {
description,
execute,
};

View file

@ -0,0 +1,24 @@
import {
TicketProperties,
} from '../../Interfaces';
export const ticketDeleteDescription: TicketProperties = [
{
displayName: 'Ticket ID',
name: 'ticketId',
required: true,
type: 'string',
displayOptions: {
show: {
resource: [
'ticket',
],
operation: [
'delete',
],
},
},
default: '',
description: 'Delete a specific customer by ID',
},
];

View file

@ -0,0 +1,26 @@
import {
IExecuteFunctions,
} from 'n8n-core';
import {
IDataObject,
INodeExecutionData,
} from 'n8n-workflow';
import {
apiRequest
} from '../../../transport';
export async function deleteTicket(this: IExecuteFunctions, index: number): Promise<INodeExecutionData[]> {
const id = this.getNodeParameter('ticketId', index) as string;
const qs = {} as IDataObject;
const requestMethod = 'DELETE';
const endpoint = `tickets/${id}`;
const body = {} as IDataObject;
let responseData;
responseData = await apiRequest.call(this, requestMethod, endpoint, body, qs);
return this.helpers.returnJsonArray(responseData);
}

View file

@ -0,0 +1,7 @@
import { deleteTicket as execute } from './execute';
import { ticketDeleteDescription as description } from './description';
export {
description,
execute,
};

View file

@ -0,0 +1,23 @@
import {
TicketProperties,
} from '../../Interfaces';
export const ticketGetDescription: TicketProperties = [
{
displayName: 'Ticket ID',
name: 'ticketId',
type: 'string',
displayOptions: {
show: {
resource: [
'ticket',
],
operation: [
'get',
],
},
},
default: '',
description: 'Get specific customer by ID',
},
];

View file

@ -0,0 +1,26 @@
import {
IExecuteFunctions,
} from 'n8n-core';
import {
IDataObject,
INodeExecutionData,
} from 'n8n-workflow';
import {
apiRequest
} from '../../../transport';
export async function getTicket(this: IExecuteFunctions, index: number): Promise<INodeExecutionData[]> {
const id = this.getNodeParameter('ticketId', index) as string;
const qs = {} as IDataObject;
const requestMethod = 'GET';
const endpoint = `tickets/${id}`;
const body = {} as IDataObject;
let responseData;
responseData = await apiRequest.call(this, requestMethod, endpoint, body, qs);
return this.helpers.returnJsonArray(responseData.ticket);
}

View file

@ -0,0 +1,7 @@
import { getTicket as execute } from './execute';
import { ticketGetDescription as description } from './description';
export {
description,
execute,
};

View file

@ -0,0 +1,107 @@
import {
TicketProperties,
} from '../../Interfaces';
export const ticketGetAllDescription: TicketProperties = [
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
displayOptions: {
show: {
resource: [
'ticket',
],
operation: [
'getAll',
],
},
},
default: false,
noDataExpression: true,
description: 'If all results should be returned or only up to a given limit',
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
displayOptions: {
show: {
resource: [
'ticket',
],
operation: [
'getAll',
],
returnAll: [
false,
],
},
},
default: 25,
description: 'Limit the number of rows returned',
},
{
displayName: 'Filters',
name: 'filters',
type: 'collection',
placeholder: 'Add Filter',
displayOptions: {
show: {
resource: [
'ticket',
],
operation: [
'getAll',
],
},
},
default: {},
options: [
{
displayName: 'Search Query',
name: 'query',
type: 'string',
default: '',
placeholder: 'John Doe',
description: 'Search query, it can be anything related to ticket data like user etc.',
},
{
displayName: 'Status',
name: 'status',
type: 'options',
options: [
{
name: 'Customer Reply',
value: 'Customer Reply',
},
{
name: 'In Progress',
value: 'In Progress',
},
{
name: 'New',
value: 'New',
},
{
name: 'Resolved',
value: 'Resolved',
},
{
name: 'Scheduled',
value: 'Scheduled',
},
{
name: 'Waiting for Parts',
value: 'Waiting for Parts',
},
{
name: 'Waiting on Customer',
value: 'Waiting on Customer',
},
],
default: 'New',
},
],
},
];

View file

@ -0,0 +1,40 @@
import {
IExecuteFunctions,
} from 'n8n-core';
import {
IDataObject,
INodeExecutionData,
} from 'n8n-workflow';
import {
apiRequest, apiRequestAllItems
} from '../../../transport';
export async function getAll(this: IExecuteFunctions, index: number): Promise<INodeExecutionData[]> {
const returnAll = this.getNodeParameter('returnAll', index) as boolean;
const filters = this.getNodeParameter('filters', index) as IDataObject;
let qs = {} as IDataObject;
const requestMethod = 'GET';
const endpoint = 'tickets';
const body = {} as IDataObject;
if (filters) {
qs = filters;
}
if (returnAll === false) {
qs.per_page = this.getNodeParameter('limit', index) as number;
}
let responseData;
if (returnAll) {
responseData = await apiRequestAllItems.call(this, requestMethod, endpoint, body, qs);
return this.helpers.returnJsonArray(responseData);
} else {
responseData = await apiRequest.call(this, requestMethod, endpoint, body, qs);
return this.helpers.returnJsonArray(responseData.tickets);
}
}

View file

@ -0,0 +1,7 @@
import { getAll as execute } from './execute';
import { ticketGetAllDescription as description } from './description';
export {
description,
execute,
};

View file

@ -0,0 +1,65 @@
import * as getAll from './getAll';
import * as create from './create';
import * as get from './get';
import * as del from './del';
import * as update from './update';
import { INodeProperties } from 'n8n-workflow';
export {
getAll,
create,
get,
del as delete,
update,
};
export const descriptions = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'ticket',
],
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create new ticket',
},
{
name: 'Delete',
value: 'delete',
description: 'Delete ticket',
},
{
name: 'Get',
value: 'get',
description: 'Retrieve ticket',
},
{
name: 'Get All',
value: 'getAll',
description: 'Retrieve all tickets',
},
{
name: 'Update',
value: 'update',
description: 'Update ticket',
},
],
default: 'getAll',
description: '',
},
...getAll.description,
...create.description,
...get.description,
...del.description,
...update.description,
] as INodeProperties[];

View file

@ -0,0 +1,137 @@
import {
TicketProperties,
} from '../../Interfaces';
export const ticketUpdateDescription: TicketProperties = [
{
displayName: 'Ticket ID',
name: 'ticketId',
type: 'string',
required: true,
displayOptions: {
show: {
resource: [
'ticket',
],
operation: [
'update',
],
},
},
default: '',
},
{
displayName: 'Update Fields',
name: 'updateFields',
type: 'collection',
placeholder: 'Add Field',
displayOptions: {
show: {
resource: [
'ticket',
],
operation: [
'update',
],
},
},
default: {},
options: [
{
displayName: 'Asset ID',
name: 'assetId',
type: 'string',
default: '',
},
{
displayName: 'Assign to Contact',
name: 'contactId',
type: 'string',
default: '',
description: 'The ID of the contact you want to assign the ticket to',
},
{
displayName: 'Customer ID',
name: 'customerId',
type: 'string',
default: '',
},
{
displayName: 'Due Date',
name: 'dueDate',
type: 'dateTime',
default: '',
},
{
displayName: 'Issue Type',
name: 'issueType',
type: 'options',
options: [
{
name: 'Contract Work',
value: 'Contract Work',
},
{
name: 'Network Project',
value: 'Network Project',
},
{
name: 'Other',
value: 'Other',
},
{
name: 'Regular Maintenance',
value: 'Regular Maintenance',
},
{
name: 'Remote Support',
value: 'Remote Support',
},
],
default: '',
},
{
displayName: 'Status',
name: 'status',
type: 'options',
options: [
{
name: 'Customer Reply',
value: 'Customer Reply',
},
{
name: 'In Progress',
value: 'In Progress',
},
{
name: 'New',
value: 'New',
},
{
name: 'Resolved',
value: 'Resolved',
},
{
name: 'Scheduled',
value: 'Scheduled',
},
{
name: 'Waiting for Parts',
value: 'Waiting for Parts',
},
{
name: 'Waiting on Customer',
value: 'Waiting on Customer',
},
],
default: 'New',
},
{
displayName: 'Subject',
name: 'subject',
type: 'string',
default: '',
},
],
},
];

View file

@ -0,0 +1,45 @@
import {
IExecuteFunctions,
} from 'n8n-core';
import {
IDataObject,
INodeExecutionData,
NodeOperationError,
} from 'n8n-workflow';
import {
apiRequest,
} from '../../../transport';
export async function updateTicket(this: IExecuteFunctions, index: number): Promise<INodeExecutionData[]> {
const id = this.getNodeParameter('ticketId', index) as IDataObject;
const { assetId, customerId, dueDate, issueType, status, subject, ticketType, contactId } = this.getNodeParameter('updateFields', index) as IDataObject;
const qs = {} as IDataObject;
const requestMethod = 'PUT';
const endpoint = `tickets/${id}`;
let body = {} as IDataObject;
body = {
...(assetId && { asset_id: assetId }),
...(customerId && { customer_id: customerId }),
...(dueDate && { due_date: dueDate }),
...(issueType && { problem_type: issueType }),
...(status && { status }),
...(subject && { subject }),
...(ticketType && { ticket_type: ticketType }),
...(contactId && { contact_id: contactId }),
};
if (!Object.keys(body).length) {
throw new NodeOperationError(this.getNode(), 'At least one update fields has to be defined');
}
let responseData;
responseData = await apiRequest.call(this, requestMethod, endpoint, body, qs);
return this.helpers.returnJsonArray(responseData.ticket);
}

View file

@ -0,0 +1,7 @@
import { updateTicket as execute } from './execute';
import { ticketUpdateDescription as description } from './description';
export {
description,
execute,
};

View file

@ -0,0 +1,61 @@
import {
INodeTypeDescription,
} from 'n8n-workflow';
import * as customer from './customer';
import * as ticket from './ticket';
import * as contact from './contact';
import * as rmm from './rmm';
export const versionDescription: INodeTypeDescription = {
displayName: 'SyncroMSP',
name: 'syncroMsp',
icon: 'file:syncromsp.png',
group: ['output'],
version: 1,
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
description: 'Gets data from SyncroMSP',
defaults: {
name: 'SyncroMSP',
color: '#08a4ab',
},
inputs: ['main'],
outputs: ['main'],
credentials: [
{
name: 'syncroMspApi',
required: true,
testedBy: 'syncroMspApiCredentialTest',
},
],
properties: [
{
displayName: 'Resource',
name: 'resource',
type: 'options',
options: [
{
name: 'Contact',
value: 'contact',
},
{
name: 'Customer',
value: 'customer',
},
{
name: 'RMM',
value: 'rmm',
},
{
name: 'Ticket',
value: 'ticket',
},
],
default: 'contact',
},
...customer.descriptions,
...ticket.descriptions,
...contact.descriptions,
...rmm.descriptions,
],
};

View file

@ -0,0 +1 @@
export * as loadOptions from './loadOptions';

View file

@ -0,0 +1,38 @@
import {
IDataObject,
ILoadOptionsFunctions,
INodePropertyOptions,
NodeOperationError,
} from 'n8n-workflow';
import {
apiRequestAllItems,
} from '../transport';
// Get all the available channels
export async function getCustomers(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const endpoint = 'customers';
const responseData = await apiRequestAllItems.call(this, 'GET', endpoint, {});
if (responseData === undefined) {
throw new NodeOperationError(this.getNode(), 'No data got returned');
}
const returnData: INodePropertyOptions[] = [];
for (const data of responseData) {
returnData.push({
name: data.fullname as string,
value: data.id as number,
});
}
returnData.sort((a, b) => {
if (a.name < b.name) { return -1; }
if (a.name > b.name) { return 1; }
return 0;
});
return returnData;
}

View file

@ -0,0 +1,49 @@
import {
INodeProperties
} from 'n8n-workflow';
export const addressFixedCollection: INodeProperties = {
displayName: 'Address',
name: 'address',
placeholder: 'Add Address Fields',
type: 'fixedCollection',
default: {},
options: [
{
displayName: 'Address Fields',
name: 'addressFields',
values: [
{
displayName: 'Line 1',
name: 'address',
type: 'string',
default: '',
},
{
displayName: 'Line 2',
name: 'address2',
type: 'string',
default: '',
},
{
displayName: 'City',
name: 'city',
type: 'string',
default: '',
},
{
displayName: 'State',
name: 'state',
type: 'string',
default: '',
},
{
displayName: 'ZIP',
name: 'zip',
type: 'string',
default: '',
},
],
},
],
};

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.2 KiB

View file

@ -0,0 +1,93 @@
import {
IExecuteFunctions,
IHookFunctions,
ILoadOptionsFunctions,
} from 'n8n-core';
import {
GenericValue,
ICredentialDataDecryptedObject,
ICredentialTestFunctions,
IDataObject,
IHttpRequestOptions,
NodeApiError,
NodeOperationError,
} from 'n8n-workflow';
/**
* Make an API request to Mattermost
*/
export async function apiRequest(
this: IHookFunctions | IExecuteFunctions | ILoadOptionsFunctions,
method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'HEAD',
endpoint: string,
body: IDataObject | GenericValue | GenericValue[] = {},
query: IDataObject = {},
) {
const credentials = await this.getCredentials('syncroMspApi');
if (!credentials) {
throw new NodeOperationError(this.getNode(), 'No credentials returned!');
}
query['api_key'] = credentials.apiKey;
const options: IHttpRequestOptions = {
method,
body,
qs: query,
url: `https://${credentials.subdomain}.syncromsp.com/api/v1/${endpoint}`,
headers: {},
};
try {
return await this.helpers.httpRequest(options);
} catch (error) {
throw new NodeApiError(this.getNode(), error);
}
}
export async function apiRequestAllItems(
this: IExecuteFunctions | ILoadOptionsFunctions,
method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'HEAD',
endpoint: string,
body: IDataObject = {},
query: IDataObject = {},
) {
let returnData: IDataObject[] = [];
let responseData;
query.page = 1;
do {
responseData = await apiRequest.call(this, method, endpoint, body, query);
query.page++;
returnData = returnData.concat(responseData[endpoint]);
} while (
responseData[endpoint].length !== 0
);
return returnData;
}
export async function validateCredentials(this: ICredentialTestFunctions, decryptedCredentials: ICredentialDataDecryptedObject): Promise<any> { // tslint:disable-line:no-any
const credentials = decryptedCredentials;
const {
subdomain,
apiKey,
} = credentials as {
subdomain: string,
apiKey: string,
};
const options: IHttpRequestOptions = {
method: 'GET',
qs: {
api_key: apiKey,
},
url: `https://${subdomain}.syncromsp.com/api/v1//me`,
};
return this.helpers.request(options);
}

View file

@ -272,6 +272,7 @@
"dist/credentials/StripeApi.credentials.js",
"dist/credentials/SurveyMonkeyApi.credentials.js",
"dist/credentials/SurveyMonkeyOAuth2Api.credentials.js",
"dist/credentials/SyncroMspApi.credentials.js",
"dist/credentials/TaigaApi.credentials.js",
"dist/credentials/TapfiliateApi.credentials.js",
"dist/credentials/TelegramApi.credentials.js",
@ -605,6 +606,7 @@
"dist/nodes/Stripe/StripeTrigger.node.js",
"dist/nodes/SurveyMonkey/SurveyMonkeyTrigger.node.js",
"dist/nodes/Switch/Switch.node.js",
"dist/nodes/SyncroMSP/SyncroMsp.node.js",
"dist/nodes/Taiga/Taiga.node.js",
"dist/nodes/Taiga/TaigaTrigger.node.js",
"dist/nodes/Tapfiliate/Tapfiliate.node.js",