Breezex.Families (breezex v0.1.0) View Source

Module implementing the Breeze families API.

Link to this section Summary

Updates family to which member_id belongs, adding everyone in new_people list.

Creates a new family grouping from pre-existing people.

Destroy the family grouping belonging to the person whose ID is passed in.

Remove people from whatever family they're in

add_to_family(map(), integer(), list()) :: Breezex.Client.client_response()

Updates family to which member_id belongs, adding everyone in new_people list.

add_to_family!(map(), integer(), list()) :: {map(), list()} | no_return()

create(map(), list()) :: Breezex.Client.client_response()

Creates a new family grouping from pre-existing people.

If anyone is already in a family, they'll be removed from the old one.

create!(map(), list()) :: {map(), list()} | no_return()

destroy(map(), list() | integer()) :: Breezex.Client.client_response()

Destroy the family grouping belonging to the person whose ID is passed in.

If a list is passed in, destroy any family containing any person whose ID is in the list.

destroy!(map(), integer() | list()) :: {map(), list()} | no_return()

remove_from_family(map(), integer() | list()) ::
  Breezex.Client.client_response()

Remove people from whatever family they're in

remove_from_family!(map(), integer() | list()) :: {map(), list()} | no_return()