Calamity.HTTP.Webhook

Webhook endpoints

Documentation

data WebhookRequest a where

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

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

type Result (WebhookRequest a)

Defined in Calamity.HTTP.Webhook

type Result (WebhookRequest a) = a

data CreateWebhookData

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

ToJSON CreateWebhookData

Defined in Calamity.HTTP.Webhook

Methods

toJSON :: CreateWebhookData -> Value

toEncoding :: CreateWebhookData -> Encoding

toJSONList :: [CreateWebhookData] -> Value

toEncodingList :: [CreateWebhookData] -> Encoding

Show CreateWebhookData

Defined in Calamity.HTTP.Webhook

Methods

showsPrec :: Int -> CreateWebhookData -> ShowS

show :: CreateWebhookData -> String

showList :: [CreateWebhookData] -> ShowS

CalamityToJSON' CreateWebhookData

Defined in Calamity.HTTP.Webhook

Methods

toPairs :: KeyValue kv => CreateWebhookData -> [Maybe kv]

Default CreateWebhookData

Defined in Calamity.HTTP.Webhook

Methods

def :: CreateWebhookData

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "avatar" k CreateWebhookData CreateWebhookData a b

Defined in Calamity.HTTP.Webhook

Methods

labelOptic :: Optic k NoIx CreateWebhookData CreateWebhookData a b

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "username" k CreateWebhookData CreateWebhookData a b

Defined in Calamity.HTTP.Webhook

Methods

labelOptic :: Optic k NoIx CreateWebhookData CreateWebhookData a b

data ModifyWebhookData

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

ToJSON ModifyWebhookData

Defined in Calamity.HTTP.Webhook

Methods

toJSON :: ModifyWebhookData -> Value

toEncoding :: ModifyWebhookData -> Encoding

toJSONList :: [ModifyWebhookData] -> Value

toEncodingList :: [ModifyWebhookData] -> Encoding

Show ModifyWebhookData

Defined in Calamity.HTTP.Webhook

Methods

showsPrec :: Int -> ModifyWebhookData -> ShowS

show :: ModifyWebhookData -> String

showList :: [ModifyWebhookData] -> ShowS

CalamityToJSON' ModifyWebhookData

Defined in Calamity.HTTP.Webhook

Methods

toPairs :: KeyValue kv => ModifyWebhookData -> [Maybe kv]

Default ModifyWebhookData

Defined in Calamity.HTTP.Webhook

Methods

def :: ModifyWebhookData

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "avatar" k ModifyWebhookData ModifyWebhookData a b

Defined in Calamity.HTTP.Webhook

Methods

labelOptic :: Optic k NoIx ModifyWebhookData ModifyWebhookData a b

(k ~ A_Lens, a ~ Maybe (Snowflake Channel), b ~ Maybe (Snowflake Channel)) => LabelOptic "channelID" k ModifyWebhookData ModifyWebhookData a b

Defined in Calamity.HTTP.Webhook

Methods

labelOptic :: Optic k NoIx ModifyWebhookData ModifyWebhookData a b

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "username" k ModifyWebhookData ModifyWebhookData a b

Defined in Calamity.HTTP.Webhook

Methods

labelOptic :: Optic k NoIx ModifyWebhookData ModifyWebhookData a b

data ExecuteWebhookOptions

Constructors

ExecuteWebhookOptions

Fields

• wait :: Maybe Bool
• content :: Maybe Text
• attachments :: [CreateMessageAttachment]
• embeds :: Maybe [Embed]
• username :: Maybe Text
• avatarUrl :: Maybe Text
• allowedMentions :: Maybe AllowedMentions
• tts :: Maybe Bool
• components :: [Component]

Instances

Show ExecuteWebhookOptions

Defined in Calamity.HTTP.Webhook

Methods

showsPrec :: Int -> ExecuteWebhookOptions -> ShowS

show :: ExecuteWebhookOptions -> String

showList :: [ExecuteWebhookOptions] -> ShowS

Default ExecuteWebhookOptions

Defined in Calamity.HTTP.Webhook

Methods

def :: ExecuteWebhookOptions

(k ~ A_Lens, a ~ Maybe AllowedMentions, b ~ Maybe AllowedMentions) => LabelOptic "allowedMentions" k ExecuteWebhookOptions ExecuteWebhookOptions a b

Defined in Calamity.HTTP.Webhook

Methods

labelOptic :: Optic k NoIx ExecuteWebhookOptions ExecuteWebhookOptions a b

(k ~ A_Lens, a ~ [CreateMessageAttachment], b ~ [CreateMessageAttachment]) => LabelOptic "attachments" k ExecuteWebhookOptions ExecuteWebhookOptions a b

Defined in Calamity.HTTP.Webhook

Methods

labelOptic :: Optic k NoIx ExecuteWebhookOptions ExecuteWebhookOptions a b

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "avatarUrl" k ExecuteWebhookOptions ExecuteWebhookOptions a b

Defined in Calamity.HTTP.Webhook

Methods

labelOptic :: Optic k NoIx ExecuteWebhookOptions ExecuteWebhookOptions a b

(k ~ A_Lens, a ~ [Component], b ~ [Component]) => LabelOptic "components" k ExecuteWebhookOptions ExecuteWebhookOptions a b

Defined in Calamity.HTTP.Webhook

Methods

labelOptic :: Optic k NoIx ExecuteWebhookOptions ExecuteWebhookOptions a b

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "content" k ExecuteWebhookOptions ExecuteWebhookOptions a b

Defined in Calamity.HTTP.Webhook

Methods

labelOptic :: Optic k NoIx ExecuteWebhookOptions ExecuteWebhookOptions a b

(k ~ A_Lens, a ~ Maybe [Embed], b ~ Maybe [Embed]) => LabelOptic "embeds" k ExecuteWebhookOptions ExecuteWebhookOptions a b

Defined in Calamity.HTTP.Webhook

Methods

labelOptic :: Optic k NoIx ExecuteWebhookOptions ExecuteWebhookOptions a b

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "tts" k ExecuteWebhookOptions ExecuteWebhookOptions a b

Defined in Calamity.HTTP.Webhook

Methods

labelOptic :: Optic k NoIx ExecuteWebhookOptions ExecuteWebhookOptions a b

(k ~ A_Lens, a ~ Maybe Text, b ~ Maybe Text) => LabelOptic "username" k ExecuteWebhookOptions ExecuteWebhookOptions a b

Defined in Calamity.HTTP.Webhook

Methods

labelOptic :: Optic k NoIx ExecuteWebhookOptions ExecuteWebhookOptions a b

(k ~ A_Lens, a ~ Maybe Bool, b ~ Maybe Bool) => LabelOptic "wait" k ExecuteWebhookOptions ExecuteWebhookOptions a b

Defined in Calamity.HTTP.Webhook

Methods

labelOptic :: Optic k NoIx ExecuteWebhookOptions ExecuteWebhookOptions a b