TreasuryPrime.StatementConfig (TreasuryPrime v1.0.0)

Configures the boilerplate content (legal name, support contact info, APY/footnote disclosures required by Regulation DD, branding) used when generating account statements via TreasuryPrime.Account.generate_statement/3. Once configured, you no longer need to pass that boilerplate on every statement generation call.

Summary

Types

t()

Functions

create(client, params, opts \\ [])

Creates a statement config. Required (per Regulation DD): org_legal_name, apy, footnote.

create!(client, params, opts \\ [])

get(client, id)

Fetches a single statement config by id.

get!(client, id)

list(client, params \\ %{})

Lists statement configs.

list!(client, params \\ %{})

update(client, id, params)

Updates a statement config.

update!(client, id, params)

Types

t()

@type t() :: %TreasuryPrime.StatementConfig{
  apy: String.t() | nil,
  created_at: String.t() | nil,
  email_address: String.t() | nil,
  footnote: String.t() | nil,
  id: String.t() | nil,
  org_legal_name: String.t() | nil,
  phone_number: String.t() | nil,
  support_url: String.t() | nil,
  updated_at: String.t() | nil,
  userdata: map() | nil
}

Functions

create(client, params, opts \\ [])

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

Creates a statement config. Required (per Regulation DD): org_legal_name, apy, footnote.

create!(client, params, opts \\ [])

@spec create!(TreasuryPrime.Client.t(), map(), keyword()) :: t()

get(client, id)

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

Fetches a single statement config by id.

get!(client, id)

@spec get!(TreasuryPrime.Client.t(), String.t()) :: t()

list(client, params \\ %{})

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

Lists statement configs.

list!(client, params \\ %{})

@spec list!(TreasuryPrime.Client.t(), map()) :: TreasuryPrime.Page.t()

update(client, id, params)

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

Updates a statement config.

update!(client, id, params)

@spec update!(TreasuryPrime.Client.t(), String.t(), map()) :: t()