Increase.Entities (Increase v1.0.0)

Entities are the legal entities that own accounts. They can be people, corporations, partnerships, government authorities, or trusts. To learn more, see [Entities].

See https://increase.com/documentation/api/entities for the full API reference for this resource.

Summary

Functions

archive(client, entity_id, opts \\ [])

Archive an Entity

create(client, params \\ %{}, opts \\ [])

Create an Entity

list(client, params \\ %{}, opts \\ [])

List Entities

retrieve(client, entity_id, opts \\ [])

Retrieve an Entity

update(client, entity_id, params \\ %{}, opts \\ [])

Update an Entity

Functions

archive(client, entity_id, opts \\ [])

@spec archive(Increase.Client.t() | keyword() | nil, String.t(), keyword()) ::
  {:ok, Increase.Entities.Entity.t()} | {:error, Increase.Error.t()}

Archive an Entity

POST /entities/{entity_id}/archive

create(client, params \\ %{}, opts \\ [])

@spec create(Increase.Client.t() | keyword() | nil, map() | keyword(), keyword()) ::
  {:ok, Increase.Entities.Entity.t()} | {:error, Increase.Error.t()}

Create an Entity

POST /entities

list(client, params \\ %{}, opts \\ [])

@spec list(Increase.Client.t() | keyword() | nil, map() | keyword(), keyword()) ::
  {:ok, Increase.Page.t()} | {:error, Increase.Error.t()}

List Entities

Returns a %Increase.Page{} whose data is a list of %__MODULE__. Entity{} structs. Page through results with Increase.Page.auto_paging_stream/1 or Increase.Page.auto_paging_each/2.

GET /entities

retrieve(client, entity_id, opts \\ [])

@spec retrieve(Increase.Client.t() | keyword() | nil, String.t(), keyword()) ::
  {:ok, Increase.Entities.Entity.t()} | {:error, Increase.Error.t()}

Retrieve an Entity

GET /entities/{entity_id}

update(client, entity_id, params \\ %{}, opts \\ [])

@spec update(
  Increase.Client.t() | keyword() | nil,
  String.t(),
  map() | keyword(),
  keyword()
) ::
  {:ok, Increase.Entities.Entity.t()} | {:error, Increase.Error.t()}

Update an Entity

PATCH /entities/{entity_id}