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

Get all immediate regions.

Parameters

• query - Optional parameters supported by the API (e.g., order_by: :name).

Examples

iex> ExIbge.Locality.ImmediateRegion.all()
{:ok, [%ExIbge.Geography.ImmediateRegion{id: 330001, name: "Rio de Janeiro", ...}, ...]}

See Also

IBGE API: Regiões Imediatas

@spec all!(Keyword.t()) :: [ExIbge.Geography.ImmediateRegion.t()]

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

Examples

iex> ExIbge.Locality.ImmediateRegion.all!()
[%ExIbge.Geography.ImmediateRegion{id: 330001, name: "Rio de Janeiro", ...}, ...]

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

Get immediate 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.ImmediateRegion.find(330001)
{:ok, [%ExIbge.Geography.ImmediateRegion{id: 330001, name: "Rio de Janeiro", ...}]}

See Also

IBGE API: Região Imediata por ID

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

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

Examples

iex> ExIbge.Locality.ImmediateRegion.find!(330001)
[%ExIbge.Geography.ImmediateRegion{id: 330001, name: "Rio de Janeiro", ...}]

@spec get_by_intermediate_region(
  integer() | String.t() | [integer() | String.t()],
  Keyword.t()
) :: {:ok, [ExIbge.Geography.ImmediateRegion.t()]} | {:error, any()}

Get immediate regions by intermediate region identifier(s).

Parameters

• intermediate_region_ids - A single integer ID or a list of integer IDs.
• query - Optional parameters supported by the API.

Examples

iex> ExIbge.Locality.ImmediateRegion.get_by_intermediate_region(3301)
{:ok, [%ExIbge.Geography.ImmediateRegion{...}, ...]}

See Also

IBGE API: Regiões Imediatas por Região Intermediária

@spec get_by_intermediate_region!(
  integer() | String.t() | [integer() | String.t()],
  Keyword.t()
) :: [ExIbge.Geography.ImmediateRegion.t()]

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

Examples

iex> ExIbge.Locality.ImmediateRegion.get_by_intermediate_region!(3301)
[%ExIbge.Geography.ImmediateRegion{...}, ...]

@spec get_by_region(integer() | String.t() | [integer() | String.t()], Keyword.t()) ::
  {:ok, [ExIbge.Geography.ImmediateRegion.t()]} | {:error, any()}

Get immediate regions by region identifier(s).

Parameters

• region_ids - A single integer ID or a list of integer IDs.
• query - Optional parameters supported by the API.

Examples

iex> ExIbge.Locality.ImmediateRegion.get_by_region(3)
{:ok, [%ExIbge.Geography.ImmediateRegion{...}, ...]}

See Also

IBGE API: Regiões Imediatas por Região

@spec get_by_region!(integer() | String.t() | [integer() | String.t()], Keyword.t()) ::
  [
    ExIbge.Geography.ImmediateRegion.t()
  ]

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

Examples

iex> ExIbge.Locality.ImmediateRegion.get_by_region!(3)
[%ExIbge.Geography.ImmediateRegion{...}, ...]

@spec get_by_state(
  integer() | atom() | String.t() | [integer() | atom() | String.t()],
  Keyword.t()
) :: {:ok, [ExIbge.Geography.ImmediateRegion.t()]} | {:error, any()}

Get immediate regions by state identifier(s).

Parameters

• uf_ids - A single identifier or list of identifiers (Integer ID or Atom UFs).
• query - Optional parameters supported by the API.

Examples

iex> ExIbge.Locality.ImmediateRegion.get_by_state(33)
{:ok, [%ExIbge.Geography.ImmediateRegion{...}, ...]}

iex> ExIbge.Locality.ImmediateRegion.get_by_state(:rj)
{:ok, [%ExIbge.Geography.ImmediateRegion{...}, ...]}

See Also

IBGE API: Regiões Imediatas por UF

@spec get_by_state!(
  integer() | atom() | String.t() | [integer() | atom() | String.t()],
  Keyword.t()
) :: [ExIbge.Geography.ImmediateRegion.t()]

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

Examples

iex> ExIbge.Locality.ImmediateRegion.get_by_state!(33)
[%ExIbge.Geography.ImmediateRegion{...}, ...]