ExClubhouse v0.5.2 ExClubhouse.Api.Group View Source

Simple interface to the Group API

Link to this section Summary

Link to this section Functions

Create a group

Example

iex> ExClubhouse.Api.Group.update(ExClubhouse.Model.Input.Group{...})
{:ok, %ExClubhouse.Model.Group{...}}
Link to this function

get(group_public_id)

View Source
get(binary()) ::
  {:ok, nil | ExClubhouse.Model.Group.t()} | {:error, ExClubhouse.Error.t()}

Get a single group by id

Example

iex> ExClubhouse.Api.Group.get(1)
{:ok, %ExClubhouse.Model.Group{...}}
Link to this function

get(session, group_public_id)

View Source

Lists all groups

Example

iex> ExClubhouse.Api.Group.list()
{:ok, [%ExClubhouse.Model.Group{...}, ...]}
Link to this function

update(group_public_id, group_input)

View Source

Update a group

Example

iex> ExClubhouse.Api.File.upfate(ExClubhouse.Model.Input.Group{...})
{:ok, %ExClubhouse.Model.Group{...}}
Link to this function

update(session, group_public_id, group_input)

View Source