StrawHat.Map v1.2.1 StrawHat.Map.Addresses View Source
Defines functionality for addresses management.
Link to this section Summary
Functions
Creates an address
Destroys an address
Gets an address by id
Gets an address by id
Returns a list of addresses
Gets list of addresses
Updates an address
Link to this section Functions
Link to this function
create_address(address_attrs)
View Source
create_address(StrawHat.Map.Address.address_attrs()) :: {:ok, StrawHat.Map.Address.t()} | {:error, Ecto.Changeset.t()}
Creates an address.
Link to this function
destroy_address(address)
View Source
destroy_address(StrawHat.Map.Address.t()) :: {:ok, StrawHat.Map.Address.t()} | {:error, Ecto.Changeset.t()}
Destroys an address.
Link to this function
find_address(address_id)
View Source
find_address(String.t()) :: {:ok, StrawHat.Map.Address.t()} | {:error, StrawHat.Error.t()}
Gets an address by id
.
Link to this function
get_address(address_id)
View Source
get_address(String.t()) :: StrawHat.Map.Address.t() | nil | no_return()
Gets an address by id
.
Link to this function
get_addresses(pagination \\ [])
View Source
get_addresses(Scrivener.Config.t()) :: Scrivener.Page.t()
Returns a list of addresses.
Link to this function
get_addresses_by_ids(address_ids)
View Source
get_addresses_by_ids([integer()]) :: [StrawHat.Map.Address.t()] | no_return()
Gets list of addresses.
Link to this function
update_address(address, address_attrs)
View Source
update_address(StrawHat.Map.Address.t(), StrawHat.Map.Address.address_attrs()) :: {:ok, StrawHat.Map.Address.t()} | {:error, Ecto.Changeset.t()}
Updates an address.