Ramp.Entities (ramp v1.0.0)

Copy Markdown View Source

The Entities resource: read-only access to the legal business entities under a Ramp account (relevant for multi-entity businesses).

Summary

Functions

Returns a lazily auto-paginating Stream of Ramp.Entities.Entitys.

Fetches a single page of entities. See Ramp.Page.

Types

list_opt()

@type list_opt() :: {:start, String.t()} | {:page_size, pos_integer()}

Functions

list(client, opts \\ [])

Returns a lazily auto-paginating Stream of Ramp.Entities.Entitys.

list_page(client, opts \\ [])

@spec list_page(Ramp.Client.t(), [list_opt()]) ::
  {:ok, Ramp.Page.t(Ramp.Entities.Entity.t())} | {:error, Ramp.Error.t()}

Fetches a single page of entities. See Ramp.Page.