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 a Beneficial Owner
Create a Beneficial Owner
List Beneficial Owners
Retrieve a Beneficial Owner
Update a Beneficial Owner
Functions
@spec archive(Increase.Client.t() | keyword() | nil, String.t(), keyword()) :: {:ok, Increase.BeneficialOwners.EntityBeneficialOwner.t()} | {:error, Increase.Error.t()}
Archive a Beneficial Owner
POST /entity_beneficial_owners/{entity_beneficial_owner_id}/archive
@spec create(Increase.Client.t() | keyword() | nil, map() | keyword(), keyword()) :: {:ok, Increase.BeneficialOwners.EntityBeneficialOwner.t()} | {:error, Increase.Error.t()}
Create a Beneficial Owner
POST /entity_beneficial_owners
@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
@spec retrieve(Increase.Client.t() | keyword() | nil, String.t(), keyword()) :: {:ok, Increase.BeneficialOwners.EntityBeneficialOwner.t()} | {:error, Increase.Error.t()}
Retrieve a Beneficial Owner
GET /entity_beneficial_owners/{entity_beneficial_owner_id}
@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}