Ações do Pipedrive

Ações do Pipedrive são ações para interagir com a API do Pipedrive.

Todas as ações do Pipedrive devem usar a instância de conexão pipedrive, criada por uma das ações pipedrive.create ou pipedrive.create_with_api_token.

Formas de conexão

Existem duas formas de gerar uma instancia de conexão pipedrive, vamos entrar em mais detalhes de como fazer e as ações necessarias para cada uma:

Instanciação com Client

pipedrive.create

Cria a conexão Pipedrive via Client.

Após este comando ainda serão necessários outros 3: pipedrive.authorization_url, pipedrive.exchange_code e pipedrive.set_access_token.

Parâmetros:

client_id - ID fornecido quando registrou seu Pipedrive Marketplace.

client_secret - senha fornecida quando registrou seu Pipedrive Marketplace.

Retornar:

pipedrive - conexão pipedrive que será passada ao chamar as outras actions.

pipedrive.authorization_url

Gera a url de autorização.

Parâmetros:

pipedrive - instância do pipedrive fornecida por pipedrive.create.

redirect_url - url fornecida quando registrou seu Pipedrive Marketplace.

Retornar:

url - url de autorização.

pipedrive.exchange_code

Gera o Token de autorização.

Parâmetros:

pipedrive - instância do pipedrive fornecida por pipedrive.create.

redirect_url - url fornecida quando registrou seu Pipedrive Marketplace.

code - codigo fornecido quando registrou seu Pipedrive Marketplace.

Retornar:

token - token de autorização.

pipedrive.set_access_token

Define o seu token de autenticação para futuras conexões pipedrive.

Parâmetros:

pipedrive - instância do pipedrive fornecida por pipedrive.create.

access_token - token de autenticação fornecido por pipedrive.exchange_code.

Retornar:

Esta ação não dá retorno.

pipedrive.refresh_token

Reseta a duração do Token de autorização.

Parâmetros:

pipedrive - instância do pipedrive fornecida por pipedrive.create.

refresh_token - token de autenticação

Retornar:

token - token de autorização.

Instanciação com API Token

pipedrive.create_with_api_token

Cria a conexão Pipedrive via API Token.

Parâmetros:

domain - dominio da url da sua conta pipedrive.

api_token - token de API da empresa em que quer fazer a conexão pipedrive.

Retornar:

pipedrive - conexão pipedrive que será passada ao chamar as outras actions.

Ações

pipedrive.get_all_activities

Retorna todas as atividades.

Parâmetros:

pipedrive - instância do pipedrive fornecida por pipedrive.create.

Retornar:

response - atividades encontradas.

pipedrive.get_all_persons

Retorna todas as pessoas.

Parâmetros:

pipedrive - instância do pipedrive fornecida por pipedrive.create.

Retornar:

response - pessoas encontradas.

pipedrive.get_all_organizations

Retorna todas as organizações.

Parâmetros:

pipedrive - instância do pipedrive fornecida por pipedrive.create.

Retornar:

response - organizações encontradas.

pipedrive.create_person

Cria uma nova pessoa.

Parâmetros:

pipedrive - instância do pipedrive fornecida por pipedrive.create.

data - informações necessarias para a criação de uma nova pessoa.

Retornar:

response - retorna o status de como foi o decorrer da ação.

pipedrive.create_deal

Cria um novo acordo.

Parâmetros:

pipedrive - instância do pipedrive fornecida por pipedrive.create.

data - informações necessarias para a criação de um novo acordo.

Retornar:

response - retorna o status de como foi o decorrer da ação.

pipedrive.create_activity

Cria uma nova atividade.

Parâmetros:

pipedrive - instância do pipedrive fornecida por pipedrive.create.

data - informações necessarias para a criação de uma nova atividade.

Retornar:

response - retorna o status de como foi o decorrer da ação.

pipedrive.search_persons

Procura por todas as pessoas que se encaixem com os params passados.

Parâmetros:

pipedrive - instância do pipedrive fornecida por pipedrive.create.

params - informações necessarias para localizar as pessoas.

Retornar:

response - pessoas encontradas.

pipedrive.search_organizations

Procura por todas as organizações que se encaixem com os params passados.

Parâmetros:

pipedrive - instância do pipedrive fornecida por pipedrive.create.

params - informações necessarias para localizar as organizações.

Retornar:

response - organizações encontradas.

pipedrive.get_person_deals

Lista de acordos, que se encaixem com os params passados, relacionados a certa pessoa .

Parâmetros:

pipedrive - instância do pipedrive fornecida por pipedrive.create.

person_id - identificação da pessoa a ser procurada.

params - informações necessarias para localizar os acordos.

Retornar:

response - acordos encontrados.

pipedrive.get_person_activities

Lista todas as atividades relacionadas a certa pessoa.

Parâmetros:

pipedrive - instância do pipedrive fornecida por pipedrive.create.

person_id - identificação da pessoa a ser procurada.

Retornar:

response - atividades encontradas.