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 role related 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 reactions related functions.
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
Specs
base_url() :: String.t()
Base API address.
Specs
channel(channel_id :: Crux.Rest.snowflake(), suffix :: String.t() | nil) :: String.t()
Used for channel related functions.
Specs
channel_invites(channel_id :: Crux.Rest.snowflake()) :: String.t()
Used for channel invites.
Specs
channel_messages( channel_id :: Crux.Rest.snowflake(), suffix :: Crux.Rest.snowflake() | String.t() | nil ) :: String.t()
Used for channel messages related functions.
Specs
channel_messages_bulk_delete(channel_id :: Crux.Rest.snowflake()) :: String.t()
Used for message deletion functions.
Specs
channel_permissions( channel_id :: Crux.Rest.snowflake(), target_id :: Crux.Rest.snowflake() ) :: String.t()
Used for channel permissions related functions.
Specs
channel_pins(channel_id :: Crux.Rest.snowflake(), suffix :: String.t() | nil) :: String.t()
Used for pin related functions.
Specs
channel_typing(channel_id :: Crux.Rest.snowflake()) :: String.t()
Used for channel typing.
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.
Specs
gateway_bot() :: String.t()
Used to obtain the gateway address along the recommended shard count.
Specs
guild(guild_id :: Crux.Rest.snowflake() | nil, suffix :: String.t() | nil) :: String.t()
Used for guild related functions.
Specs
guild_audit_logs(guild_id :: Crux.Rest.snowflake()) :: String.t()
Used for guild audit logs fetching.
Specs
guild_bans( guild_id :: Crux.Rest.snowflake(), suffix :: Crux.Rest.snowflake() | String.t() | nil ) :: String.t()
Used for ban related functions.
Specs
guild_channels(guild_id :: Crux.Rest.snowflake()) :: String.t()
Used for guild channel functions.
Specs
guild_embed(guild_id :: Crux.Rest.snowflake()) :: String.t()
Used for guild embed functions.
Specs
guild_emojis( guild_id :: Crux.Rest.snowflake(), suffix :: Crux.Rest.snowflake() | String.t() | nil ) :: String.t()
Used for guild emoji related functions.
Specs
guild_integrations( guild_id :: Crux.Rest.snowflake(), suffix :: String.t() | nil ) :: String.t()
Used for integration related functions.
Specs
guild_invites(guild_id :: Crux.Rest.snowflake()) :: String.t()
Used for guild invites functions.
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.
Specs
guild_members( guild_id :: Crux.Rest.snowflake(), suffix :: Crux.Rest.snowflake() | String.t() | nil ) :: String.t()
Used for guild members related functions.
Specs
guild_own_nick(guild_id :: Crux.Rest.snowflake()) :: String.t()
Discord being special.
Specs
guild_prune(guild_id :: Crux.Rest.snowflake()) :: String.t()
Used for guild prune functions
Specs
guild_regions(guild_id :: Crux.Rest.snowflake()) :: String.t()
Used for guild region functions.
Specs
guild_roles( guild_id :: Crux.Rest.snowflake(), suffix :: Crux.Rest.snowflake() | String.t() | nil ) :: String.t()
Used for role related functions.
Specs
guild_webhooks(guild_id :: Crux.Rest.snowflake()) :: String.t()
Used to fetch guild webhooks.
Specs
Used for invite related functions.
Specs
Used for functions related to the current user.
Specs
me_channels() :: String.t()
Used for dm channel functions.
Specs
me_guilds(suffix :: Crux.Rest.snowflake() | String.t() | nil) :: String.t()
Used for functions related to the current user's guilds.
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.
Specs
users(suffix :: Crux.Rest.snowflake() | String.t() | nil) :: String.t()
Used for functions related to users.
Specs
webhook(guild_id :: Crux.Rest.snowflake(), token :: String.t() | nil) :: String.t()
Used for webhook related functions.
Specs
webhook_github(webhook_id :: Crux.Rest.snowflake(), token :: String.t()) :: String.t()
Used to send github formatted webhooks.
Specs
webhook_slack(webhook_id :: Crux.Rest.snowflake(), token :: String.t()) :: String.t()
Used to send slack formatted webhooks.