crux_rest v0.1.7 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

api() deprecated

Base API address

Base API address

cdn() deprecated

Base CDN address

Used for channel related functions

Used for channel messages related functions

Used for channel permissions related functions

Used for pin related functions

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 emoji related functions

Used for integration related functions

Used for guild members related functions

Discord being special

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 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 api() View Source (since 0.1.0)
api() :: String.t()
This function is deprecated. Use Crux.Structs.Endpoints.base_url/0 instead.

Base API address.

Deprecated, use base_url/0 instead.

Link to this function base_url() View Source (since 0.1.5)
base_url() :: String.t()

Base API address.

Link to this function cdn() View Source (since 0.1.0)
cdn() :: String.t()
This function is deprecated. Use Crux.Structs.CDN.base_url/0 instead.

Base CDN address.

Deprecated, use Crux.Rest.CDN.cdn/0 instead.

Link to this function channel(channel_id, suffix \\ nil) View Source (since 0.1.0)
channel(channel_id :: Crux.Rest.snowflake(), suffix :: String.t() | nil) ::
  String.t()

Used for channel related functions.

Link to this function channel_messages(channel_id, suffix \\ nil) View Source (since 0.1.0)
channel_messages(
  channel_id :: Crux.Rest.snowflake(),
  suffix :: String.t() | nil
) :: String.t()

Used for channel messages related functions.

Link to this function channel_permissions(channel_id, target_id) View Source (since 0.1.0)
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)
channel_pins(channel_id :: Crux.Rest.snowflake(), suffix :: String.t() | nil) ::
  String.t()

Used for pin related functions.

Link to this function channel_webhooks(channel_id) View Source (since 0.1.7)
channel_webhooks(channel_id :: Crux.Rest.snowflake()) :: String.t()

Used to fetch channel webhooks.

Link to this function gateway() View Source (since 0.1.0)
gateway() :: String.t()

Used to obtain the gateway address.

Link to this function gateway_bot() View Source (since 0.1.0)
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)
guild(guild_id :: Crux.Rest.snowflake(), 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)
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)
guild_bans(guild_id :: Crux.Rest.snowflake(), suffix :: String.t() | nil) ::
  String.t()

Used for ban related functions.

Link to this function guild_emojis(guild_id, suffix \\ nil) View Source (since 0.1.0)
guild_emojis(guild_id :: Crux.Rest.snowflake(), suffix :: 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)
guild_integrations(
  guild_id :: Crux.Rest.snowflake(),
  suffix :: String.t() | nil
) :: String.t()

Used for integration related functions.

Link to this function guild_member_roles(guild_id, member_id, role_id \\ nil) View Source (since 0.1.1)
guild_member_roles(
  guild_id :: Crux.Rest.snowflake(),
  member_id :: Crux.Rest.snowflake(),
  role_id :: Crux.Rest.snowflake()
) :: String.t()

Used for role related functions.

Link to this function guild_members(guild_id, suffix \\ nil) View Source (since 0.1.0)
guild_members(guild_id :: Crux.Rest.snowflake(), suffix :: 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)
guild_own_nick(guild_id :: Crux.Rest.snowflake()) :: String.t()

Discord being special.

Link to this function guild_roles(guild_id, suffix \\ nil) View Source (since 0.1.2)
guild_roles(guild_id :: Crux.Rest.snowflake(), suffix :: String.t() | nil) ::
  String.t()

Used for role related functions.

Link to this function guild_webhooks(guild_id) View Source (since 0.1.7)
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)
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)
me(suffix :: String.t()) :: String.t()

Used for functions related to the current user.

Link to this function me_guilds(suffix \\ nil) View Source (since 0.1.4)
me_guilds(suffix :: String.t()) :: 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)
message_reactions(
  channel_id :: Crux.Rest.snowflake(),
  message_id :: Crux.Rest.snowflake(),
  emoji :: String.t(),
  suffix :: String.t() | nil
) :: String.t()

Used for reactions related functions.

Link to this function users(suffix \\ nil) View Source (since 0.1.4)
users(suffix :: String.t()) :: String.t()

Used for functions related to users.

Link to this function webhook(webhook_id, token \\ nil) View Source (since 0.1.7)
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)
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)
webhook_slack(webhook_id :: Crux.Rest.snowflake(), token :: String.t()) ::
  String.t()

Used to send slack formatted webhooks.