nubank_api v1.1.0 NubankAPI.Feature.BillSummaries

Module responsible for handling the data from the :bills_summary endpoint.

Link to this section Summary

Functions

Fetch bill summaries (both open and overdue)

List the known bill states

Link to this section Functions

Link to this function

fetch_bill_summaries(access, opts \\ [])

Fetch bill summaries (both open and overdue)

Examples

iex> NubankAPI.Feature.BillSummaries.fetch_bill_summaries(access)
{:ok, [%BillSummary{}]}

iex> NubankAPI.Feature.BillSummaries.fetch_bill_summaries(access, state: :open)
{:ok, [%BillSummary{state: :open}]}
Link to this function

list_known_states()

List the known bill states

Examples

iex> NubankAPI.Feature.BillSummaries.list_known_states()
[:open, :overdue]