StrawHat.Map v1.0.0 StrawHat.Map.Address View Source

Represents a Address Ecto Schema with functionality about the data validation for Address.

Link to this section Summary

Types

address_attrs()

Check t/0 type for more information about the keys

t()

line_one: Line one of the address.
line_two: Line two of the address.
postal_code: Postal Code or Zipcode of the address.
city: StrawHat.Map.City.t/0 associated with the address.
city_id: id of StrawHat.Map.City.t/0 associated with the address.
locations: List of StrawHat.Map.Location.t/0 associated with the address

Functions

changeset(address, address_attrs)

Validates the attributes and return a Ecto.Changeset for the current Address

Link to this section Types

address_attrs()

address_attrs() :: %{
  line_one: String.t(),
  line_two: String.t(),
  postal_code: String.t(),
  city_id: Integer.t()
}

Check t/0 type for more information about the keys.

t()

t() :: %StrawHat.Map.Address{
  __meta__: term(),
  city: StrawHat.Map.City.t() | Ecto.Association.NotLoaded.t(),
  city_id: Integer.t(),
  id: term(),
  line_one: String.t(),
  line_two: String.t(),
  locations: [StrawHat.Map.Location.t()] | Ecto.Association.NotLoaded.t(),
  postal_code: String.t()
}

line_one: Line one of the address.
line_two: Line two of the address.
postal_code: Postal Code or Zipcode of the address.
city: StrawHat.Map.City.t/0 associated with the address.
city_id: id of StrawHat.Map.City.t/0 associated with the address.
locations: List of StrawHat.Map.Location.t/0 associated with the address.

Link to this section Functions

changeset(address, address_attrs)

changeset(t(), address_attrs()) :: Ecto.Changeset.t()

Validates the attributes and return a Ecto.Changeset for the current Address.