EDA.API.Command (EDA v0.3.0)

Copy Markdown View Source

REST API endpoints for Discord application commands.

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

Summary

Functions

bulk_overwrite_global(commands)

Bulk overwrites all global application commands.

bulk_overwrite_guild(guild_id, commands)

Bulk overwrites all guild application commands.

create_global(command)

Creates a global application command.

create_guild(guild_id, command)

Creates a guild application command (available instantly).

delete_global(command_id)

Deletes a global application command.

delete_guild(guild_id, command_id)

Deletes a guild application command.

edit_global(command_id, command)

Updates a global application command.

edit_guild(guild_id, command_id, command)

Updates a guild application command.

list_global()

Fetches all global application commands.

list_guild(guild_id)

Fetches all guild application commands.

Functions

bulk_overwrite_global(commands)

@spec bulk_overwrite_global([map() | EDA.Command.t()]) ::
  {:ok, [map()]} | {:error, term()}

Bulk overwrites all global application commands.

bulk_overwrite_guild(guild_id, commands)

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

Bulk overwrites all guild application commands.

create_global(command)

@spec create_global(map() | EDA.Command.t()) :: {:ok, map()} | {:error, term()}

Creates a global application command.

create_guild(guild_id, command)

@spec create_guild(String.t() | integer(), map() | EDA.Command.t()) ::
  {:ok, map()} | {:error, term()}

Creates a guild application command (available instantly).

delete_global(command_id)

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

Deletes a global application command.

delete_guild(guild_id, command_id)

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

Deletes a guild application command.

edit_global(command_id, command)

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

Updates a global application command.

edit_guild(guild_id, command_id, command)

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

Updates a guild application command.

list_global()

@spec list_global() :: {:ok, [map()]} | {:error, term()}

Fetches all global application commands.

list_guild(guild_id)

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

Fetches all guild application commands.