Moov.Branding (Moov v1.0.0)

Copy Markdown View Source

Light/dark-mode brand colors used across Moov-hosted UIs - onboarding forms, payment links, hosted receipts, etc.

See https://docs.moov.io/api/enrichment/branding/.

Summary

Functions

create(client, account_id, params)

Creates a brand for an account.

create_or_replace(client, account_id, params)

Creates or fully replaces an account's brand.

get(client, account_id)

Retrieves an account's brand.

update(client, account_id, params)

Partially updates an account's brand.

Functions

create(client, account_id, params)

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

Creates a brand for an account.

params: %{light: %{...colors}, dark: %{...colors}, logo_image_id: ...}.

create_or_replace(client, account_id, params)

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

Creates or fully replaces an account's brand.

get(client, account_id)

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

Retrieves an account's brand.

update(client, account_id, params)

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

Partially updates an account's brand.