Safe Haskell	None
Language	Haskell2010

Calamity.HTTP.Webhook

Description

Webhook endpoints

Documentation

data WebhookRequest a where Source #

Constructors

CreateWebhook :: HasID Channel c => c -> CreateWebhookData -> WebhookRequest Webhook
GetChannelWebhooks :: HasID Channel c => c -> WebhookRequest [Webhook]
GetGuildWebhooks :: HasID Guild c => c -> WebhookRequest [Webhook]
GetWebhook :: HasID Webhook w => w -> WebhookRequest Webhook
GetWebhookToken :: HasID Webhook w => w -> Text -> WebhookRequest Webhook
ModifyWebhook :: HasID Webhook w => w -> ModifyWebhookData -> WebhookRequest Webhook
ModifyWebhookToken :: HasID Webhook w => w -> Text -> ModifyWebhookData -> WebhookRequest Webhook
DeleteWebhook :: HasID Webhook w => w -> WebhookRequest ()
DeleteWebhookToken :: HasID Webhook w => w -> Text -> WebhookRequest ()
ExecuteWebhook :: HasID Webhook w => w -> Text -> ExecuteWebhookOptions -> WebhookRequest ()

Instances

Instances details

Request (WebhookRequest a) Source #
Instance details Defined in Calamity.HTTP.Webhook Associated Types type Result (WebhookRequest a) Source # Methods route :: WebhookRequest a -> Route Source # action :: WebhookRequest a -> Url 'Https -> Option 'Https -> Req LbsResponse Source # modifyResponse :: WebhookRequest a -> Value -> Value Source #
type Result (WebhookRequest a) Source #
Instance details Defined in Calamity.HTTP.Webhook type Result (WebhookRequest a) = a

data CreateWebhookData Source #

Constructors

CreateWebhookData
Fields username :: Maybe Text avatar :: Maybe Text The avatar field should be in discord's image data format: https://discord.com/developers/docs/reference#image-data

Instances

Instances details

Show CreateWebhookData Source #
Instance details Defined in Calamity.HTTP.Webhook Methods showsPrec :: Int -> CreateWebhookData -> ShowS # show :: CreateWebhookData -> String # showList :: [CreateWebhookData] -> ShowS #
Generic CreateWebhookData Source #
Instance details Defined in Calamity.HTTP.Webhook Associated Types type Rep CreateWebhookData :: Type -> Type # Methods from :: CreateWebhookData -> Rep CreateWebhookData x # to :: Rep CreateWebhookData x -> CreateWebhookData #
ToJSON CreateWebhookData Source #
Instance details Defined in Calamity.HTTP.Webhook Methods toJSON :: CreateWebhookData -> Value # toEncoding :: CreateWebhookData -> Encoding # toJSONList :: [CreateWebhookData] -> Value # toEncodingList :: [CreateWebhookData] -> Encoding #
Default CreateWebhookData Source #
Instance details Defined in Calamity.HTTP.Webhook Methods def :: CreateWebhookData #
type Rep CreateWebhookData Source #
Instance details Defined in Calamity.HTTP.Webhook type Rep CreateWebhookData = D1 ('MetaData "CreateWebhookData" "Calamity.HTTP.Webhook" "calamity-0.1.26.0-8Rbyh2JfYBvC9UHgZLNZiA" 'False) (C1 ('MetaCons "CreateWebhookData" 'PrefixI 'True) (S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "avatar") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

data ModifyWebhookData Source #

Constructors

ModifyWebhookData
Fields username :: Maybe Text avatar :: Maybe Text The avatar field should be in discord's image data format: https://discord.com/developers/docs/reference#image-data channelID :: Maybe (Snowflake Channel)

Instances

Instances details

Show ModifyWebhookData Source #
Instance details Defined in Calamity.HTTP.Webhook Methods showsPrec :: Int -> ModifyWebhookData -> ShowS # show :: ModifyWebhookData -> String # showList :: [ModifyWebhookData] -> ShowS #
Generic ModifyWebhookData Source #
Instance details Defined in Calamity.HTTP.Webhook Associated Types type Rep ModifyWebhookData :: Type -> Type # Methods from :: ModifyWebhookData -> Rep ModifyWebhookData x # to :: Rep ModifyWebhookData x -> ModifyWebhookData #
ToJSON ModifyWebhookData Source #
Instance details Defined in Calamity.HTTP.Webhook Methods toJSON :: ModifyWebhookData -> Value # toEncoding :: ModifyWebhookData -> Encoding # toJSONList :: [ModifyWebhookData] -> Value # toEncodingList :: [ModifyWebhookData] -> Encoding #
Default ModifyWebhookData Source #
Instance details Defined in Calamity.HTTP.Webhook Methods def :: ModifyWebhookData #
type Rep ModifyWebhookData Source #
Instance details Defined in Calamity.HTTP.Webhook type Rep ModifyWebhookData = D1 ('MetaData "ModifyWebhookData" "Calamity.HTTP.Webhook" "calamity-0.1.26.0-8Rbyh2JfYBvC9UHgZLNZiA" 'False) (C1 ('MetaCons "ModifyWebhookData" 'PrefixI 'True) (S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "avatar") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "channelID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Snowflake Channel))))))

data ExecuteWebhookOptions Source #

Constructors

ExecuteWebhookOptions
Fields wait :: Maybe Bool content :: Maybe Text file :: Maybe ByteString embeds :: Maybe [Embed] username :: Maybe Text avatarUrl :: Maybe Text tts :: Maybe Bool

Instances

Instances details

Show ExecuteWebhookOptions Source #
Instance details Defined in Calamity.HTTP.Webhook Methods showsPrec :: Int -> ExecuteWebhookOptions -> ShowS # show :: ExecuteWebhookOptions -> String # showList :: [ExecuteWebhookOptions] -> ShowS #
Generic ExecuteWebhookOptions Source #
Instance details Defined in Calamity.HTTP.Webhook Associated Types type Rep ExecuteWebhookOptions :: Type -> Type # Methods from :: ExecuteWebhookOptions -> Rep ExecuteWebhookOptions x # to :: Rep ExecuteWebhookOptions x -> ExecuteWebhookOptions #
Default ExecuteWebhookOptions Source #
Instance details Defined in Calamity.HTTP.Webhook Methods def :: ExecuteWebhookOptions #
type Rep ExecuteWebhookOptions Source #
Instance details Defined in Calamity.HTTP.Webhook type Rep ExecuteWebhookOptions = D1 ('MetaData "ExecuteWebhookOptions" "Calamity.HTTP.Webhook" "calamity-0.1.26.0-8Rbyh2JfYBvC9UHgZLNZiA" 'False) (C1 ('MetaCons "ExecuteWebhookOptions" 'PrefixI 'True) ((S1 ('MetaSel ('Just "wait") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "file") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ByteString)))) :: ((S1 ('MetaSel ('Just "embeds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Embed])) :: S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "avatarUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))))