Safe Haskell	Safe-Inferred
Language	Haskell2010

Discord.Internal.Rest.Prelude

Description

Utility and base types and functions for the Discord Rest API

Synopsis

apiVersion :: Text
baseUrl :: Url 'Https
authHeader :: Auth -> Option 'Https
(/?) :: ToHttpApiData a => Url scheme -> Maybe a -> Url scheme
data JsonRequest where
- 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
- majorRoute :: a -> String
- jsonRequest :: a -> JsonRequest
newtype RestIO a = RestIO {
- restIOtoIO :: IO a
}

Documentation

apiVersion :: Text Source #

The api version to use.

baseUrl :: Url 'Https Source #

The base url (Req) for API requests

authHeader :: Auth -> Option 'Https Source #

Discord requires HTTP headers for authentication.

(/?) :: ToHttpApiData a => Url scheme -> Maybe a -> Url scheme infixl 5 Source #

data JsonRequest where Source #

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 Source #

Methods

majorRoute :: a -> String Source #

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

jsonRequest :: a -> JsonRequest Source #

build a JSON http request

Instances

Instances details

Request (ApplicationCommandRequest a) Source #
Instance details Defined in Discord.Internal.Rest.ApplicationCommands Methods majorRoute :: ApplicationCommandRequest a -> String Source # jsonRequest :: ApplicationCommandRequest a -> JsonRequest Source #
Request (FullApplicationRequest a) Source #
Instance details Defined in Discord.Internal.Rest.ApplicationInfo Methods majorRoute :: FullApplicationRequest a -> String Source # jsonRequest :: FullApplicationRequest a -> JsonRequest Source #
Request (ChannelRequest a) Source #
Instance details Defined in Discord.Internal.Rest.Channel Methods majorRoute :: ChannelRequest a -> String Source # jsonRequest :: ChannelRequest a -> JsonRequest Source #
Request (EmojiRequest a) Source #
Instance details Defined in Discord.Internal.Rest.Emoji Methods majorRoute :: EmojiRequest a -> String Source # jsonRequest :: EmojiRequest a -> JsonRequest Source #
Request (StickerRequest a) Source #
Instance details Defined in Discord.Internal.Rest.Emoji Methods majorRoute :: StickerRequest a -> String Source # jsonRequest :: StickerRequest a -> JsonRequest Source #
Request (GuildRequest a) Source #
Instance details Defined in Discord.Internal.Rest.Guild Methods majorRoute :: GuildRequest a -> String Source # jsonRequest :: GuildRequest a -> JsonRequest Source #
Request (InteractionResponseRequest a) Source #
Instance details Defined in Discord.Internal.Rest.Interactions Methods majorRoute :: InteractionResponseRequest a -> String Source # jsonRequest :: InteractionResponseRequest a -> JsonRequest Source #
Request (InviteRequest a) Source #
Instance details Defined in Discord.Internal.Rest.Invite Methods majorRoute :: InviteRequest a -> String Source # jsonRequest :: InviteRequest a -> JsonRequest Source #
Request (ScheduledEventRequest a) Source #
Instance details Defined in Discord.Internal.Rest.ScheduledEvents Methods majorRoute :: ScheduledEventRequest a -> String Source # jsonRequest :: ScheduledEventRequest a -> JsonRequest Source #
Request (UserRequest a) Source #
Instance details Defined in Discord.Internal.Rest.User Methods majorRoute :: UserRequest a -> String Source # jsonRequest :: UserRequest a -> JsonRequest Source #
Request (VoiceRequest a) Source #
Instance details Defined in Discord.Internal.Rest.Voice Methods majorRoute :: VoiceRequest a -> String Source # jsonRequest :: VoiceRequest a -> JsonRequest Source #
Request (WebhookRequest a) Source #
Instance details Defined in Discord.Internal.Rest.Webhook Methods majorRoute :: WebhookRequest a -> String Source # jsonRequest :: WebhookRequest a -> JsonRequest Source #

newtype RestIO a Source #

Same Monad as IO. Overwrite Req settings

Constructors

RestIO
Fields restIOtoIO :: IO a

Instances

Instances details

MonadIO RestIO Source #
Instance details Defined in Discord.Internal.Rest.Prelude Methods liftIO :: IO a -> RestIO a #
Applicative RestIO Source #
Instance details 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 #
Functor RestIO Source #
Instance details Defined in Discord.Internal.Rest.Prelude Methods fmap :: (a -> b) -> RestIO a -> RestIO b # (<$) :: a -> RestIO b -> RestIO a #
Monad RestIO Source #
Instance details Defined in Discord.Internal.Rest.Prelude Methods (>>=) :: RestIO a -> (a -> RestIO b) -> RestIO b # (>>) :: RestIO a -> RestIO b -> RestIO b # return :: a -> RestIO a #
MonadHttp RestIO Source #
Instance details Defined in Discord.Internal.Rest.Prelude Methods handleHttpException :: HttpException -> RestIO a # getHttpConfig :: RestIO HttpConfig #