bbox v0.1.2

View Source Bbox.Parties (bbox v0.1.2)

Parties module.

Link to this section Summary

Functions

get_by_initials!(initials)

Get party by initials.

insert(params \\ %{})

Create a new party.

list!()

List all parties.

Link to this section Functions

Link to this function

get_by_initials!(initials)

View Source 
@spec get_by_initials!(charlist()) :: %Bbox.Parties.Party{
  __meta__: term(),
  candidates: term(),
  description: term(),
  initials: term(),
  inserted_at: term(),
  name: term(),
  updated_at: term()
}

Get party by initials.

Link to this function

insert(params \\ %{})

View Source 
@spec insert(map()) ::
  {:ok,
   %Bbox.Parties.Party{
     __meta__: term(),
     candidates: term(),
     description: term(),
     initials: term(),
     inserted_at: term(),
     name: term(),
     updated_at: term()
   }}

Create a new party.

Link to this function

list!()

View Source 
@spec list!() :: [
  %Bbox.Parties.Party{
    __meta__: term(),
    candidates: term(),
    description: term(),
    initials: term(),
    inserted_at: term(),
    name: term(),
    updated_at: term()
  }
]

List all parties.