Increase.BeneficialOwners (Increase v1.0.0)

Copy Markdown View Source

Functions for working with BeneficialOwners via the Increase API.

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

Summary

Functions

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

Archive a Beneficial Owner

POST /entity_beneficial_owners/{entity_beneficial_owner_id}/archive

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

Create a Beneficial Owner

POST /entity_beneficial_owners

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

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

List Beneficial Owners

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

GET /entity_beneficial_owners

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

Retrieve a Beneficial Owner

GET /entity_beneficial_owners/{entity_beneficial_owner_id}

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

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

Update a Beneficial Owner

PATCH /entity_beneficial_owners/{entity_beneficial_owner_id}