EDA.API.Role (EDA v0.3.0)

Copy Markdown View Source

REST API endpoints for Discord guild roles.

All functions return {:ok, result} or {:error, reason}.

Summary

Functions

create(guild_id, params \\ [], opts \\ [])

Creates a role in a guild.

delete(guild_id, role_id, opts \\ [])

Deletes a guild role.

list(guild_id)

Gets roles for a guild.

modify(guild_id, role_id, payload, opts \\ [])

Modifies a guild role.

modify_positions(guild_id, positions)

Modifies guild role positions.

Functions

create(guild_id, params \\ [], opts \\ [])

@spec create(String.t() | integer(), keyword() | map(), keyword()) ::
  {:ok, map()} | {:error, term()}

Creates a role in a guild.

delete(guild_id, role_id, opts \\ [])

@spec delete(String.t() | integer(), String.t() | integer(), keyword()) ::
  :ok | {:error, term()}

Deletes a guild role.

list(guild_id)

@spec list(String.t() | integer()) :: {:ok, [map()]} | {:error, term()}

Gets roles for a guild.

modify(guild_id, role_id, payload, opts \\ [])

@spec modify(String.t() | integer(), String.t() | integer(), map(), keyword()) ::
  {:ok, map()} | {:error, term()}

Modifies a guild role.

modify_positions(guild_id, positions)

@spec modify_positions(String.t() | integer(), [map()]) ::
  {:ok, [map()]} | {:error, term()}

Modifies guild role positions.