n8n-rdstation-crm
Version:
Nós personalizados do n8n para integração com a API do RD Station CRM (v1)
298 lines (297 loc) • 14.2 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.RdStationCrmCampaigns = void 0;
const n8n_workflow_1 = require("n8n-workflow");
/**
* 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.
*/
class RdStationCrmCampaigns {
constructor() {
this.description = {
// 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',
group: ['transform'],
version: 1,
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
description: 'Consultar campanhas no RD Station CRM',
defaults: {
name: 'RD Station CRM Campanhas', // 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 campanhas)
{
displayName: 'Recurso',
name: 'resource',
type: 'options',
noDataExpression: true,
options: [
{
name: 'Campanha',
value: 'campaign', // Valor interno da opção
},
],
default: 'campaign',
required: true, // Campo obrigatório
},
// Seleção da operação a ser realizada sobre as campanhas
{
displayName: 'Operação',
name: 'operation',
type: 'options',
noDataExpression: true,
displayOptions: {
show: {
// Mostra este campo apenas quando o recurso for 'campaign'
resource: [
'campaign',
],
},
},
options: [
// Lista de operações disponíveis para campanhas
{
name: 'Listar',
value: 'getAll',
description: 'Listar todas as campanhas',
action: 'Listar campanhas',
},
{
name: 'Obter',
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',
name: 'campaignId',
type: 'string',
default: '',
required: true,
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',
name: 'listParameters',
type: 'collection',
placeholder: 'Adicionar Parâmetros',
default: {},
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',
name: 'limit',
type: 'number',
default: 50,
description: 'Número máximo de campanhas a retornar',
},
{
displayName: 'Página',
name: 'page',
type: 'number',
default: 1,
description: 'Número da página para retornar',
},
{
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)',
},
{
displayName: 'Status',
name: 'status',
type: 'options',
options: [
{
name: 'Ativa',
value: 'active',
},
{
name: 'Inativa',
value: 'inactive',
},
{
name: 'Todas',
value: 'all',
},
],
default: 'active',
description: 'Filtrar campanhas por status',
},
{
displayName: 'Termo de Busca',
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() {
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 === '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);
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.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);
// Verifica se o ID da campanha foi fornecido
if (!campaignId) {
throw new n8n_workflow_1.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);
// 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), // 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
}
}
exports.RdStationCrmCampaigns = RdStationCrmCampaigns;