View Source ExPipedrive.Leads (ex_pipedrive v0.1.0)

API v1 shim for Pipedrive leads.

All functions in this module explicitly route to /api/v1/leads. Prefer the get/2, create/2, update/3, and list/2 aliases for new code; the original *_lead names remain supported for compatibility. A v2 Leads resource can replace this shim without changing callers that use those aliases.

Summary

Functions

create(client, attrs)

Creates a lead through POST /api/v1/leads.

create_lead(client, attrs)

Creates a lead through POST /api/v1/leads.

get(client, lead_id)

Fetches a lead by id through GET /api/v1/leads/:id.

get_lead(client, lead_id)

Fetches a lead by id through GET /api/v1/leads/:id.

list(client, opts \\ [])

Lists leads through GET /api/v1/leads.

list_leads(client, opts \\ [])

Lists leads through GET /api/v1/leads.

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

update(client, lead_id, attrs)

Updates a lead through PATCH /api/v1/leads/:id.

update_lead(client, lead_id, attrs)

Updates a lead through PATCH /api/v1/leads/:id.

Functions

create(client, attrs)

Creates a lead through POST /api/v1/leads.

Accepts a map (preferred) or %Lead{} and returns {:ok, %Lead{}}.

create_lead(client, attrs)

Creates a lead through POST /api/v1/leads.

get(client, lead_id)

Fetches a lead by id through GET /api/v1/leads/:id.

get_lead(client, lead_id)

Fetches a lead by id through GET /api/v1/leads/:id.

list(client, opts \\ [])

Lists leads through GET /api/v1/leads.

Supports :start, :limit, :owner_id, :person_id, :organization_id, :filter_id, and :sort.

list_leads(client, opts \\ [])

Lists leads through GET /api/v1/leads.

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

update(client, lead_id, attrs)

Updates a lead through PATCH /api/v1/leads/:id.

Accepts a map (preferred) or %Lead{} and returns {:ok, %Lead{}}.

update_lead(client, lead_id, attrs)

Updates a lead through PATCH /api/v1/leads/:id.