defmodule Ibanity.Sandbox.FinancialInstitutionAccount do
@moduledoc """
[Financial institution account](https://documentation.ibanity.com/xs2a/api#financial-institution-account) API wrapper
"""
use Ibanity.Resource
defstruct id: nil,
available_balance: nil,
currency: nil,
current_balance: nil,
description: nil,
reference: nil,
reference_type: nil,
subtype: nil,
created_at: nil,
updated_at: nil,
internal_reference: nil,
product: nil,
holder_name: nil,
current_balance_changed_at: nil,
current_balance_variation_observed_at: nil,
current_balance_reference_date: nil,
available_balance_changed_at: nil,
available_balance_variation_observed_at: nil,
available_balance_reference_date: nil,
authorized_at: nil,
authorization_expiration_expected_at: nil,
financial_institution_user: nil,
financial_institution_user_id: nil,
financial_institution_id: nil,
transactions: nil
@api_schema_path ["sandbox", "financialInstitution", "financialInstitutionAccounts"]
@resource_type "financial_institution_account"
@doc """
[Creates a new financial institution account](https://documentation.ibanity.com/xs2a/api#create-financial-institution-account).
Returns `{:ok, account}` when successful, `{:error, reason}` otherwise.
## Example
iex> [
...> subtype: "checking",
...> reference: "BE456789012",
...> reference_type: "IBAN",
...> description: "Savings account",
...> currency: "EUR"
...> ]
...> |> Request.attributes
...> |> Request.id(:financial_institution_id, "b5d6c5f9-e1d2-4cd1-a2aa-7baf964f7bf7")
...> |> Request.id(:financial_institution_user_id, "a64f42ec-c801-41a7-8801-0f815ca42e9e")
...> |> FinancialInstitutionAccount.create
{:ok, %Ibanity.FinancialInstitutionAccount{id: "3034fe85-29ee-4ebc-9a2d-33df4e2f4602", ...}}
"""
def create(%Request{} = request) do
request
|> Request.id(:id, "")
|> Request.resource_type(@resource_type)
|> Client.execute(:post, @api_schema_path)
end
@doc """
[List all accounts](https://documentation.ibanity.com/xs2a/api#list-financial-institution-accounts)
belonging to a user, within a financial institution.
Returns `{:ok, accounts}` where `accounts` is a `Ibanity.Collection` where items are `Ibanity.FinancialInstitutionAccount`.
"""
def list(institution_id, user_id) do
Request.id(:financial_institution_id, institution_id)
|> Request.id(:financial_institution_user_id, user_id)
|> list
end
@doc """
[List all accounts](https://documentation.ibanity.com/xs2a/api#list-financial-institution-accounts)
belonging to a user, within a financial institution.
Returns `{:ok, accounts}` where `accounts` is a `Ibanity.Collection` where items are `Ibanity.FinancialInstitutionAccount`.
## Examples
iex> |> Request.id(:financial_institution_id, "b5d6c5f9-e1d2-4cd1-a2aa-7baf964f7bf7")
...> |> Request.id(:financial_institution_user_id, "a64f42ec-c801-41a7-8801-0f815ca42e9e")
...> |> FinancialInstitutionAccount.list
{:ok, %Ibanity.Collection{items: [%Ibanity.FinancialInstitutionAccount{...}], ...}}
"""
def list(%Request{} = request) do
request
|> Request.id(:id, "")
|> Client.execute(:get, @api_schema_path)
end
@doc """
[Retrieves an account](https://documentation.ibanity.com/xs2a/api#get-financial-institution-account)
belonging to a user and a financial institution.
Returns `{:ok, account}` when successful, `{:error, reason}` otherwise.
## Example
iex> FinancialInstitutionAccount.find(
...> "b5d6c5f9-e1d2-4cd1-a2aa-7baf964f7bf7",
...> "a64f42ec-c801-41a7-8801-0f815ca42e9e",
...> "b1c1e046-309b-49b8-bc5d-c4b1f82f61a7",
...> )
{:ok, Ibanity.FinancialInstitutionAccount{id: "b1c1e046-309b-49b8-bc5d-c4b1f82f61a7", ...}}
"""
def find(institution_id, user_id, account_id) do
Request.id(:financial_institution_id, institution_id)
|> Request.id(:financial_institution_user_id, user_id)
|> Request.id(:id, account_id)
|> find
end
@doc """
[Retrieves an account](https://documentation.ibanity.com/xs2a/api#get-financial-institution-account)
belonging to a user and a financial institution.
Returns `{:ok, account}` when successful, `{:error, reason}` otherwise.
## Example
iex> Request.id(:financial_institution_id, "b5d6c5f9-e1d2-4cd1-a2aa-7baf964f7bf7")
...> |> Request.id(:financial_institution_user_id, "a64f42ec-c801-41a7-8801-0f815ca42e9e")
...> |> Request.id(:id, "b1c1e046-309b-49b8-bc5d-c4b1f82f61a7")
...> |> FinancialInstitutionAccount.find
{:ok, Ibanity.FinancialInstitutionAccount{id: "b1c1e046-309b-49b8-bc5d-c4b1f82f61a7", ...}}
"""
def find(%Request{} = request) do
request
|> Client.execute(:get, @api_schema_path)
end
@doc """
[Deletes an account](https://documentation.ibanity.com/xs2a/api#delete-financial-institution-account)
belonging to a user and a financial institution.
Returns `{:ok, account}` when successful, `{:error, reason}` otherwise.
## Example
iex> Ibanity.FinancialInstitutionAccount.delete(
...> "b5d6c5f9-e1d2-4cd1-a2aa-7baf964f7bf7",
...> "a64f42ec-c801-41a7-8801-0f815ca42e9e",
...> "b1c1e046-309b-49b8-bc5d-c4b1f82f61a7",
...> )
{:ok, FinancialInstitutionAccount{id: "b1c1e046-309b-49b8-bc5d-c4b1f82f61a7", ...}}
"""
def delete(institution_id, user_id, account_id) do
Request.id(:financial_institution_id, institution_id)
|> Request.id(:financial_institution_user_id, user_id)
|> Request.id(:id, account_id)
|> delete
end
@doc """
[Deletes an account](https://documentation.ibanity.com/xs2a/api#delete-financial-institution-account)
belonging to a user and a financial institution.
Returns `{:ok, account}` when successful, `{:error, reason}` otherwise.
## Example
iex> Request.id(:financial_institution_id, "b5d6c5f9-e1d2-4cd1-a2aa-7baf964f7bf7")
...> |> Request.id(:financial_institution_user_id, "a64f42ec-c801-41a7-8801-0f815ca42e9e")
...> |> Request.id(:id, "b1c1e046-309b-49b8-bc5d-c4b1f82f61a7")
...> |> FinancialInstitutionAccount.delete
{:ok, Ibanity.FinancialInstitutionAccount{id: "b1c1e046-309b-49b8-bc5d-c4b1f82f61a7", ...}}
"""
def delete(%Request{} = request) do
request
|> Client.execute(:delete, @api_schema_path)
end
@doc """
Fetches the transactions associated to this account.
Returns:
* `{:ok, transactions}` if successful, where `transactions` is an `Ibanity.Collection`
* `nil` if no transaction link was set on the structure
* `{:error, reason}` otherwise
"""
def transactions(%__MODULE__{} = account) do
if account.transactions, do: Client.get(account.transactions), else: nil
end
@doc """
Fetches the financial institution user this account belongs to.
Returns:
* `{:ok, institution}` if successful,
* `nil` if no financial institution user link was set on the structure
* `{:error, reason}` otherwise
"""
def financial_institution_user(%__MODULE__{} = account) do
if account.financial_institution_user,
do: Client.get(account.financial_institution_user),
else: nil
end
@doc false
def key_mapping do
[
id: {~w(id), :string},
available_balance: {~w(attributes availableBalance), :float},
currency: {~w(attributes currency), :string},
current_balance: {~w(attributes currentBalance), :float},
description: {~w(attributes description), :string},
reference: {~w(attributes reference), :string},
reference_type: {~w(attributes referenceType), :string},
subtype: {~w(attributes subtype), :string},
internal_reference: {~w(attributes internalReference), :string},
product: {~w(attributes product), :string},
holder_name: {~w(attributes holderName), :string},
current_balance_changed_at: {~w(attributes currentBalanceChangedAt), :datetime},
current_balance_variation_observed_at: {~w(attributes currentBalanceVariationObservedAt), :datetime},
current_balance_reference_date: {~w(attributes currentBalanceReferenceDate), :datetime},
available_balance_changed_at: {~w(attributes availableBalanceChangedAt), :datetime},
available_balance_variation_observed_at: {~w(attributes availableBalanceVariationObservedAt), :datetime},
available_balance_reference_date: {~w(attributes availableBalanceReferenceDate), :datetime},
authorized_at: {~w(attributes authorizedAt), :datetime},
authorization_expiration_expected_at: {~w(attributes authorizationExpirationExpectedAt), :datetime},
transactions: {~w(relationships financialInstitutionTransactions links related), :string},
financial_institution_user:
{~w(relationships financialInstitutionUser links related), :string},
financial_institution_user_id:
{~w(relationships financialInstitutionUser data id), :string},
financial_institution_id: {~w(relationships financialInstitution data id), :string},
created_at: {~w(attributes createdAt), :datetime},
updated_at: {~w(attributes updatedAt), :datetime}
]
end
end
