View Source ExPipedrive.ProjectBoards (ex_pipedrive v0.2.0)

Pipedrive project boards resource — workflow containers for projects.

v2 helpers talk to /api/v2/boards via ExPipedrive.Resource. Shapes follow Pipedrive OpenAPI v2.

Phases within a board (/api/v2/phases) are not implemented here; see ExPipedrive.Projects moduledoc for other deferred project-cluster APIs.

Example

{:ok, boards} = ExPipedrive.ProjectBoards.list_page(client)
{:ok, board} = ExPipedrive.ProjectBoards.get(client, 1)

{:ok, board} =
  ExPipedrive.ProjectBoards.create(client, %{name: "Delivery board", order_nr: 1})

{:ok, board} =
  ExPipedrive.ProjectBoards.update(client, board.id, %{name: "Renamed board"})

{:ok, %{"data" => %{"id" => _}}} = ExPipedrive.ProjectBoards.delete(client, board.id)

Summary

Functions

Creates a project board via POST /api/v2/boards.

Deletes a project board via DELETE /api/v2/boards/:id.

Fetches a project board by id via GET /api/v2/boards/:id.

Lists project boards via GET /api/v2/boards.

Streams project boards. For the live API this is typically a single page.

Updates a project board via PATCH /api/v2/boards/:id.

Functions

Creates a project board via POST /api/v2/boards.

Requires :name. Returns {:ok, %ProjectBoard{}}.

Link to this function

delete(client, board_id)

View Source

Deletes a project board via DELETE /api/v2/boards/:id.

Fetches a project board by id via GET /api/v2/boards/:id.

Link to this function

list_page(client, opts \\ [])

View Source

Lists project boards via GET /api/v2/boards.

Pipedrive returns all active boards in one response (no cursor in OpenAPI). :cursor and :limit are forwarded if supplied but may be ignored by the API.

Link to this function

stream(client, opts \\ [])

View Source

Streams project boards. For the live API this is typically a single page.

Link to this function

update(client, board_id, attrs)

View Source

Updates a project board via PATCH /api/v2/boards/:id.