yodlee v0.1.1 Yodlee.Cobrand

Functions for cobrand endpoint.

Link to this section Summary

Functions

Adds a webhook callback URL to the Cobrand

Deletes a Cobrand’s webhooks associated with event name

Lists a Cobrand’s webhooks

Get’s Cobrand session. Uses credentials provided in configuration by default. Automatically sets the session token to the configuration variable cob_session if the login is successful

Link to this section Types

Link to this type cob_session()
cob_session() :: String.t()
Link to this type t()
t() :: %Yodlee.Cobrand{
  application_id: String.t(),
  cobrand_id: integer(),
  locale: String.t(),
  session: String.t()
}

Link to this section Functions

Link to this function add_webhook(session, event_name, callback_url)
add_webhook(cob_session(), String.t(), String.t()) ::
  {:ok, map()} | {:error, error() | atom()}

Adds a webhook callback URL to the Cobrand.

Link to this function delete_webhook(session, event_name)
delete_webhook(cob_session(), String.t()) :: {:ok, map()} | {:error, error()}

Deletes a Cobrand’s webhooks associated with event name.

Link to this function list_webhooks(session)
list_webhooks(cob_session()) :: {:ok, [Yodlee.Webhook.t()]} | {:error, error()}

Lists a Cobrand’s webhooks.

Link to this function login(cred \\ get_cobrand_cred())
login(map() | nil) :: {:ok, Yodlee.Cobrand.t()} | {:error, error()}

Get’s Cobrand session. Uses credentials provided in configuration by default. Automatically sets the session token to the configuration variable cob_session if the login is successful.

cred = %{
  cobrandLogin: "your_cobrand_login",
  cobrandPassword: "your_cobrand_password"
}