Tink.Insights (Tink v1.0.0)

Copy Markdown View Source

AI-driven personalised financial insights. Requires insights:read and insights:write scopes.

Summary

Functions

Archive an insight. Requires insights:write.

List active insights. Requires insights:read.

List archived insights. Requires insights:read.

Take an action on an insight. Requires insights:write.

Functions

archive(client, insight_id)

@spec archive(Tink.Client.t(), String.t()) :: {:ok, map()} | {:error, Tink.Error.t()}

Archive an insight. Requires insights:write.

list(client)

@spec list(Tink.Client.t()) :: {:ok, map()} | {:error, Tink.Error.t()}

List active insights. Requires insights:read.

list_archived(client)

@spec list_archived(Tink.Client.t()) :: {:ok, map()} | {:error, Tink.Error.t()}

List archived insights. Requires insights:read.

take_action(client, params)

@spec take_action(Tink.Client.t(), map()) :: {:ok, map()} | {:error, Tink.Error.t()}

Take an action on an insight. Requires insights:write.

Example

Tink.Insights.take_action(client, %{
  "insightId" => "ins-001",
  "type"      => "ACKNOWLEDGE"
})