Plaid (elixir_plaid v0.1.0) View Source
Shared types used in the library.
Link to this section Summary
Types
Configuration that can be passed to each authenticated request.
Supported environments in the Plaid API.
Configuration that can be passed to any un-authenticated request.
Link to this section Types
Specs
config() :: [ client_id: String.t(), secret: String.t(), env: env() | nil, test_api_host: String.t() | nil ]
Configuration that can be passed to each authenticated request.
:client_id
- The client_id Plaid uses for authentication.:secret
- The secret Plaid uses for authentication.:env
- A supported Plaid environment.:test_api_host
- A way to override the URL for requests. Useful for E2E or integration testing.
client_id
andsecret
are required.
Specs
env() :: :production | :development | :sandbox
Supported environments in the Plaid API.
Specs
Configuration that can be passed to any un-authenticated request.
:env
- A supported Plaid environment.:test_api_host
- A way to override the URL for requests. Useful for E2E or integration testing.