View Source ExPipedrive.Page (ex_pipedrive v0.2.0)

A single cursor-paginated page of Pipedrive API v2 results.

Prefer this over bare lists for v2 list endpoints so callers can follow next_cursor (or use ExPipedrive.Cursor.stream/2).

List return conventions

API style	Preferred return	Stream
v2 cursor	`{:ok, %Page{}}` via `list_page/2`	`stream/2`
v1 offset	`{:ok, %ExPipedrive.PagedResult{}}` via `list/2`	optional
Fixed / tiny collections (no pagination)	`{:ok, list}`	n/a

Avoid helpers that return a bare list when the underlying endpoint is paginated — see ExPipedrive.Notes.get_all_org_notes/2 (now a PagedResult wrapper) and soft-deprecated ExPipedrive.Pipelines.list_pipelines/1.

t()

done?(page)

True when there is no further page to fetch.

Builds a page from decoded entities and a raw API response body.

@type t() :: %ExPipedrive.Page{
  data: list(),
  limit: (pos_integer() | nil) | nil,
  next_cursor: (String.t() | nil) | nil
}

@spec done?(t()) :: boolean()

True when there is no further page to fetch.

@spec from_items(list(), map()) :: t()

Builds a page from decoded entities and a raw API response body.