ClearBank.Client (ClearBank v1.0.0)

Copy Markdown View Source

Immutable client struct holding credentials and configuration.

Create with ClearBank.new/1 or ClearBank.Config.default_client/0.

Summary

Functions

Builds a new %Client{} from keyword options. See ClearBank.Config.schema/0 for all options.

Types

t()

@type t() :: %ClearBank.Client{
  api_token: String.t(),
  base_url: String.t(),
  pool_size: pos_integer(),
  private_key: binary() | nil,
  telemetry_prefix: [atom()],
  timeout: non_neg_integer()
}

Functions

new(opts)

@spec new(keyword()) :: t()

Builds a new %Client{} from keyword options. See ClearBank.Config.schema/0 for all options.