Marqeta.DiVA.DataDictionary (marqeta v1.0.0)

Copy Markdown View Source

Retrieve field definitions, types, and descriptions for any DiVA view.

Examples

# All view dictionaries
{:ok, all} = Marqeta.DiVA.DataDictionary.list()

# Specific view
{:ok, dict} = Marqeta.DiVA.DataDictionary.get("authorizations")
# Returns: [%{"name" => "transaction_token", "type" => "string", ...}, ...]

Summary

Functions

get(view_name, opts \\ [])

Returns the data dictionary for a specific DiVA view by name.

list(params \\ %{}, opts \\ [])

Lists data dictionary entries for all DiVA views.

Functions

get(view_name, opts \\ [])

@spec get(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, Marqeta.Error.t()}

Returns the data dictionary for a specific DiVA view by name.

list(params \\ %{}, opts \\ [])

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

Lists data dictionary entries for all DiVA views.