yodlee v0.1.2 Yodlee.User View Source

Functions for user endpoint.

Link to this section Summary

Functions

Returns FastLink token from user session token

Logs in a user within a Cobrand session

Registers a user within a Cobrand session

Unregisters (deletes) a Yodlee user

Link to this section Types

Link to this type cob_session() View Source
cob_session() :: String.t()
Link to this type t() View Source
t() :: %Yodlee.User{id: integer(), login_name: String.t(), session: String.t()}
Link to this type user_session() View Source
user_session() :: String.t()

Link to this section Functions

Link to this function login(cob_session, params) View Source
login(cob_session(), map()) :: {:ok, Yodlee.User.t()} | {:error, error()}

Logs in a user within a Cobrand session:

params = %{ loginName: "user_login_name", password: "user_password#123" }

Link to this function register(cob_session, params) View Source
register(cob_session(), map()) :: {:ok, Yodlee.User.t()} | {:error, error()}

Registers a user within a Cobrand session.

params = %{
  loginName: "user1@pickpocket.me",
  password: "lcDEig$JI$zC3G1!",
  email: "user1@pickpocket.me"
}
Link to this function unregister(session) View Source
unregister(user_session()) :: {:ok, Yodlee.User.t()} | {:error, error()}

Unregisters (deletes) a Yodlee user.