Stickers: read standard and guild stickers, and create, modify or delete guild stickers.

Functions

create-guild-sticker

fn (request: CreateGuildStickerRequest): Map
fn (request: CreateGuildStickerRequest, opts: Map): Map

POST /guilds/{guild_id}/stickers - Upload a sticker (PNG, APNG, GIF or Lottie JSON, max 512 KiB) as multipart/form-data. name 2-30 characters, tags an autocomplete word (a Unicode emoji name). Needs CREATE_GUILD_EXPRESSIONS.

Example

::stickers ::discord::stickers

::stickers/create-guild-sticker(::stickers/CreateGuildStickerRequest({
  guild_id: "1000000000000000000",
  name: "shipit",
  tags: "rocket",
  file: {filename: "shipit.png", content: ::hot::file/read-file-bytes("shipit.png")}
}))

delete-guild-sticker

fn (request: DeleteGuildStickerRequest): Bool
fn (request: DeleteGuildStickerRequest, opts: Map): Bool

DELETE /guilds/{guild_id}/stickers/{sticker_id} - Delete a sticker. Needs MANAGE_GUILD_EXPRESSIONS.

Example

::stickers ::discord::stickers

::stickers/delete-guild-sticker(::stickers/DeleteGuildStickerRequest({
  guild_id: "1000000000000000000",
  sticker_id: "2200000000000000000",
  reason: "Retired"
}))

get-guild-sticker

fn (request: GetGuildStickerRequest): Map
fn (request: GetGuildStickerRequest, opts: Map): Map

GET /guilds/{guild_id}/stickers/{sticker_id} - One guild sticker.

Example

::stickers ::discord::stickers

sticker ::stickers/get-guild-sticker(::stickers/GetGuildStickerRequest({
  guild_id: "1000000000000000000",
  sticker_id: "2200000000000000000"
}))
sticker.tags

get-sticker

fn (request: GetStickerRequest): Map
fn (request: GetStickerRequest, opts: Map): Map

GET /stickers/{sticker_id} - Any sticker by id.

Example

::stickers ::discord::stickers

sticker ::stickers/get-sticker(::stickers/GetStickerRequest({sticker_id: "2200000000000000000"}))
sticker.name

list-guild-stickers

fn (request: ListGuildStickersRequest): Vec<Map>
fn (request: ListGuildStickersRequest, opts: Map): Vec<Map>

GET /guilds/{guild_id}/stickers - The guild's custom stickers.

Example

::stickers ::discord::stickers

stickers ::stickers/list-guild-stickers(::stickers/ListGuildStickersRequest({guild_id: "1000000000000000000"}), {token: ::hot::ctx/get("tenant-b.discord.bot.token")})
map(stickers, %.name)

list-sticker-packs

fn (): Map
fn (opts: Map): Map

GET /sticker-packs - Discord's standard sticker packs. Returns {sticker_packs}.

Example

packs ::discord::stickers/list-sticker-packs()
map(packs.sticker_packs, %.name)

modify-guild-sticker

fn (request: ModifyGuildStickerRequest): Map
fn (request: ModifyGuildStickerRequest, opts: Map): Map

PATCH /guilds/{guild_id}/stickers/{sticker_id} - Change a sticker's name, description or tags. Only fields you set are sent. Needs MANAGE_GUILD_EXPRESSIONS.

Example

::stickers ::discord::stickers

::stickers/modify-guild-sticker(::stickers/ModifyGuildStickerRequest({
  guild_id: "1000000000000000000",
  sticker_id: "2200000000000000000",
  name: "ship_it",
  tags: "rocket"
}))

Types

CreateGuildStickerRequest

CreateGuildStickerRequest type {
    guild_id: Str,
    name: Str,
    tags: Str,
    file: ::discord::api/FileUpload,
    description: Str?,
    reason: Str?
}

DeleteGuildStickerRequest

DeleteGuildStickerRequest type {
    guild_id: Str,
    sticker_id: Str,
    reason: Str?
}

GetGuildStickerRequest

GetGuildStickerRequest type {
    guild_id: Str,
    sticker_id: Str
}

GetStickerRequest

GetStickerRequest type {
    sticker_id: Str
}

ListGuildStickersRequest

ListGuildStickersRequest type {
    guild_id: Str
}

ModifyGuildStickerRequest

ModifyGuildStickerRequest type {
    guild_id: Str,
    sticker_id: Str,
    name: Str?,
    description: Str?,
    tags: Str?,
    reason: Str?,
    clear: Vec<Str>?
}