Discord.Internal.Rest.Prelude

Utility and base types and functions for the Discord Rest API

Documentation

baseUrl :: Url 'Https

The base url (Req) for API requests

authHeader :: Auth -> Option 'Https

Discord requires HTTP headers for authentication.

(//) :: Show a => Url scheme -> a -> Url scheme infixl 5

data JsonRequest where

A compiled HTTP request ready to execute

Constructors

Delete :: Url 'Https -> Option 'Https -> JsonRequest

Get :: Url 'Https -> Option 'Https -> JsonRequest

Put :: HttpBody a => Url 'Https -> a -> Option 'Https -> JsonRequest

Patch :: HttpBody a => Url 'Https -> RestIO a -> Option 'Https -> JsonRequest

Post :: HttpBody a => Url 'Https -> RestIO a -> Option 'Https -> JsonRequest

class Request a where

Methods

majorRoute :: a -> String

used for putting a request into a rate limit bucket https://discord.com/developers/docs/topics/rate-limits#rate-limits

jsonRequest :: a -> JsonRequest

build a JSON http request

Instances

Request (WebhookRequest a)

Defined in Discord.Internal.Rest.Webhook

Methods

majorRoute :: WebhookRequest a -> String

jsonRequest :: WebhookRequest a -> JsonRequest

Request (VoiceRequest a)

Defined in Discord.Internal.Rest.Voice

Methods

majorRoute :: VoiceRequest a -> String

jsonRequest :: VoiceRequest a -> JsonRequest

Request (UserRequest a)

Defined in Discord.Internal.Rest.User

Methods

majorRoute :: UserRequest a -> String

jsonRequest :: UserRequest a -> JsonRequest

Request (InviteRequest a)

Defined in Discord.Internal.Rest.Invite

Methods

majorRoute :: InviteRequest a -> String

jsonRequest :: InviteRequest a -> JsonRequest

Request (InteractionResponseRequest a)

Defined in Discord.Internal.Rest.Interactions

Methods

majorRoute :: InteractionResponseRequest a -> String

jsonRequest :: InteractionResponseRequest a -> JsonRequest

Request (GuildRequest a)

Defined in Discord.Internal.Rest.Guild

Methods

majorRoute :: GuildRequest a -> String

jsonRequest :: GuildRequest a -> JsonRequest

Request (EmojiRequest a)

Defined in Discord.Internal.Rest.Emoji

Methods

majorRoute :: EmojiRequest a -> String

jsonRequest :: EmojiRequest a -> JsonRequest

Request (ChannelRequest a)

Defined in Discord.Internal.Rest.Channel

Methods

majorRoute :: ChannelRequest a -> String

jsonRequest :: ChannelRequest a -> JsonRequest

Request (ApplicationCommandRequest a)

Defined in Discord.Internal.Rest.ApplicationCommands

Methods

majorRoute :: ApplicationCommandRequest a -> String

jsonRequest :: ApplicationCommandRequest a -> JsonRequest

newtype RestIO a

Same Monad as IO. Overwrite Req settings

Constructors

RestIO

Fields

• restIOtoIO :: IO a

Instances

Monad RestIO

Defined in Discord.Internal.Rest.Prelude

Methods

(>>=) :: RestIO a -> (a -> RestIO b) -> RestIO b

(>>) :: RestIO a -> RestIO b -> RestIO b

return :: a -> RestIO a

Functor RestIO

Defined in Discord.Internal.Rest.Prelude

Methods

fmap :: (a -> b) -> RestIO a -> RestIO b

(<$) :: a -> RestIO b -> RestIO a

Applicative RestIO

Defined in Discord.Internal.Rest.Prelude

Methods

pure :: a -> RestIO a

(<*>) :: RestIO (a -> b) -> RestIO a -> RestIO b

liftA2 :: (a -> b -> c) -> RestIO a -> RestIO b -> RestIO c

(*>) :: RestIO a -> RestIO b -> RestIO b

(<*) :: RestIO a -> RestIO b -> RestIO a

MonadIO RestIO

Defined in Discord.Internal.Rest.Prelude

Methods

liftIO :: IO a -> RestIO a

MonadHttp RestIO

Defined in Discord.Internal.Rest.Prelude

Methods

handleHttpException :: HttpException -> RestIO a

getHttpConfig :: RestIO HttpConfig