n8n-nodes-base
Version:
Base nodes of n8n
300 lines (295 loc) • 10.4 kB
text/typescript
/**
* HubSpot Node - Version 2.1
* Discriminator: resource=company, operation=create
*/
interface Credentials {
hubspotApi: CredentialReference;
hubspotAppToken: CredentialReference;
hubspotOAuth2Api: CredentialReference;
}
/** Create a company */
export type HubspotV21CompanyCreateParams = {
resource: 'company';
operation: 'create';
authentication?: 'apiKey' | 'appToken' | 'oAuth2' | Expression<string>;
/**
* Name
*/
name?: string | Expression<string> | PlaceholderValue;
/**
* Company Properties
* @default {}
*/
additionalFields?: {
/** About Us
*/
aboutUs?: string | Expression<string> | PlaceholderValue;
/** The actual or estimated annual revenue of the company
* @default 0
*/
annualRevenue?: number | Expression<number>;
/** The city where the company is located
*/
city?: string | Expression<string> | PlaceholderValue;
/** The date the company or organization was closed as a customer. When using expressions, the time should be specified in YYYY-MM-DD hh-mm-ss format.
*/
closeDate?: string | Expression<string>;
/** The domain name of the company or organization
*/
companyDomainName?: string | Expression<string> | PlaceholderValue;
/** The owner of the company. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code/expressions/">expression</a>.
*/
companyOwner?: string | Expression<string>;
/** The country/region in which the company or organization is located
*/
countryRegion?: string | Expression<string> | PlaceholderValue;
/** Custom Properties
* @default {}
*/
customPropertiesUi?: {
/** Custom Property
*/
customPropertiesValues?: Array<{
/** Name of the property. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code/expressions/">expression</a>.
* @default {}
*/
property?: string | Expression<string>;
/** Value of the property
*/
value?: string | Expression<string> | PlaceholderValue;
}>;
};
/** A short statement about the company's mission and goals
*/
description?: string | Expression<string> | PlaceholderValue;
/** Number of facebook fans
* @default 0
*/
facebookFans?: number | Expression<number>;
/** The URL of the Google Plus page for the company or organization
*/
googlePlusPage?: string | Expression<string> | PlaceholderValue;
/** The type of business the company performs. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code/expressions/">expression</a>.
*/
industry?: string | Expression<string>;
/** Whether that the company is publicly traded
* @default false
*/
isPublic?: boolean | Expression<boolean>;
/** The company's sales, prospecting or outreach status. Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code/expressions/">expression</a>.
*/
leadStatus?: string | Expression<string>;
/** 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/code/expressions/">expression</a>.
*/
lifecycleStatus?: string | Expression<string>;
/** The LinkedIn bio for the company or organization
*/
linkedinBio?: string | Expression<string> | PlaceholderValue;
/** The URL of the LinkedIn company page for the company or organization
*/
linkedInCompanyPage?: string | Expression<string> | PlaceholderValue;
/** The total number of employees who work for the company or organization
* @default 0
*/
numberOfEmployees?: number | Expression<number>;
/** 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/code/expressions/">expression</a>.
*/
originalSourceType?: string | Expression<string>;
/** A company's primary phone number. Powered by HubSpot Insights.
*/
phoneNumber?: string | Expression<string> | PlaceholderValue;
/** The postal or zip code of the company or organization. Powered by HubSpot Insights.
*/
postalCode?: string | Expression<string> | PlaceholderValue;
/** The state or region in which the company or organization is located. Powered by HubSpot Insights.
*/
stateRegion?: string | Expression<string> | PlaceholderValue;
/** The street address of the company or organization, including unit number. Powered by HubSpot Insights.
*/
streetAddress?: string | Expression<string> | PlaceholderValue;
/** The additional address of the company or organization. Powered by HubSpot Insights.
*/
streetAddress2?: string | Expression<string> | PlaceholderValue;
/** 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/code/expressions/">expression</a>.
*/
targetAccount?: string | Expression<string>;
/** The time zone where the company or organization is located. Powered by HubSpot Insights.
*/
timezone?: string | Expression<string> | PlaceholderValue;
/** The total amount of money raised by the company. Powered by HubSpot Insights.
* @default 0
*/
totalMoneyRaised?: number | Expression<number>;
/** The Twitter bio of the company or organization
*/
twitterBio?: string | Expression<string> | PlaceholderValue;
/** The number of Twitter followers of the company or organization
* @default 0
*/
twitterFollowers?: number | Expression<number>;
/** The main twitter account of the company or organization
*/
twitterHandle?: string | Expression<string> | PlaceholderValue;
/** 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/code/expressions/">expression</a>.
*/
type?: string | Expression<string>;
/** 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/code/expressions/">expression</a>.
*/
webTechnologies?: string | Expression<string>;
/** The main website of the company or organization. This property is used to identify unique companies. Powered by HubSpot Insights.
*/
websiteUrl?: string | Expression<string> | PlaceholderValue;
/** The year the company was created. Powered by HubSpot Insights.
*/
yearFounded?: string | Expression<string> | PlaceholderValue;
};
};
export type HubspotV21CompanyCreateOutput = {
companyId?: number;
isDeleted?: boolean;
portalId?: number;
properties?: {
createdate?: {
source?: string;
sourceId?: string;
timestamp?: number;
updatedByUserId?: null;
value?: string;
versions?: Array<{
name?: string;
requestId?: string;
source?: string;
sourceId?: string;
timestamp?: number;
value?: string;
}>;
};
hs_lastmodifieddate?: {
source?: string;
sourceId?: string;
timestamp?: number;
updatedByUserId?: null;
value?: string;
versions?: Array<{
name?: string;
requestId?: string;
source?: string;
sourceId?: string;
timestamp?: number;
value?: string;
}>;
};
hs_object_id?: {
source?: string;
sourceId?: string;
timestamp?: number;
updatedByUserId?: null;
value?: string;
versions?: Array<{
name?: string;
requestId?: string;
source?: string;
sourceId?: string;
timestamp?: number;
value?: string;
}>;
};
hs_object_source?: {
source?: string;
sourceId?: string;
timestamp?: number;
updatedByUserId?: null;
value?: string;
versions?: Array<{
name?: string;
requestId?: string;
source?: string;
sourceId?: string;
timestamp?: number;
value?: string;
}>;
};
hs_object_source_id?: {
source?: string;
sourceId?: string;
timestamp?: number;
updatedByUserId?: null;
value?: string;
versions?: Array<{
name?: string;
requestId?: string;
source?: string;
sourceId?: string;
timestamp?: number;
value?: string;
}>;
};
hs_object_source_label?: {
source?: string;
sourceId?: string;
timestamp?: number;
updatedByUserId?: null;
value?: string;
versions?: Array<{
name?: string;
requestId?: string;
source?: string;
sourceId?: string;
timestamp?: number;
value?: string;
}>;
};
hs_pipeline?: {
source?: string;
sourceId?: string;
timestamp?: number;
updatedByUserId?: null;
value?: string;
versions?: Array<{
name?: string;
requestId?: string;
source?: string;
sourceId?: string;
timestamp?: number;
value?: string;
}>;
};
lifecyclestage?: {
source?: string;
sourceId?: string;
timestamp?: number;
updatedByUserId?: null;
value?: string;
versions?: Array<{
name?: string;
requestId?: string;
source?: string;
sourceId?: string;
timestamp?: number;
value?: string;
}>;
};
name?: {
source?: string;
sourceId?: string;
timestamp?: number;
updatedByUserId?: null;
value?: string;
versions?: Array<{
name?: string;
requestId?: string;
source?: string;
sourceId?: string;
timestamp?: number;
value?: string;
}>;
};
};
};
export type HubspotV21CompanyCreateNode = {
type: 'n8n-nodes-base.hubspot';
version: 2.1;
credentials?: Credentials;
config: NodeConfig<HubspotV21CompanyCreateParams>;
output?: Items<HubspotV21CompanyCreateOutput>;
};