n8n-nodes-base
Version:
Base nodes of n8n
119 lines (115 loc) • 3.8 kB
text/typescript
/**
* HighLevel Node - Version 1
* Discriminator: resource=contact, operation=create
*/
interface Credentials {
highLevelApi: CredentialReference;
}
export type HighLevelV1ContactCreateParams = {
resource: 'contact';
operation: 'create';
/**
* Email or Phone are required to create contact
*/
email?: string | Expression<string> | PlaceholderValue;
/**
* Phone or Email are required to create contact. Phone number has to start with a valid <a href="https://en.wikipedia.org/wiki/List_of_country_calling_codes">country code</a> leading with + sign.
*/
phone?: string | Expression<string> | PlaceholderValue;
/**
* Additional Fields
* @default {}
*/
additionalFields?: {
/** Address
*/
address1?: string | Expression<string> | PlaceholderValue;
/** City
*/
city?: string | Expression<string> | PlaceholderValue;
/** Custom Fields
* @default {}
*/
customFields?: {
/** Value
*/
values?: Array<{
/** Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code/expressions/">expression</a>
*/
fieldId?: string | Expression<string>;
/** Field Value
*/
fieldValue?: string | Expression<string> | PlaceholderValue;
}>;
};
/** Whether automated/manual outbound messages are permitted to go out or not. True means NO outbound messages are permitted.
* @default false
*/
dnd?: boolean | Expression<boolean>;
/** First Name
*/
firstName?: string | Expression<string> | PlaceholderValue;
/** Last Name
*/
lastName?: string | Expression<string> | PlaceholderValue;
/** The full name of the contact, will be overwritten by 'First Name' and 'Last Name' if set
* @default e.g. John Deo
*/
name?: string | Expression<string> | PlaceholderValue;
/** Postal Code
*/
postalCode?: string | Expression<string> | PlaceholderValue;
/** Source
*/
source?: string | Expression<string> | PlaceholderValue;
/** State
*/
state?: string | Expression<string> | PlaceholderValue;
/** Tags
* @hint Comma separated list of tags, array of strings can be set in expression
*/
tags?: string | Expression<string> | PlaceholderValue;
/** Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code/expressions/">expression</a>
*/
timezone?: string | Expression<string>;
/** Website
*/
website?: string | Expression<string> | PlaceholderValue;
};
requestOptions?: {
/** Batching
* @default {"batch":{}}
*/
batching?: {
/** Batching
*/
batch?: {
/** Input will be split in batches to throttle requests. -1 for disabled. 0 will be treated as 1.
* @default 50
*/
batchSize?: number | Expression<number>;
/** Time (in milliseconds) between each batch of requests. 0 for disabled.
* @default 1000
*/
batchInterval?: number | Expression<number>;
};
};
/** Whether to accept the response even if SSL certificate validation is not possible
* @default false
*/
allowUnauthorizedCerts?: boolean;
/** HTTP proxy to use. If authentication is required it can be defined as follow: http://username:password@myproxy:3128
*/
proxy?: string | Expression<string> | PlaceholderValue;
/** Time in ms to wait for the server to send response headers (and start the response body) before aborting the request
* @default 10000
*/
timeout?: number | Expression<number>;
};
};
export type HighLevelV1ContactCreateNode = {
type: 'n8n-nodes-base.highLevel';
version: 1;
credentials?: Credentials;
config: NodeConfig<HighLevelV1ContactCreateParams>;
};