mohiit1502/Automata
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feat(Freshworks CRM Node): Add Search + Lookup functionality (#3131)

Browse Source 
* Add fields and Ops for Lookup Search

* Adds Search (Search + Lookup) operations

* 🔨 credentials update

* 🔨 improvements

* ⚡ clean up and linter fixes

* ⚡ merged search and query, more hints

* ⚡ Improvements

* ⚡ Add generic type to authentication method

Co-authored-by: Michael Kret <michael.k@radency.com>
Co-authored-by: ricardo <ricardoespinoza105@gmail.com>
This commit is contained in:
Jan Thiel
2022-07-10 10:37:41 +02:00
committed by GitHub
parent af45a07f21
commit dbc02803db
5 changed files with 348 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

267
packages/nodes-base/nodes/FreshworksCrm/descriptions/SearchDescription.ts Normal file
View File

@@ -0,0 +1,267 @@
import {
INodeProperties,
} from 'n8n-workflow';
export const searchOperations: INodeProperties[] = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
noDataExpression: true,
displayOptions: {
show: {
resource: [
'search',
],
},
},
options: [
{
name: 'Query',
value: 'query',
description: 'Search for records by entering search queries of your choice',
},
{
name: 'Lookup',
value: 'lookup',
description: 'Search for the name or email address of records',
},
],
default: 'query',
},
];
export const searchFields: INodeProperties[] = [
// ----------------------------------------
// Search: query
// ----------------------------------------
{
displayName: 'Search Term',
name: 'query',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'search',
],
operation: [
'query',
],
},
},
description: 'Enter a term that will be used for searching entities',
},
{
displayName: 'Search on Entities',
name: 'entities',
type: 'multiOptions',
options: [
{
name: 'Contact',
value: 'contact',
},
{
name: 'Deal',
value: 'deal',
},
{
name: 'Sales Account',
value: 'sales_account',
},
{
name: 'User',
value: 'user',
},
],
required: true,
default: [],
displayOptions: {
show: {
resource: [
'search',
],
operation: [
'query',
],
},
},
description: 'Enter a term that will be used for searching entities',
},
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
default: false,
displayOptions: {
show: {
resource: [
'search',
],
operation: [
'query',
],
},
},
description: 'Whether to return all results or only up to a given limit',
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
default: 25,
displayOptions: {
show: {
resource: [
'search',
],
operation: [
'query',
],
returnAll: [
false,
],
},
},
description: 'Max number of results to return',
},
// ----------------------------------------
// Search: lookup
// ----------------------------------------
{
displayName: 'Search Field',
name: 'searchField',
type: 'options',
options: [
{
name: 'Email',
value: 'email',
},
{
name: 'Name',
value: 'name',
},
{
name: 'Custom Field',
value: 'customField',
description: 'Only allowed custom fields of type "Text field", "Number", "Dropdown" or "Radio button"',
},
],
required: true,
default: '',
displayOptions: {
show: {
resource: [
'search',
],
operation: [
'lookup',
],
},
},
description: 'Field against which the entities have to be searched',
},
{
displayName: 'Custom Field Name',
name: 'customFieldName',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'search',
],
operation: [
'lookup',
],
searchField: [
'customField',
],
},
},
},
{
displayName: 'Custom Field Value',
name: 'customFieldValue',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'search',
],
operation: [
'lookup',
],
searchField: [
'customField',
],
},
},
},
{
displayName: 'Field Value',
name: 'fieldValue',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'search',
],
operation: [
'lookup',
],
searchField: [
'email',
'name',
],
},
},
},
{
displayName: 'Options',
name: 'options',
type: 'collection',
placeholder: 'Add Option',
default: {},
displayOptions: {
show: {
resource: [
'search',
],
operation: [
'lookup',
],
},
},
options: [
{
displayName: 'Entities',
name: 'entities',
type: 'multiOptions',
default: [],
options: [
{
name: 'Contact',
value: 'contact',
},
{
name: 'Deal',
value: 'deal',
},
{
name: 'Sales Account',
value: 'sales_account',
},
],
// eslint-disable-next-line n8n-nodes-base/node-param-description-unneeded-backticks
description: `Use 'entities' to query against related entities. You can include multiple entities at once, provided the field is available in both entities or else you'd receive an error response.`,
},
],
},
];