Brasilapi.Client (BrasilAPI v1.0.2)

HTTP client for BrasilAPI endpoints.

Provides a consistent interface for making HTTP requests to BrasilAPI with proper error handling, retries, and response parsing.

Summary

Types

error_response()

mapper(result, mapped)

response()

success_response()

Functions

delete(path, opts \\ [])

Makes a DELETE request to the specified path.

get(path, opts \\ [])

Makes a GET request to the specified path.

post(path, body, opts \\ [])

Makes a POST request to the specified path.

put(path, body, opts \\ [])

Makes a PUT request to the specified path.

Types

error_response()

@type error_response() :: {:error, map()}

mapper(result, mapped)

@type mapper(result, mapped) :: (result -> mapped)

response()

@type response() :: success_response() | error_response()

success_response()

@type success_response() :: {:ok, term()}

Functions

delete(path, opts \\ [])

@spec delete(
  String.t(),
  keyword()
) :: response()

Makes a DELETE request to the specified path.

Parameters

path - The API path (without base URL)
opts - Additional options (optional)

get(path, opts \\ [])

@spec get(
  String.t(),
  keyword()
) :: response()

Makes a GET request to the specified path.

Parameters

path - The API path (without base URL)
opts - Additional options (optional)

Examples

iex> Brasilapi.Client.get("/banks/v1")
{:ok, [%{"ispb" => "00000000", "name" => "BCO DO BRASIL S.A.", ...}]}

iex> Brasilapi.Client.get("/banks/v1/999999")
{:error, %{status: 404, message: "Not found"}}

post(path, body, opts \\ [])

@spec post(String.t(), term(), keyword()) :: response()

Makes a POST request to the specified path.

Parameters

path - The API path (without base URL)
body - The request body
opts - Additional options (optional)

put(path, body, opts \\ [])

@spec put(String.t(), term(), keyword()) :: response()

Makes a PUT request to the specified path.

Parameters

path - The API path (without base URL)
body - The request body
opts - Additional options (optional)