Humaans.BankAccounts behaviour (Humaans v0.4.0)

This module provides functions for managing bank account resources in the Humaans API.

Summary

Types

delete_response()

list_response()

response()

Callbacks

create(client, map)

delete(client, t)

list(client, map)

retrieve(client, t)

update(client, t, map)

Functions

create(client, params)

Creates a new bank account resource.

delete(client, id)

Deletes a specific bank account by ID.

list(client, params \\ %{})

Lists all bank account resources.

retrieve(client, id)

Retrieves a specific bank account by ID.

update(client, id, params)

Updates a specific bank account by ID.

Types

delete_response()

@type delete_response() :: {:ok, %{id: String.t(), deleted: bool()}} | {:error, any()}

list_response()

@type list_response() ::
  {:ok,
   [
     %Humaans.Resources.BankAccount{
       account_number: term(),
       bank_name: term(),
       created_at: term(),
       id: term(),
       name_on_account: term(),
       person_id: term(),
       routing_number: term(),
       sort_code: term(),
       swift_code: term(),
       updated_at: term()
     }
   ]}
  | {:error, any()}

response()

@type response() ::
  {:ok,
   %Humaans.Resources.BankAccount{
     account_number: term(),
     bank_name: term(),
     created_at: term(),
     id: term(),
     name_on_account: term(),
     person_id: term(),
     routing_number: term(),
     sort_code: term(),
     swift_code: term(),
     updated_at: term()
   }}
  | {:error, any()}

Callbacks

create(client, map)

@callback create(client :: map(), map()) :: {:ok, map()} | {:error, any()}

delete(client, t)

@callback delete(client :: map(), String.t()) :: {:ok, map()} | {:error, any()}

list(client, map)

@callback list(client :: map(), map()) :: {:ok, map()} | {:error, any()}

retrieve(client, t)

@callback retrieve(client :: map(), String.t()) :: {:ok, map()} | {:error, any()}

update(client, t, map)

@callback update(client :: map(), String.t(), map()) :: {:ok, map()} | {:error, any()}

Functions

create(client, params)

@spec create(client :: map(), params :: keyword()) :: response()

Creates a new bank account resource.

Parameters

client - Client map created with Humaans.new/1
params - Map of parameters for the new bank account

Examples

client = Humaans.new(access_token: "your_access_token")

params = %{
  personId: "person_id",
  accountType: "personal",
  accountHolder: "Jane Doe",
  accountNumber: "12345678",
  sortCode: "01-02-03"
}

{:ok, account} = Humaans.BankAccounts.create(client, params)

delete(client, id)

@spec delete(client :: map(), id :: String.t()) :: delete_response()

Deletes a specific bank account by ID.

Parameters

client - Client map created with Humaans.new/1
id - String ID of the bank account to delete

Examples

client = Humaans.new(access_token: "your_access_token")

{:ok, result} = Humaans.BankAccounts.delete(client, "account_id")
# result contains %{id: "account_id", deleted: true}

list(client, params \\ %{})

@spec list(client :: map(), params :: keyword()) :: list_response()

Lists all bank account resources.

Returns a list of bank account resources that match the optional filters provided in params.

Parameters

client - Client map created with Humaans.new/1
params - Optional parameters for filtering the results (default: %{})

Examples

client = Humaans.new(access_token: "your_access_token")

# List all bank accounts
{:ok, accounts} = Humaans.BankAccounts.list(client)

# List with filtering parameters
{:ok, accounts} = Humaans.BankAccounts.list(client, %{limit: 10})

retrieve(client, id)

@spec retrieve(client :: map(), id :: String.t()) :: response()

Retrieves a specific bank account by ID.

Parameters

client - Client map created with Humaans.new/1
id - String ID of the bank account to retrieve

Examples

client = Humaans.new(access_token: "your_access_token")

{:ok, account} = Humaans.BankAccounts.retrieve(client, "account_id")

update(client, id, params)

@spec update(client :: map(), id :: String.t(), params :: keyword()) :: response()

Updates a specific bank account by ID.

Parameters

client - Client map created with Humaans.new/1
id - String ID of the bank account to update
params - Map of parameters to update

Examples

client = Humaans.new(access_token: "your_access_token")

params = %{accountHolder: "Janet Doe"}

{:ok, updated_account} = Humaans.BankAccounts.update(client, "account_id", params)