View Source ExPipedrive (ex_pipedrive v0.2.0)
Convenience entrypoint for ExPipedrive.
Blessed path (prefer this)
Call resource modules directly — they are the supported public surface:
client = ExPipedrive.client(token, "company.pipedrive.com")
{:ok, deal} = ExPipedrive.Deals.get(client, deal_id)
ExPipedrive.Deals.stream(client, status: "open") |> Enum.to_list()
{:ok, page} = ExPipedrive.Search.search_deals(client, "acme")Naming conventions:
- API v2:
get/2,create/2,update/3,delete/2,list_page/2,stream/2 - API v1 offset lists:
list/2→{:ok, %ExPipedrive.PagedResult{}} - Escape hatch:
ExPipedrive.Raw/ExPipedrive.Resource
This root module keeps a compatibility facade of convenience wrappers
(LineDrive-era names and a subset of v2 list/stream helpers). It is
intentionally incomplete — newer modules (Projects, Files, Filters, …) are not
mirrored here. Prefer the ExPipedrive.* resource modules for new code.
Legacy twin functions on resource modules (e.g. Deals.get_deal/2) are soft-
deprecated; they remain available but document a migration path to the v2 names.
Summary
Functions
Builds a Tesla client by refreshing an OAuth access token once.
Builds a Tesla client authenticated with a Pipedrive API token.
Functions
Builds a Tesla client by refreshing an OAuth access token once.
Builds a Tesla client authenticated with a Pipedrive API token.
api_domain may be a full base URL or a host (e.g. company.pipedrive.com).
Defaults to x-api-token header auth; see ExPipedrive.Client for options
and ExPipedrive.Request for versioned routing.
See ExPipedrive.OrganizationFields.list_organization_fields/2.