n8n-rdstation-crm
Version:
Nós personalizados do n8n para integração com a API do RD Station CRM (v1)
481 lines (480 loc) • 24.4 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.RdStationCrmCompanies = void 0;
const n8n_workflow_1 = require("n8n-workflow");
/**
* Classe para o nó de Empresas do RD Station CRM
* Este nó permite interações com a API de Empresas (Organizations) do RD Station CRM.
* As empresas são entidades jurídicas que podem agrupar contatos e negócios no CRM.
*/
class RdStationCrmCompanies {
constructor() {
this.description = {
// Informações básicas do nó que serão exibidas na interface do n8n
displayName: 'RD Station CRM Empresas',
name: 'rdStationCrmCompanies',
icon: 'file:rdstation.svg',
group: ['transform'],
version: 1,
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
description: 'Operações com empresas no RD Station CRM',
defaults: {
name: 'RD Station CRM Empresas', // Nome padrão quando o nó é adicionado
},
inputs: ['main'],
outputs: ['main'],
credentials: [
{
// Define que o nó requer credenciais do tipo rdStationCrmApi
name: 'rdStationCrmApi',
required: true, // As credenciais são obrigatórias
},
],
properties: [
// Seleção do recurso (neste caso, só temos empresas/organizations)
{
displayName: 'Recurso',
name: 'resource',
type: 'options',
noDataExpression: true,
options: [
{
name: 'Empresa',
value: 'organization', // Valor interno da opção (organization é o termo usado na API)
},
],
default: 'organization',
required: true, // Campo obrigatório
},
// Seleção da operação a ser realizada sobre as empresas
{
displayName: 'Operação',
name: 'operation',
type: 'options',
noDataExpression: true,
displayOptions: {
show: {
// Mostra este campo apenas quando o recurso for 'organization'
resource: [
'organization',
],
},
},
options: [
// Lista de operações disponíveis para empresas
{
name: 'Criar',
value: 'create',
description: 'Criar uma nova empresa',
action: 'Criar uma empresa',
},
{
name: 'Atualizar',
value: 'update',
description: 'Atualizar uma empresa existente',
action: 'Atualizar uma empresa',
},
{
name: 'Listar',
value: 'getAll',
description: 'Listar empresas',
action: 'Listar empresas',
},
{
name: 'Obter',
value: 'get',
description: 'Obter uma empresa pelo ID',
action: 'Obter uma empresa',
},
{
name: 'Listar Contatos da Empresa',
value: 'getContacts',
description: 'Listar contatos associados a uma empresa',
action: 'Listar contatos de uma empresa',
},
],
default: 'getAll', // Operação padrão
},
// Campos para a operação LISTAR EMPRESAS
{
displayName: 'Parâmetros de Listagem',
name: 'listParameters',
type: 'collection',
placeholder: 'Adicionar Parâmetros',
default: {},
displayOptions: {
show: {
// Mostra apenas quando recurso é 'organization' e operação é 'getAll'
resource: [
'organization',
],
operation: [
'getAll',
],
},
},
options: [
// Opções de filtragem e paginação para listagem
{
displayName: 'Limite',
name: 'limit',
type: 'number',
default: 50,
description: 'Número máximo de empresas a retornar',
},
{
displayName: 'Página',
name: 'page',
type: 'number',
default: 1,
description: 'Número da página para retornar',
},
{
displayName: 'Busca por Nome',
name: 'q',
type: 'string',
default: '',
description: 'Buscar empresas por nome',
},
{
displayName: 'ID do Segmento',
name: 'organization_segment_id',
type: 'string',
default: '',
description: 'Filtrar empresas por segmento específico',
},
{
displayName: 'ID do Usuário Responsável',
name: 'user_id',
type: 'string',
default: '',
description: 'Filtrar empresas por usuário responsável',
},
{
displayName: 'Ordenação',
name: 'order',
type: 'options',
options: [
{
name: 'Nome',
value: 'name',
},
{
name: 'Data de Criação',
value: 'created_at',
},
],
default: 'name',
description: 'Campo pelo qual ordenar os resultados',
},
{
displayName: 'Direção da Ordenação',
name: 'direction',
type: 'options',
options: [
{
name: 'Ascendente',
value: 'asc',
},
{
name: 'Descendente',
value: 'desc',
},
],
default: 'asc',
description: 'Direção da ordenação (crescente ou decrescente)',
},
],
},
// Campos para a operação OBTER EMPRESA ou LISTAR CONTATOS DA EMPRESA
{
displayName: 'ID da Empresa',
name: 'organizationId',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
// Mostrar apenas quando operação for 'get', 'update' ou 'getContacts'
resource: [
'organization',
],
operation: [
'get',
'update',
'getContacts',
],
},
},
description: 'ID da empresa a ser consultada/atualizada',
},
// Campos comuns para CRIAR e ATUALIZAR empresas
{
displayName: 'Dados da Empresa',
name: 'organizationData',
type: 'collection',
placeholder: 'Adicionar Dados',
default: {},
displayOptions: {
show: {
resource: [
'organization',
],
operation: [
'create',
'update',
],
},
},
options: [
// Campos de dados da empresa
{
displayName: 'Nome',
name: 'name',
type: 'string',
default: '',
description: 'Nome da empresa (obrigatório para criação, mínimo 2 caracteres, deve ser único)',
},
{
displayName: 'ID do Segmento',
name: 'segment_id',
type: 'string',
default: '',
description: 'ID do segmento da empresa',
},
{
displayName: 'Site',
name: 'website',
type: 'string',
default: '',
description: 'URL do site da empresa',
},
{
displayName: 'E-mail',
name: 'email',
type: 'string',
default: '',
description: 'E-mail de contato geral da empresa',
},
{
displayName: 'Endereço',
name: 'address',
type: 'string',
default: '',
description: 'Endereço da empresa',
},
],
},
// Telefones da empresa (para CRIAR e ATUALIZAR)
{
displayName: 'Telefones',
name: 'phones',
placeholder: 'Adicionar Telefone',
type: 'fixedCollection',
typeOptions: {
multipleValues: true, // Permite múltiplos telefones
},
displayOptions: {
show: {
resource: [
'organization',
],
operation: [
'create',
'update',
],
},
},
default: {},
options: [
{
name: 'phonesValues',
displayName: 'Telefone',
values: [
{
displayName: 'Número',
name: 'phone',
type: 'string',
default: '',
description: 'Número de telefone da empresa',
required: true, // Número é obrigatório se um telefone for adicionado
},
{
displayName: 'Tipo',
name: 'type',
type: 'options',
options: [
{
name: 'Trabalho',
value: 'work',
},
{
name: 'Fax',
value: 'fax',
},
{
name: 'Outro',
value: 'other',
},
],
default: 'work',
description: 'Tipo de telefone',
},
],
},
],
},
],
};
}
/**
* Método principal que executa o nó com base na operação selecionada
* Este método é chamado pelo n8n quando o fluxo é executado
*/
async execute() {
const items = this.getInputData(); // Obtém os dados de entrada
const returnData = []; // Array para armazenar resultados
// URL base da API do RD Station CRM
const baseUrl = 'https://crm.rdstation.com/api/v1';
const resource = this.getNodeParameter('resource', 0); // Obtém o recurso selecionado
const operation = this.getNodeParameter('operation', 0); // Obtém a operação selecionada
// Para cada item de entrada, processa a operação solicitada
for (let i = 0; i < items.length; i++) {
try {
// Configuração comum para todas as requisições HTTP
const options = {
uri: '',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json', // Envia dados em formato JSON
},
json: true,
resolveWithFullResponse: true, // Retorna o objeto de resposta completo
};
// Vamos determinar qual operação executar com base no recurso e operação selecionados
if (resource === 'organization') {
if (operation === 'getAll') {
// Operação: LISTAR EMPRESAS
// Preparando a requisição para listar empresas
options.method = 'GET'; // Método HTTP GET para listar
options.uri = `${baseUrl}/organizations`; // Endpoint de organizations (empresas)
// Obtendo e aplicando parâmetros de filtro/paginação definidos pelo usuário
const listParameters = this.getNodeParameter('listParameters', i);
const qs = {}; // Objeto para parâmetros de query string
// Adicionando os parâmetros à query string se estiverem definidos
if (listParameters.limit)
qs.limit = listParameters.limit;
if (listParameters.page)
qs.page = listParameters.page;
if (listParameters.q)
qs.q = listParameters.q;
if (listParameters.organization_segment_id)
qs.organization_segment_id = listParameters.organization_segment_id;
if (listParameters.user_id)
qs.user_id = listParameters.user_id;
if (listParameters.order)
qs.order = listParameters.order;
if (listParameters.direction)
qs.direction = listParameters.direction;
options.qs = qs; // Anexa os parâmetros à requisição
}
else if (operation === 'get') {
// Operação: OBTER EMPRESA ESPECÍFICA
// Obtém o ID da empresa a ser consultada
const organizationId = this.getNodeParameter('organizationId', i);
// Verifica se o ID da empresa foi fornecido
if (!organizationId) {
throw new n8n_workflow_1.NodeOperationError(this.getNode(), 'É necessário fornecer um ID de empresa válido!', { itemIndex: i });
}
// Configurando a requisição para buscar uma empresa específica
options.method = 'GET';
options.uri = `${baseUrl}/organizations/${organizationId}`;
}
else if (operation === 'getContacts') {
// Operação: LISTAR CONTATOS DA EMPRESA
// Obtém o ID da empresa para listar seus contatos
const organizationId = this.getNodeParameter('organizationId', i);
// Verifica se o ID da empresa foi fornecido
if (!organizationId) {
throw new n8n_workflow_1.NodeOperationError(this.getNode(), 'É necessário fornecer um ID de empresa válido!', { itemIndex: i });
}
// Configurando a requisição para buscar contatos de uma empresa específica
options.method = 'GET';
options.uri = `${baseUrl}/organizations/${organizationId}/contacts`;
}
else if (operation === 'create') {
// Operação: CRIAR EMPRESA
// Configurando requisição para criar empresa
options.method = 'POST'; // Método HTTP POST para criação
options.uri = `${baseUrl}/organizations`; // Endpoint de organizations
// Obtendo os dados da empresa
const organizationData = this.getNodeParameter('organizationData', i);
// Verificando se o nome foi fornecido (obrigatório para criação)
if (!organizationData.name || organizationData.name.length < 2) {
throw new n8n_workflow_1.NodeOperationError(this.getNode(), 'O nome da empresa é obrigatório e deve ter pelo menos 2 caracteres!', { itemIndex: i });
}
// Preparando o corpo da requisição
const body = { ...organizationData };
// Adicionando telefones ao corpo
const phonesCollection = this.getNodeParameter('phones', i);
if (phonesCollection.phonesValues && phonesCollection.phonesValues.length > 0) {
body.phones = phonesCollection.phonesValues;
}
options.body = body; // Anexa o corpo à requisição
}
else if (operation === 'update') {
// Operação: ATUALIZAR EMPRESA
// Obtém o ID da empresa a ser atualizada
const organizationId = this.getNodeParameter('organizationId', i);
// Verifica se o ID da empresa foi fornecido
if (!organizationId) {
throw new n8n_workflow_1.NodeOperationError(this.getNode(), 'É necessário fornecer um ID de empresa válido para atualização!', { itemIndex: i });
}
// Configurando a requisição para atualizar a empresa
options.method = 'PUT'; // Método HTTP PUT para atualização
options.uri = `${baseUrl}/organizations/${organizationId}`; // Endpoint com ID da empresa
// Obtendo os dados a serem atualizados
const organizationData = this.getNodeParameter('organizationData', i);
// Preparando o corpo da requisição
const body = { ...organizationData };
// Adicionando telefones ao corpo, se fornecidos
const phonesCollection = this.getNodeParameter('phones', i);
if (phonesCollection.phonesValues && phonesCollection.phonesValues.length > 0) {
body.phones = phonesCollection.phonesValues;
}
// Verifica se há campos para atualizar
if (Object.keys(body).length === 0) {
throw new n8n_workflow_1.NodeOperationError(this.getNode(), 'É necessário fornecer pelo menos um campo para atualizar a empresa!', { itemIndex: i });
}
options.body = body; // Anexa o corpo à requisição
}
}
// Executa a requisição HTTP com as opções configuradas e autenticação
const response = await this.helpers.requestWithAuthentication.call(this, 'rdStationCrmApi', // Usa as credenciais configuradas
options);
// Extrai os dados da resposta e adiciona ao retorno
const responseData = response.body;
returnData.push({
json: responseData,
pairedItem: { item: i }, // Mantém o pareamento com o item de entrada
});
}
catch (error) {
// Trata e reporta erros ocorridos durante a execução
if (this.continueOnFail()) {
// Se configurado para continuar mesmo com falhas
returnData.push({
json: {
error: error instanceof Error ? error.message : String(error), // Inclui a mensagem de erro
},
pairedItem: { item: i },
});
continue; // Continua para o próximo item
}
throw error; // Senão, propaga o erro para interromper a execução
}
}
return [returnData]; // Retorna os dados processados
}
}
exports.RdStationCrmCompanies = RdStationCrmCompanies;