Calamity.HTTP.Internal.Request

Generic Request type

Documentation

class Request a where

Minimal complete definition

route, action

Associated Types

type Result a

Methods

route :: a -> Route

action :: a -> Options -> Session -> String -> IO (Response ByteString)

invoke :: (BotC r, FromJSON (Result a)) => a -> Sem r (Either RestError (Result a))

Instances

Request (WebhookRequest a)

Defined in Calamity.HTTP.Webhook

Associated Types

type Result (WebhookRequest a)

Methods

route :: WebhookRequest a -> Route

action :: WebhookRequest a -> Options -> Session -> String -> IO (Response ByteString)

invoke :: forall (r :: [(Type -> Type) -> Type -> Type]). (BotC r, FromJSON (Result (WebhookRequest a))) => WebhookRequest a -> Sem r (Either RestError (Result (WebhookRequest a)))

Request (UserRequest a)

Defined in Calamity.HTTP.User

Associated Types

type Result (UserRequest a)

Methods

route :: UserRequest a -> Route

action :: UserRequest a -> Options -> Session -> String -> IO (Response ByteString)

invoke :: forall (r :: [(Type -> Type) -> Type -> Type]). (BotC r, FromJSON (Result (UserRequest a))) => UserRequest a -> Sem r (Either RestError (Result (UserRequest a)))

Request a => Request (Reason a)

Defined in Calamity.HTTP.Reason

Associated Types

type Result (Reason a)

Methods

route :: Reason a -> Route

action :: Reason a -> Options -> Session -> String -> IO (Response ByteString)

invoke :: forall (r :: [(Type -> Type) -> Type -> Type]). (BotC r, FromJSON (Result (Reason a))) => Reason a -> Sem r (Either RestError (Result (Reason a)))

Request (MiscRequest a)

Defined in Calamity.HTTP.MiscRoutes

Associated Types

type Result (MiscRequest a)

Methods

route :: MiscRequest a -> Route

action :: MiscRequest a -> Options -> Session -> String -> IO (Response ByteString)

invoke :: forall (r :: [(Type -> Type) -> Type -> Type]). (BotC r, FromJSON (Result (MiscRequest a))) => MiscRequest a -> Sem r (Either RestError (Result (MiscRequest a)))

Request (InviteRequest a)

Defined in Calamity.HTTP.Invite

Associated Types

type Result (InviteRequest a)

Methods

route :: InviteRequest a -> Route

action :: InviteRequest a -> Options -> Session -> String -> IO (Response ByteString)

invoke :: forall (r :: [(Type -> Type) -> Type -> Type]). (BotC r, FromJSON (Result (InviteRequest a))) => InviteRequest a -> Sem r (Either RestError (Result (InviteRequest a)))

Request (GuildRequest a)

Defined in Calamity.HTTP.Guild

Associated Types

type Result (GuildRequest a)

Methods

route :: GuildRequest a -> Route

action :: GuildRequest a -> Options -> Session -> String -> IO (Response ByteString)

invoke :: forall (r :: [(Type -> Type) -> Type -> Type]). (BotC r, FromJSON (Result (GuildRequest a))) => GuildRequest a -> Sem r (Either RestError (Result (GuildRequest a)))

Request (EmojiRequest a)

Defined in Calamity.HTTP.Emoji

Associated Types

type Result (EmojiRequest a)

Methods

route :: EmojiRequest a -> Route

action :: EmojiRequest a -> Options -> Session -> String -> IO (Response ByteString)

invoke :: forall (r :: [(Type -> Type) -> Type -> Type]). (BotC r, FromJSON (Result (EmojiRequest a))) => EmojiRequest a -> Sem r (Either RestError (Result (EmojiRequest a)))

Request (ChannelRequest a)

Defined in Calamity.HTTP.Channel

Associated Types

type Result (ChannelRequest a)

Methods

route :: ChannelRequest a -> Route

action :: ChannelRequest a -> Options -> Session -> String -> IO (Response ByteString)

invoke :: forall (r :: [(Type -> Type) -> Type -> Type]). (BotC r, FromJSON (Result (ChannelRequest a))) => ChannelRequest a -> Sem r (Either RestError (Result (ChannelRequest a)))

Request (AuditLogRequest a)

Defined in Calamity.HTTP.AuditLog

Associated Types

type Result (AuditLogRequest a)

Methods

route :: AuditLogRequest a -> Route

action :: AuditLogRequest a -> Options -> Session -> String -> IO (Response ByteString)

invoke :: forall (r :: [(Type -> Type) -> Type -> Type]). (BotC r, FromJSON (Result (AuditLogRequest a))) => AuditLogRequest a -> Sem r (Either RestError (Result (AuditLogRequest a)))

postWith' :: Postable a => a -> Options -> Session -> String -> IO (Response ByteString)

postWithP' :: Postable a => a -> (Options -> Options) -> Options -> Session -> String -> IO (Response ByteString)

putWith' :: Putable a => a -> Options -> Session -> String -> IO (Response ByteString)

patchWith' :: Postable a => a -> Options -> Session -> String -> IO (Response ByteString)

putEmpty :: Options -> Session -> String -> IO (Response ByteString)

putEmptyP :: (Options -> Options) -> Options -> Session -> String -> IO (Response ByteString)

postEmpty :: Options -> Session -> String -> IO (Response ByteString)

postEmptyP :: (Options -> Options) -> Options -> Session -> String -> IO (Response ByteString)

getWithP :: (Options -> Options) -> Options -> Session -> String -> IO (Response ByteString)