Tink.Enrichment.Sustainability (Tink v1.0.0)

Copy Markdown View Source

CO₂ sustainability insights for transactions and users. Requires enrichment.sustainability scope.

Summary

Functions

Get overall sustainability insights.

Get market-average CO₂ emissions.

Get sustainability profiling questions.

Get CO₂ data for a specific transaction.

Get CO₂ comparables for a transaction.

Get CO₂ refinement suggestions for a transaction.

Get per-user sustainability insights.

Get user sustainability profiling data.

Bulk CO₂ refinement for transactions.

Functions

get_insights(client)

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

Get overall sustainability insights.

get_market_average(client)

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

Get market-average CO₂ emissions.

get_profiling_questions(client)

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

Get sustainability profiling questions.

get_transaction(client, transaction_id)

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

Get CO₂ data for a specific transaction.

get_transaction_comparables(client, transaction_id)

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

Get CO₂ comparables for a transaction.

get_transaction_refinement(client, transaction_id)

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

Get CO₂ refinement suggestions for a transaction.

get_user_insights(client)

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

Get per-user sustainability insights.

get_user_profiling(client)

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

Get user sustainability profiling data.

list_transaction_refinements(client, opts \\ [])

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

Bulk CO₂ refinement for transactions.