Salesforce
As ações Salesforce permitem interações com a API do Salesforce.
Todas as ações do Salesforce devem usar a instância de conexão Salesforce, criada pela ação login.
Configuração da Conexão
login
Estabelece uma conexão com o Salesforce usando as credenciais fornecidas.
Parâmetros:
username - Nome de usuário da conta do Salesforce.
password - Senha da conta do Salesforce.
token - Token de segurança fornecido pelo Salesforce.
client_id (Opcional)- ID do cliente para aplicativos personalizados.
domain (Opcional)- Domínio do Salesforce.
organizationId (Opcional)- ID da organização para acesso multi-inquilino.
Retorno:
sf_connection - Instância de conexão do Salesforce para interações adicionais com a API.
Ações
query
Executa uma consulta SOQL e recupera dados do Salesforce, lidando com a paginação.
Parâmetros:
sf_connection - Instância do Salesforce fornecida por login.
query - String da consulta SOQL a ser executada.
Retorno:
result - Lista de todos os registros recuperados.
total_size - Número total de registros que correspondem à consulta.
update
Atualiza ou insere um registro no objeto Contact do Salesforce.
Parâmetros:
sf_connection - Instância do Salesforce fornecida por login.
id - Identificador único do registro a ser atualizado.
values - Dicionário contendo os campos a serem atualizados e seus novos valores.
Retorno:
status - Resposta indicando o resultado da operação de atualização/inserção (upsert).
describe
Recupera metadados para o objeto Contact ou o layout de um registro específico de Contact.
Parâmetros:
sf_connection - Instância do Salesforce fornecida por login.
id (Opcional)- ID do registro específico de Contact para descrição do layout.
Retorno:
items - Lista de dicionários para cada campo, contendo:
- label - Nome do campo para leitura humana.
- name - Nome do campo na API.
- type - Tipo de dado do campo (ex.: string, número).
- referenceTo - Objetos relacionados do Salesforce, se aplicável.
salesforce.describe
Retorna metadados de campos de um objeto Salesforce ou layout quando um id de registro é informado. Mesmo comportamento de describe.
Parâmetros:
sf_connection - instância retornada por salesforce.login.
table - nome API do objeto.
id (opcional) - quando informado, descreve o layout do registro (padrão=None).
Retornar:
items - lista de campos com label, name, type e referenceTo.
Exceções:
Esta ação não gera exceções
get_all_pages
Recupera todos os registros de uma consulta SOQL no Salesforce, lidando automaticamente com a paginação.
Parâmetros:
sf_connection - Instância de conexão do Salesforce fornecida por login.
response - Objeto de resposta inicial retornado de uma consulta SOQL.
data - Lista que será preenchida com todos os registros coletados em múltiplas páginas.
Retorno:
data - Lista completa de registros de todas as páginas da consulta, onde o campo "attributes" foi removido.
Exceções:
Esta ação não retorna exceções.
salesforce.login
Estabelece conexão com o Salesforce usando as credenciais informadas. Mesmo comportamento de login.
Parâmetros:
username - usuário da conta Salesforce.
password - senha da conta Salesforce.
token - token de segurança do Salesforce.
client_id (opcional) - client id para apps personalizados (padrão=None).
domain (opcional) - domínio Salesforce (padrão=None).
organizationId (opcional) - id da organização em cenários multi-tenant (padrão=None).
Retornar:
sf_connection - objeto de conexão para uso nas demais actions.
Exceções:
Esta ação não gera exceções
salesforce.query
Executa consulta SOQL com paginação automática. Mesmo comportamento de query.
Parâmetros:
sf_connection - instância retornada por salesforce.login ou login.
query - string SOQL.
Retornar:
result - lista de registros (campo attributes removido de cada registro).
total_size - total de registros correspondentes à consulta.
Exceções:
Esta ação não gera exceções
salesforce.update
Realiza upsert em qualquer objeto Salesforce. Mesmo comportamento de update.
Parâmetros:
sf_connection - instância retornada por salesforce.login.
table - nome API do objeto (por exemplo Contact, Account, Lead).
id - id externo no formato External_Id__c/valor ou id padrão para upsert.
values - dicionário de campos a criar ou atualizar.
Retornar:
status - resposta do upsert na API.
Exceções:
Esta ação não gera exceções