Ibanity.Sandbox.FinancialInstitutionUser (ibanity v0.12.0)
Financial institution user API wrapper
Link to this section Summary
Functions
Finds a financial institution user based on its id.
Link to this section Functions
create(request)
Creates a new financial institution user.
Returns {:ok, user} when successful, {:error, reason} otherwise.
example
Example
iex> [
...> login: "jlopez",
...> password: "password",
...> last_name: "Lopez",
...> first_name: "Jane"
...> ]
...> |> Request.attributes
...> |> Ibanity.FinancialInstitutionUser.create
{:ok, %Ibanity.FinancialInstitutionUser{id: "5178d658-0c33-440a-a3af-616a8e472617", ...}}delete(request)
Deletes a financial institution user.
Returns {:ok, user} when successful, {:error, reason} otherwise.
example
Example
iex> |> Request.id(:id, "0934789d-e177-484f-b197-f60b40b0f9c4")
...> |> Ibanity.FinancialInstitutionUser.update
{:ok, %Ibanity.FinancialInstitutionUser{id: "5178d658-0c33-440a-a3af-616a8e472617", ...}}find(request)
Finds a financial institution user based on its id.
Returns {:ok, user} when successful, {:error, reason} otherwise.
example
Example
iex>
...> |> Request.attribute()
...> |> Ibanity.FinancialInstitutionUser.find
{:ok, %Ibanity.FinancialInstitutionUser{id: "5178d658-0c33-440a-a3af-616a8e472617", ...}}list()
list(request)
Lists all financial institution users.
Returns {:ok, collection} where collection is of type Ibanity.Collection and its items are of type Ibanity.FinancialInstitutionUser,
otherwise returns {:error, reason}.
example
Example
iex> Ibanity.FinancialInstitutionUser.list
{:ok, %Ibanity.Collection{items: [%Ibanity.FinancialInstitutionUser{...}], ...}}update(request)
Updates a financial institution user.
Returns {:ok, user} when successful, {:error, reason} otherwise.
example
Example
iex> [
...> login: "jlopez",
...> password: "password",
...> last_name: "Lopez",
...> first_name: "Jane"
...> ]
...> |> Request.attributes
...> |> Request.id(:id, "0934789d-e177-484f-b197-f60b40b0f9c4")
...> |> Ibanity.FinancialInstitutionUser.update
{:ok, %Ibanity.FinancialInstitutionUser{id: "5178d658-0c33-440a-a3af-616a8e472617", ...}}