# `Codat.Client`
[🔗](https://github.com/iamkanishka/codat.git/blob/v1.0.0/lib/codat/client.ex#L1)

The Codat API client.

A `%Codat.Client{}` holds configuration for authenticating and communicating
with the Codat API. Pass a client to any API function to use custom settings,
or omit it to use the global application config.

## Creating a Client

    # From application config (reads :codat app config + CODAT_API_KEY env var)
    client = Codat.Client.new()

    # Explicit API key
    client = Codat.Client.new(api_key: "your-api-key")

    # Full custom configuration
    client = Codat.Client.new(
      api_key: "your-api-key",
      base_url: "https://api.codat.io",
      http_timeout: 60_000,
      max_retries: 5
    )

## Using a Client

    # All API functions accept an optional client as the first argument
    {:ok, companies} = Codat.Platform.Companies.list(client)

    # Without a client, uses global application config
    {:ok, companies} = Codat.Platform.Companies.list()

## Multi-Tenant Usage

Create one client per tenant to isolate API keys and configurations:

    clients = Map.new(tenants, fn {id, key} ->
      {id, Codat.Client.new(api_key: key)}
    end)

    {:ok, companies} = Codat.Platform.Companies.list(clients[tenant_id])

# `t`

```elixir
@type t() :: %Codat.Client{config: Codat.Config.t()}
```

# `api_key!`

```elixir
@spec api_key!(t()) :: String.t()
```

Returns the resolved API key for this client.
Raises if no API key is configured.

# `config`

```elixir
@spec config(t()) :: Codat.Config.t()
```

Returns the underlying `%Codat.Config{}` for this client.

# `new`

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

Creates a new `%Codat.Client{}` with the given options merged over application config.

Options are validated via `NimbleOptions`. See `Codat.Config.options_schema/0` for
the full list of supported keys.

## Examples

    iex> Codat.Client.new(api_key: "abc123")
    %Codat.Client{config: %Codat.Config{api_key: "abc123", ...}}

---

*Consult [api-reference.md](api-reference.md) for complete listing*