View Source ExPipedrive.Pipelines (ex_pipedrive v0.1.0)

Pipedrive pipelines resource.

v2-first helpers (get/2, create/2, update/3, delete/2, list_page/2, stream/2) talk to /api/v2/pipelines. Legacy list_pipelines/1 and list_pipeline_deals/2 remain on API v1.

For deals in a pipeline on v2, prefer ExPipedrive.Deals.list_page/2 or stream/2 with pipeline_id: — Pipedrive deprecated GET /pipelines/:id/deals.

Summary

Functions

Creates a pipeline via POST /api/v2/pipelines.

Deletes a pipeline via DELETE /api/v2/pipelines/:id.

Fetches a pipeline by id via GET /api/v2/pipelines/:id.

Lists one page of pipelines via API v2 cursor pagination.

Lists deals in a pipeline via deprecated v1 GET /pipelines/:id/deals.

Lazily streams pipelines across all v2 cursor pages until next_cursor is nil.

Updates a pipeline via PATCH /api/v2/pipelines/:id.

Functions

Creates a pipeline via POST /api/v2/pipelines.

Accepts a map (preferred) or %Pipeline{}. Returns {:ok, %Pipeline{}}.

Link to this function

delete(client, pipeline_id)

View Source

Deletes a pipeline via DELETE /api/v2/pipelines/:id.

Link to this function

get(client, pipeline_id)

View Source

Fetches a pipeline by id via GET /api/v2/pipelines/:id.

Link to this function

list_page(client, opts \\ [])

View Source

Lists one page of pipelines via API v2 cursor pagination.

Options: :cursor, :limit (clamped to 500), :sort_by, :sort_direction.

Link to this function

list_pipeline_deals(client, pipeline_id)

View Source

Lists deals in a pipeline via deprecated v1 GET /pipelines/:id/deals.

Prefer ExPipedrive.Deals.list_page(client, pipeline_id: id) on API v2.

Link to this function

list_pipelines_page(client, opts \\ [])

View Source
Link to this function

stream(client, opts \\ [])

View Source

Lazily streams pipelines across all v2 cursor pages until next_cursor is nil.

Link to this function

stream_pipelines(client, opts \\ [])

View Source
Link to this function

update(client, pipeline_id, attrs)

View Source

Updates a pipeline via PATCH /api/v2/pipelines/:id.