n8n-rdstation-crm
Version:
Nós personalizados do n8n para integração com a API do RD Station CRM (v1)
353 lines (352 loc) • 17.1 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.RdStationCrmNotes = void 0;
const n8n_workflow_1 = require("n8n-workflow");
/**
* Classe para o nó de Anotações (Notas) do RD Station CRM
* Este nó permite interações com a API de Anotações do RD Station CRM.
* As anotações são registros de texto inseridos no histórico de uma oportunidade
* para guardar informações relevantes ou feedbacks de conversas com o cliente.
* Importante: Anotações não podem ser editadas ou excluídas via API para garantir
* integridade e evitar fraudes no histórico de negociação.
*/
class RdStationCrmNotes {
constructor() {
this.description = {
// Informações básicas do nó que serão exibidas na interface do n8n
displayName: 'RD Station CRM Notas',
name: 'rdStationCrmNotes',
icon: 'file:rdstation.svg',
group: ['transform'],
version: 1,
subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}',
description: 'Operações com anotações no RD Station CRM',
defaults: {
name: 'RD Station CRM Notas', // 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 notas/anotações)
{
displayName: 'Recurso',
name: 'resource',
type: 'options',
noDataExpression: true,
options: [
{
name: 'Nota',
value: 'note', // Valor interno da opção
},
],
default: 'note',
required: true, // Campo obrigatório
},
// Seleção da operação a ser realizada sobre as notas
{
displayName: 'Operação',
name: 'operation',
type: 'options',
noDataExpression: true,
displayOptions: {
show: {
// Mostra este campo apenas quando o recurso for 'note'
resource: [
'note',
],
},
},
options: [
// Lista de operações disponíveis para notas
// No caso de notas, não é possível editar ou excluir via API
{
name: 'Criar',
value: 'create',
description: 'Criar uma nova anotação para um negócio',
action: 'Criar uma nota',
},
{
name: 'Listar',
value: 'getAll',
description: 'Listar anotações',
action: 'Listar notas',
},
],
default: 'getAll', // Operação padrão
},
// Campos para a operação LISTAR NOTAS
{
displayName: 'Parâmetros de Listagem',
name: 'listParameters',
type: 'collection',
placeholder: 'Adicionar Parâmetros',
default: {},
displayOptions: {
show: {
// Mostra apenas quando recurso é 'note' e operação é 'getAll'
resource: [
'note',
],
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 notas a retornar',
},
{
displayName: 'Página',
name: 'page',
type: 'number',
default: 1,
description: 'Número da página para retornar',
},
{
displayName: 'ID do Negócio',
name: 'deal_id',
type: 'string',
default: '',
description: 'Filtrar notas por negócio específico',
},
{
displayName: 'ID do Usuário',
name: 'user_id',
type: 'string',
default: '',
description: 'Filtrar notas por usuário autor',
},
{
displayName: 'Data Inicial',
name: 'start_date',
type: 'string',
default: '',
description: 'Data inicial para filtrar notas (formato YYYY-MM-DD)',
},
{
displayName: 'Data Final',
name: 'end_date',
type: 'string',
default: '',
description: 'Data final para filtrar notas (formato YYYY-MM-DD)',
},
{
displayName: 'Ordenação',
name: 'order',
type: 'options',
options: [
{
name: 'Data de Criação',
value: 'created_at',
},
],
default: 'created_at',
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: 'desc',
description: 'Direção da ordenação (crescente ou decrescente)',
},
],
},
// Campos para a operação CRIAR NOTA
{
displayName: 'ID do Negócio',
name: 'dealId',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
resource: [
'note',
],
operation: [
'create',
],
},
},
description: 'ID do negócio ao qual a nota está ligada (obrigatório)',
},
{
displayName: 'ID do Usuário',
name: 'userId',
type: 'string',
default: '',
required: true,
displayOptions: {
show: {
resource: [
'note',
],
operation: [
'create',
],
},
},
description: 'ID do usuário autor da nota (obrigatório)',
},
{
displayName: 'Texto da Nota',
name: 'text',
type: 'string',
typeOptions: {
rows: 4, // Campo de texto multi-linha para facilitar digitação de notas longas
},
default: '',
required: true,
displayOptions: {
show: {
resource: [
'note',
],
operation: [
'create',
],
},
},
description: 'Conteúdo da anotação a ser registrada (obrigatório)',
},
],
};
}
/**
* 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 === 'note') {
if (operation === 'getAll') {
// Operação: LISTAR NOTAS
// Na API do RD Station CRM, as notas são consideradas "activities"
// Preparando a requisição para listar notas/atividades
options.method = 'GET'; // Método HTTP GET para listar
options.uri = `${baseUrl}/activities`; // Endpoint de atividades que inclui notas
// Obtendo e aplicando parâmetros de filtro/paginação definidos pelo usuário
const listParameters = this.getNodeParameter('listParameters', i);
const qs = {
type: 'note', // Filtra apenas por atividades do tipo "nota"
};
// 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.deal_id)
qs.deal_id = listParameters.deal_id;
if (listParameters.user_id)
qs.user_id = listParameters.user_id;
if (listParameters.start_date)
qs.start_date = listParameters.start_date;
if (listParameters.end_date)
qs.end_date = listParameters.end_date;
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 === 'create') {
// Operação: CRIAR NOTA
// Configurando requisição para criar nota
options.method = 'POST'; // Método HTTP POST para criação
options.uri = `${baseUrl}/activities`; // Endpoint de activities para criar nota
// Obtém os dados necessários para criar a nota
const dealId = this.getNodeParameter('dealId', i); // ID do negócio
const userId = this.getNodeParameter('userId', i); // ID do usuário autor
const text = this.getNodeParameter('text', i); // Texto da nota
// Verifica se todos os campos obrigatórios foram fornecidos
if (!dealId) {
throw new n8n_workflow_1.NodeOperationError(this.getNode(), 'O ID do negócio é obrigatório para criar uma nota!', { itemIndex: i });
}
if (!userId) {
throw new n8n_workflow_1.NodeOperationError(this.getNode(), 'O ID do usuário é obrigatório para criar uma nota!', { itemIndex: i });
}
if (!text) {
throw new n8n_workflow_1.NodeOperationError(this.getNode(), 'O texto da nota é obrigatório!', { itemIndex: i });
}
// Preparando o corpo da requisição
const body = {
deal_id: dealId,
user_id: userId,
text: text,
type: 'note', // Tipo de atividade = nota
};
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.RdStationCrmNotes = RdStationCrmNotes;