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 -> Url 'Https -> Option 'Https -> Req LbsResponse

modifyResponse :: a -> Value -> Value

Instances

Request (UserRequest a)

Defined in Calamity.HTTP.User

Associated Types

type Result (UserRequest a)

Methods

route :: UserRequest a -> Route

action :: UserRequest a -> Url 'Https -> Option 'Https -> Req LbsResponse

modifyResponse :: UserRequest a -> Value -> Value

Request a => Request (Reason a)

Defined in Calamity.HTTP.Reason

Associated Types

type Result (Reason a)

Methods

route :: Reason a -> Route

action :: Reason a -> Url 'Https -> Option 'Https -> Req LbsResponse

modifyResponse :: Reason a -> Value -> Value

Request (MiscRequest a)

Defined in Calamity.HTTP.MiscRoutes

Associated Types

type Result (MiscRequest a)

Methods

route :: MiscRequest a -> Route

action :: MiscRequest a -> Url 'Https -> Option 'Https -> Req LbsResponse

modifyResponse :: MiscRequest a -> Value -> Value

Request (InviteRequest a)

Defined in Calamity.HTTP.Invite

Associated Types

type Result (InviteRequest a)

Methods

route :: InviteRequest a -> Route

action :: InviteRequest a -> Url 'Https -> Option 'Https -> Req LbsResponse

modifyResponse :: InviteRequest a -> Value -> Value

Request (GuildRequest a)

Defined in Calamity.HTTP.Guild

Associated Types

type Result (GuildRequest a)

Methods

route :: GuildRequest a -> Route

action :: GuildRequest a -> Url 'Https -> Option 'Https -> Req LbsResponse

modifyResponse :: GuildRequest a -> Value -> Value

Request (EmojiRequest a)

Defined in Calamity.HTTP.Emoji

Associated Types

type Result (EmojiRequest a)

Methods

route :: EmojiRequest a -> Route

action :: EmojiRequest a -> Url 'Https -> Option 'Https -> Req LbsResponse

modifyResponse :: EmojiRequest a -> Value -> Value

Request (ChannelRequest a)

Defined in Calamity.HTTP.Channel

Associated Types

type Result (ChannelRequest a)

Methods

route :: ChannelRequest a -> Route

action :: ChannelRequest a -> Url 'Https -> Option 'Https -> Req LbsResponse

modifyResponse :: ChannelRequest a -> Value -> Value

Request (WebhookRequest a)

Defined in Calamity.HTTP.Webhook

Associated Types

type Result (WebhookRequest a)

Methods

route :: WebhookRequest a -> Route

action :: WebhookRequest a -> Url 'Https -> Option 'Https -> Req LbsResponse

modifyResponse :: WebhookRequest a -> Value -> Value

Request (InteractionRequest a)

Defined in Calamity.HTTP.Interaction

Associated Types

type Result (InteractionRequest a)

Methods

route :: InteractionRequest a -> Route

action :: InteractionRequest a -> Url 'Https -> Option 'Https -> Req LbsResponse

modifyResponse :: InteractionRequest a -> Value -> Value

Request (AuditLogRequest a)

Defined in Calamity.HTTP.AuditLog

Associated Types

type Result (AuditLogRequest a)

Methods

route :: AuditLogRequest a -> Route

action :: AuditLogRequest a -> Url 'Https -> Option 'Https -> Req LbsResponse

modifyResponse :: AuditLogRequest a -> Value -> Value

invoke :: (Members '[RatelimitEff, TokenEff, LogEff, MetricEff, Embed IO] r, Request a, ReadResponse (Result a)) => a -> Sem r (Either RestError (Result a))

getWith :: Url 'Https -> Option 'Https -> Req LbsResponse

postWith' :: HttpBody a => a -> Url 'Https -> Option 'Https -> Req LbsResponse

postWithP' :: HttpBody a => a -> Option 'Https -> Url 'Https -> Option 'Https -> Req LbsResponse

putWith' :: HttpBody a => a -> Url 'Https -> Option 'Https -> Req LbsResponse

patchWith' :: HttpBody a => a -> Url 'Https -> Option 'Https -> Req LbsResponse

putEmpty :: Url 'Https -> Option 'Https -> Req LbsResponse

putEmptyP :: Option 'Https -> Url 'Https -> Option 'Https -> Req LbsResponse

postEmpty :: Url 'Https -> Option 'Https -> Req LbsResponse

postEmptyP :: Option 'Https -> Url 'Https -> Option 'Https -> Req LbsResponse

getWithP :: Option 'Https -> Url 'Https -> Option 'Https -> Req LbsResponse

deleteWith :: Url 'Https -> Option 'Https -> Req LbsResponse

(=:?) :: ToHttpApiData a => Text -> Maybe a -> Option 'Https