@spec get(Pluggy.Client.t(), String.t()) :: {:ok, term()} | {:error, Pluggy.Error.t()}

Gets an investment by ID.

@spec list(Pluggy.Client.t(), String.t() | map(), keyword()) ::
  {:ok, term()} | {:error, Pluggy.Error.t()}

Lists investments for a given item.

The second argument accepts either an item ID string or an item map (e.g. the result of Pluggy.Items.get/2) — the :id field is extracted automatically.

Examples

Pluggy.Investments.list(client, "item-uuid")
Pluggy.Investments.list(client, item)   # item is %{id: "item-uuid", ...}

@spec list_with_cursor(Pluggy.Client.t(), String.t() | map(), keyword()) ::
  {:ok, map(), Pluggy.HTTP.Cursor.t() | nil} | {:error, Pluggy.Error.t()}

Lists investments with cursor-based pagination.

The second argument accepts either an item ID string or an item map — the :id field is extracted automatically.

Returns {:ok, response, cursor} where cursor is a %Pluggy.HTTP.Cursor{} when more pages are available, or nil when on the last page.

Pass the cursor to Pluggy.HTTP.with_cursor/1 to fetch the next page.

@spec transactions(Pluggy.Client.t(), String.t() | map(), keyword()) ::
  {:ok, term()} | {:error, Pluggy.Error.t()}

Fetches transactions for an investment.

The second argument accepts either an investment ID string or an investment map (e.g. an entry from Pluggy.Investments.list/2) — the :id field is extracted automatically:

{:ok, %{results: [investment | _]}} = Pluggy.Investments.list(client, item_id)
Pluggy.Investments.transactions(client, investment)