View Source ExPipedrive.Notes (ex_pipedrive v0.2.0)
API v1 shim for Pipedrive notes.
All functions in this module explicitly route to /api/v1/notes. Prefer the
get/2, create/2, and list/2 aliases for new code; add_note/2 and
list_notes/2 remain supported for compatibility. A v2 Notes resource can
replace this shim without changing callers that use those aliases.
List return shapes
Paginated note lists return {:ok, %ExPipedrive.PagedResult{}} (v1 offset
pagination). Prefer list/2 with filters such as :org_id over
get_all_org_notes/2 (kept as a thin wrapper that returns the same
PagedResult shape).
Summary
Functions
Soft-deprecated: prefer create/2.
Creates a note through POST /api/v1/notes.
Fetches a note by id through GET /api/v1/notes/:id.
Soft-deprecated: prefer list/2 with org_id:.
Soft-deprecated: prefer list/2 with org_id:.
Soft-deprecated: prefer get/2.
Lists notes through GET /api/v1/notes.
Soft-deprecated: prefer list/2.
Functions
Soft-deprecated: prefer create/2.
Creates a note through POST /api/v1/notes.
Creates a note through POST /api/v1/notes.
Accepts a map (preferred) or %Note{} and returns {:ok, %Note{}}.
Fetches a note by id through GET /api/v1/notes/:id.
Soft-deprecated: prefer list/2 with org_id:.
Lists notes for an organization via GET /api/v1/notes?org_id=….
Prefer list/2 with :org_id for new code. Returns
{:ok, %PagedResult{}} (same as list/2).
Accepts either get_all_org_notes(client, org_id, opts) or
get_all_org_notes(client, org_id: id, …) for historical call sites.
Soft-deprecated: prefer list/2 with org_id:.
Soft-deprecated: prefer get/2.
Fetches a note by id through GET /api/v1/notes/:id.
Lists notes through GET /api/v1/notes.
Supports the legacy v1 pagination and filtering options accepted by
list_notes/2. Returns {:ok, %PagedResult{}}.
Soft-deprecated: prefer list/2.
Lists notes through GET /api/v1/notes.