crux_rest v0.2.2 Crux.Rest.Endpoints View Source

Endpoints being used by the Crux.Rest module, you do not need to worry about it.

Link to this section Summary

Functions

Base API address.

Used for channel related functions.

Used for channel invites.

Used for channel messages related functions.

Used for message deletion functions.

Used for channel permissions related functions.

Used for pin related functions.

Used for channel typing.

Used to fetch channel webhooks.

Used to obtain the gateway address.

Used to obtain the gateway address along the recommended shard count.

Used for guild related functions.

Used for guild audit logs fetching.

Used for ban related functions.

Used for guild channel functions.

Used for guild embed functions.

Used for guild emoji related functions.

Used for integration related functions.

Used for guild invites functions.

Used for guild members related functions.

Discord being special.

Used for guild prune functions

Used for guild region functions.

Used for role related functions.

Used to fetch guild webhooks.

Used for invite related functions.

Used for functions related to the current user.

Used for dm channel functions.

Used for functions related to the current user's guilds.

Used for functions related to users.

Used for webhook related functions.

Used to send github formatted webhooks.

Used to send slack formatted webhooks.

Link to this section Functions

Link to this function

base_url()

View Source (since 0.1.5)

Specs

base_url() :: String.t()

Base API address.

Link to this function

channel(channel_id, suffix \\ nil)

View Source (since 0.1.0)

Specs

channel(channel_id :: Crux.Rest.snowflake(), suffix :: String.t() | nil) ::
  String.t()

Used for channel related functions.

Link to this function

channel_invites(channel_id)

View Source (since 0.2.0)

Specs

channel_invites(channel_id :: Crux.Rest.snowflake()) :: String.t()

Used for channel invites.

Link to this function

channel_messages(channel_id, suffix \\ nil)

View Source (since 0.1.0)

Specs

channel_messages(
  channel_id :: Crux.Rest.snowflake(),
  suffix :: Crux.Rest.snowflake() | String.t() | nil
) :: String.t()

Used for channel messages related functions.

Link to this function

channel_messages_bulk_delete(channel_id)

View Source (since 0.2.0)

Specs

channel_messages_bulk_delete(channel_id :: Crux.Rest.snowflake()) :: String.t()

Used for message deletion functions.

Link to this function

channel_permissions(channel_id, target_id)

View Source (since 0.1.0)

Specs

channel_permissions(
  channel_id :: Crux.Rest.snowflake(),
  target_id :: Crux.Rest.snowflake()
) :: String.t()

Used for channel permissions related functions.

Link to this function

channel_pins(channel_id, suffix \\ nil)

View Source (since 0.1.0)

Specs

channel_pins(channel_id :: Crux.Rest.snowflake(), suffix :: String.t() | nil) ::
  String.t()

Used for pin related functions.

Link to this function

channel_typing(channel_id)

View Source (since 0.2.0)

Specs

channel_typing(channel_id :: Crux.Rest.snowflake()) :: String.t()

Used for channel typing.

Link to this function

channel_webhooks(channel_id)

View Source (since 0.1.7)

Specs

channel_webhooks(channel_id :: Crux.Rest.snowflake()) :: String.t()

Used to fetch channel webhooks.

Specs

gateway() :: String.t()

Used to obtain the gateway address.

Link to this function

gateway_bot()

View Source (since 0.1.0)

Specs

gateway_bot() :: String.t()

Used to obtain the gateway address along the recommended shard count.

Link to this function

guild(guild_id \\ nil, suffix \\ nil)

View Source (since 0.1.0)

Specs

guild(guild_id :: Crux.Rest.snowflake() | nil, suffix :: String.t() | nil) ::
  String.t()

Used for guild related functions.

Link to this function

guild_audit_logs(guild_id)

View Source (since 0.1.7)

Specs

guild_audit_logs(guild_id :: Crux.Rest.snowflake()) :: String.t()

Used for guild audit logs fetching.

Link to this function

guild_bans(guild_id, suffix \\ nil)

View Source (since 0.1.2)

Specs

guild_bans(
  guild_id :: Crux.Rest.snowflake(),
  suffix :: Crux.Rest.snowflake() | String.t() | nil
) :: String.t()

Used for ban related functions.

Link to this function

guild_channels(guild_id)

View Source (since 0.2.0)

Specs

guild_channels(guild_id :: Crux.Rest.snowflake()) :: String.t()

Used for guild channel functions.

Link to this function

guild_embed(guild_id)

View Source (since 0.2.0)

Specs

guild_embed(guild_id :: Crux.Rest.snowflake()) :: String.t()

Used for guild embed functions.

Link to this function

guild_emojis(guild_id, suffix \\ nil)

View Source (since 0.1.0)

Specs

guild_emojis(
  guild_id :: Crux.Rest.snowflake(),
  suffix :: Crux.Rest.snowflake() | String.t() | nil
) :: String.t()

Used for guild emoji related functions.

Link to this function

guild_integrations(guild_id, suffix \\ nil)

View Source (since 0.1.2)

Specs

guild_integrations(
  guild_id :: Crux.Rest.snowflake(),
  suffix :: String.t() | nil
) :: String.t()

Used for integration related functions.

Link to this function

guild_invites(guild_id)

View Source (since 0.2.0)

Specs

guild_invites(guild_id :: Crux.Rest.snowflake()) :: String.t()

Used for guild invites functions.

Link to this function

guild_member_roles(guild_id, member_id, role_id \\ nil)

View Source (since 0.1.1)

Specs

guild_member_roles(
  guild_id :: Crux.Rest.snowflake(),
  member_id :: Crux.Rest.snowflake(),
  role_id :: Crux.Rest.snowflake() | nil
) :: String.t()

Used for role related functions.

Link to this function

guild_members(guild_id, suffix \\ nil)

View Source (since 0.1.0)

Specs

guild_members(
  guild_id :: Crux.Rest.snowflake(),
  suffix :: Crux.Rest.snowflake() | String.t() | nil
) :: String.t()

Used for guild members related functions.

Link to this function

guild_own_nick(guild_id)

View Source (since 0.1.0)

Specs

guild_own_nick(guild_id :: Crux.Rest.snowflake()) :: String.t()

Discord being special.

Link to this function

guild_prune(guild_id)

View Source (since 0.2.0)

Specs

guild_prune(guild_id :: Crux.Rest.snowflake()) :: String.t()

Used for guild prune functions

Link to this function

guild_regions(guild_id)

View Source (since 0.2.0)

Specs

guild_regions(guild_id :: Crux.Rest.snowflake()) :: String.t()

Used for guild region functions.

Link to this function

guild_roles(guild_id, suffix \\ nil)

View Source (since 0.1.2)

Specs

guild_roles(
  guild_id :: Crux.Rest.snowflake(),
  suffix :: Crux.Rest.snowflake() | String.t() | nil
) :: String.t()

Used for role related functions.

Link to this function

guild_webhooks(guild_id)

View Source (since 0.1.7)

Specs

guild_webhooks(guild_id :: Crux.Rest.snowflake()) :: String.t()

Used to fetch guild webhooks.

Link to this function

invite(code \\ nil)

View Source (since 0.1.0)

Specs

invite(code :: String.t() | nil) :: String.t()

Used for invite related functions.

Link to this function

me(suffix \\ nil)

View Source (since 0.1.4)

Specs

me(suffix :: String.t() | nil) :: String.t()

Used for functions related to the current user.

Link to this function

me_channels()

View Source (since 0.2.0)

Specs

me_channels() :: String.t()

Used for dm channel functions.

Link to this function

me_guilds(suffix \\ nil)

View Source (since 0.1.4)

Specs

me_guilds(suffix :: Crux.Rest.snowflake() | String.t() | nil) :: String.t()

Used for functions related to the current user's guilds.

Link to this function

message_reactions(channel_id, message_id, emoji, suffix \\ nil)

View Source (since 0.1.0)

Specs

message_reactions(
  channel_id :: Crux.Rest.snowflake(),
  message_id :: Crux.Rest.snowflake(),
  emoji :: String.t(),
  suffix :: Crux.Rest.snowflake() | String.t() | nil
) :: String.t()

Used for reactions related functions.

Link to this function

users(suffix \\ nil)

View Source (since 0.1.4)

Specs

users(suffix :: Crux.Rest.snowflake() | String.t() | nil) :: String.t()

Used for functions related to users.

Link to this function

webhook(webhook_id, token \\ nil)

View Source (since 0.1.7)

Specs

webhook(guild_id :: Crux.Rest.snowflake(), token :: String.t() | nil) ::
  String.t()

Used for webhook related functions.

Link to this function

webhook_github(webhook_id, token)

View Source (since 0.1.7)

Specs

webhook_github(webhook_id :: Crux.Rest.snowflake(), token :: String.t()) ::
  String.t()

Used to send github formatted webhooks.

Link to this function

webhook_slack(webhook_id, token)

View Source (since 0.1.7)

Specs

webhook_slack(webhook_id :: Crux.Rest.snowflake(), token :: String.t()) ::
  String.t()

Used to send slack formatted webhooks.