2020-04-17 14:42:41 -07:00
import {
INodeProperties ,
2021-01-31 23:31:40 -08:00
} from 'n8n-workflow' ;
2020-04-17 14:42:41 -07:00
2021-12-03 00:44:16 -08:00
export const companyOperations : INodeProperties [ ] = [
2020-04-17 14:42:41 -07:00
{
displayName : 'Operation' ,
name : 'operation' ,
type : 'options' ,
2022-05-20 14:47:24 -07:00
noDataExpression : true ,
2020-04-17 14:42:41 -07:00
displayOptions : {
show : {
resource : [
'company' ,
] ,
} ,
} ,
options : [
{
name : 'Create' ,
value : 'create' ,
description : 'Create a company' ,
} ,
{
name : 'Delete' ,
value : 'delete' ,
description : 'Delete a company' ,
} ,
{
name : 'Get' ,
value : 'get' ,
description : 'Get a company' ,
} ,
{
name : 'Get All' ,
value : 'getAll' ,
2020-07-24 03:56:41 -07:00
description : 'Get all companies' ,
2020-04-17 14:42:41 -07:00
} ,
{
name : 'Get Recently Created' ,
value : 'getRecentlyCreated' ,
description : 'Get recently created companies' ,
} ,
{
name : 'Get Recently Modified' ,
value : 'getRecentlyModified' ,
description : 'Get recently modified companies' ,
} ,
{
name : 'Search By Domain' ,
value : 'searchByDomain' ,
description : 'Search companies by domain' ,
} ,
{
name : 'Update' ,
value : 'update' ,
description : 'Update a company' ,
} ,
] ,
default : 'create' ,
} ,
2021-12-03 00:44:16 -08:00
] ;
2020-04-17 14:42:41 -07:00
2021-12-03 00:44:16 -08:00
export const companyFields : INodeProperties [ ] = [
2020-04-17 14:42:41 -07:00
2021-01-31 23:31:40 -08:00
/* -------------------------------------------------------------------------- */
/* company:create */
/* -------------------------------------------------------------------------- */
2020-04-17 14:42:41 -07:00
{
displayName : 'Name' ,
name : 'name' ,
type : 'string' ,
required : true ,
displayOptions : {
show : {
resource : [
'company' ,
] ,
operation : [
'create' ,
] ,
} ,
} ,
default : '' ,
} ,
{
displayName : 'Additional Fields' ,
name : 'additionalFields' ,
type : 'collection' ,
placeholder : 'Add Field' ,
default : { } ,
displayOptions : {
show : {
resource : [
'company' ,
] ,
operation : [
'create' ,
] ,
} ,
} ,
options : [
{
displayName : 'About Us' ,
name : 'aboutUs' ,
type : 'string' ,
typeOptions : {
alwaysOpenEditWindow : true ,
} ,
default : '' ,
} ,
{
displayName : 'Annual Revenue' ,
name : 'annualRevenue' ,
type : 'number' ,
typeOptions : {
minValue : 0 ,
} ,
default : 0 ,
description : 'The actual or estimated annual revenue of the company' ,
} ,
{
displayName : 'City' ,
name : 'city' ,
type : 'string' ,
default : '' ,
2022-05-06 14:01:25 -07:00
description : 'The city where the company is located' ,
2020-04-17 14:42:41 -07:00
} ,
{
displayName : 'Close Date' ,
name : 'closeDate' ,
type : 'dateTime' ,
default : '' ,
description : 'The date the company or organization was closed as a customer' ,
} ,
{
displayName : 'Company Domain Name' ,
name : 'companyDomainName' ,
type : 'string' ,
default : '' ,
2020-10-22 06:46:03 -07:00
description : 'The domain name of the company or organization' ,
2020-04-17 14:42:41 -07:00
} ,
{
2022-06-03 10:23:49 -07:00
displayName : 'Company Owner Name or ID' ,
2020-04-17 14:42:41 -07:00
name : 'companyOwner' ,
type : 'options' ,
typeOptions : {
loadOptionsMethod : 'getOwners' ,
} ,
default : '' ,
2022-06-03 10:23:49 -07:00
description : 'The owner of the company. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>.' ,
2020-04-17 14:42:41 -07:00
} ,
{
displayName : 'Country/Region' ,
name : 'countryRegion' ,
type : 'string' ,
default : '' ,
2022-05-06 14:01:25 -07:00
description : 'The country/region in which the company or organization is located' ,
2020-04-17 14:42:41 -07:00
} ,
2021-02-04 06:31:48 -08:00
{
displayName : 'Custom Properties' ,
name : 'customPropertiesUi' ,
placeholder : 'Add Custom Property' ,
type : 'fixedCollection' ,
typeOptions : {
multipleValues : true ,
} ,
default : { } ,
options : [
{
name : 'customPropertiesValues' ,
displayName : 'Custom Property' ,
values : [
{
2022-06-03 10:23:49 -07:00
displayName : 'Property Name or ID' ,
2021-02-04 06:31:48 -08:00
name : 'property' ,
type : 'options' ,
typeOptions : {
loadOptionsMethod : 'getCompanyCustomProperties' ,
} ,
default : '' ,
2022-06-03 10:23:49 -07:00
description : 'Name of the property. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>.' ,
2021-02-04 06:31:48 -08:00
} ,
{
displayName : 'Value' ,
name : 'value' ,
type : 'string' ,
default : '' ,
description : 'Value of the property' ,
} ,
] ,
} ,
] ,
} ,
2020-04-17 14:42:41 -07:00
{
displayName : 'Description' ,
name : 'description' ,
type : 'string' ,
default : '' ,
2022-05-06 14:01:25 -07:00
description : 'A short statement about the company\'s mission and goals' ,
2020-04-17 14:42:41 -07:00
} ,
{
displayName : 'Facebook Fans' ,
name : 'facebookFans' ,
type : 'number' ,
typeOptions : {
minValue : 0 ,
} ,
default : 0 ,
description : 'Number of facebook fans' ,
} ,
{
displayName : 'Google Plus Page' ,
name : 'googlePlusPage' ,
type : 'string' ,
default : '' ,
description : 'The URL of the Google Plus page for the company or organization' ,
} ,
{
2022-06-03 10:23:49 -07:00
displayName : 'Industry Name or ID' ,
2020-04-17 14:42:41 -07:00
name : 'industry' ,
type : 'options' ,
typeOptions : {
2020-10-22 06:46:03 -07:00
loadOptionsMethod : 'getCompanyIndustries' ,
2020-04-17 14:42:41 -07:00
} ,
default : '' ,
2022-06-03 10:23:49 -07:00
description : 'The type of business the company performs. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>.' ,
2020-04-17 14:42:41 -07:00
} ,
{
displayName : 'Is Public' ,
name : 'isPublic' ,
type : 'boolean' ,
default : false ,
2022-05-06 14:01:25 -07:00
description : 'Indicates that the company is publicly traded' ,
2020-04-17 14:42:41 -07:00
} ,
{
2022-06-03 10:23:49 -07:00
displayName : 'Lead Status Name or ID' ,
2020-04-17 14:42:41 -07:00
name : 'leadStatus' ,
type : 'options' ,
typeOptions : {
loadOptionsMethod : 'getCompanyleadStatuses' ,
} ,
default : '' ,
2022-06-03 10:23:49 -07:00
description : 'The company\'s sales, prospecting or outreach status. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>.' ,
2020-04-17 14:42:41 -07:00
} ,
{
2022-06-03 10:23:49 -07:00
displayName : 'Lifecycle Stage Name or ID' ,
2020-04-17 14:42:41 -07:00
name : 'lifecycleStatus' ,
type : 'options' ,
typeOptions : {
loadOptionsMethod : 'getCompanylifecycleStages' ,
} ,
default : '' ,
2022-06-03 10:23:49 -07:00
description : 'The most advanced lifecycle stage across all contacts associated with this company or organization. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>.' ,
2020-04-17 14:42:41 -07:00
} ,
{
displayName : 'LinkedIn Bio' ,
name : 'linkedinBio' ,
type : 'string' ,
default : '' ,
description : 'The LinkedIn bio for the company or organization' ,
} ,
{
displayName : 'LinkedIn Company Page' ,
name : 'linkedInCompanyPage' ,
type : 'string' ,
default : '' ,
description : 'The URL of the LinkedIn company page for the company or organization' ,
} ,
{
displayName : 'Number Of Employees' ,
name : 'numberOfEmployees' ,
type : 'number' ,
typeOptions : {
minValue : 0 ,
} ,
default : 0 ,
description : 'The total number of employees who work for the company or organization' ,
} ,
{
2022-06-03 10:23:49 -07:00
displayName : 'Original Source Type Name or ID' ,
2020-04-17 14:42:41 -07:00
name : 'originalSourceType' ,
type : 'options' ,
typeOptions : {
loadOptionsMethod : 'getCompanySourceTypes' ,
} ,
default : '' ,
2022-06-03 10:23:49 -07:00
description : 'Original source for the contact with the earliest activity for this company or organization. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>.' ,
2020-04-17 14:42:41 -07:00
} ,
{
displayName : 'Phone Number' ,
name : 'phoneNumber' ,
type : 'string' ,
default : '' ,
2022-05-06 14:01:25 -07:00
description : 'A company\'s primary phone number. Powered by HubSpot Insights.' ,
2020-04-17 14:42:41 -07:00
} ,
{
displayName : 'Postal Code' ,
name : 'postalCode' ,
type : 'string' ,
default : '' ,
description : 'The postal or zip code of the company or organization. Powered by HubSpot Insights.' ,
} ,
{
displayName : 'State/Region' ,
name : 'stateRegion' ,
type : 'string' ,
default : '' ,
description : 'The state or region in which the company or organization is located. Powered by HubSpot Insights.' ,
} ,
{
displayName : 'Street Address' ,
name : 'streetAddress' ,
type : 'string' ,
default : '' ,
description : 'The street address of the company or organization, including unit number. Powered by HubSpot Insights.' ,
} ,
{
displayName : 'Street Address 2' ,
name : 'streetAddress2' ,
type : 'string' ,
default : '' ,
description : 'The additional address of the company or organization. Powered by HubSpot Insights.' ,
} ,
{
2022-06-03 10:23:49 -07:00
displayName : 'Target Account Name or ID' ,
2020-04-17 14:42:41 -07:00
name : 'targetAccount' ,
type : 'options' ,
typeOptions : {
loadOptionsMethod : 'getCompanyTargetAccounts' ,
} ,
default : '' ,
2022-06-03 10:23:49 -07:00
description : 'The Target Account property is a means to flag high priority companies if you are following an account based strategy. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>.' ,
2020-04-17 14:42:41 -07:00
} ,
{
displayName : 'Timezone' ,
name : 'timezone' ,
type : 'string' ,
default : '' ,
description : 'The time zone where the company or organization is located. Powered by HubSpot Insights.' ,
} ,
{
displayName : 'Total Money Raised' ,
name : 'totalMoneyRaised' ,
type : 'number' ,
typeOptions : {
minValue : 0 ,
} ,
default : 0 ,
description : 'The total amount of money raised by the company. Powered by HubSpot Insights.' ,
} ,
{
displayName : 'Twitter Bio' ,
name : 'twitterBio' ,
type : 'string' ,
typeOptions : {
alwaysOpenEditWindow : true ,
} ,
default : '' ,
description : 'The Twitter bio of the company or organization' ,
} ,
{
displayName : 'Twitter Followers' ,
name : 'twitterFollowers' ,
type : 'number' ,
typeOptions : {
minValue : 0 ,
} ,
default : 0 ,
description : 'The number of Twitter followers of the company or organization' ,
} ,
{
displayName : 'Twitter Handle' ,
name : 'twitterHandle' ,
type : 'string' ,
default : '' ,
description : 'The main twitter account of the company or organization' ,
} ,
{
2022-06-03 10:23:49 -07:00
displayName : 'Type Name or ID' ,
2020-04-17 14:42:41 -07:00
name : 'type' ,
type : 'options' ,
typeOptions : {
loadOptionsMethod : 'getCompanyTypes' ,
} ,
default : '' ,
2022-06-03 10:23:49 -07:00
description : 'The optional classification of this company record - prospect, partner, etc. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>.' ,
2020-04-17 14:42:41 -07:00
} ,
{
2022-06-03 10:23:49 -07:00
displayName : 'Web Technologies Name or ID' ,
2020-04-17 14:42:41 -07:00
name : 'webTechnologies' ,
type : 'options' ,
typeOptions : {
2020-10-22 06:46:03 -07:00
loadOptionsMethod : 'getCompanyWebTechnologies' ,
2020-04-17 14:42:41 -07:00
} ,
default : '' ,
2022-06-03 10:23:49 -07:00
description : 'The web technologies used by the company or organization. Powered by HubSpot Insights. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>.' ,
2020-04-17 14:42:41 -07:00
} ,
{
displayName : 'Website URL' ,
name : 'websiteUrl' ,
type : 'string' ,
default : '' ,
description : 'The main website of the company or organization. This property is used to identify unique companies. Powered by HubSpot Insights.' ,
} ,
{
2021-01-31 23:31:40 -08:00
displayName : 'Year Founded' ,
2020-04-17 14:42:41 -07:00
name : 'yearFounded' ,
type : 'string' ,
default : '' ,
description : 'The year the company was created. Powered by HubSpot Insights.' ,
} ,
2020-10-22 06:46:03 -07:00
] ,
2020-04-17 14:42:41 -07:00
} ,
2021-01-31 23:31:40 -08:00
/* -------------------------------------------------------------------------- */
/* company:update */
/* -------------------------------------------------------------------------- */
2020-04-17 14:42:41 -07:00
{
displayName : 'Company ID' ,
name : 'companyId' ,
type : 'string' ,
required : true ,
displayOptions : {
show : {
resource : [
'company' ,
] ,
operation : [
'update' ,
] ,
} ,
} ,
default : '' ,
description : 'Unique identifier for a particular company' ,
} ,
{
displayName : 'Update Fields' ,
name : 'updateFields' ,
type : 'collection' ,
placeholder : 'Add Field' ,
default : { } ,
displayOptions : {
show : {
resource : [
'company' ,
] ,
operation : [
'update' ,
] ,
} ,
} ,
options : [
{
displayName : 'About Us' ,
name : 'aboutUs' ,
type : 'string' ,
typeOptions : {
alwaysOpenEditWindow : true ,
} ,
default : '' ,
} ,
{
displayName : 'Annual Revenue' ,
name : 'annualRevenue' ,
type : 'number' ,
typeOptions : {
minValue : 0 ,
} ,
default : 0 ,
description : 'The actual or estimated annual revenue of the company' ,
} ,
{
displayName : 'City' ,
name : 'city' ,
type : 'string' ,
default : '' ,
2022-05-06 14:01:25 -07:00
description : 'The city where the company is located' ,
2020-04-17 14:42:41 -07:00
} ,
{
displayName : 'Close Date' ,
name : 'closeDate' ,
type : 'dateTime' ,
default : '' ,
description : 'The date the company or organization was closed as a customer' ,
} ,
{
displayName : 'Company Domain Name' ,
name : 'companyDomainName' ,
type : 'string' ,
default : '' ,
2020-10-22 06:46:03 -07:00
description : 'The domain name of the company or organization' ,
2020-04-17 14:42:41 -07:00
} ,
{
2022-06-03 10:23:49 -07:00
displayName : 'Company Owmer Name or ID' ,
2020-04-17 14:42:41 -07:00
name : 'companyOwner' ,
type : 'options' ,
typeOptions : {
loadOptionsMethod : 'getOwners' ,
} ,
default : '' ,
2022-06-03 10:23:49 -07:00
description : 'The owner of the company. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>.' ,
2020-04-17 14:42:41 -07:00
} ,
{
displayName : 'Country/Region' ,
name : 'countryRegion' ,
type : 'string' ,
default : '' ,
2022-05-06 14:01:25 -07:00
description : 'The country/region in which the company or organization is located' ,
2020-04-17 14:42:41 -07:00
} ,
2021-02-04 06:31:48 -08:00
{
displayName : 'Custom Properties' ,
name : 'customPropertiesUi' ,
placeholder : 'Add Custom Property' ,
type : 'fixedCollection' ,
typeOptions : {
multipleValues : true ,
} ,
default : { } ,
options : [
{
name : 'customPropertiesValues' ,
displayName : 'Custom Property' ,
values : [
{
2022-06-03 10:23:49 -07:00
displayName : 'Property Name or ID' ,
2021-02-04 06:31:48 -08:00
name : 'property' ,
type : 'options' ,
typeOptions : {
loadOptionsMethod : 'getCompanyCustomProperties' ,
} ,
default : '' ,
2022-06-03 10:23:49 -07:00
description : 'Name of the property. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>.' ,
2021-02-04 06:31:48 -08:00
} ,
{
displayName : 'Value' ,
name : 'value' ,
type : 'string' ,
default : '' ,
description : 'Value of the property' ,
} ,
] ,
} ,
] ,
} ,
2020-04-17 14:42:41 -07:00
{
displayName : 'Description' ,
name : 'description' ,
type : 'string' ,
default : '' ,
2022-05-06 14:01:25 -07:00
description : 'A short statement about the company\'s mission and goals' ,
2020-04-17 14:42:41 -07:00
} ,
{
displayName : 'Facebook Fans' ,
name : 'facebookFans' ,
type : 'number' ,
typeOptions : {
minValue : 0 ,
} ,
default : 0 ,
description : 'Number of facebook fans' ,
} ,
{
displayName : 'Google Plus Page' ,
name : 'googlePlusPage' ,
type : 'string' ,
default : '' ,
description : 'The URL of the Google Plus page for the company or organization' ,
} ,
{
2022-06-03 10:23:49 -07:00
displayName : 'Industry Name or ID' ,
2020-04-17 14:42:41 -07:00
name : 'industry' ,
type : 'options' ,
typeOptions : {
2020-10-22 06:46:03 -07:00
loadOptionsMethod : 'getCompanyIndustries' ,
2020-04-17 14:42:41 -07:00
} ,
default : '' ,
2022-06-03 10:23:49 -07:00
description : 'The type of business the company performs. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>.' ,
2020-04-17 14:42:41 -07:00
} ,
{
displayName : 'Is Public' ,
name : 'isPublic' ,
type : 'boolean' ,
default : false ,
2022-05-06 14:01:25 -07:00
description : 'Indicates that the company is publicly traded' ,
2020-04-17 14:42:41 -07:00
} ,
{
2022-06-03 10:23:49 -07:00
displayName : 'Lead Status Name or ID' ,
2020-04-17 14:42:41 -07:00
name : 'leadStatus' ,
type : 'options' ,
typeOptions : {
loadOptionsMethod : 'getCompanyleadStatuses' ,
} ,
default : '' ,
2022-06-03 10:23:49 -07:00
description : 'The company\'s sales, prospecting or outreach status. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>.' ,
2020-04-17 14:42:41 -07:00
} ,
{
2022-06-03 10:23:49 -07:00
displayName : 'Lifecycle Stage Name or ID' ,
2020-04-17 14:42:41 -07:00
name : 'lifecycleStatus' ,
type : 'options' ,
typeOptions : {
loadOptionsMethod : 'getCompanylifecycleStages' ,
} ,
default : '' ,
2022-06-03 10:23:49 -07:00
description : 'The most advanced lifecycle stage across all contacts associated with this company or organization. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>.' ,
2020-04-17 14:42:41 -07:00
} ,
{
displayName : 'Linkedin Bio' ,
name : 'linkedinBio' ,
type : 'string' ,
default : '' ,
description : 'The LinkedIn bio for the company or organization' ,
} ,
{
displayName : 'LinkedIn Company Page' ,
name : 'linkedInCompanyPage' ,
type : 'string' ,
default : '' ,
description : 'The URL of the LinkedIn company page for the company or organization' ,
} ,
{
displayName : 'Name' ,
name : 'name' ,
type : 'string' ,
default : '' ,
} ,
{
displayName : 'Number Of Employees' ,
name : 'numberOfEmployees' ,
type : 'number' ,
typeOptions : {
minValue : 0 ,
} ,
default : 0 ,
description : 'The total number of employees who work for the company or organization' ,
} ,
{
2022-06-03 10:23:49 -07:00
displayName : 'Original Source Type Name or ID' ,
2020-04-17 14:42:41 -07:00
name : 'originalSourceType' ,
type : 'options' ,
typeOptions : {
loadOptionsMethod : 'getCompanySourceTypes' ,
} ,
default : '' ,
2022-06-03 10:23:49 -07:00
description : 'Original source for the contact with the earliest activity for this company or organization. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>.' ,
2020-04-17 14:42:41 -07:00
} ,
{
displayName : 'Phone Number' ,
name : 'phoneNumber' ,
type : 'string' ,
default : '' ,
2022-05-06 14:01:25 -07:00
description : 'A company\'s primary phone number. Powered by HubSpot Insights.' ,
2020-04-17 14:42:41 -07:00
} ,
{
displayName : 'Postal Code' ,
name : 'postalCode' ,
type : 'string' ,
default : '' ,
description : 'The postal or zip code of the company or organization. Powered by HubSpot Insights.' ,
} ,
{
displayName : 'State/Region' ,
name : 'stateRegion' ,
type : 'string' ,
default : '' ,
description : 'The state or region in which the company or organization is located. Powered by HubSpot Insights.' ,
} ,
{
displayName : 'Street Address' ,
name : 'streetAddress' ,
type : 'string' ,
default : '' ,
description : 'The street address of the company or organization, including unit number. Powered by HubSpot Insights.' ,
} ,
{
displayName : 'Street Address 2' ,
name : 'streetAddress2' ,
type : 'string' ,
default : '' ,
description : 'The additional address of the company or organization. Powered by HubSpot Insights.' ,
} ,
{
2022-06-03 10:23:49 -07:00
displayName : 'Target Account Name or ID' ,
2020-04-17 14:42:41 -07:00
name : 'targetAccount' ,
type : 'options' ,
typeOptions : {
loadOptionsMethod : 'getCompanyTargetAccounts' ,
} ,
default : '' ,
2022-06-03 10:23:49 -07:00
description : 'The Target Account property is a means to flag high priority companies if you are following an account based strategy. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>.' ,
2020-04-17 14:42:41 -07:00
} ,
{
displayName : 'Timezone' ,
name : 'timezone' ,
type : 'string' ,
default : '' ,
description : 'The time zone where the company or organization is located. Powered by HubSpot Insights.' ,
} ,
{
displayName : 'Total Money Raised' ,
name : 'totalMoneyRaised' ,
type : 'number' ,
typeOptions : {
minValue : 0 ,
} ,
default : 0 ,
description : 'The total amount of money raised by the company. Powered by HubSpot Insights.' ,
} ,
{
displayName : 'Twitter Bio' ,
name : 'twitterBio' ,
type : 'string' ,
typeOptions : {
alwaysOpenEditWindow : true ,
} ,
default : '' ,
description : 'The Twitter bio of the company or organization' ,
} ,
{
displayName : 'Twitter Followers' ,
name : 'twitterFollowers' ,
type : 'number' ,
typeOptions : {
minValue : 0 ,
} ,
default : 0 ,
description : 'The number of Twitter followers of the company or organization' ,
} ,
{
displayName : 'Twitter Handle' ,
name : 'twitterHandle' ,
type : 'string' ,
default : '' ,
description : 'The main twitter account of the company or organization' ,
} ,
{
2022-06-03 10:23:49 -07:00
displayName : 'Type Name or ID' ,
2020-04-17 14:42:41 -07:00
name : 'type' ,
type : 'options' ,
typeOptions : {
loadOptionsMethod : 'getCompanyTypes' ,
} ,
default : '' ,
2022-06-03 10:23:49 -07:00
description : 'The optional classification of this company record - prospect, partner, etc. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>.' ,
2020-04-17 14:42:41 -07:00
} ,
{
2022-06-03 10:23:49 -07:00
displayName : 'Web Technologies Name or ID' ,
2020-04-17 14:42:41 -07:00
name : 'webTechnologies' ,
type : 'options' ,
typeOptions : {
2020-10-22 06:46:03 -07:00
loadOptionsMethod : 'getCompanyWebTechnologies' ,
2020-04-17 14:42:41 -07:00
} ,
default : '' ,
2022-06-03 10:23:49 -07:00
description : 'The web technologies used by the company or organization. Powered by HubSpot Insights. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/nodes/expressions.html#expressions">expression</a>.' ,
2020-04-17 14:42:41 -07:00
} ,
{
displayName : 'Website URL' ,
name : 'websiteUrl' ,
type : 'string' ,
default : '' ,
description : 'The main website of the company or organization. This property is used to identify unique companies. Powered by HubSpot Insights.' ,
} ,
{
2021-01-31 23:31:40 -08:00
displayName : 'Year Founded' ,
2020-04-17 14:42:41 -07:00
name : 'yearFounded' ,
type : 'string' ,
default : '' ,
description : 'The year the company was created. Powered by HubSpot Insights.' ,
} ,
2020-10-22 06:46:03 -07:00
] ,
2020-04-17 14:42:41 -07:00
} ,
2021-01-31 23:31:40 -08:00
/* -------------------------------------------------------------------------- */
/* company:get */
/* -------------------------------------------------------------------------- */
2020-04-17 14:42:41 -07:00
{
displayName : 'Company ID' ,
name : 'companyId' ,
type : 'string' ,
required : true ,
displayOptions : {
show : {
resource : [
'company' ,
] ,
operation : [
'get' ,
] ,
} ,
} ,
default : '' ,
description : 'Unique identifier for a particular company' ,
} ,
{
displayName : 'Additional Fields' ,
name : 'additionalFields' ,
type : 'collection' ,
placeholder : 'Add Field' ,
default : { } ,
displayOptions : {
show : {
resource : [
'company' ,
] ,
operation : [
'get' ,
] ,
} ,
} ,
options : [
{
displayName : 'Include Merge Audits' ,
name : 'includeMergeAudits' ,
type : 'boolean' ,
default : false ,
2022-05-06 14:01:25 -07:00
description : 'Returns any merge history if the company has been previously merged with another company record. Defaults to false.' ,
2020-04-17 14:42:41 -07:00
} ,
2020-10-22 06:46:03 -07:00
] ,
2020-04-17 14:42:41 -07:00
} ,
2021-01-31 23:31:40 -08:00
/* -------------------------------------------------------------------------- */
/* company:getAll */
/* -------------------------------------------------------------------------- */
2020-04-17 14:42:41 -07:00
{
displayName : 'Return All' ,
name : 'returnAll' ,
type : 'boolean' ,
displayOptions : {
show : {
resource : [
'company' ,
] ,
operation : [
'getAll' ,
] ,
} ,
} ,
default : false ,
2022-05-06 14:01:25 -07:00
description : 'Whether to return all results or only up to a given limit' ,
2020-04-17 14:42:41 -07:00
} ,
{
displayName : 'Limit' ,
name : 'limit' ,
type : 'number' ,
displayOptions : {
show : {
resource : [
'company' ,
] ,
operation : [
'getAll' ,
] ,
returnAll : [
false ,
] ,
} ,
} ,
typeOptions : {
minValue : 1 ,
maxValue : 250 ,
} ,
default : 100 ,
2022-05-06 14:01:25 -07:00
description : 'Max number of results to return' ,
2020-04-17 14:42:41 -07:00
} ,
{
displayName : 'Options' ,
name : 'options' ,
type : 'collection' ,
placeholder : 'Add Field' ,
default : { } ,
displayOptions : {
show : {
resource : [
'company' ,
] ,
operation : [
'getAll' ,
] ,
} ,
} ,
options : [
{
displayName : 'Include Merge Audits' ,
name : 'includeMergeAudits' ,
type : 'boolean' ,
default : false ,
2022-05-06 14:01:25 -07:00
description : 'Returns any merge history if a company has been previously merged with another company record. Defaults to false.' ,
2020-04-17 14:42:41 -07:00
} ,
{
displayName : 'Properties' ,
name : 'properties' ,
type : 'multiOptions' ,
typeOptions : {
loadOptionsMethod : 'getCompanyProperties' ,
} ,
2022-04-22 09:29:51 -07:00
default : [ ] ,
2022-05-06 14:01:25 -07:00
description : '<p>Used to include specific company properties in the results. By default, the results will only include company ID and will not include the values for any properties for your companies.</p><p>Including this parameter will include the data for the specified property in the results. You can include this parameter multiple times to request multiple properties separated by a comma: <code>,</code>.</p>' ,
2020-04-17 14:42:41 -07:00
} ,
{
displayName : 'Properties With History' ,
name : 'propertiesWithHistory' ,
type : 'string' ,
default : '' ,
2022-05-06 14:01:25 -07:00
description : 'Works similarly to properties=, but this parameter will include the history for the specified property, instead of just including the current value. Use this parameter when you need the full history of changes to a property\'s value.' ,
2020-04-17 14:42:41 -07:00
} ,
2020-10-22 06:46:03 -07:00
] ,
2020-04-17 14:42:41 -07:00
} ,
2021-01-31 23:31:40 -08:00
/* -------------------------------------------------------------------------- */
/* company:delete */
/* -------------------------------------------------------------------------- */
2020-04-17 14:42:41 -07:00
{
displayName : 'Company ID' ,
name : 'companyId' ,
type : 'string' ,
required : true ,
displayOptions : {
show : {
resource : [
'company' ,
] ,
operation : [
'delete' ,
] ,
} ,
} ,
default : '' ,
description : 'Unique identifier for a particular company' ,
} ,
2021-01-31 23:31:40 -08:00
/* -------------------------------------------------------------------------- */
/* company:getRecentlyCreated company:getRecentlyModifie */
/* -------------------------------------------------------------------------- */
2020-04-17 14:42:41 -07:00
{
displayName : 'Return All' ,
name : 'returnAll' ,
type : 'boolean' ,
displayOptions : {
show : {
resource : [
'company' ,
] ,
operation : [
'getRecentlyCreated' ,
'getRecentlyModified' ,
] ,
} ,
} ,
default : false ,
2022-05-06 14:01:25 -07:00
description : 'Whether to return all results or only up to a given limit' ,
2020-04-17 14:42:41 -07:00
} ,
{
displayName : 'Limit' ,
name : 'limit' ,
type : 'number' ,
displayOptions : {
show : {
resource : [
'company' ,
] ,
operation : [
'getRecentlyCreated' ,
'getRecentlyModified' ,
] ,
returnAll : [
false ,
] ,
} ,
} ,
typeOptions : {
minValue : 1 ,
maxValue : 250 ,
} ,
default : 100 ,
2022-05-06 14:01:25 -07:00
description : 'Max number of results to return' ,
2020-04-17 14:42:41 -07:00
} ,
{
displayName : 'Filters' ,
name : 'filters' ,
type : 'collection' ,
placeholder : 'Add Filter' ,
default : { } ,
displayOptions : {
show : {
resource : [
'company' ,
] ,
operation : [
'getRecentlyModified' ,
] ,
} ,
} ,
options : [
{
displayName : 'Since' ,
name : 'since' ,
type : 'dateTime' ,
default : '' ,
2022-05-06 14:01:25 -07:00
description : 'Only return companys created after timestamp x' ,
2020-04-17 14:42:41 -07:00
} ,
{
displayName : 'Include Property Versions' ,
name : 'includePropertyVersions' ,
type : 'boolean' ,
default : false ,
2022-05-06 14:01:25 -07:00
description : 'By default, you will only get data for the most recent version of a property in the "versions" data. If you include this parameter, you will get data for all previous versions.' ,
2020-04-17 14:42:41 -07:00
} ,
2020-10-22 06:46:03 -07:00
] ,
2020-04-17 14:42:41 -07:00
} ,
2021-01-31 23:31:40 -08:00
/* -------------------------------------------------------------------------- */
/* company:searchByDomain */
/* -------------------------------------------------------------------------- */
2020-04-17 14:42:41 -07:00
{
displayName : 'Domain' ,
name : 'domain' ,
type : 'string' ,
displayOptions : {
show : {
resource : [
'company' ,
] ,
operation : [
'searchByDomain' ,
] ,
} ,
} ,
required : true ,
default : '' ,
} ,
{
displayName : 'Return All' ,
name : 'returnAll' ,
type : 'boolean' ,
displayOptions : {
show : {
resource : [
'company' ,
] ,
operation : [
'searchByDomain' ,
] ,
} ,
} ,
default : false ,
2022-05-06 14:01:25 -07:00
description : 'Whether to return all results or only up to a given limit' ,
2020-04-17 14:42:41 -07:00
} ,
{
displayName : 'Limit' ,
name : 'limit' ,
type : 'number' ,
displayOptions : {
show : {
resource : [
'company' ,
] ,
operation : [
'searchByDomain' ,
] ,
returnAll : [
false ,
] ,
} ,
} ,
typeOptions : {
minValue : 1 ,
maxValue : 250 ,
} ,
default : 100 ,
2022-05-06 14:01:25 -07:00
description : 'Max number of results to return' ,
2020-04-17 14:42:41 -07:00
} ,
{
displayName : 'Options' ,
name : 'options' ,
type : 'collection' ,
placeholder : 'Add Field' ,
default : { } ,
displayOptions : {
show : {
resource : [
'company' ,
] ,
operation : [
'searchByDomain' ,
] ,
} ,
} ,
options : [
{
displayName : 'Properties' ,
name : 'properties' ,
type : 'multiOptions' ,
typeOptions : {
loadOptionsMethod : 'getCompanyProperties' ,
} ,
2022-04-22 09:29:51 -07:00
default : [ ] ,
2022-05-06 14:01:25 -07:00
description : '<p>Used to include specific company properties in the results. By default, the results will only include company ID and will not include the values for any properties for your company.</p><p>Including this parameter will include the data for the specified property in the results. You can include this parameter multiple times to request multiple properties separated by a comma: <code>,</code>.</p>' ,
2020-04-17 14:42:41 -07:00
} ,
2020-10-22 06:46:03 -07:00
] ,
2020-04-17 14:42:41 -07:00
} ,
2021-12-03 00:44:16 -08:00
] ;