Cep v0.0.3 Cep.Client

Provides a function get_address/1 to query addreses of a given cep.

Link to this section Summary

Functions

Gets the address related to a given CEP.

Link to this section Functions

Link to this function

get_address(cep, options \\ [])

Gets the address related to a given CEP.

Parameters

  • cep: The CEP code

Return value

It returns a Cep.Address when the CEP was found.

Errors

It returns a tuple {:not_found, "CEP not found."} if the CEP couldn't be found in any of the sources (probably an invalid CEP).

It returns a tuple {:error, reason} in case there was an unhandled error coming from the source.