EDA.API.Sticker (EDA v0.3.0)

Copy Markdown View Source

REST API endpoints for Discord stickers.

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

Summary

Functions

Creates a guild sticker via multipart upload.

Deletes a guild sticker.

Gets a sticker by ID (any sticker, not guild-specific). Returns an EDA.Sticker struct.

Gets a guild sticker by ID. Returns an EDA.Sticker struct.

Gets a sticker pack by ID. Returns an EDA.Sticker.Pack struct.

Lists all stickers for a guild. Returns EDA.Sticker structs.

Lists all available sticker packs (Nitro stickers). Returns EDA.Sticker.Pack structs.

Modifies a guild sticker.

Functions

create(guild_id, params)

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

Creates a guild sticker via multipart upload.

Parameters

  • guild_id - The guild ID
  • params - Map with:
    • :name - Sticker name (required, 2-30 chars)
    • :description - Sticker description (required, 2-100 chars)
    • :tags - Autocomplete/suggestion tags (required, max 200 chars)
    • :file - An EDA.File struct with the sticker image data

delete_guild(guild_id, sticker_id)

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

Deletes a guild sticker.

get(sticker_id)

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

Gets a sticker by ID (any sticker, not guild-specific). Returns an EDA.Sticker struct.

get_guild(guild_id, sticker_id)

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

Gets a guild sticker by ID. Returns an EDA.Sticker struct.

get_pack(pack_id)

@spec get_pack(String.t() | integer()) ::
  {:ok, EDA.Sticker.Pack.t()} | {:error, term()}

Gets a sticker pack by ID. Returns an EDA.Sticker.Pack struct.

list(guild_id)

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

Lists all stickers for a guild. Returns EDA.Sticker structs.

list_packs()

@spec list_packs() :: {:ok, [EDA.Sticker.Pack.t()]} | {:error, term()}

Lists all available sticker packs (Nitro stickers). Returns EDA.Sticker.Pack structs.

modify(guild_id, sticker_id, params)

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

Modifies a guild sticker.