mudhorn/n8n
1
0
Fork 0
mirror of https://github.com/n8n-io/n8n.git synced 2024-11-15 09:04:07 -08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
n8n/packages/nodes-base/nodes/FreshworksCrm/descriptions/ContactDescription.ts
Iván Ovejero a661dece4d
✨ Add Freshworks node (#2017) 
* ✨ Create Freshworks node

* ⚡ Implement all getAll operations

* ⚡ Add tz to appointment:create and update

* ⚡ Fix repetition in email in contact:create

* ⚡ Add tz to salesActivity:create and update

* ⚡ Add tz to task:create and update

* 🔥 Remove required from due date

* ⚡ Add all-day setting to appointment

* ⚡ Add filters to all operations

* ⚡ Improvements

* ⚡ Minor improvements

* ⚡ Additional parameter display name changes

Co-authored-by: ricardo <ricardoespinoza105@gmail.com>
Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
2021-07-30 16:12:30 +02:00

669 lines
14 KiB
TypeScript
Raw Blame History

import {
INodeProperties,
} from 'n8n-workflow';
export const contactOperations = [
{
displayName: 'Operation',
name: 'operation',
type: 'options',
displayOptions: {
show: {
resource: [
'contact',
],
},
},
options: [
{
name: 'Create',
value: 'create',
description: 'Create a contact',
},
{
name: 'Delete',
value: 'delete',
description: 'Delete a contact',
},
{
name: 'Get',
value: 'get',
description: 'Retrieve a contact',
},
{
name: 'Get All',
value: 'getAll',
description: 'Retrieve all contacts',
},
{
name: 'Update',
value: 'update',
description: 'Update a contact',
},
],
default: 'create',
},
] as INodeProperties[];
export const contactFields = [
// ----------------------------------------
// contact: create
// ----------------------------------------
{
displayName: 'First Name',
name: 'firstName',
description: 'First name of the contact',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'contact',
],
operation: [
'create',
],
},
},
},
{
displayName: 'Last Name',
name: 'lastName',
description: 'Last name of the contact',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'contact',
],
operation: [
'create',
],
},
},
},
{
displayName: 'Email Address',
name: 'emails',
type: 'string',
default: '',
description: 'Email addresses of the contact',
required: true,
displayOptions: {
show: {
resource: [
'contact',
],
operation: [
'create',
],
},
},
},
{
displayName: 'Additional Fields',
name: 'additionalFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'contact',
],
operation: [
'create',
],
},
},
options: [
{
displayName: 'Address',
name: 'address',
type: 'string',
default: '',
description: 'Address of the contact',
},
{
displayName: 'Campaign ID',
name: 'campaign_id',
type: 'options',
default: '',
typeOptions: {
loadOptionsMethod: 'getCampaigns',
},
description: 'ID of the campaign that led your contact to your webapp',
},
{
displayName: 'City',
name: 'city',
type: 'string',
default: '',
description: 'City that the contact belongs to',
},
{
displayName: 'Contact Status ID',
name: 'contact_status_id',
type: 'options',
default: '',
typeOptions: {
loadOptionsMethod: 'getContactStatuses',
},
description: 'ID of the contact status that the contact belongs to',
},
{
displayName: 'Country',
name: 'country',
type: 'string',
default: '',
description: 'Country that the contact belongs to',
},
{
displayName: 'External ID',
name: 'external_id',
type: 'string',
default: '',
description: 'External ID of the contact',
},
{
displayName: 'Facebook',
name: 'facebook',
type: 'string',
default: '',
description: 'Facebook username of the contact',
},
{
displayName: 'Job Title',
name: 'job_title',
type: 'string',
default: '',
description: 'Designation of the contact in the account they belong to',
},
{
displayName: 'Keywords',
name: 'keyword',
type: 'string',
default: '',
description: 'Keywords that the contact used to reach your website/web app',
},
{
displayName: 'Lead Source ID',
name: 'lead_source_id',
type: 'string', // not obtainable from API
default: '',
description: 'ID of the source where contact came from',
},
{
displayName: 'Lifecycle Stage ID',
name: 'lifecycle_stage_id',
type: 'options',
default: '',
typeOptions: {
loadOptionsMethod: 'getLifecycleStages',
},
description: 'ID of the lifecycle stage that the contact belongs to',
},
{
displayName: 'LinkedIn',
name: 'linkedin',
type: 'string',
default: '',
description: 'LinkedIn account of the contact',
},
{
displayName: 'Medium',
name: 'medium',
type: 'string',
default: '',
description: 'Medium that led your contact to your website/webapp',
},
{
displayName: 'Mobile Number',
name: 'mobile_number',
type: 'string',
default: '',
description: 'Mobile phone number of the contact',
},
{
displayName: 'Owner ID',
name: 'owner_id',
type: 'options',
default: '',
typeOptions: {
loadOptionsMethod: 'getUsers',
},
description: 'ID of the user to whom the contact is assigned',
},
{
displayName: 'Sales Accounts',
name: 'sales_accounts',
type: 'multiOptions',
default: [],
typeOptions: {
loadOptionsMethod: 'getAccounts',
},
description: 'Accounts which contact belongs to',
},
{
displayName: 'State',
name: 'state',
type: 'string',
default: '',
description: 'State that the contact belongs to',
},
{
displayName: 'Subscription Status',
name: 'subscription_status',
type: 'string', // not obtainable from API
default: '',
description: 'Status of subscription that the contact is in',
},
{
displayName: 'Subscription Types',
name: 'subscription_types',
type: 'string', // not obtainable from API
default: '',
description: 'Type of subscription that the contact is in',
},
{
displayName: 'Territory ID',
name: 'territory_id',
type: 'options',
default: '',
typeOptions: {
loadOptionsMethod: 'getTerritories',
},
description: 'ID of the territory that the contact belongs to',
},
{
displayName: 'Time Zone',
name: 'time_zone',
type: 'string',
default: '',
description: 'Timezone that the contact belongs to',
},
{
displayName: 'Twitter',
name: 'twitter',
type: 'string',
default: '',
description: 'Twitter username of the contact',
},
{
displayName: 'Work Number',
name: 'work_number',
type: 'string',
default: '',
description: 'Work phone number of the contact',
},
{
displayName: 'Zipcode',
name: 'zipcode',
type: 'string',
default: '',
description: 'Zipcode of the region that the contact belongs to',
},
],
},
// ----------------------------------------
// contact: delete
// ----------------------------------------
{
displayName: 'Contact ID',
name: 'contactId',
description: 'ID of the contact to delete',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'contact',
],
operation: [
'delete',
],
},
},
},
// ----------------------------------------
// contact: get
// ----------------------------------------
{
displayName: 'Contact ID',
name: 'contactId',
description: 'ID of the contact to retrieve',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'contact',
],
operation: [
'get',
],
},
},
},
// ----------------------------------------
// contact: getAll
// ----------------------------------------
{
displayName: 'View',
name: 'view',
type: 'options',
displayOptions: {
show: {
resource: [
'contact',
],
operation: [
'getAll',
],
},
},
typeOptions: {
loadOptionsMethod: 'getContactViews',
},
default: '',
},
{
displayName: 'Return All',
name: 'returnAll',
type: 'boolean',
default: false,
description: 'Whether to return all results or only up to a given limit',
displayOptions: {
show: {
resource: [
'contact',
],
operation: [
'getAll',
],
},
},
},
{
displayName: 'Limit',
name: 'limit',
type: 'number',
default: 50,
description: 'How many results to return',
typeOptions: {
minValue: 1,
},
displayOptions: {
show: {
resource: [
'contact',
],
operation: [
'getAll',
],
returnAll: [
false,
],
},
},
},
// ----------------------------------------
// contact: update
// ----------------------------------------
{
displayName: 'Contact ID',
name: 'contactId',
description: 'ID of the contact to update',
type: 'string',
required: true,
default: '',
displayOptions: {
show: {
resource: [
'contact',
],
operation: [
'update',
],
},
},
},
{
displayName: 'Update Fields',
name: 'updateFields',
type: 'collection',
placeholder: 'Add Field',
default: {},
displayOptions: {
show: {
resource: [
'contact',
],
operation: [
'update',
],
},
},
options: [
{
displayName: 'Address',
name: 'address',
type: 'string',
default: '',
description: 'Address of the contact',
},
{
displayName: 'Campaign ID',
name: 'campaign_id',
type: 'options',
default: '',
typeOptions: {
loadOptionsMethod: 'getCampaigns',
},
description: 'ID of the campaign that led your contact to your webapp',
},
{
displayName: 'City',
name: 'city',
type: 'string',
default: '',
description: 'City that the contact belongs to',
},
{
displayName: 'Contact Status ID',
name: 'contact_status_id',
type: 'options',
default: '',
typeOptions: {
loadOptionsMethod: 'getContactStatuses',
},
description: 'ID of the contact status that the contact belongs to',
},
{
displayName: 'Country',
name: 'country',
type: 'string',
default: '',
description: 'Country that the contact belongs to',
},
{
displayName: 'External ID',
name: 'external_id',
type: 'string',
default: '',
description: 'External ID of the contact',
},
{
displayName: 'Facebook',
name: 'facebook',
type: 'string',
default: '',
description: 'Facebook username of the contact',
},
{
displayName: 'First Name',
name: 'first_name',
type: 'string',
default: '',
description: 'First name of the contact',
},
{
displayName: 'Job Title',
name: 'job_title',
type: 'string',
default: '',
description: 'Designation of the contact in the account they belong to',
},
{
displayName: 'Keywords',
name: 'keyword',
type: 'string',
default: '',
description: 'Keywords that the contact used to reach your website/web app',
},
{
displayName: 'Last Name',
name: 'last_name',
type: 'string',
default: '',
description: 'Last name of the contact',
},
{
displayName: 'Lead Source ID',
name: 'lead_source_id',
type: 'options',
default: '',
typeOptions: {
loadOptionsMethod: 'getLeadSources',
},
description: 'ID of the source where contact came from',
},
{
displayName: 'Lifecycle Stage ID',
name: 'lifecycle_stage_id',
type: 'options',
default: '',
typeOptions: {
loadOptionsMethod: 'getLifecycleStages',
},
description: 'ID of the lifecycle stage that the contact belongs to',
},
{
displayName: 'LinkedIn',
name: 'linkedin',
type: 'string',
default: '',
description: 'LinkedIn account of the contact',
},
{
displayName: 'Medium',
name: 'medium',
type: 'string',
default: '',
description: 'Medium that led your contact to your website/webapp',
},
{
displayName: 'Mobile Number',
name: 'mobile_number',
type: 'string',
default: '',
description: 'Mobile phone number of the contact',
},
{
displayName: 'Owner ID',
name: 'owner_id',
type: 'options',
default: '',
typeOptions: {
loadOptionsMethod: 'getUsers',
},
description: 'ID of the user to whom the contact is assigned',
},
{
displayName: 'Sales Accounts',
name: 'sales_accounts',
type: 'multiOptions',
default: [],
typeOptions: {
loadOptionsMethod: 'getAccounts',
},
description: 'Accounts which contact belongs to',
},
{
displayName: 'State',
name: 'state',
type: 'string',
default: '',
description: 'State that the contact belongs to',
},
{
displayName: 'Subscription Status',
name: 'subscription_status',
type: 'options',
default: '',
typeOptions: {
loadOptionsMethod: 'getSubscriptionStatuses',
},
description: 'Status of subscription that the contact is in',
},
{
displayName: 'Subscription Types',
name: 'subscription_types',
type: 'options',
default: '',
typeOptions: {
loadOptionsMethod: 'getSubscriptionTypes',
},
description: 'Type of subscription that the contact is in',
},
{
displayName: 'Territory ID',
name: 'territory_id',
type: 'options',
default: '',
typeOptions: {
loadOptionsMethod: 'getTerritories',
},
description: 'ID of the territory that the contact belongs to',
},
{
displayName: 'Time Zone',
name: 'time_zone',
type: 'string',
default: '',
description: 'Timezone that the contact belongs to',
},
{
displayName: 'Twitter',
name: 'twitter',
type: 'string',
default: '',
description: 'Twitter username of the contact',
},
{
displayName: 'Work Number',
name: 'work_number',
type: 'string',
default: '',
description: 'Work phone number of the contact',
},
{
displayName: 'Zipcode',
name: 'zipcode',
type: 'string',
default: '',
description: 'Zipcode of the region that the contact belongs to',
},
],
},
] as INodeProperties[];
Reference in a new issue View git blame Copy permalink