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

Link to this function

add_activity(client, activity)

View Source
This function is deprecated. Use ExPipedrive.Activities.create/2.
This function is deprecated. Use ExPipedrive.Notes.create/2.
Link to this function

build_client(refresh_token, client_id, client_secret, api_domain)

View Source

Builds a Tesla client by refreshing an OAuth access token once.

Link to this function

client(api_token, api_domain, opts \\ [])

View Source

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.

Link to this function

create_lead(client, lead)

View Source
This function is deprecated. Use ExPipedrive.Leads.create/2.
Link to this function

create_organization(client, org)

View Source
This function is deprecated. Use ExPipedrive.Organizations.create/2.
Link to this function

create_person(client, person)

View Source
This function is deprecated. Use ExPipedrive.Persons.create/2.
Link to this function

find_users_by_name(client, term, opts \\ [])

View Source

See ExPipedrive.Users.find_users_by_name/3.

Link to this function

get_all_org_notes(client, org_id, opts \\ [])

View Source
This function is deprecated. Use ExPipedrive.Notes.list/2 with org_id:.
Link to this function

get_deal(client, deal_id)

View Source
This function is deprecated. Use ExPipedrive.Deals.get/2.
Link to this function

get_lead(client, lead_id)

View Source
This function is deprecated. Use ExPipedrive.Leads.get/2.
Link to this function

get_organization(client, org_id)

View Source
This function is deprecated. Use ExPipedrive.Organizations.get/2.
Link to this function

get_person(client, person_id)

View Source
This function is deprecated. Use ExPipedrive.Persons.get/2.
Link to this function

get_user(client, user_id)

View Source

See ExPipedrive.Users.get/2.

Link to this function

list_activities(client, opts \\ [])

View Source
This function is deprecated. Use ExPipedrive.Activities.list_page/2 or stream/2.
Link to this function

list_activities_page(client, opts \\ [])

View Source

See ExPipedrive.Activities.list_activities_page/2.

Link to this function

list_activity_types(client)

View Source

See ExPipedrive.ActivityTypes.list_activity_types/1.

Link to this function

list_deal_fields(client, opts)

View Source

See ExPipedrive.DealFields.list_deal_fields/2.

Link to this function

list_deals(client, opts)

View Source
This function is deprecated. Use ExPipedrive.Deals.list_page/2 or stream/2.
Link to this function

list_deals_page(client, opts \\ [])

View Source

See ExPipedrive.Deals.list_deals_page/2.

Link to this function

list_leads(client, opts \\ [])

View Source

See ExPipedrive.Leads.list/2.

Link to this function

list_notes(client, opts \\ [])

View Source

See ExPipedrive.Notes.list/2.

Link to this function

list_organization_fields(client, opts)

View Source

See ExPipedrive.OrganizationFields.list_organization_fields/2.

Link to this function

list_organizations(client, opts)

View Source
This function is deprecated. Use ExPipedrive.Organizations.list_page/2 or stream/2.
Link to this function

list_organizations_page(client, opts \\ [])

View Source

See ExPipedrive.Organizations.list_organizations_page/2.

Link to this function

list_own_activities(client, opts \\ [])

View Source
This function is deprecated. Use ExPipedrive.Activities.list_page/2 with owner_id:.
Link to this function

list_person_fields(client, opts)

View Source

See ExPipedrive.PersonFields.list_person_fields/2.

Link to this function

list_persons(client, opts)

View Source
This function is deprecated. Use ExPipedrive.Persons.list_page/2 or stream/2.
Link to this function

list_persons_page(client, opts \\ [])

View Source

See ExPipedrive.Persons.list_persons_page/2.

Link to this function

list_pipeline_deals(client, pipeline_id)

View Source
This function is deprecated. Use ExPipedrive.Deals.list_page/2 with pipeline_id:.
This function is deprecated. Use ExPipedrive.Pipelines.list_page/2 or stream/2.
Link to this function

list_products_page(client, opts \\ [])

View Source

See ExPipedrive.Products.list_products_page/2.

Link to this function

list_users(client, opts \\ [])

View Source

See ExPipedrive.Users.list/2.

See ExPipedrive.Users.me/1.

Link to this function

search_deals(client, term, opts)

View Source
This function is deprecated. Use ExPipedrive.Search.search_deals/3.
Link to this function

search_leads(client, term, opts)

View Source
This function is deprecated. Use ExPipedrive.Leads.list/2 where possible.
Link to this function

search_organizations(client, term, opts)

View Source
This function is deprecated. Use ExPipedrive.Search.search_organizations/3.
Link to this function

search_page(client, term, opts \\ [])

View Source

See ExPipedrive.Search.search_page/3.

Link to this function

search_persons(client, term, opts)

View Source
This function is deprecated. Use ExPipedrive.Search.search_persons/3.
Link to this function

stream_activities(client, opts \\ [])

View Source

See ExPipedrive.Activities.stream_activities/2.

Link to this function

stream_deals(client, opts \\ [])

View Source

See ExPipedrive.Deals.stream_deals/2.

Link to this function

stream_organizations(client, opts \\ [])

View Source

See ExPipedrive.Organizations.stream_organizations/2.

Link to this function

stream_persons(client, opts \\ [])

View Source

See ExPipedrive.Persons.stream_persons/2.

Link to this function

stream_products(client, opts \\ [])

View Source

See ExPipedrive.Products.stream_products/2.

Link to this function

stream_search(client, term, opts \\ [])

View Source

See ExPipedrive.Search.stream/3.

Link to this function

update_organization(client, org_id, data)

View Source
This function is deprecated. Use ExPipedrive.Organizations.update/3.