Correios CEP v0.3.0 Correios.CEP.Address View Source

Address structure.

Link to this section Summary

Types

t()

Functions

new(map)

Create a new Correios.CEP.Address struct with given values

Link to this section Types

t()

t() :: %Correios.CEP.Address{
  city: String.t(),
  complement: String.t(),
  neighborhood: String.t(),
  state: String.t(),
  street: String.t(),
  zipcode: String.t()
}

Link to this section Functions

new(map)

new(map()) :: t()

Create a new Correios.CEP.Address struct with given values.

Key values will be converted to string, and complement and complement2 keys will be joined in a single complement key.

Examples

iex> Correios.CEP.Address.new(%{
...>   street: 'Street',
...>   neighborhood: 'Neighborhood',
...>   complement: ' complement one',
...>   complement2: 'complement two ',
...>   city: 'City',
...>   state: 'ST',
...>   zipcode: '12345678'
...> })
%Correios.CEP.Address{
  city: "City",
  complement: "complement one complement two",
  neighborhood: "Neighborhood",
  state: "ST",
  street: "Street",
  zipcode: "12345678"
}