glyph/models/discord · glyph

AllowedMentions

This contains information regarding the mentions contained within a message’s content.

pub type AllowedMentions {
  AllowedMentions(
    parse: List(MentionType),
    roles: List(Snowflake),
    users: List(Snowflake),
    replied_user: Bool,
  )
}

Constructors

AllowedMentions(
  parse: List(MentionType),
  roles: List(Snowflake),
  users: List(Snowflake),
  replied_user: Bool,
)

Application

</>

Model for a Discord Application.

TODO: summary is deprecated and will be removed in v11

pub type Application {
  Application(
    id: Snowflake,
    name: String,
    icon: Option(String),
    description: String,
    rpc_origins: Option(List(String)),
    bot_public: Bool,
    bot_require_code_grant: Bool,
    bot: Option(Bot),
    terms_of_service_url: Option(String),
    privacy_policy_url: Option(String),
    owner: Option(Owner),
    summary: Option(String),
    verify_key: String,
    team: Option(Team),
    guild_id: Option(Snowflake),
    primary_sku_id: Option(Snowflake),
    slug: Option(String),
    cover_image: Option(String),
    flags: Option(Int),
    approximate_guild_count: Option(Int),
    redirect_uris: Option(List(String)),
    interactions_endpoint_url: Option(String),
    role_connections_verification_url: Option(String),
    tags: Option(List(String)),
    install_params: Option(InstallParams),
    custom_install_url: Option(String),
  )
}

Constructors

Application(
  id: Snowflake,
  name: String,
  icon: Option(String),
  description: String,
  rpc_origins: Option(List(String)),
  bot_public: Bool,
  bot_require_code_grant: Bool,
  bot: Option(Bot),
  terms_of_service_url: Option(String),
  privacy_policy_url: Option(String),
  owner: Option(Owner),
  summary: Option(String),
  verify_key: String,
  team: Option(Team),
  guild_id: Option(Snowflake),
  primary_sku_id: Option(Snowflake),
  slug: Option(String),
  cover_image: Option(String),
  flags: Option(Int),
  approximate_guild_count: Option(Int),
  redirect_uris: Option(List(String)),
  interactions_endpoint_url: Option(String),
  role_connections_verification_url: Option(String),
  tags: Option(List(String)),
  install_params: Option(InstallParams),
  custom_install_url: Option(String),
)

Bot

</>

pub type Bot =
  User

BotClient

</>

Type that contains necessary information when communicating with the Discord API

pub type BotClient {
  BotClient(
    token_type: rest.TokenType,
    token: String,
    client_url: String,
    client_version: String,
    intents: Int,
    handlers: EventHandler,
    rest_client: rest.RESTClient,
  )
}

Constructors

BotClient(
  token_type: rest.TokenType,
  token: String,
  client_url: String,
  client_version: String,
  intents: Int,
  handlers: EventHandler,
  rest_client: rest.RESTClient,
)

DiscordError

</>

Generic Discord Error

pub type DiscordError

Embed

</>

Model for an embed that can be attached to a message.

pub type Embed {
  Embed(
    title: Option(String),
    description: Option(String),
    url: Option(String),
    timestamp: Option(String),
    color: Option(Int),
    footer: Option(EmbedFooter),
    image: Option(EmbedImage),
    thumbnail: Option(EmbedThumbnail),
    video: Option(EmbedVideo),
    provider: Option(EmbedProvider),
    author: Option(EmbedAuthor),
    fields: Option(List(EmbedField)),
  )
}

Constructors

Embed(
  title: Option(String),
  description: Option(String),
  url: Option(String),
  timestamp: Option(String),
  color: Option(Int),
  footer: Option(EmbedFooter),
  image: Option(EmbedImage),
  thumbnail: Option(EmbedThumbnail),
  video: Option(EmbedVideo),
  provider: Option(EmbedProvider),
  author: Option(EmbedAuthor),
  fields: Option(List(EmbedField)),
)

EmbedAuthor

</>

Metadata about the author of the embedded data.

pub type EmbedAuthor {
  EmbedAuthor(
    name: String,
    url: Option(String),
    icon_url: Option(String),
    proxy_icon_url: Option(String),
  )
}

Constructors

EmbedAuthor(
  name: String,
  url: Option(String),
  icon_url: Option(String),
  proxy_icon_url: Option(String),
)

EmbedField

</>

Generic fields that can be added to an embed.

pub type EmbedField {
  EmbedField(name: String, value: String, inline: Option(Bool))
}

Constructors

EmbedField(name: String, value: String, inline: Option(Bool))

EmbedFooter

</>

Supported information for an embed’s footer.

pub type EmbedFooter {
  EmbedFooter(
    text: String,
    icon_url: Option(String),
    proxy_icon_url: Option(String),
  )
}

Constructors

EmbedFooter(
  text: String,
  icon_url: Option(String),
  proxy_icon_url: Option(String),
)

EmbedImage

</>

The information necessary to send an image with an embed.

pub type EmbedImage {
  EmbedImage(
    url: String,
    proxy_url: Option(String),
    height: Option(Int),
    width: Option(Int),
  )
}

Constructors

EmbedImage(
  url: String,
  proxy_url: Option(String),
  height: Option(Int),
  width: Option(Int),
)

EmbedProvider

</>

Metadata about the source of the embedded data.

pub type EmbedProvider {
  EmbedProvider(name: Option(String), url: Option(String))
}

Constructors

EmbedProvider(name: Option(String), url: Option(String))

EmbedThumbnail

</>

The information necessary to send a thumbnail with an embed.

pub type EmbedThumbnail {
  EmbedThumbnail(
    url: String,
    proxy_url: Option(String),
    height: Option(Int),
    width: Option(Int),
  )
}

Constructors

EmbedThumbnail(
  url: String,
  proxy_url: Option(String),
  height: Option(Int),
  width: Option(Int),
)

EmbedVideo

</>

The information necessary to send a video with an embed.

pub type EmbedVideo {
  EmbedVideo(
    url: Option(String),
    proxy_url: Option(String),
    height: Option(Int),
    width: Option(Int),
  )
}

Constructors

EmbedVideo(
  url: Option(String),
  proxy_url: Option(String),
  height: Option(Int),
  width: Option(Int),
)

EventHandler

</>

These represent Glyph’s supported gateway events and the necessary function signature for callbacks that get passed in to the BotClient.

pub type EventHandler {
  EventHandler(
    on_message_create: fn(BotClient, Message) ->
      Result(Nil, DiscordError),
  )
}

Constructors

EventHandler(
  on_message_create: fn(BotClient, Message) ->
    Result(Nil, DiscordError),
)

GatewayEvent

</>

Top-level structure of payloads between gateway and client.

pub type GatewayEvent {
  GatewayEvent(
    op: Int,
    d: dynamic.Dynamic,
    s: Option(Int),
    t: Option(String),
  )
}

Constructors

GatewayEvent(
  op: Int,
  d: dynamic.Dynamic,
  s: Option(Int),
  t: Option(String),
)

GatewayIntent

</>

The following are gateway intents which represent what events you subscribe to.

pub type GatewayIntent {
  Guilds
  GuildMembers
  GuildModeration
  GuildEmojisAndStickers
  GuildIntegrations
  GuildWebhooks
  GuildInvites
  GuildVoiceStates
  GuildPresences
  GuildMessages
  GuildMessageReactions
  GuildMessageTyping
  DirectMessages
  DirectMessageReactions
  DirectMessageTyping
  MessageContent
  GuildScheduledEvents
  AutoModerationConfiguration
  AutoModerationExecution
}

Constructors

```
Guilds
```
```
GuildMembers
```
```
GuildModeration
```
```
GuildEmojisAndStickers
```
```
GuildIntegrations
```
```
GuildWebhooks
```
```
GuildInvites
```
```
GuildVoiceStates
```
```
GuildPresences
```
```
GuildMessages
```
```
GuildMessageReactions
```
```
GuildMessageTyping
```
```
DirectMessages
```
```
DirectMessageReactions
```
```
DirectMessageTyping
```
```
MessageContent
```
```
GuildScheduledEvents
```
```
AutoModerationConfiguration
```
```
AutoModerationExecution
```

GetGatewayBot

</>

Model for the response received from /gateway/bot.

pub type GetGatewayBot {
  GetGatewayBot(
    url: String,
    shards: Int,
    session_start_limit: SessionStartLimit,
  )
}

Constructors

GetGatewayBot(
  url: String,
  shards: Int,
  session_start_limit: SessionStartLimit,
)

HelloEvent

</>

Structure of a Hello event.

pub type HelloEvent {
  HelloEvent(heartbeat_interval: Int)
}

Constructors

```
HelloEvent(heartbeat_interval: Int)
```

InstallParams

</>

Model for Install Params.

pub type InstallParams {
  InstallParams(scopes: List(String), permissions: String)
}

Constructors

InstallParams(scopes: List(String), permissions: String)

Member

</>

Model for a Team Member object.

pub type Member {
  Member(
    membership_state: Int,
    team_id: Snowflake,
    user: User,
    role: String,
  )
}

Constructors

Member(
  membership_state: Int,
  team_id: Snowflake,
  user: User,
  role: String,
)

MembershipState

</>

Model for Membership State.

pub type MembershipState {
  INVITED
  ACCEPTED
}

Constructors

```
INVITED
```
```
ACCEPTED
```

MentionType

</>

The supported types of mentions.

pub type MentionType {
  Roles
  Users
  Everyone
}

Constructors

```
Roles
```
```
Users
```
```
Everyone
```

Message

</>

Model for a Message object as received from the gateway.

TODO: add remaining fields

pub type Message {
  Message(
    id: Snowflake,
    channel_id: Snowflake,
    author: User,
    content: String,
    tts: Bool,
    mention_everyone: Bool,
    pinned: Bool,
    message_type: Int,
  )
}

Constructors

Message(
  id: Snowflake,
  channel_id: Snowflake,
  author: User,
  content: String,
  tts: Bool,
  mention_everyone: Bool,
  pinned: Bool,
  message_type: Int,
)

MessagePayload

</>

Model for the payload when creating a message.

TODO: message components (will come w/ interactions / commands), files

pub type MessagePayload {
  MessagePayload(
    content: Option(String),
    tts: Option(Bool),
    embeds: Option(List(Embed)),
    allowed_mentions: Option(AllowedMentions),
    message_reference: Option(MessageReference),
    sticker_ids: Option(List(Snowflake)),
    flags: Option(Int),
    nonce: Option(String),
    enforce_nonce: Option(Bool),
  )
}

Constructors

MessagePayload(
  content: Option(String),
  tts: Option(Bool),
  embeds: Option(List(Embed)),
  allowed_mentions: Option(AllowedMentions),
  message_reference: Option(MessageReference),
  sticker_ids: Option(List(Snowflake)),
  flags: Option(Int),
  nonce: Option(String),
  enforce_nonce: Option(Bool),
)

MessageReference

</>

This contains information needed for a message_reference attached to a MessagePayload. Needed when replying to a message.

pub type MessageReference {
  MessageReference(
    message_id: Option(Snowflake),
    channel_id: Option(Snowflake),
    guild_id: Option(Snowflake),
    fail_if_not_exists: Option(Bool),
  )
}

Constructors

MessageReference(
  message_id: Option(Snowflake),
  channel_id: Option(Snowflake),
  guild_id: Option(Snowflake),
  fail_if_not_exists: Option(Bool),
)

Owner

</>

pub type Owner =
  User

ReadyApplication

</>

Model for a partial Application received in the Ready event

pub type ReadyApplication {
  ReadyApplication(id: Snowflake, flags: Int)
}

Constructors

ReadyApplication(id: Snowflake, flags: Int)

ReadyEvent

</>

Structure of a Ready event.

pub type ReadyEvent {
  ReadyEvent(
    v: Int,
    user: User,
    guilds: dynamic.Dynamic,
    session_id: String,
    resume_gateway_url: String,
    shard: Option(List(Int)),
    application: ReadyApplication,
  )
}

Constructors

ReadyEvent(
  v: Int,
  user: User,
  guilds: dynamic.Dynamic,
  session_id: String,
  resume_gateway_url: String,
  shard: Option(List(Int)),
  application: ReadyApplication,
)

SessionStartLimit

</>

Model for Session Start Limit Object.

pub type SessionStartLimit {
  SessionStartLimit(
    total: Int,
    remaining: Int,
    reset_after: Int,
    max_concurrency: Int,
  )
}

Constructors

SessionStartLimit(
  total: Int,
  remaining: Int,
  reset_after: Int,
  max_concurrency: Int,
)

Snowflake

</>

The data structure Discord uses for UUIDs.

pub type Snowflake =
  String

Team

</>

Model for a Team object.

pub type Team {
  Team(
    id: Snowflake,
    icon: Option(String),
    members: List(Member),
    name: String,
    owner_user_id: Snowflake,
  )
}

Constructors

Team(
  id: Snowflake,
  icon: Option(String),
  members: List(Member),
  name: String,
  owner_user_id: Snowflake,
)

User

</>

Model for a Discord User.

Some additional fields marked as optional here due to the use of partial user objects in other areas of the API.

pub type User {
  User(
    id: Snowflake,
    username: String,
    discriminator: String,
    global_name: Option(String),
    avatar: Option(String),
    bot: Option(Bool),
    system: Option(Bool),
    mfa_enabled: Option(Bool),
    banner: Option(String),
    accent_color: Option(Int),
    locale: Option(String),
    email: Option(String),
    flags: Option(Int),
    premium_type: Option(Int),
    public_flags: Option(Int),
    avatar_decoration: Option(String),
  )
}

Constructors

User(
  id: Snowflake,
  username: String,
  discriminator: String,
  global_name: Option(String),
  avatar: Option(String),
  bot: Option(Bool),
  system: Option(Bool),
  mfa_enabled: Option(Bool),
  banner: Option(String),
  accent_color: Option(Int),
  locale: Option(String),
  email: Option(String),
  flags: Option(Int),
  premium_type: Option(Int),
  public_flags: Option(Int),
  avatar_decoration: Option(String),
)