# `ExIbge.Locality.IntegratedDevelopmentRegion`
[🔗](https://github.com/pedrohfonseca81/ex_ibge/blob/main/lib/ex_ibge/locality/integrated_development_region.ex#L1)

Module for handling Integrated Development Region (Região Integrada de Desenvolvimento - RIDE) queries from IBGE.

This module provides functions to fetch Integrated Development Regions.

# `all`

```elixir
@spec all(Keyword.t()) ::
  {:ok, [ExIbge.Geography.IntegratedDevelopmentRegion.t()]} | {:error, any()}
```

Get all integrated development regions.

## Parameters

  * `query` - Optional parameters supported by the API (e.g., `order_by: :name`, `municipality: 2611101`).

## Examples

    iex> ExIbge.Locality.IntegratedDevelopmentRegion.all()
    {:ok, [%ExIbge.Geography.IntegratedDevelopmentRegion{id: "07801", name: "Região Integrada de Desenvolvimento do Distrito Federal e Entorno", ...}, ...]}

## See Also

[IBGE API: Regiões Integradas de Desenvolvimento](https://servicodados.ibge.gov.br/api/docs/localidades#api-Regioes_integradas_de_desenvolvimento-regioes-integradas-de-desenvolvimentoGet)

# `all!`

```elixir
@spec all!(Keyword.t()) :: [ExIbge.Geography.IntegratedDevelopmentRegion.t()]
```

Same as `all/1`, but raises an error on failure.

## Examples

    iex> ExIbge.Locality.IntegratedDevelopmentRegion.all!()
    [%ExIbge.Geography.IntegratedDevelopmentRegion{id: "07801", ...}, ...]

# `find`

```elixir
@spec find(integer() | String.t() | [integer() | String.t()], Keyword.t()) ::
  {:ok, [ExIbge.Geography.IntegratedDevelopmentRegion.t()]} | {:error, any()}
```

Get integrated development region(s) by identifier(s).

## Parameters

  * `ids` - A single integer ID or a list of integer IDs.
  * `query` - Optional parameters supported by the API.

## Examples

    iex> ExIbge.Locality.IntegratedDevelopmentRegion.find("07801")
    {:ok, [%ExIbge.Geography.IntegratedDevelopmentRegion{id: "07801", ...}]}

## See Also

[IBGE API: Região Integrada de Desenvolvimento por ID](https://servicodados.ibge.gov.br/api/docs/localidades#api-Regioes_integradas_de_desenvolvimento-regioes-integradas-de-desenvolvimentoRegiaoIntegradaDeDesenvolvimentoGet)

# `find!`

```elixir
@spec find!(integer() | String.t() | [integer() | String.t()], Keyword.t()) :: [
  ExIbge.Geography.IntegratedDevelopmentRegion.t()
]
```

Same as `find/2`, but raises an error on failure.

## Examples

    iex> ExIbge.Locality.IntegratedDevelopmentRegion.find!("07801")
    [%ExIbge.Geography.IntegratedDevelopmentRegion{id: "07801", ...}]

---

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