n8n-nodes-base 1.44.0 → 1.45.0

package/dist/nodes/HighLevel/v2/description/ContactDescription.js

@@ -0,0 +1,819 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.contactFields = exports.contactNotes = exports.contactOperations = void 0;
+const GenericFunctions_1 = require("../GenericFunctions");
+exports.contactOperations = [
+    {
+        displayName: 'Operation',
+        name: 'operation',
+        type: 'options',
+        noDataExpression: true,
+        displayOptions: {
+            show: {
+                resource: ['contact'],
+            },
+        },
+        options: [
+            {
+                name: 'Create or Update',
+                value: 'create',
+                routing: {
+                    request: {
+                        method: 'POST',
+                        url: '/contacts/upsert/',
+                    },
+                    send: {
+                        preSend: [
+                            GenericFunctions_1.validEmailAndPhonePreSendAction,
+                            GenericFunctions_1.splitTagsPreSendAction,
+                            GenericFunctions_1.addLocationIdPreSendAction,
+                        ],
+                    },
+                    output: {
+                        postReceive: [
+                            {
+                                type: 'rootProperty',
+                                properties: {
+                                    property: 'contact',
+                                },
+                            },
+                        ],
+                    },
+                },
+                action: 'Create or update a contact',
+            },
+            {
+                name: 'Delete',
+                value: 'delete',
+                routing: {
+                    request: {
+                        method: 'DELETE',
+                        url: '=/contacts/{{$parameter.contactId}}/',
+                    },
+                    output: {
+                        postReceive: [
+                            {
+                                type: 'set',
+                                properties: {
+                                    value: '={{ { "success": true } }}',
+                                },
+                            },
+                        ],
+                    },
+                },
+                action: 'Delete a contact',
+            },
+            {
+                name: 'Get',
+                value: 'get',
+                routing: {
+                    request: {
+                        method: 'GET',
+                        url: '=/contacts/{{$parameter.contactId}}/',
+                    },
+                    output: {
+                        postReceive: [
+                            {
+                                type: 'rootProperty',
+                                properties: {
+                                    property: 'contact',
+                                },
+                            },
+                        ],
+                    },
+                },
+                action: 'Get a contact',
+            },
+            {
+                name: 'Get Many',
+                value: 'getAll',
+                routing: {
+                    request: {
+                        method: 'GET',
+                        url: '=/contacts/',
+                    },
+                    send: {
+                        preSend: [GenericFunctions_1.addLocationIdPreSendAction],
+                        paginate: true,
+                    },
+                },
+                action: 'Get many contacts',
+            },
+            {
+                name: 'Update',
+                value: 'update',
+                routing: {
+                    request: {
+                        method: 'PUT',
+                        url: '=/contacts/{{$parameter.contactId}}/',
+                    },
+                    send: {
+                        preSend: [GenericFunctions_1.validEmailAndPhonePreSendAction, GenericFunctions_1.splitTagsPreSendAction],
+                    },
+                    output: {
+                        postReceive: [
+                            {
+                                type: 'rootProperty',
+                                properties: {
+                                    property: 'contact',
+                                },
+                            },
+                        ],
+                    },
+                },
+                action: 'Update a contact',
+            },
+        ],
+        default: 'create',
+    },
+];
+exports.contactNotes = [
+    {
+        displayName: 'Create a new contact or update an existing one if email or phone matches (upsert)',
+        name: 'contactCreateNotice',
+        type: 'notice',
+        displayOptions: {
+            show: {
+                resource: ['contact'],
+                operation: ['create'],
+            },
+        },
+        default: '',
+    },
+];
+const customFields = {
+    displayName: 'Custom Fields',
+    name: 'customFields',
+    placeholder: 'Add Field',
+    type: 'fixedCollection',
+    default: {},
+    typeOptions: {
+        multipleValues: true,
+    },
+    options: [
+        {
+            name: 'values',
+            displayName: 'Value',
+            values: [
+                {
+                    displayName: 'Field Name or ID',
+                    name: 'fieldId',
+                    type: 'options',
+                    required: true,
+                    default: '',
+                    description: 'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
+                    typeOptions: {
+                        loadOptions: {
+                            routing: {
+                                request: {
+                                    url: '/custom-fields',
+                                    method: 'GET',
+                                },
+                                output: {
+                                    postReceive: [
+                                        {
+                                            type: 'rootProperty',
+                                            properties: {
+                                                property: 'customFields',
+                                            },
+                                        },
+                                        {
+                                            type: 'setKeyValue',
+                                            properties: {
+                                                name: '={{$responseItem.name}}',
+                                                value: '={{$responseItem.id}}',
+                                            },
+                                        },
+                                        {
+                                            type: 'sort',
+                                            properties: {
+                                                key: 'name',
+                                            },
+                                        },
+                                    ],
+                                },
+                            },
+                        },
+                    },
+                },
+                {
+                    displayName: 'Field Value',
+                    name: 'fieldValue',
+                    type: 'string',
+                    default: '',
+                    routing: {
+                        send: {
+                            value: '={{$value}}',
+                            property: '=customField.{{$parent.fieldId}}',
+                            type: 'body',
+                        },
+                    },
+                },
+            ],
+        },
+    ],
+};
+const createProperties = [
+    {
+        displayName: 'Email',
+        name: 'email',
+        type: 'string',
+        placeholder: 'name@email.com',
+        description: 'Email or Phone are required to create contact',
+        displayOptions: {
+            show: {
+                resource: ['contact'],
+                operation: ['create'],
+            },
+        },
+        default: '',
+        routing: {
+            send: {
+                type: 'body',
+                property: 'email',
+            },
+        },
+    },
+    {
+        displayName: 'Phone',
+        name: 'phone',
+        type: 'string',
+        description: '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.',
+        placeholder: '+491234567890',
+        displayOptions: {
+            show: {
+                resource: ['contact'],
+                operation: ['create'],
+            },
+        },
+        default: '',
+        routing: {
+            send: {
+                type: 'body',
+                property: 'phone',
+            },
+        },
+    },
+    {
+        displayName: 'Additional Fields',
+        name: 'additionalFields',
+        type: 'collection',
+        placeholder: 'Add Field',
+        default: {},
+        displayOptions: {
+            show: {
+                resource: ['contact'],
+                operation: ['create'],
+            },
+        },
+        options: [
+            {
+                displayName: 'Address',
+                name: 'address1',
+                type: 'string',
+                default: '',
+                routing: {
+                    send: {
+                        type: 'body',
+                        property: 'address1',
+                    },
+                },
+            },
+            {
+                displayName: 'City',
+                name: 'city',
+                type: 'string',
+                default: '',
+                routing: {
+                    send: {
+                        type: 'body',
+                        property: 'city',
+                    },
+                },
+            },
+            customFields,
+            {
+                displayName: 'Do Not Disturb',
+                name: 'dnd',
+                description: 'Whether automated/manual outbound messages are permitted to go out or not. True means NO outbound messages are permitted.',
+                type: 'boolean',
+                default: false,
+                routing: {
+                    send: {
+                        type: 'body',
+                        property: 'dnd',
+                    },
+                },
+            },
+            {
+                displayName: 'First Name',
+                name: 'firstName',
+                type: 'string',
+                default: '',
+                routing: {
+                    send: {
+                        type: 'body',
+                        property: 'firstName',
+                    },
+                },
+            },
+            {
+                displayName: 'Last Name',
+                name: 'lastName',
+                type: 'string',
+                default: '',
+                routing: {
+                    send: {
+                        type: 'body',
+                        property: 'lastName',
+                    },
+                },
+            },
+            {
+                displayName: 'Name',
+                name: 'name',
+                type: 'string',
+                default: 'e.g. John Deo',
+                description: "The full name of the contact, will be overwritten by 'First Name' and 'Last Name' if set",
+                routing: {
+                    send: {
+                        type: 'body',
+                        property: 'name',
+                    },
+                },
+            },
+            {
+                displayName: 'Postal Code',
+                name: 'postalCode',
+                type: 'string',
+                default: '',
+                routing: {
+                    send: {
+                        type: 'body',
+                        property: 'postalCode',
+                    },
+                },
+            },
+            {
+                displayName: 'Source',
+                name: 'source',
+                type: 'string',
+                default: '',
+                placeholder: 'e.g. Public API',
+                routing: {
+                    send: {
+                        type: 'body',
+                        property: 'source',
+                    },
+                },
+            },
+            {
+                displayName: 'State',
+                name: 'state',
+                type: 'string',
+                default: '',
+                routing: {
+                    send: {
+                        type: 'body',
+                        property: 'state',
+                    },
+                },
+            },
+            {
+                displayName: 'Tags',
+                name: 'tags',
+                type: 'string',
+                hint: 'Comma separated list of tags, array of strings can be set in expression',
+                default: '',
+                routing: {
+                    send: {
+                        type: 'body',
+                        property: 'tags',
+                    },
+                },
+            },
+            {
+                displayName: 'Timezone',
+                name: 'timezone',
+                type: 'options',
+                default: '',
+                description: 'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
+                typeOptions: {
+                    loadOptionsMethod: 'getTimezones',
+                },
+                routing: {
+                    send: {
+                        type: 'body',
+                        property: 'timezone',
+                    },
+                },
+            },
+            {
+                displayName: 'Website',
+                name: 'website',
+                type: 'string',
+                default: '',
+                routing: {
+                    send: {
+                        type: 'body',
+                        property: 'website',
+                    },
+                },
+            },
+        ],
+    },
+];
+const updateProperties = [
+    {
+        displayName: 'Contact ID',
+        name: 'contactId',
+        type: 'string',
+        required: true,
+        displayOptions: {
+            show: {
+                resource: ['contact'],
+                operation: ['update'],
+            },
+        },
+        default: '',
+    },
+    {
+        displayName: 'Update Fields',
+        name: 'updateFields',
+        type: 'collection',
+        placeholder: 'Add Field',
+        default: {},
+        displayOptions: {
+            show: {
+                resource: ['contact'],
+                operation: ['update'],
+            },
+        },
+        options: [
+            {
+                displayName: 'Address',
+                name: 'address1',
+                type: 'string',
+                default: '',
+                routing: {
+                    send: {
+                        type: 'body',
+                        property: 'address1',
+                    },
+                },
+            },
+            {
+                displayName: 'City',
+                name: 'city',
+                type: 'string',
+                default: '',
+                routing: {
+                    send: {
+                        type: 'body',
+                        property: 'city',
+                    },
+                },
+            },
+            customFields,
+            {
+                displayName: 'Do Not Disturb',
+                name: 'dnd',
+                description: 'Whether automated/manual outbound messages are permitted to go out or not. True means NO outbound messages are permitted.',
+                type: 'boolean',
+                default: false,
+                routing: {
+                    send: {
+                        type: 'body',
+                        property: 'dnd',
+                    },
+                },
+            },
+            {
+                displayName: 'Email',
+                name: 'email',
+                type: 'string',
+                placeholder: 'name@email.com',
+                default: '',
+                routing: {
+                    send: {
+                        type: 'body',
+                        property: 'email',
+                    },
+                },
+            },
+            {
+                displayName: 'First Name',
+                name: 'firstName',
+                type: 'string',
+                default: '',
+                routing: {
+                    send: {
+                        type: 'body',
+                        property: 'firstName',
+                    },
+                },
+            },
+            {
+                displayName: 'Last Name',
+                name: 'lastName',
+                type: 'string',
+                default: '',
+                routing: {
+                    send: {
+                        type: 'body',
+                        property: 'lastName',
+                    },
+                },
+            },
+            {
+                displayName: 'Name',
+                name: 'name',
+                type: 'string',
+                description: "The full name of the contact, will be overwritten by 'First Name' and 'Last Name' if set",
+                default: 'e.g. John Deo',
+                routing: {
+                    send: {
+                        type: 'body',
+                        property: 'name',
+                    },
+                },
+            },
+            {
+                displayName: 'Phone',
+                name: 'phone',
+                type: 'string',
+                default: '',
+                description: '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',
+                placeholder: '+491234567890',
+                routing: {
+                    send: {
+                        type: 'body',
+                        property: 'phone',
+                    },
+                },
+            },
+            {
+                displayName: 'Postal Code',
+                name: 'postalCode',
+                type: 'string',
+                default: '',
+                routing: {
+                    send: {
+                        type: 'body',
+                        property: 'postalCode',
+                    },
+                },
+            },
+            {
+                displayName: 'State',
+                name: 'state',
+                type: 'string',
+                default: '',
+                routing: {
+                    send: {
+                        type: 'body',
+                        property: 'state',
+                    },
+                },
+            },
+            {
+                displayName: 'Tags',
+                name: 'tags',
+                type: 'string',
+                hint: 'Comma separated list of tags, array of strings can be set in expression',
+                default: '',
+                routing: {
+                    send: {
+                        type: 'body',
+                        property: 'tags',
+                    },
+                },
+            },
+            {
+                displayName: 'Timezone',
+                name: 'timezone',
+                type: 'options',
+                default: '',
+                description: 'Choose from the list, or specify an ID using an <a href="https://docs.n8n.io/code-examples/expressions/">expression</a>',
+                typeOptions: {
+                    loadOptionsMethod: 'getTimezones',
+                },
+                routing: {
+                    send: {
+                        type: 'body',
+                        property: 'timezone',
+                    },
+                },
+            },
+            {
+                displayName: 'Website',
+                name: 'website',
+                type: 'string',
+                default: '',
+                routing: {
+                    send: {
+                        type: 'body',
+                        property: 'website',
+                    },
+                },
+            },
+        ],
+    },
+];
+const deleteProperties = [
+    {
+        displayName: 'Contact ID',
+        name: 'contactId',
+        type: 'string',
+        required: true,
+        displayOptions: {
+            show: {
+                resource: ['contact'],
+                operation: ['delete'],
+            },
+        },
+        default: '',
+    },
+];
+const getProperties = [
+    {
+        displayName: 'Contact ID',
+        name: 'contactId',
+        type: 'string',
+        required: true,
+        displayOptions: {
+            show: {
+                resource: ['contact'],
+                operation: ['get'],
+            },
+        },
+        default: '',
+    },
+];
+const getAllProperties = [
+    {
+        displayName: 'Return All',
+        name: 'returnAll',
+        type: 'boolean',
+        displayOptions: {
+            show: {
+                resource: ['contact'],
+                operation: ['getAll'],
+            },
+        },
+        default: false,
+        description: 'Whether to return all results or only up to a given limit',
+    },
+    {
+        displayName: 'Limit',
+        name: 'limit',
+        type: 'number',
+        displayOptions: {
+            show: {
+                resource: ['contact'],
+                operation: ['getAll'],
+                returnAll: [false],
+            },
+        },
+        typeOptions: {
+            minValue: 1,
+            maxValue: 100,
+        },
+        default: 20,
+        routing: {
+            send: {
+                type: 'query',
+                property: 'limit',
+            },
+            output: {
+                maxResults: '={{$value}}',
+            },
+        },
+        description: 'Max number of results to return',
+    },
+    {
+        displayName: 'Filters',
+        name: 'filters',
+        type: 'collection',
+        placeholder: 'Add Filter',
+        default: {},
+        displayOptions: {
+            show: {
+                resource: ['contact'],
+                operation: ['getAll'],
+            },
+        },
+        options: [
+            {
+                displayName: 'Query',
+                name: 'query',
+                type: 'string',
+                default: '',
+                description: 'Query will search on these fields: Name, Phone, Email, Tags, and Company Name',
+                routing: {
+                    send: {
+                        type: 'query',
+                        property: 'query',
+                    },
+                },
+            },
+        ],
+    },
+    {
+        displayName: 'Options',
+        name: 'options',
+        type: 'collection',
+        placeholder: 'Add Option',
+        default: {},
+        displayOptions: {
+            show: {
+                resource: ['contact'],
+                operation: ['getAll'],
+            },
+        },
+        options: [
+            {
+                displayName: 'Order',
+                name: 'order',
+                type: 'options',
+                options: [
+                    {
+                        name: 'Descending',
+                        value: 'desc',
+                    },
+                    {
+                        name: 'Ascending',
+                        value: 'asc',
+                    },
+                ],
+                default: 'desc',
+                routing: {
+                    send: {
+                        type: 'query',
+                        property: 'order',
+                    },
+                },
+            },
+            {
+                displayName: 'Sort By',
+                name: 'sortBy',
+                type: 'options',
+                options: [
+                    {
+                        name: 'Date Added',
+                        value: 'date_added',
+                    },
+                    {
+                        name: 'Date Updated',
+                        value: 'date_updated',
+                    },
+                ],
+                default: 'date_added',
+                routing: {
+                    send: {
+                        type: 'query',
+                        property: 'sortBy',
+                    },
+                },
+            },
+        ],
+    },
+];
+const lookupProperties = [
+    {
+        displayName: 'Email',
+        name: 'email',
+        type: 'string',
+        placeholder: 'name@email.com',
+        description: 'Lookup Contact by Email. If Email is not found it will try to find a contact by phone.',
+        displayOptions: {
+            show: {
+                resource: ['contact'],
+                operation: ['lookup'],
+            },
+        },
+        default: '',
+    },
+    {
+        displayName: 'Phone',
+        name: 'phone',
+        type: 'string',
+        description: 'Lookup Contact by Phone. It will first try to find a contact by Email and than by Phone.',
+        displayOptions: {
+            show: {
+                resource: ['contact'],
+                operation: ['lookup'],
+            },
+        },
+        default: '',
+    },
+];
+exports.contactFields = [
+    ...createProperties,
+    ...updateProperties,
+    ...deleteProperties,
+    ...getProperties,
+    ...getAllProperties,
+    ...lookupProperties,
+];
+//# sourceMappingURL=ContactDescription.js.map