n8n/packages/nodes-base/nodes/Microsoft/Dynamics/MicrosoftDynamicsCrm.node.ts

299 lines
9.5 KiB
TypeScript
Raw Normal View History

import type {
IExecuteFunctions,
IDataObject,
ILoadOptionsFunctions,
INodeExecutionData,
INodePropertyOptions,
INodeType,
INodeTypeDescription,
} from 'n8n-workflow';
import type { IField } from './GenericFunctions';
import {
adjustAddresses,
getEntityFields,
getPicklistOptions,
microsoftApiRequest,
microsoftApiRequestAllItems,
sort,
} from './GenericFunctions';
import { accountFields, accountOperations } from './descriptions';
export class MicrosoftDynamicsCrm implements INodeType {
description: INodeTypeDescription = {
displayName: 'Microsoft Dynamics CRM',
name: 'microsoftDynamicsCrm',
icon: 'file:dynamicsCrm.svg',
group: ['input'],
version: 1,
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
description: 'Consume Microsoft Dynamics CRM API',
defaults: {
name: 'Microsoft Dynamics CRM',
},
inputs: ['main'],
outputs: ['main'],
credentials: [
{
name: 'microsoftDynamicsOAuth2Api',
required: true,
},
],
properties: [
{
displayName: 'Resource',
name: 'resource',
type: 'options',
refactor: Apply more nodelinting rules (#3324) * :pencil2: Alphabetize lint rules * :fire: Remove duplicates * :zap: Update `lintfix` script * :shirt: Apply `node-param-operation-without-no-data-expression` (#3329) * :shirt: Apply `node-param-operation-without-no-data-expression` * :shirt: Add exceptions * :shirt: Apply `node-param-description-weak` (#3328) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-option-value-duplicate` (#3331) * :shirt: Apply `node-param-description-miscased-json` (#3337) * :shirt: Apply `node-param-display-name-excess-inner-whitespace` (#3335) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-type-options-missing-from-limit` (#3336) * Rule workig as intended * :pencil2: Uncomment rules Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-option-name-duplicate` (#3338) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-description-wrong-for-simplify` (#3334) * :zap: fix * :zap: exceptions * :zap: changed rule ignoring from file to line * :shirt: Apply `node-param-resource-without-no-data-expression` (#3339) * :shirt: Apply `node-param-display-name-untrimmed` (#3341) * :shirt: Apply `node-param-display-name-miscased-id` (#3340) Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-resource-with-plural-option` (#3342) * :shirt: Apply `node-param-description-wrong-for-upsert` (#3333) * :zap: fix * :zap: replaced record with contact in description * :zap: fix Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :shirt: Apply `node-param-option-description-identical-to-name` (#3343) * :shirt: Apply `node-param-option-name-containing-star` (#3347) * :shirt: Apply `node-param-display-name-wrong-for-update-fields` (#3348) * :shirt: Apply `node-param-option-name-wrong-for-get-all` (#3345) * :zap: fix * :zap: exceptions * :shirt: Apply node-param-display-name-wrong-for-simplify (#3344) * Rule working as intended * Uncomented other rules * :shirt: Undo and add exceptions Co-authored-by: Iván Ovejero <ivov.src@gmail.com> * :zap: Alphabetize lint rules * :zap: Restore `lintfix` script Co-authored-by: Michael Kret <88898367+michael-radency@users.noreply.github.com> Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com>
2022-05-20 14:47:24 -07:00
noDataExpression: true,
options: [
{
name: 'Account',
value: 'account',
},
],
default: 'account',
},
...accountOperations,
...accountFields,
],
};
methods = {
loadOptions: {
async getAccountCategories(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
return getPicklistOptions.call(this, 'account', 'accountcategorycode');
},
async getAccountRatingCodes(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
return getPicklistOptions.call(this, 'account', 'accountratingcode');
},
async getAddressTypes(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
return getPicklistOptions.call(this, 'account', 'address1_addresstypecode');
},
async getBusinessTypes(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
return getPicklistOptions.call(this, 'account', 'businesstypecode');
},
async getCustomerSizeCodes(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
return getPicklistOptions.call(this, 'account', 'customersizecode');
},
async getCustomerTypeCodes(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
return getPicklistOptions.call(this, 'account', 'customertypecode');
},
async getIndustryCodes(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
return getPicklistOptions.call(this, 'account', 'industrycode');
},
async getPaymentTermsCodes(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
return getPicklistOptions.call(this, 'account', 'paymenttermscode');
},
async getPreferredAppointmentDayCodes(
this: ILoadOptionsFunctions,
): Promise<INodePropertyOptions[]> {
return getPicklistOptions.call(this, 'account', 'preferredappointmentdaycode');
},
async getPreferredAppointmentTimeCodes(
this: ILoadOptionsFunctions,
): Promise<INodePropertyOptions[]> {
return getPicklistOptions.call(this, 'account', 'preferredappointmenttimecode');
},
async getPreferredContactMethodCodes(
this: ILoadOptionsFunctions,
): Promise<INodePropertyOptions[]> {
return getPicklistOptions.call(this, 'account', 'preferredcontactmethodcode');
},
async getShippingMethodCodes(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
return getPicklistOptions.call(this, 'account', 'shippingmethodcode');
},
async getTerritoryCodes(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
return getPicklistOptions.call(this, 'account', 'territorycode');
},
async getAccountFields(this: ILoadOptionsFunctions): Promise<INodePropertyOptions[]> {
const fields = await getEntityFields.call(this, 'account');
const isSelectable = (field: IField) =>
field.IsValidForRead &&
field.CanBeSecuredForRead &&
field.IsValidODataAttribute &&
field.LogicalName !== 'slaid';
return fields
.filter(isSelectable)
.filter((field) => field.DisplayName.UserLocalizedLabel?.Label)
.map((field) => ({
name: field.DisplayName.UserLocalizedLabel.Label,
value: field.LogicalName,
}))
.sort(sort);
},
async getExpandableAccountFields(
this: ILoadOptionsFunctions,
): Promise<INodePropertyOptions[]> {
const fields = await getEntityFields.call(this, 'account');
const isSelectable = (field: IField) =>
field.IsValidForRead &&
field.CanBeSecuredForRead &&
field.IsValidODataAttribute &&
field.AttributeType === 'Lookup' &&
field.LogicalName !== 'slaid';
return fields
.filter(isSelectable)
.map((field) => ({
name: field.DisplayName.UserLocalizedLabel.Label,
value: field.LogicalName,
}))
.sort(sort);
},
},
};
async execute(this: IExecuteFunctions): Promise<INodeExecutionData[][]> {
const items = this.getInputData();
const returnData: INodeExecutionData[] = [];
refactor: Apply `eslint-plugin-n8n-nodes-base` autofixable rules (#3174) * :zap: Initial setup * :shirt: Update `.eslintignore` * :shirt: Autofix node-param-default-missing (#3173) * :fire: Remove duplicate key * :shirt: Add exceptions * :package: Update package-lock.json * :shirt: Apply `node-class-description-inputs-wrong-trigger-node` (#3176) * :shirt: Apply `node-class-description-inputs-wrong-regular-node` (#3177) * :shirt: Apply `node-class-description-outputs-wrong` (#3178) * :shirt: Apply `node-execute-block-double-assertion-for-items` (#3179) * :shirt: Apply `node-param-default-wrong-for-collection` (#3180) * :shirt: Apply node-param-default-wrong-for-boolean (#3181) * Autofixed default missing * Autofixed booleans, worked well * :zap: Fix params * :rewind: Undo exempted autofixes * :package: Update package-lock.json * :shirt: Apply node-class-description-missing-subtitle (#3182) * :zap: Fix missing comma * :shirt: Apply `node-param-default-wrong-for-fixed-collection` (#3184) * :shirt: Add exception for `node-class-description-missing-subtitle` * :shirt: Apply `node-param-default-wrong-for-multi-options` (#3185) * :shirt: Apply `node-param-collection-type-unsorted-items` (#3186) * Missing coma * :shirt: Apply `node-param-default-wrong-for-simplify` (#3187) * :shirt: Apply `node-param-description-comma-separated-hyphen` (#3190) * :shirt: Apply `node-param-description-empty-string` (#3189) * :shirt: Apply `node-param-description-excess-inner-whitespace` (#3191) * Rule looks good * Add whitespace rule in eslint config * :zao: fix * :shirt: Apply `node-param-description-identical-to-display-name` (#3193) * :shirt: Apply `node-param-description-missing-for-ignore-ssl-issues` (#3195) * :rewind: Revert ":zao: fix" This reverts commit ef8a76f3dfedffd1bdccf3178af8a8d90cf5a55c. * :shirt: Apply `node-param-description-missing-for-simplify` (#3196) * :shirt: Apply `node-param-description-missing-final-period` (#3194) * Rule working as intended * Add rule to eslint * :shirt: Apply node-param-description-missing-for-return-all (#3197) * :zap: Restore `lintfix` command Co-authored-by: agobrech <45268029+agobrech@users.noreply.github.com> Co-authored-by: Omar Ajoue <krynble@gmail.com> Co-authored-by: agobrech <ael.gobrecht@gmail.com> Co-authored-by: Michael Kret <michael.k@radency.com>
2022-04-22 09:29:51 -07:00
const length = items.length;
const qs: IDataObject = {};
let responseData;
const resource = this.getNodeParameter('resource', 0);
const operation = this.getNodeParameter('operation', 0);
for (let i = 0; i < length; i++) {
try {
if (resource === 'account') {
//https://docs.microsoft.com/en-us/powerapps/developer/data-platform/webapi/create-entity-web-api
if (operation === 'create') {
const name = this.getNodeParameter('name', i) as string;
const additionalFields = this.getNodeParameter('additionalFields', i) as {
addresses: { address: [{ [key: string]: any }] };
};
const options = this.getNodeParameter('options', i) as { returnFields: string[] };
const body = {
name,
...additionalFields,
};
if (body?.addresses?.address) {
Object.assign(body, adjustAddresses(body.addresses.address));
//@ts-ignore
delete body?.addresses;
}
if (options.returnFields) {
options.returnFields.push('accountid');
qs.$select = options.returnFields.join(',');
} else {
qs.$select = 'accountid';
}
responseData = await microsoftApiRequest.call(this, 'POST', '/accounts', body, qs);
}
if (operation === 'delete') {
//https://docs.microsoft.com/en-us/powerapps/developer/data-platform/webapi/update-delete-entities-using-web-api#basic-delete
const accountId = this.getNodeParameter('accountId', i) as string;
await microsoftApiRequest.call(this, 'DELETE', `/accounts(${accountId})`, {}, qs);
responseData = { success: true };
}
if (operation === 'get') {
//https://docs.microsoft.com/en-us/powerapps/developer/data-platform/webapi/retrieve-entity-using-web-api
const accountId = this.getNodeParameter('accountId', i) as string;
const options = this.getNodeParameter('options', i);
if (options.returnFields) {
qs.$select = (options.returnFields as string[]).join(',');
}
if (options.expandFields) {
qs.$expand = (options.expandFields as string[]).join(',');
}
responseData = await microsoftApiRequest.call(
this,
'GET',
`/accounts(${accountId})`,
{},
qs,
);
}
if (operation === 'getAll') {
//https://docs.microsoft.com/en-us/powerapps/developer/data-platform/webapi/query-data-web-api
const returnAll = this.getNodeParameter('returnAll', i);
const options = this.getNodeParameter('options', i);
const filters = this.getNodeParameter('filters', i);
if (options.returnFields) {
qs.$select = (options.returnFields as string[]).join(',');
}
if (options.expandFields) {
qs.$expand = (options.expandFields as string[]).join(',');
}
if (filters.query) {
qs.$filter = filters.query as string;
}
if (returnAll) {
responseData = await microsoftApiRequestAllItems.call(
this,
'value',
'GET',
'/accounts',
{},
qs,
);
} else {
qs.$top = this.getNodeParameter('limit', 0);
responseData = await microsoftApiRequest.call(this, 'GET', '/accounts', {}, qs);
responseData = responseData.value;
}
}
if (operation === 'update') {
const accountId = this.getNodeParameter('accountId', i) as string;
const updateFields = this.getNodeParameter('updateFields', i) as {
addresses: { address: [{ [key: string]: any }] };
};
const options = this.getNodeParameter('options', i) as { returnFields: string[] };
const body = {
...updateFields,
};
if (body?.addresses?.address) {
Object.assign(body, adjustAddresses(body.addresses.address));
//@ts-ignore
delete body?.addresses;
}
if (options.returnFields) {
options.returnFields.push('accountid');
qs.$select = options.returnFields.join(',');
} else {
qs.$select = 'accountid';
}
responseData = await microsoftApiRequest.call(
this,
'PATCH',
`/accounts(${accountId})`,
body,
qs,
);
}
}
const executionData = this.helpers.constructExecutionMetaData(
this.helpers.returnJsonArray(responseData as IDataObject),
{ itemData: { item: i } },
);
returnData.push(...executionData);
} catch (error) {
if (this.continueOnFail()) {
const executionErrorData = this.helpers.constructExecutionMetaData(
this.helpers.returnJsonArray({ error: error.message }),
{ itemData: { item: i } },
);
returnData.push(...executionErrorData);
continue;
}
throw error;
}
}
return this.prepareOutputData(returnData);
}
}