import { IExecuteFunctions, INodeExecutionData, INodeType, INodeTypeDescription, NodeOperationError, } from 'n8n-workflow'; import { OptionsWithUri } from 'request-promise-native'; /** * Classe para o nó de Campanhas do RD Station CRM * Este nó permite consultar as campanhas cadastradas no RD Station CRM. * * As campanhas são usadas para categorizar negócios e ajudar a identificar a * origem/iniciativa que gerou uma oportunidade de venda específica, permitindo * análises de desempenho de diferentes iniciativas de marketing e vendas. * * Normalmente, a API só permite operações de leitura para campanhas, já que * a criação e gerenciamento são feitos na interface administrativa do CRM. */ export class RdStationCrmCampaigns implements INodeType { description: INodeTypeDescription = { // Informações básicas do nó que serão exibidas na interface do n8n displayName: 'RD Station CRM Campanhas', name: 'rdStationCrmCampaigns', icon: 'file:rdstation.svg', // Ícone a ser exibido no n8n group: ['transform'], // Grupo onde o nó aparecerá na interface version: 1, // Versão do nó subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}', // Subtítulo dinâmico baseado nos parâmetros description: 'Consultar campanhas no RD Station CRM', // Descrição do nó defaults: { name: 'RD Station CRM Campanhas', // Nome padrão quando o nó é adicionado }, inputs: ['main'], // Define que o nó aceita uma entrada principal outputs: ['main'], // Define que o nó tem uma saída principal 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 campanhas) { displayName: 'Recurso', // Label exibido na interface name: 'resource', // Nome do parâmetro para referência interna type: 'options', // Tipo do campo (seleção entre opções) noDataExpression: true, // Não permite expressões dinâmicas options: [ { name: 'Campanha', // Nome amigável da opção value: 'campaign', // Valor interno da opção }, ], default: 'campaign', // Valor padrão selecionado required: true, // Campo obrigatório }, // Seleção da operação a ser realizada sobre as campanhas { displayName: 'Operação', // Label do campo na interface name: 'operation', // Nome do parâmetro internamente type: 'options', // Campo de seleção entre opções noDataExpression: true, // Não permite expressões dinâmicas displayOptions: { show: { // Mostra este campo apenas quando o recurso for 'campaign' resource: [ 'campaign', ], }, }, options: [ // Lista de operações disponíveis para campanhas { name: 'Listar', // Operação de listagem value: 'getAll', description: 'Listar todas as campanhas', action: 'Listar campanhas', }, { name: 'Obter', // Operação para obter detalhes value: 'get', description: 'Obter uma campanha pelo ID', action: 'Obter uma campanha', }, ], default: 'getAll', // Operação padrão }, // Campos para a operação OBTER CAMPANHA { displayName: 'ID da Campanha', // Campo para informar ID da campanha name: 'campaignId', type: 'string', // Tipo texto para o ID default: '', required: true, // Campo obrigatório displayOptions: { show: { // Mostrar apenas quando operação for 'get' resource: [ 'campaign', ], operation: [ 'get', ], }, }, description: 'ID da campanha a ser consultada', }, // Campos para a operação LISTAR CAMPANHAS { displayName: 'Parâmetros de Listagem', // Título da seção name: 'listParameters', // Nome para referência interna type: 'collection', // Tipo coleção permite múltiplos parâmetros agrupados placeholder: 'Adicionar Parâmetros', // Texto de placeholder default: {}, // Valor padrão (vazio) displayOptions: { show: { // Mostra apenas quando recurso é 'campaign' e operação é 'getAll' resource: [ 'campaign', ], operation: [ 'getAll', ], }, }, options: [ // Opções de filtragem e paginação para listagem { displayName: 'Limite', // Controle de quantos itens retornar name: 'limit', type: 'number', default: 50, description: 'Número máximo de campanhas a retornar', }, { displayName: 'Página', // Para navegação entre páginas name: 'page', type: 'number', default: 1, description: 'Número da página para retornar', }, { displayName: 'Ordenação', // Campo para ordenar resultados name: 'order', type: 'options', options: [ { name: 'Nome', // Ordem alfabética por nome value: 'name', }, { name: 'Data de Criação', // Do mais antigo ao mais recente value: 'created_at', }, ], default: 'name', description: 'Campo pelo qual ordenar os resultados', }, { displayName: 'Direção da Ordenação', // Crescente ou decrescente name: 'direction', type: 'options', options: [ { name: 'Ascendente', // A-Z ou mais antigo para mais recente value: 'asc', }, { name: 'Descendente', // Z-A ou mais recente para mais antigo value: 'desc', }, ], default: 'asc', description: 'Direção da ordenação (crescente ou decrescente)', }, { displayName: 'Status', // Filtrar por status da campanha name: 'status', type: 'options', options: [ { name: 'Ativa', // Campanhas ativas value: 'active', }, { name: 'Inativa', // Campanhas desativadas value: 'inactive', }, { name: 'Todas', // Ambos os status value: 'all', }, ], default: 'active', description: 'Filtrar campanhas por status', }, { displayName: 'Termo de Busca', // Pesquisar por texto no nome da campanha name: 'query', type: 'string', default: '', description: 'Termo para buscar no nome da campanha', }, ], }, ], }; /** * 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(this: IExecuteFunctions): Promise { const items = this.getInputData(); // Obtém os dados de entrada const returnData: INodeExecutionData[] = []; // 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) as string; // Obtém o recurso selecionado const operation = this.getNodeParameter('operation', 0) as string; // 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: OptionsWithUri = { uri: '', // Uri inicial vazio, será definido conforme a operação headers: { 'Accept': 'application/json', // Aceita respostas em JSON 'Content-Type': 'application/json', // Envia dados em formato JSON }, json: true, // Processa automaticamente respostas JSON resolveWithFullResponse: true, // Retorna o objeto de resposta completo }; // Vamos determinar qual operação executar com base no recurso e operação selecionados if (resource === 'campaign') { if (operation === 'getAll') { // Operação: LISTAR CAMPANHAS // Preparando a requisição para listar campanhas options.method = 'GET'; // Método HTTP GET para listar options.uri = `${baseUrl}/campaigns`; // Endpoint de campanhas // Obtendo e aplicando parâmetros de filtro/paginação definidos pelo usuário const listParameters = this.getNodeParameter('listParameters', i) as { limit?: number; page?: number; order?: string; direction?: string; status?: string; query?: string; }; const qs: Record = {}; // 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.order) qs.order = listParameters.order; if (listParameters.direction) qs.direction = listParameters.direction; if (listParameters.status) qs.status = listParameters.status; if (listParameters.query) qs.query = listParameters.query; options.qs = qs; // Anexa os parâmetros à requisição } else if (operation === 'get') { // Operação: OBTER CAMPANHA ESPECÍFICA // Obtém o ID da campanha a ser consultada const campaignId = this.getNodeParameter('campaignId', i) as string; // Verifica se o ID da campanha foi fornecido if (!campaignId) { throw new NodeOperationError(this.getNode(), 'É necessário fornecer um ID de campanha válido!', { itemIndex: i }); } // Configurando a requisição para buscar uma campanha específica options.method = 'GET'; options.uri = `${baseUrl}/campaigns/${campaignId}`; // Endpoint com ID da campanha } } // 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, // Opções da requisição ); // Extrai os dados da resposta e adiciona ao retorno const responseData = response.body; returnData.push({ json: responseData, // Dados da resposta em formato JSON 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), // Tratamento seguro do 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 } }