glyph - v0.1.0

glyph/models/discord

This contains all types needed to communicate with either the Gateway or REST API.

Types

Application

</>

Model for a Discord Application: https://discord.com/developers/docs/resources/application Note to self: 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

DiscordError

</>

Generic Discord Error

pub type DiscordError

EventHandler

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

Constructors 

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

GatewayEvent

</>

Structure of payloads between gateway and client: https://discord.com/developers/docs/topics/gateway-events#payload-structure

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: https://discord.com/developers/docs/topics/gateway#gateway-intents

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 Get Gateway Bot: https://discord.com/developers/docs/topics/gateway#get-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: https://discord.com/developers/docs/topics/gateway#hello-event

pub type HelloEvent {
  HelloEvent(heartbeat_interval: Int)
}

Constructors 

  • HelloEvent(heartbeat_interval: Int)

InstallParams

</>

Model for Install Params: https://discord.com/developers/docs/resources/application#install-params-object

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

Constructors 

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

Member

</>

Model for a Team Member object: https://discord.com/developers/docs/topics/teams#data-models-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: https://discord.com/developers/docs/topics/teams#data-models-membership-state-enum

pub type MembershipState {
  INVITED
  ACCEPTED
}

Constructors 

  • INVITED
  • ACCEPTED

Message

</>

Model for a Message object: https://discord.com/developers/docs/resources/channel#message-object 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: https://discord.com/developers/docs/resources/channel#create-message TODO: add remaining fields

pub type MessagePayload {
  MessagePayload(content: String)
}

Constructors 

  • MessagePayload(content: String)

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: https://discord.com/developers/docs/topics/gateway-events#ready-ready-event-fields

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: https://discord.com/developers/docs/topics/gateway#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: https://discord.com/developers/docs/reference#snowflakes

pub type Snowflake =
  String

Team

</>

Model for a Team object: https://discord.com/developers/docs/topics/teams#data-models-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: https://discord.com/developers/docs/resources/user#user-object 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),
)
✨ Search Document