-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/
-- | Easy to use library for building Telegram bots. Exports Telegram Bot API.
--
-- Please see the README on Github at
-- https://github.com/fizruk/telegram-bot-simple#readme
--
-- For official Bot API see Telegram Bot API at
-- https://core.telegram.org/bots/api
@package telegram-bot-api
@version 7.3
module Telegram.Bot.API.Internal.TH
makeDefault :: Name -> Q [Dec]
module Telegram.Bot.API.Internal.Utils
deriveJSON' :: Name -> Q [Dec]
gtoJSON :: forall a d f. (Generic a, GToJSON Zero (Rep a), Rep a ~ D1 d f, Datatype d) => a -> Value
gparseJSON :: forall a d f. (Generic a, GFromJSON Zero (Rep a), Rep a ~ D1 d f, Datatype d) => Value -> Parser a
genericSomeToJSON :: (Generic a, GSomeJSON (Rep a)) => a -> Value
genericSomeParseJSON :: (Generic a, GSomeJSON (Rep a)) => Value -> Parser a
data Proxy3 d f a
Proxy3 :: Proxy3 d f a
jsonOptions :: String -> Options
snakeFieldModifier :: String -> String -> String
camelWords :: String -> [String]
stripCommonPrefix :: Eq a => [a] -> [a] -> [a]
wordsToCamel :: [String] -> String
wordsToSnake :: [String] -> String
capitalise :: String -> String
stripCommonPrefixWords :: String -> String -> [String]
class GSomeJSON f
gsomeToJSON :: GSomeJSON f => f p -> Value
gsomeParseJSON :: GSomeJSON f => Value -> Parser (f p)
addJsonFields :: Value -> [Pair] -> Value
isNull :: Pair -> Bool
addMultipartFields :: [Input] -> MultipartData tag -> MultipartData tag
instance forall k (f :: k -> *) (d :: GHC.Generics.Meta). Telegram.Bot.API.Internal.Utils.GSomeJSON f => Telegram.Bot.API.Internal.Utils.GSomeJSON (GHC.Generics.D1 d f)
instance (Data.Aeson.Types.ToJSON.ToJSON a, Data.Aeson.Types.FromJSON.FromJSON a) => Telegram.Bot.API.Internal.Utils.GSomeJSON (GHC.Generics.C1 c (GHC.Generics.S1 s (GHC.Generics.K1 i a)))
instance forall k (f :: k -> *) (g :: k -> *). (Telegram.Bot.API.Internal.Utils.GSomeJSON f, Telegram.Bot.API.Internal.Utils.GSomeJSON g) => Telegram.Bot.API.Internal.Utils.GSomeJSON (f GHC.Generics.:+: g)
module Telegram.Bot.API.Types.Birthdate
-- | Describes the birthdate of a user.
data Birthdate
Birthdate :: DayOfMonth -> MonthOfYear -> Maybe Year -> Birthdate
-- | Day of the user's birth; 1-31.
[birthdateDay] :: Birthdate -> DayOfMonth
-- | Month of the user's birth; 1-12.
[birthdateMonth] :: Birthdate -> MonthOfYear
-- | Year of the user's birth.
[birthdate] :: Birthdate -> Maybe Year
instance GHC.Show.Show Telegram.Bot.API.Types.Birthdate.Birthdate
instance GHC.Generics.Generic Telegram.Bot.API.Types.Birthdate.Birthdate
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.Birthdate.Birthdate
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.Birthdate.Birthdate
module Telegram.Bot.API.Types.BotCommand
-- | This object represents a bot command.
data BotCommand
BotCommand :: Text -> Text -> BotCommand
-- | Text of the command; 1-32 characters. Can contain only lowercase
-- English letters, digits and underscores.
[botCommandCommand] :: BotCommand -> Text
-- | Description of the command; 1-256 characters.
[botCommandDescription] :: BotCommand -> Text
instance GHC.Show.Show Telegram.Bot.API.Types.BotCommand.BotCommand
instance GHC.Generics.Generic Telegram.Bot.API.Types.BotCommand.BotCommand
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.BotCommand.BotCommand
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.BotCommand.BotCommand
module Telegram.Bot.API.Types.BotDescription
-- | This object represents the bot's description.
newtype BotDescription
BotDescription :: Text -> BotDescription
-- | The bot's description.
[botDescriptionDescription] :: BotDescription -> Text
instance GHC.Show.Show Telegram.Bot.API.Types.BotDescription.BotDescription
instance GHC.Generics.Generic Telegram.Bot.API.Types.BotDescription.BotDescription
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.BotDescription.BotDescription
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.BotDescription.BotDescription
module Telegram.Bot.API.Types.BotName
-- | This object represents the bot's name.
newtype BotName
BotName :: Text -> BotName
-- | The bot's name.
[botNameName] :: BotName -> Text
instance GHC.Show.Show Telegram.Bot.API.Types.BotName.BotName
instance GHC.Generics.Generic Telegram.Bot.API.Types.BotName.BotName
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.BotName.BotName
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.BotName.BotName
module Telegram.Bot.API.Types.BotShortDescription
-- | This object represents the bot's short description.
data BotShortDescription
BotShortDescription :: Text -> BotShortDescription
-- | The bot's short description.
[botShortDescriptionShortDescription] :: BotShortDescription -> Text
instance GHC.Show.Show Telegram.Bot.API.Types.BotShortDescription.BotShortDescription
instance GHC.Generics.Generic Telegram.Bot.API.Types.BotShortDescription.BotShortDescription
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.BotShortDescription.BotShortDescription
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.BotShortDescription.BotShortDescription
module Telegram.Bot.API.Types.BusinessOpeningHoursInterval
-- | Contains information about the start page settings of a Telegram
-- Business account.
data BusinessOpeningHoursInterval
BusinessOpeningHoursInterval :: Int -> Int -> BusinessOpeningHoursInterval
-- | The minute's sequence number in a week, starting on Monday, marking
-- the start of the time interval during which the business is open;
-- 0 - 7 * 24 * 60.
[businessOpeningHoursIntervalOpeningMinute] :: BusinessOpeningHoursInterval -> Int
-- | The minute's sequence number in a week, starting on Monday, marking
-- the end of the time interval during which the business is open; 0
-- - 8 * 24 * 60.
[businessOpeningHoursIntervalClosingMinute] :: BusinessOpeningHoursInterval -> Int
instance GHC.Show.Show Telegram.Bot.API.Types.BusinessOpeningHoursInterval.BusinessOpeningHoursInterval
instance GHC.Generics.Generic Telegram.Bot.API.Types.BusinessOpeningHoursInterval.BusinessOpeningHoursInterval
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.BusinessOpeningHoursInterval.BusinessOpeningHoursInterval
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.BusinessOpeningHoursInterval.BusinessOpeningHoursInterval
module Telegram.Bot.API.Types.BusinessOpeningHours
data BusinessOpeningHours
BusinessOpeningHours :: Text -> [BusinessOpeningHoursInterval] -> BusinessOpeningHours
-- | Unique name of the time zone for which the opening hours are defined.
[businessOpeningHoursTimeZoneName] :: BusinessOpeningHours -> Text
-- | List of time intervals describing business opening hours.
[businessOpeningHoursOpeningHours] :: BusinessOpeningHours -> [BusinessOpeningHoursInterval]
instance GHC.Show.Show Telegram.Bot.API.Types.BusinessOpeningHours.BusinessOpeningHours
instance GHC.Generics.Generic Telegram.Bot.API.Types.BusinessOpeningHours.BusinessOpeningHours
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.BusinessOpeningHours.BusinessOpeningHours
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.BusinessOpeningHours.BusinessOpeningHours
module Telegram.Bot.API.Types.CallbackGame
-- | A placeholder, currently holds no information. Use BotFather to set up
-- your game.
newtype CallbackGame
CallbackGame :: Object -> CallbackGame
instance GHC.Show.Show Telegram.Bot.API.Types.CallbackGame.CallbackGame
instance GHC.Generics.Generic Telegram.Bot.API.Types.CallbackGame.CallbackGame
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.CallbackGame.CallbackGame
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.CallbackGame.CallbackGame
module Telegram.Bot.API.Types.ChatAdministratorRights
-- | Represents the rights of an administrator in a chat.
data ChatAdministratorRights
ChatAdministratorRights :: Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> ChatAdministratorRights
-- | True, if the user's presence in the chat is hidden.
[chatAdministratorRightsIsAnonymous] :: ChatAdministratorRights -> Bool
-- | True, if the administrator can access the chat event log, chat
-- statistics, message statistics in channels, see channel members, see
-- anonymous administrators in supergroups and ignore slow mode. Implied
-- by any other administrator privilege.
[chatAdministratorRightsCanManageChat] :: ChatAdministratorRights -> Bool
-- | True, if the administrator can delete messages of other users.
[chatAdministratorRightsCanDeleteMessages] :: ChatAdministratorRights -> Bool
-- | True, if the administrator can manage video chats.
[chatAdministratorRightsCanManageVideoChats] :: ChatAdministratorRights -> Bool
-- | True, if the administrator can restrict, ban or unban chat
-- members.
[chatAdministratorRightsCanRestrictMembers] :: ChatAdministratorRights -> Bool
-- | True, if the administrator can add new administrators with a
-- subset of their own privileges or demote administrators that he has
-- promoted, directly or indirectly (promoted by administrators that were
-- appointed by the user).
[chatAdministratorRightsCanPromoteMembers] :: ChatAdministratorRights -> Bool
-- | True, if the user is allowed to change the chat title, photo
-- and other settings.
[chatAdministratorRightsCanChangeInfo] :: ChatAdministratorRights -> Bool
-- | True, if the user is allowed to invite new users to the chat.
[chatAdministratorRightsCanInviteUsers] :: ChatAdministratorRights -> Bool
-- | True, if the administrator can post stories to the chat.
[chatAdministratorRightsCanPostStories] :: ChatAdministratorRights -> Maybe Bool
-- | True, if the administrator can edit stories posted by other
-- users, post stories to the chat page, pin chat stories, and access the
-- chat's story archive.
[chatAdministratorRightsCanEditStories] :: ChatAdministratorRights -> Maybe Bool
-- | True, if the administrator can delete stories posted by other
-- users.
[chatAdministratorRightsCanDeleteStories] :: ChatAdministratorRights -> Maybe Bool
-- | True, if the administrator can post in the channel; channels
-- only.
[chatAdministratorRightsCanPostMessages] :: ChatAdministratorRights -> Maybe Bool
-- | True, if the administrator can edit messages of other users and
-- can pin messages; channels only.
[chatAdministratorRightsCanEditMessages] :: ChatAdministratorRights -> Maybe Bool
-- | True, if the user is allowed to pin messages; groups and
-- supergroups only
[chatAdministratorRightsCanPinMessages] :: ChatAdministratorRights -> Maybe Bool
-- | True, if the user is allowed to create, rename, close, and
-- reopen forum topics; supergroups only.
[chatAdministratorRightsCanManageTopics] :: ChatAdministratorRights -> Maybe Bool
instance GHC.Show.Show Telegram.Bot.API.Types.ChatAdministratorRights.ChatAdministratorRights
instance GHC.Generics.Generic Telegram.Bot.API.Types.ChatAdministratorRights.ChatAdministratorRights
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.ChatAdministratorRights.ChatAdministratorRights
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.ChatAdministratorRights.ChatAdministratorRights
module Telegram.Bot.API.Types.ChatBoostAdded
-- | This object represents a boost added to a chat or changed.
data ChatBoostAdded
ChatBoostAdded :: Int -> ChatBoostAdded
-- | Number of boosts added by the user.
[chatBoostAddedBoostCount] :: ChatBoostAdded -> Int
instance GHC.Show.Show Telegram.Bot.API.Types.ChatBoostAdded.ChatBoostAdded
instance GHC.Generics.Generic Telegram.Bot.API.Types.ChatBoostAdded.ChatBoostAdded
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.ChatBoostAdded.ChatBoostAdded
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.ChatBoostAdded.ChatBoostAdded
module Telegram.Bot.API.Types.ChatPermissions
-- | Describes actions that a non-administrator user is allowed to take in
-- a chat.
data ChatPermissions
ChatPermissions :: Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> ChatPermissions
-- | True, if the user is allowed to send text messages, contacts,
-- locations and venues.
[chatPermissionsCanSendMessages] :: ChatPermissions -> Maybe Bool
-- | True, if the user is allowed to send audios.
[chatPermissionsCanSendAudios] :: ChatPermissions -> Maybe Bool
-- | True, if the user is allowed to send documents.
[chatPermissionsCanSendDocuments] :: ChatPermissions -> Maybe Bool
-- | True, if the user is allowed to send photos.
[chatPermissionsCanSendPhotos] :: ChatPermissions -> Maybe Bool
-- | True, if the user is allowed to send videos.
[chatPermissionsCanSendVideos] :: ChatPermissions -> Maybe Bool
-- | True, if the user is allowed to send video notes.
[chatPermissionsCanSendVideoNotes] :: ChatPermissions -> Maybe Bool
-- | True, if the user is allowed to send voice notes.
[chatPermissionsCanSendVoiceNotes] :: ChatPermissions -> Maybe Bool
-- | True, if the user is allowed to send polls, implies
-- can_send_messages.
[chatPermissionsCanSendPolls] :: ChatPermissions -> Maybe Bool
-- | True, if the user is allowed to send animations, games,
-- stickers and use inline bots, implies can_send_media_messages.
[chatPermissionsCanSendOtherMessages] :: ChatPermissions -> Maybe Bool
-- | True, if the user is allowed to add web page previews to their
-- messages, implies can_send_media_messages.
[chatPermissionsCanAddWebPagePreviews] :: ChatPermissions -> Maybe Bool
-- | True, if the user is allowed to change the chat title, photo
-- and other settings. Ignored in public supergroups
[chatPermissionsCanChangeInfo] :: ChatPermissions -> Maybe Bool
-- | True, if the user is allowed to invite new users to the chat.
[chatPermissionsCanInviteUsers] :: ChatPermissions -> Maybe Bool
-- | True, if the user is allowed to pin messages. Ignored in public
-- supergroups.
[chatPermissionsCanPinMessages] :: ChatPermissions -> Maybe Bool
-- | True, if the user is allowed to create forum topics. If omitted
-- defaults to the value of can_pin_messages.
[chatPermissionsCanManageTopics] :: ChatPermissions -> Maybe Bool
instance GHC.Show.Show Telegram.Bot.API.Types.ChatPermissions.ChatPermissions
instance GHC.Generics.Generic Telegram.Bot.API.Types.ChatPermissions.ChatPermissions
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.ChatPermissions.ChatPermissions
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.ChatPermissions.ChatPermissions
module Telegram.Bot.API.Types.ChatType
-- | Type of the chat, can be either “private”, “group”, “supergroup” or
-- “channel”.
data ChatType
ChatTypePrivate :: ChatType
ChatTypeGroup :: ChatType
ChatTypeSupergroup :: ChatType
ChatTypeChannel :: ChatType
ChatTypeSender :: ChatType
instance GHC.Show.Show Telegram.Bot.API.Types.ChatType.ChatType
instance GHC.Generics.Generic Telegram.Bot.API.Types.ChatType.ChatType
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.ChatType.ChatType
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.ChatType.ChatType
module Telegram.Bot.API.Types.Common
-- | Unique identifier for this file.
newtype FileId
FileId :: Text -> FileId
newtype Seconds
Seconds :: Int -> Seconds
-- | Unique identifier for this user or bot.
newtype UserId
UserId :: Integer -> UserId
-- | Unique identifier of the boost.
newtype BoostId
BoostId :: Text -> BoostId
-- | Unique identifier for this chat.
newtype ChatId
ChatId :: Integer -> ChatId
-- | Unique message identifier inside this chat.
newtype MessageId
MessageId :: Integer -> MessageId
-- | Unique identifier of a message thread to which the message belongs;
-- for supergroups only.
newtype MessageThreadId
MessageThreadId :: Integer -> MessageThreadId
-- | The unique identifier of a media message group a message belongs to.
newtype MediaGroupId
MediaGroupId :: Text -> MediaGroupId
-- | Signed 32-bit identifier of the request, which will be received back
-- in the UserShared or ChatShared object. Must be
-- unique within the message.
newtype RequestId
RequestId :: Integer -> RequestId
-- | Unique poll identifier.
newtype PollId
PollId :: Text -> PollId
newtype ShippingOptionId
ShippingOptionId :: Text -> ShippingOptionId
newtype WebAppInfo
WebAppInfo :: Text -> WebAppInfo
[webAppInfoUrl] :: WebAppInfo -> Text
newtype CallbackQueryId
CallbackQueryId :: Text -> CallbackQueryId
-- | Unique identifier of the business connection.
newtype BusinessConnectionId
BusinessConnectionId :: Text -> BusinessConnectionId
-- | Unique identifier for the target chat or username of the target
-- channel (in the format @channelusername).
data SomeChatId
-- | Unique chat ID.
SomeChatId :: ChatId -> SomeChatId
-- | Username of the target channel.
SomeChatUsername :: Text -> SomeChatId
addType :: Text -> [Pair] -> [Pair]
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.Common.FileId
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.Common.FileId
instance GHC.Show.Show Telegram.Bot.API.Types.Common.FileId
instance GHC.Classes.Eq Telegram.Bot.API.Types.Common.FileId
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.Common.Seconds
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.Common.Seconds
instance GHC.Num.Num Telegram.Bot.API.Types.Common.Seconds
instance GHC.Show.Show Telegram.Bot.API.Types.Common.Seconds
instance GHC.Classes.Eq Telegram.Bot.API.Types.Common.Seconds
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.Common.UserId
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.Common.UserId
instance GHC.Show.Show Telegram.Bot.API.Types.Common.UserId
instance GHC.Classes.Eq Telegram.Bot.API.Types.Common.UserId
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.Common.BoostId
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.Common.BoostId
instance GHC.Generics.Generic Telegram.Bot.API.Types.Common.BoostId
instance GHC.Show.Show Telegram.Bot.API.Types.Common.BoostId
instance GHC.Classes.Eq Telegram.Bot.API.Types.Common.BoostId
instance Data.Hashable.Class.Hashable Telegram.Bot.API.Types.Common.ChatId
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.Common.ChatId
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.Common.ChatId
instance GHC.Show.Show Telegram.Bot.API.Types.Common.ChatId
instance GHC.Classes.Eq Telegram.Bot.API.Types.Common.ChatId
instance Data.Hashable.Class.Hashable Telegram.Bot.API.Types.Common.MessageId
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.Common.MessageId
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.Common.MessageId
instance GHC.Show.Show Telegram.Bot.API.Types.Common.MessageId
instance GHC.Classes.Eq Telegram.Bot.API.Types.Common.MessageId
instance Data.Hashable.Class.Hashable Telegram.Bot.API.Types.Common.MessageThreadId
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.Common.MessageThreadId
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.Common.MessageThreadId
instance GHC.Show.Show Telegram.Bot.API.Types.Common.MessageThreadId
instance GHC.Classes.Eq Telegram.Bot.API.Types.Common.MessageThreadId
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.Common.MediaGroupId
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.Common.MediaGroupId
instance GHC.Show.Show Telegram.Bot.API.Types.Common.MediaGroupId
instance GHC.Classes.Eq Telegram.Bot.API.Types.Common.MediaGroupId
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.Common.RequestId
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.Common.RequestId
instance GHC.Show.Show Telegram.Bot.API.Types.Common.RequestId
instance GHC.Classes.Eq Telegram.Bot.API.Types.Common.RequestId
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.Common.PollId
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.Common.PollId
instance GHC.Show.Show Telegram.Bot.API.Types.Common.PollId
instance GHC.Classes.Eq Telegram.Bot.API.Types.Common.PollId
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.Common.ShippingOptionId
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.Common.ShippingOptionId
instance GHC.Generics.Generic Telegram.Bot.API.Types.Common.ShippingOptionId
instance GHC.Show.Show Telegram.Bot.API.Types.Common.ShippingOptionId
instance GHC.Classes.Eq Telegram.Bot.API.Types.Common.ShippingOptionId
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.Common.WebAppInfo
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.Common.WebAppInfo
instance GHC.Show.Show Telegram.Bot.API.Types.Common.WebAppInfo
instance GHC.Generics.Generic Telegram.Bot.API.Types.Common.WebAppInfo
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.Common.CallbackQueryId
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.Common.CallbackQueryId
instance GHC.Generics.Generic Telegram.Bot.API.Types.Common.CallbackQueryId
instance GHC.Show.Show Telegram.Bot.API.Types.Common.CallbackQueryId
instance GHC.Classes.Eq Telegram.Bot.API.Types.Common.CallbackQueryId
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.Common.BusinessConnectionId
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.Common.BusinessConnectionId
instance Web.Internal.HttpApiData.ToHttpApiData Telegram.Bot.API.Types.Common.BusinessConnectionId
instance GHC.Generics.Generic Telegram.Bot.API.Types.Common.BusinessConnectionId
instance GHC.Show.Show Telegram.Bot.API.Types.Common.BusinessConnectionId
instance GHC.Classes.Eq Telegram.Bot.API.Types.Common.BusinessConnectionId
instance GHC.Show.Show Telegram.Bot.API.Types.Common.SomeChatId
instance GHC.Generics.Generic Telegram.Bot.API.Types.Common.SomeChatId
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.Common.SomeChatId
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.Common.SomeChatId
instance Web.Internal.HttpApiData.ToHttpApiData Telegram.Bot.API.Types.Common.SomeChatId
instance Web.Internal.HttpApiData.ToHttpApiData Telegram.Bot.API.Types.Common.MessageThreadId
instance Web.Internal.HttpApiData.ToHttpApiData Telegram.Bot.API.Types.Common.MessageId
instance Web.Internal.HttpApiData.ToHttpApiData Telegram.Bot.API.Types.Common.ChatId
instance Web.Internal.HttpApiData.ToHttpApiData Telegram.Bot.API.Types.Common.UserId
instance Web.Internal.HttpApiData.ToHttpApiData Telegram.Bot.API.Types.Common.FileId
module Telegram.Bot.API.Types.ChatPhoto
-- | Chat photo. Returned only in getChat.
data ChatPhoto
ChatPhoto :: FileId -> FileId -> FileId -> FileId -> ChatPhoto
-- | Unique file identifier of small (160x160) chat photo. This file_id can
-- be used only for photo download.
[chatPhotoSmallFileId] :: ChatPhoto -> FileId
-- | Unique file identifier of small (160x160) chat photo, which is
-- supposed to be the same over time and for different bots. Can't be
-- used to download or reuse the file.
[chatPhotoSmallFileUniqueId] :: ChatPhoto -> FileId
-- | Unique file identifier of big (640x640) chat photo. This file_id can
-- be used only for photo download.
[chatPhotoBigFileId] :: ChatPhoto -> FileId
-- | Unique file identifier of big (640x640) chat photo, which is supposed
-- to be the same over time and for different bots. Can't be used to
-- download or reuse the file.
[chatPhotoBigFileUniqueId] :: ChatPhoto -> FileId
instance GHC.Show.Show Telegram.Bot.API.Types.ChatPhoto.ChatPhoto
instance GHC.Generics.Generic Telegram.Bot.API.Types.ChatPhoto.ChatPhoto
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.ChatPhoto.ChatPhoto
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.ChatPhoto.ChatPhoto
module Telegram.Bot.API.Types.Chat
-- | This object represents a chat.
data Chat
Chat :: ChatId -> ChatType -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Bool -> Chat
-- | Unique identifier for this chat. This number may be greater than 32
-- bits and some programming languages may have difficulty/silent defects
-- in interpreting it. But it is smaller than 52 bits, so a signed 64 bit
-- integer or double-precision float type are safe for storing this
-- identifier.
[chatId] :: Chat -> ChatId
-- | Type of the chat, can be either “private”, “group”, “supergroup” or
-- “channel”
[chatType] :: Chat -> ChatType
-- | Title, for supergroups, channels and group chats.
[chatTitle] :: Chat -> Maybe Text
-- | Username, for private chats, supergroups and channels if available.
[chatUsername] :: Chat -> Maybe Text
-- | First name of the other party in a private chat.
[chatFirstName] :: Chat -> Maybe Text
-- | Last name of the other party in a private chat.
[chatLastName] :: Chat -> Maybe Text
-- | True, if the supergroup chat is a forum (has topics enabled).
[chatIsForum] :: Chat -> Maybe Bool
instance GHC.Show.Show Telegram.Bot.API.Types.Chat.Chat
instance GHC.Generics.Generic Telegram.Bot.API.Types.Chat.Chat
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.Chat.Chat
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.Chat.Chat
module Telegram.Bot.API.Types.BusinessMessagesDeleted
-- | This object is received when messages are deleted from a connected
-- business account.
data BusinessMessagesDeleted
BusinessMessagesDeleted :: BusinessConnectionId -> Chat -> [MessageId] -> BusinessMessagesDeleted
-- | Unique identifier of the business connection.
[businessMessagesDeletedBusinessConnectionId] :: BusinessMessagesDeleted -> BusinessConnectionId
-- | Information about a chat in the business account. The bot may not have
-- access to the chat or the corresponding user.
[businessMessagesDeletedChat] :: BusinessMessagesDeleted -> Chat
-- | The list of identifiers of deleted messages in the chat of the
-- business account.
[businessMessagesDeletedMessageIds] :: BusinessMessagesDeleted -> [MessageId]
instance GHC.Show.Show Telegram.Bot.API.Types.BusinessMessagesDeleted.BusinessMessagesDeleted
instance GHC.Generics.Generic Telegram.Bot.API.Types.BusinessMessagesDeleted.BusinessMessagesDeleted
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.BusinessMessagesDeleted.BusinessMessagesDeleted
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.BusinessMessagesDeleted.BusinessMessagesDeleted
module Telegram.Bot.API.Types.BotCommandScope
data BotCommandScope
-- | Represents the default scope of bot commands. Default commands are
-- used if no commands with a narrower scope are specified for the user.
BotCommandScopeDefault :: BotCommandScope
-- | Represents the scope of bot commands, covering all private chats.
BotCommandScopeAllPrivateChats :: BotCommandScope
-- | Represents the scope of bot commands, covering all group and
-- supergroup chats.
BotCommandScopeAllGroupChats :: BotCommandScope
-- | Represents the scope of bot commands, covering all group and
-- supergroup chat administrators.
BotCommandScopeAllChatAdministrators :: BotCommandScope
-- | Represents the scope of bot commands, covering a specific chat.
BotCommandScopeChat :: SomeChatId -> BotCommandScope
-- | Represents the scope of bot commands, covering all administrators of a
-- specific group or supergroup chat.
BotCommandScopeChatAdministrators :: SomeChatId -> BotCommandScope
-- | Represents the scope of bot commands, covering a specific member of a
-- group or supergroup chat.
BotCommandScopeChatMember :: SomeChatId -> UserId -> BotCommandScope
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.BotCommandScope.BotCommandScope
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.BotCommandScope.BotCommandScope
module Telegram.Bot.API.Types.BackgroundFill
-- | This object describes the way a background is filled based on the
-- selected colors. Currently, it can be one of
--
--
-- - BackgroundFillSolid
-- - BackgroundFillGradient
-- - BackgroundFillFreeformGradient
--
data BackgroundFill
-- | The background is filled using the selected color.
BackgroundFillSolid :: Text -> Int -> BackgroundFill
-- | Type of the background fill, always “solid”.
[backgroundFillSolidType] :: BackgroundFill -> Text
-- | The color of the background fill in the RGB24 format.
[backgroundFillSolidColor] :: BackgroundFill -> Int
-- | The background is a gradient fill.
BackgroundFillGradient :: Text -> Int -> Int -> Int -> BackgroundFill
-- | Type of the background fill, always “gradient”.
[backgroundFillGradientType] :: BackgroundFill -> Text
-- | Top color of the gradient in the RGB24 format.
[backgroundFillGradientTopColor] :: BackgroundFill -> Int
-- | Bottom color of the gradient in the RGB24 format.
[backgroundFillGradientBottomColor] :: BackgroundFill -> Int
-- | Clockwise rotation angle of the background fill in degrees;
-- 0-359.
[backgroundFillGradientRotationAngle] :: BackgroundFill -> Int
-- | The background is a freeform gradient that rotates after every message
-- in the chat.
BackgroundFillFreeformGradient :: Text -> [Int] -> BackgroundFill
-- | Type of the background fill, always “freeform_gradient”.
[backgroundFillFreeformGradientType] :: BackgroundFill -> Text
-- | A list of the 3 or 4 base colors that are used to generate the
-- freeform gradient in the RGB24 format.
[backgroundFillFreeformGradientColors] :: BackgroundFill -> [Int]
instance GHC.Show.Show Telegram.Bot.API.Types.BackgroundFill.BackgroundFill
instance GHC.Generics.Generic Telegram.Bot.API.Types.BackgroundFill.BackgroundFill
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.BackgroundFill.BackgroundFill
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.BackgroundFill.BackgroundFill
module Telegram.Bot.API.Types.Contact
-- | This object represents a phone contact.
data Contact
Contact :: Text -> Text -> Maybe Text -> Maybe UserId -> Maybe Text -> Contact
-- | Contact's phone number.
[contactPhoneNumber] :: Contact -> Text
-- | Contact's first name.
[contactFirstName] :: Contact -> Text
-- | Contact's last name.
[contactLastName] :: Contact -> Maybe Text
-- | Contact's user identifier in Telegram.
[contactUserId] :: Contact -> Maybe UserId
-- | Additional data about the contact in the form of a vCard.
[contactVcard] :: Contact -> Maybe Text
instance GHC.Show.Show Telegram.Bot.API.Types.Contact.Contact
instance GHC.Generics.Generic Telegram.Bot.API.Types.Contact.Contact
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.Contact.Contact
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.Contact.Contact
module Telegram.Bot.API.Types.CopyMessageId
-- | This object represents result of copyMessage request.
data CopyMessageId
CopyMessageId :: MessageId -> CopyMessageId
-- | the MessageId of the sent message.
[copyMessageIdMessageId] :: CopyMessageId -> MessageId
instance GHC.Show.Show Telegram.Bot.API.Types.CopyMessageId.CopyMessageId
instance GHC.Generics.Generic Telegram.Bot.API.Types.CopyMessageId.CopyMessageId
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.CopyMessageId.CopyMessageId
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.CopyMessageId.CopyMessageId
module Telegram.Bot.API.Types.Dice
-- | This object represents an animated emoji that displays a random value.
data Dice
Dice :: Text -> Int -> Dice
-- | Emoji on which the dice throw animation is based.
[diceEmoji] :: Dice -> Text
-- | Value of the dice, 1-6 for “🎲”, “🎯” and “🎳” base emoji, 1-5 for “🏀”
-- and “⚽” base emoji, 1-64 for “🎰” base emoji
[diceValue] :: Dice -> Int
instance GHC.Show.Show Telegram.Bot.API.Types.Dice.Dice
instance GHC.Generics.Generic Telegram.Bot.API.Types.Dice.Dice
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.Dice.Dice
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.Dice.Dice
module Telegram.Bot.API.Types.EncryptedCredentials
-- | Contains data required for decrypting and authenticating
-- EncryptedPassportElement. See the Telegram Passport Documentation for
-- a complete description of the data decryption and authentication
-- processes.
data EncryptedCredentials
EncryptedCredentials :: Text -> Text -> Text -> EncryptedCredentials
-- | Base64-encoded encrypted JSON-serialized data with unique user's
-- payload, data hashes and secrets required for EncryptedPassportElement
-- decryption and authentication.
[encryptedCredentialsData] :: EncryptedCredentials -> Text
-- | Base64-encoded data hash for data authentication.
[encryptedCredentialsHash] :: EncryptedCredentials -> Text
-- | Base64-encoded secret, encrypted with the bot's public RSA key,
-- required for data decryption
[encryptedCredentialsSecret] :: EncryptedCredentials -> Text
instance GHC.Show.Show Telegram.Bot.API.Types.EncryptedCredentials.EncryptedCredentials
instance GHC.Generics.Generic Telegram.Bot.API.Types.EncryptedCredentials.EncryptedCredentials
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.EncryptedCredentials.EncryptedCredentials
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.EncryptedCredentials.EncryptedCredentials
module Telegram.Bot.API.Types.File
-- | This object represents a file ready to be downloaded. The file can be
-- downloaded via the link
-- https://api.telegram.org/file/bot<token>/<file_path>.
-- It is guaranteed that the link will be valid for at least 1 hour. When
-- the link expires, a new one can be requested by calling getFile.
data File
File :: FileId -> FileId -> Maybe Integer -> Maybe Text -> File
-- | Unique identifier for this file.
[fileFileId] :: File -> FileId
-- | Unique identifier for this file, which is supposed to be the same over
-- time and for different bots. Can't be used to download or reuse the
-- file.
[fileFileUniqueId] :: File -> FileId
-- | File size in bytes, if known.
[fileFileSize] :: File -> Maybe Integer
-- | File path. Use
-- https://api.telegram.org/file/bot<token>/<file_path>
-- to get the file.
[fileFilePath] :: File -> Maybe Text
instance GHC.Show.Show Telegram.Bot.API.Types.File.File
instance GHC.Generics.Generic Telegram.Bot.API.Types.File.File
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.File.File
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.File.File
module Telegram.Bot.API.Types.ForceReply
-- | Upon receiving a message with this object, Telegram clients will
-- display a reply interface to the user (act as if the user has selected
-- the bot‘s message and tapped ’Reply'). This can be extremely useful if
-- you want to create user-friendly step-by-step interfaces without
-- having to sacrifice privacy mode.
data ForceReply
ForceReply :: Bool -> Maybe Text -> Maybe Bool -> ForceReply
-- | Shows reply interface to the user, as if they manually selected the
-- bot‘s message and tapped ’Reply'
[forceReplyForceReply] :: ForceReply -> Bool
-- | The placeholder to be shown in the input field when the reply is
-- active; 1-64 characters.
[forceReplyInputFieldPlaceholder] :: ForceReply -> Maybe Text
-- | Use this parameter if you want to force reply from specific users
-- only. Targets: 1) users that are @mentioned in the text of the Message
-- object; 2) if the bot's message is a reply (has reply_to_message_id),
-- sender of the original message.
[forceReplySelective] :: ForceReply -> Maybe Bool
instance GHC.Show.Show Telegram.Bot.API.Types.ForceReply.ForceReply
instance GHC.Generics.Generic Telegram.Bot.API.Types.ForceReply.ForceReply
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.ForceReply.ForceReply
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.ForceReply.ForceReply
module Telegram.Bot.API.Types.ForumTopic
-- | This object represents a forum topic.
data ForumTopic
ForumTopic :: MessageThreadId -> Text -> Integer -> Maybe Text -> ForumTopic
-- | Unique identifier of the forum topic
[forumTopicMessageThreadId] :: ForumTopic -> MessageThreadId
-- | Name of the topic
[forumTopicName] :: ForumTopic -> Text
-- | Color of the topic icon in RGB format.
[forumTopicIconColor] :: ForumTopic -> Integer
-- | Unique identifier of the custom emoji shown as the topic icon.
[forumTopicIconCustomEmojiId] :: ForumTopic -> Maybe Text
instance GHC.Show.Show Telegram.Bot.API.Types.ForumTopic.ForumTopic
instance GHC.Generics.Generic Telegram.Bot.API.Types.ForumTopic.ForumTopic
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.ForumTopic.ForumTopic
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.ForumTopic.ForumTopic
module Telegram.Bot.API.Types.ForumTopicClosed
-- | This object represents a service message about a forum topic closed in
-- the chat. Currently holds no information.
newtype ForumTopicClosed
ForumTopicClosed :: Object -> ForumTopicClosed
instance GHC.Show.Show Telegram.Bot.API.Types.ForumTopicClosed.ForumTopicClosed
instance GHC.Generics.Generic Telegram.Bot.API.Types.ForumTopicClosed.ForumTopicClosed
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.ForumTopicClosed.ForumTopicClosed
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.ForumTopicClosed.ForumTopicClosed
module Telegram.Bot.API.Types.ForumTopicCreated
-- | This object represents a service message about a new forum topic
-- created in the chat.
data ForumTopicCreated
ForumTopicCreated :: Text -> Integer -> Maybe Text -> ForumTopicCreated
-- | Name of the topic.
[forumTopicCreatedName] :: ForumTopicCreated -> Text
-- | Color of the topic icon in RGB format.
[forumTopicCreatedIconColor] :: ForumTopicCreated -> Integer
-- | Unique identifier of the custom emoji shown as the topic icon.
[forumTopicCreatedIconCustomEmojiId] :: ForumTopicCreated -> Maybe Text
instance GHC.Show.Show Telegram.Bot.API.Types.ForumTopicCreated.ForumTopicCreated
instance GHC.Generics.Generic Telegram.Bot.API.Types.ForumTopicCreated.ForumTopicCreated
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.ForumTopicCreated.ForumTopicCreated
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.ForumTopicCreated.ForumTopicCreated
module Telegram.Bot.API.Types.ForumTopicEdited
-- | This object represents a service message about an edited forum topic.
data ForumTopicEdited
ForumTopicEdited :: Maybe Text -> Maybe Text -> ForumTopicEdited
-- | New name of the topic, if it was edited.
[forumTopicEditedName] :: ForumTopicEdited -> Maybe Text
-- | New identifier of the custom emoji shown as the topic icon, if it was
-- edited; an empty string if the icon was removed.
[forumTopicEditedIconCustomEmojiId] :: ForumTopicEdited -> Maybe Text
instance GHC.Show.Show Telegram.Bot.API.Types.ForumTopicEdited.ForumTopicEdited
instance GHC.Generics.Generic Telegram.Bot.API.Types.ForumTopicEdited.ForumTopicEdited
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.ForumTopicEdited.ForumTopicEdited
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.ForumTopicEdited.ForumTopicEdited
module Telegram.Bot.API.Types.ForumTopicReopened
-- | This object represents a service message about a forum topic reopened
-- in the chat. Currently holds no information.
newtype ForumTopicReopened
ForumTopicReopened :: Object -> ForumTopicReopened
instance GHC.Show.Show Telegram.Bot.API.Types.ForumTopicReopened.ForumTopicReopened
instance GHC.Generics.Generic Telegram.Bot.API.Types.ForumTopicReopened.ForumTopicReopened
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.ForumTopicReopened.ForumTopicReopened
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.ForumTopicReopened.ForumTopicReopened
module Telegram.Bot.API.Types.GeneralForumTopicHidden
-- | This object represents a service message about General forum topic
-- hidden in the chat. Currently holds no information.
newtype GeneralForumTopicHidden
GeneralForumTopicHidden :: Object -> GeneralForumTopicHidden
instance GHC.Show.Show Telegram.Bot.API.Types.GeneralForumTopicHidden.GeneralForumTopicHidden
instance GHC.Generics.Generic Telegram.Bot.API.Types.GeneralForumTopicHidden.GeneralForumTopicHidden
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.GeneralForumTopicHidden.GeneralForumTopicHidden
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.GeneralForumTopicHidden.GeneralForumTopicHidden
module Telegram.Bot.API.Types.GeneralForumTopicUnhidden
-- | This object represents a service message about General forum topic
-- unhidden in the chat. Currently holds no information.
newtype GeneralForumTopicUnhidden
GeneralForumTopicUnhidden :: Object -> GeneralForumTopicUnhidden
instance GHC.Show.Show Telegram.Bot.API.Types.GeneralForumTopicUnhidden.GeneralForumTopicUnhidden
instance GHC.Generics.Generic Telegram.Bot.API.Types.GeneralForumTopicUnhidden.GeneralForumTopicUnhidden
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.GeneralForumTopicUnhidden.GeneralForumTopicUnhidden
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.GeneralForumTopicUnhidden.GeneralForumTopicUnhidden
module Telegram.Bot.API.Types.Giveaway
-- | This object represents a message about a scheduled giveaway.
data Giveaway
Giveaway :: [Chat] -> POSIXTime -> Int -> Maybe Bool -> Maybe Bool -> Maybe Text -> Maybe [Text] -> Maybe Int -> Giveaway
-- | The list of chats which the user must join to participate in the
-- giveaway
[giveawayChats] :: Giveaway -> [Chat]
-- | Point in time (Unix timestamp) when winners of the giveaway will be
-- selected.
[giveawayWinnersSelectionDate] :: Giveaway -> POSIXTime
-- | The number of users which are supposed to be selected as winners of
-- the giveaway.
[giveawayWinnerCount] :: Giveaway -> Int
-- | True, if only users who join the chats after the giveaway
-- started should be eligible to win.
[giveawayOnlyNewMembers] :: Giveaway -> Maybe Bool
-- | True, if the list of giveaway winners will be visible to
-- everyone.
[giveawayHasPublicWinners] :: Giveaway -> Maybe Bool
-- | Description of additional giveaway prize.
[giveawayPrizeDescription] :: Giveaway -> Maybe Text
-- | A list of two-letter ISO 3166-1 alpha-2 country codes indicating the
-- countries from which eligible users for the giveaway must come. If
-- empty, then all users can participate in the giveaway. Users with a
-- phone number that was bought on Fragment can always participate in
-- giveaways.
[giveawayCountryCodes] :: Giveaway -> Maybe [Text]
-- | The number of months the Telegram Premium subscription won from the
-- giveaway will be active for.
[giveawayPremiumSubscriptionMonthCount] :: Giveaway -> Maybe Int
instance GHC.Show.Show Telegram.Bot.API.Types.Giveaway.Giveaway
instance GHC.Generics.Generic Telegram.Bot.API.Types.Giveaway.Giveaway
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.Giveaway.Giveaway
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.Giveaway.Giveaway
module Telegram.Bot.API.Types.GiveawayCreated
-- | This object represents a service message about the creation of a
-- scheduled giveaway. Currently holds no information.
data GiveawayCreated
GiveawayCreated :: GiveawayCreated
instance GHC.Show.Show Telegram.Bot.API.Types.GiveawayCreated.GiveawayCreated
instance GHC.Generics.Generic Telegram.Bot.API.Types.GiveawayCreated.GiveawayCreated
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.GiveawayCreated.GiveawayCreated
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.GiveawayCreated.GiveawayCreated
module Telegram.Bot.API.Types.Invoice
-- | This object contains basic information about an invoice.
data Invoice
Invoice :: Text -> Text -> Text -> Text -> Int -> Invoice
-- | Product name.
[invoiceTitle] :: Invoice -> Text
-- | Product description.
[invoiceDescription] :: Invoice -> Text
-- | Unique bot deep-linking parameter that can be used to generate this
-- invoice.
[invoiceStartParameter] :: Invoice -> Text
-- | Three-letter ISO 4217 currency code.
[invoiceCurrency] :: Invoice -> Text
-- | Total price in the smallest units of the currency (integer, not
-- float/double). For example, for a price of US$ 1.45 pass amount = 145.
-- See the exp parameter in currencies.json, it shows the number of
-- digits past the decimal point for each currency (2 for the majority of
-- currencies).
[invoiceTotalAmount] :: Invoice -> Int
instance GHC.Show.Show Telegram.Bot.API.Types.Invoice.Invoice
instance GHC.Generics.Generic Telegram.Bot.API.Types.Invoice.Invoice
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.Invoice.Invoice
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.Invoice.Invoice
module Telegram.Bot.API.Types.KeyboardButtonRequestChat
-- | This object defines the criteria used to request a suitable chat. The
-- identifier of the selected chat will be shared with the bot when the
-- corresponding button is pressed.
data KeyboardButtonRequestChat
KeyboardButtonRequestChat :: RequestId -> Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe ChatAdministratorRights -> Maybe ChatAdministratorRights -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> KeyboardButtonRequestChat
-- | Signed 32-bit identifier of the request, which will be received back
-- in the ChatShared object. Must be unique within the message
[keyboardButtonRequestChatRequestId] :: KeyboardButtonRequestChat -> RequestId
-- | Pass True to request a channel chat, pass False to
-- request a group or a supergroup chat.
[keyboardButtonRequestChatChatIsChannel] :: KeyboardButtonRequestChat -> Bool
-- | Pass True to request a forum supergroup, pass False to
-- request a non-forum chat. If not specified, no additional restrictions
-- are applied.
[keyboardButtonRequestChatChatIsForum] :: KeyboardButtonRequestChat -> Maybe Bool
-- | Pass True to request a supergroup or a channel with a username,
-- pass False to request a chat without a username. If not
-- specified, no additional restrictions are applied.
[keyboardButtonRequestChatChatHasUsername] :: KeyboardButtonRequestChat -> Maybe Bool
-- | Pass True to request a chat owned by the user. Otherwise, no
-- additional restrictions are applied.
[keyboardButtonRequestChatChatIsCreated] :: KeyboardButtonRequestChat -> Maybe Bool
-- | A JSON-serialized object listing the required administrator rights of
-- the user in the chat. The rights must be a superset of
-- bot_administrator_rights. If not specified, no additional
-- restrictions are applied.
[keyboardButtonRequestChatUserAdministratorRights] :: KeyboardButtonRequestChat -> Maybe ChatAdministratorRights
-- | A JSON-serialized object listing the required administrator rights of
-- the bot in the chat. The rights must be a subset of
-- user_administrator_rights. If not specified, no additional
-- restrictions are applied.
[keyboardButtonRequestChatBotAdministratorRights] :: KeyboardButtonRequestChat -> Maybe ChatAdministratorRights
-- | Pass True to request a chat with the bot as a member.
-- Otherwise, no additional restrictions are applied.
[keyboardButtonRequestChatBotIsMember] :: KeyboardButtonRequestChat -> Maybe Bool
-- | Pass True to request the chat's title.
[keyboardButtonRequestChatRequestTitle] :: KeyboardButtonRequestChat -> Maybe Bool
-- | Pass True to request the chat's username.
[keyboardButtonRequestChatRequestUsername] :: KeyboardButtonRequestChat -> Maybe Bool
-- | Pass True to request the chat's photo.
[keyboardButtonRequestChatRequestPhoto] :: KeyboardButtonRequestChat -> Maybe Bool
instance GHC.Show.Show Telegram.Bot.API.Types.KeyboardButtonRequestChat.KeyboardButtonRequestChat
instance GHC.Generics.Generic Telegram.Bot.API.Types.KeyboardButtonRequestChat.KeyboardButtonRequestChat
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.KeyboardButtonRequestChat.KeyboardButtonRequestChat
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.KeyboardButtonRequestChat.KeyboardButtonRequestChat
module Telegram.Bot.API.Types.KeyboardButtonRequestUsers
-- | This object defines the criteria used to request suitable users. The
-- identifiers of the selected users will be shared with the bot when the
-- corresponding button is pressed. More about requesting users »
data KeyboardButtonRequestUsers
KeyboardButtonRequestUsers :: RequestId -> Maybe Bool -> Maybe Bool -> Maybe Int -> Maybe Bool -> Maybe Bool -> Maybe Bool -> KeyboardButtonRequestUsers
-- | Signed 32-bit identifier of the request, which will be received back
-- in the UserShared object. Must be unique within the message
[keyboardButtonRequestUsersRequestId] :: KeyboardButtonRequestUsers -> RequestId
-- | Pass True to request a bot, pass False to request a
-- regular user. If not specified, no additional restrictions are
-- applied.
[keyboardButtonRequestUsersUserIsBot] :: KeyboardButtonRequestUsers -> Maybe Bool
-- | Pass True to request a premium user, pass False to
-- request a non-premium user. If not specified, no additional
-- restrictions are applied.
[keyboardButtonRequestUsersUserIsPremium] :: KeyboardButtonRequestUsers -> Maybe Bool
-- | The maximum number of users to be selected; 1-10. Defaults to 1.
[keyboardButtonRequestUsersMaxQuantity] :: KeyboardButtonRequestUsers -> Maybe Int
-- | Pass True to request the users' first and last names.
[keyboardButtonRequestUsersRequestName] :: KeyboardButtonRequestUsers -> Maybe Bool
-- | Pass True to request the users' usernames.
[keyboardButtonRequestUsersRequestUsername] :: KeyboardButtonRequestUsers -> Maybe Bool
-- | Pass True to request the users' photos.
[keyboardButtonRequestUsersRequestPhoto] :: KeyboardButtonRequestUsers -> Maybe Bool
instance GHC.Show.Show Telegram.Bot.API.Types.KeyboardButtonRequestUsers.KeyboardButtonRequestUsers
instance GHC.Generics.Generic Telegram.Bot.API.Types.KeyboardButtonRequestUsers.KeyboardButtonRequestUsers
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.KeyboardButtonRequestUsers.KeyboardButtonRequestUsers
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.KeyboardButtonRequestUsers.KeyboardButtonRequestUsers
module Telegram.Bot.API.Types.LabeledPrice
-- | This object represents a portion of the price for goods or services.
data LabeledPrice
LabelPrice :: Text -> Int -> LabeledPrice
-- | Portion label.
[labeledPriceLabel] :: LabeledPrice -> Text
-- | Price of the product in the smallest units of the currency (integer,
-- not float/double). For example, for a price of US$ 1.45 pass amount =
-- 145. See the exp parameter in currencies.json, it shows the number of
-- digits past the decimal point for each currency (2 for the majority of
-- currencies).
[labeledPriceAmount] :: LabeledPrice -> Int
instance GHC.Show.Show Telegram.Bot.API.Types.LabeledPrice.LabeledPrice
instance GHC.Generics.Generic Telegram.Bot.API.Types.LabeledPrice.LabeledPrice
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.LabeledPrice.LabeledPrice
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.LabeledPrice.LabeledPrice
module Telegram.Bot.API.InlineMode.InputMessageContent
-- | Represents the content of a text message to be sent as the result of
-- an inline query.
data InputMessageContent
-- | Represents the content of a text message to be sent as the
-- result of an inline query.
InputTextMessageContent :: Text -> Maybe Text -> Maybe Bool -> InputMessageContent
-- | Text of the message to be sent, 1-4096 characters
[inputMessageContentMessageText] :: InputMessageContent -> Text
-- | Mode for parsing entities in the message text. See formatting
-- options for more details.
[inputMessageContentParseMode] :: InputMessageContent -> Maybe Text
-- | Disables link previews for links in the sent message
[inputMessageContentDisableWebPagePrefiew] :: InputMessageContent -> Maybe Bool
-- | Represents the content of a location message to be sent as the
-- result of an inline query.
InputLocationMessageContent :: Float -> Float -> Maybe Float -> Maybe Integer -> Maybe Integer -> Maybe Integer -> InputMessageContent
-- | Latitude of the location in degrees
[inputMessageContentLatitude] :: InputMessageContent -> Float
-- | Longitude of the location in degrees
[inputMessageContentLongitude] :: InputMessageContent -> Float
-- | The radius of uncertainty for the location, measured in meters; 0-1500
[inputMessageContentHorizontalAccuracy] :: InputMessageContent -> Maybe Float
-- | Period in seconds for which the location can be updated, should be
-- between 60 and 86400.
[inputMessageContentLivePeriod] :: InputMessageContent -> Maybe Integer
-- | For live locations, a direction in which the user is moving, in
-- degrees. Must be between 1 and 360 if specified.
[inputMessageContentHeading] :: InputMessageContent -> Maybe Integer
-- | For live locations, a maximum distance for proximity alerts about
-- approaching another chat member, in meters. Must be between 1 and
-- 100000 if specified.
[inputMessageContentProximityAlertRadius] :: InputMessageContent -> Maybe Integer
-- | Represents the content of a venue message to be sent as the
-- result of an inline query.
InputVenueMessageContent :: Float -> Float -> Text -> Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> InputMessageContent
-- | Latitude of the location in degrees
[inputMessageContentLatitude] :: InputMessageContent -> Float
-- | Longitude of the location in degrees
[inputMessageContentLongitude] :: InputMessageContent -> Float
-- | Name of the venue
[inputMessageContentTitle] :: InputMessageContent -> Text
-- | Address of the venue
[inputMessageContentAddress] :: InputMessageContent -> Text
-- | Foursquare identifier of the venue, if known
[inputMessageContentFoursquareId] :: InputMessageContent -> Maybe Text
-- | Foursquare type of the venue, if known. (For example,
-- “arts_entertainment/default”, “arts_entertainment/aquarium” or
-- “food/icecream”.)
[inputMessageContentFoursquareType] :: InputMessageContent -> Maybe Text
-- | Google Places identifier of the venue
[inputMessageContentGooglePlaceId] :: InputMessageContent -> Maybe Text
-- | Google Places type of the venue. (See supported types.)
[inputMessageContentGooglePlaceType] :: InputMessageContent -> Maybe Text
-- | Represents the content of a contact message to be sent as the
-- result of an inline query.
InputContactMessageContent :: Text -> Text -> Maybe Text -> Maybe Text -> InputMessageContent
-- | Contact's phone number
[inputMessageContentPhoneNumber] :: InputMessageContent -> Text
-- | Contact's first name
[inputMessageContentFirstName] :: InputMessageContent -> Text
-- | Contact's last name
[inputMessageContentSecondName] :: InputMessageContent -> Maybe Text
-- | Additional data about the contact in the form of a vCard,
-- 0-2048 bytes
[inputMessageContentVcard] :: InputMessageContent -> Maybe Text
-- | Represents the content of an invoice message to be sent as the
-- result of an inline query.
InputInvoiceMessageContent :: Text -> Text -> Text -> Text -> Text -> [LabeledPrice] -> Maybe Integer -> Maybe [Integer] -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Integer -> Maybe Integer -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> InputMessageContent
-- | Name of the venue
[inputMessageContentTitle] :: InputMessageContent -> Text
-- | Product description, 1-255 characters.
[inputMessageContentDescription] :: InputMessageContent -> Text
-- | Bot-defined invoice payload, 1-128 bytes. This will not be displayed
-- to the user, use for your internal processes.
[inputMessageContentPayload] :: InputMessageContent -> Text
-- | Payment provider token, obtained via @BotFather.
[inputMessageContentProviderToken] :: InputMessageContent -> Text
-- | Three-letter ISO 4217 currency code, see more on currencies.
[inputMessageContentCurrency] :: InputMessageContent -> Text
-- | Price breakdown, a JSON-serialized list of components (e.g. product
-- price, tax, discount, delivery cost, delivery tax, bonus, etc.).
[inputMessageContentPrices] :: InputMessageContent -> [LabeledPrice]
-- | The maximum accepted amount for tips in the smallest units of the
-- currency (integer, not floatdouble). For example, for a maximum tip
-- of US$ 1.45 pass max_tip_amount = 145. See the exp
-- parameter in
-- [currencies.json](https:core.telegram.orgbotspaymentscurrencies.json),
-- it shows the number of digits past the decimal point for each currency
-- (2 for the majority of currencies). Defaults to 0.
[inputMessageContentMaxTipAmount] :: InputMessageContent -> Maybe Integer
-- | A JSON-serialized array of suggested amounts of tip in the smallest
-- units of the currency (integer, not float/double). At most 4 suggested
-- tip amounts can be specified. The suggested tip amounts must be
-- positive, passed in a strictly increased order and must not exceed
-- max_tip_amount.
[inputMessageContentSuggestedTipAmounts] :: InputMessageContent -> Maybe [Integer]
-- | A JSON-serialized object for data about the invoice, which will be
-- shared with the payment provider. A detailed description of the
-- required fields should be provided by the payment provider.
[inputMessageContentProviderData] :: InputMessageContent -> Maybe Text
-- | URL of the product photo for the invoice. Can be a photo of the goods
-- or a marketing image for a service.
[inputMessageContentPhotoUrl] :: InputMessageContent -> Maybe Text
-- | Photo size in bytes.
[inputMessageContentPhotoSize] :: InputMessageContent -> Maybe Integer
-- | Photo width.
[inputMessageContentPhotoWidth] :: InputMessageContent -> Maybe Integer
-- | Photo height.
[inputMessageContentPhotoHeight] :: InputMessageContent -> Maybe Integer
-- | True if you require the user's full name to complete the order.
[inputMessageContentNeedName] :: InputMessageContent -> Maybe Bool
-- | True if you require the user's phone number to complete the
-- order.
[inputMessageContentNeedPhoneNumber] :: InputMessageContent -> Maybe Bool
-- | True if you require the user's email address to complete the
-- order.
[inputMessageContentNeedEmail] :: InputMessageContent -> Maybe Bool
-- | True if you require the user's shipping address to complete the
-- order.
[inputMessageContentNeedShippingAddress] :: InputMessageContent -> Maybe Bool
-- | True if the user's phone number should be sent to provider.
[inputMessageContentSendPhoneNumberToProvider] :: InputMessageContent -> Maybe Bool
-- | True if the user's email address should be sent to provider.
[inputMessageContentSendEmailToProvider] :: InputMessageContent -> Maybe Bool
-- | True if the final price depends on the shipping method.
[inputMessageContentIsFlexible] :: InputMessageContent -> Maybe Bool
defaultInputTextMessageContent :: Text -> InputMessageContent
defaultInputLocationMessageContent :: Float -> Float -> InputMessageContent
instance GHC.Show.Show Telegram.Bot.API.InlineMode.InputMessageContent.InputMessageContent
instance GHC.Generics.Generic Telegram.Bot.API.InlineMode.InputMessageContent.InputMessageContent
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.InlineMode.InputMessageContent.InputMessageContent
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.InlineMode.InputMessageContent.InputMessageContent
module Telegram.Bot.API.Types.LinkPreviewOptions
data LinkPreviewOptions
LinkPreviewOptions :: Maybe Bool -> Maybe Text -> Maybe Bool -> Maybe Bool -> Maybe Bool -> LinkPreviewOptions
-- | True, if the link preview is disabled.
[linkPreviewOptionsIsDisabled] :: LinkPreviewOptions -> Maybe Bool
-- | URL to use for the link preview. If empty, then the first URL found in
-- the message text will be used.
[linkPreviewOptionsUrl] :: LinkPreviewOptions -> Maybe Text
-- | True, if the media in the link preview is suppposed to be
-- shrunk; ignored if the URL isn't explicitly specified or media size
-- change isn't supported for the preview.
[linkPreviewOptionsPreferSmallMedia] :: LinkPreviewOptions -> Maybe Bool
-- | True, if the media in the link preview is suppposed to be
-- enlarged; ignored if the URL isn't explicitly specified or media size
-- change isn't supported for the preview.
[linkPreviewOptionsPreferLargeMedia] :: LinkPreviewOptions -> Maybe Bool
-- | True, if the link preview must be shown above the message text;
-- otherwise, the link preview will be shown below the message text.
[linkPreviewOptionsShowAboveText] :: LinkPreviewOptions -> Maybe Bool
instance GHC.Show.Show Telegram.Bot.API.Types.LinkPreviewOptions.LinkPreviewOptions
instance GHC.Generics.Generic Telegram.Bot.API.Types.LinkPreviewOptions.LinkPreviewOptions
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.LinkPreviewOptions.LinkPreviewOptions
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.LinkPreviewOptions.LinkPreviewOptions
module Telegram.Bot.API.Types.Location
-- | This object represents a point on the map.
data Location
Location :: Float -> Float -> Maybe Float -> Maybe Seconds -> Maybe Int -> Maybe Int -> Location
-- | Longitude as defined by sender.
[locationLongitude] :: Location -> Float
-- | Latitude as defined by sender.
[locationLatitude] :: Location -> Float
-- | The radius of uncertainty for the location, measured in meters;
-- 0-1500.
[locationHorizontalAccuracy] :: Location -> Maybe Float
-- | Time relative to the message sending date, during which the location
-- can be updated; in seconds. For active live locations only.
[locationLivePeriod] :: Location -> Maybe Seconds
-- | The direction in which user is moving, in degrees; 1-360. For active
-- live locations only.
[locationHeading] :: Location -> Maybe Int
-- | Maximum distance for proximity alerts about approaching another chat
-- member, in meters. For sent live locations only.
[locationProximityAlertRadius] :: Location -> Maybe Int
instance GHC.Show.Show Telegram.Bot.API.Types.Location.Location
instance GHC.Generics.Generic Telegram.Bot.API.Types.Location.Location
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.Location.Location
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.Location.Location
module Telegram.Bot.API.Types.ChatLocation
-- | Represents a location to which a chat is connected.
data ChatLocation
ChatLocation :: Location -> Text -> ChatLocation
-- | The location to which the supergroup is connected. Can't be a live
-- location..
[chatLocationLocation] :: ChatLocation -> Location
-- | Location address; 1-64 characters, as defined by the chat owner.
[chatLocationAddress] :: ChatLocation -> Text
instance GHC.Show.Show Telegram.Bot.API.Types.ChatLocation.ChatLocation
instance GHC.Generics.Generic Telegram.Bot.API.Types.ChatLocation.ChatLocation
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.ChatLocation.ChatLocation
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.ChatLocation.ChatLocation
module Telegram.Bot.API.Types.BusinessLocation
-- | Contains information about the location of a Telegram Business
-- account.
data BusinessLocation
BusinessLocation :: Text -> Maybe Location -> BusinessLocation
-- | Address of the business.
[businessLocationAddress] :: BusinessLocation -> Text
-- | Location of the business.
[businessLocationLocation] :: BusinessLocation -> Maybe Location
instance GHC.Show.Show Telegram.Bot.API.Types.BusinessLocation.BusinessLocation
instance GHC.Generics.Generic Telegram.Bot.API.Types.BusinessLocation.BusinessLocation
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.BusinessLocation.BusinessLocation
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.BusinessLocation.BusinessLocation
module Telegram.Bot.API.Types.LoginUrl
-- | This object represents a parameter of the inline keyboard button used
-- to automatically authorize a user. Serves as a great replacement for
-- the Telegram Login Widget when the user is coming from Telegram. All
-- the user needs to do is tap/click a button and confirm that they want
-- to log in:
--
--
-- https://core.telegram.org/file/811140015/1734/8VZFkwWXalM.97872/6127fa62d8a0bf2b3c
--
-- Telegram apps support these buttons as of version 5.7.
data LoginUrl
LoginUrl :: Text -> Maybe Text -> Maybe Text -> Maybe Bool -> LoginUrl
-- | An HTTP URL to be opened with user authorization data added to the
-- query string when the button is pressed. If the user refuses to
-- provide authorization data, the original URL without information about
-- the user will be opened. The data added is the same as described in
-- Receiving authorization data.
--
--
-- - *NOTE**: You **must** always check the hash of the received data
-- to verify the authentication and the integrity of the data as
-- described in Checking authorization.
--
[loginUrlUrl] :: LoginUrl -> Text
-- | New text of the button in forwarded messages.
[loginUrlForwardText] :: LoginUrl -> Maybe Text
-- | Username of a bot, which will be used for user authorization. See
-- Setting up a bot for more details. If not specified, the current bot's
-- username will be assumed. The url's domain must be the same as the
-- domain linked with the bot. See Linking your domain to the bot for
-- more details.
[loginUrlBotUsername] :: LoginUrl -> Maybe Text
-- | Pass True to request the permission for your bot to send
-- messages to the user.
[loginUrlRequestWriteAccess] :: LoginUrl -> Maybe Bool
instance GHC.Show.Show Telegram.Bot.API.Types.LoginUrl.LoginUrl
instance GHC.Generics.Generic Telegram.Bot.API.Types.LoginUrl.LoginUrl
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.LoginUrl.LoginUrl
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.LoginUrl.LoginUrl
module Telegram.Bot.API.Types.MaskPosition
-- | This object describes the position on faces where a mask should be
-- placed by default.
data MaskPosition
MaskPosition :: Text -> Float -> Float -> Float -> MaskPosition
-- | The part of the face relative to which the mask should be placed. One
-- of “forehead”, “eyes”, “mouth”, or “chin”.
[maskPositionPoint] :: MaskPosition -> Text
-- | Shift by X-axis measured in widths of the mask scaled to the face
-- size, from left to right. For example, choosing -1.0 will place mask
-- just to the left of the default mask position.
[maskPositionXShift] :: MaskPosition -> Float
-- | Shift by Y-axis measured in heights of the mask scaled to the face
-- size, from top to bottom. For example, 1.0 will place the mask just
-- below the default mask position.
[maskPositionYShift] :: MaskPosition -> Float
-- | Mask scaling coefficient. For example, 2.0 means double size.
[maskPositionScale] :: MaskPosition -> Float
instance GHC.Show.Show Telegram.Bot.API.Types.MaskPosition.MaskPosition
instance GHC.Generics.Generic Telegram.Bot.API.Types.MaskPosition.MaskPosition
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.MaskPosition.MaskPosition
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.MaskPosition.MaskPosition
module Telegram.Bot.API.Types.MenuButton
-- | This object describes the bot's menu button in a private chat. If a
-- menu button other than MenuButtonDefault is set for a private
-- chat, then it is applied in the chat. Otherwise the default menu
-- button is applied. By default, the menu button opens the list of bot
-- commands.
data MenuButton
-- | Represents a menu button, which opens the bot's list of commands.
MenuButtonCommands :: MenuButton
-- | Represents a menu button, which launches a Web App.
MenuButtonWebApp :: Text -> WebAppInfo -> MenuButton
[menuButtonWebAppText] :: MenuButton -> Text
[menuButtonWebAppWebApp] :: MenuButton -> WebAppInfo
-- | Describes that no specific value for the menu button was set.
MenuButtonDefault :: MenuButton
instance GHC.Generics.Generic Telegram.Bot.API.Types.MenuButton.MenuButton
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.MenuButton.MenuButton
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.MenuButton.MenuButton
module Telegram.Bot.API.Types.MessageAutoDeleteTimerChanged
-- | This object represents a service message about a change in auto-delete
-- timer settings.
data MessageAutoDeleteTimerChanged
MessageAutoDeleteTimerChanged :: Seconds -> MessageAutoDeleteTimerChanged
-- | New auto-delete time for messages in the chat; in seconds
[messageAutoDeleteTimerChangedMessageAutoDeleteTime] :: MessageAutoDeleteTimerChanged -> Seconds
instance GHC.Show.Show Telegram.Bot.API.Types.MessageAutoDeleteTimerChanged.MessageAutoDeleteTimerChanged
instance GHC.Generics.Generic Telegram.Bot.API.Types.MessageAutoDeleteTimerChanged.MessageAutoDeleteTimerChanged
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.MessageAutoDeleteTimerChanged.MessageAutoDeleteTimerChanged
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.MessageAutoDeleteTimerChanged.MessageAutoDeleteTimerChanged
module Telegram.Bot.API.Types.ParseMode
data ParseMode
Markdown :: ParseMode
HTML :: ParseMode
MarkdownV2 :: ParseMode
instance GHC.Show.Show Telegram.Bot.API.Types.ParseMode.ParseMode
instance GHC.Generics.Generic Telegram.Bot.API.Types.ParseMode.ParseMode
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.ParseMode.ParseMode
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.ParseMode.ParseMode
module Telegram.Bot.API.Types.PassportFile
-- | This object represents a file uploaded to Telegram Passport. Currently
-- all Telegram Passport files are in JPEG format when decrypted and
-- don't exceed 10MB.
data PassportFile
PassportFile :: FileId -> FileId -> Int -> POSIXTime -> PassportFile
-- | Identifier for this file, which can be used to download or reuse the
-- file.
[passportFileFileId] :: PassportFile -> FileId
-- | Unique identifier for this file, which is supposed to be the same over
-- time and for different bots. Can't be used to download or reuse the
-- file.
[passportFileFileUniqueId] :: PassportFile -> FileId
-- | File size in bytes.
[passportFileFileSize] :: PassportFile -> Int
-- | Unix time when the file was uploaded.
[passportFileFileDate] :: PassportFile -> POSIXTime
instance GHC.Show.Show Telegram.Bot.API.Types.PassportFile.PassportFile
instance GHC.Generics.Generic Telegram.Bot.API.Types.PassportFile.PassportFile
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.PassportFile.PassportFile
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.PassportFile.PassportFile
module Telegram.Bot.API.Types.EncryptedPassportElement
-- | Contains information about documents or other Telegram Passport
-- elements shared with the bot by the user.
data EncryptedPassportElement
EncryptedPassportElement :: PassportElementType -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe [PassportFile] -> Maybe PassportFile -> Maybe PassportFile -> Maybe PassportFile -> Maybe [PassportFile] -> Text -> EncryptedPassportElement
-- | One of “personal_details”, “passport”, “driver_license”,
-- “identity_card”, “internal_passport”, “address”, “utility_bill”,
-- “bank_statement”, “rental_agreement”, “passport_registration”,
-- “temporary_registration”, “phone_number”, “email”.
[encryptedPassportElementType] :: EncryptedPassportElement -> PassportElementType
-- | Base64-encoded encrypted Telegram Passport element data provided by
-- the user, available for “personal_details”, “passport”,
-- “driver_license”, “identity_card”, “internal_passport” and “address”
-- types. Can be decrypted and verified using the accompanying
-- EncryptedCredentials.
[encryptedPassportElementData] :: EncryptedPassportElement -> Maybe Text
-- | User's verified phone number, available only for “phone_number” type.
[encryptedPassportElementPhoneNumber] :: EncryptedPassportElement -> Maybe Text
-- | User's verified email address, available only for “email” type.
[encryptedPassportElementEmail] :: EncryptedPassportElement -> Maybe Text
-- | Array of encrypted files with documents provided by the user,
-- available for “utility_bill”, “bank_statement”, “rental_agreement”,
-- “passport_registration” and “temporary_registration” types. Files can
-- be decrypted and verified using the accompanying EncryptedCredentials.
[encryptedPassportElementFiles] :: EncryptedPassportElement -> Maybe [PassportFile]
-- | Encrypted file with the front side of the document, provided by the
-- user. Available for “passport”, “driver_license”, “identity_card” and
-- “internal_passport”. The file can be decrypted and verified using the
-- accompanying EncryptedCredentials.
[encryptedPassportElementFrontSide] :: EncryptedPassportElement -> Maybe PassportFile
-- | Encrypted file with the reverse side of the document, provided by the
-- user. Available for “driver_license” and “identity_card”. The file can
-- be decrypted and verified using the accompanying EncryptedCredentials.
[encryptedPassportElementReverseSide] :: EncryptedPassportElement -> Maybe PassportFile
-- | Encrypted file with the selfie of the user holding a document,
-- provided by the user; available for “passport”, “driver_license”,
-- “identity_card” and “internal_passport”. The file can be decrypted and
-- verified using the accompanying EncryptedCredentials.
[encryptedPassportElementSelfie] :: EncryptedPassportElement -> Maybe PassportFile
-- | Array of encrypted files with translated versions of documents
-- provided by the user. Available if requested for “passport”,
-- “driver_license”, “identity_card”, “internal_passport”,
-- “utility_bill”, “bank_statement”, “rental_agreement”,
-- “passport_registration” and “temporary_registration” types. Files can
-- be decrypted and verified using the accompanying EncryptedCredentials.
[encryptedPassportElementTranslation] :: EncryptedPassportElement -> Maybe [PassportFile]
-- | Base64-encoded element hash for using in
-- PassportElementErrorUnspecified.
[encryptedPassportElementHash] :: EncryptedPassportElement -> Text
-- | One of “personal_details”, “passport”, “driver_license”,
-- “identity_card”, “internal_passport”, “address”, “utility_bill”,
-- “bank_statement”, “rental_agreement”, “passport_registration”,
-- “temporary_registration”, “phone_number”, “email”.
data PassportElementType
PassportElementTypePersonalDetails :: PassportElementType
PassportElementTypePassport :: PassportElementType
PassportElementTypeDriverLicense :: PassportElementType
PassportElementTypeIdentityCard :: PassportElementType
PassportElementTypeInternalPassport :: PassportElementType
PassportElementTypeAddress :: PassportElementType
PassportElementTypeUtilityBill :: PassportElementType
PassportElementTypeBankStatement :: PassportElementType
PassportElementTypeRentalAgreement :: PassportElementType
PassportElementTypePassportRegistration :: PassportElementType
PassportElementTypeTemporaryRegistration :: PassportElementType
PassportElementTypePhoneNumber :: PassportElementType
PassportElementTypeEmail :: PassportElementType
instance GHC.Show.Show Telegram.Bot.API.Types.EncryptedPassportElement.PassportElementType
instance GHC.Generics.Generic Telegram.Bot.API.Types.EncryptedPassportElement.PassportElementType
instance GHC.Show.Show Telegram.Bot.API.Types.EncryptedPassportElement.EncryptedPassportElement
instance GHC.Generics.Generic Telegram.Bot.API.Types.EncryptedPassportElement.EncryptedPassportElement
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.EncryptedPassportElement.EncryptedPassportElement
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.EncryptedPassportElement.EncryptedPassportElement
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.EncryptedPassportElement.PassportElementType
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.EncryptedPassportElement.PassportElementType
module Telegram.Bot.API.Types.PassportElementError
data PassportErrorSource
PassportErrorSourceData :: PassportErrorSource
PassportErrorSourceFrontSide :: PassportErrorSource
PassportErrorSourceReverseSide :: PassportErrorSource
PassportErrorSourceSelfie :: PassportErrorSource
PassportErrorSourceFile :: PassportErrorSource
PassportErrorSourceFiles :: PassportErrorSource
PassportErrorSourceTranslationFile :: PassportErrorSource
PassportErrorSourceTranslationFiles :: PassportErrorSource
PassportErrorSourceUnspecified :: PassportErrorSource
data PassportElementError
PassportElementError :: PassportErrorSource -> PassportElementType -> Text -> Maybe Text -> Text -> Maybe Text -> Maybe [Text] -> Maybe Text -> PassportElementError
-- | Error source, must be one of PassportErrorSource.
[passportElementErrorSource] :: PassportElementError -> PassportErrorSource
-- | The section of the user's Telegram Passport which has the error, one
-- of PassportElementType.
[passportElementErrorType] :: PassportElementError -> PassportElementType
-- | Name of the data field which has the error.
[passportElementErrorName] :: PassportElementError -> Text
-- | Base64-encoded data hash.
[passportElementErrorHash] :: PassportElementError -> Maybe Text
-- | Error message.
[passportElementErrorMessage] :: PassportElementError -> Text
-- | Base64-encoded hash of the file with the reverse side of the document.
[passportElementErrorFileHash] :: PassportElementError -> Maybe Text
-- | List of base64-encoded file hashes.
[passportElementErrorFileHashes] :: PassportElementError -> Maybe [Text]
-- | Base64-encoded element hash.
[passportElementErrorElementHash] :: PassportElementError -> Maybe Text
instance GHC.Show.Show Telegram.Bot.API.Types.PassportElementError.PassportErrorSource
instance GHC.Generics.Generic Telegram.Bot.API.Types.PassportElementError.PassportErrorSource
instance GHC.Show.Show Telegram.Bot.API.Types.PassportElementError.PassportElementError
instance GHC.Generics.Generic Telegram.Bot.API.Types.PassportElementError.PassportElementError
instance Web.Internal.HttpApiData.ToHttpApiData Telegram.Bot.API.Types.PassportElementError.PassportElementError
instance Web.Internal.HttpApiData.ToHttpApiData [Telegram.Bot.API.Types.PassportElementError.PassportElementError]
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.PassportElementError.PassportElementError
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.PassportElementError.PassportElementError
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.PassportElementError.PassportErrorSource
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.PassportElementError.PassportErrorSource
module Telegram.Bot.API.Types.PassportData
-- | Contains information about Telegram Passport data shared with the bot
-- by the user.
data PassportData
PassportData :: [EncryptedPassportElement] -> EncryptedCredentials -> PassportData
-- | Array with information about documents and other Telegram Passport
-- elements that was shared with the bot.
[passportDataData] :: PassportData -> [EncryptedPassportElement]
-- | Encrypted credentials required to decrypt the data.
[passportDataCredentials] :: PassportData -> EncryptedCredentials
instance GHC.Show.Show Telegram.Bot.API.Types.PassportData.PassportData
instance GHC.Generics.Generic Telegram.Bot.API.Types.PassportData.PassportData
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.PassportData.PassportData
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.PassportData.PassportData
module Telegram.Bot.API.Types.PhotoSize
-- | This object represents one size of a photo or a file / sticker
-- thumbnail.
data PhotoSize
PhotoSize :: FileId -> FileId -> Int -> Int -> Maybe Int -> PhotoSize
-- | Unique identifier for this file.
[photoSizeFileId] :: PhotoSize -> FileId
-- | Unique identifier for this file, which is supposed to be the same over
-- time and for different bots. Can't be used to download or reuse the
-- file.
[photoSizeFileUniqueId] :: PhotoSize -> FileId
-- | Photo width
[photoSizeWidth] :: PhotoSize -> Int
-- | Photo height
[photoSizeHeight] :: PhotoSize -> Int
-- | File size
[photoSizeFileSize] :: PhotoSize -> Maybe Int
instance GHC.Show.Show Telegram.Bot.API.Types.PhotoSize.PhotoSize
instance GHC.Generics.Generic Telegram.Bot.API.Types.PhotoSize.PhotoSize
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.PhotoSize.PhotoSize
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.PhotoSize.PhotoSize
module Telegram.Bot.API.Types.Document
-- | This object represents a general file (as opposed to photos, voice
-- messages and audio files).
data Document
Document :: FileId -> FileId -> Maybe PhotoSize -> Maybe Text -> Maybe Text -> Maybe Integer -> Document
-- | Unique file identifier.
[documentFileId] :: Document -> FileId
-- | Unique identifier for this file, which is supposed to be the same over
-- time and for different bots. Can't be used to download or reuse the
-- file.
[documentFileUniqueId] :: Document -> FileId
-- | Document thumbnail as defined by sender.
[documentThumbnail] :: Document -> Maybe PhotoSize
-- | Original filename as defined by sender.
[documentFileName] :: Document -> Maybe Text
-- | MIME type of the file as defined by sender.
[documentMimeType] :: Document -> Maybe Text
-- | File size in bytes.
[documentFileSize] :: Document -> Maybe Integer
instance GHC.Show.Show Telegram.Bot.API.Types.Document.Document
instance GHC.Generics.Generic Telegram.Bot.API.Types.Document.Document
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.Document.Document
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.Document.Document
module Telegram.Bot.API.Types.BackgroundType
-- | This object describes the type of a background. Currently, it can be
-- one of
--
--
-- - BackgroundTypeFill
-- - BackgroundTypeWallpaper
-- - BackgroundTypePattern
-- - BackgroundTypeChatTheme
--
data BackgroundType
-- | The background is automatically filled based on the selected colors.
BackgroundTypeFill :: Text -> BackgroundFill -> Int -> BackgroundType
-- | Type of the background, always “fill”.
[backgroundTypeFillType] :: BackgroundType -> Text
-- | The background fill.
[backgroundTypeFillFill] :: BackgroundType -> BackgroundFill
-- | Dimming of the background in dark themes, as a percentage;
-- 0-100.
[backgroundTypeFillDarkThemeDimming] :: BackgroundType -> Int
-- | The background is a wallpaper in the JPEG format.
BackgroundTypeWallpaper :: Text -> Document -> Int -> Maybe Bool -> Maybe Bool -> BackgroundType
-- | Type of the background, always “wallpaper”.
[backgroundTypeWallpaperType] :: BackgroundType -> Text
-- | Document with the wallpaper.
[backgroundTypeWallpaperDocument] :: BackgroundType -> Document
-- | Dimming of the background in dark themes, as a percentage;
-- 0-100.
[backgroundTypeWallpaperDarkThemeDimming] :: BackgroundType -> Int
-- | True, if the wallpaper is downscaled to fit in a
-- 450x450 square and then box-blurred with radius 12.
[backgroundTypeWallpaperIsBlurred] :: BackgroundType -> Maybe Bool
-- | True, if the background moves slightly when the device is
-- tilted.
[backgroundTypeWallpaperIsMoving] :: BackgroundType -> Maybe Bool
-- | The background is a PNG or TGV (gzipped subset of SVG with MIME type
-- “application/x-tgwallpattern”) pattern to be combined with the
-- background fill chosen by the user.
BackgroundTypePattern :: Text -> Document -> BackgroundFill -> Int -> Maybe Bool -> Maybe Bool -> BackgroundType
-- | Type of the background, always “pattern”.
[backgroundTypePatternType] :: BackgroundType -> Text
-- | Document with the pattern.
[backgroundTypePatternDocument] :: BackgroundType -> Document
-- | The background fill that is combined with the pattern.
[backgroundTypePatternFill] :: BackgroundType -> BackgroundFill
-- | Intensity of the pattern when it is shown above the filled background;
-- 0-100.
[backgroundTypePatternIntensity] :: BackgroundType -> Int
-- | True, if the background fill must be applied only to the
-- pattern itself. All other pixels are black in this case. For dark
-- themes only.
[backgroundTypePatternIsInverted] :: BackgroundType -> Maybe Bool
-- | True, if the background moves slightly when the device is
-- tilted.
[backgroundTypePatternIsMoving] :: BackgroundType -> Maybe Bool
-- | The background is taken directly from a built-in chat theme.
BackgroundTypeChatTheme :: Text -> Text -> BackgroundType
-- | Type of the background, always “chat_theme”.
[backgroundTypeChatThemeType] :: BackgroundType -> Text
-- | Name of the chat theme, which is usually an emoji.
[backgroundTypeChatThemeThemeName] :: BackgroundType -> Text
instance GHC.Show.Show Telegram.Bot.API.Types.BackgroundType.BackgroundType
instance GHC.Generics.Generic Telegram.Bot.API.Types.BackgroundType.BackgroundType
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.BackgroundType.BackgroundType
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.BackgroundType.BackgroundType
module Telegram.Bot.API.Types.ChatBackground
-- | This object represents a chat background.
data ChatBackground
ChatBackground :: BackgroundType -> ChatBackground
-- | Type of the background.
[chatBackgroundType] :: ChatBackground -> BackgroundType
instance GHC.Show.Show Telegram.Bot.API.Types.ChatBackground.ChatBackground
instance GHC.Generics.Generic Telegram.Bot.API.Types.ChatBackground.ChatBackground
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.ChatBackground.ChatBackground
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.ChatBackground.ChatBackground
module Telegram.Bot.API.Types.ChatShared
-- | This object contains information about the chat whose identifier was
-- shared with the bot using a KeyboardButtonRequestChat button.
data ChatShared
ChatShared :: RequestId -> ChatId -> Maybe Text -> Maybe Text -> Maybe [PhotoSize] -> ChatShared
-- | Identifier of the request.
[chatSharedRequestId] :: ChatShared -> RequestId
-- | Identifier of the shared chat. This number may have more than 32
-- significant bits and some programming languages may have
-- difficulty/silent defects in interpreting it. But it has at most 52
-- significant bits, so a 64-bit integer or double-precision float type
-- are safe for storing this identifier. The bot may not have access to
-- the chat and could be unable to use this identifier, unless the chat
-- is already known to the bot by some other means.
[chatSharedChatId] :: ChatShared -> ChatId
-- | Title of the chat, if the title was requested by the bot.
[chatSharedTitle] :: ChatShared -> Maybe Text
-- | Username of the chat, if the username was requested by the bot and
-- available.
[chatSharedUsername] :: ChatShared -> Maybe Text
-- | Available sizes of the chat photo, if the photo was requested by the
-- bot.
[chatSharedPhoto] :: ChatShared -> Maybe [PhotoSize]
instance GHC.Show.Show Telegram.Bot.API.Types.ChatShared.ChatShared
instance GHC.Generics.Generic Telegram.Bot.API.Types.ChatShared.ChatShared
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.ChatShared.ChatShared
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.ChatShared.ChatShared
module Telegram.Bot.API.Types.Audio
-- | This object represents an audio file to be treated as music by the
-- Telegram clients.
data Audio
Audio :: FileId -> FileId -> Seconds -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe PhotoSize -> Audio
-- | Unique identifier for this file.
[audioFileId] :: Audio -> FileId
-- | Unique identifier for this file, which is supposed to be the same over
-- time and for different bots. Can't be used to download or reuse the
-- file.
[audioFileUniqueId] :: Audio -> FileId
-- | Duration of the audio in seconds as defined by sender.
[audioDuration] :: Audio -> Seconds
-- | Performer of the audio as defined by sender or by audio tags.
[audioPerformer] :: Audio -> Maybe Text
-- | Title of the audio as defined by sender or by audio tags.
[audioTitle] :: Audio -> Maybe Text
-- | Original filename as defined by sender.
[audioFileName] :: Audio -> Maybe Text
-- | MIME type of the file as defined by sender.
[audioMimeType] :: Audio -> Maybe Text
-- | File size in bytes.
[audioFileSize] :: Audio -> Maybe Integer
-- | Thumbnail of the album cover to which the music file belongs.
[audioThumbnail] :: Audio -> Maybe PhotoSize
instance GHC.Show.Show Telegram.Bot.API.Types.Audio.Audio
instance GHC.Generics.Generic Telegram.Bot.API.Types.Audio.Audio
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.Audio.Audio
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.Audio.Audio
module Telegram.Bot.API.Types.Animation
-- | This object represents an animation file (GIF or H.264/MPEG-4 AVC
-- video without sound).
data Animation
Animation :: FileId -> FileId -> Int -> Int -> Seconds -> Maybe PhotoSize -> Maybe Text -> Maybe Text -> Maybe Integer -> Animation
-- | Identifier for this file, which can be used to download or reuse the
-- file.
[animationFileId] :: Animation -> FileId
-- | Unique identifier for this file, which is supposed to be the same over
-- time and for different bots. Can't be used to download or reuse the
-- file.
[animationFileUniqueId] :: Animation -> FileId
-- | Video width as defined by sender.
[animationWidth] :: Animation -> Int
-- | Video height as defined by sender.
[animationHeight] :: Animation -> Int
-- | Duration of the video in seconds as defined by sender.
[animationDuration] :: Animation -> Seconds
-- | Animation thumbnail as defined by sender.
[animationThumbnail] :: Animation -> Maybe PhotoSize
-- | Original animation filename as defined by sender.
[animationFileName] :: Animation -> Maybe Text
-- | MIME type of the file as defined by sender.
[animationMimeType] :: Animation -> Maybe Text
-- | File size in bytes.
[animationFileSize] :: Animation -> Maybe Integer
instance GHC.Show.Show Telegram.Bot.API.Types.Animation.Animation
instance GHC.Generics.Generic Telegram.Bot.API.Types.Animation.Animation
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.Animation.Animation
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.Animation.Animation
module Telegram.Bot.API.Types.PollType
data PollType
PollTypeQuiz :: PollType
PollTypeRegular :: PollType
getPollType :: PollType -> Text
instance GHC.Show.Show Telegram.Bot.API.Types.PollType.PollType
instance GHC.Generics.Generic Telegram.Bot.API.Types.PollType.PollType
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.PollType.PollType
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.PollType.PollType
module Telegram.Bot.API.Types.KeyboardButton
-- | This object represents one button of the reply keyboard. For simple
-- text buttons String can be used instead of this object to specify text
-- of the button. Optional fields are mutually exclusive.
data KeyboardButton
KeyboardButton :: Text -> Maybe KeyboardButtonRequestUsers -> Maybe KeyboardButtonRequestChat -> Maybe Bool -> Maybe Bool -> Maybe PollType -> Maybe WebAppInfo -> KeyboardButton
-- | Text of the button. If none of the optional fields are used, it will
-- be sent as a message when the button is pressed.
[keyboardButtonText] :: KeyboardButton -> Text
-- | If specified, pressing the button will open a list of suitable users.
-- Identifiers of selected users will be sent to the bot in a
-- “users_shared” service message. Available in private chats only.
[keyboardButtonRequestUsers] :: KeyboardButton -> Maybe KeyboardButtonRequestUsers
-- | If specified, pressing the button will open a list of suitable chats.
-- Tapping on a chat will send its identifier to the bot in a
-- “chat_shared” service message. Available in private chats only.
[keyboardButtonRequestChat] :: KeyboardButton -> Maybe KeyboardButtonRequestChat
-- | If True, the user's phone number will be sent as a contact when
-- the button is pressed. Available in private chats only.
[keyboardButtonRequestContact] :: KeyboardButton -> Maybe Bool
-- | If True, the user's current location will be sent when the
-- button is pressed. Available in private chats only.
[keyboardButtonRequestLocation] :: KeyboardButton -> Maybe Bool
-- | If specified, the user will be asked to create a poll and send it to
-- the bot when the button is pressed. Available in private chats only.
[keyboardButtonRequestPoll] :: KeyboardButton -> Maybe PollType
-- | If specified, the described Web App will be launched when the button
-- is pressed. The Web App will be able to send a “web_app_data” service
-- message. Available in private chats only.
[keyboardButtonWebApp] :: KeyboardButton -> Maybe WebAppInfo
instance GHC.Show.Show Telegram.Bot.API.Types.KeyboardButton.KeyboardButton
instance GHC.Generics.Generic Telegram.Bot.API.Types.KeyboardButton.KeyboardButton
instance Data.String.IsString Telegram.Bot.API.Types.KeyboardButton.KeyboardButton
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.KeyboardButton.KeyboardButton
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.KeyboardButton.KeyboardButton
module Telegram.Bot.API.Types.ReactionType
-- | This object describes the type of a reaction. Currently, it can be one
-- of
--
--
data ReactionType
ReactionTypeEmoji :: Text -> Text -> ReactionType
-- | Type of the reaction, always “emoji”.
[reactionTypeEmojiType] :: ReactionType -> Text
-- | Reaction emoji. Currently, it can be one of "👍", "👎", "❤", "🔥", "🥰",
-- "👏", "😁", "🤔", "🤯", "😱", "🤬", "😢", "🎉", "🤩", "🤮", "💩", "🙏", "👌", "🕊",
-- "🤡", "🥱", "🥴", "😍", "🐳", "❤🔥", "🌚", "🌭", "💯", "🤣", "⚡", "🍌", "🏆",
-- "💔", "🤨", "😐", "🍓", "🍾", "💋", "🖕", "😈", "😴", "😭", "🤓", "👻", "👨💻",
-- "👀", "🎃", "🙈", "😇", "😨", "🤝", "✍", "🤗", "🫡", "🎅", "🎄", "☃", "💅", "🤪",
-- "🗿", "🆒", "💘", "🙉", "🦄", "😘", "💊", "🙊", "😎", "👾", "🤷♂", "🤷", "🤷♀",
-- "😡".
[reactionTypeEmojiEmoji] :: ReactionType -> Text
ReactionTypeCustomEmoji :: Text -> Text -> ReactionType
-- | Type of the reaction, always “custom_emoji”.
[reactionTypeCustomEmojiType] :: ReactionType -> Text
-- | Custom emoji identifier.
[reactionTypeCustomEmojiCustomEmojiId] :: ReactionType -> Text
instance GHC.Show.Show Telegram.Bot.API.Types.ReactionType.ReactionType
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.ReactionType.ReactionType
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.ReactionType.ReactionType
module Telegram.Bot.API.Types.ReactionCount
-- | Represents a reaction added to a message along with the number of
-- times it was added.
data ReactionCount
ReactionCount :: ReactionType -> Int -> ReactionCount
-- | Type of the reaction.
[reactionCountType] :: ReactionCount -> ReactionType
-- | Number of times the reaction was added.
[reactionCountTotalCount] :: ReactionCount -> Int
instance GHC.Show.Show Telegram.Bot.API.Types.ReactionCount.ReactionCount
instance GHC.Generics.Generic Telegram.Bot.API.Types.ReactionCount.ReactionCount
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.ReactionCount.ReactionCount
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.ReactionCount.ReactionCount
module Telegram.Bot.API.Types.MessageReactionCountUpdated
-- | This object represents reaction changes on a message with anonymous
-- reactions.
data MessageReactionCountUpdated
MessageReactionCountUpdated :: Chat -> MessageId -> POSIXTime -> [ReactionCount] -> MessageReactionCountUpdated
-- | The chat containing the message.
[messageReactionCountUpdatedChat] :: MessageReactionCountUpdated -> Chat
-- | Unique message identifier inside the chat.
[messageReactionCountUpdatedMessageId] :: MessageReactionCountUpdated -> MessageId
-- | Date of the change in Unix time.
[messageReactionCountUpdatedDate] :: MessageReactionCountUpdated -> POSIXTime
-- | List of reactions that are present on the message.
[messageReactionCountUpdatedReactions] :: MessageReactionCountUpdated -> [ReactionCount]
instance GHC.Show.Show Telegram.Bot.API.Types.MessageReactionCountUpdated.MessageReactionCountUpdated
instance GHC.Generics.Generic Telegram.Bot.API.Types.MessageReactionCountUpdated.MessageReactionCountUpdated
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.MessageReactionCountUpdated.MessageReactionCountUpdated
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.MessageReactionCountUpdated.MessageReactionCountUpdated
module Telegram.Bot.API.Types.ReplyKeyboardMarkup
-- | This object represents a custom keyboard with reply options (see
-- Introduction to bots for details and examples).
data ReplyKeyboardMarkup
ReplyKeyboardMarkup :: [[KeyboardButton]] -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Text -> Maybe Bool -> ReplyKeyboardMarkup
-- | Array of button rows, each represented by an Array of KeyboardButton
-- objects.
[replyKeyboardMarkupKeyboard] :: ReplyKeyboardMarkup -> [[KeyboardButton]]
-- | Requests clients to always show the keyboard when the regular keyboard
-- is hidden. Defaults to False, in which case the custom keyboard
-- can be hidden and opened with a keyboard icon.
[replyKeyboardMarkupIsPersistent] :: ReplyKeyboardMarkup -> Maybe Bool
-- | Requests clients to resize the keyboard vertically for optimal fit
-- (e.g., make the keyboard smaller if there are just two rows of
-- buttons). Defaults to false, in which case the custom keyboard is
-- always of the same height as the app's standard keyboard.
[replyKeyboardMarkupResizeKeyboard] :: ReplyKeyboardMarkup -> Maybe Bool
-- | Requests clients to hide the keyboard as soon as it's been used. The
-- keyboard will still be available, but clients will automatically
-- display the usual letter-keyboard in the chat – the user can press a
-- special button in the input field to see the custom keyboard again.
-- Defaults to false.
[replyKeyboardMarkupOneTimeKeyboard] :: ReplyKeyboardMarkup -> Maybe Bool
-- | The placeholder to be shown in the input field when the keyboard is
-- active; 1-64 characters.
[replyKeyboardMarkupInputFieldSelector] :: ReplyKeyboardMarkup -> Maybe Text
-- | Use this parameter if you want to show the keyboard to specific users
-- only. Targets: 1) users that are @mentioned in the text of the Message
-- object; 2) if the bot's message is a reply (has reply_to_message_id),
-- sender of the original message.
--
-- Example: A user requests to change the bot's language, bot replies to
-- the request with a keyboard to select the new language. Other users in
-- the group don't see the keyboard.
[replyKeyboardMarkupSelective] :: ReplyKeyboardMarkup -> Maybe Bool
instance GHC.Show.Show Telegram.Bot.API.Types.ReplyKeyboardMarkup.ReplyKeyboardMarkup
instance GHC.Generics.Generic Telegram.Bot.API.Types.ReplyKeyboardMarkup.ReplyKeyboardMarkup
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.ReplyKeyboardMarkup.ReplyKeyboardMarkup
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.ReplyKeyboardMarkup.ReplyKeyboardMarkup
module Telegram.Bot.API.Types.ReplyKeyboardRemove
-- | Upon receiving a message with this object, Telegram clients will
-- remove the current custom keyboard and display the default
-- letter-keyboard.
--
-- By default, custom keyboards are displayed until a new keyboard is
-- sent by a bot. An exception is made for one-time keyboards that are
-- hidden immediately after the user presses a button (see
-- ReplyKeyboardMarkup).
data ReplyKeyboardRemove
ReplyKeyboardRemove :: Bool -> Maybe Bool -> ReplyKeyboardRemove
-- | Requests clients to remove the custom keyboard (user will not be able
-- to summon this keyboard; if you want to hide the keyboard from sight
-- but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup)
[replyKeyboardRemoveRemoveKeyboard] :: ReplyKeyboardRemove -> Bool
-- | Use this parameter if you want to remove the keyboard for specific
-- users only. Targets: 1) users that are @mentioned in the text of the
-- Message object; 2) if the bot's message is a reply (has
-- reply_to_message_id), sender of the original message.
--
-- Example: A user votes in a poll, bot returns confirmation message in
-- reply to the vote and removes the keyboard for that user, while still
-- showing the keyboard with poll options to users who haven't voted yet.
[replyKeyboardRemoveSelective] :: ReplyKeyboardRemove -> Maybe Bool
instance GHC.Show.Show Telegram.Bot.API.Types.ReplyKeyboardRemove.ReplyKeyboardRemove
instance GHC.Generics.Generic Telegram.Bot.API.Types.ReplyKeyboardRemove.ReplyKeyboardRemove
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.ReplyKeyboardRemove.ReplyKeyboardRemove
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.ReplyKeyboardRemove.ReplyKeyboardRemove
module Telegram.Bot.API.Types.ResponseParameters
-- | Contains information about why a request was unsuccessful.
data ResponseParameters
ResponseParameters :: Maybe ChatId -> Maybe Seconds -> ResponseParameters
-- | The group has been migrated to a supergroup with the specified
-- identifier. This number may be greater than 32 bits and some
-- programming languages may have difficulty/silent defects in
-- interpreting it. But it is smaller than 52 bits, so a signed 64 bit
-- integer or double-precision float type are safe for storing this
-- identifier.
[responseParametersMigrateToChatId] :: ResponseParameters -> Maybe ChatId
-- | In case of exceeding flood control, the number of seconds left to wait
-- before the request can be repeated
[responseParametersRetryAfter] :: ResponseParameters -> Maybe Seconds
instance GHC.Generics.Generic Telegram.Bot.API.Types.ResponseParameters.ResponseParameters
instance GHC.Show.Show Telegram.Bot.API.Types.ResponseParameters.ResponseParameters
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.ResponseParameters.ResponseParameters
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.ResponseParameters.ResponseParameters
module Telegram.Bot.API.Types.SharedUser
-- | This object contains information about a user that was shared with the
-- bot using a KeyboardButtonRequestUsers button.
data SharedUser
SharedUser :: UserId -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe [PhotoSize] -> SharedUser
-- | Identifier of the shared user. This number may have more than 32
-- significant bits and some programming languages may have
-- difficulty/silent defects in interpreting it. But it has at most 52
-- significant bits, so 64-bit integers or double-precision float types
-- are safe for storing these identifiers. The bot may not have access to
-- the user and could be unable to use this identifier, unless the user
-- is already known to the bot by some other means.
[sharedUserUserId] :: SharedUser -> UserId
-- | First name of the user, if the name was requested by the bot.
[sharedUserFirstName] :: SharedUser -> Maybe Text
-- | Last name of the user, if the name was requested by the bot.
[sharedUserLastName] :: SharedUser -> Maybe Text
-- | Username of the user, if the username was requested by the bot.
[sharedUserUsername] :: SharedUser -> Maybe Text
-- | Available sizes of the chat photo, if the photo was requested by the
-- bot.3
[sharedUserPhoto] :: SharedUser -> Maybe [PhotoSize]
instance GHC.Show.Show Telegram.Bot.API.Types.SharedUser.SharedUser
instance GHC.Generics.Generic Telegram.Bot.API.Types.SharedUser.SharedUser
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.SharedUser.SharedUser
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.SharedUser.SharedUser
module Telegram.Bot.API.Types.ShippingAddress
-- | This object represents a shipping address.
data ShippingAddress
ShippingAddress :: Text -> Text -> Text -> Text -> Text -> Text -> ShippingAddress
-- | ISO 3166-1 alpha-2 country code.
[shippingAddressCountryCode] :: ShippingAddress -> Text
-- | State, if applicable.
[shippingAddressState] :: ShippingAddress -> Text
-- | City.
[shippingAddressCity] :: ShippingAddress -> Text
-- | First line for the address.
[shippingAddressStreetLine1] :: ShippingAddress -> Text
-- | Second line for the address.
[shippingAddressStreetLine2] :: ShippingAddress -> Text
-- | Address post code.
[shippingAddressPostCode] :: ShippingAddress -> Text
instance GHC.Show.Show Telegram.Bot.API.Types.ShippingAddress.ShippingAddress
instance GHC.Generics.Generic Telegram.Bot.API.Types.ShippingAddress.ShippingAddress
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.ShippingAddress.ShippingAddress
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.ShippingAddress.ShippingAddress
module Telegram.Bot.API.Types.OrderInfo
-- | This object represents information about an order.
data OrderInfo
OrderInfo :: Maybe Text -> Maybe Text -> Maybe Text -> Maybe ShippingAddress -> OrderInfo
-- | User name.
[orderInfoName] :: OrderInfo -> Maybe Text
-- | User's phone number.
[orderInfoPhoneNumber] :: OrderInfo -> Maybe Text
-- | User email.
[orderInfoEmail] :: OrderInfo -> Maybe Text
-- | User shipping address.
[orderInfoShippingAddress] :: OrderInfo -> Maybe ShippingAddress
instance GHC.Show.Show Telegram.Bot.API.Types.OrderInfo.OrderInfo
instance GHC.Generics.Generic Telegram.Bot.API.Types.OrderInfo.OrderInfo
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.OrderInfo.OrderInfo
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.OrderInfo.OrderInfo
module Telegram.Bot.API.Types.ShippingOption
-- | This object represents one shipping option.
data ShippingOption
ShippingOption :: ShippingOptionId -> Text -> [LabeledPrice] -> ShippingOption
-- | Shipping option identifier.
[shippingOptionId] :: ShippingOption -> ShippingOptionId
-- | Option title.
[shippingOptionTitle] :: ShippingOption -> Text
-- | List of price portions.
[shippingOptionPrice] :: ShippingOption -> [LabeledPrice]
instance GHC.Show.Show Telegram.Bot.API.Types.ShippingOption.ShippingOption
instance GHC.Generics.Generic Telegram.Bot.API.Types.ShippingOption.ShippingOption
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.ShippingOption.ShippingOption
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.ShippingOption.ShippingOption
module Telegram.Bot.API.Types.Story
-- | Unique identifier for the story in the chat
newtype StoryId
StoryId :: Int -> StoryId
-- | This object represents a message about a story.
data Story
Story :: Chat -> StoryId -> Story
-- | Chat that posted the story.
[storyChat] :: Story -> Chat
-- | Unique identifier for the story in the chat.
[storyId] :: Story -> StoryId
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.Story.StoryId
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.Story.StoryId
instance GHC.Show.Show Telegram.Bot.API.Types.Story.StoryId
instance GHC.Show.Show Telegram.Bot.API.Types.Story.Story
instance GHC.Generics.Generic Telegram.Bot.API.Types.Story.Story
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.Story.Story
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.Story.Story
module Telegram.Bot.API.Types.SuccessfulPayment
-- | This object contains basic information about a successful payment.
data SuccessfulPayment
SuccessfulPayment :: Text -> Int -> Text -> Maybe ShippingOptionId -> Maybe OrderInfo -> Text -> Text -> SuccessfulPayment
-- | Three-letter ISO 4217 currency code.
[successfulPaymentCurrency] :: SuccessfulPayment -> Text
-- | Total price in the smallest units of the currency (integer, not
-- float/double). For example, for a price of US$ 1.45 pass amount = 145.
-- See the exp parameter in currencies.json, it shows the number of
-- digits past the decimal point for each currency (2 for the majority of
-- currencies).
[successfulPaymentTotalAmount] :: SuccessfulPayment -> Int
-- | Bot specified invoice payload.
[successfulPaymentInvoicePayload] :: SuccessfulPayment -> Text
-- | Identifier of the shipping option chosen by the user.
[successfulPaymentShippingOptionId] :: SuccessfulPayment -> Maybe ShippingOptionId
-- | Order info provided by the user.
[successfulPaymentOrderInfo] :: SuccessfulPayment -> Maybe OrderInfo
-- | Telegram payment identifier.
[successfulPaymentTelegramPaymentChargeId] :: SuccessfulPayment -> Text
-- | Provider payment identifier.
[successfulPaymentProviderPaymentChargeId] :: SuccessfulPayment -> Text
instance GHC.Show.Show Telegram.Bot.API.Types.SuccessfulPayment.SuccessfulPayment
instance GHC.Generics.Generic Telegram.Bot.API.Types.SuccessfulPayment.SuccessfulPayment
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.SuccessfulPayment.SuccessfulPayment
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.SuccessfulPayment.SuccessfulPayment
module Telegram.Bot.API.Types.SwitchInlineQueryChosenChat
-- | This object represents an inline button that switches the current user
-- to inline mode in a chosen chat, with an optional default inline
-- query.
data SwitchInlineQueryChosenChat
SwitchInlineQueryChosenChat :: Maybe Text -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> SwitchInlineQueryChosenChat
-- | The default inline query to be inserted in the input field. If left
-- empty, only the bot's username will be inserted.
[switchInlineQueryChosenChatQuery] :: SwitchInlineQueryChosenChat -> Maybe Text
-- | True, if private chats with users can be chosen.
[switchInlineQueryChosenChatAllowUserChats] :: SwitchInlineQueryChosenChat -> Maybe Bool
-- | True, if private chats with bots can be chosen.
[switchInlineQueryChosenChatAllowBotChats] :: SwitchInlineQueryChosenChat -> Maybe Bool
-- | True, if group and supergroup chats can be chosen.
[switchInlineQueryChosenChatAllowGroupChats] :: SwitchInlineQueryChosenChat -> Maybe Bool
-- | True, if channel chats can be chosen.
[switchInlineQueryChosenChatAllowChannelChats] :: SwitchInlineQueryChosenChat -> Maybe Bool
instance GHC.Generics.Generic Telegram.Bot.API.Types.SwitchInlineQueryChosenChat.SwitchInlineQueryChosenChat
instance GHC.Show.Show Telegram.Bot.API.Types.SwitchInlineQueryChosenChat.SwitchInlineQueryChosenChat
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.SwitchInlineQueryChosenChat.SwitchInlineQueryChosenChat
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.SwitchInlineQueryChosenChat.SwitchInlineQueryChosenChat
module Telegram.Bot.API.Types.InlineKeyboardButton
-- | This object represents one button of an inline keyboard. You must use
-- exactly one of the optional fields.
data InlineKeyboardButton
InlineKeyboardButton :: Text -> Maybe Text -> Maybe Text -> Maybe WebAppInfo -> Maybe LoginUrl -> Maybe Text -> Maybe Text -> Maybe SwitchInlineQueryChosenChat -> Maybe CallbackGame -> Maybe Bool -> InlineKeyboardButton
-- | Label text on the button
[inlineKeyboardButtonText] :: InlineKeyboardButton -> Text
-- | HTTP url to be opened when button is pressed
[inlineKeyboardButtonUrl] :: InlineKeyboardButton -> Maybe Text
-- | Data to be sent in a callback query to the bot when button is pressed,
-- 1-64 bytes
[inlineKeyboardButtonCallbackData] :: InlineKeyboardButton -> Maybe Text
-- | Description of the Web App that will be launched when the user presses
-- the button. The Web App will be able to send an arbitrary message on
-- behalf of the user using the method answerWebAppQuery.
-- Available only in private chats between a user and the bot.
[inlineKeyboardButtonWebApp] :: InlineKeyboardButton -> Maybe WebAppInfo
-- | An HTTPS URL used to automatically authorize the user. Can be used as
-- a replacement for the Telegram Login Widget.
[inlineKeyboardButtonLoginUrl] :: InlineKeyboardButton -> Maybe LoginUrl
-- | If set, pressing the button will prompt the user to select one of
-- their chats, open that chat and insert the bot‘s username and the
-- specified inline query in the input field. Can be empty, in which case
-- just the bot’s username will be inserted.
[inlineKeyboardButtonSwitchInlineQuery] :: InlineKeyboardButton -> Maybe Text
-- | If set, pressing the button will insert the bot‘s username and the
-- specified inline query in the current chat's input field. Can be
-- empty, in which case only the bot’s username will be inserted.
[inlineKeyboardButtonSwitchInlineQueryCurrentChat] :: InlineKeyboardButton -> Maybe Text
-- | If set, pressing the button will prompt the user to select one of
-- their chats of the specified type, open that chat and insert the bot's
-- username and the specified inline query in the input field.
[inlineKeyboardButtonSwitchInlineQueryChosenChat] :: InlineKeyboardButton -> Maybe SwitchInlineQueryChosenChat
-- | Description of the game that will be launched when the user presses
-- the button.
[inlineKeyboardButtonCallbackGame] :: InlineKeyboardButton -> Maybe CallbackGame
-- | Specify True, to send a Pay button.
[inlineKeyboardButtonPay] :: InlineKeyboardButton -> Maybe Bool
labeledInlineKeyboardButton :: Text -> InlineKeyboardButton
instance GHC.Show.Show Telegram.Bot.API.Types.InlineKeyboardButton.InlineKeyboardButton
instance GHC.Generics.Generic Telegram.Bot.API.Types.InlineKeyboardButton.InlineKeyboardButton
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.InlineKeyboardButton.InlineKeyboardButton
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.InlineKeyboardButton.InlineKeyboardButton
module Telegram.Bot.API.Types.InlineKeyboardMarkup
-- | This object represents an inline keyboard that appears right next to
-- the message it belongs to.
--
--
-- - *Note**: This will only work in Telegram versions released after 9
-- April, 2016. Older clients will display unsupported message.
--
data InlineKeyboardMarkup
InlineKeyboardMarkup :: [[InlineKeyboardButton]] -> InlineKeyboardMarkup
-- | Array of button rows, each represented by an Array of
-- InlineKeyboardButton objects
[inlineKeyboardMarkupInlineKeyboard] :: InlineKeyboardMarkup -> [[InlineKeyboardButton]]
instance GHC.Show.Show Telegram.Bot.API.Types.InlineKeyboardMarkup.InlineKeyboardMarkup
instance GHC.Generics.Generic Telegram.Bot.API.Types.InlineKeyboardMarkup.InlineKeyboardMarkup
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.InlineKeyboardMarkup.InlineKeyboardMarkup
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.InlineKeyboardMarkup.InlineKeyboardMarkup
module Telegram.Bot.API.Types.SomeReplyMarkup
-- | Additional interface options. A JSON-serialized object for an inline
-- keyboard, custom reply keyboard, instructions to remove reply keyboard
-- or to force a reply from the user.
data SomeReplyMarkup
SomeInlineKeyboardMarkup :: InlineKeyboardMarkup -> SomeReplyMarkup
SomeReplyKeyboardMarkup :: ReplyKeyboardMarkup -> SomeReplyMarkup
SomeReplyKeyboardRemove :: ReplyKeyboardRemove -> SomeReplyMarkup
SomeForceReply :: ForceReply -> SomeReplyMarkup
instance GHC.Generics.Generic Telegram.Bot.API.Types.SomeReplyMarkup.SomeReplyMarkup
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.SomeReplyMarkup.SomeReplyMarkup
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.SomeReplyMarkup.SomeReplyMarkup
module Telegram.Bot.API.Types.User
-- | This object represents a Telegram user or bot.
--
-- https://core.telegram.org/bots/api#user
data User
User :: UserId -> Bool -> Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> User
-- | Unique identifier for this user or bot.
[userId] :: User -> UserId
-- | True, if this user is a bot.
[userIsBot] :: User -> Bool
-- | User's or bot's first name.
[userFirstName] :: User -> Text
-- | User‘s or bot’s last name.
[userLastName] :: User -> Maybe Text
-- | User‘s or bot’s username.
[userUsername] :: User -> Maybe Text
-- | IETF language tag of the user's language.
[userLanguageCode] :: User -> Maybe Text
-- | True, if this user is a Telegram Premium user.
[userIsPremium] :: User -> Maybe Bool
-- | True, if this user added the bot to the attachment menu.
[userAddedToAttachmentMenu] :: User -> Maybe Bool
-- | True, if the bot can be invited to groups. Returned only in
-- getMe.
[userCanJoinGroups] :: User -> Maybe Bool
-- | True, if privacy mode is disabled for the bot. Returned only in
-- getMe.
[userCanReadAllGroupMessages] :: User -> Maybe Bool
-- | True, if the bot supports inline queries. Returned only in
-- getMe.
[userSupportsInlineQueries] :: User -> Maybe Bool
instance GHC.Generics.Generic Telegram.Bot.API.Types.User.User
instance GHC.Show.Show Telegram.Bot.API.Types.User.User
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.User.User
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.User.User
module Telegram.Bot.API.Types.ShippingQuery
-- | This object contains information about an incoming shipping query.
data ShippingQuery
ShippingQuery :: Text -> User -> Text -> ShippingAddress -> ShippingQuery
-- | Unique query identifier.
[shippingQueryId] :: ShippingQuery -> Text
-- | User who sent the query.
[shippingQueryFrom] :: ShippingQuery -> User
-- | Bot specified invoice payload.
[shippingQueryInvoicePayload] :: ShippingQuery -> Text
-- | User specified shipping address.
[shippingQueryShippingAddress] :: ShippingQuery -> ShippingAddress
instance GHC.Show.Show Telegram.Bot.API.Types.ShippingQuery.ShippingQuery
instance GHC.Generics.Generic Telegram.Bot.API.Types.ShippingQuery.ShippingQuery
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.ShippingQuery.ShippingQuery
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.ShippingQuery.ShippingQuery
module Telegram.Bot.API.Types.ProximityAlertTriggered
-- | This object represents the content of a service message, sent whenever
-- a user in the chat triggers a proximity alert set by another user.
data ProximityAlertTriggered
ProximityAlertTriggered :: User -> User -> Int -> ProximityAlertTriggered
-- | User that triggered the alert.
[proximityAlertTriggeredTraveler] :: ProximityAlertTriggered -> User
-- | User that set the alert.
[proximityAlertTriggeredWatcher] :: ProximityAlertTriggered -> User
-- | The distance between the users.
[proximityAlertTriggeredDistance] :: ProximityAlertTriggered -> Int
instance GHC.Show.Show Telegram.Bot.API.Types.ProximityAlertTriggered.ProximityAlertTriggered
instance GHC.Generics.Generic Telegram.Bot.API.Types.ProximityAlertTriggered.ProximityAlertTriggered
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.ProximityAlertTriggered.ProximityAlertTriggered
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.ProximityAlertTriggered.ProximityAlertTriggered
module Telegram.Bot.API.Types.PreCheckoutQuery
-- | This object contains information about an incoming pre-checkout query.
data PreCheckoutQuery
PreCheckoutQuery :: Text -> User -> Text -> Int -> Text -> Maybe ShippingOptionId -> Maybe OrderInfo -> PreCheckoutQuery
-- | Unique query identifier.
[preCheckoutQueryId] :: PreCheckoutQuery -> Text
-- | User who sent the query.
[preCheckoutQueryFrom] :: PreCheckoutQuery -> User
-- | Three-letter ISO 4217 currency code
[preCheckoutQueryCurrency] :: PreCheckoutQuery -> Text
-- | Total price in the smallest units of the currency (integer, not
-- float/double). For example, for a price of US$ 1.45 pass amount = 145.
-- See the exp parameter in currencies.json, it shows the number of
-- digits past the decimal point for each currency (2 for the majority of
-- currencies).
[preCheckoutQueryTotalAmount] :: PreCheckoutQuery -> Int
-- | Bot specified invoice payload
[preCheckoutQueryInvoicePayload] :: PreCheckoutQuery -> Text
-- | Identifier of the shipping option chosen by the user.
[preCheckoutQueryShippingOptionId] :: PreCheckoutQuery -> Maybe ShippingOptionId
-- | Order info provided by the user.
[preCheckoutQueryOrderInfo] :: PreCheckoutQuery -> Maybe OrderInfo
instance GHC.Show.Show Telegram.Bot.API.Types.PreCheckoutQuery.PreCheckoutQuery
instance GHC.Generics.Generic Telegram.Bot.API.Types.PreCheckoutQuery.PreCheckoutQuery
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.PreCheckoutQuery.PreCheckoutQuery
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.PreCheckoutQuery.PreCheckoutQuery
module Telegram.Bot.API.Types.PollAnswer
-- | This object represents an answer of a user in a non-anonymous poll.
data PollAnswer
PollAnswer :: PollId -> Maybe Chat -> Maybe User -> [Int] -> PollAnswer
-- | Unique poll identifier.
[pollAnswerPollId] :: PollAnswer -> PollId
-- | The chat that changed the answer to the poll, if the voter is
-- anonymous.
[pollAnswerVoterChat] :: PollAnswer -> Maybe Chat
-- | The user that changed the answer to the poll, if the voter isn't
-- anonymous. For backward compatibility, the field user in such objects
-- will contain the user 136817688 (@Channel_Bot).
[pollAnswerUser] :: PollAnswer -> Maybe User
-- | 0-based identifiers of answer options, chosen by the user. May be
-- empty if the user retracted their vote.
[pollAnswerOptionIds] :: PollAnswer -> [Int]
instance GHC.Show.Show Telegram.Bot.API.Types.PollAnswer.PollAnswer
instance GHC.Generics.Generic Telegram.Bot.API.Types.PollAnswer.PollAnswer
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.PollAnswer.PollAnswer
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.PollAnswer.PollAnswer
module Telegram.Bot.API.Types.MessageReactionUpdated
-- | This object represents a change of a reaction on a message performed
-- by a user.
data MessageReactionUpdated
MessageReactionUpdated :: Chat -> MessageId -> Maybe User -> Maybe Chat -> POSIXTime -> [ReactionType] -> [ReactionType] -> MessageReactionUpdated
-- | The chat containing the message.
[messageReactionUpdatedChat] :: MessageReactionUpdated -> Chat
-- | Unique message identifier inside the chat.
[messageReactionUpdatedMessageId] :: MessageReactionUpdated -> MessageId
-- | The user that changed the reaction, if the user isn't anonymous.
[messageReactionUpdatedUser] :: MessageReactionUpdated -> Maybe User
-- | The chat on behalf of which the reaction was changed, if the user is
-- anonymous.
[messageReactionUpdatedActorChat] :: MessageReactionUpdated -> Maybe Chat
-- | Date of the change in Unix time.
[messageReactionUpdatedDate] :: MessageReactionUpdated -> POSIXTime
-- | Previous list of reaction types that were set by the user.
[messageReactionUpdatedOldReaction] :: MessageReactionUpdated -> [ReactionType]
-- | New list of reaction types that have been set by the user.
[messageReactionUpdatedNewReaction] :: MessageReactionUpdated -> [ReactionType]
instance GHC.Show.Show Telegram.Bot.API.Types.MessageReactionUpdated.MessageReactionUpdated
instance GHC.Generics.Generic Telegram.Bot.API.Types.MessageReactionUpdated.MessageReactionUpdated
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.MessageReactionUpdated.MessageReactionUpdated
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.MessageReactionUpdated.MessageReactionUpdated
module Telegram.Bot.API.Types.MessageOrigin
-- | This object describes the origin of a message. It can be one of
--
--
-- - MessageOriginUser
-- - MessageOriginHiddenUser
-- - MessageOriginChat
-- - MessageOriginChannel
--
data MessageOrigin
-- | The message was originally sent by a known user.
MessageOriginUser :: Text -> POSIXTime -> User -> MessageOrigin
-- | Type of the message origin, always “user”.
[messageOriginUserType] :: MessageOrigin -> Text
-- | Date the message was sent originally in Unix time.
[messageOriginUserDate] :: MessageOrigin -> POSIXTime
-- | User that sent the message originally.
[messageOriginUserSenderUser] :: MessageOrigin -> User
-- | The message was originally sent by an unknown user.
MessageOriginHiddenUser :: Text -> POSIXTime -> Text -> MessageOrigin
-- | Type of the message origin, always “hidden_user”.
[messageOriginHiddenUserType] :: MessageOrigin -> Text
-- | Date the message was sent originally in Unix time.
[messageOriginHiddenUserDate] :: MessageOrigin -> POSIXTime
-- | Name of the user that sent the message originally.
[messageOriginHiddenUserSenderUserName] :: MessageOrigin -> Text
-- | The message was originally sent on behalf of a chat to a group chat.
MessageOriginChat :: Text -> POSIXTime -> Chat -> Maybe Text -> MessageOrigin
-- | Type of the message origin, always “chat”.
[messageOriginChatType] :: MessageOrigin -> Text
-- | Date the message was sent originally in Unix time.
[messageOriginChatDate] :: MessageOrigin -> POSIXTime
-- | Chat that sent the message originally.
[messageOriginChatSenderChat] :: MessageOrigin -> Chat
-- | For messages originally sent by an anonymous chat administrator,
-- original message author signature.
[messageOriginChatAuthorSignature] :: MessageOrigin -> Maybe Text
-- | The message was originally sent to a channel chat.
MessageOriginChannel :: Text -> POSIXTime -> Chat -> MessageId -> Maybe Text -> MessageOrigin
-- | Type of the message origin, always “channel”.
[messageOriginChannelType] :: MessageOrigin -> Text
-- | Date the message was sent originally in Unix time.
[messageOriginChannelDate] :: MessageOrigin -> POSIXTime
-- | Channel chat to which the message was originally sent.
[messageOriginChannelChat] :: MessageOrigin -> Chat
-- | Unique message identifier inside the chat.
[messageOriginChannelMessageId] :: MessageOrigin -> MessageId
-- | Signature of the original post author.
[messageOriginChannelAuthorSignature] :: MessageOrigin -> Maybe Text
instance GHC.Show.Show Telegram.Bot.API.Types.MessageOrigin.MessageOrigin
instance GHC.Generics.Generic Telegram.Bot.API.Types.MessageOrigin.MessageOrigin
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.MessageOrigin.MessageOrigin
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.MessageOrigin.MessageOrigin
module Telegram.Bot.API.Types.MessageEntity
-- | This object represents one special entity in a text message. For
-- example, hashtags, usernames, URLs, etc.
data MessageEntity
MessageEntity :: MessageEntityType -> Int -> Int -> Maybe Text -> Maybe User -> Maybe Text -> Maybe Text -> MessageEntity
-- | Type of the entity. Can be mention (@username), hashtag, bot_command,
-- url, email, bold (bold text), italic (italic text), underline
-- (underlined text), strikethrough, code (monowidth string), pre
-- (monowidth block), text_link (for clickable text URLs), text_mention
-- (for users without usernames)
[messageEntityType] :: MessageEntity -> MessageEntityType
-- | Offset in UTF-16 code units to the start of the entity
[messageEntityOffset] :: MessageEntity -> Int
-- | Length of the entity in UTF-16 code units
[messageEntityLength] :: MessageEntity -> Int
-- | For “text_link” only, url that will be opened after user taps on the
-- text
[messageEntityUrl] :: MessageEntity -> Maybe Text
-- | For “text_mention” only, the mentioned user
[messageEntityUser] :: MessageEntity -> Maybe User
-- | For “pre” only, the programming language of the entity text.
[messageEntityLanguage] :: MessageEntity -> Maybe Text
-- | For “custom_emoji” only, unique identifier of the custom emoji. Use
-- getCustomEmojiStickers to get full information about the
-- sticker.
[messageEntityCustomEmojiId] :: MessageEntity -> Maybe Text
-- | Type of the entity. Can be mention (@username), hashtag, bot_command,
-- url, email, bold (bold text), italic (italic text), underline
-- (underlined text), strikethrough, code (monowidth string), pre
-- (monowidth block), text_link (for clickable text URLs), text_mention
-- (for users without usernames), cashtag, phone_number
data MessageEntityType
MessageEntityMention :: MessageEntityType
MessageEntityHashtag :: MessageEntityType
MessageEntityBotCommand :: MessageEntityType
MessageEntityUrl :: MessageEntityType
MessageEntityEmail :: MessageEntityType
MessageEntityBold :: MessageEntityType
MessageEntityItalic :: MessageEntityType
-- | See
-- https://core.telegram.org/tdlib/docs/classtd_1_1td__api_1_1text_entity_type_underline.html
MessageEntityUnderline :: MessageEntityType
-- | See
-- https://core.telegram.org/tdlib/docs/classtd_1_1td__api_1_1text_entity_type_strikethrough.html
MessageEntityStrikethrough :: MessageEntityType
MessageEntitySpoiler :: MessageEntityType
MessageEntityBlockquote :: MessageEntityType
MessageEntityCode :: MessageEntityType
MessageEntityPre :: MessageEntityType
MessageEntityTextLink :: MessageEntityType
MessageEntityTextMention :: MessageEntityType
-- | See
-- https://core.telegram.org/tdlib/docs/classtd_1_1td__api_1_1text_entity_type_cashtag.html.
MessageEntityCashtag :: MessageEntityType
-- | See
-- https://core.telegram.org/tdlib/docs/classtd_1_1td__api_1_1text_entity_type_phone_number.html.
MessageEntityPhoneNumber :: MessageEntityType
MessageEntityCustomEmoji :: MessageEntityType
instance GHC.Generics.Generic Telegram.Bot.API.Types.MessageEntity.MessageEntityType
instance GHC.Show.Show Telegram.Bot.API.Types.MessageEntity.MessageEntityType
instance GHC.Classes.Eq Telegram.Bot.API.Types.MessageEntity.MessageEntityType
instance GHC.Show.Show Telegram.Bot.API.Types.MessageEntity.MessageEntity
instance GHC.Generics.Generic Telegram.Bot.API.Types.MessageEntity.MessageEntity
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.MessageEntity.MessageEntity
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.MessageEntity.MessageEntity
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.MessageEntity.MessageEntityType
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.MessageEntity.MessageEntityType
module Telegram.Bot.API.Types.TextQuote
-- | This object contains information about the quoted part of a message
-- that is replied to by the given message.
data TextQuote
TextQuote :: Text -> Maybe [MessageEntity] -> Int -> Maybe Bool -> TextQuote
-- | Text of the quoted part of a message that is replied to by the given
-- message.
[textQuoteText] :: TextQuote -> Text
-- | Special entities that appear in the quote. Currently, only
-- bold, italic, underline,
-- strikethrough, spoiler, and custom_emoji
-- entities are kept in quotes.
[textQuoteEntities] :: TextQuote -> Maybe [MessageEntity]
-- | Approximate quote position in the original message in UTF-16 code
-- units as specified by the sender.
[textQuotePosition] :: TextQuote -> Int
-- | True, if the quote was chosen manually by the message sender.
-- Otherwise, the quote was added automatically by the server.
[textQuoteIsManual] :: TextQuote -> Maybe Bool
instance GHC.Generics.Generic Telegram.Bot.API.Types.TextQuote.TextQuote
instance GHC.Show.Show Telegram.Bot.API.Types.TextQuote.TextQuote
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.TextQuote.TextQuote
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.TextQuote.TextQuote
module Telegram.Bot.API.Types.ReplyParameters
-- | Describes reply parameters for the message that is being sent.
data ReplyParameters
ReplyParameters :: MessageId -> Maybe SomeChatId -> Maybe Bool -> Maybe Text -> Maybe ParseMode -> Maybe [MessageEntity] -> Maybe Int -> ReplyParameters
-- | Identifier of the message that will be replied to in the current chat,
-- or in the chat chat_id if it is specified.
[replyParametersMessageId] :: ReplyParameters -> MessageId
-- | f the message to be replied to is from a different chat, unique
-- identifier for the chat or username of the channel (in the format
-- @channelusername).
[replyParametersChatId] :: ReplyParameters -> Maybe SomeChatId
-- | Pass True if the message should be sent even if the specified
-- message to be replied to is not found; can be used only for replies in
-- the same chat and forum topic.
[replyParametersAllowSendingWithoutReply] :: ReplyParameters -> Maybe Bool
-- | Quoted part of the message to be replied to; 0-1024 characters after
-- entities parsing. The quote must be an exact substring of the message
-- to be replied to, including bold, italic,
-- underline, strikethrough, spoiler, and
-- custom_emoji entities. The message will fail to send if the
-- quote isn't found in the original message.
[replyParametersQuote] :: ReplyParameters -> Maybe Text
-- | Mode for parsing entities in the quote. See formatting options for
-- more details.
[replyParametersQuoteParseMode] :: ReplyParameters -> Maybe ParseMode
-- | A JSON-serialized list of special entities that appear in the quote.
-- It can be specified instead of quote_parse_mode.
[replyParametersQuoteEntities] :: ReplyParameters -> Maybe [MessageEntity]
-- | Position of the quote in the original message in UTF-16 code units.
[replyParametersQuotePosition] :: ReplyParameters -> Maybe Int
instance GHC.Show.Show Telegram.Bot.API.Types.ReplyParameters.ReplyParameters
instance GHC.Generics.Generic Telegram.Bot.API.Types.ReplyParameters.ReplyParameters
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.ReplyParameters.ReplyParameters
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.ReplyParameters.ReplyParameters
module Telegram.Bot.API.Types.PollOption
-- | This object contains information about one answer option in a poll.
data PollOption
PollOption :: Text -> Maybe [MessageEntity] -> Int -> PollOption
-- | Option text, 1-100 characters.
[pollOptionText] :: PollOption -> Text
-- | Special entities that appear in the option text. Currently,
-- only custom emoji entities are allowed in poll option texts.
[pollOptionEntities] :: PollOption -> Maybe [MessageEntity]
-- | Number of users that voted for this option.
[pollOptionVoterCount] :: PollOption -> Int
instance GHC.Show.Show Telegram.Bot.API.Types.PollOption.PollOption
instance GHC.Generics.Generic Telegram.Bot.API.Types.PollOption.PollOption
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.PollOption.PollOption
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.PollOption.PollOption
module Telegram.Bot.API.Types.Poll
data Poll
Poll :: PollId -> Text -> Maybe [MessageEntity] -> [PollOption] -> Int -> Bool -> Bool -> PollType -> Bool -> Maybe Int -> Maybe Text -> Maybe [MessageEntity] -> Maybe Seconds -> Maybe POSIXTime -> Poll
-- | Unique poll identifier.
[pollId] :: Poll -> PollId
-- | Poll question, 1-300 characters.
[pollQuestion] :: Poll -> Text
-- | Special entities that appear in the question. Currently, only
-- custom emoji entities are allowed in poll questions.
[pollQuestionEntities] :: Poll -> Maybe [MessageEntity]
-- | List of poll options.
[pollOptions] :: Poll -> [PollOption]
-- | Total number of users that voted in the poll.
[pollTotalVoterCount] :: Poll -> Int
-- | True, if the poll is closed.
[pollIsClosed] :: Poll -> Bool
-- | True, if the poll is anonymous.
[pollIsAnonymous] :: Poll -> Bool
-- | Poll type, currently can be “regular” or “quiz”.
[pollType] :: Poll -> PollType
-- | True, if the poll allows multiple answers.
[pollAllowsMultipleAnswers] :: Poll -> Bool
-- | 0-based identifier of the correct answer option. Available only for
-- polls in the quiz mode, which are closed, or was sent (not forwarded)
-- by the bot or to the private chat with the bot.
[pollCorrectOptionId] :: Poll -> Maybe Int
-- | Text that is shown when a user chooses an incorrect answer or taps on
-- the lamp icon in a quiz-style poll, 0-200 characters.
[pollExplanation] :: Poll -> Maybe Text
-- | Special entities like usernames, URLs, bot commands, etc. that appear
-- in the explanation.
[pollExplanationEntities] :: Poll -> Maybe [MessageEntity]
-- | Amount of time in seconds the poll will be active after creation.
[pollOpenPeriod] :: Poll -> Maybe Seconds
-- | Point in time (Unix timestamp) when the poll will be automatically
-- closed.
[pollCloseData] :: Poll -> Maybe POSIXTime
instance GHC.Show.Show Telegram.Bot.API.Types.Poll.Poll
instance GHC.Generics.Generic Telegram.Bot.API.Types.Poll.Poll
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.Poll.Poll
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.Poll.Poll
module Telegram.Bot.API.Types.InputPollOption
-- | This object contains information about one answer option in a poll to
-- send.
data InputPollOption
InputPollOption :: Text -> Maybe ParseMode -> Maybe [MessageEntity] -> InputPollOption
-- | Option text, 1-100 characters.
[inputPollOptionText] :: InputPollOption -> Text
-- | Mode for parsing entities in the text. See formatting options
-- for more details. Currently, only custom emoji entities are allowed.
[inputPollOptionTextParseMode] :: InputPollOption -> Maybe ParseMode
-- | A JSON-serialized list of special entities that appear in the poll
-- option text. It can be specified instead of text_parse_mode.
[inputPollOptionTextEntities] :: InputPollOption -> Maybe [MessageEntity]
instance GHC.Show.Show Telegram.Bot.API.Types.InputPollOption.InputPollOption
instance GHC.Generics.Generic Telegram.Bot.API.Types.InputPollOption.InputPollOption
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.InputPollOption.InputPollOption
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.InputPollOption.InputPollOption
module Telegram.Bot.API.Types.InputMedia
-- | Generic fields for all InputMedia structures
data InputMediaGeneric
InputMediaGeneric :: InputFile -> Maybe Text -> Maybe Text -> Maybe [MessageEntity] -> InputMediaGeneric
-- | File to send. Pass a file_id to send a file that exists on the
-- Telegram servers (recommended), pass an HTTP URL for Telegram to get a
-- file from the Internet, or pass “attach:/file_attach_name”
-- to upload a new one using multipartform-data under
-- file_attach_name name.
[inputMediaGenericMedia] :: InputMediaGeneric -> InputFile
-- | Caption of the photo to be sent, 0-1024 characters after entities
-- parsing.
[inputMediaGenericCaption] :: InputMediaGeneric -> Maybe Text
-- | Mode for parsing entities in the photo caption. See formatting options
-- https://core.telegram.org/bots/api#formatting-options for more
-- details.
[inputMediaGenericParseMode] :: InputMediaGeneric -> Maybe Text
-- | List of special entities that appear in the caption, which can be
-- specified instead of parse_mode.
[inputMediaGenericCaptionEntities] :: InputMediaGeneric -> Maybe [MessageEntity]
data InputMediaGenericThumbnail
InputMediaGenericThumbnail :: InputMediaGeneric -> Maybe InputFile -> InputMediaGenericThumbnail
[inputMediaGenericGeneric] :: InputMediaGenericThumbnail -> InputMediaGeneric
-- | Thumbnail of the file sent; can be ignored if thumbnail generation for
-- the file is supported server-side. The thumbnail should be in JPEG
-- format and less than 200 kB in size. A thumbnail's width and height
-- should not exceed 320. Ignored if the file is not uploaded using
-- multipartform-data. Thumbnails can't be reused and can be only
-- uploaded as a new file, so you can pass
-- “attach:file_attach_name” if the thumbnail was uploaded
-- using multipartform-data under file_attach_name.
[inputMediaGenericThumbnail] :: InputMediaGenericThumbnail -> Maybe InputFile
data InputMedia
-- | Represents a photo to be sent.
InputMediaPhoto :: InputMediaGeneric -> Maybe Bool -> InputMedia
[inputMediaPhotoGeneric] :: InputMedia -> InputMediaGeneric
-- | Pass True if the video needs to be covered with a spoiler
-- animation.
[inputMediaPhotoHasSpoiler] :: InputMedia -> Maybe Bool
-- | Represents a video to be sent.
InputMediaVideo :: InputMediaGenericThumbnail -> Maybe Integer -> Maybe Integer -> Maybe Integer -> Maybe Bool -> Maybe Bool -> InputMedia
[inputMediaVideoGeneric] :: InputMedia -> InputMediaGenericThumbnail
-- | Video width
[inputMediaVideoWidth] :: InputMedia -> Maybe Integer
-- | Video height
[inputMediaVideoHeight] :: InputMedia -> Maybe Integer
-- | Video duration in seconds
[inputMediaVideoDuration] :: InputMedia -> Maybe Integer
-- | Pass True, if the uploaded video is suitable for streaming.
[inputMediaVideoSupportsStreaming] :: InputMedia -> Maybe Bool
-- | Pass True if the video needs to be covered with a spoiler
-- animation.
[inputMediaVideoHasSpoiler] :: InputMedia -> Maybe Bool
-- | Represents an animation file (GIF or H.264/MPEG-4 AVC video without
-- sound) to be sent.
InputMediaAnimation :: InputMediaGenericThumbnail -> Maybe Integer -> Maybe Integer -> Maybe Integer -> Maybe Bool -> InputMedia
[inputMediaAnimationGeneric] :: InputMedia -> InputMediaGenericThumbnail
-- | Animation width
[inputMediaAnimationWidth] :: InputMedia -> Maybe Integer
-- | Animation height
[inputMediaAnimationHeight] :: InputMedia -> Maybe Integer
-- | Animation duration in seconds
[inputMediaAnimationDuration] :: InputMedia -> Maybe Integer
-- | Pass True if the video needs to be covered with a spoiler
-- animation.
[inputMediaAnimationHasSpoiler] :: InputMedia -> Maybe Bool
-- | Represents an audio file to be treated as music to be sent.
InputMediaAudio :: InputMediaGenericThumbnail -> Maybe Integer -> Maybe Text -> Maybe Text -> InputMedia
[inputMediaAudioGeneric] :: InputMedia -> InputMediaGenericThumbnail
-- | Duration of the audio in seconds
[inputMediaAudioDuration] :: InputMedia -> Maybe Integer
-- | Performer of the audio
[inputMediaAudioPerformer] :: InputMedia -> Maybe Text
-- | Title of the audio
[inputMediaAudioTitle] :: InputMedia -> Maybe Text
-- | Represents a general file to be sent.
InputMediaDocument :: InputMediaGenericThumbnail -> Maybe Bool -> InputMedia
[inputMediaDocumentGeneric] :: InputMedia -> InputMediaGenericThumbnail
-- | Disables automatic server-side content type detection for files
-- uploaded using multipart/form-data. Always True, if the document is
-- sent as part of an album.
[inputMediaDocumentDisableContentTypeDetection] :: InputMedia -> Maybe Bool
type ContentType = Text
data InputFile
InputFileId :: FileId -> InputFile
FileUrl :: Text -> InputFile
InputFile :: FilePath -> ContentType -> InputFile
-- | Multipart file helper
makeFile :: Text -> InputFile -> MultipartData Tmp -> MultipartData Tmp
instance GHC.Show.Show Telegram.Bot.API.Types.InputMedia.InputFile
instance GHC.Generics.Generic Telegram.Bot.API.Types.InputMedia.InputFile
instance GHC.Generics.Generic Telegram.Bot.API.Types.InputMedia.InputMediaGeneric
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.InputMedia.InputMedia
instance Servant.Multipart.API.ToMultipart Servant.Multipart.API.Tmp Telegram.Bot.API.Types.InputMedia.InputMedia
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.InputMedia.InputMediaGenericThumbnail
instance Servant.Multipart.API.ToMultipart Servant.Multipart.API.Tmp Telegram.Bot.API.Types.InputMedia.InputMediaGenericThumbnail
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.InputMedia.InputMediaGeneric
instance Servant.Multipart.API.ToMultipart Servant.Multipart.API.Tmp Telegram.Bot.API.Types.InputMedia.InputMediaGeneric
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.InputMedia.InputFile
module Telegram.Bot.API.Types.Sticker
data InputSticker
InputSticker :: InputFile -> Text -> [Text] -> Maybe MaskPosition -> Maybe [Text] -> InputSticker
-- | The added sticker. Pass a file_id as a String to send a file that
-- already exists on the Telegram servers, pass an HTTP URL as a String
-- for Telegram to get a file from the Internet, upload a new one using
-- multipart/form-data, or pass
-- attach://file_attach_name to upload a new one using
-- multipart/form-data under file_attach_name
-- name. Animated and video stickers can't be uploaded via HTTP URL.
[$sel:inputStickerSticker:InputSticker] :: InputSticker -> InputFile
-- | Format of the added sticker, must be one of “static” for a
-- .WEBP or .PNG image, “animated” for a .TGS
-- animation, “video” for a WEBM video.
[$sel:inputStickerFormat:InputSticker] :: InputSticker -> Text
-- | List of 1-20 emoji associated with the sticker.
[$sel:inputStickerEmojiList:InputSticker] :: InputSticker -> [Text]
-- | Position where the mask should be placed on faces. For “mask” stickers
-- only.
[$sel:inputStickerMaskPosition:InputSticker] :: InputSticker -> Maybe MaskPosition
-- | List of 0-20 search keywords for the sticker with total length of up
-- to 64 characters. For “regular” and “custom_emoji” stickers only.
[$sel:inputStickerKeywords:InputSticker] :: InputSticker -> Maybe [Text]
-- | This object represents a sticker.
data Sticker
Sticker :: FileId -> FileId -> Int -> Int -> Bool -> Bool -> Maybe PhotoSize -> Maybe Text -> Maybe Text -> Maybe File -> Maybe MaskPosition -> Maybe Text -> Maybe Integer -> Maybe Bool -> Sticker
-- | Identifier for this file, which can be used to download or reuse the
-- file.
[$sel:stickerFileId:Sticker] :: Sticker -> FileId
-- | Unique identifier for this file, which is supposed to be the same over
-- time and for different bots. Can't be used to download or reuse the
-- file.
[$sel:stickerFileUniqueId:Sticker] :: Sticker -> FileId
-- | Sticker width.
[$sel:stickerWidth:Sticker] :: Sticker -> Int
-- | Sticker height.
[$sel:stickerHeight:Sticker] :: Sticker -> Int
-- | True, if the sticker is animated.
[$sel:stickerIsAnimated:Sticker] :: Sticker -> Bool
-- | True, if the sticker is a video sticker.
[$sel:stickerIsVideo:Sticker] :: Sticker -> Bool
-- | Sticker thumbnail in the .WEBP or .JPG format.
[$sel:stickerThumbnail:Sticker] :: Sticker -> Maybe PhotoSize
-- | Emoji associated with the sticker.
[$sel:stickerEmoji:Sticker] :: Sticker -> Maybe Text
-- | Name of the sticker set to which the sticker belongs.
[$sel:stickerSetName:Sticker] :: Sticker -> Maybe Text
-- | For premium regular stickers, premium animation for the sticker.
[$sel:stickerPremiumAnimation:Sticker] :: Sticker -> Maybe File
-- | For mask stickers, the position where the mask should be placed.
[$sel:stickerMaskPosition:Sticker] :: Sticker -> Maybe MaskPosition
-- | For custom emoji stickers, unique identifier of the custom emoji.
[$sel:stickerCustomEmojiId:Sticker] :: Sticker -> Maybe Text
-- | File size in bytes.
[$sel:stickerFileSize:Sticker] :: Sticker -> Maybe Integer
-- | Pass True if stickers in the sticker set must be repainted to
-- the color of text when used in messages, the accent color if used as
-- emoji status, white on chat photos, or another appropriate color based
-- on context; for custom emoji sticker sets only.
[$sel:stickerNeedsRepainting:Sticker] :: Sticker -> Maybe Bool
-- | This object represents a sticker set.
data StickerSet
StickerSet :: Text -> Text -> StickerSetType -> Maybe Bool -> [Sticker] -> Maybe PhotoSize -> StickerSet
-- | Sticker set name.
[$sel:stickerSetName:StickerSet] :: StickerSet -> Text
-- | Sticker set title.
[$sel:stickerSetTitle:StickerSet] :: StickerSet -> Text
-- | Type of stickers in the set, currently one of “regular”, “mask”,
-- “custom_emoji”.
[$sel:stickerSetType:StickerSet] :: StickerSet -> StickerSetType
-- | True, if the sticker set contains masks.
[$sel:stickerSetContainsMasks:StickerSet] :: StickerSet -> Maybe Bool
-- | List of all set stickers.
[$sel:stickerSetStickers:StickerSet] :: StickerSet -> [Sticker]
-- | Sticker set thumbnail in the .WEBP or .TGS format.
[$sel:stickerSetThumbnail:StickerSet] :: StickerSet -> Maybe PhotoSize
-- | Type of stickers in the set, currently one of “regular”, “mask”,
-- “custom_emoji”.
data StickerSetType
StickerSetTypeRegular :: StickerSetType
StickerSetTypeMask :: StickerSetType
StickerSetTypeCustomEmoji :: StickerSetType
instance GHC.Show.Show Telegram.Bot.API.Types.Sticker.InputSticker
instance GHC.Generics.Generic Telegram.Bot.API.Types.Sticker.InputSticker
instance GHC.Show.Show Telegram.Bot.API.Types.Sticker.Sticker
instance GHC.Generics.Generic Telegram.Bot.API.Types.Sticker.Sticker
instance GHC.Generics.Generic Telegram.Bot.API.Types.Sticker.StickerSetType
instance GHC.Show.Show Telegram.Bot.API.Types.Sticker.StickerSetType
instance GHC.Classes.Eq Telegram.Bot.API.Types.Sticker.StickerSetType
instance GHC.Show.Show Telegram.Bot.API.Types.Sticker.StickerSet
instance GHC.Generics.Generic Telegram.Bot.API.Types.Sticker.StickerSet
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.Sticker.StickerSet
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.Sticker.StickerSet
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.Sticker.StickerSetType
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.Sticker.StickerSetType
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.Sticker.Sticker
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.Sticker.Sticker
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.Sticker.InputSticker
module Telegram.Bot.API.Types.BusinessIntro
-- | Contains information about the start page settings of a Telegram
-- Business account.
data BusinessIntro
BusinessIntro :: Maybe Text -> Maybe Text -> Maybe Sticker -> BusinessIntro
-- | Title text of the business intro.
[businessIntroTitle] :: BusinessIntro -> Maybe Text
-- | Message text of the business intro.
[businessIntroMessage] :: BusinessIntro -> Maybe Text
-- | Sticker of the business intro.
[businessIntroSticker] :: BusinessIntro -> Maybe Sticker
instance GHC.Show.Show Telegram.Bot.API.Types.BusinessIntro.BusinessIntro
instance GHC.Generics.Generic Telegram.Bot.API.Types.BusinessIntro.BusinessIntro
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.BusinessIntro.BusinessIntro
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.BusinessIntro.BusinessIntro
module Telegram.Bot.API.Types.Game
-- | This object represents a game. Use BotFather to create and edit games,
-- their short names will act as unique identifiers.
data Game
Game :: Text -> Text -> [PhotoSize] -> Maybe Text -> Maybe [MessageEntity] -> Maybe Animation -> Game
-- | Title of the game.
[gameTitle] :: Game -> Text
-- | Description of the game.
[gameDescription] :: Game -> Text
-- | Photo that will be displayed in the game message in chats.
[gamePhoto] :: Game -> [PhotoSize]
-- | Brief description of the game or high scores included in the game
-- message. Can be automatically edited to include current high scores
-- for the game when the bot calls setGameScore, or manually edited using
-- editMessageText. 0-4096 characters.
[gameText] :: Game -> Maybe Text
-- | Special entities that appear in text, such as usernames, URLs, bot
-- commands, etc.
[gameTextEntities] :: Game -> Maybe [MessageEntity]
-- | Animation that will be displayed in the game message in chats. Upload
-- via BotFather.
[gameAnimation] :: Game -> Maybe Animation
instance GHC.Show.Show Telegram.Bot.API.Types.Game.Game
instance GHC.Generics.Generic Telegram.Bot.API.Types.Game.Game
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.Game.Game
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.Game.Game
module Telegram.Bot.API.Types.GiveawayWinners
-- | This object represents a message about the completion of a giveaway
-- with public winners.
data GiveawayWinners
GiveawayWinners :: Chat -> MessageId -> POSIXTime -> Int -> [User] -> Maybe Int -> Maybe Int -> Maybe Int -> Maybe Bool -> Maybe Bool -> Maybe Text -> GiveawayWinners
-- | The chat that created the giveaway.
[giveawayWinnersChat] :: GiveawayWinners -> Chat
-- | Identifier of the messsage with the giveaway in the chat.
[giveawayWinnersGiveawayMessageId] :: GiveawayWinners -> MessageId
-- | Point in time (Unix timestamp) when winners of the giveaway were
-- selected.
[giveawayWinnersWinnersSelectionDate] :: GiveawayWinners -> POSIXTime
-- | Total number of winners in the giveaway.
[giveawayWinnersWinnerCount] :: GiveawayWinners -> Int
-- | List of up to 100 winners of the giveaway.
[giveawayWinnersWinners] :: GiveawayWinners -> [User]
-- | The number of other chats the user had to join in order to be eligible
-- for the giveaway.
[giveawayWinnersAdditionalChatCount] :: GiveawayWinners -> Maybe Int
-- | The number of months the Telegram Premium subscription won from the
-- giveaway will be active for.
[giveawayWinnersPremiumSubscriptionMonthCount] :: GiveawayWinners -> Maybe Int
-- | Number of undistributed prizes.
[giveawayWinnersUnclaimedPrizeCount] :: GiveawayWinners -> Maybe Int
-- | True, if only users who had joined the chats after the giveaway
-- started were eligible to win.
[giveawayWinnersOnlyNewMembers] :: GiveawayWinners -> Maybe Bool
-- | True, if the giveaway was canceled because the payment for it
-- was refunded.
[giveawayWinnersWasRefunded] :: GiveawayWinners -> Maybe Bool
-- | Description of additional giveaway prize.
[giveawayWinnersPrizeDescription] :: GiveawayWinners -> Maybe Text
instance GHC.Show.Show Telegram.Bot.API.Types.GiveawayWinners.GiveawayWinners
instance GHC.Generics.Generic Telegram.Bot.API.Types.GiveawayWinners.GiveawayWinners
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.GiveawayWinners.GiveawayWinners
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.GiveawayWinners.GiveawayWinners
module Telegram.Bot.API.Types.GameHighScore
-- | This object represents one row of the high scores table for a game.
data GameHighScore
GameHighScore :: Int -> User -> Int -> GameHighScore
-- | Position in high score table for the game.
[gameHighScorePosition] :: GameHighScore -> Int
-- | User.
[gameHighScoreUser] :: GameHighScore -> User
-- | Score.
[gameHighScoreScore] :: GameHighScore -> Int
instance GHC.Show.Show Telegram.Bot.API.Types.GameHighScore.GameHighScore
instance GHC.Generics.Generic Telegram.Bot.API.Types.GameHighScore.GameHighScore
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.GameHighScore.GameHighScore
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.GameHighScore.GameHighScore
module Telegram.Bot.API.Types.ChatMember
-- | This object contains information about one member of a chat.
data ChatMember
ChatMember :: User -> Text -> Maybe POSIXTime -> Maybe Bool -> Maybe Text -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> ChatMember
-- | Information about the user
[chatMemberUser] :: ChatMember -> User
-- | The member's status in the chat. Can be “owner”, “administrator”,
-- “member”, “restricted”, “left” or “banned”.
[chatMemberStatus] :: ChatMember -> Text
-- | Restictred and banned only. Date when restrictions will be lifted for
-- this user, unix time.
[chatMemberUntilDate] :: ChatMember -> Maybe POSIXTime
-- | Owners and administrators only. True, if the user's presence in
-- the chat is hidden.
[chatMemberIsAnonymous] :: ChatMember -> Maybe Bool
-- | Owners and administrators only. Custom title for this user.
[chatMemberCustomTitle] :: ChatMember -> Maybe Text
-- | Administrators only. True, if the bot is allowed to edit
-- administrator privileges of that user
[chatMemberCanBeEdited] :: ChatMember -> Maybe Bool
-- | Administrators only. True, if the administrator can access the
-- chat event log, chat statistics, message statistics in channels, see
-- channel members, see anonymous administrators in supergroups and
-- ignore slow mode. Implied by any other administrator privilege.
[chatMemberCanManageChat] :: ChatMember -> Maybe Bool
-- | Administrators only. True, if the administrator can delete
-- messages of other users.
[chatMemberCanDeleteMessages] :: ChatMember -> Maybe Bool
-- | Administrators only. True, if the administrator can manage
-- video (previously, voice) chats.
[chatMemberCanManageVideoChats] :: ChatMember -> Maybe Bool
-- | Administrators only. True, if the administrator can restrict,
-- ban or unban chat members.
[chatMemberCanRestrictMembers] :: ChatMember -> Maybe Bool
-- | Administrators only. True, if the administrator can add new
-- administrators with a subset of his own privileges or demote
-- administrators that he has promoted, directly or indirectly (promoted
-- by administrators that were appointed by the user).
[chatMemberCanPromoteMembers] :: ChatMember -> Maybe Bool
-- | Administrators only. True, if the administrator can change the
-- chat title, photo and other settings.
[chatMemberCanChangeInfo] :: ChatMember -> Maybe Bool
-- | Administrators only. True, if the administrator can post in the
-- channel, channels only.
[chatMemberCanPostMessages] :: ChatMember -> Maybe Bool
-- | Administrators only. True, if the administrator can edit
-- messages of other users and can pin messages, channels only.
[chatMemberCanEditMessages] :: ChatMember -> Maybe Bool
-- | Administrators only. True, if the administrator can post
-- stories in the channel; channels only.
[chatMemberCanPostStories] :: ChatMember -> Maybe Bool
-- | Administrators only. True, if the administrator can edit
-- stories posted by other users; channels only.
[chatMemberCanEditStories] :: ChatMember -> Maybe Bool
-- | Administrators only. True, if the administrator can delete
-- stories posted by other users; channels only.
[chatMemberCanDeleteStories] :: ChatMember -> Maybe Bool
-- | Administrators and restricted only. True, if the administrator
-- can invite new users to the chat.
[chatMemberCanInviteUsers] :: ChatMember -> Maybe Bool
-- | Administrators and restricted only. True, if the administrator
-- can pin messages, supergroups only.
[chatMemberCanPinMessages] :: ChatMember -> Maybe Bool
-- | Administrators and restricted only. True, if the user is
-- allowed to create, rename, close, and reopen forum topics; supergroups
-- only.
[chatMemberCanManageTopics] :: ChatMember -> Maybe Bool
-- | Restricted only. True, if the user is a member of the chat at
-- the moment of the request.
[chatMemberIsMember] :: ChatMember -> Maybe Bool
-- | Restricted only. True, if the user can send text messages,
-- contacts, locations and venues.
[chatMemberCanSendMessages] :: ChatMember -> Maybe Bool
-- | Restricted only. True, if the user is allowed to send audios.
[chatMemberCanSendAudios] :: ChatMember -> Maybe Bool
-- | Restricted only. True, if the user is allowed to send
-- documents.
[chatMemberCanSendDocuments] :: ChatMember -> Maybe Bool
-- | Restricted only. True, if the user is allowed to send photos.
[chatMemberCanSendPhotos] :: ChatMember -> Maybe Bool
-- | Restricted only. True, if the user is allowed to send videos.
[chatMemberCanSendVideos] :: ChatMember -> Maybe Bool
-- | Restricted only. True, if the user is allowed to send video
-- notes.
[chatMemberCanSendVideoNotes] :: ChatMember -> Maybe Bool
-- | Restricted only. True, if the user is allowed to send voice
-- notes.
[chatMemberCanSendVoiceNotes] :: ChatMember -> Maybe Bool
-- | Restricted only. True, if the user is allowed to send polls.
[chatMemberCanSendPolls] :: ChatMember -> Maybe Bool
-- | Restricted only. True, if the user can send animations, games,
-- stickers and use inline bots, implies can_send_media_messages.
[chatMemberCanSendOtherMessages] :: ChatMember -> Maybe Bool
-- | Restricted only. True, if user may add web page previews to his
-- messages, implies can_send_media_messages.
[chatMemberCanAddWebPagePreviews] :: ChatMember -> Maybe Bool
instance GHC.Show.Show Telegram.Bot.API.Types.ChatMember.ChatMember
instance GHC.Generics.Generic Telegram.Bot.API.Types.ChatMember.ChatMember
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.ChatMember.ChatMember
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.ChatMember.ChatMember
module Telegram.Bot.API.Types.ChatInviteLink
-- | Represents an invite link for a chat.
data ChatInviteLink
ChatInviteLink :: Text -> User -> Bool -> Bool -> Bool -> Maybe Text -> Maybe POSIXTime -> Maybe Int -> Maybe Int -> ChatInviteLink
-- | The invite link. If the link was created by another chat
-- administrator, then the second part of the link will be replaced with
-- “…”.
[chatInviteLinkInviteLink] :: ChatInviteLink -> Text
-- | Creator of the link.
[chatInviteLinkCreator] :: ChatInviteLink -> User
-- | True, if users joining the chat via the link need to be
-- approved by chat administrators.
[chatInviteLinkCreatesJoinRequest] :: ChatInviteLink -> Bool
-- | True, if the link is primary.
[chatInviteLinkIsPrimary] :: ChatInviteLink -> Bool
-- | True, if the link is revoked.
[chatInviteLinkIsRevoked] :: ChatInviteLink -> Bool
-- | Invite link name.
[chatInviteLinkName] :: ChatInviteLink -> Maybe Text
-- | Point in time (Unix timestamp) when the link will expire or has been
-- expired.
[chatInviteLinkExpireDate] :: ChatInviteLink -> Maybe POSIXTime
-- | Maximum number of users that can be members of the chat simultaneously
-- after joining the chat via this invite link; 1-99999.
[chatInviteLinkMemberLimit] :: ChatInviteLink -> Maybe Int
-- | Number of pending join requests created using this link.
[chatInviteLinkPendingJoinRequestCount] :: ChatInviteLink -> Maybe Int
instance GHC.Show.Show Telegram.Bot.API.Types.ChatInviteLink.ChatInviteLink
instance GHC.Generics.Generic Telegram.Bot.API.Types.ChatInviteLink.ChatInviteLink
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.ChatInviteLink.ChatInviteLink
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.ChatInviteLink.ChatInviteLink
module Telegram.Bot.API.Types.ChatMemberUpdated
-- | This object represents changes in the status of a chat member.
data ChatMemberUpdated
ChatMemberUpdated :: Chat -> User -> POSIXTime -> ChatMember -> ChatMember -> Maybe ChatInviteLink -> Maybe Bool -> Maybe Bool -> ChatMemberUpdated
-- | Chat the user belongs to.
[chatMemberUpdatedChat] :: ChatMemberUpdated -> Chat
-- | Performer of the action, which resulted in the change.
[chatMemberUpdatedFrom] :: ChatMemberUpdated -> User
-- | Date the change was done in Unix time.
[chatMemberUpdatedDate] :: ChatMemberUpdated -> POSIXTime
-- | Previous information about the chat member.
[chatMemberUpdatedOldChatMember] :: ChatMemberUpdated -> ChatMember
-- | New information about the chat member.
[chatMemberUpdatedNewChatMember] :: ChatMemberUpdated -> ChatMember
-- | Chat invite link, which was used by the user to join the chat; for
-- joining by invite link events only.
[chatMemberUpdatedInviteLink] :: ChatMemberUpdated -> Maybe ChatInviteLink
-- | True, if the user joined the chat after sending a direct join
-- request without using an invite link and being approved by an
-- administrator.
[chatMemberUpdatedViaJoinRequest] :: ChatMemberUpdated -> Maybe Bool
-- | True, if the user joined the chat via a chat folder invite
-- link.
[chatMemberUpdatedViaChatFolderInviteLink] :: ChatMemberUpdated -> Maybe Bool
instance GHC.Show.Show Telegram.Bot.API.Types.ChatMemberUpdated.ChatMemberUpdated
instance GHC.Generics.Generic Telegram.Bot.API.Types.ChatMemberUpdated.ChatMemberUpdated
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.ChatMemberUpdated.ChatMemberUpdated
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.ChatMemberUpdated.ChatMemberUpdated
module Telegram.Bot.API.Types.ChatJoinRequest
-- | Represents a join request sent to a chat.
data ChatJoinRequest
ChatJoinRequest :: Chat -> User -> ChatId -> POSIXTime -> Maybe Text -> Maybe ChatInviteLink -> ChatJoinRequest
-- | Chat to which the request was sent.
[chatJoinRequestChat] :: ChatJoinRequest -> Chat
-- | User that sent the join request.
[chatJoinRequestFrom] :: ChatJoinRequest -> User
-- | Identifier of a private chat with the user who sent the join request.
-- This number may have more than 32 significant bits and some
-- programming languages may have difficulty/silent defects in
-- interpreting it. But it has at most 52 significant bits, so a 64-bit
-- integer or double-precision float type are safe for storing this
-- identifier. The bot can use this identifier for 24 hours to send
-- messages until the join request is processed, assuming no other
-- administrator contacted the user.
[chatJoinRequestUserChatId] :: ChatJoinRequest -> ChatId
-- | Date the request was sent in Unix time.
[chatJoinRequestDate] :: ChatJoinRequest -> POSIXTime
-- | Bio of the user.
[chatJoinRequestBio] :: ChatJoinRequest -> Maybe Text
-- | Chat invite link that was used by the user to send the join request.
[chatJoinRequestInviteLink] :: ChatJoinRequest -> Maybe ChatInviteLink
instance GHC.Show.Show Telegram.Bot.API.Types.ChatJoinRequest.ChatJoinRequest
instance GHC.Generics.Generic Telegram.Bot.API.Types.ChatJoinRequest.ChatJoinRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.ChatJoinRequest.ChatJoinRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.ChatJoinRequest.ChatJoinRequest
module Telegram.Bot.API.Types.ChatBoostSource
-- | This object describes the source of a chat boost. It can be one of
--
--
-- - ChatBoostSourcePremium
-- - ChatBoostSourceGiftCode
-- - ChatBoostSourceGiveaway
--
data ChatBoostSource
-- | The boost was obtained by subscribing to Telegram Premium or by
-- gifting a Telegram Premium subscription to another user.
ChatBoostSourcePremium :: Text -> User -> ChatBoostSource
-- | Source of the boost, always “premium”.
[chatBoostSourcePremiumSource] :: ChatBoostSource -> Text
-- | User that boosted the chat.
[chatBoostSourcePremiumUser] :: ChatBoostSource -> User
-- | The boost was obtained by the creation of Telegram Premium gift codes
-- to boost a chat. Each such code boosts the chat 4 times for the
-- duration of the corresponding Telegram Premium subscription.
ChatBoostSourceGiftCode :: Text -> User -> ChatBoostSource
-- | Source of the boost, always “gift_code”.
[chatBoostSourceGiftCodeSource] :: ChatBoostSource -> Text
-- | User for which the gift code was created.
[chatBoostSourceGiftCodeUser] :: ChatBoostSource -> User
-- | The boost was obtained by the creation of a Telegram Premium giveaway.
-- This boosts the chat 4 times for the duration of the corresponding
-- Telegram Premium subscription.
ChatBoostSourceGiveaway :: Text -> MessageId -> Maybe User -> Maybe Bool -> ChatBoostSource
-- | Source of the boost, always “giveaway”.
[chatBoostSourceGiveawaySource] :: ChatBoostSource -> Text
-- | Identifier of a message in the chat with the giveaway; the message
-- could have been deleted already. May be 0 if the message isn't sent
-- yet.
[chatBoostSourceGiveawayGiveawayMessageId] :: ChatBoostSource -> MessageId
-- | User that won the prize in the giveaway if any
[chatBoostSourceGiveawayUser] :: ChatBoostSource -> Maybe User
-- | True, if the giveaway was completed, but there was no user to
-- win the prize
[chatBoostSourceGiveawayIsUnclaimed] :: ChatBoostSource -> Maybe Bool
instance GHC.Show.Show Telegram.Bot.API.Types.ChatBoostSource.ChatBoostSource
instance GHC.Generics.Generic Telegram.Bot.API.Types.ChatBoostSource.ChatBoostSource
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.ChatBoostSource.ChatBoostSource
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.ChatBoostSource.ChatBoostSource
module Telegram.Bot.API.Types.ChatBoostRemoved
-- | This object represents a boost removed from a chat.
data ChatBoostRemoved
ChatBoostRemoved :: Chat -> BoostId -> POSIXTime -> ChatBoostSource -> ChatBoostRemoved
-- | Chat which was boosted.
[chatBoostRemovedChat] :: ChatBoostRemoved -> Chat
-- | Unique identifier of the boost.
[chatBoostRemovedBoostId] :: ChatBoostRemoved -> BoostId
-- | Point in time (Unix timestamp) when the boost was removed.
[chatBoostRemovedRemoveDate] :: ChatBoostRemoved -> POSIXTime
-- | Source of the removed boost.
[chatBoostRemovedSource] :: ChatBoostRemoved -> ChatBoostSource
instance GHC.Show.Show Telegram.Bot.API.Types.ChatBoostRemoved.ChatBoostRemoved
instance GHC.Generics.Generic Telegram.Bot.API.Types.ChatBoostRemoved.ChatBoostRemoved
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.ChatBoostRemoved.ChatBoostRemoved
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.ChatBoostRemoved.ChatBoostRemoved
module Telegram.Bot.API.Types.ChatBoost
-- | This object contains information about a chat boost.
data ChatBoost
ChatBoost :: BoostId -> POSIXTime -> POSIXTime -> ChatBoostSource -> ChatBoost
-- | Unique identifier of the boost.
[chatBoostBoostId] :: ChatBoost -> BoostId
-- | Point in time (Unix timestamp) when the chat was boosted.
[chatBoostAddTime] :: ChatBoost -> POSIXTime
-- | Point in time (Unix timestamp) when the boost will automatically
-- expire, unless the booster's Telegram Premium subscription is
-- prolonged.
[chatBoostExpirateionDate] :: ChatBoost -> POSIXTime
-- | Source of the added boost.
[chatBoostSource] :: ChatBoost -> ChatBoostSource
instance GHC.Show.Show Telegram.Bot.API.Types.ChatBoost.ChatBoost
instance GHC.Generics.Generic Telegram.Bot.API.Types.ChatBoost.ChatBoost
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.ChatBoost.ChatBoost
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.ChatBoost.ChatBoost
module Telegram.Bot.API.Types.ChatBoostUpdated
-- | This object represents a boost added to a chat or changed.
data ChatBoostUpdated
ChatBoostUpdated :: Chat -> ChatBoost -> ChatBoostUpdated
-- | Chat which was boosted.
[chatBoostUpdatedChat] :: ChatBoostUpdated -> Chat
-- | Infomation about the chat boost.
[chatBoostUpdatedBoost] :: ChatBoostUpdated -> ChatBoost
instance GHC.Show.Show Telegram.Bot.API.Types.ChatBoostUpdated.ChatBoostUpdated
instance GHC.Generics.Generic Telegram.Bot.API.Types.ChatBoostUpdated.ChatBoostUpdated
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.ChatBoostUpdated.ChatBoostUpdated
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.ChatBoostUpdated.ChatBoostUpdated
module Telegram.Bot.API.Types.BusinessConnection
-- | Describes the connection of the bot with a business account.
data BusinessConnection
BusinessConnection :: BusinessConnectionId -> User -> ChatId -> POSIXTime -> Bool -> Bool -> BusinessConnection
-- | Unique identifier of the business connection.
[businessConnectionId] :: BusinessConnection -> BusinessConnectionId
-- | Business account user that created the business connection.
[businessConnectionUser] :: BusinessConnection -> User
-- | Identifier of a private chat with the user who created the business
-- connection. This number may have more than 32 significant bits and
-- some programming languages may have difficulty/silent defects in
-- interpreting it. But it has at most 52 significant bits, so a 64-bit
-- integer or double-precision float type are safe for storing this
-- identifier.
[businessConnectionUserChatId] :: BusinessConnection -> ChatId
-- | Date the connection was established in Unix time.
[businessConnectionDate] :: BusinessConnection -> POSIXTime
-- | True, if the bot can act on behalf of the business account in
-- chats that were active in the last 24 hours.
[businessConnectionCanReply] :: BusinessConnection -> Bool
-- | True, if the connection is active.
[businessConnectionIsEnabled] :: BusinessConnection -> Bool
instance GHC.Show.Show Telegram.Bot.API.Types.BusinessConnection.BusinessConnection
instance GHC.Generics.Generic Telegram.Bot.API.Types.BusinessConnection.BusinessConnection
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.BusinessConnection.BusinessConnection
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.BusinessConnection.BusinessConnection
module Telegram.Bot.API.Types.UserChatBoosts
-- | This object represents a list of boosts added to a chat by a user.
newtype UserChatBoosts
UserChatBoosts :: [ChatBoost] -> UserChatBoosts
[userChatBoostsBosts] :: UserChatBoosts -> [ChatBoost]
instance GHC.Show.Show Telegram.Bot.API.Types.UserChatBoosts.UserChatBoosts
instance GHC.Generics.Generic Telegram.Bot.API.Types.UserChatBoosts.UserChatBoosts
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.UserChatBoosts.UserChatBoosts
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.UserChatBoosts.UserChatBoosts
module Telegram.Bot.API.Types.UserProfilePhotos
-- | This object represent a user's profile pictures.
data UserProfilePhotos
UserProfilePhotos :: Int -> [[PhotoSize]] -> UserProfilePhotos
-- | Total number of profile pictures the target user has
[userProfilePhotosTotalCount] :: UserProfilePhotos -> Int
-- | Requested profile pictures (in up to 4 sizes each)
[userProfilePhotosPhotos] :: UserProfilePhotos -> [[PhotoSize]]
instance GHC.Show.Show Telegram.Bot.API.Types.UserProfilePhotos.UserProfilePhotos
instance GHC.Generics.Generic Telegram.Bot.API.Types.UserProfilePhotos.UserProfilePhotos
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.UserProfilePhotos.UserProfilePhotos
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.UserProfilePhotos.UserProfilePhotos
module Telegram.Bot.API.Types.UserShared
-- | This object contains information about the user whose identifier was
-- shared with the bot using a KeyboardButtonRequestUser button.
data UserShared
UserShared :: RequestId -> UserId -> UserShared
-- | Identifier of the request.
[userSharedRequestId] :: UserShared -> RequestId
-- | Identifier of the shared user. This number may have more than 32
-- significant bits and some programming languages may have
-- difficulty/silent defects in interpreting it. But it has at most 52
-- significant bits, so a 64-bit integer or double-precision float type
-- are safe for storing this identifier. The bot may not have access to
-- the user and could be unable to use this identifier, unless the user
-- is already known to the bot by some other means.
[userSharedUserId] :: UserShared -> UserId
instance GHC.Show.Show Telegram.Bot.API.Types.UserShared.UserShared
instance GHC.Generics.Generic Telegram.Bot.API.Types.UserShared.UserShared
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.UserShared.UserShared
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.UserShared.UserShared
module Telegram.Bot.API.Types.UsersShared
-- | This object contains information about the users whose identifiers
-- were shared with the bot using a KeyboardButtonRequestUsers
-- button.
data UsersShared
UsersShared :: RequestId -> [SharedUser] -> UsersShared
-- | Identifier of the request.
[usersSharedRequestId] :: UsersShared -> RequestId
-- | Information about users shared with the bot.
[usersSharedUserId] :: UsersShared -> [SharedUser]
instance GHC.Show.Show Telegram.Bot.API.Types.UsersShared.UsersShared
instance GHC.Generics.Generic Telegram.Bot.API.Types.UsersShared.UsersShared
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.UsersShared.UsersShared
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.UsersShared.UsersShared
module Telegram.Bot.API.Types.Venue
-- | This object represents a venue.
data Venue
Venue :: Location -> Text -> Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Venue
-- | Venue location.
[venueLocation] :: Venue -> Location
-- | Name of the venue.
[venueTitle] :: Venue -> Text
-- | Address of the venue.
[venueAddress] :: Venue -> Text
-- | Foursquare identifier of the venue.
[venueFoursquareId] :: Venue -> Maybe Text
-- | Foursquare type of the venue. (For example,
-- “arts_entertainmentdefault”, “arts_entertainmentaquarium” or
-- “food/icecream”.)
[venueFoursquareType] :: Venue -> Maybe Text
-- | Google Places identifier of the venue.
[venueGooglePlaceId] :: Venue -> Maybe Text
-- | Google Places type of the venue. (See supported types.)
[venueGooglePlaceType] :: Venue -> Maybe Text
instance GHC.Show.Show Telegram.Bot.API.Types.Venue.Venue
instance GHC.Generics.Generic Telegram.Bot.API.Types.Venue.Venue
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.Venue.Venue
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.Venue.Venue
module Telegram.Bot.API.Types.Video
-- | This object represents a video file.
data Video
Video :: FileId -> FileId -> Int -> Int -> Seconds -> Maybe PhotoSize -> Maybe Text -> Maybe Text -> Maybe Integer -> Video
-- | Unique identifier for this file.
[videoFileId] :: Video -> FileId
-- | Unique identifier for this file, which is supposed to be the same over
-- time and for different bots. Can't be used to download or reuse the
-- file.
[videoFileUniqueId] :: Video -> FileId
-- | Video width as defined by sender.
[videoWidth] :: Video -> Int
-- | Video height as defined by sender.
[videoHeight] :: Video -> Int
-- | Duration of the video in seconds as defined by sender.
[videoDuration] :: Video -> Seconds
-- | Video thumbnail.
[videoThumbnail] :: Video -> Maybe PhotoSize
-- | Original filename as defined by sender.
[videoFileName] :: Video -> Maybe Text
-- | Mime type of a file as defined by sender.
[videoMimeType] :: Video -> Maybe Text
-- | File size in bytes.
[videoFileSize] :: Video -> Maybe Integer
instance GHC.Show.Show Telegram.Bot.API.Types.Video.Video
instance GHC.Generics.Generic Telegram.Bot.API.Types.Video.Video
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.Video.Video
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.Video.Video
module Telegram.Bot.API.Types.VideoChatEnded
-- | This object represents a service message about a video chat ended in
-- the chat.
data VideoChatEnded
VideoChatEnded :: Seconds -> VideoChatEnded
-- | Video chat duration in seconds.
[videoChatEndedDuration] :: VideoChatEnded -> Seconds
data VideoChatParticipantsInvited
VideoChatParticipantsInvited :: Maybe [User] -> VideoChatParticipantsInvited
-- | New members that were invited to the video chat.
[videoChatParticipantsInvitedUsers] :: VideoChatParticipantsInvited -> Maybe [User]
instance GHC.Show.Show Telegram.Bot.API.Types.VideoChatEnded.VideoChatEnded
instance GHC.Generics.Generic Telegram.Bot.API.Types.VideoChatEnded.VideoChatEnded
instance GHC.Show.Show Telegram.Bot.API.Types.VideoChatEnded.VideoChatParticipantsInvited
instance GHC.Generics.Generic Telegram.Bot.API.Types.VideoChatEnded.VideoChatParticipantsInvited
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.VideoChatEnded.VideoChatParticipantsInvited
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.VideoChatEnded.VideoChatParticipantsInvited
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.VideoChatEnded.VideoChatEnded
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.VideoChatEnded.VideoChatEnded
module Telegram.Bot.API.Types.VideoChatScheduled
-- | This object represents a service message about a video chat scheduled
-- in the chat.
data VideoChatScheduled
VideoChatScheduled :: POSIXTime -> VideoChatScheduled
-- | Point in time (Unix timestamp) when the video chat is supposed to be
-- started by a chat administrator.
[videoChatScheduledStartDate] :: VideoChatScheduled -> POSIXTime
instance GHC.Show.Show Telegram.Bot.API.Types.VideoChatScheduled.VideoChatScheduled
instance GHC.Generics.Generic Telegram.Bot.API.Types.VideoChatScheduled.VideoChatScheduled
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.VideoChatScheduled.VideoChatScheduled
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.VideoChatScheduled.VideoChatScheduled
module Telegram.Bot.API.Types.VideoChatStarted
-- | This object represents a service message about a video chat started in
-- the chat. Currently holds no information.
data VideoChatStarted
VideoChatStarted :: VideoChatStarted
instance GHC.Show.Show Telegram.Bot.API.Types.VideoChatStarted.VideoChatStarted
instance GHC.Generics.Generic Telegram.Bot.API.Types.VideoChatStarted.VideoChatStarted
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.VideoChatStarted.VideoChatStarted
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.VideoChatStarted.VideoChatStarted
module Telegram.Bot.API.Types.VideoNote
-- | This object represents a video message (available in Telegram apps as
-- of v.4.0).
data VideoNote
VideoNote :: FileId -> FileId -> Int -> Seconds -> Maybe PhotoSize -> Maybe Integer -> VideoNote
-- | Unique identifier for this file.
[videoNoteFileId] :: VideoNote -> FileId
-- | Unique identifier for this file, which is supposed to be the same over
-- time and for different bots. Can't be used to download or reuse the
-- file.
[videoNoteFileUniqueId] :: VideoNote -> FileId
-- | Video width and height as defined by sender.
[videoNoteLength] :: VideoNote -> Int
-- | Duration of the video in seconds as defined by sender.
[videoNoteDuration] :: VideoNote -> Seconds
-- | Video thumbnail.
[videoNoteThumbnail] :: VideoNote -> Maybe PhotoSize
-- | File size in bytes.
[videoNoteFileSize] :: VideoNote -> Maybe Integer
instance GHC.Show.Show Telegram.Bot.API.Types.VideoNote.VideoNote
instance GHC.Generics.Generic Telegram.Bot.API.Types.VideoNote.VideoNote
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.VideoNote.VideoNote
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.VideoNote.VideoNote
module Telegram.Bot.API.Types.Voice
-- | This object represents a voice note.
data Voice
Voice :: FileId -> FileId -> Seconds -> Maybe Text -> Maybe Integer -> Voice
-- | Unique identifier for this file.
[voiceFileId] :: Voice -> FileId
-- | Unique identifier for this file, which is supposed to be the same over
-- time and for different bots. Can't be used to download or reuse the
-- file.
[voiceFileUniqueId] :: Voice -> FileId
-- | Duration of the audio in seconds as defined by sender.
[voiceDuration] :: Voice -> Seconds
-- | MIME type of the file as defined by sender.
[voiceMimeType] :: Voice -> Maybe Text
-- | File size in bytes.
[voiceFileSize] :: Voice -> Maybe Integer
instance GHC.Show.Show Telegram.Bot.API.Types.Voice.Voice
instance GHC.Generics.Generic Telegram.Bot.API.Types.Voice.Voice
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.Voice.Voice
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.Voice.Voice
module Telegram.Bot.API.Types.ExternalReplyInfo
-- | This object contains information about a message that is being replied
-- to, which may come from another chat or forum topic.
data ExternalReplyInfo
ExternalReplyInfo :: MessageOrigin -> Maybe Chat -> Maybe MessageId -> Maybe Animation -> Maybe Audio -> Maybe Document -> Maybe [PhotoSize] -> Maybe Sticker -> Maybe Story -> Maybe Video -> Maybe VideoNote -> Maybe Voice -> Maybe Bool -> Maybe Contact -> Maybe Dice -> Maybe Game -> Maybe Invoice -> Maybe Location -> Maybe Poll -> Maybe Venue -> ExternalReplyInfo
-- | Origin of the message replied to by the given message.
[externalReplyInfoOrigin] :: ExternalReplyInfo -> MessageOrigin
-- | Chat the original message belongs to. Available only if the chat is a
-- supergroup or a channel.
[externalReplyInfoChat] :: ExternalReplyInfo -> Maybe Chat
-- | Unique message identifier inside the original chat. Available only if
-- the original chat is a supergroup or a channel.
[externalReplyInfoMessageId] :: ExternalReplyInfo -> Maybe MessageId
-- | Message is an animation, information about the animation.
[externalReplyInfoAnimation] :: ExternalReplyInfo -> Maybe Animation
-- | Message is an audio file, information about the file.
[externalReplyInfoAudio] :: ExternalReplyInfo -> Maybe Audio
-- | Message is a general file, information about the file.
[externalReplyInfoDocument] :: ExternalReplyInfo -> Maybe Document
-- | Message is a photo, available sizes of the photo.
[externalReplyInfoPhoto] :: ExternalReplyInfo -> Maybe [PhotoSize]
-- | Message is a sticker, information about the sticker.
[externalReplyInfoSticker] :: ExternalReplyInfo -> Maybe Sticker
-- | Message is a forwarded story.
[externalReplyInfoStory] :: ExternalReplyInfo -> Maybe Story
-- | Message is a video, information about the video.
[externalReplyInfoVideo] :: ExternalReplyInfo -> Maybe Video
-- | Message is a video note, information about the video message
[externalReplyInfoVideoNote] :: ExternalReplyInfo -> Maybe VideoNote
-- | Message is a voice message, information about the file
[externalReplyInfoVoice] :: ExternalReplyInfo -> Maybe Voice
-- | True, if the message media is covered by a spoiler animation.
[externalReplyInfoHasMediaSpoiler] :: ExternalReplyInfo -> Maybe Bool
-- | Message is a shared contact, information about the contact.
[externalReplyInfoContact] :: ExternalReplyInfo -> Maybe Contact
-- | Message is a dice with random value.
[externalReplyInfoDice] :: ExternalReplyInfo -> Maybe Dice
-- | Message is a game, information about the game.
[externalReplyInfoGame] :: ExternalReplyInfo -> Maybe Game
-- | Message is an invoice for a payment, information about the invoice.
[externalReplyInfoInvoice] :: ExternalReplyInfo -> Maybe Invoice
-- | Message is a shared location, information about the location.
[externalReplyInfoLocation] :: ExternalReplyInfo -> Maybe Location
-- | Message is a native poll, information about the poll.
[externalReplyInfoPoll] :: ExternalReplyInfo -> Maybe Poll
-- | Message is a venue, information about the venue.
[externalReplyInfoVenue] :: ExternalReplyInfo -> Maybe Venue
instance GHC.Show.Show Telegram.Bot.API.Types.ExternalReplyInfo.ExternalReplyInfo
instance GHC.Generics.Generic Telegram.Bot.API.Types.ExternalReplyInfo.ExternalReplyInfo
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.ExternalReplyInfo.ExternalReplyInfo
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.ExternalReplyInfo.ExternalReplyInfo
module Telegram.Bot.API.Types.WebAppData
data WebAppData
WebAppData :: Text -> Text -> WebAppData
-- | The data. Be aware that a bad client can send arbitrary data in this
-- field.
[webAppDataData] :: WebAppData -> Text
-- | Text of the web_app keyboard button, from which the Web App
-- was opened. Be aware that a bad client can send arbitrary data in this
-- field.
[webAppDataButtonText] :: WebAppData -> Text
instance GHC.Show.Show Telegram.Bot.API.Types.WebAppData.WebAppData
instance GHC.Generics.Generic Telegram.Bot.API.Types.WebAppData.WebAppData
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.WebAppData.WebAppData
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.WebAppData.WebAppData
module Telegram.Bot.API.Types.WriteAccessAllowed
-- | This object represents a service message about a user allowing a bot
-- added to the attachment menu to write messages. Currently holds no
-- information.
data WriteAccessAllowed
WriteAccessAllowed :: Maybe Bool -> Maybe Text -> Maybe Bool -> WriteAccessAllowed
-- | True, if the access was granted after the user accepted an explicit
-- request from a Web App sent by the method requestWriteAccess.
[writeAccessAllowedFromRequest] :: WriteAccessAllowed -> Maybe Bool
-- | Name of the Web App which was launched from a link.
[writeAccessAllowedWebAppName] :: WriteAccessAllowed -> Maybe Text
-- | True, if the access was granted when the bot was added to the
-- attachment or side menu.
[writeAccessAllowedFromAttachmentMenu] :: WriteAccessAllowed -> Maybe Bool
instance GHC.Show.Show Telegram.Bot.API.Types.WriteAccessAllowed.WriteAccessAllowed
instance GHC.Generics.Generic Telegram.Bot.API.Types.WriteAccessAllowed.WriteAccessAllowed
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.WriteAccessAllowed.WriteAccessAllowed
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.WriteAccessAllowed.WriteAccessAllowed
module Telegram.Bot.API.Types.Message
-- | This object represents a message.
data Message
Message :: MessageId -> Maybe MessageThreadId -> Maybe User -> Maybe Chat -> Maybe Int -> Maybe User -> POSIXTime -> Maybe BusinessConnectionId -> Chat -> Maybe MessageOrigin -> Maybe Bool -> Maybe Bool -> Maybe Message -> Maybe ExternalReplyInfo -> Maybe TextQuote -> Maybe Story -> Maybe User -> Maybe POSIXTime -> Maybe Bool -> Maybe Bool -> Maybe MediaGroupId -> Maybe Text -> Maybe Text -> Maybe [MessageEntity] -> Maybe LinkPreviewOptions -> Maybe Animation -> Maybe Audio -> Maybe Document -> Maybe [PhotoSize] -> Maybe Sticker -> Maybe Story -> Maybe Video -> Maybe VideoNote -> Maybe Voice -> Maybe Text -> Maybe [MessageEntity] -> Maybe Bool -> Maybe Contact -> Maybe Dice -> Maybe Game -> Maybe Poll -> Maybe Venue -> Maybe Location -> Maybe [User] -> Maybe User -> Maybe Text -> Maybe [PhotoSize] -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe MessageAutoDeleteTimerChanged -> Maybe Bool -> Maybe Bool -> Maybe ChatId -> Maybe ChatId -> Maybe Message -> Maybe Invoice -> Maybe SuccessfulPayment -> Maybe UsersShared -> Maybe ChatShared -> Maybe Text -> Maybe WriteAccessAllowed -> Maybe PassportData -> Maybe ProximityAlertTriggered -> Maybe ChatBoostAdded -> Maybe ChatBackground -> Maybe ForumTopicCreated -> Maybe ForumTopicEdited -> Maybe ForumTopicClosed -> Maybe ForumTopicReopened -> Maybe GeneralForumTopicHidden -> Maybe GeneralForumTopicUnhidden -> Maybe GiveawayCreated -> Maybe Giveaway -> Maybe GiveawayWinners -> Maybe GiveawayCompleted -> Maybe VideoChatScheduled -> Maybe VideoChatStarted -> Maybe VideoChatEnded -> Maybe VideoChatParticipantsInvited -> Maybe WebAppData -> Maybe InlineKeyboardMarkup -> Message
-- | Unique message identifier inside this chat.
[messageMessageId] :: Message -> MessageId
-- | Unique identifier of a message thread to which the message belongs;
-- for supergroups only.
[messageMessageThreadId] :: Message -> Maybe MessageThreadId
-- | Sender, empty for messages sent to channels.
[messageFrom] :: Message -> Maybe User
-- | Sender of the message, sent on behalf of a chat. For example, the
-- channel itself for channel posts, the supergroup itself for messages
-- from anonymous group administrators, the linked channel for messages
-- automatically forwarded to the discussion group. For backward
-- compatibility, the field from contains a fake sender user in
-- non-channel chats, if the message was sent on behalf of a chat.
[messageSenderChat] :: Message -> Maybe Chat
-- | If the sender of the message boosted the chat, the number of boosts
-- added by the user.
[messageSenderBoostCount] :: Message -> Maybe Int
-- | The bot that actually sent the message on behalf of the business
-- account. Available only for outgoing messages sent on behalf of the
-- connected business account.
[messageSenderBusinessBot] :: Message -> Maybe User
-- | Date the message was sent in Unix time.
[messageDate] :: Message -> POSIXTime
-- | Unique identifier of the business connection from which the message
-- was received. If non-empty, the message belongs to a chat of the
-- corresponding business account that is independent from any potential
-- bot chat which might share the same identifier.
[messageBusinessConnectionId] :: Message -> Maybe BusinessConnectionId
-- | Conversation the message belongs to.
[messageChat] :: Message -> Chat
-- | Information about the original message for forwarded messages.
[messageForwardOrigin] :: Message -> Maybe MessageOrigin
-- | True, if the message is sent to a forum topic.
[messageIsTopicMessage] :: Message -> Maybe Bool
-- | True, if the message is a channel post that was automatically
-- forwarded to the connected discussion group.
[messageIsAutomaticForward] :: Message -> Maybe Bool
-- | For replies, the original message. Note that the Message object in
-- this field will not contain further reply_to_message fields even if it
-- itself is a reply.
[messageReplyToMessage] :: Message -> Maybe Message
-- | Information about the message that is being replied to, which may come
-- from another chat or forum topic.
[messageExternalReply] :: Message -> Maybe ExternalReplyInfo
-- | For replies that quote part of the original message, the quoted part
-- of the message.
[messageQuote] :: Message -> Maybe TextQuote
-- | For replies to a story, the original story.
[messageReplyToStory] :: Message -> Maybe Story
-- | Bot through which the message was sent.
[messageViaBot] :: Message -> Maybe User
-- | Date the message was last edited in Unix time
[messageEditDate] :: Message -> Maybe POSIXTime
-- | True, if the message can't be forwarded.
[messageHasProtectedContent] :: Message -> Maybe Bool
-- | True, if the message was sent by an implicit action, for
-- example, as an away or a greeting business message, or as a scheduled
-- message.
[messageIsFromOffline] :: Message -> Maybe Bool
-- | The unique identifier of a media message group this message belongs to
[messageMediaGroupId] :: Message -> Maybe MediaGroupId
-- | Signature of the post author for messages in channels
[messageAuthorSignature] :: Message -> Maybe Text
-- | For text messages, the actual UTF-8 text of the message, 0-4096
-- characters.
[messageText] :: Message -> Maybe Text
-- | For text messages, special entities like usernames, URLs, bot
-- commands, etc. that appear in the text
[messageEntities] :: Message -> Maybe [MessageEntity]
-- | Options used for link preview generation for the message, if it is a
-- text message and link preview options were changed.
[messageLinkPreviewOptions] :: Message -> Maybe LinkPreviewOptions
-- | Message is an animation, information about the animation. For backward
-- compatibility, when this field is set, the document field will also be
-- set.
[messageAnimation] :: Message -> Maybe Animation
-- | Message is an audio file, information about the file
[messageAudio] :: Message -> Maybe Audio
-- | Message is a general file, information about the file.
[messageDocument] :: Message -> Maybe Document
-- | Message is a photo, available sizes of the photo
[messagePhoto] :: Message -> Maybe [PhotoSize]
-- | Message is a sticker, information about the sticker
[messageSticker] :: Message -> Maybe Sticker
-- | Message is a forwarded story.
[messageStory] :: Message -> Maybe Story
-- | Message is a video, information about the video
[messageVideo] :: Message -> Maybe Video
-- | Message is a video note, information about the video message
[messageVideoNote] :: Message -> Maybe VideoNote
-- | Message is a voice message, information about the file
[messageVoice] :: Message -> Maybe Voice
-- | Caption for the audio, document, photo, video or voice, 0-200
-- characters
[messageCaption] :: Message -> Maybe Text
-- | For messages with a caption, special entities like usernames, URLs,
-- bot commands, etc. that appear in the caption.
[messageCaptionEntities] :: Message -> Maybe [MessageEntity]
-- | True, if the message media is covered by a spoiler animation.
[messageHasMediaSpoiler] :: Message -> Maybe Bool
-- | Message is a shared contact, information about the contact
[messageContact] :: Message -> Maybe Contact
-- | Message is a dice with random value.
[messageDice] :: Message -> Maybe Dice
-- | Message is a game, information about the game. More about games » ,
-- messageLocation :: Maybe Location -- ^ Message is a shared location,
-- information about the location
[messageGame] :: Message -> Maybe Game
-- | Message is a native poll, information about the poll.
[messagePoll] :: Message -> Maybe Poll
-- | Message is a venue, information about the venue
[messageVenue] :: Message -> Maybe Venue
-- | Message is a shared location, information about the location.
[messageLocation] :: Message -> Maybe Location
-- | New members that were added to the group or supergroup and information
-- about them (the bot itself may be one of these members)
[messageNewChatMembers] :: Message -> Maybe [User]
-- | A member was removed from the group, information about them (this
-- member may be the bot itself)
[messageLeftChatMember] :: Message -> Maybe User
-- | A chat title was changed to this value
[messageNewChatTitle] :: Message -> Maybe Text
-- | A chat photo was change to this value
[messageNewChatPhoto] :: Message -> Maybe [PhotoSize]
-- | Service message: the chat photo was deleted
[messageDeleteChatPhoto] :: Message -> Maybe Bool
-- | Service message: the group has been created
[messageGroupChatCreated] :: Message -> Maybe Bool
-- | Service message: the supergroup has been created. This field can‘t be
-- received in a message coming through updates, because bot can’t be a
-- member of a supergroup when it is created. It can only be found in
-- reply_to_message if someone replies to a very first message in a
-- directly created supergroup.
[messageSupergroupChatCreated] :: Message -> Maybe Bool
-- | Service message: the channel has been created. This field can‘t be
-- received in a message coming through updates, because bot can’t be a
-- member of a channel when it is created. It can only be found in
-- reply_to_message if someone replies to a very first message in a
-- channel.
[messageChannelChatCreated] :: Message -> Maybe Bool
-- | Service message: auto-delete timer settings changed in the chat.
[messageAutoDeleteTimerChanged] :: Message -> Maybe MessageAutoDeleteTimerChanged
-- | True, if aggressive anti-spam checks are enabled in the
-- supergroup. The field is only available to chat administrators.
-- Returned only in getChat.
[messageHasAggressiveAntiSpamEnabled] :: Message -> Maybe Bool
-- | True, if non-administrators can only get the list of bots and
-- administrators in the chat. Returned only in getChat.
[messageHasHiddenMembers] :: Message -> Maybe Bool
-- | The group has been migrated to a supergroup with the specified
-- identifier. This number may be greater than 32 bits and some
-- programming languages may have difficulty/silent defects in
-- interpreting it. But it is smaller than 52 bits, so a signed 64 bit
-- integer or double-precision float type are safe for storing this
-- identifier.
[messageMigrateToChatId] :: Message -> Maybe ChatId
-- | The supergroup has been migrated from a group with the specified
-- identifier. This number may be greater than 32 bits and some
-- programming languages may have difficulty/silent defects in
-- interpreting it. But it is smaller than 52 bits, so a signed 64 bit
-- integer or double-precision float type are safe for storing this
-- identifier.
[messageMigrateFromChatId] :: Message -> Maybe ChatId
-- | Specified message was pinned. Note that the Message object in this
-- field will not contain further reply_to_message fields even
-- if it itself is a reply. Use isInaccessibleMessage to
-- understand whether a message was deleted or is otherwise inaccessible
-- to the bot.
[messagePinnedMessage] :: Message -> Maybe Message
-- | Message is an invoice for a payment, information about the invoice.
[messageInvoice] :: Message -> Maybe Invoice
-- | Message is a service message about a successful payment, information
-- about the payment.
[messageSuccessfulPayment] :: Message -> Maybe SuccessfulPayment
-- | Service message: users were shared with the bot.
[messageUsersShared] :: Message -> Maybe UsersShared
-- | Service message: a chat was shared with the bot.
[messageChatShared] :: Message -> Maybe ChatShared
-- | The domain name of the website on which the user has logged in.
[messageConnectedWebsite] :: Message -> Maybe Text
-- | Service message: the user allowed the bot added to the attachment menu
-- to write messages.
[messageWriteAccessAllowed] :: Message -> Maybe WriteAccessAllowed
-- | Telegram Passport data.
[messagePassportData] :: Message -> Maybe PassportData
-- | Service message. A user in the chat triggered another user's proximity
-- alert while sharing Live Location.
[messageProximityAlertTriggered] :: Message -> Maybe ProximityAlertTriggered
-- | Service message: user boosted the chat.
[messageBoostAdded] :: Message -> Maybe ChatBoostAdded
-- | Service message: chat background set.
[messageChatBackgroundSet] :: Message -> Maybe ChatBackground
-- | Service message: forum topic created.
[messageForumTopicCreated] :: Message -> Maybe ForumTopicCreated
-- | Service message: forum topic edited.
[messageForumTopicEdited] :: Message -> Maybe ForumTopicEdited
-- | Service message: forum topic closed.
[messageForumTopicClosed] :: Message -> Maybe ForumTopicClosed
-- | Service message: forum topic reopened.
[messageForumTopicReopened] :: Message -> Maybe ForumTopicReopened
-- | Service message: the General forum topic hidden.
[messageGeneralForumTopicHidden] :: Message -> Maybe GeneralForumTopicHidden
-- | Service message: the General forum topic unhidden
[messageGeneralForumTopicUnhidden] :: Message -> Maybe GeneralForumTopicUnhidden
-- | Service message: a scheduled giveaway was created.
[messageGiveawayCreated] :: Message -> Maybe GiveawayCreated
-- | The message is a scheduled giveaway message.
[messageGiveaway] :: Message -> Maybe Giveaway
-- | A giveaway with public winners was completed.
[messageGiveawayWinners] :: Message -> Maybe GiveawayWinners
-- | Service message: a giveaway without public winners was completed.
[messageGiveawayCompleted] :: Message -> Maybe GiveawayCompleted
-- | Service message: video chat scheduled.
[messageVideoChatScheduled] :: Message -> Maybe VideoChatScheduled
-- | Service message: video chat started
[messageVideoChatStarted] :: Message -> Maybe VideoChatStarted
-- | Service message: video chat ended.
[messageVideoChatEnded] :: Message -> Maybe VideoChatEnded
-- | Service message: new participants invited to a video chat.
[messageVideoChatParticipantsInvited] :: Message -> Maybe VideoChatParticipantsInvited
-- | Service message: data sent by a Web App.
[messageWebAppData] :: Message -> Maybe WebAppData
-- | Inline keyboard attached to the message. login_url buttons
-- are represented as ordinary url buttons.
[messageReplyMarkup] :: Message -> Maybe InlineKeyboardMarkup
isInaccessibleMessage :: Message -> Bool
instance GHC.Show.Show Telegram.Bot.API.Types.Message.Message
instance GHC.Generics.Generic Telegram.Bot.API.Types.Message.Message
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.Message.Message
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.Message.Message
module Telegram.Bot.API.Types.GiveawayCompleted
-- | This object represents a service message about the completion of a
-- giveaway without public winners.
data GiveawayCompleted
GiveawayCompleted :: Int -> Maybe Int -> Maybe Message -> GiveawayCompleted
-- | Number of winners in the giveaway.
[giveawayCompletedWinnerCount] :: GiveawayCompleted -> Int
-- | Number of undistributed prizes.
[giveawayCompletedUnclaimedPrizeCount] :: GiveawayCompleted -> Maybe Int
-- | Message with the giveaway that was completed, if it wasn't deleted.
[giveawayCompletedGiveawayMessage] :: GiveawayCompleted -> Maybe Message
instance GHC.Show.Show Telegram.Bot.API.Types.GiveawayCompleted.GiveawayCompleted
instance GHC.Generics.Generic Telegram.Bot.API.Types.GiveawayCompleted.GiveawayCompleted
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.GiveawayCompleted.GiveawayCompleted
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.GiveawayCompleted.GiveawayCompleted
module Telegram.Bot.API.Types.ChatFullInfo
-- | This object contains full information about a chat.
--
-- https://core.telegram.org/bots/api#chatfullinfo
data ChatFullInfo
ChatFullInfo :: ChatId -> Maybe Bool -> ChatType -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Bool -> Maybe Int -> Int -> Maybe ChatPhoto -> Maybe Text -> Maybe Birthdate -> Maybe BusinessIntro -> Maybe BusinessLocation -> Maybe BusinessOpeningHours -> Maybe Chat -> Maybe [ReactionType] -> Maybe Text -> Maybe Int -> Maybe Text -> Maybe Text -> Maybe POSIXTime -> Maybe Text -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Text -> Maybe Text -> Maybe Message -> Maybe ChatPermissions -> Maybe Int -> Maybe Int -> Maybe POSIXTime -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Text -> Maybe Bool -> Maybe Text -> Maybe ChatId -> Maybe ChatLocation -> ChatFullInfo
-- | Unique identifier for this chat. This number may be greater than 32
-- bits and some programming languages may have difficulty/silent defects
-- in interpreting it. But it is smaller than 52 bits, so a signed 64 bit
-- integer or double-precision float type are safe for storing this
-- identifier.
[chatFullInfoId] :: ChatFullInfo -> ChatId
-- | True, if this user is a bot.
[chatFullInfoIsBot] :: ChatFullInfo -> Maybe Bool
-- | Type of chat.
[chatFullInfoType] :: ChatFullInfo -> ChatType
-- | Title, for supergroups, channels and group chats.
[chatFullInfoTitle] :: ChatFullInfo -> Maybe Text
-- | Username, for private chats, supergroups and channels if available.
[chatFullInfoUsername] :: ChatFullInfo -> Maybe Text
-- | First name of the other party in a private chat.
[chatFullInfoFirstName] :: ChatFullInfo -> Maybe Text
-- | Last name of the other party in a private chat.
[chatFullInfoLastName] :: ChatFullInfo -> Maybe Text
-- | True, if the supergroup chat is a forum (has topics enabled).
[chatFullInfoIsForum] :: ChatFullInfo -> Maybe Bool
-- | Identifier of the accent color for the chat name and backgrounds of
-- the chat photo, reply header, and link preview. See accent
-- colors for more details. Returned only in getChat. Always
-- returned in getChat.
[chatFullInfoAccentColorId] :: ChatFullInfo -> Maybe Int
-- | The maximum number of reactions that can be set on a message in the
-- chat.
[chatFullInfoMaxReactionCount] :: ChatFullInfo -> Int
-- | Chat photo. Returned only in getChat.
[chatFullInfoPhoto] :: ChatFullInfo -> Maybe ChatPhoto
-- | If non-empty, the list of all active chat usernames; for private
-- chats, supergroups and channels. Returned only in getChat.
[chatFullInfoActiveUsernames] :: ChatFullInfo -> Maybe Text
-- | For private chats, the date of birth of the user.
[chatFullInfoBirthdate] :: ChatFullInfo -> Maybe Birthdate
-- | For private chats with business accounts, the intro of the business.
[chatFullInfoBusinessIntro] :: ChatFullInfo -> Maybe BusinessIntro
-- | For private chats with business accounts, the location of the
-- business.
[chatFullInfoBusinessLocation] :: ChatFullInfo -> Maybe BusinessLocation
-- | For private chats with business accounts, the opening hours of the
-- business.
[chatFullInfoBusinessOpeningHours] :: ChatFullInfo -> Maybe BusinessOpeningHours
-- | For private chats, the personal channel of the user.
[chatFullInfoPersonalChat] :: ChatFullInfo -> Maybe Chat
-- | List of available reactions allowed in the chat. If omitted, then all
-- emoji reactions are allowed. Returned only in getChat.
[chatFullInfoAvailableReactions] :: ChatFullInfo -> Maybe [ReactionType]
-- | Custom emoji identifier of emoji chosen by the chat for the reply
-- header and link preview background. Returned only in getChat.
[chatFullInfoBackgroundCustomEmojiId] :: ChatFullInfo -> Maybe Text
-- | Identifier of the accent color for the chat's profile background. See
-- profile accent colors for more details. Returned only in
-- getChat.
[chatFullInfoProfileAccentColorId] :: ChatFullInfo -> Maybe Int
-- | Custom emoji identifier of the emoji chosen by the chat for its
-- profile background. Returned only in getChat.
[chatFullInfoProfileBackgroundCustomEmojiId] :: ChatFullInfo -> Maybe Text
-- | Custom emoji identifier of emoji status of the other party in a
-- private chat. Returned only in getChat.
[chatFullInfoEmojiStatusCustomEmojiId] :: ChatFullInfo -> Maybe Text
-- | Expiration date of the emoji status of the chat or the other party in
-- a private chat, in Unix time, if any. Returned only in
-- getChat.
[chatFullInfoEmojiStatusExpirationDate] :: ChatFullInfo -> Maybe POSIXTime
-- | Bio of the other party in a private chat. Returned only in
-- getChat.
[chatFullInfoBio] :: ChatFullInfo -> Maybe Text
-- | True, if privacy settings of the other party in the private
-- chat allows to use `tg://user?id=user_id` links only in chats
-- with the user. Returned only in getChat.
[chatFullInfoHasPrivateForwards] :: ChatFullInfo -> Maybe Bool
-- | True, if the privacy settings of the other party restrict
-- sending voice and video note messages in the private chat. Returned
-- only in getChat.
[chatFullInfoHasRestrictedVoiceAndVideoMessages] :: ChatFullInfo -> Maybe Bool
-- | True, if users need to join the supergroup before they can send
-- messages. Returned only in getChat.
[chatFullInfoJoinToSendMessages] :: ChatFullInfo -> Maybe Bool
-- | True, if all users directly joining the supergroup need to be
-- approved by supergroup administrators. Returned only in
-- getChat.
[chatFullInfoJoinByRequest] :: ChatFullInfo -> Maybe Bool
-- | Description, for supergroups and channel chats. Returned only in
-- getChat.
[chatFullInfoDescription] :: ChatFullInfo -> Maybe Text
-- | Chat invite link, for supergroups and channel chats. Returned only in
-- getChat.
[chatFullInfoInviteLink] :: ChatFullInfo -> Maybe Text
-- | Pinned message, for supergroups. Returned only in getChat.
[chatFullInfoPinnedMessage] :: ChatFullInfo -> Maybe Message
-- | Default chat member permissions, for groups and supergroups.
[chatFullInfoPermissions] :: ChatFullInfo -> Maybe ChatPermissions
-- | For supergroups, the minimum allowed delay between consecutive
-- messages sent by each unpriviledged user; in seconds.
[chatFullInfoSlowModeDelay] :: ChatFullInfo -> Maybe Int
-- | For supergroups, the minimum number of boosts that a non-administrator
-- user needs to add in order to ignore slow mode and chat permissions.
[chatFullInfoUnrestrictBootCount] :: ChatFullInfo -> Maybe Int
-- | The time after which all messages sent to the chat will be
-- automatically deleted; in seconds.
[chatFullInfoMessageAutoDeleteTime] :: ChatFullInfo -> Maybe POSIXTime
-- | True, if aggressive anti-spam checks are enabled in the
-- supergroup. The field is only available to chat administrators.
-- Returned only in getChat.
[chatFullInfoHasAggressiveAntiSpamEnabled] :: ChatFullInfo -> Maybe Bool
-- | True, if non-administrators can only get the list of bots and
-- administrators in the chat. Returned only in getChat.
[chatFullInfoHasHiddenMembers] :: ChatFullInfo -> Maybe Bool
-- | True, if messages from the chat can't be forwarded to other
-- chats.
[chatFullInfoHasProtectedContent] :: ChatFullInfo -> Maybe Bool
-- | True, if new chat members will have access to old messages;
-- available only to chat administrators. Returned only in
-- getChat.
[chatFullInfoHasVisibleHistory] :: ChatFullInfo -> Maybe Bool
-- | For supergroups, name of group sticker set. Returned only in getChat.
[chatFullInfoStickerSetName] :: ChatFullInfo -> Maybe Text
-- | True, if the bot can change the group sticker set. Returned only in
-- getChat.
[chatFullInfoCanSetStickerSet] :: ChatFullInfo -> Maybe Bool
-- | For supergroups, the name of the group's custom emoji sticker set.
-- Custom emoji from this set can be used by all users and bots in the
-- group.
[chatFullInfoCustomEmojiStickerSet] :: ChatFullInfo -> Maybe Text
-- | Unique identifier for the linked chat, i.e. the discussion group
-- identifier for a channel and vice versa; for supergroups and channel
-- chats. This identifier may be greater than 32 bits and some
-- programming languages may have difficulty/silent defects in
-- interpreting it. But it is smaller than 52 bits, so a signed 64 bit
-- integer or double-precision float type are safe for storing this
-- identifier.
[chatFullInfoLinkedChatId] :: ChatFullInfo -> Maybe ChatId
-- | For supergroups, the location to which the supergroup is connected.
-- Returned only in getChat.
[chatFullInfoLocation] :: ChatFullInfo -> Maybe ChatLocation
instance GHC.Show.Show Telegram.Bot.API.Types.ChatFullInfo.ChatFullInfo
instance GHC.Generics.Generic Telegram.Bot.API.Types.ChatFullInfo.ChatFullInfo
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.ChatFullInfo.ChatFullInfo
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.ChatFullInfo.ChatFullInfo
module Telegram.Bot.API.Types.CallbackQuery
-- | This object represents an incoming callback query from a callback
-- button in an inline keyboard. If the button that originated the query
-- was attached to a message sent by the bot, the field message will be
-- present. If the button was attached to a message sent via the bot (in
-- inline mode), the field inline_message_id will be present.
-- Exactly one of the fields data or game_short_name will be present.
data CallbackQuery
CallbackQuery :: CallbackQueryId -> User -> Maybe Message -> Maybe MessageId -> Text -> Maybe Text -> Maybe Text -> CallbackQuery
-- | Unique identifier for this query
[callbackQueryId] :: CallbackQuery -> CallbackQueryId
-- | Sender
[callbackQueryFrom] :: CallbackQuery -> User
-- | Message sent by the bot with the callback button that originated the
-- query. Use isInaccessible to understand whether a message was
-- deleted or is otherwise inaccessible to the bot.
[callbackQueryMessage] :: CallbackQuery -> Maybe Message
-- | Identifier of the message sent via the bot in inline mode, that
-- originated the query.
[callbackQueryInlineMessageId] :: CallbackQuery -> Maybe MessageId
-- | Global identifier, uniquely corresponding to the chat to which the
-- message with the callback button was sent. Useful for high scores in
-- games.
[callbackQueryChatInstance] :: CallbackQuery -> Text
-- | Data associated with the callback button. Be aware that a bad client
-- can send arbitrary data in this field.
[callbackQueryData] :: CallbackQuery -> Maybe Text
-- | Short name of a Game to be returned, serves as the unique identifier
-- for the game
[callbackQueryGameShortName] :: CallbackQuery -> Maybe Text
instance GHC.Show.Show Telegram.Bot.API.Types.CallbackQuery.CallbackQuery
instance GHC.Generics.Generic Telegram.Bot.API.Types.CallbackQuery.CallbackQuery
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Types.CallbackQuery.CallbackQuery
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Types.CallbackQuery.CallbackQuery
module Telegram.Bot.API.Types
type RequiredQueryParam = QueryParam' '[Required, Strict]
module Telegram.Bot.API.MakingRequests
botBaseUrl :: Token -> BaseUrl
botBaseUrlTest :: Token -> BaseUrl
defaultTelegramClientEnv :: Token -> IO ClientEnv
defaultTelegramClientEnvTest :: Token -> IO ClientEnv
defaultRunBot :: Token -> ClientM a -> IO (Either ClientError a)
defaultRunBotTest :: Token -> ClientM a -> IO (Either ClientError a)
data Response a
Response :: Bool -> Maybe Text -> a -> Maybe Integer -> Maybe ResponseParameters -> Response a
[responseOk] :: Response a -> Bool
[responseDescription] :: Response a -> Maybe Text
[responseResult] :: Response a -> a
[responseErrorCode] :: Response a -> Maybe Integer
[responseParameters] :: Response a -> Maybe ResponseParameters
newtype Token
Token :: Text -> Token
instance GHC.Base.Functor Telegram.Bot.API.MakingRequests.Response
instance GHC.Generics.Generic (Telegram.Bot.API.MakingRequests.Response a)
instance GHC.Show.Show a => GHC.Show.Show (Telegram.Bot.API.MakingRequests.Response a)
instance Data.String.IsString Telegram.Bot.API.MakingRequests.Token
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.MakingRequests.Token
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.MakingRequests.Token
instance Web.Internal.HttpApiData.FromHttpApiData Telegram.Bot.API.MakingRequests.Token
instance Web.Internal.HttpApiData.ToHttpApiData Telegram.Bot.API.MakingRequests.Token
instance GHC.Show.Show Telegram.Bot.API.MakingRequests.Token
instance GHC.Classes.Eq Telegram.Bot.API.MakingRequests.Token
instance Data.Aeson.Types.ToJSON.ToJSON a => Data.Aeson.Types.ToJSON.ToJSON (Telegram.Bot.API.MakingRequests.Response a)
instance Data.Aeson.Types.FromJSON.FromJSON a => Data.Aeson.Types.FromJSON.FromJSON (Telegram.Bot.API.MakingRequests.Response a)
module Telegram.Bot.API.Stickers
-- | Type of uploaded sticker file. Static or animated.
data StickerType
-- | PNG image with the sticker, must be up to 512 kilobytes in size,
-- dimensions must not exceed 512px, and either width or height must be
-- exactly 512px. Pass a file_id as a String to send a file that already
-- exists on the Telegram servers, pass an HTTP URL as a String for
-- Telegram to get a file from the Internet, or upload a new one using
-- multipart/form-data.
PngSticker :: StickerType
-- | TGS animation with the sticker, uploaded using multipart/form-data.
-- See
-- https://core.telegram.org/animated_stickers#technical-requirements
-- for technical requirements.
TgsSticker :: StickerType
-- | WEBM video with the sticker, uploaded using multipart/form-data. See
-- https://core.telegram.org/stickers#video-sticker-requirements
-- for technical requirements.
WebmSticker :: StickerType
-- | Sticker file with static/animated label.
data StickerFile
StickerFile :: InputFile -> StickerType -> StickerFile
[stickerFileSticker] :: StickerFile -> InputFile
[stickerFileLabel] :: StickerFile -> StickerType
-- | Request parameters for sendSticker.
data SendStickerRequest
SendStickerRequest :: Maybe BusinessConnectionId -> SomeChatId -> Maybe MessageThreadId -> Maybe Text -> InputFile -> Maybe Bool -> Maybe Bool -> Maybe MessageId -> Maybe ReplyParameters -> Maybe InlineKeyboardMarkup -> SendStickerRequest
-- | Unique identifier of the business connection on behalf of which the
-- message will be sent.
[sendStickerBusinessConnectionId] :: SendStickerRequest -> Maybe BusinessConnectionId
-- | Unique identifier for the target chat or username of the target
-- channel (in the format @channelusername).
[sendStickerChatId] :: SendStickerRequest -> SomeChatId
-- | Unique identifier for the target message thread (topic) of the forum;
-- for forum supergroups only.
[sendStickerMessageThreadId] :: SendStickerRequest -> Maybe MessageThreadId
-- | Emoji associated with the sticker; only for just uploaded stickers.
[sendStickerEmoji] :: SendStickerRequest -> Maybe Text
-- | Sticker to send. Pass a file_id as String to send a file that exists
-- on the Telegram servers (recommended), pass an HTTP URL as a String
-- for Telegram to get a .WEBP sticker from the Internet, or
-- upload a new .WEBP, .TGS, or .WEBM sticker using
-- multipart/form-data. More information on Sending Files ». Video and
-- animated stickers can't be sent via an HTTP URL.
[sendStickerSticker] :: SendStickerRequest -> InputFile
-- | Sends the message silently. Users will receive a notification with no
-- sound.
[sendStickerDisableNotification] :: SendStickerRequest -> Maybe Bool
-- | Protects the contents of the sent message from forwarding and saving.
[sendStickerProtectContent] :: SendStickerRequest -> Maybe Bool
-- | If the message is a reply, ID of the original message
[sendStickerReplyToMessageId] :: SendStickerRequest -> Maybe MessageId
-- | Description of the message to reply to.
[sendStickerReplyParameters] :: SendStickerRequest -> Maybe ReplyParameters
-- | Additional interface options. A JSON-serialized object for an inline
-- keyboard, custom reply keyboard, instructions to remove reply keyboard
-- or to force a reply from the user.
[sendStickerReplyMarkup] :: SendStickerRequest -> Maybe InlineKeyboardMarkup
type SendStickerContent = "sendSticker" :> MultipartForm Tmp SendStickerRequest :> Post '[JSON] (Response Message)
type SendStickerLink = "sendSticker" :> ReqBody '[JSON] SendStickerRequest :> Post '[JSON] (Response Message)
-- | Use this method to send static .WEBP or animated .TGS stickers. On
-- success, the sent Message is returned.
sendSticker :: SendStickerRequest -> ClientM (Response Message)
-- | Request parameters for getCustomEmojiStickers.
data GetCustomEmojiStickersRequest
GetCustomEmojiStickersRequest :: [Text] -> GetCustomEmojiStickersRequest
-- | List of custom emoji identifiers. At most 200 custom emoji identifiers
-- can be specified.
[getCustomEmojiStickersRequestCustomEmojiIds] :: GetCustomEmojiStickersRequest -> [Text]
type GetCustomEmojiStickers = "getCustomEmojiStickers" :> ReqBody '[JSON] GetCustomEmojiStickersRequest :> Post '[JSON] (Response [Sticker])
getCustomEmojiStickers :: GetCustomEmojiStickersRequest -> ClientM (Response [Sticker])
-- | Request parameters for uploadStickerFile.
data UploadStickerFileRequest
UploadStickerFileRequest :: UserId -> InputFile -> Text -> UploadStickerFileRequest
-- | User identifier of sticker file owner
[uploadStickerFileUserId] :: UploadStickerFileRequest -> UserId
-- | A file with the sticker in .WEBP, .PNG, .TGS, or .WEBM format. See
-- https://core.telegram.org/stickers for technical requirements.
[uploadStickerFileSticker] :: UploadStickerFileRequest -> InputFile
-- | Format of the sticker, must be one of “static”, “animated”, “video”
[uploadStickerFileStickerFormat] :: UploadStickerFileRequest -> Text
type UploadStickerFileContent = "uploadStickerFile" :> MultipartForm Tmp UploadStickerFileRequest :> Post '[JSON] (Response File)
type UploadStickerFileLink = "uploadStickerFile" :> ReqBody '[JSON] UploadStickerFileRequest :> Post '[JSON] (Response File)
-- | Use this method to upload f file in .WEBP, .PNG,
-- .TGS, or .WEBM format with a sticker for later use in
-- createNewStickerSet and addStickerToSet methods (can be used multiple
-- times). Returns the uploaded File on success.
uploadStickerFile :: UploadStickerFileRequest -> ClientM (Response File)
-- | Request parameters for createNewStickerSet.
data CreateNewStickerSetRequest
CreateNewStickerSetRequest :: UserId -> Text -> Text -> [InputSticker] -> Maybe StickerSetType -> Maybe Bool -> CreateNewStickerSetRequest
-- | User identifier of created sticker set owner
[createNewStickerSetUserId] :: CreateNewStickerSetRequest -> UserId
-- | Short name of sticker set, to be used in t.meaddstickers URLs
-- (e.g., animals). Can contain only english letters, digits and
-- underscores. Must begin with a letter, can't contain consecutive
-- underscores and must end in “_by_username”. bot_username
-- is case insensitive. 1-64 characters.
[createNewStickerSetName] :: CreateNewStickerSetRequest -> Text
-- | Sticker set title, 1-64 characters
[createNewStickerSetTitle] :: CreateNewStickerSetRequest -> Text
-- | A JSON-serialized list of 1-50 initial stickers to be added to the
-- sticker set.
[createNewStickerSetStickers] :: CreateNewStickerSetRequest -> [InputSticker]
-- | Type of stickers in the set, pass “regular”, “mask”, or
-- “custom_emoji”. By default, a regular sticker set is created.
[createNewStickerSetStickerType] :: CreateNewStickerSetRequest -> Maybe StickerSetType
-- | True if stickers in the sticker set must be repainted to the
-- color of text when used in messages, the accent color if used as emoji
-- status, white on chat photos, or another appropriate color based on
-- context; for custom emoji sticker sets only.
[createNewStickerSetNeedsRepainting] :: CreateNewStickerSetRequest -> Maybe Bool
type CreateNewStickerSet = "createNewStickerSet" :> ReqBody '[JSON] CreateNewStickerSetRequest :> Post '[JSON] (Response Bool)
-- | Use this method to create a new sticker set owned by a user. The bot
-- will be able to edit the sticker set thus created. Returns True
-- on success.
createNewStickerSet :: CreateNewStickerSetRequest -> ClientM (Response Bool)
-- | Request parameters for addStickerToSet.
data AddStickerToSetRequest
AddStickerToSetRequest :: UserId -> Text -> InputSticker -> AddStickerToSetRequest
-- | User identifier of sticker set owner
[addStickerToSetUserId] :: AddStickerToSetRequest -> UserId
-- | Sticker set name
[addStickerToSetName] :: AddStickerToSetRequest -> Text
-- | A JSON-serialized object with information about the added sticker. If
-- exactly the same sticker had already been added to the set, then the
-- set isn't changed.
[addStickerToSetStickers] :: AddStickerToSetRequest -> InputSticker
type AddStickerToSet = "addStickerToSet" :> ReqBody '[JSON] AddStickerToSetRequest :> Post '[JSON] (Response Bool)
-- | Use this method to add a new sticker to a set created by the bot. You
-- must use exactly one of the fields png_sticker or tgs_sticker.
-- Animated stickers can be added to animated sticker sets and only to
-- them. Animated sticker sets can have up to 50 stickers. Static sticker
-- sets can have up to 120 stickers. Returns True on success.
addStickerToSet :: AddStickerToSetRequest -> ClientM (Response Bool)
type GetStickerSet = "getStickerSet" :> RequiredQueryParam "name" Text :> Get '[JSON] (Response StickerSet)
-- | Use this method to get a sticker set. On success, a StickerSet object
-- is returned.
getStickerSet :: Text -> ClientM (Response StickerSet)
type SetStickerPositionInSet = "setStickerPositionInSet" :> RequiredQueryParam "sticker" Text :> RequiredQueryParam "position" Integer :> Post '[JSON] (Response Bool)
-- | Use this method to move a sticker in a set created by the bot to a
-- specific position. Returns True on success.
setStickerPositionInSet :: Text -> Integer -> ClientM (Response Bool)
type DeleteStickerFromSet = "deleteStickerFromSet" :> RequiredQueryParam "sticker" Text :> Post '[JSON] (Response Bool)
-- | Use this method to delete a sticker from a set created by the bot.
-- Returns True on success.
deleteStickerFromSet :: Text -> ClientM (Response Bool)
-- | Request parameters for setStickerSetThumbnail.
data SetStickerSetThumbnailRequest
SetStickerSetThumbnailRequest :: Text -> UserId -> InputFile -> Text -> SetStickerSetThumbnailRequest
-- | Sticker set name
[setStickerSetThumbnailName] :: SetStickerSetThumbnailRequest -> Text
-- | User identifier of the sticker set owner
[setStickerSetThumbnailUserId] :: SetStickerSetThumbnailRequest -> UserId
-- | A PNG image with the thumbnail, must be up to 128 kilobytes in size
-- and have width and height exactly 100px, or a TGS animation with the
-- thumbnail up to 32 kilobytes in size; see
-- https://core.telegram.org/animated_stickers#technical-requirements
-- for animated sticker technical requirements. Pass a file_id as a
-- String to send a file that already exists on the Telegram servers,
-- pass an HTTP URL as a String for Telegram to get a file from the
-- Internet, or upload a new one using multipart/form-data. Animated
-- sticker set thumbnail can't be uploaded via HTTP URL.
[setStickerSetThumbnailThumbnail] :: SetStickerSetThumbnailRequest -> InputFile
-- | Format of the thumbnail, must be one of “static” for a .WEBP or
-- .PNG image, “animated” for a .TGS animation, or “video”
-- for a WEBM video.
[setStickerSetThumbnailFormat] :: SetStickerSetThumbnailRequest -> Text
type SetStickerSetThumbnailContent = "setStickerSetThumbnail" :> MultipartForm Tmp SetStickerSetThumbnailRequest :> Post '[JSON] (Response Bool)
type SetStickerSetThumbnailLink = "setStickerSetThumbnail" :> ReqBody '[JSON] SetStickerSetThumbnailRequest :> Post '[JSON] (Response Bool)
-- | Use this method to set the thumbnail of a sticker set. Animated
-- thumbnails can be set for animated sticker sets only. Returns True on
-- success.
setStickerSetThumbnail :: SetStickerSetThumbnailRequest -> ClientM (Response Bool)
defSetStickerSetThumbnail :: Text -> UserId -> InputFile -> Text -> SetStickerSetThumbnailRequest
defAddStickerToSet :: UserId -> Text -> InputSticker -> AddStickerToSetRequest
defCreateNewStickerSet :: UserId -> Text -> Text -> [InputSticker] -> CreateNewStickerSetRequest
defUploadStickerFile :: UserId -> InputFile -> Text -> UploadStickerFileRequest
defGetCustomEmojiStickers :: [Text] -> GetCustomEmojiStickersRequest
defSendSticker :: SomeChatId -> InputFile -> SendStickerRequest
instance GHC.Generics.Generic Telegram.Bot.API.Stickers.SendStickerRequest
instance GHC.Generics.Generic Telegram.Bot.API.Stickers.GetCustomEmojiStickersRequest
instance GHC.Generics.Generic Telegram.Bot.API.Stickers.UploadStickerFileRequest
instance GHC.Generics.Generic Telegram.Bot.API.Stickers.CreateNewStickerSetRequest
instance GHC.Generics.Generic Telegram.Bot.API.Stickers.AddStickerToSetRequest
instance GHC.Generics.Generic Telegram.Bot.API.Stickers.SetStickerSetThumbnailRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Stickers.SetStickerSetThumbnailRequest
instance Servant.Multipart.API.ToMultipart Servant.Multipart.API.Tmp Telegram.Bot.API.Stickers.SetStickerSetThumbnailRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Stickers.AddStickerToSetRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Stickers.CreateNewStickerSetRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Stickers.UploadStickerFileRequest
instance Servant.Multipart.API.ToMultipart Servant.Multipart.API.Tmp Telegram.Bot.API.Stickers.UploadStickerFileRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Stickers.GetCustomEmojiStickersRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Stickers.SendStickerRequest
instance Servant.Multipart.API.ToMultipart Servant.Multipart.API.Tmp Telegram.Bot.API.Stickers.SendStickerRequest
module Telegram.Bot.API.Payments
data SendInvoiceRequest
SendInvoiceRequest :: ChatId -> Maybe MessageThreadId -> Text -> Text -> Text -> Text -> Text -> [LabeledPrice] -> Maybe Integer -> Maybe [Integer] -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Int -> Maybe Int -> Maybe Int -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe MessageId -> Maybe ReplyParameters -> Maybe InlineKeyboardMarkup -> SendInvoiceRequest
-- | Unique identifier for the target chat or username of the target
-- channel (in the format @channelusername).
[sendInvoiceChatId] :: SendInvoiceRequest -> ChatId
-- | Unique identifier for the target message thread (topic) of the forum;
-- for forum supergroups only.
[sendInvoiceMessageThreadId] :: SendInvoiceRequest -> Maybe MessageThreadId
-- | Product name, 1-32 characters.
[sendInvoiceTitle] :: SendInvoiceRequest -> Text
-- | Product description, 1-255 characters.
[sendInvoiceDescription] :: SendInvoiceRequest -> Text
-- | Bot-defined invoice payload, 1-128 bytes. This will not be displayed
-- to the user, use for your internal processes.
[sendInvoicePayload] :: SendInvoiceRequest -> Text
-- | Payments provider token, obtained via Botfather.
[sendInvoiceProviderToken] :: SendInvoiceRequest -> Text
-- | Three-letter ISO 4217 currency code, see more on currencies.
[sendInvoiceCurrency] :: SendInvoiceRequest -> Text
-- | Price breakdown, a JSON-serialized list of components (e.g. product
-- price, tax, discount, delivery cost, delivery tax, bonus, etc.).
[sendInvoicePrices] :: SendInvoiceRequest -> [LabeledPrice]
-- | The maximum accepted amount for tips in the smallest units of the
-- currency (integer, not float/double). For example, for a maximum tip
-- of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in
-- currencies.json, it shows the number of digits past the decimal point
-- for each currency (2 for the majority of currencies). Defaults to 0.
[sendInvoiceMaxTipAmount] :: SendInvoiceRequest -> Maybe Integer
-- | A JSON-serialized array of suggested amounts of tips in the smallest
-- units of the currency (integer, not float/double). At most 4 suggested
-- tip amounts can be specified. The suggested tip amounts must be
-- positive, passed in a strictly increased order and must not exceed
-- max_tip_amount.
[sendInvoiceequestSuggestedTipAmounts] :: SendInvoiceRequest -> Maybe [Integer]
-- | Unique deep-linking parameter. If left empty, forwarded copies of the
-- sent message will have a Pay button, allowing multiple users to pay
-- directly from the forwarded message, using the same invoice. If
-- non-empty, forwarded copies of the sent message will have a URL button
-- with a deep link to the bot (instead of a Pay button), with the value
-- used as the start parameter.
[sendInvoiceStartParameter] :: SendInvoiceRequest -> Maybe Text
-- | A JSON-serialized data about the invoice, which will be shared with
-- the payment provider. A detailed description of required fields should
-- be provided by the payment provider.
[sendInvoiceProviderData] :: SendInvoiceRequest -> Maybe Text
-- | URL of the product photo for the invoice. Can be a photo of the goods
-- or a marketing image for a service. People like it better when they
-- see what they are paying for.
[sendInvoicePhotoUrl] :: SendInvoiceRequest -> Maybe Text
-- | Photo size.
[sendInvoicePhotoSize] :: SendInvoiceRequest -> Maybe Int
-- | Photo width.
[sendInvoicePhotoWidth] :: SendInvoiceRequest -> Maybe Int
-- | Photo height.
[sendInvoicePhotoHeight] :: SendInvoiceRequest -> Maybe Int
-- | Pass True, if you require the user's full name to complete the
-- order.
[sendInvoiceNeedName] :: SendInvoiceRequest -> Maybe Bool
-- | Pass True, if you require the user's phone number to complete
-- the order.
[sendInvoiceNeedPhoneNumber] :: SendInvoiceRequest -> Maybe Bool
-- | Pass True, if you require the user's email address to complete
-- the order.
[sendInvoiceNeedEmail] :: SendInvoiceRequest -> Maybe Bool
-- | Pass True, if you require the user's shipping address to
-- complete the order.
[sendInvoiceNeedShippingAddress] :: SendInvoiceRequest -> Maybe Bool
-- | Pass True, if you require the user's phone number to complete
-- the order.
[sendInvoiceSendPhoneNumberToProvider] :: SendInvoiceRequest -> Maybe Bool
-- | Pass True, if user's email address should be sent to provider.
[sendInvoiceSendEmailToProvider] :: SendInvoiceRequest -> Maybe Bool
-- | Pass True, if the final price depends on the shipping method.
[sendInvoiceIsFlexible] :: SendInvoiceRequest -> Maybe Bool
-- | Sends the message silently. Users will receive a notification with no
-- sound.
[sendInvoiceDisableNotification] :: SendInvoiceRequest -> Maybe Bool
-- | Protects the contents of the sent message from forwarding and saving.
[sendInvoiceProtectContent] :: SendInvoiceRequest -> Maybe Bool
-- | If the message is a reply, ID of the original message.
[sendInvoiceReplyToMessageId] :: SendInvoiceRequest -> Maybe MessageId
-- | Description of the message to reply to.
[sendInvoiceReplyParameters] :: SendInvoiceRequest -> Maybe ReplyParameters
-- | A JSON-serialized object for an inline keyboard. If empty, one 'Pay
-- total price' button will be shown. If not empty, the first button must
-- be a Pay button.
[sendInvoiceReplyMarkup] :: SendInvoiceRequest -> Maybe InlineKeyboardMarkup
type SendInvoice = "sendInvoice" :> ReqBody '[JSON] SendInvoiceRequest :> Post '[JSON] (Response Message)
-- | Use this method to send invoices. On success, the sent Message
-- is returned.
sendInvoice :: SendInvoiceRequest -> ClientM (Response Message)
data CreateInvoiceLinkRequest
CreateInvoiceLinkRequest :: Text -> Text -> Text -> Text -> Text -> [LabeledPrice] -> Maybe Integer -> Maybe [Integer] -> Maybe Text -> Maybe Text -> Maybe Int -> Maybe Int -> Maybe Int -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> CreateInvoiceLinkRequest
-- | Product name, 1-32 characters.
[createInvoiceLinkTitle] :: CreateInvoiceLinkRequest -> Text
-- | Product description, 1-255 characters.
[createInvoiceLinkDescription] :: CreateInvoiceLinkRequest -> Text
-- | Bot-defined invoice payload, 1-128 bytes. This will not be displayed
-- to the user, use for your internal processes.
[createInvoiceLinkPayload] :: CreateInvoiceLinkRequest -> Text
-- | Payment provider token, obtained via BotFather.
[createInvoiceLinkProviderToken] :: CreateInvoiceLinkRequest -> Text
-- | Three-letter ISO 4217 currency code, see more on currencies.
[createInvoiceLinkCurrency] :: CreateInvoiceLinkRequest -> Text
-- | Price breakdown, a JSON-serialized list of components (e.g. product
-- price, tax, discount, delivery cost, delivery tax, bonus, etc.).
[createInvoiceLinkPrices] :: CreateInvoiceLinkRequest -> [LabeledPrice]
-- | The maximum accepted amount for tips in the smallest units of the
-- currency (integer, not float/double). For example, for a maximum tip
-- of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in
-- currencies.json, it shows the number of digits past the decimal point
-- for each currency (2 for the majority of currencies). Defaults to 0.
[createInvoiceLinkMaxTipAmount] :: CreateInvoiceLinkRequest -> Maybe Integer
-- | A JSON-serialized array of suggested amounts of tips in the smallest
-- units of the currency (integer, not float/double). At most 4 suggested
-- tip amounts can be specified. The suggested tip amounts must be
-- positive, passed in a strictly increased order and must not exceed
-- max_tip_amount.
[createInvoiceLinkSuggestedTipAmounts] :: CreateInvoiceLinkRequest -> Maybe [Integer]
-- | JSON-serialized data about the invoice, which will be shared with the
-- payment provider. A detailed description of required fields should be
-- provided by the payment provider.
[createInvoiceLinkProviderData] :: CreateInvoiceLinkRequest -> Maybe Text
-- | URL of the product photo for the invoice. Can be a photo of the goods
-- or a marketing image for a service.
[createInvoiceLinkPhotoUrl] :: CreateInvoiceLinkRequest -> Maybe Text
-- | Photo size in bytes.
[createInvoiceLinkPhotoSize] :: CreateInvoiceLinkRequest -> Maybe Int
-- | Photo width.
[createInvoiceLinkPhotoWidth] :: CreateInvoiceLinkRequest -> Maybe Int
-- | Photo height
[createInvoiceLinkPhotoHeight] :: CreateInvoiceLinkRequest -> Maybe Int
-- | Pass True if you require the user's full name to complete the
-- order.
[createInvoiceLinkNeedName] :: CreateInvoiceLinkRequest -> Maybe Bool
-- | Pass True if you require the user's phone number to complete
-- the order.
[createInvoiceLinkNeedPhoneNumber] :: CreateInvoiceLinkRequest -> Maybe Bool
-- | Pass True if you require the user's email address to complete
-- the order.
[createInvoiceLinkNeedEmail] :: CreateInvoiceLinkRequest -> Maybe Bool
-- | Pass True if you require the user's shipping address to
-- complete the order.
[createInvoiceLinkNeedShippingAddress] :: CreateInvoiceLinkRequest -> Maybe Bool
-- | Pass True if the user's phone number should be sent to the
-- provider.
[createInvoiceLinkSendPhoneNumberToProvider] :: CreateInvoiceLinkRequest -> Maybe Bool
-- | Pass True if the user's email address should be sent to the
-- provider.
[createInvoiceLinkSendEmailToProvider] :: CreateInvoiceLinkRequest -> Maybe Bool
-- | Pass True if the final price depends on the shipping method.
[createInvoiceLinkIsFlexible] :: CreateInvoiceLinkRequest -> Maybe Bool
type CreateInvoiceLink = "createInvoiceLink" :> ReqBody '[JSON] CreateInvoiceLinkRequest :> Post '[JSON] (Response Text)
-- | Use this method to create a link for an invoice. Returns the created
-- invoice link as Text on success.
createInvoiceLink :: CreateInvoiceLinkRequest -> ClientM (Response Text)
data AnswerShippingQueryRequest
AnswerShippingQueryRequest :: Text -> Bool -> Maybe [ShippingOption] -> Maybe Text -> AnswerShippingQueryRequest
-- | Unique identifier for the query to be answered.
[answerShippingQueryShippingQueryId] :: AnswerShippingQueryRequest -> Text
-- | Specify True if delivery to the specified address is possible
-- and False if there are any problems (for example, if delivery
-- to the specified address is not possible).
[answerShippingQueryOk] :: AnswerShippingQueryRequest -> Bool
-- | Required if ok is True. A JSON-serialized array of
-- available shipping options.
[answerShippingQueryShippingOptions] :: AnswerShippingQueryRequest -> Maybe [ShippingOption]
-- | Required if ok is False. Error message in human
-- readable form that explains why it is impossible to complete the order
-- (e.g. "Sorry, delivery to your desired address is unavailable').
-- Telegram will display this message to the user.
[answerShippingQueryErrorMessage] :: AnswerShippingQueryRequest -> Maybe Text
type AnswerShippingQuery = "answerShippingQuery" :> ReqBody '[JSON] AnswerShippingQueryRequest :> Post '[JSON] (Response Bool)
-- | If you sent an invoice requesting a shipping address and the parameter
-- is_flexible was specified, the Bot API will send an
-- Update with a shipping_query field to the bot. Use
-- this method to reply to shipping queries. On success, True is
-- returned.
answerShippingQuery :: AnswerShippingQueryRequest -> ClientM (Response Bool)
data AnswerPreCheckoutQueryRequest
AnswerPreCheckoutQueryRequest :: Text -> Bool -> Maybe Text -> AnswerPreCheckoutQueryRequest
-- | Unique identifier for the query to be answered.
[answerPreCheckoutQueryPreCheckoutQueryId] :: AnswerPreCheckoutQueryRequest -> Text
-- | Specify True if everything is alright (goods are available,
-- etc.) and the bot is ready to proceed with the order. Use False if
-- there are any problems.
[answerPreCheckoutQueryOk] :: AnswerPreCheckoutQueryRequest -> Bool
-- | Required if ok is False. Error message in human
-- readable form that explains the reason for failure to proceed with the
-- checkout (e.g. "Sorry, somebody just bought the last of our amazing
-- black T-shirts while you were busy filling out your payment details.
-- Please choose a different color or garment!"). Telegram will display
-- this message to the user.
[answerPreCheckoutQueryErrorMessage] :: AnswerPreCheckoutQueryRequest -> Maybe Text
type AnswerPreCheckoutQuery = "answerPreCheckoutQuery" :> ReqBody '[JSON] AnswerPreCheckoutQueryRequest :> Post '[JSON] (Response Bool)
-- | Once the user has confirmed their payment and shipping details, the
-- Bot API sends the final confirmation in the form of an Update with the
-- field pre_checkout_query. Use this method to respond to such
-- pre-checkout queries. On success, True is returned. Note: The
-- Bot API must receive an answer within 10 seconds after the
-- pre-checkout query was sent.
answerPreCheckoutQuery :: AnswerPreCheckoutQueryRequest -> ClientM (Response Bool)
defAnswerPreCheckoutQuery :: Text -> Bool -> AnswerPreCheckoutQueryRequest
defAnswerShippingQuery :: Text -> Bool -> AnswerShippingQueryRequest
defCreateInvoiceLink :: Text -> Text -> Text -> Text -> Text -> [LabeledPrice] -> CreateInvoiceLinkRequest
defSendInvoice :: ChatId -> Text -> Text -> Text -> Text -> Text -> [LabeledPrice] -> SendInvoiceRequest
instance GHC.Show.Show Telegram.Bot.API.Payments.SendInvoiceRequest
instance GHC.Generics.Generic Telegram.Bot.API.Payments.SendInvoiceRequest
instance GHC.Show.Show Telegram.Bot.API.Payments.CreateInvoiceLinkRequest
instance GHC.Generics.Generic Telegram.Bot.API.Payments.CreateInvoiceLinkRequest
instance GHC.Show.Show Telegram.Bot.API.Payments.AnswerShippingQueryRequest
instance GHC.Generics.Generic Telegram.Bot.API.Payments.AnswerShippingQueryRequest
instance GHC.Show.Show Telegram.Bot.API.Payments.AnswerPreCheckoutQueryRequest
instance GHC.Generics.Generic Telegram.Bot.API.Payments.AnswerPreCheckoutQueryRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Payments.AnswerPreCheckoutQueryRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Payments.AnswerPreCheckoutQueryRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Payments.AnswerShippingQueryRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Payments.AnswerShippingQueryRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Payments.CreateInvoiceLinkRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Payments.CreateInvoiceLinkRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Payments.SendInvoiceRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Payments.SendInvoiceRequest
module Telegram.Bot.API.Passport
type SetPassportDataErrors = "setPassportDataErrors" :> RequiredQueryParam "user_id" UserId :> RequiredQueryParam "errors" [PassportElementError] :> Get '[JSON] (Response Bool)
-- | Use this if the data submitted by the user doesn't satisfy the
-- standards your service requires for any reason. For example, if a
-- birthday date seems invalid, a submitted document is blurry, a scan
-- shows evidence of tampering, etc. Supply some details in the error
-- message to make sure the user knows how to correct the issues.
setPassportDataErrors :: UserId -> [PassportElementError] -> ClientM (Response Bool)
module Telegram.Bot.API.Methods.UnpinChatMessage
type UnpinChatMessage = "unpinChatMessage" :> RequiredQueryParam "chat_id" SomeChatId :> QueryParam "message_id" MessageId :> Post '[JSON] (Response Bool)
-- | Use this method to remove a message from the list of pinned messages
-- in a chat. If the chat is not a private chat, the bot must be an
-- administrator in the chat for this to work and must have the
-- can_pin_messages administrator right in a supergroup or
-- can_edit_messages administrator right in a channel. Returns
-- True on success.
unpinChatMessage :: SomeChatId -> Maybe MessageId -> ClientM (Response Bool)
module Telegram.Bot.API.Methods.UnpinAllChatMessages
type UnpinAllChatMessages = "unpinAllChatMessages" :> RequiredQueryParam "chat_id" SomeChatId :> Post '[JSON] (Response Bool)
-- | Use this method to clear the list of pinned messages in a chat. If the
-- chat is not a private chat, the bot must be an administrator in the
-- chat for this to work and must have the can_pin_messages
-- administrator right in a supergroup or can_edit_messages
-- administrator right in a channel. Returns True on success.
unpinAllChatMessages :: SomeChatId -> ClientM (Response Bool)
module Telegram.Bot.API.Methods.UnbanChatSenderChat
type UnbanChatSenderChat = "unbanChatSenderChat" :> RequiredQueryParam "chat_id" SomeChatId :> RequiredQueryParam "sender_chat_id" ChatId :> Post '[JSON] (Response Bool)
-- | Use this method to unban a previously banned channel chat in a
-- supergroup or channel. The bot must be an administrator for this to
-- work and must have the appropriate administrator rights. Returns True
-- on success.
unbanChatSenderChat :: SomeChatId -> ChatId -> ClientM (Response Bool)
module Telegram.Bot.API.Methods.UnbanChatMember
-- | Request parameters for unbanChatMember.
data UnbanChatMemberRequest
UnbanChatMemberRequest :: SomeChatId -> UserId -> Maybe Bool -> UnbanChatMemberRequest
-- | Unique identifier for the target chat or username of the target
-- channel (in the format @channelusername)
[unbanChatMemberChatId] :: UnbanChatMemberRequest -> SomeChatId
-- | Unique identifier of the target user
[unbanChatMemberUserId] :: UnbanChatMemberRequest -> UserId
-- | Do nothing if the user is not banned
[unbanChatMemberOnlyIfBanned] :: UnbanChatMemberRequest -> Maybe Bool
type UnbanChatMember = "unbanChatMember" :> ReqBody '[JSON] UnbanChatMemberRequest :> Post '[JSON] (Response Bool)
-- | Use this method to unban a previously banned user in a supergroup or
-- channel. The user will not return to the group or channel
-- automatically, but will be able to join via link, etc. The bot must be
-- an administrator for this to work. By default, this method guarantees
-- that after the call the user is not a member of the chat, but will be
-- able to join it. So if the user is a member of the chat they will also
-- be removed from the chat. If you don't want this, use the parameter
-- only_if_banned. Returns True on success.
unbanChatMember :: UnbanChatMemberRequest -> ClientM (Response Bool)
defUnbanChatMember :: SomeChatId -> UserId -> UnbanChatMemberRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.UnbanChatMember.UnbanChatMemberRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.UnbanChatMember.UnbanChatMemberRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Methods.UnbanChatMember.UnbanChatMemberRequest
module Telegram.Bot.API.Methods.StopMessageLiveLocation
-- | Request parameters for stopMessageLiveLocation.
data StopMessageLiveLocationRequest
StopMessageLiveLocationRequest :: Maybe SomeChatId -> Maybe MessageId -> Maybe Text -> Maybe InlineKeyboardMarkup -> StopMessageLiveLocationRequest
-- | Unique identifier for the target chat or username of the target
-- channel (in the format @channelusername)
[stopMessageLiveLocationChatId] :: StopMessageLiveLocationRequest -> Maybe SomeChatId
-- | Required if inline_message_id is not specified. Identifier of the
-- message with live location to stop
[stopMessageLiveLocationMessageId] :: StopMessageLiveLocationRequest -> Maybe MessageId
-- | Required if chat_id and message_id are not specified. Identifier of
-- the inline message
[stopMessageLiveLocationInlineMessageId] :: StopMessageLiveLocationRequest -> Maybe Text
-- | Additional interface options. A JSON-serialized object for an inline
-- keyboard, custom reply keyboard, instructions to remove reply keyboard
-- or to force a reply from the user.
[stopMessageLiveLocationReplyMarkup] :: StopMessageLiveLocationRequest -> Maybe InlineKeyboardMarkup
type StopMessageLiveLocation = "stopMessageLiveLocation" :> ReqBody '[JSON] StopMessageLiveLocationRequest :> Post '[JSON] (Response (Either Bool Message))
-- | Use this method to stop updating a live location message before
-- live_period expires. On success, if the message is not an inline
-- message, the edited Message is returned, otherwise True is returned.
stopMessageLiveLocation :: StopMessageLiveLocationRequest -> ClientM (Response (Either Bool Message))
defStopMessageLiveLocation :: StopMessageLiveLocationRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.StopMessageLiveLocation.StopMessageLiveLocationRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.StopMessageLiveLocation.StopMessageLiveLocationRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Methods.StopMessageLiveLocation.StopMessageLiveLocationRequest
module Telegram.Bot.API.Methods.SetStickerSetTitle
type SetStickerSetTitle = "setStickerSetTitle" :> RequiredQueryParam "name" Text :> RequiredQueryParam "title" Text :> Post '[JSON] (Response Bool)
-- | Use this method to set the title of a created sticker set. Returns
-- True on success.
setStickerSetTitle :: Text -> Text -> ClientM (Response Bool)
module Telegram.Bot.API.Methods.SetStickerMaskPosition
-- | Request parameters for setStickerMaskPosition.
data SetStickerMaskPositionRequest
SetStickerMaskPositionRequest :: Text -> Maybe [MaskPosition] -> SetStickerMaskPositionRequest
-- | File identifier of the sticker
[setStickerMaskPositionSticker] :: SetStickerMaskPositionRequest -> Text
-- | A JSON-serialized object with the position where the mask should be
-- placed on faces. Omit the parameter to remove the mask position.
[setStickerMaskPositionMaskPosition] :: SetStickerMaskPositionRequest -> Maybe [MaskPosition]
type SetStickerMaskPosition = "setStickerMaskPosition" :> ReqBody '[JSON] SetStickerMaskPositionRequest :> Post '[JSON] (Response Bool)
-- | Use this method to change the mask position of a mask sticker. The
-- sticker must belong to a sticker set that was created by the bot.
-- Returns True on success.
setStickerMaskPosition :: SetStickerMaskPositionRequest -> ClientM (Response Bool)
defSetStickerMaskPosition :: Text -> SetStickerMaskPositionRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.SetStickerMaskPosition.SetStickerMaskPositionRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.SetStickerMaskPosition.SetStickerMaskPositionRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Methods.SetStickerMaskPosition.SetStickerMaskPositionRequest
module Telegram.Bot.API.Methods.SetStickerKeywords
-- | Request parameters for setStickerKeywords.
data SetStickerKeywordsRequest
SetStickerKeywordsRequest :: Text -> Maybe [Text] -> SetStickerKeywordsRequest
-- | File identifier of the sticker
[setStickerKeywordsSticker] :: SetStickerKeywordsRequest -> Text
-- | A JSON-serialized list of 0-20 search keywords for the sticker with
-- total length of up to 64 characters
[setStickerKeywordsKeywords] :: SetStickerKeywordsRequest -> Maybe [Text]
type SetStickerKeywords = "setStickerKeywords" :> ReqBody '[JSON] SetStickerKeywordsRequest :> Post '[JSON] (Response Bool)
-- | Use this method to change search keywords assigned to a regular or
-- custom emoji sticker. The sticker must belong to a sticker set created
-- by the bot. Returns True on success.
setStickerKeywords :: SetStickerKeywordsRequest -> ClientM (Response Bool)
defSetStickerKeywords :: Text -> SetStickerKeywordsRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.SetStickerKeywords.SetStickerKeywordsRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.SetStickerKeywords.SetStickerKeywordsRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Methods.SetStickerKeywords.SetStickerKeywordsRequest
module Telegram.Bot.API.Methods.SetStickerEmojiList
-- | Request parameters for setStickerEmojiList.
data SetStickerEmojiListRequest
SetStickerEmojiListRequest :: Text -> [Text] -> SetStickerEmojiListRequest
-- | File identifier of the sticker
[setStickerEmojiListSticker] :: SetStickerEmojiListRequest -> Text
-- | A JSON-serialized list of 1-20 emoji associated with the sticker
[setStickerEmojiListEmojiList] :: SetStickerEmojiListRequest -> [Text]
type SetStickerEmojiList = "setStickerEmojiList" :> ReqBody '[JSON] SetStickerEmojiListRequest :> Post '[JSON] (Response Bool)
-- | Use this method to change the list of emoji assigned to a regular or
-- custom emoji sticker. The sticker must belong to a sticker set created
-- by the bot. Returns True on success.
setStickerEmojiList :: SetStickerEmojiListRequest -> ClientM (Response Bool)
defSetStickerEmojiList :: Text -> [Text] -> SetStickerEmojiListRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.SetStickerEmojiList.SetStickerEmojiListRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.SetStickerEmojiList.SetStickerEmojiListRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Methods.SetStickerEmojiList.SetStickerEmojiListRequest
module Telegram.Bot.API.Methods.SetMyShortDescription
data SetMyShortDescriptionRequest
SetMyShortDescriptionRequest :: Maybe Text -> Maybe Text -> SetMyShortDescriptionRequest
-- | New short description for the bot; 0-120 characters. Pass an empty
-- string to remove the dedicated short description for the given
-- language.
[setMyShortDescriptionDescription] :: SetMyShortDescriptionRequest -> Maybe Text
-- | A two-letter ISO 639-1 language code. If empty, the short description
-- will be applied to all users for whose language there is no dedicated
-- short description.
[setMyShortDescriptionLanguageCode] :: SetMyShortDescriptionRequest -> Maybe Text
type SetMyShortDescription = "setMyShortDescription" :> ReqBody '[JSON] SetMyShortDescriptionRequest :> Post '[JSON] (Response Bool)
-- | Use this method to change the bot's short description, which is shown
-- on the bot's profile page and is sent together with the link when
-- users share the bot. Returns True on success.
setMyShortDescription :: SetMyShortDescriptionRequest -> ClientM (Response Bool)
defSetMyShortDescription :: SetMyShortDescriptionRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.SetMyShortDescription.SetMyShortDescriptionRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.SetMyShortDescription.SetMyShortDescriptionRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Methods.SetMyShortDescription.SetMyShortDescriptionRequest
module Telegram.Bot.API.Methods.SetMyName
data SetMyNameRequest
SetMyNameRequest :: Maybe Text -> Maybe Text -> SetMyNameRequest
-- | New bot name; 0-64 characters. Pass an empty string to remove the
-- dedicated name for the given language.
[setMyNameName] :: SetMyNameRequest -> Maybe Text
-- | A two-letter ISO 639-1 language code. If empty, the name will be shown
-- to all users for whose language there is no dedicated name.
[setMyNameLanguageCode] :: SetMyNameRequest -> Maybe Text
type SetMyName = "setMyName" :> ReqBody '[JSON] SetMyNameRequest :> Post '[JSON] (Response Bool)
-- | Use this method to change the bot's name. Returns True on
-- success.
setMyName :: SetMyNameRequest -> ClientM (Response Bool)
defSetMyName :: SetMyNameRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.SetMyName.SetMyNameRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.SetMyName.SetMyNameRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Methods.SetMyName.SetMyNameRequest
module Telegram.Bot.API.Methods.SetMyDescription
data SetMyDescriptionRequest
SetMyDescriptionRequest :: Maybe Text -> Maybe Text -> SetMyDescriptionRequest
-- | New bot description; 0-512 characters. Pass an empty string to remove
-- the dedicated description for the given language.
[setMyDescriptionDescription] :: SetMyDescriptionRequest -> Maybe Text
-- | A two-letter ISO 639-1 language code. If empty, the description will
-- be applied to all users for whose language there is no dedicated
-- description.
[setMyDescriptionLanguageCode] :: SetMyDescriptionRequest -> Maybe Text
type SetMyDescription = "setMyDescription" :> ReqBody '[JSON] SetMyDescriptionRequest :> Post '[JSON] (Response Bool)
-- | Use this method to change the bot's description, which is shown in the
-- chat with the bot if the chat is empty. Returns True on
-- success.
setMyDescription :: SetMyDescriptionRequest -> ClientM (Response Bool)
defSetMyDescription :: SetMyDescriptionRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.SetMyDescription.SetMyDescriptionRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.SetMyDescription.SetMyDescriptionRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Methods.SetMyDescription.SetMyDescriptionRequest
module Telegram.Bot.API.Methods.SetMyDefaultAdministratorRights
-- | Request parameters for setMyDefaultAdministratorRights.
data SetMyDefaultAdministratorRightsRequest
SetMyDefaultAdministratorRightsRequest :: Maybe ChatAdministratorRights -> Maybe Bool -> SetMyDefaultAdministratorRightsRequest
-- | A JSON-serialized object describing new default administrator rights.
-- If not specified, the default administrator rights will be cleared.
[setMyDefaultAdministratorRightsRequestRights] :: SetMyDefaultAdministratorRightsRequest -> Maybe ChatAdministratorRights
-- | Pass True to change the default administrator rights of the bot
-- in channels. Otherwise, the default administrator rights of the bot
-- for groups and supergroups will be changed.
[setMyDefaultAdministratorRightsRequestForChannels] :: SetMyDefaultAdministratorRightsRequest -> Maybe Bool
type SetMyDefaultAdministratorRights = "setMyDefaultAdministratorRights" :> ReqBody '[JSON] SetMyDefaultAdministratorRightsRequest :> Post '[JSON] (Response Bool)
-- | Use this method to change the default administrator rights requested
-- by the bot when it's added as an administrator to groups or channels.
-- These rights will be suggested to users, but they are are free to
-- modify the list before adding the bot. Returns True on success.
setMyDefaultAdministratorRights :: SetMyDefaultAdministratorRightsRequest -> ClientM (Response Bool)
defSetMyDefaultAdministratorRights :: SetMyDefaultAdministratorRightsRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.SetMyDefaultAdministratorRights.SetMyDefaultAdministratorRightsRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.SetMyDefaultAdministratorRights.SetMyDefaultAdministratorRightsRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Methods.SetMyDefaultAdministratorRights.SetMyDefaultAdministratorRightsRequest
module Telegram.Bot.API.Methods.SetMyCommands
-- | Request parameters for setMyCommands.
data SetMyCommandsRequest
SetMyCommandsRequest :: [BotCommand] -> Maybe BotCommandScope -> Maybe Text -> SetMyCommandsRequest
-- | A JSON-serialized list of bot commands to be set as the list of the
-- bot's commands. At most 100 commands can be specified.
[setMyCommandsCommands] :: SetMyCommandsRequest -> [BotCommand]
-- | A JSON-serialized object, describing scope of users for which the
-- commands are relevant. Defaults to BotCommandScopeDefault.
[setMyCommandsScope] :: SetMyCommandsRequest -> Maybe BotCommandScope
-- | A two-letter ISO 639-1 language code. If empty, commands will be
-- applied to all users from the given scope, for whose language there
-- are no dedicated commands
[setMyCommandsLanguageCode] :: SetMyCommandsRequest -> Maybe Text
type SetMyCommands = "setMyCommands" :> ReqBody '[JSON] SetMyCommandsRequest :> Post '[JSON] (Response Bool)
-- | Use this method to change the list of the bot's commands. See
-- https://core.telegram.org/bots#commands for more details about
-- bot commands. Returns True on success.
setMyCommands :: SetMyCommandsRequest -> ClientM (Response Bool)
defSetMyCommands :: [BotCommand] -> SetMyCommandsRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.SetMyCommands.SetMyCommandsRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.SetMyCommands.SetMyCommandsRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Methods.SetMyCommands.SetMyCommandsRequest
module Telegram.Bot.API.Methods.SetMessageReaction
-- | Request parameters for setMessageReaction
data SetMessageReactionRequest
SetMessageReactionRequest :: SomeChatId -> MessageId -> Maybe [ReactionType] -> Maybe Bool -> SetMessageReactionRequest
-- | Unique identifier for the target chat or username of the target
-- channel (in the format @channelusername).
[setMessageReactionRequestChatId] :: SetMessageReactionRequest -> SomeChatId
-- | Identifier of the target message. If the message belongs to a media
-- group, the reaction is set to the first non-deleted message in the
-- group instead.
[setMessageReactionRequestMessageId] :: SetMessageReactionRequest -> MessageId
-- | New list of reaction types to set on the message. Currently, as
-- non-premium users, bots can set up to one reaction per message. A
-- custom emoji reaction can be used if it is either already present on
-- the message or explicitly allowed by chat administrators.
[setMessageReactionRequestReaction] :: SetMessageReactionRequest -> Maybe [ReactionType]
-- | Pass True to set the reaction with a big animation.
[setMessageReactionRequestIsBig] :: SetMessageReactionRequest -> Maybe Bool
type SetMessageReaction = "setMessageReaction" :> ReqBody '[JSON] SetMessageReactionRequest :> Post '[JSON] (Response Bool)
setMessageReaction :: SetMessageReactionRequest -> ClientM (Response Bool)
defSetMessageReaction :: SomeChatId -> MessageId -> SetMessageReactionRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.SetMessageReaction.SetMessageReactionRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.SetMessageReaction.SetMessageReactionRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Methods.SetMessageReaction.SetMessageReactionRequest
module Telegram.Bot.API.Methods.SetCustomEmojiStickerSetThumbnail
data SetCustomEmojiStickerSetThumbnailRequest
SetCustomEmojiStickerSetThumbnailRequest :: Text -> Maybe Text -> SetCustomEmojiStickerSetThumbnailRequest
-- | Sticker set name
[setCustomEmojiStickerSetThumbnailName] :: SetCustomEmojiStickerSetThumbnailRequest -> Text
-- | Custom emoji identifier of a sticker from the sticker set; pass an
-- empty string to drop the thumbnail and use the first sticker as the
-- thumbnail.
[setCustomEmojiStickerSetThumbnailCustomEmojiId] :: SetCustomEmojiStickerSetThumbnailRequest -> Maybe Text
type SetCustomEmojiStickerSetThumbnail = "setCustomEmojiStickerSetThumbnail" :> ReqBody '[JSON] SetCustomEmojiStickerSetThumbnailRequest :> Post '[JSON] (Response Bool)
-- | Use this method to set the thumbnail of a custom emoji sticker set.
-- Returns True on success.
setCustomEmojiStickerSetThumbnail :: SetCustomEmojiStickerSetThumbnailRequest -> ClientM (Response Bool)
defSetCustomEmojiStickerSetThumbnail :: Text -> SetCustomEmojiStickerSetThumbnailRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.SetCustomEmojiStickerSetThumbnail.SetCustomEmojiStickerSetThumbnailRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.SetCustomEmojiStickerSetThumbnail.SetCustomEmojiStickerSetThumbnailRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Methods.SetCustomEmojiStickerSetThumbnail.SetCustomEmojiStickerSetThumbnailRequest
module Telegram.Bot.API.Methods.SetChatTitle
type SetChatTitle = "setChatTitle" :> RequiredQueryParam "chat_id" SomeChatId :> RequiredQueryParam "title" Text :> Post '[JSON] (Response Bool)
-- | Use this method to change the title of a chat. Titles can't be changed
-- for private chats. The bot must be an administrator in the chat for
-- this to work and must have the appropriate administrator rights.
-- Returns True on success.
setChatTitle :: SomeChatId -> Text -> ClientM (Response Bool)
module Telegram.Bot.API.Methods.SetChatStickerSet
type SetChatStickerSet = "setChatStickerSet" :> RequiredQueryParam "chat_id" SomeChatId :> RequiredQueryParam "sticker_set_name" Text :> Post '[JSON] (Response Bool)
-- | Use this method to set a new group sticker set for a supergroup. The
-- bot must be an administrator in the chat for this to work and must
-- have the appropriate administrator rights. Use the field
-- can_set_sticker_set optionally returned in getChat requests to check
-- if the bot can use this method. Returns True on success.
setChatStickerSet :: SomeChatId -> Text -> ClientM (Response Bool)
module Telegram.Bot.API.Methods.SetChatPhoto
-- | Request parameters for setChatPhoto.
data SetChatPhotoRequest
SetChatPhotoRequest :: SomeChatId -> InputFile -> SetChatPhotoRequest
-- | Unique identifier for the target chat or username of the target
-- channel (in the format @channelusername)
[setChatPhotoChatId] :: SetChatPhotoRequest -> SomeChatId
-- | New chat photo, uploaded using multipart/form-data
[setChatPhotoPhoto] :: SetChatPhotoRequest -> InputFile
type SetChatPhoto = "setChatPhoto" :> MultipartForm Tmp SetChatPhotoRequest :> Post '[JSON] (Response Bool)
-- | Use this method to set a new profile photo for the chat. Photos can't
-- be changed for private chats. The bot must be an administrator in the
-- chat for this to work and must have the appropriate administrator
-- rights. Returns True on success.
--
--
setChatPhoto :: SetChatPhotoRequest -> ClientM (Response Bool)
defSetChatPhoto :: SomeChatId -> InputFile -> SetChatPhotoRequest
instance Servant.Multipart.API.ToMultipart Servant.Multipart.API.Tmp Telegram.Bot.API.Methods.SetChatPhoto.SetChatPhotoRequest
module Telegram.Bot.API.Methods.SetChatPermissions
-- | Request parameters for setChatPermissions.
data SetChatPermissionsRequest
SetChatPermissionsRequest :: SomeChatId -> ChatPermissions -> Maybe Bool -> SetChatPermissionsRequest
-- | Unique identifier for the target chat or username of the target
-- channel (in the format @channelusername).
[setChatPermissionsChatId] :: SetChatPermissionsRequest -> SomeChatId
-- | A JSON-serialized object for new default chat permissions.
[setChatPermissionsPermissions] :: SetChatPermissionsRequest -> ChatPermissions
-- | Pass True if chat permissions are set independently. Otherwise,
-- the can_send_other_messages and
-- can_add_web_page_previews permissions will imply the
-- can_send_messages, can_send_audios,
-- can_send_documents, can_send_photos,
-- can_send_videos, can_send_video_notes, and
-- can_send_voice_notes permissions; the can_send_polls
-- permission will imply the can_send_messages permission.
[setChatPermissionsUseIndependentChatPermissions] :: SetChatPermissionsRequest -> Maybe Bool
type SetChatPermissions = "setChatPermissions" :> ReqBody '[JSON] SetChatPermissionsRequest :> Post '[JSON] (Response Bool)
-- | Use this method to set default chat permissions for all members. The
-- bot must be an administrator in the group or a supergroup for this to
-- work and must have the can_restrict_members administrator rights.
-- Returns True on success.
setChatPermissions :: SetChatPermissionsRequest -> ClientM (Response Bool)
defSetChatPermissions :: SomeChatId -> ChatPermissions -> SetChatPermissionsRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.SetChatPermissions.SetChatPermissionsRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.SetChatPermissions.SetChatPermissionsRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Methods.SetChatPermissions.SetChatPermissionsRequest
module Telegram.Bot.API.Methods.SetChatMenuButton
-- | Request parameters for setChatMenuButton.
data SetChatMenuButtonRequest
SetChatMenuButtonRequest :: Maybe ChatId -> Maybe MenuButton -> SetChatMenuButtonRequest
-- | Unique identifier for the target private chat. If not specified,
-- default bot's menu button will be changed.
[setChatMenuButtonRequestChatId] :: SetChatMenuButtonRequest -> Maybe ChatId
-- | A JSON-serialized object for the new bot's menu button. Defaults to
-- MenuButtonDefault.
[setChatMenuButtonRequestMenuButton] :: SetChatMenuButtonRequest -> Maybe MenuButton
type SetChatMenuButton = "setChatMenuButton" :> ReqBody '[JSON] SetChatMenuButtonRequest :> Post '[JSON] (Response Bool)
-- | Use this method to change the bot's menu button in a private chat, or
-- the default menu button. Returns True on success.
setChatMenuButton :: SetChatMenuButtonRequest -> ClientM (Response Bool)
defSetChatMenuButton :: SetChatMenuButtonRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.SetChatMenuButton.SetChatMenuButtonRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.SetChatMenuButton.SetChatMenuButtonRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Methods.SetChatMenuButton.SetChatMenuButtonRequest
module Telegram.Bot.API.Methods.SetChatDescription
type SetChatDescription = "setChatDescription" :> RequiredQueryParam "chat_id" SomeChatId :> QueryParam "description" Text :> Post '[JSON] (Response Bool)
-- | Use this method to change the description of a group, a supergroup or
-- a channel. The bot must be an administrator in the chat for this to
-- work and must have the appropriate administrator rights. Returns True
-- on success.
setChatDescription :: SomeChatId -> Maybe Text -> ClientM (Response Bool)
module Telegram.Bot.API.Methods.SetChatAdministratorCustomTitle
-- | Request parameters for setChatAdministratorCustomTitle.
data SetChatAdministratorCustomTitleRequest
SetChatAdministratorCustomTitleRequest :: SomeChatId -> UserId -> Text -> SetChatAdministratorCustomTitleRequest
-- | Unique identifier for the target chat or username of the target
-- channel (in the format @channelusername)
[setChatAdministratorCustomTitleChatId] :: SetChatAdministratorCustomTitleRequest -> SomeChatId
-- | Unique identifier of the target user
[setChatAdministratorCustomTitleUserId] :: SetChatAdministratorCustomTitleRequest -> UserId
-- | New custom title for the administrator; 0-16 characters, emoji are not
-- allowed
[setChatAdministratorCustomTitleCustomTitle] :: SetChatAdministratorCustomTitleRequest -> Text
type SetChatAdministratorCustomTitle = "setChatAdministratorCustomTitle" :> ReqBody '[JSON] SetChatAdministratorCustomTitleRequest :> Post '[JSON] (Response Bool)
-- | Use this method to set a custom title for an administrator in a
-- supergroup promoted by the bot. Returns True on success.
setChatAdministratorCustomTitle :: SetChatAdministratorCustomTitleRequest -> ClientM (Response Bool)
defSetChatAdministratorCustomTitle :: SomeChatId -> UserId -> Text -> SetChatAdministratorCustomTitleRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.SetChatAdministratorCustomTitle.SetChatAdministratorCustomTitleRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.SetChatAdministratorCustomTitle.SetChatAdministratorCustomTitleRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Methods.SetChatAdministratorCustomTitle.SetChatAdministratorCustomTitleRequest
module Telegram.Bot.API.Methods.SendVoice
-- | Request parameters for sendVoice.
data SendVoiceRequest
SendVoiceRequest :: Maybe BusinessConnectionId -> SomeChatId -> Maybe MessageThreadId -> InputFile -> Maybe Text -> Maybe ParseMode -> Maybe [MessageEntity] -> Maybe Int -> Maybe Bool -> Maybe Bool -> Maybe MessageId -> Maybe ReplyParameters -> Maybe InlineKeyboardMarkup -> SendVoiceRequest
-- | Unique identifier of the business connection on behalf of which the
-- message will be sent.
[sendVoiceBusinessConnectionId] :: SendVoiceRequest -> Maybe BusinessConnectionId
-- | Unique identifier for the target chat or username of the target
-- channel (in the format @channelusername).
[sendVoiceChatId] :: SendVoiceRequest -> SomeChatId
-- | Unique identifier for the target message thread (topic) of the forum;
-- for forum supergroups only.
[sendVoiceMessageThreadId] :: SendVoiceRequest -> Maybe MessageThreadId
-- | Audio file to send. Pass a file_id as String to send a file that
-- exists on the Telegram servers (recommended), pass an HTTP URL as a
-- String for Telegram to get a file from the Internet, or upload a new
-- one using multipart/form-data. More info on Sending Files »
[sendVoiceVoice] :: SendVoiceRequest -> InputFile
-- | Voice message caption, 0-1024 characters after entities parsing
[sendVoiceCaption] :: SendVoiceRequest -> Maybe Text
-- | Send MarkdownV2, HTML or Markdown (legacy), if
-- you want Telegram apps to show bold, italic, fixed-width text or
-- inline URLs in your bot's message.
[sendVoiceParseMode] :: SendVoiceRequest -> Maybe ParseMode
-- | A JSON-serialized list of special entities that appear in the caption,
-- which can be specified instead of parse_mode
[sendVoiceCaptionEntities] :: SendVoiceRequest -> Maybe [MessageEntity]
-- | Duration of the voice message in seconds
[sendVoiceDuration] :: SendVoiceRequest -> Maybe Int
-- | Sends the message silently. Users will receive a notification with no
-- sound.
[sendVoiceDisableNotification] :: SendVoiceRequest -> Maybe Bool
-- | Protects the contents of the sent message from forwarding and saving
[sendVoiceProtectContent] :: SendVoiceRequest -> Maybe Bool
-- | If the message is a reply, ID of the original message
[sendVoiceReplyToMessageId] :: SendVoiceRequest -> Maybe MessageId
-- | Description of the message to reply to.
[sendVoiceReplyParameters] :: SendVoiceRequest -> Maybe ReplyParameters
-- | Additional interface options. A JSON-serialized object for an inline
-- keyboard, custom reply keyboard, instructions to remove reply keyboard
-- or to force a reply from the user.
[sendVoiceReplyMarkup] :: SendVoiceRequest -> Maybe InlineKeyboardMarkup
type SendVoiceContent = "sendVoice" :> MultipartForm Tmp SendVoiceRequest :> Post '[JSON] (Response Message)
type SendVoiceLink = "sendVoice" :> ReqBody '[JSON] SendVoiceRequest :> Post '[JSON] (Response Message)
-- | Use this method to send audio files, if you want Telegram clients to
-- display the file as a playable voice message. For this to work, your
-- audio must be in an .OGG file encoded with OPUS (other formats may be
-- sent as Audio or Document). On success, the sent Message is returned.
-- Bots can currently send voice messages of up to 50 MB in size, this
-- limit may be changed in the future.
sendVoice :: SendVoiceRequest -> ClientM (Response Message)
defSendVoice :: SomeChatId -> InputFile -> SendVoiceRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.SendVoice.SendVoiceRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.SendVoice.SendVoiceRequest
instance Servant.Multipart.API.ToMultipart Servant.Multipart.API.Tmp Telegram.Bot.API.Methods.SendVoice.SendVoiceRequest
module Telegram.Bot.API.Methods.SendVideoNote
-- | Request parameters for sendVideoNote.
data SendVideoNoteRequest
SendVideoNoteRequest :: Maybe BusinessConnectionId -> SomeChatId -> Maybe MessageThreadId -> InputFile -> Maybe Int -> Maybe Int -> Maybe InputFile -> Maybe Bool -> Maybe Bool -> Maybe MessageId -> Maybe ReplyParameters -> Maybe InlineKeyboardMarkup -> SendVideoNoteRequest
-- | Unique identifier of the business connection on behalf of which the
-- message will be sent.
[sendVideoNoteBusinessConnectionId] :: SendVideoNoteRequest -> Maybe BusinessConnectionId
-- | Unique identifier for the target chat or username of the target
-- channel (in the format @channelusername).
[sendVideoNoteChatId] :: SendVideoNoteRequest -> SomeChatId
-- | Unique identifier for the target message thread (topic) of the forum;
-- for forum supergroups only.
[sendVideoNoteMessageThreadId] :: SendVideoNoteRequest -> Maybe MessageThreadId
-- | Video note to send. Pass a file_id as String to send a video note that
-- exists on the Telegram servers (recommended) or upload a new video
-- using multipart/form-data. More info on Sending Files ». Sending video
-- notes by a URL is currently unsupported
[sendVideoNoteVideoNote] :: SendVideoNoteRequest -> InputFile
-- | Duration of sent video in seconds
[sendVideoNoteDuration] :: SendVideoNoteRequest -> Maybe Int
-- | Video width and height, i.e. diameter of the video message
[sendVideoNoteLength] :: SendVideoNoteRequest -> Maybe Int
-- | Thumbnail of the file sent; can be ignored if thumbnail generation for
-- the file is supported server-side. The thumbnail should be in JPEG
-- format and less than 200 kB in size. A thumbnail's width and height
-- should not exceed 320. Ignored if the file is not uploaded using
-- multipartform-data. Thumbnails can't be reused and can be only
-- uploaded as a new file, so you can pass
-- “attach:file_attach_name” if the thumbnail was uploaded
-- using multipartform-data under file_attach_name. More info
-- on Sending Files »
[sendVideoNoteThumbnail] :: SendVideoNoteRequest -> Maybe InputFile
-- | Sends the message silently. Users will receive a notification with no
-- sound.
[sendVideoNoteDisableNotification] :: SendVideoNoteRequest -> Maybe Bool
-- | Protects the contents of the sent message from forwarding and saving
[sendVideoNoteProtectContent] :: SendVideoNoteRequest -> Maybe Bool
-- | If the message is a reply, ID of the original message
[sendVideoNoteReplyToMessageId] :: SendVideoNoteRequest -> Maybe MessageId
-- | Description of the message to reply to.
[sendVideoNoteReplyParameters] :: SendVideoNoteRequest -> Maybe ReplyParameters
-- | Additional interface options. A JSON-serialized object for an inline
-- keyboard, custom reply keyboard, instructions to remove reply keyboard
-- or to force a reply from the user.
[sendVideoNoteReplyMarkup] :: SendVideoNoteRequest -> Maybe InlineKeyboardMarkup
type SendVideoNoteContent = "sendVideoNote" :> MultipartForm Tmp SendVideoNoteRequest :> Post '[JSON] (Response Message)
type SendVideoNoteLink = "sendVideoNote" :> ReqBody '[JSON] SendVideoNoteRequest :> Post '[JSON] (Response Message)
-- | As of v.4.0, Telegram clients support rounded square mp4 videos of up
-- to 1 minute long. Use this method to send video messages. On success,
-- the sent Message is returned.
sendVideoNote :: SendVideoNoteRequest -> ClientM (Response Message)
defSendVideoNote :: SomeChatId -> InputFile -> SendVideoNoteRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.SendVideoNote.SendVideoNoteRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.SendVideoNote.SendVideoNoteRequest
instance Servant.Multipart.API.ToMultipart Servant.Multipart.API.Tmp Telegram.Bot.API.Methods.SendVideoNote.SendVideoNoteRequest
module Telegram.Bot.API.Methods.SendVideo
-- | Request parameters for sendVideo.
data SendVideoRequest
SendVideoRequest :: Maybe BusinessConnectionId -> SomeChatId -> Maybe MessageThreadId -> InputFile -> Maybe Int -> Maybe Int -> Maybe Int -> Maybe InputFile -> Maybe Text -> Maybe ParseMode -> Maybe [MessageEntity] -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe MessageId -> Maybe ReplyParameters -> Maybe InlineKeyboardMarkup -> SendVideoRequest
-- | Unique identifier of the business connection on behalf of which the
-- message will be sent.
[sendVideoBusinessConnectionId] :: SendVideoRequest -> Maybe BusinessConnectionId
-- | Unique identifier for the target chat or username of the target
-- channel (in the format @channelusername)
[sendVideoChatId] :: SendVideoRequest -> SomeChatId
-- | Unique identifier for the target message thread (topic) of the forum;
-- for forum supergroups only.
[sendVideoMessageThreadId] :: SendVideoRequest -> Maybe MessageThreadId
-- | Video to send. Pass a file_id as String to send an video that exists
-- on the Telegram servers (recommended), pass an HTTP URL as a String
-- for Telegram to get a video from the Internet, or upload a new video
-- using multipart/form-data. More info on Sending Files »
[sendVideoVideo] :: SendVideoRequest -> InputFile
-- | Duration of sent video in seconds
[sendVideoDuration] :: SendVideoRequest -> Maybe Int
-- | Video width
[sendVideoWidth] :: SendVideoRequest -> Maybe Int
-- | Video height
[sendVideoHeight] :: SendVideoRequest -> Maybe Int
-- | Thumbnail of the file sent; can be ignored if thumbnail generation for
-- the file is supported server-side. The thumbnail should be in JPEG
-- format and less than 200 kB in size. A thumbnail's width and height
-- should not exceed 320. Ignored if the file is not uploaded using
-- multipartform-data. Thumbnails can't be reused and can be only
-- uploaded as a new file, so you can pass
-- “attach:file_attach_name” if the thumbnail was uploaded
-- using multipartform-data under file_attach_name. More info
-- on Sending Files »
[sendVideoThumbnail] :: SendVideoRequest -> Maybe InputFile
-- | Video caption (may also be used when resending videos by file_id),
-- 0-1024 characters after entities parsing
[sendVideoCaption] :: SendVideoRequest -> Maybe Text
-- | Send MarkdownV2, HTML or Markdown (legacy), if
-- you want Telegram apps to show bold, italic, fixed-width text or
-- inline URLs in your bot's message.
[sendVideoParseMode] :: SendVideoRequest -> Maybe ParseMode
-- | A JSON-serialized list of special entities that appear in the caption,
-- which can be specified instead of parse_mode
[sendVideoCaptionEntities] :: SendVideoRequest -> Maybe [MessageEntity]
-- | Pass True if the video needs to be covered with a spoiler
-- animation.
[sendVideoHasSpoiler] :: SendVideoRequest -> Maybe Bool
-- | Pass True, if the uploaded video is suitable for streaming
[sendVideoSupportsStreaming] :: SendVideoRequest -> Maybe Bool
-- | Sends the message silently. Users will receive a notification with no
-- sound.
[sendVideoDisableNotification] :: SendVideoRequest -> Maybe Bool
-- | Protects the contents of the sent message from forwarding and saving.
[sendVideoProtectContent] :: SendVideoRequest -> Maybe Bool
-- | If the message is a reply, ID of the original message
[sendVideoReplyToMessageId] :: SendVideoRequest -> Maybe MessageId
-- | Description of the message to reply to.
[sendVideoReplyParameters] :: SendVideoRequest -> Maybe ReplyParameters
-- | Additional interface options. A JSON-serialized object for an inline
-- keyboard, custom reply keyboard, instructions to remove reply keyboard
-- or to force a reply from the user.
[sendVideoReplyMarkup] :: SendVideoRequest -> Maybe InlineKeyboardMarkup
type SendVideoContent = "sendVideo" :> MultipartForm Tmp SendVideoRequest :> Post '[JSON] (Response Message)
type SendVideoLink = "sendVideo" :> ReqBody '[JSON] SendVideoRequest :> Post '[JSON] (Response Message)
-- | Use this method to send video files, Telegram clients support mp4
-- videos (other formats may be sent as Document). On success, the sent
-- Message is returned. Bots can currently send video files of up to 50
-- MB in size, this limit may be changed in the future.
sendVideo :: SendVideoRequest -> ClientM (Response Message)
defSendVideo :: SomeChatId -> InputFile -> SendVideoRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.SendVideo.SendVideoRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.SendVideo.SendVideoRequest
instance Servant.Multipart.API.ToMultipart Servant.Multipart.API.Tmp Telegram.Bot.API.Methods.SendVideo.SendVideoRequest
module Telegram.Bot.API.Methods.SendVenue
-- | Request parameters for sendVenue.
data SendVenueRequest
SendVenueRequest :: Maybe BusinessConnectionId -> SomeChatId -> Maybe MessageThreadId -> Float -> Float -> Text -> Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Bool -> Maybe Bool -> Maybe MessageId -> Maybe ReplyParameters -> Maybe InlineKeyboardMarkup -> SendVenueRequest
-- | Unique identifier of the business connection on behalf of which the
-- message will be sent.
[sendVenueBusinessConnectionId] :: SendVenueRequest -> Maybe BusinessConnectionId
-- | Unique identifier for the target chat or username of the target
-- channel (in the format @channelusername).
[sendVenueChatId] :: SendVenueRequest -> SomeChatId
-- | Unique identifier for the target message thread (topic) of the forum;
-- for forum supergroups only.
[sendVenueMessageThreadId] :: SendVenueRequest -> Maybe MessageThreadId
-- | Latitude of the venue
[sendVenueLatitude] :: SendVenueRequest -> Float
-- | Longitude of the venue
[sendVenueLongitude] :: SendVenueRequest -> Float
-- | Name of the venue
[sendVenueTitle] :: SendVenueRequest -> Text
-- | Address of the venue
[sendVenueAddress] :: SendVenueRequest -> Text
-- | Foursquare identifier of the venue
[sendVenueFoursquareId] :: SendVenueRequest -> Maybe Text
-- | Foursquare type of the venue, if known. (For example,
-- “arts_entertainmentdefault”, “arts_entertainmentaquarium” or
-- “food/icecream”.)
[sendVenueFoursquareType] :: SendVenueRequest -> Maybe Text
-- | Google Places identifier of the venue
[sendVenueGooglePlaceId] :: SendVenueRequest -> Maybe Text
-- | Google Places type of the venue. (See supported types
-- https://developers.google.com/maps/documentation/places/web-service/supported_types.)
[sendVenueGooglePlaceType] :: SendVenueRequest -> Maybe Text
-- | Sends the message silently. Users will receive a notification with no
-- sound.
[sendVenueDisableNotification] :: SendVenueRequest -> Maybe Bool
-- | Protects the contents of the sent message from forwarding and saving
[sendVenueProtectContent] :: SendVenueRequest -> Maybe Bool
-- | If the message is a reply, ID of the original message
[sendVenueReplyToMessageId] :: SendVenueRequest -> Maybe MessageId
-- | Description of the message to reply to.
[sendVenueReplyParameters] :: SendVenueRequest -> Maybe ReplyParameters
-- | Additional interface options. A JSON-serialized object for an inline
-- keyboard, custom reply keyboard, instructions to remove reply keyboard
-- or to force a reply from the user.
[sendVenueReplyMarkup] :: SendVenueRequest -> Maybe InlineKeyboardMarkup
type SendVenue = "sendVenue" :> ReqBody '[JSON] SendVenueRequest :> Post '[JSON] (Response Message)
-- | Use this method to send information about a venue. On success, the
-- sent Message is returned.
sendVenue :: SendVenueRequest -> ClientM (Response Message)
defSendVenue :: SomeChatId -> Float -> Float -> Text -> Text -> SendVenueRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.SendVenue.SendVenueRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.SendVenue.SendVenueRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Methods.SendVenue.SendVenueRequest
module Telegram.Bot.API.Methods.SendPoll
-- | Request parameters for sendPoll.
data SendPollRequest
SendPollRequest :: Maybe BusinessConnectionId -> SomeChatId -> Maybe MessageThreadId -> Text -> Maybe ParseMode -> Maybe [MessageEntity] -> [InputPollOption] -> Maybe Bool -> Maybe Text -> Maybe Bool -> Maybe Int -> Maybe Text -> Maybe ParseMode -> Maybe [MessageEntity] -> Maybe Int -> Maybe Int -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe MessageId -> Maybe ReplyParameters -> Maybe InlineKeyboardMarkup -> SendPollRequest
-- | Unique identifier of the business connection on behalf of which the
-- message will be sent.
[sendPollBusinessConnectionId] :: SendPollRequest -> Maybe BusinessConnectionId
-- | Unique identifier for the target chat or username of the target
-- channel (in the format @channelusername).
[sendPollChatId] :: SendPollRequest -> SomeChatId
-- | Unique identifier for the target message thread (topic) of the forum;
-- for forum supergroups only.
[sendPollMessageThreadId] :: SendPollRequest -> Maybe MessageThreadId
-- | Poll question, 1-300 characters.
[sendPollQuestion] :: SendPollRequest -> Text
-- | Mode for parsing entities in the question. See formatting
-- options for more details. Currently, only custom emoji entities
-- are allowed.
[sendPollQuestionParseMode] :: SendPollRequest -> Maybe ParseMode
-- | A JSON-serialized list of special entities that appear in the poll
-- question. It can be specified instead of question_parse_mode.
[sendPollQuestionEntities] :: SendPollRequest -> Maybe [MessageEntity]
-- | A JSON-serialized list of answer options, 2-10 strings 1-100
-- characters each.
[sendPollOptions] :: SendPollRequest -> [InputPollOption]
-- | True, if the poll needs to be anonymous, defaults to True.
[sendPollIsAnonymous] :: SendPollRequest -> Maybe Bool
-- | Poll type, “quiz” or “regular”, defaults to “regular”.
[sendPollType] :: SendPollRequest -> Maybe Text
-- | True, if the poll allows multiple answers, ignored for polls in quiz
-- mode, defaults to False.
[sendPollAllowsMultipleAnswers] :: SendPollRequest -> Maybe Bool
-- | 0-based identifier of the correct answer option, required for polls in
-- quiz mode.
[sendPollCorrectOptionId] :: SendPollRequest -> Maybe Int
-- | Text that is shown when a user chooses an incorrect answer or taps on
-- the lamp icon in a quiz-style poll, 0-200 characters with at most 2
-- line feeds after entities parsing.
[sendPollExplanation] :: SendPollRequest -> Maybe Text
-- | Send MarkdownV2, HTML or Markdown (legacy), if
-- you want Telegram apps to show bold, italic, fixed-width text or
-- inline URLs in your bot's message.
[sendPollExplanationParseMode] :: SendPollRequest -> Maybe ParseMode
-- | A JSON-serialized list of special entities that appear in the poll
-- explanation, which can be specified instead of parse_mode.
[sendPollExplanationEntities] :: SendPollRequest -> Maybe [MessageEntity]
-- | Amount of time in seconds the poll will be active after creation,
-- 5-600. Can't be used together with close_date.
[sendPollOpenPeriod] :: SendPollRequest -> Maybe Int
-- | Point in time (Unix timestamp) when the poll will be automatically
-- closed. Must be at least 5 and no more than 600 seconds in the future.
-- Can't be used together with open_period.
[sendPollCloseDate] :: SendPollRequest -> Maybe Int
-- | Pass True, if the poll needs to be immediately closed. This can be
-- useful for poll preview.
[sendPollIsClosed] :: SendPollRequest -> Maybe Bool
-- | Sends the message silently. Users will receive a notification with no
-- sound.
[sendPollDisableNotification] :: SendPollRequest -> Maybe Bool
-- | Protects the contents of the sent message from forwarding and saving.
[sendPollProtectContent] :: SendPollRequest -> Maybe Bool
-- | If the message is a reply, ID of the original message.
[sendPollReplyToMessageId] :: SendPollRequest -> Maybe MessageId
-- | Description of the message to reply to.
[sendPollReplyParameters] :: SendPollRequest -> Maybe ReplyParameters
-- | Additional interface options. A JSON-serialized object for an inline
-- keyboard, custom reply keyboard, instructions to remove reply keyboard
-- or to force a reply from the user.
[sendPollReplyMarkup] :: SendPollRequest -> Maybe InlineKeyboardMarkup
type SendPoll = "sendPoll" :> ReqBody '[JSON] SendPollRequest :> Post '[JSON] (Response Message)
-- | Use this method to send a native poll. On success, the sent Message is
-- returned.
sendPoll :: SendPollRequest -> ClientM (Response Message)
defSendPoll :: SomeChatId -> Text -> [InputPollOption] -> SendPollRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.SendPoll.SendPollRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.SendPoll.SendPollRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Methods.SendPoll.SendPollRequest
module Telegram.Bot.API.Methods.SendPhoto
type SendPhotoContent = "sendPhoto" :> MultipartForm Tmp SendPhotoRequest :> Post '[JSON] (Response Message)
type SendPhotoLink = "sendPhoto" :> ReqBody '[JSON] SendPhotoRequest :> Post '[JSON] (Response Message)
newtype PhotoFile
MakePhotoFile :: InputFile -> PhotoFile
pattern PhotoFileId :: FileId -> PhotoFile
pattern PhotoUrl :: Text -> PhotoFile
pattern PhotoFile :: FilePath -> ContentType -> PhotoFile
-- | Request parameters for sendPhoto
data SendPhotoRequest
SendPhotoRequest :: Maybe BusinessConnectionId -> SomeChatId -> Maybe MessageThreadId -> PhotoFile -> Maybe FilePath -> Maybe Text -> Maybe ParseMode -> Maybe [MessageEntity] -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe MessageId -> Maybe ReplyParameters -> Maybe SomeReplyMarkup -> SendPhotoRequest
-- | Unique identifier of the business connection on behalf of which the
-- message will be sent.
[sendPhotoBusinessConnectionId] :: SendPhotoRequest -> Maybe BusinessConnectionId
-- | Unique identifier for the target chat or username of the target
-- channel (in the format @channelusername).
[sendPhotoChatId] :: SendPhotoRequest -> SomeChatId
-- | Unique identifier for the target message thread (topic) of the forum;
-- for forum supergroups only.
[sendPhotoMessageThreadId] :: SendPhotoRequest -> Maybe MessageThreadId
-- | Pass a file_id as String to send a file that exists on the Telegram
-- servers (recommended), pass an HTTP URL as a String for Telegram to
-- get a file from the Internet, or upload a new one using
-- multipart/form-data
[sendPhotoPhoto] :: SendPhotoRequest -> PhotoFile
-- | Thumbnail of the file sent; can be ignored if thumbnail generation for
-- the file is supported server-side. The thumbnail should be in JPEG
-- format and less than 200 kB in size. A thumbnail's width and height
-- should not exceed 320. Ignored if the file is not uploaded using
-- multipartform-data. Thumbnails can't be reused and can be only
-- uploaded as a new file, so you can pass
-- “attach:file_attach_name” if the thumbnail was uploaded
-- using multipartform-data under file_attach_name
[sendPhotoThumb] :: SendPhotoRequest -> Maybe FilePath
-- | Photo caption (may also be used when resending Photos by file_id),
-- 0-1024 characters after entities parsing
[sendPhotoCaption] :: SendPhotoRequest -> Maybe Text
-- | Send MarkdownV2, HTML or Markdown (legacy), if
-- you want Telegram apps to show bold, italic, fixed-width text or
-- inline URLs in your bot's message.
[sendPhotoParseMode] :: SendPhotoRequest -> Maybe ParseMode
-- | A JSON-serialized list of special entities that appear in the caption,
-- which can be specified instead of parse_mode.
[sendPhotoCaptionEntities] :: SendPhotoRequest -> Maybe [MessageEntity]
-- | Pass True if the photo needs to be covered with a spoiler
-- animation.
[sendPhotoHasSpoiler] :: SendPhotoRequest -> Maybe Bool
-- | Sends the message silently. Users will receive a notification with no
-- sound.
[sendPhotoDisableNotification] :: SendPhotoRequest -> Maybe Bool
-- | Protects the contents of the sent message from forwarding and saving.
[sendPhotoProtectContent] :: SendPhotoRequest -> Maybe Bool
-- | If the message is a reply, ID of the original message.
[sendPhotoReplyToMessageId] :: SendPhotoRequest -> Maybe MessageId
-- | Description of the message to reply to.
[sendPhotoReplyParameters] :: SendPhotoRequest -> Maybe ReplyParameters
-- | Additional interface options. A JSON-serialized object for an inline
-- keyboard, custom reply keyboard, instructions to remove reply keyboard
-- or to force a reply from the user.
[sendPhotoReplyMarkup] :: SendPhotoRequest -> Maybe SomeReplyMarkup
-- | Use this method to send photos. On success, the sent Message is
-- returned.
--
-- https://core.telegram.org/bots/api#sendphoto
sendPhoto :: SendPhotoRequest -> ClientM (Response Message)
defSendPhoto :: SomeChatId -> PhotoFile -> SendPhotoRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.SendPhoto.PhotoFile
instance GHC.Generics.Generic Telegram.Bot.API.Methods.SendPhoto.SendPhotoRequest
instance Servant.Multipart.API.ToMultipart Servant.Multipart.API.Tmp Telegram.Bot.API.Methods.SendPhoto.SendPhotoRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.SendPhoto.SendPhotoRequest
module Telegram.Bot.API.Methods.SendMessage
type SendMessage = "sendMessage" :> ReqBody '[JSON] SendMessageRequest :> Post '[JSON] (Response Message)
-- | Use this method to send text messages. On success, the sent
-- Message is returned.
sendMessage :: SendMessageRequest -> ClientM (Response Message)
-- | Request parameters for sendMessage.
data SendMessageRequest
SendMessageRequest :: Maybe BusinessConnectionId -> SomeChatId -> Maybe MessageThreadId -> Text -> Maybe ParseMode -> Maybe [MessageEntity] -> Maybe LinkPreviewOptions -> Maybe Bool -> Maybe Bool -> Maybe MessageId -> Maybe ReplyParameters -> Maybe SomeReplyMarkup -> SendMessageRequest
-- | Unique identifier of the business connection on behalf of which the
-- message will be sent.
[sendMessageBusinessConnectionId] :: SendMessageRequest -> Maybe BusinessConnectionId
-- | Unique identifier for the target chat or username of the target
-- channel (in the format @channelusername).
[sendMessageChatId] :: SendMessageRequest -> SomeChatId
-- | Unique identifier for the target message thread (topic) of the forum;
-- for forum supergroups only.
[sendMessageMessageThreadId] :: SendMessageRequest -> Maybe MessageThreadId
-- | Text of the message to be sent.
[sendMessageText] :: SendMessageRequest -> Text
-- | Send MarkdownV2, HTML or Markdown (legacy), if
-- you want Telegram apps to show bold, italic, fixed-width text or
-- inline URLs in your bot's message.
[sendMessageParseMode] :: SendMessageRequest -> Maybe ParseMode
-- | A JSON-serialized list of special entities that appear in message
-- text, which can be specified instead of parse_mode.
[sendMessageEntities] :: SendMessageRequest -> Maybe [MessageEntity]
-- | Link preview generation options for the message.
[sendMessageLinkPreviewOptions] :: SendMessageRequest -> Maybe LinkPreviewOptions
-- | Sends the message silently. Users will receive a notification with no
-- sound.
[sendMessageDisableNotification] :: SendMessageRequest -> Maybe Bool
-- | Protects the contents of the sent message from forwarding and saving.
[sendMessageProtectContent] :: SendMessageRequest -> Maybe Bool
-- | If the message is a reply, ID of the original message.
[sendMessageReplyToMessageId] :: SendMessageRequest -> Maybe MessageId
-- | Description of the message to reply to.
[sendMessageReplyParameters] :: SendMessageRequest -> Maybe ReplyParameters
-- | Additional interface options. A JSON-serialized object for an inline
-- keyboard, custom reply keyboard, instructions to remove reply keyboard
-- or to force a reply from the user.
[sendMessageReplyMarkup] :: SendMessageRequest -> Maybe SomeReplyMarkup
defSendMessage :: SomeChatId -> Text -> SendMessageRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.SendMessage.SendMessageRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.SendMessage.SendMessageRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Methods.SendMessage.SendMessageRequest
module Telegram.Bot.API.Methods.SendMediaGroup
-- | Request parameters for sendMediaGroup.
data SendMediaGroupRequest
SendMediaGroupRequest :: Maybe BusinessConnectionId -> SomeChatId -> Maybe MessageThreadId -> [InputMedia] -> Maybe Bool -> Maybe Bool -> Maybe MessageId -> Maybe ReplyParameters -> Maybe InlineKeyboardMarkup -> SendMediaGroupRequest
-- | Unique identifier of the business connection on behalf of which the
-- message will be sent.
[sendMediaGroupBusinessConnectionId] :: SendMediaGroupRequest -> Maybe BusinessConnectionId
-- | Unique identifier for the target chat or username of the target
-- channel (in the format @channelusername).
[sendMediaGroupChatId] :: SendMediaGroupRequest -> SomeChatId
-- | Unique identifier for the target message thread (topic) of the forum;
-- for forum supergroups only.
[sendMediaGroupMessageThreadId] :: SendMediaGroupRequest -> Maybe MessageThreadId
-- | A JSON-serialized array describing messages to be sent, must include
-- 2-10 items. InputMediaAudio, InputMediaDocument, InputMediaPhoto or
-- InputMediaVideo.
[sendMediaGroupMedia] :: SendMediaGroupRequest -> [InputMedia]
-- | Sends the message silently. Users will receive a notification with no
-- sound.
[sendMediaGroupDisableNotification] :: SendMediaGroupRequest -> Maybe Bool
-- | Protects the contents of the sent message from forwarding and saving
[sendMediaGroupProtectContent] :: SendMediaGroupRequest -> Maybe Bool
-- | If the message is a reply, ID of the original message
[sendMediaGroupReplyToMessageId] :: SendMediaGroupRequest -> Maybe MessageId
-- | Description of the message to reply to.
[sendMediaGroupReplyParameters] :: SendMediaGroupRequest -> Maybe ReplyParameters
-- | Additional interface options. A JSON-serialized object for an inline
-- keyboard, custom reply keyboard, instructions to remove reply keyboard
-- or to force a reply from the user.
[sendMediaGroupReplyMarkup] :: SendMediaGroupRequest -> Maybe InlineKeyboardMarkup
type SendMediaGroup = "sendMediaGroup" :> ReqBody '[JSON] SendMediaGroupRequest :> Post '[JSON] (Response [Message])
-- | Use this method to send a group of photos, videos, documents or audios
-- as an album. Documents and audio files can be only grouped in an album
-- with messages of the same type. On success, an array of Messages that
-- were sent is returned.
sendMediaGroup :: SendMediaGroupRequest -> ClientM (Response [Message])
defSendMediaGroup :: SomeChatId -> [InputMedia] -> SendMediaGroupRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.SendMediaGroup.SendMediaGroupRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.SendMediaGroup.SendMediaGroupRequest
module Telegram.Bot.API.Methods.SendLocation
-- | Request parameters for sendLocation.
data SendLocationRequest
SendLocationRequest :: Maybe BusinessConnectionId -> SomeChatId -> Maybe MessageThreadId -> Float -> Float -> Maybe Float -> Int -> Maybe Int -> Maybe Int -> Maybe Bool -> Maybe Bool -> Maybe MessageId -> Maybe ReplyParameters -> Maybe InlineKeyboardMarkup -> SendLocationRequest
-- | Unique identifier of the business connection on behalf of which the
-- message will be sent.
[sendLocationBusinessConnectionId] :: SendLocationRequest -> Maybe BusinessConnectionId
-- | Unique identifier for the target chat or username of the target
-- channel (in the format @channelusername).
[sendLocationChatId] :: SendLocationRequest -> SomeChatId
-- | Unique identifier for the target message thread (topic) of the forum;
-- for forum supergroups only.
[sendLocationMessageThreadId] :: SendLocationRequest -> Maybe MessageThreadId
-- | Latitude of new location
[sendLocationLatitude] :: SendLocationRequest -> Float
-- | Longitude of new location
[sendLocationLongitude] :: SendLocationRequest -> Float
-- | The radius of uncertainty for the location, measured in meters; 0-1500
[sendLocationHorizontalAccuracy] :: SendLocationRequest -> Maybe Float
-- | Period in seconds for which the location will be updated (see Live
-- Locations, should be between 60 and 86400.)
[sendLocationLivePeriod] :: SendLocationRequest -> Int
-- | Direction in which the user is moving, in degrees. Must be between 1
-- and 360 if specified.
[sendLocationHeading] :: SendLocationRequest -> Maybe Int
-- | Maximum distance for proximity alerts about approaching another chat
-- member, in meters. Must be between 1 and 100000 if specified.
[sendLocationProximityAlertRadius] :: SendLocationRequest -> Maybe Int
-- | Sends the message silently. Users will receive a notification with no
-- sound.
[sendLocationDisableNotification] :: SendLocationRequest -> Maybe Bool
-- | Protects the contents of the sent message from forwarding and saving
[sendLocationProtectContent] :: SendLocationRequest -> Maybe Bool
-- | If the message is a reply, ID of the original message
[sendLocationReplyToMessageId] :: SendLocationRequest -> Maybe MessageId
-- | Description of the message to reply to.
[sendLocationReplyParameters] :: SendLocationRequest -> Maybe ReplyParameters
-- | Additional interface options. A JSON-serialized object for an inline
-- keyboard, custom reply keyboard, instructions to remove reply keyboard
-- or to force a reply from the user.
[sendLocationReplyMarkup] :: SendLocationRequest -> Maybe InlineKeyboardMarkup
type SendLocation = "sendLocation" :> ReqBody '[JSON] SendLocationRequest :> Post '[JSON] (Response Message)
-- | Use this method to send point on the map. On success, the sent Message
-- is returned.
sendLocation :: SendLocationRequest -> ClientM (Response Message)
defSendLocation :: SomeChatId -> Float -> Float -> Int -> SendLocationRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.SendLocation.SendLocationRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.SendLocation.SendLocationRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Methods.SendLocation.SendLocationRequest
module Telegram.Bot.API.Methods.SendDocument
type SendDocumentContent = "sendDocument" :> MultipartForm Tmp SendDocumentRequest :> Post '[JSON] (Response Message)
type SendDocumentLink = "sendDocument" :> ReqBody '[JSON] SendDocumentRequest :> Post '[JSON] (Response Message)
-- | Use this method to send text messages. On success, the sent
-- Message is returned.
--
-- https://core.telegram.org/bots/api#senddocument
sendDocument :: SendDocumentRequest -> ClientM (Response Message)
-- | Request parameters for sendDocument
data SendDocumentRequest
SendDocumentRequest :: Maybe BusinessConnectionId -> SomeChatId -> Maybe MessageThreadId -> DocumentFile -> Maybe FilePath -> Maybe Text -> Maybe ParseMode -> Maybe [MessageEntity] -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe MessageId -> Maybe ReplyParameters -> Maybe SomeReplyMarkup -> SendDocumentRequest
-- | Unique identifier of the business connection on behalf of which the
-- message will be sent.
[sendDocumentBusinessConnectionId] :: SendDocumentRequest -> Maybe BusinessConnectionId
-- | Unique identifier for the target chat or username of the target
-- channel (in the format @channelusername).
[sendDocumentChatId] :: SendDocumentRequest -> SomeChatId
-- | Unique identifier for the target message thread (topic) of the forum;
-- for forum supergroups only.
[sendDocumentMessageThreadId] :: SendDocumentRequest -> Maybe MessageThreadId
-- | Pass a file_id as String to send a file that exists on the Telegram
-- servers (recommended), pass an HTTP URL as a String for Telegram to
-- get a file from the Internet, or upload a new one using
-- multipart/form-data
[sendDocumentDocument] :: SendDocumentRequest -> DocumentFile
-- | Thumbnail of the file sent; can be ignored if thumbnail generation for
-- the file is supported server-side. The thumbnail should be in JPEG
-- format and less than 200 kB in size. A thumbnail's width and height
-- should not exceed 320. Ignored if the file is not uploaded using
-- multipartform-data. Thumbnails can't be reused and can be only
-- uploaded as a new file, so you can pass
-- “attach:file_attach_name” if the thumbnail was uploaded
-- using multipartform-data under file_attach_name
[sendDocumentThumbnail] :: SendDocumentRequest -> Maybe FilePath
-- | Document caption (may also be used when resending documents by
-- file_id), 0-1024 characters after entities parsing
[sendDocumentCaption] :: SendDocumentRequest -> Maybe Text
-- | Send MarkdownV2, HTML or Markdown (legacy), if
-- you want Telegram apps to show bold, italic, fixed-width text or
-- inline URLs in your bot's message.
[sendDocumentParseMode] :: SendDocumentRequest -> Maybe ParseMode
-- | A JSON-serialized list of special entities that appear in the caption,
-- which can be specified instead of parse_mode.
[sendDocumentCaptionEntities] :: SendDocumentRequest -> Maybe [MessageEntity]
-- | Disables automatic server-side content type detection for files
-- uploaded using multipart/form-data.
[sendDocumentDisableContentTypeDetection] :: SendDocumentRequest -> Maybe Bool
-- | Sends the message silently. Users will receive a notification with no
-- sound.
[sendDocumentDisableNotification] :: SendDocumentRequest -> Maybe Bool
-- | Protects the contents of the sent message from forwarding and saving.
[sendDocumentProtectContent] :: SendDocumentRequest -> Maybe Bool
-- | If the message is a reply, ID of the original message.
[sendDocumentReplyToMessageId] :: SendDocumentRequest -> Maybe MessageId
-- | Description of the message to reply to.
[sendDocumentReplyParameters] :: SendDocumentRequest -> Maybe ReplyParameters
-- | Additional interface options. A JSON-serialized object for an inline
-- keyboard, custom reply keyboard, instructions to remove reply keyboard
-- or to force a reply from the user.
[sendDocumentReplyMarkup] :: SendDocumentRequest -> Maybe SomeReplyMarkup
newtype DocumentFile
MakeDocumentFile :: InputFile -> DocumentFile
pattern DocumentFileId :: FileId -> DocumentFile
pattern DocumentUrl :: Text -> DocumentFile
pattern DocumentFile :: FilePath -> ContentType -> DocumentFile
defSendDocument :: SomeChatId -> DocumentFile -> SendDocumentRequest
-- | Generate send document structure.
toSendDocument :: SomeChatId -> DocumentFile -> SendDocumentRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.SendDocument.DocumentFile
instance GHC.Generics.Generic Telegram.Bot.API.Methods.SendDocument.SendDocumentRequest
instance Servant.Multipart.API.ToMultipart Servant.Multipart.API.Tmp Telegram.Bot.API.Methods.SendDocument.SendDocumentRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.SendDocument.SendDocumentRequest
module Telegram.Bot.API.Methods.SendDice
-- | Request parameters for sendDice.
data SendDiceRequest
SendDiceRequest :: Maybe BusinessConnectionId -> SomeChatId -> Maybe MessageThreadId -> Maybe Text -> Maybe Bool -> Maybe Bool -> Maybe MessageId -> Maybe ReplyParameters -> Maybe InlineKeyboardMarkup -> SendDiceRequest
-- | Unique identifier of the business connection on behalf of which the
-- message will be sent.
[sendDiceBusinessConnectionId] :: SendDiceRequest -> Maybe BusinessConnectionId
-- | Unique identifier for the target chat or username of the target
-- channel (in the format @channelusername).
[sendDiceChatId] :: SendDiceRequest -> SomeChatId
-- | Unique identifier for the target message thread (topic) of the forum;
-- for forum supergroups only.
[sendDiceMessageThreadId] :: SendDiceRequest -> Maybe MessageThreadId
-- | Emoji on which the dice throw animation is based. Currently, must be
-- one of “🎲”, “🎯”, “🏀”, “⚽”, “🎳”, or “🎰”. Dice can have values 1-6 for
-- “🎲”, “🎯” and “🎳”, values 1-5 for “🏀” and “⚽”, and values 1-64 for “🎰”.
-- Defaults to “🎲”
[sendDiceEmoji] :: SendDiceRequest -> Maybe Text
-- | Sends the message silently. Users will receive a notification with no
-- sound.
[sendDiceDisableNotification] :: SendDiceRequest -> Maybe Bool
-- | Protects the contents of the sent message from forwarding
[sendDiceProtectContent] :: SendDiceRequest -> Maybe Bool
-- | If the message is a reply, ID of the original message
[sendDiceReplyToMessageId] :: SendDiceRequest -> Maybe MessageId
-- | Description of the message to reply to.
[sendDiceReplyParameters] :: SendDiceRequest -> Maybe ReplyParameters
-- | Additional interface options. A JSON-serialized object for an inline
-- keyboard, custom reply keyboard, instructions to remove reply keyboard
-- or to force a reply from the user.
[sendDiceReplyMarkup] :: SendDiceRequest -> Maybe InlineKeyboardMarkup
type SendDice = "sendDice" :> ReqBody '[JSON] SendDiceRequest :> Post '[JSON] (Response Message)
-- | Use this method to send an animated emoji that will display a random
-- value. On success, the sent Message is returned.
sendDice :: SendDiceRequest -> ClientM (Response Message)
defSendDice :: SomeChatId -> SendDiceRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.SendDice.SendDiceRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.SendDice.SendDiceRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Methods.SendDice.SendDiceRequest
module Telegram.Bot.API.Methods.SendContact
-- | Request parameters for sendContact.
data SendContactRequest
SendContactRequest :: Maybe BusinessConnectionId -> SomeChatId -> Maybe MessageThreadId -> Text -> Text -> Text -> Text -> Maybe Bool -> Maybe Bool -> Maybe MessageId -> Maybe ReplyParameters -> Maybe InlineKeyboardMarkup -> SendContactRequest
-- | Unique identifier of the business connection on behalf of which the
-- message will be sent.
[sendContactBusinessConnectionId] :: SendContactRequest -> Maybe BusinessConnectionId
-- | Unique identifier for the target chat or username of the target
-- channel (in the format @channelusername).
[sendContactChatId] :: SendContactRequest -> SomeChatId
-- | Unique identifier for the target message thread (topic) of the forum;
-- for forum supergroups only.
[sendContactMessageThreadId] :: SendContactRequest -> Maybe MessageThreadId
-- | Contact's phone number
[sendContactPhoneNumber] :: SendContactRequest -> Text
-- | Contact's first name
[sendContactFirstName] :: SendContactRequest -> Text
-- | Contact's last name
[sendContactLastName] :: SendContactRequest -> Text
-- | Additional data about the contact in the form of a vCard, 0-2048 bytes
[sendContactVcard] :: SendContactRequest -> Text
-- | Sends the message silently. Users will receive a notification with no
-- sound.
[sendContactDisableNotification] :: SendContactRequest -> Maybe Bool
-- | Protects the contents of the sent message from forwarding and saving
[sendContactProtectContent] :: SendContactRequest -> Maybe Bool
-- | If the message is a reply, ID of the original message
[sendContactReplyToMessageId] :: SendContactRequest -> Maybe MessageId
-- | Description of the message to reply to.
[sendContactReplyParameters] :: SendContactRequest -> Maybe ReplyParameters
-- | Additional interface options. A JSON-serialized object for an inline
-- keyboard, custom reply keyboard, instructions to remove reply keyboard
-- or to force a reply from the user.
[sendContactReplyMarkup] :: SendContactRequest -> Maybe InlineKeyboardMarkup
type SendContact = "sendContact" :> ReqBody '[JSON] SendContactRequest :> Post '[JSON] (Response Message)
-- | Use this method to send phone contacts. On success, the sent Message
-- is returned.
sendContact :: SendContactRequest -> ClientM (Response Message)
defSendContact :: SomeChatId -> Text -> Text -> Text -> Text -> SendContactRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.SendContact.SendContactRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.SendContact.SendContactRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Methods.SendContact.SendContactRequest
module Telegram.Bot.API.Methods.SendChatAction
data SendChatActionRequest
SendChatActionRequest :: Maybe BusinessConnectionId -> ChatId -> Maybe MessageThreadId -> Text -> SendChatActionRequest
-- | Unique identifier of the business connection on behalf of which the
-- action will be sent.
[sendChatActionBusinessConnectionId] :: SendChatActionRequest -> Maybe BusinessConnectionId
-- | Unique identifier for the target chat or username of the target
-- channel (in the format @channelusername).
[sendChatActionChatId] :: SendChatActionRequest -> ChatId
-- | Unique identifier for the target message thread; for supergroups only.
[sendChatActionMessageThreadId] :: SendChatActionRequest -> Maybe MessageThreadId
-- | Type of action to broadcast. Choose one, depending on what the user is
-- about to receive: typing for text messages, upload_photo for photos,
-- record_video or upload_video for videos, record_voice or upload_voice
-- for voice notes, upload_document for general files, choose_sticker for
-- stickers, find_location for location data, record_video_note or
-- upload_video_note for video notes.
[sendChatActionAction] :: SendChatActionRequest -> Text
type SendChatAction = "sendChatAction" :> ReqBody '[JSON] SendChatActionRequest :> Post '[JSON] (Response Bool)
-- | Use this method when you need to tell the user that something is
-- happening on the bot's side. The status is set for 5 seconds or less
-- (when a message arrives from your bot, Telegram clients clear its
-- typing status). Returns True on success.
--
-- Example: The ImageBot needs some time to process a request and upload
-- the image. Instead of sending a text message along the lines of
-- “Retrieving image, please wait…”, the bot may use sendChatAction with
-- action = upload_photo. The user will see a “sending photo” status for
-- the bot.
--
-- We only recommend using this method when a response from the bot will
-- take a noticeable amount of time to arrive.
sendChatAction :: SendChatActionRequest -> ClientM (Response Bool)
instance GHC.Generics.Generic Telegram.Bot.API.Methods.SendChatAction.SendChatActionRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.SendChatAction.SendChatActionRequest
module Telegram.Bot.API.Methods.SendAudio
-- | Request parameters for sendAudio.
data SendAudioRequest
SendAudioRequest :: Maybe BusinessConnectionId -> SomeChatId -> Maybe MessageThreadId -> InputFile -> Maybe Int -> Maybe Text -> Maybe Text -> Maybe InputFile -> Maybe Text -> Maybe ParseMode -> Maybe [MessageEntity] -> Maybe Bool -> Maybe Bool -> Maybe MessageId -> Maybe ReplyParameters -> Maybe InlineKeyboardMarkup -> SendAudioRequest
-- | Unique identifier of the business connection on behalf of which the
-- message will be sent.
[sendAudioBusinessConnectionId] :: SendAudioRequest -> Maybe BusinessConnectionId
-- | Unique identifier for the target chat or username of the target
-- channel (in the format @channelusername).
[sendAudioChatId] :: SendAudioRequest -> SomeChatId
-- | Unique identifier for the target message thread (topic) of the forum;
-- for forum supergroups only.
[sendAudioMessageThreadId] :: SendAudioRequest -> Maybe MessageThreadId
-- | Audio to send. Pass a file_id as String to send an audio that exists
-- on the Telegram servers (recommended), pass an HTTP URL as a String
-- for Telegram to get a audio from the Internet, or upload a new audio
-- using multipart/form-data. More info on Sending Files »
[sendAudioAudio] :: SendAudioRequest -> InputFile
-- | Duration of sent audio in seconds
[sendAudioDuration] :: SendAudioRequest -> Maybe Int
-- | Performer
[sendAudioPerformer] :: SendAudioRequest -> Maybe Text
-- | Track name
[sendAudioTitle] :: SendAudioRequest -> Maybe Text
-- | Thumbnail of the file sent; can be ignored if thumbnail generation for
-- the file is supported server-side. The thumbnail should be in JPEG
-- format and less than 200 kB in size. A thumbnail's width and height
-- should not exceed 320. Ignored if the file is not uploaded using
-- multipartform-data. Thumbnails can't be reused and can be only
-- uploaded as a new file, so you can pass
-- “attach:file_attach_name” if the thumbnail was uploaded
-- using multipartform-data under file_attach_name. More info
-- on Sending Files »
[sendAudioThumbnail] :: SendAudioRequest -> Maybe InputFile
-- | Audio caption (may also be used when resending audios by file_id),
-- 0-1024 characters after entities parsing
[sendAudioCaption] :: SendAudioRequest -> Maybe Text
-- | Send MarkdownV2, HTML or Markdown (legacy), if
-- you want Telegram apps to show bold, italic, fixed-width text or
-- inline URLs in your bot's message.
[sendAudioParseMode] :: SendAudioRequest -> Maybe ParseMode
-- | A JSON-serialized list of special entities that appear in the caption,
-- which can be specified instead of parse_mode
[sendAudioCaptionEntities] :: SendAudioRequest -> Maybe [MessageEntity]
-- | Sends the message silently. Users will receive a notification with no
-- sound.
[sendAudioDisableNotification] :: SendAudioRequest -> Maybe Bool
-- | Protects the contents of the sent message from forwarding and saving
[sendAudioProtectContent] :: SendAudioRequest -> Maybe Bool
-- | If the message is a reply, ID of the original message
[sendAudioReplyToMessageId] :: SendAudioRequest -> Maybe MessageId
-- | Description of the message to reply to.
[sendAudioReplyParameters] :: SendAudioRequest -> Maybe ReplyParameters
-- | Additional interface options. A JSON-serialized object for an inline
-- keyboard, custom reply keyboard, instructions to remove reply keyboard
-- or to force a reply from the user.
[sendAudioReplyMarkup] :: SendAudioRequest -> Maybe InlineKeyboardMarkup
type SendAudioContent = "sendAudio" :> MultipartForm Tmp SendAudioRequest :> Post '[JSON] (Response Message)
type SendAudioLink = "sendAudio" :> ReqBody '[JSON] SendAudioRequest :> Post '[JSON] (Response Message)
-- | Use this method to send audio files, if you want Telegram clients to
-- display them in the music player. Your audio must be in the .MP3 or
-- .M4A format. On success, the sent Message is returned. Bots can
-- currently send audio files of up to 50 MB in size, this limit may be
-- changed in the future.
--
-- For sending voice messages, use the sendVoice method instead.
sendAudio :: SendAudioRequest -> ClientM (Response Message)
defSendAudio :: SomeChatId -> InputFile -> SendAudioRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.SendAudio.SendAudioRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.SendAudio.SendAudioRequest
instance Servant.Multipart.API.ToMultipart Servant.Multipart.API.Tmp Telegram.Bot.API.Methods.SendAudio.SendAudioRequest
module Telegram.Bot.API.Methods.SendAnimation
-- | Request parameters for sendAnimation.
data SendAnimationRequest
SendAnimationRequest :: Maybe BusinessConnectionId -> SomeChatId -> Maybe MessageThreadId -> InputFile -> Maybe Int -> Maybe Int -> Maybe Int -> Maybe InputFile -> Maybe Text -> Maybe ParseMode -> Maybe [MessageEntity] -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe MessageId -> Maybe ReplyParameters -> Maybe InlineKeyboardMarkup -> SendAnimationRequest
-- | Unique identifier of the business connection on behalf of which the
-- message will be sent.
[sendAnimationBusinessConnectionId] :: SendAnimationRequest -> Maybe BusinessConnectionId
-- | Unique identifier for the target chat or username of the target
-- channel (in the format @channelusername)
[sendAnimationChatId] :: SendAnimationRequest -> SomeChatId
-- | Unique identifier for the target message thread (topic) of the forum;
-- for forum supergroups only.
[sendAnimationMessageThreadId] :: SendAnimationRequest -> Maybe MessageThreadId
-- | Animation to send. Pass a file_id as String to send an animation that
-- exists on the Telegram servers (recommended), pass an HTTP URL as a
-- String for Telegram to get an animation from the Internet, or upload a
-- new animation using multipart/form-data. More info on Sending Files »
[sendAnimationAnimation] :: SendAnimationRequest -> InputFile
-- | Duration of sent animation in seconds
[sendAnimationDuration] :: SendAnimationRequest -> Maybe Int
-- | Animation width
[sendAnimationWidth] :: SendAnimationRequest -> Maybe Int
-- | Animation height
[sendAnimationHeight] :: SendAnimationRequest -> Maybe Int
-- | Thumbnail of the file sent; can be ignored if thumbnail generation for
-- the file is supported server-side. The thumbnail should be in JPEG
-- format and less than 200 kB in size. A thumbnail's width and height
-- should not exceed 320. Ignored if the file is not uploaded using
-- multipartform-data. Thumbnails can't be reused and can be only
-- uploaded as a new file, so you can pass
-- “attach:file_attach_name” if the thumbnail was uploaded
-- using multipartform-data under file_attach_name. More info
-- on Sending Files »
[sendAnimationThumbnail] :: SendAnimationRequest -> Maybe InputFile
-- | Animation caption (may also be used when resending animation by
-- file_id), 0-1024 characters after entities parsing
[sendAnimationCaption] :: SendAnimationRequest -> Maybe Text
-- | Send MarkdownV2, HTML or Markdown (legacy), if
-- you want Telegram apps to show bold, italic, fixed-width text or
-- inline URLs in your bot's message.
[sendAnimationParseMode] :: SendAnimationRequest -> Maybe ParseMode
-- | A JSON-serialized list of special entities that appear in the caption,
-- which can be specified instead of parse_mode
[sendAnimationCaptionEntities] :: SendAnimationRequest -> Maybe [MessageEntity]
-- | Pass True if the animation needs to be covered with a spoiler
-- animation.
[sendAnimationHasSpoiler] :: SendAnimationRequest -> Maybe Bool
-- | Sends the message silently. Users will receive a notification with no
-- sound.
[sendAnimationDisableNotification] :: SendAnimationRequest -> Maybe Bool
-- | Protects the contents of the sent message from forwarding and saving.
[sendAnimationProtectContent] :: SendAnimationRequest -> Maybe Bool
-- | If the message is a reply, ID of the original message.
[sendAnimationReplyToMessageId] :: SendAnimationRequest -> Maybe MessageId
-- | Description of the message to reply to.
[sendAnimationReplyParameters] :: SendAnimationRequest -> Maybe ReplyParameters
-- | Additional interface options. A JSON-serialized object for an inline
-- keyboard, custom reply keyboard, instructions to remove reply keyboard
-- or to force a reply from the user.
[sendAnimationReplyMarkup] :: SendAnimationRequest -> Maybe InlineKeyboardMarkup
type SendAnimationContent = "sendAnimation" :> MultipartForm Tmp SendAnimationRequest :> Post '[JSON] (Response Message)
type SendAnimationLink = "sendAnimation" :> ReqBody '[JSON] SendAnimationRequest :> Post '[JSON] (Response Message)
-- | Use this method to send animation files (GIF or H.264/MPEG-4 AVC video
-- without sound). On success, the sent Message is returned. Bots can
-- currently send animation files of up to 50 MB in size, this limit may
-- be changed in the future.
sendAnimation :: SendAnimationRequest -> ClientM (Response Message)
defSendAnimation :: SomeChatId -> InputFile -> SendAnimationRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.SendAnimation.SendAnimationRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.SendAnimation.SendAnimationRequest
instance Servant.Multipart.API.ToMultipart Servant.Multipart.API.Tmp Telegram.Bot.API.Methods.SendAnimation.SendAnimationRequest
module Telegram.Bot.API.Methods.RevokeChatInviteLink
type RevokeChatInviteLink = "revokeChatInviteLink" :> RequiredQueryParam "chat_id" SomeChatId :> RequiredQueryParam "invite_link" Text :> Post '[JSON] (Response ChatInviteLink)
-- | Use this method to revoke an invite link created by the bot. If the
-- primary link is revoked, a new link is automatically generated. The
-- bot must be an administrator in the chat for this to work and must
-- have the appropriate administrator rights. Returns the revoked invite
-- link as ChatInviteLink object.
revokeChatInviteLink :: SomeChatId -> Text -> ClientM (Response ChatInviteLink)
module Telegram.Bot.API.Methods.RestrictChatMember
-- | Request parameters for restrictChatMember.
data RestrictChatMemberRequest
RestrictChatMemberRequest :: SomeChatId -> UserId -> ChatPermissions -> Maybe Bool -> Maybe Int -> RestrictChatMemberRequest
-- | Unique identifier for the target chat or username of the target
-- channel (in the format @channelusername).
[restrictChatMemberChatId] :: RestrictChatMemberRequest -> SomeChatId
-- | Unique identifier of the target user.
[restrictChatMemberUserId] :: RestrictChatMemberRequest -> UserId
-- | A JSON-serialized object for new user permissions.
[restrictChatMemberPermissions] :: RestrictChatMemberRequest -> ChatPermissions
-- | Pass True if chat permissions are set independently. Otherwise,
-- the can_send_other_messages and
-- can_add_web_page_previews permissions will imply the
-- can_send_messages, can_send_audios,
-- can_send_documents, can_send_photos,
-- can_send_videos, can_send_video_notes, and
-- can_send_voice_notes permissions; the can_send_polls
-- permission will imply the can_send_messages permission.
[restrictChatMemberUseIndependentChatPermissions] :: RestrictChatMemberRequest -> Maybe Bool
-- | Date when restrictions will be lifted for the user, unix time. If user
-- is restricted for more than 366 days or less than 30 seconds from the
-- current time, they are considered to be restricted forever.
[restrictChatMemberUntilDate] :: RestrictChatMemberRequest -> Maybe Int
type RestrictChatMember = "restrictChatMember" :> ReqBody '[JSON] RestrictChatMemberRequest :> Post '[JSON] (Response Bool)
-- | Use this method to restrict a user in a supergroup. The bot must be an
-- administrator in the supergroup for this to work and must have the
-- appropriate administrator rights. Pass True for all permissions to
-- lift restrictions from a user. Returns True on success.
restrictChatMember :: RestrictChatMemberRequest -> ClientM (Response Bool)
defRestrictChatMember :: SomeChatId -> UserId -> ChatPermissions -> RestrictChatMemberRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.RestrictChatMember.RestrictChatMemberRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.RestrictChatMember.RestrictChatMemberRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Methods.RestrictChatMember.RestrictChatMemberRequest
module Telegram.Bot.API.Methods.PromoteChatMember
-- | Request parameters for promoteChatMember.
data PromoteChatMemberRequest
PromoteChatMemberRequest :: SomeChatId -> UserId -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> Maybe Bool -> PromoteChatMemberRequest
-- | Unique identifier for the target chat or username of the target
-- channel (in the format @channelusername).
[promoteChatMemberChatId] :: PromoteChatMemberRequest -> SomeChatId
-- | Unique identifier of the target user.
[promoteChatMemberUserId] :: PromoteChatMemberRequest -> UserId
-- | Pass True, if the administrator's presence in the chat is
-- hidden.
[promoteChatMemberIsAnonymous] :: PromoteChatMemberRequest -> Maybe Bool
-- | Pass True, if the administrator can access the chat event log,
-- chat statistics, message statistics in channels, see channel members,
-- see anonymous administrators in supergroups and ignore slow mode.
-- Implied by any other administrator privilege.
[promoteChatMemberCanManageChat] :: PromoteChatMemberRequest -> Maybe Bool
-- | Pass True, if the administrator can create channel posts,
-- channels only.
[promoteChatMemberCanPostMessages] :: PromoteChatMemberRequest -> Maybe Bool
-- | Pass True, if the administrator can edit messages of other
-- users and can pin messages, channels only.
[promoteChatMemberCanEditMessages] :: PromoteChatMemberRequest -> Maybe Bool
-- | Pass True, if the administrator can delete messages of other
-- users.
[promoteChatMemberCanDeleteMessages] :: PromoteChatMemberRequest -> Maybe Bool
-- | Pass True, if the administrator can manage video chats.
[promoteChatMemberCanManageVideoChats] :: PromoteChatMemberRequest -> Maybe Bool
-- | Pass True, if the administrator can restrict, ban or unban chat
-- members.
[promoteChatMemberCanRestrictMembers] :: PromoteChatMemberRequest -> Maybe Bool
-- | Pass True, if the administrator can add new administrators with
-- a subset of their own privileges or demote administrators that he has
-- promoted, directly or indirectly (promoted by administrators that were
-- appointed by him).
[promoteChatMemberCanPromoteMembers] :: PromoteChatMemberRequest -> Maybe Bool
-- | Pass True, if the administrator can change chat title, photo
-- and other settings.
[promoteChatMemberCanChangeInfo] :: PromoteChatMemberRequest -> Maybe Bool
-- | Pass True, if the administrator can invite new users to the
-- chat.
[promoteChatMemberCanInviteUsers] :: PromoteChatMemberRequest -> Maybe Bool
-- | Pass True, if the administrator can pin messages, supergroups
-- only.
[promoteChatMemberCanPinMessages] :: PromoteChatMemberRequest -> Maybe Bool
-- | Pass True if the administrator can post stories in the channel;
-- channels only.
[promoteChatMemberCanPostStories] :: PromoteChatMemberRequest -> Maybe Bool
-- | Pass True if the administrator can edit stories posted by other
-- users; channels only.
[promoteChatMemberCanEditStories] :: PromoteChatMemberRequest -> Maybe Bool
-- | Pass True if the administrator can delete stories posted by
-- other users; channels only.
[promoteChatMemberCanDeleteStories] :: PromoteChatMemberRequest -> Maybe Bool
-- | Pass True, if the user is allowed to create, rename, close, and
-- reopen forum topics, supergroups only.
[promoteChatMemberCanManageTopics] :: PromoteChatMemberRequest -> Maybe Bool
type PromoteChatMember = "promoteChatMember" :> ReqBody '[JSON] PromoteChatMemberRequest :> Post '[JSON] (Response Bool)
-- | Use this method to promote or demote a user in a supergroup or a
-- channel. The bot must be an administrator in the chat for this to work
-- and must have the appropriate administrator rights. Pass False for all
-- boolean parameters to demote a user. Returns True on success.
promoteChatMember :: PromoteChatMemberRequest -> ClientM (Response Bool)
defPromoteChatMember :: SomeChatId -> UserId -> PromoteChatMemberRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.PromoteChatMember.PromoteChatMemberRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.PromoteChatMember.PromoteChatMemberRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Methods.PromoteChatMember.PromoteChatMemberRequest
module Telegram.Bot.API.Methods.PinChatMessage
-- | Request parameters for pinChatMessage.
data PinChatMessageRequest
PinChatMessageRequest :: SomeChatId -> MessageId -> Maybe Bool -> PinChatMessageRequest
-- | Unique identifier for the target chat or username of the target
-- channel (in the format @channelusername)
[pinChatMessageChatId] :: PinChatMessageRequest -> SomeChatId
-- | Identifier of a message to pin
[pinChatMessageMessageId] :: PinChatMessageRequest -> MessageId
-- | Pass True, if it is not necessary to send a notification to all chat
-- members about the new pinned message. Notifications are always
-- disabled in channels and private chats.
[pinChatMessageDisableNotification] :: PinChatMessageRequest -> Maybe Bool
type PinChatMessage = "pinChatMessage" :> ReqBody '[JSON] PinChatMessageRequest :> Post '[JSON] (Response Bool)
-- | Use this method to add a message to the list of pinned messages in a
-- chat. If the chat is not a private chat, the bot must be an
-- administrator in the chat for this to work and must have the
-- can_pin_messages administrator right in a supergroup or
-- can_edit_messages administrator right in a channel. Returns
-- True on success.
pinChatMessage :: PinChatMessageRequest -> ClientM (Response Bool)
defPinChatMessage :: SomeChatId -> MessageId -> PinChatMessageRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.PinChatMessage.PinChatMessageRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.PinChatMessage.PinChatMessageRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Methods.PinChatMessage.PinChatMessageRequest
module Telegram.Bot.API.Methods.LeaveChat
type LeaveChat = "leaveChat" :> RequiredQueryParam "chat_id" SomeChatId :> Post '[JSON] (Response Bool)
-- | Use this method for your bot to leave a group, supergroup or channel.
-- Returns True on success.
leaveChat :: SomeChatId -> ClientM (Response Bool)
module Telegram.Bot.API.Methods.GetUserProfilePhotos
-- | Request parameters for getUserProfilePhotos.
data GetUserProfilePhotosRequest
GetUserProfilePhotosRequest :: UserId -> Maybe Int -> Maybe Int -> GetUserProfilePhotosRequest
-- | Unique identifier of the target user
[getUserProfilePhotosUserId] :: GetUserProfilePhotosRequest -> UserId
-- | Sequential number of the first photo to be returned. By default, all
-- photos are returned.
[getUserProfilePhotosOffset] :: GetUserProfilePhotosRequest -> Maybe Int
-- | Limits the number of photos to be retrieved. Values between 1-100 are
-- accepted. Defaults to 100.
[getUserProfilePhotosLimit] :: GetUserProfilePhotosRequest -> Maybe Int
type GetUserProfilePhotos = "getUserProfilePhotos" :> ReqBody '[JSON] GetUserProfilePhotosRequest :> Post '[JSON] (Response UserProfilePhotos)
-- | Use this method to get a list of profile pictures for a user. Returns
-- a UserProfilePhotos object.
getUserProfilePhotos :: GetUserProfilePhotosRequest -> ClientM (Response UserProfilePhotos)
defGetUserProfilePhotos :: UserId -> GetUserProfilePhotosRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.GetUserProfilePhotos.GetUserProfilePhotosRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.GetUserProfilePhotos.GetUserProfilePhotosRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Methods.GetUserProfilePhotos.GetUserProfilePhotosRequest
module Telegram.Bot.API.Methods.GetUserChatBoosts
type GetUserChatBoosts = "getUserChatBoosts" :> ReqBody '[JSON] GetUserChatBoostsRequest :> Post '[JSON] (Response UserChatBoosts)
-- | Use this method to get the list of boosts added to a chat by a user.
-- Requires administrator rights in the chat. Returns a
-- UserChatBoosts object.
getUserChatBoosts :: GetUserChatBoostsRequest -> ClientM (Response UserChatBoosts)
-- | Request parameters for getUserChatBoosts.
data GetUserChatBoostsRequest
GetUserChatBoostsRequest :: SomeChatId -> UserId -> GetUserChatBoostsRequest
-- | Unique identifier for the chat or username of the channel (in the
-- format @channelusername).
[getUserChatBoostsRequestChatId] :: GetUserChatBoostsRequest -> SomeChatId
-- | Unique identifier of the target user.
[getUserChatBoostsRequestUserId] :: GetUserChatBoostsRequest -> UserId
defGetUserChatBoosts :: SomeChatId -> UserId -> GetUserChatBoostsRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.GetUserChatBoosts.GetUserChatBoostsRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.GetUserChatBoosts.GetUserChatBoostsRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Methods.GetUserChatBoosts.GetUserChatBoostsRequest
module Telegram.Bot.API.Methods.GetMyShortDescription
newtype GetMyShortDescriptionRequest
GetMyShortDescriptionRequest :: Maybe Text -> GetMyShortDescriptionRequest
-- | A two-letter ISO 639-1 language code or an empty string.
[getMyShortDescriptionLanguageCode] :: GetMyShortDescriptionRequest -> Maybe Text
type GetMyShortDescription = "getMyShortDescription" :> ReqBody '[JSON] GetMyShortDescriptionRequest :> Post '[JSON] (Response BotShortDescription)
-- | Use this method to get the current bot short description for the given
-- user language. Returns BotShortDescription on success.
getMyShortDescription :: GetMyShortDescriptionRequest -> ClientM (Response BotShortDescription)
defGetMyShortDescription :: GetMyShortDescriptionRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.GetMyShortDescription.GetMyShortDescriptionRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.GetMyShortDescription.GetMyShortDescriptionRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Methods.GetMyShortDescription.GetMyShortDescriptionRequest
module Telegram.Bot.API.Methods.GetMyName
newtype GetMyNameRequest
GetMyNameRequest :: Maybe Text -> GetMyNameRequest
-- | A two-letter ISO 639-1 language code or an empty string.
[getMyNameLanguageCode] :: GetMyNameRequest -> Maybe Text
type GetMyName = "getMyName" :> ReqBody '[JSON] GetMyNameRequest :> Post '[JSON] (Response BotName)
-- | Use this method to get the current bot name for the given user
-- language. Returns BotName on success.
getMyName :: GetMyNameRequest -> ClientM (Response BotName)
defGetMyName :: GetMyNameRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.GetMyName.GetMyNameRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.GetMyName.GetMyNameRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Methods.GetMyName.GetMyNameRequest
module Telegram.Bot.API.Methods.GetMyDescription
newtype GetMyDescriptionRequest
GetMyDescriptionRequest :: Maybe Text -> GetMyDescriptionRequest
-- | A two-letter ISO 639-1 language code or an empty string.
[getMyDescriptionLanguageCode] :: GetMyDescriptionRequest -> Maybe Text
type GetMyDescription = "getMyDescription" :> ReqBody '[JSON] GetMyDescriptionRequest :> Post '[JSON] (Response BotDescription)
-- | Use this method to get the current bot description for the given user
-- language. Returns BotDescription on success.
getMyDescription :: GetMyDescriptionRequest -> ClientM (Response BotDescription)
defGetMyDescription :: GetMyDescriptionRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.GetMyDescription.GetMyDescriptionRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.GetMyDescription.GetMyDescriptionRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Methods.GetMyDescription.GetMyDescriptionRequest
module Telegram.Bot.API.Methods.GetMyDefaultAdministratorRights
-- | Request parameters for getMyDefaultAdministratorRights.
newtype GetMyDefaultAdministratorRightsRequest
GetMyDefaultAdministratorRightsRequest :: Maybe Bool -> GetMyDefaultAdministratorRightsRequest
-- | Pass True to get default administrator rights of the bot in
-- channels. Otherwise, default administrator rights of the bot for
-- groups and supergroups will be returned.
[getMyDefaultAdministratorRightsRequestForChannels] :: GetMyDefaultAdministratorRightsRequest -> Maybe Bool
type GetMyDefaultAdministratorRights = "getMyDefaultAdministratorRights" :> ReqBody '[JSON] GetMyDefaultAdministratorRightsRequest :> Post '[JSON] (Response ChatAdministratorRights)
-- | Use this method to get the current default administrator rights of the
-- bot. Returns ChatAdministratorRights on success.
getMyDefaultAdministratorRights :: GetMyDefaultAdministratorRightsRequest -> ClientM (Response ChatAdministratorRights)
defGetMyDefaultAdministratorRights :: GetMyDefaultAdministratorRightsRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.GetMyDefaultAdministratorRights.GetMyDefaultAdministratorRightsRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.GetMyDefaultAdministratorRights.GetMyDefaultAdministratorRightsRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Methods.GetMyDefaultAdministratorRights.GetMyDefaultAdministratorRightsRequest
module Telegram.Bot.API.Methods.GetMyCommands
-- | Request parameters for getMyCommands.
data GetMyCommandsRequest
GetMyCommandsRequest :: Maybe BotCommandScope -> Maybe Text -> GetMyCommandsRequest
-- | A JSON-serialized object, describing scope of users. Defaults to
-- BotCommandScopeDefault.
[getMyCommandsScope] :: GetMyCommandsRequest -> Maybe BotCommandScope
-- | A two-letter ISO 639-1 language code or an empty string
[getMyCommandsLanguageCode] :: GetMyCommandsRequest -> Maybe Text
type GetMyCommands = "getMyCommands" :> ReqBody '[JSON] GetMyCommandsRequest :> Post '[JSON] (Response [BotCommand])
-- | Use this method to get the current list of the bot's commands for the
-- given scope and user language. Returns Array of BotCommand on success.
-- If commands aren't set, an empty list is returned.
getMyCommands :: GetMyCommandsRequest -> ClientM (Response [BotCommand])
defGetMyCommands :: GetMyCommandsRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.GetMyCommands.GetMyCommandsRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.GetMyCommands.GetMyCommandsRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Methods.GetMyCommands.GetMyCommandsRequest
module Telegram.Bot.API.Methods.GetMe
type GetMe = "getMe" :> Get '[JSON] (Response User)
-- | A simple method for testing your bot's auth token. Requires no
-- parameters. Returns basic information about the bot in form of a
-- User object.
getMe :: ClientM (Response User)
module Telegram.Bot.API.Methods.GetFile
type GetFile = "getFile" :> RequiredQueryParam "file_id" FileId :> Get '[JSON] (Response File)
getFile :: FileId -> ClientM (Response File)
module Telegram.Bot.API.Methods.GetChatMenuButton
-- | Request parameters for getChatMenuButton.
data GetChatMenuButtonRequest
GetChatMenuButtonRequest :: Maybe ChatId -> GetChatMenuButtonRequest
-- | Unique identifier for the target private chat. If not specified,
-- default bot's menu button will be returned.
[getChatMenuButtonRequestChatId] :: GetChatMenuButtonRequest -> Maybe ChatId
type GetChatMenuButton = "getChatMenuButton" :> ReqBody '[JSON] GetChatMenuButtonRequest :> Post '[JSON] (Response MenuButton)
-- | Use this method to get the current value of the bot's menu button in a
-- private chat, or the default menu button. Returns MenuButton
-- on success.
getChatMenuButton :: GetChatMenuButtonRequest -> ClientM (Response MenuButton)
defGetChatMenuButton :: GetChatMenuButtonRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.GetChatMenuButton.GetChatMenuButtonRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.GetChatMenuButton.GetChatMenuButtonRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Methods.GetChatMenuButton.GetChatMenuButtonRequest
module Telegram.Bot.API.Methods.GetChatMemberCount
type GetChatMemberCount = "getChatMemberCount" :> RequiredQueryParam "chat_id" SomeChatId :> Post '[JSON] (Response Integer)
-- | Use this method to get the number of members in a chat. Returns Int on
-- success.
getChatMemberCount :: SomeChatId -> ClientM (Response Integer)
module Telegram.Bot.API.Methods.GetChatMember
type GetChatMember = "getChatMember" :> RequiredQueryParam "chat_id" SomeChatId :> RequiredQueryParam "user_id" UserId :> Post '[JSON] (Response ChatMember)
-- | Use this method to get information about a member of a chat. Returns a
-- ChatMember object on success.
getChatMember :: SomeChatId -> UserId -> ClientM (Response ChatMember)
module Telegram.Bot.API.Methods.GetChatAdministrators
type GetChatAdministrators = "getChatAdministrators" :> RequiredQueryParam "chat_id" SomeChatId :> Post '[JSON] (Response [ChatMember])
-- | Use this method to get a list of administrators in a chat. On success,
-- returns an Array of ChatMember objects that contains information about
-- all chat administrators except other bots. If the chat is a group or a
-- supergroup and no administrators were appointed, only the creator will
-- be returned.
getChatAdministrators :: SomeChatId -> ClientM (Response [ChatMember])
module Telegram.Bot.API.Methods.GetChat
type GetChat = "getChat" :> RequiredQueryParam "chat_id" SomeChatId :> Post '[JSON] (Response ChatFullInfo)
-- | Use this method to get up to date information about the chat (current
-- name of the user for one-on-one conversations, current username of a
-- user, group or channel, etc.). Returns a Chat object on success.
getChat :: SomeChatId -> ClientM (Response ChatFullInfo)
module Telegram.Bot.API.Methods.GetBusinessConnection
type GetBusinessConnection = "getBusinessConnection" :> RequiredQueryParam "business_connection_id" BusinessConnectionId :> Post '[JSON] (Response BusinessConnection)
-- | Use this method to get information about the connection of the bot
-- with a business account. Returns a BusinessConnection object on
-- success.
getBusinessConnection :: BusinessConnectionId -> ClientM (Response BusinessConnection)
module Telegram.Bot.API.Methods.ForwardMessages
type ForwardMessages = "forwardMessages" :> ReqBody '[JSON] ForwardMessagesRequest :> Post '[JSON] (Response [MessageId])
-- | Use this method to forward multiple messages of any kind. If some of
-- the specified messages can't be found or forwarded, they are skipped.
-- Service messages and messages with protected content can't be
-- forwarded. Album grouping is kept for forwarded messages. On success,
-- an array of MessageId of the sent messages is returned.
forwardMessages :: ForwardMessagesRequest -> ClientM (Response [MessageId])
-- | Request parameters for forwardMessages.
data ForwardMessagesRequest
ForwardMessagesRequest :: SomeChatId -> Maybe MessageThreadId -> SomeChatId -> [MessageId] -> Maybe Bool -> Maybe Bool -> ForwardMessagesRequest
-- | Unique identifier for the target chat or username of the target
-- channel (in the format @@channelusername).
[forwardMessagesChatId] :: ForwardMessagesRequest -> SomeChatId
-- | Unique identifier for the target message thread (topic) of the forum;
-- for forum supergroups only.
[forwardMessagesMessageThreadId] :: ForwardMessagesRequest -> Maybe MessageThreadId
-- | Unique identifier for the chat where the original message was sent (or
-- channel username in the format @@channelusername).
[forwardMessagesFromChatId] :: ForwardMessagesRequest -> SomeChatId
-- | Identifiers of 1-100 messages in the chat from_chat_id to forward. The
-- identifiers must be specified in a strictly increasing order.
[forwardMessagesMessageIds] :: ForwardMessagesRequest -> [MessageId]
-- | Sends the message silently. Users will receive a notification with no
-- sound.
[forwardMessagesDisableNotification] :: ForwardMessagesRequest -> Maybe Bool
-- | Protects the contents of the sent message from forwarding and saving.
[forwardMessagesProtectContent] :: ForwardMessagesRequest -> Maybe Bool
defForwardMessages :: SomeChatId -> SomeChatId -> [MessageId] -> ForwardMessagesRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.ForwardMessages.ForwardMessagesRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.ForwardMessages.ForwardMessagesRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Methods.ForwardMessages.ForwardMessagesRequest
module Telegram.Bot.API.Methods.ForwardMessage
type ForwardMessage = "forwardMessage" :> ReqBody '[JSON] ForwardMessageRequest :> Post '[JSON] (Response Message)
-- | Use this method to forward messages of any kind. On success, the sent
-- Message is returned.
forwardMessage :: ForwardMessageRequest -> ClientM (Response Message)
-- | Request parameters for forwardMessage.
data ForwardMessageRequest
ForwardMessageRequest :: SomeChatId -> Maybe MessageThreadId -> SomeChatId -> Maybe Bool -> Maybe Bool -> MessageId -> ForwardMessageRequest
-- | Unique identifier for the target chat or username of the target
-- channel (in the format @@channelusername).
[forwardMessageChatId] :: ForwardMessageRequest -> SomeChatId
-- | Unique identifier for the target message thread (topic) of the forum;
-- for forum supergroups only.
[forwardMessageMessageThreadId] :: ForwardMessageRequest -> Maybe MessageThreadId
-- | Unique identifier for the chat where the original message was sent (or
-- channel username in the format @@channelusername).
[forwardMessageFromChatId] :: ForwardMessageRequest -> SomeChatId
-- | Sends the message silently. Users will receive a notification with no
-- sound.
[forwardMessageDisableNotification] :: ForwardMessageRequest -> Maybe Bool
-- | Protects the contents of the sent message from forwarding and saving.
[forwardMessageProtectContent] :: ForwardMessageRequest -> Maybe Bool
-- | Message identifier in the chat specified in from_chat_id.
[forwardMessageMessageId] :: ForwardMessageRequest -> MessageId
defForwardMessage :: SomeChatId -> SomeChatId -> MessageId -> ForwardMessageRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.ForwardMessage.ForwardMessageRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.ForwardMessage.ForwardMessageRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Methods.ForwardMessage.ForwardMessageRequest
module Telegram.Bot.API.Methods.ExportChatInviteLink
type ExportChatInviteLink = "exportChatInviteLink" :> RequiredQueryParam "chat_id" SomeChatId :> Post '[JSON] (Response Text)
-- | Use this method to generate a new primary invite link for a chat; any
-- previously generated primary link is revoked. The bot must be an
-- administrator in the chat for this to work and must have the
-- appropriate administrator rights. Returns the new invite link as
-- String on success.
exportChatInviteLink :: SomeChatId -> ClientM (Response Text)
module Telegram.Bot.API.Methods.EditMessageLiveLocation
-- | Request parameters for editMessageLiveLocation.
data EditMessageLiveLocationRequest
EditMessageLiveLocationRequest :: Maybe SomeChatId -> Maybe MessageId -> Maybe Text -> Float -> Float -> Maybe Int -> Maybe Float -> Maybe Int -> Maybe Int -> Maybe InlineKeyboardMarkup -> EditMessageLiveLocationRequest
-- | Unique identifier for the target chat or username of the target
-- channel (in the format @channelusername).
[editMessageLiveLocationChatId] :: EditMessageLiveLocationRequest -> Maybe SomeChatId
-- | Required if inline_message_id is not specified. Identifier of the
-- message with live location to stop.
[editMessageLiveLocationMessageId] :: EditMessageLiveLocationRequest -> Maybe MessageId
-- | Required if chat_id and message_id are not specified. Identifier of
-- the inline message.
[editMessageLiveLocationInlineMessageId] :: EditMessageLiveLocationRequest -> Maybe Text
-- | Latitude of new location.
[editMessageLiveLocationLatitude] :: EditMessageLiveLocationRequest -> Float
-- | Longitude of new location.
[editMessageLiveLocationLongitude] :: EditMessageLiveLocationRequest -> Float
-- | New period in seconds during which the location can be updated,
-- starting from the message send date. If 0x7FFFFFFF is
-- specified, then the location can be updated forever. Otherwise, the
-- new value must not exceed the current live_period by more
-- than a day, and the live location expiration date must remain within
-- the next 90 days. If not specified, then live_period remains
-- unchanged.
[editMessageLiveLocationLivePeriod] :: EditMessageLiveLocationRequest -> Maybe Int
-- | The radius of uncertainty for the location, measured in meters;
-- 0-1500.
[editMessageLiveLocationHorizontalAccuracy] :: EditMessageLiveLocationRequest -> Maybe Float
-- | Direction in which the user is moving, in degrees. Must be between 1
-- and 360 if specified.
[editMessageLiveLocationHeading] :: EditMessageLiveLocationRequest -> Maybe Int
-- | Maximum distance for proximity alerts about approaching another chat
-- member, in meters. Must be between 1 and 100000 if specified.
[editMessageLiveLocationProximityAlertRadius] :: EditMessageLiveLocationRequest -> Maybe Int
-- | Additional interface options. A JSON-serialized object for an inline
-- keyboard, custom reply keyboard, instructions to remove reply keyboard
-- or to force a reply from the user.
[editMessageLiveLocationReplyMarkup] :: EditMessageLiveLocationRequest -> Maybe InlineKeyboardMarkup
type EditMessageLiveLocation = "editMessageLiveLocation" :> ReqBody '[JSON] EditMessageLiveLocationRequest :> Post '[JSON] (Response (Either Bool Message))
-- | Use this method to edit live location messages. A location can be
-- edited until its live_period expires or editing is explicitly disabled
-- by a call to stopMessageLiveLocation. On success, if the edited
-- message is not an inline message, the edited Message is returned,
-- otherwise True is returned.
editMessageLiveLocation :: EditMessageLiveLocationRequest -> ClientM (Response (Either Bool Message))
defEditMessageLiveLocation :: Float -> Float -> EditMessageLiveLocationRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.EditMessageLiveLocation.EditMessageLiveLocationRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.EditMessageLiveLocation.EditMessageLiveLocationRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Methods.EditMessageLiveLocation.EditMessageLiveLocationRequest
module Telegram.Bot.API.Methods.EditChatInviteLink
-- | Request parameters for editChatInviteLink.
data EditChatInviteLinkRequest
EditChatInviteLinkRequest :: SomeChatId -> Text -> Maybe Text -> Maybe Integer -> Maybe Int -> Maybe Bool -> EditChatInviteLinkRequest
-- | Unique identifier for the target chat or username of the target
-- channel (in the format @channelusername)
[editChatInviteLinkChatId] :: EditChatInviteLinkRequest -> SomeChatId
-- | The invite link to edit
[editChatInviteLinkInviteLink] :: EditChatInviteLinkRequest -> Text
-- | Invite link name; 0-32 characters
[editChatInviteLinkName] :: EditChatInviteLinkRequest -> Maybe Text
-- | Point in time (Unix timestamp) when the link will expire
[editChatInviteLinkExpireDate] :: EditChatInviteLinkRequest -> Maybe Integer
-- | Maximum number of users that can be members of the chat simultaneously
-- after joining the chat via this invite link; 1-99999
[editChatInviteLinkMemberLimit] :: EditChatInviteLinkRequest -> Maybe Int
-- | True, if users joining the chat via the link need to be approved by
-- chat administrators. If True, member_limit can't be specified
[editChatInviteLinkCreatesJoinRequest] :: EditChatInviteLinkRequest -> Maybe Bool
type EditChatInviteLink = "editChatInviteLink" :> ReqBody '[JSON] EditChatInviteLinkRequest :> Post '[JSON] (Response ChatInviteLink)
-- | Use this method to edit a non-primary invite link created by the bot.
-- The bot must be an administrator in the chat for this to work and must
-- have the appropriate administrator rights. Returns the edited invite
-- link as a ChatInviteLink object.
editChatInviteLink :: EditChatInviteLinkRequest -> ClientM (Response ChatInviteLink)
defEditChatInviteLink :: SomeChatId -> Text -> EditChatInviteLinkRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.EditChatInviteLink.EditChatInviteLinkRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.EditChatInviteLink.EditChatInviteLinkRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Methods.EditChatInviteLink.EditChatInviteLinkRequest
module Telegram.Bot.API.Methods.DeleteStickerSet
type DeleteStickerSet = "deleteStickerSet" :> RequiredQueryParam "name" Text :> Post '[JSON] (Response Bool)
-- | Use this method to delete a sticker set that was created by the bot.
-- Returns True on success.
deleteStickerSet :: Text -> ClientM (Response Bool)
module Telegram.Bot.API.Methods.DeleteMyCommands
-- | Request parameters for deleteMyCommands.
data DeleteMyCommandsRequest
DeleteMyCommandsRequest :: Maybe BotCommandScope -> Maybe Text -> DeleteMyCommandsRequest
-- | A JSON-serialized object, describing scope of users. Defaults to
-- BotCommandScopeDefault.
[deleteMyCommandsScope] :: DeleteMyCommandsRequest -> Maybe BotCommandScope
-- | A two-letter ISO 639-1 language code. If empty, commands will be
-- applied to all users from the given scope, for whose language there
-- are no dedicated commands
[deleteMyCommandsLanguageCode] :: DeleteMyCommandsRequest -> Maybe Text
type DeleteMyCommands = "deleteMyCommands" :> ReqBody '[JSON] DeleteMyCommandsRequest :> Post '[JSON] (Response Bool)
-- | Use this method to delete the list of the bot's commands for the given
-- scope and user language. After deletion, higher level commands will be
-- shown to affected users. Returns True on success.
deleteMyCommands :: DeleteMyCommandsRequest -> ClientM (Response Bool)
defDeleteMyCommands :: DeleteMyCommandsRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.DeleteMyCommands.DeleteMyCommandsRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.DeleteMyCommands.DeleteMyCommandsRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Methods.DeleteMyCommands.DeleteMyCommandsRequest
module Telegram.Bot.API.Methods.DeleteMessages
-- | Use this method to delete multiple messages simultaneously. If some of
-- the specified messages can't be found, they are skipped. Returns
-- True on success.
type DeleteMessages = "deleteMessages" :> ReqBody '[JSON] DeleteMessagesRequest :> Post '[JSON] (Response Bool)
-- | Use this method to delete message in chat. On success, the sent Bool
-- is returned.
deleteMessages :: DeleteMessagesRequest -> ClientM (Response Bool)
-- | Request parameters for deleteMessages.
data DeleteMessagesRequest
DeleteMessagesRequest :: ChatId -> [MessageId] -> DeleteMessagesRequest
-- | Unique identifier for the target chat or username of the target
-- channel (in the format @channelusername).
[deleteMessagesRequestChatId] :: DeleteMessagesRequest -> ChatId
-- | Identifiers of 1-100 messages to delete. See deleteMessage
-- for limitations on which messages can be deleted.
[deleteMessagesRequestMessageIds] :: DeleteMessagesRequest -> [MessageId]
defDeleteMessages :: ChatId -> [MessageId] -> DeleteMessagesRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.DeleteMessages.DeleteMessagesRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.DeleteMessages.DeleteMessagesRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Methods.DeleteMessages.DeleteMessagesRequest
module Telegram.Bot.API.Methods.DeleteMessage
-- | Notice that deleting by POST method was bugged, so we use GET
type DeleteMessage = "deleteMessage" :> RequiredQueryParam "chat_id" ChatId :> RequiredQueryParam "message_id" MessageId :> Get '[JSON] (Response Bool)
-- | Use this method to delete message in chat. On success, the sent Bool
-- is returned.
deleteMessage :: ChatId -> MessageId -> ClientM (Response Bool)
module Telegram.Bot.API.Methods.DeleteChatStickerSet
type DeleteChatStickerSet = "deleteChatStickerSet" :> RequiredQueryParam "chat_id" SomeChatId :> Post '[JSON] (Response Bool)
-- | Use this method to delete a group sticker set from a supergroup. The
-- bot must be an administrator in the chat for this to work and must
-- have the appropriate administrator rights. Use the field
-- can_set_sticker_set optionally returned in getChat requests to check
-- if the bot can use this method. Returns True on success.
deleteChatStickerSet :: SomeChatId -> ClientM (Response Bool)
module Telegram.Bot.API.Methods.DeleteChatPhoto
type DeleteChatPhoto = "deleteChatPhoto" :> RequiredQueryParam "chat_id" SomeChatId :> Post '[JSON] (Response Bool)
-- | Use this method to delete a chat photo. Photos can't be changed for
-- private chats. The bot must be an administrator in the chat for this
-- to work and must have the appropriate administrator rights. Returns
-- True on success.
deleteChatPhoto :: SomeChatId -> ClientM (Response Bool)
module Telegram.Bot.API.Methods.DeclineChatJoinRequest
type DeclineChatJoinRequest = "declineChatJoinRequest" :> RequiredQueryParam "chat_id" SomeChatId :> RequiredQueryParam "user_id" UserId :> Post '[JSON] (Response Bool)
-- | Use this method to decline a chat join request. The bot must be an
-- administrator in the chat for this to work and must have the
-- can_invite_users administrator right. Returns True on success.
declineChatJoinRequest :: SomeChatId -> UserId -> ClientM (Response Bool)
module Telegram.Bot.API.Methods.CreateChatInviteLink
-- | Request parameters for createChatInviteLink.
data CreateChatInviteLinkRequest
CreateChatInviteLinkRequest :: SomeChatId -> Maybe Text -> Maybe Integer -> Maybe Int -> Maybe Bool -> CreateChatInviteLinkRequest
-- | Unique identifier for the target chat or username of the target
-- channel (in the format @channelusername)
[createChatInviteLinkChatId] :: CreateChatInviteLinkRequest -> SomeChatId
-- | Invite link name; 0-32 characters
[createChatInviteLinkName] :: CreateChatInviteLinkRequest -> Maybe Text
-- | Point in time (Unix timestamp) when the link will expire
[createChatInviteLinkExpireDate] :: CreateChatInviteLinkRequest -> Maybe Integer
-- | Maximum number of users that can be members of the chat simultaneously
-- after joining the chat via this invite link; 1-99999
[createChatInviteLinkMemberLimit] :: CreateChatInviteLinkRequest -> Maybe Int
-- | True, if users joining the chat via the link need to be approved by
-- chat administrators. If True, member_limit can't be specified
[createChatInviteLinkCreatesJoinRequest] :: CreateChatInviteLinkRequest -> Maybe Bool
type CreateChatInviteLink = "createChatInviteLink" :> ReqBody '[JSON] CreateChatInviteLinkRequest :> Post '[JSON] (Response ChatInviteLink)
-- | Use this method to create an additional invite link for a chat. The
-- bot must be an administrator in the chat for this to work and must
-- have the appropriate administrator rights. The link can be revoked
-- using the method revokeChatInviteLink. Returns the new invite link as
-- ChatInviteLink object.
createChatInviteLink :: CreateChatInviteLinkRequest -> ClientM (Response ChatInviteLink)
defCreateChatInviteLink :: SomeChatId -> CreateChatInviteLinkRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.CreateChatInviteLink.CreateChatInviteLinkRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.CreateChatInviteLink.CreateChatInviteLinkRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Methods.CreateChatInviteLink.CreateChatInviteLinkRequest
module Telegram.Bot.API.Methods.CopyMessages
type CopyMessages = "copyMessages" :> ReqBody '[JSON] CopyMessagesRequest :> Post '[JSON] (Response [CopyMessageId])
-- | Use this method to copy messages of any kind. If some of the specified
-- messages can't be found or copied, they are skipped. Service messages,
-- giveaway messages, giveaway winners messages, and invoice messages
-- can't be copied. A quiz poll can be copied only if the value of the
-- field correct_option_id is knownto the bot. The method is
-- analogous to the method forwardMessages, but the copied
-- messages don't have a link to the original message. Album grouping is
-- kept for copied messages. On success, an array of CopyMessageId
-- of the sent messages is returned.
copyMessages :: CopyMessagesRequest -> ClientM (Response [CopyMessageId])
-- | Request parameters for copyMessages.
data CopyMessagesRequest
CopyMessagesRequest :: SomeChatId -> Maybe Message -> SomeChatId -> [MessageId] -> Maybe Text -> Maybe ParseMode -> Maybe [MessageEntity] -> Maybe Bool -> Maybe Bool -> Maybe Bool -> CopyMessagesRequest
-- | Unique identifier for the target chat or username of the target
-- channel (in the format @channelusername).
[copyMessagesChatId] :: CopyMessagesRequest -> SomeChatId
-- | Unique identifier for the target message thread (topic) of the forum;
-- for forum supergroups only.
[copyMessagesMessageThreadId] :: CopyMessagesRequest -> Maybe Message
-- | Unique identifier for the chat where the original message was sent (or
-- channel username in the format @channelusername).
[copyMessagesFromChatId] :: CopyMessagesRequest -> SomeChatId
-- | Identifiers of 1-100 messages in the chat from_chat_id to
-- copy. The identifiers must be specified in a strictly increasing
-- order.
[copyMessagesMessageIds] :: CopyMessagesRequest -> [MessageId]
-- | New caption for media, 0-1024 characters after entities parsing. If
-- not specified, the original caption is kept
[copyMessagesCaption] :: CopyMessagesRequest -> Maybe Text
-- | Send MarkdownV2, HTML or Markdown (legacy), if
-- you want Telegram apps to show bold, italic, fixed-width text or
-- inline URLs in your bot's message.
[copyMessagesParseMode] :: CopyMessagesRequest -> Maybe ParseMode
-- | A JSON-serialized list of special entities that appear in the caption,
-- which can be specified instead of parse_mode
[copyMessagesCaptionEntities] :: CopyMessagesRequest -> Maybe [MessageEntity]
-- | Sends the message silently. Users will receive a notification with no
-- sound.
[copyMessagesDisableNotification] :: CopyMessagesRequest -> Maybe Bool
-- | Protects the contents of the sent message from forwarding and saving
[copyMessagesProtectContent] :: CopyMessagesRequest -> Maybe Bool
-- | Pass True to copy the messages without their captions.
[copyMessagesRemoveCaption] :: CopyMessagesRequest -> Maybe Bool
defCopyMessages :: SomeChatId -> SomeChatId -> [MessageId] -> CopyMessagesRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.CopyMessages.CopyMessagesRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.CopyMessages.CopyMessagesRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Methods.CopyMessages.CopyMessagesRequest
module Telegram.Bot.API.Methods.CopyMessage
type CopyMessage = "copyMessage" :> ReqBody '[JSON] CopyMessageRequest :> Post '[JSON] (Response CopyMessageId)
-- | Use this method to copy messages of any kind. Service messages and
-- invoice messages can't be copied. The method is analogous to the
-- method forwardMessage, but the copied message doesn't have a link to
-- the original message. Returns the MessageId of the sent message on
-- success.
copyMessage :: CopyMessageRequest -> ClientM (Response CopyMessageId)
-- | Request parameters for copyMessage.
data CopyMessageRequest
CopyMessageRequest :: SomeChatId -> Maybe Message -> SomeChatId -> MessageId -> Maybe Text -> Maybe ParseMode -> Maybe [MessageEntity] -> Maybe Bool -> Maybe Bool -> Maybe MessageId -> Maybe ReplyParameters -> Maybe InlineKeyboardMarkup -> CopyMessageRequest
-- | Unique identifier for the target chat or username of the target
-- channel (in the format @channelusername).
[copyMessageChatId] :: CopyMessageRequest -> SomeChatId
-- | Unique identifier for the target message thread (topic) of the forum;
-- for forum supergroups only.
[copyMessageMessageThreadId] :: CopyMessageRequest -> Maybe Message
-- | Unique identifier for the chat where the original message was sent (or
-- channel username in the format @channelusername)
[copyMessageFromChatId] :: CopyMessageRequest -> SomeChatId
-- | Message identifier in the chat specified in from_chat_id
[copyMessageMessageId] :: CopyMessageRequest -> MessageId
-- | New caption for media, 0-1024 characters after entities parsing. If
-- not specified, the original caption is kept
[copyMessageCaption] :: CopyMessageRequest -> Maybe Text
-- | Send MarkdownV2, HTML or Markdown (legacy), if
-- you want Telegram apps to show bold, italic, fixed-width text or
-- inline URLs in your bot's message.
[copyMessageParseMode] :: CopyMessageRequest -> Maybe ParseMode
-- | A JSON-serialized list of special entities that appear in the caption,
-- which can be specified instead of parse_mode
[copyMessageCaptionEntities] :: CopyMessageRequest -> Maybe [MessageEntity]
-- | Sends the message silently. Users will receive a notification with no
-- sound.
[copyMessageDisableNotification] :: CopyMessageRequest -> Maybe Bool
-- | Protects the contents of the sent message from forwarding and saving
[copyMessageProtectContent] :: CopyMessageRequest -> Maybe Bool
-- | If the message is a reply, ID of the original message
[copyMessageReplyToMessageId] :: CopyMessageRequest -> Maybe MessageId
-- | Description of the message to reply to.
[copyMessageReplyParameters] :: CopyMessageRequest -> Maybe ReplyParameters
-- | Additional interface options. A JSON-serialized object for an inline
-- keyboard, custom reply keyboard, instructions to remove reply keyboard
-- or to force a reply from the user.
[copyMessageReplyMarkup] :: CopyMessageRequest -> Maybe InlineKeyboardMarkup
defCopyMessage :: SomeChatId -> SomeChatId -> MessageId -> CopyMessageRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.CopyMessage.CopyMessageRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.CopyMessage.CopyMessageRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Methods.CopyMessage.CopyMessageRequest
module Telegram.Bot.API.Methods.BanChatSenderChat
type BanChatSenderChat = "banChatSenderChat" :> RequiredQueryParam "chat_id" SomeChatId :> RequiredQueryParam "sender_chat_id" ChatId :> Post '[JSON] (Response Bool)
-- | Use this method to ban a channel chat in a supergroup or a channel.
-- Until the chat is unbanned, the owner of the banned chat won't be able
-- to send messages on behalf of any of their channels. The bot must be
-- an administrator in the supergroup or channel for this to work and
-- must have the appropriate administrator rights. Returns True on
-- success.
banChatSenderChat :: SomeChatId -> ChatId -> ClientM (Response Bool)
module Telegram.Bot.API.Methods.BanChatMember
-- | Request parameters for banChatMember.
data BanChatMemberRequest
BanChatMemberRequest :: SomeChatId -> UserId -> Maybe Int -> Maybe Bool -> BanChatMemberRequest
-- | Unique identifier for the target chat or username of the target
-- channel (in the format @channelusername)
[banChatMemberChatId] :: BanChatMemberRequest -> SomeChatId
-- | Unique identifier of the target user
[banChatMemberUserId] :: BanChatMemberRequest -> UserId
-- | Date when the user will be unbanned, unix time. If user is banned for
-- more than 366 days or less than 30 seconds from the current time they
-- are considered to be banned forever. Applied for supergroups and
-- channels only.
[banChatMemberUntilDate] :: BanChatMemberRequest -> Maybe Int
-- | Pass True to delete all messages from the chat for the user that is
-- being removed. If False, the user will be able to see messages in the
-- group that were sent before the user was removed. Always True for
-- supergroups and channels.
[banChatMemberRevokeMessages] :: BanChatMemberRequest -> Maybe Bool
type BanChatMember = "banChatMember" :> ReqBody '[JSON] BanChatMemberRequest :> Post '[JSON] (Response Bool)
-- | Use this method to ban a user in a group, a supergroup or a channel.
-- In the case of supergroups and channels, the user will not be able to
-- return to the chat on their own using invite links, etc., unless
-- unbanned first. The bot must be an administrator in the chat for this
-- to work and must have the appropriate administrator rights. Returns
-- True on success.
banChatMember :: BanChatMemberRequest -> ClientM (Response Bool)
defBanChatMember :: SomeChatId -> UserId -> BanChatMemberRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.BanChatMember.BanChatMemberRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.BanChatMember.BanChatMemberRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Methods.BanChatMember.BanChatMemberRequest
module Telegram.Bot.API.Methods.ApproveChatJoinRequest
type ApproveChatJoinRequest = "approveChatJoinRequest" :> RequiredQueryParam "chat_id" SomeChatId :> RequiredQueryParam "user_id" UserId :> Post '[JSON] (Response Bool)
-- | Use this method to approve a chat join request. The bot must be an
-- administrator in the chat for this to work and must have the
-- can_invite_users administrator right. Returns True on success.
approveChatJoinRequest :: SomeChatId -> UserId -> ClientM (Response Bool)
module Telegram.Bot.API.Methods.AnswerCallbackQuery
-- | Request parameters for answerCallbackQuery.
data AnswerCallbackQueryRequest
AnswerCallbackQueryRequest :: CallbackQueryId -> Maybe Text -> Maybe Bool -> Maybe Text -> Maybe Integer -> AnswerCallbackQueryRequest
-- | Unique identifier for the query to be answered
[answerCallbackQueryCallbackQueryId] :: AnswerCallbackQueryRequest -> CallbackQueryId
-- | Text of the notification. If not specified, nothing will be shown to
-- the user, 0-200 characters
[answerCallbackQueryText] :: AnswerCallbackQueryRequest -> Maybe Text
-- | If True, an alert will be shown by the client instead of a
-- notification at the top of the chat screen. Defaults to false.
[answerCallbackQueryShowAlert] :: AnswerCallbackQueryRequest -> Maybe Bool
-- | URL that will be opened by the user's client. If you have created a
-- Game and accepted the conditions via @Botfather, specify the URL that
-- opens your game — note that this will only work if the query comes
-- from a callback_game button.
--
-- Otherwise, you may use links like t.me/your_bot?start=XXXX that open
-- your bot with a parameter.
[answerCallbackQueryUrl] :: AnswerCallbackQueryRequest -> Maybe Text
-- | The maximum amount of time in seconds that the result of the callback
-- query may be cached client-side. Telegram apps will support caching
-- starting in version 3.14. Defaults to 0.
[answerCallbackQueryCacheTime] :: AnswerCallbackQueryRequest -> Maybe Integer
type AnswerCallbackQuery = "answerCallbackQuery" :> ReqBody '[JSON] AnswerCallbackQueryRequest :> Post '[JSON] (Response Bool)
-- | Use this method to send answers to callback queries sent from inline
-- keyboards. The answer will be displayed to the user as a notification
-- at the top of the chat screen or as an alert. On success, True is
-- returned.
--
-- Alternatively, the user can be redirected to the specified Game URL.
-- For this option to work, you must first create a game for your bot via
-- @Botfather and accept the terms. Otherwise, you may use links like
-- t.me/your_bot?start=XXXX that open your bot with a parameter.
answerCallbackQuery :: AnswerCallbackQueryRequest -> ClientM (Response Bool)
defAnswerCallbackQuery :: CallbackQueryId -> AnswerCallbackQueryRequest
instance GHC.Generics.Generic Telegram.Bot.API.Methods.AnswerCallbackQuery.AnswerCallbackQueryRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Methods.AnswerCallbackQuery.AnswerCallbackQueryRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Methods.AnswerCallbackQuery.AnswerCallbackQueryRequest
module Telegram.Bot.API.InlineMode.InlineQueryResult
newtype InlineQueryResultId
InlineQueryResultId :: Text -> InlineQueryResultId
data InlineQueryResultGeneric
InlineQueryResultGeneric :: InlineQueryResultId -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe [MessageEntity] -> Maybe InlineKeyboardMarkup -> Maybe InputMessageContent -> Maybe Text -> InlineQueryResultGeneric
-- | Unique identifier for this result, 1-64 Bytes
[inlineQueryResultId] :: InlineQueryResultGeneric -> InlineQueryResultId
-- | Title of the result (only valid for Article, Photo,
-- Gif, Mpeg4Gif, Video, Audio, Voice,
-- Document, Location, Venue, CachedPhoto,
-- CachedGif, CachedMpeg4Gif, CachedDocument,
-- CachedVideo, CachedVoice types of results)
[inlineQueryResultTitle] :: InlineQueryResultGeneric -> Maybe Text
-- | Caption of the media to be sent, 0-1024 characters after entities
-- parsing.
[inlineQueryResultCaption] :: InlineQueryResultGeneric -> Maybe Text
-- | Mode for parsing entities in the photo caption. See formatting options
-- https://core.telegram.org/bots/api#formatting-options for more
-- details.
[inlineQueryResultParseMode] :: InlineQueryResultGeneric -> Maybe Text
-- | List of special entities that appear in the caption, which can be
-- specified instead of parse_mode.
[inlineQueryResultCaptionEntities] :: InlineQueryResultGeneric -> Maybe [MessageEntity]
-- | Inline keyboard attached to the message.
[inlineQueryResultReplyMarkup] :: InlineQueryResultGeneric -> Maybe InlineKeyboardMarkup
-- | Content of the message to be sent instead of the media.
[inlineQueryResultInputMessageContent] :: InlineQueryResultGeneric -> Maybe InputMessageContent
-- | Short description of the result.
[inlineQueryResultDescription] :: InlineQueryResultGeneric -> Maybe Text
data InlineQueryResultGenericThumbnail
InlineQueryResultGenericThumbnail :: InlineQueryResultGeneric -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Integer -> InlineQueryResultGenericThumbnail
[inlineQueryResultGenericGeneric] :: InlineQueryResultGenericThumbnail -> InlineQueryResultGeneric
-- | URL of the thumbnail for the media.
[inlineQueryResultGenericThumbnailUrl] :: InlineQueryResultGenericThumbnail -> Maybe Text
-- | MIME type of the thumbnail, must be one of image/jpeg,
-- image/gif, or video/mp4. Defaults to
-- image/jpeg.
[inlineQueryResultGenericThumbnailMimeType] :: InlineQueryResultGenericThumbnail -> Maybe Text
-- | Media width.
[inlineQueryResultGenericThumbnailWidth] :: InlineQueryResultGenericThumbnail -> Maybe Integer
-- | Media height.
[inlineQueryResultGenericThumbnailHeight] :: InlineQueryResultGenericThumbnail -> Maybe Integer
-- | This object represents one result of an inline query
data InlineQueryResult
InlineQueryResultArticle :: InlineQueryResultGenericThumbnail -> Maybe Text -> Maybe Bool -> InlineQueryResult
[inlineQueryResultArticleGeneric] :: InlineQueryResult -> InlineQueryResultGenericThumbnail
-- | URL of the result.
[inlineQueryResultArticleUrl] :: InlineQueryResult -> Maybe Text
-- | True if you don't want the URL to be shown in the message.
[inlineQueryResultArticleHideUrl] :: InlineQueryResult -> Maybe Bool
InlineQueryResultPhoto :: InlineQueryResultGenericThumbnail -> Text -> Maybe Integer -> Maybe Integer -> InlineQueryResult
[inlineQueryResultPhotoGeneric] :: InlineQueryResult -> InlineQueryResultGenericThumbnail
-- | A valid URL of the photo. Photo must be in **JPEG** format. Photo size
-- must not exceed 5MB.
[inlineQueryResultPhotoPhotoUrl] :: InlineQueryResult -> Text
-- | Width of the photo.
[inlineQueryResultPhotoPhotoWidth] :: InlineQueryResult -> Maybe Integer
-- | Height of the photo.
[inlineQueryResultPhotoPhotoHeight] :: InlineQueryResult -> Maybe Integer
InlineQueryResultGif :: InlineQueryResultGenericThumbnail -> Text -> Maybe Integer -> Maybe Integer -> Maybe Integer -> InlineQueryResult
[inlineQueryResultGifGeneric] :: InlineQueryResult -> InlineQueryResultGenericThumbnail
-- | A valid URL for the GIF file. File size must not exceed 1MB.
[inlineQueryResultGifGifUrl] :: InlineQueryResult -> Text
-- | Width of the GIF.
[inlineQueryResultGifGifWidth] :: InlineQueryResult -> Maybe Integer
-- | Height of the GIF.
[inlineQueryResultGifGifHeight] :: InlineQueryResult -> Maybe Integer
-- | Duration of the GIF in seconds.
[inlineQueryResultGifGifDuration] :: InlineQueryResult -> Maybe Integer
InlineQueryResultMpeg4Gif :: InlineQueryResultGenericThumbnail -> Text -> Maybe Integer -> Maybe Integer -> Maybe Integer -> InlineQueryResult
[inlineQueryResultMpeg4GifGeneric] :: InlineQueryResult -> InlineQueryResultGenericThumbnail
-- | A valid URL for the MPEG4 file. File size must not exceed 1MB.
[inlineQueryResultMpeg4GifMpeg4Url] :: InlineQueryResult -> Text
-- | Video width.
[inlineQueryResultMpeg4GifMpeg4Width] :: InlineQueryResult -> Maybe Integer
-- | Video height.
[inlineQueryResultMpeg4GifMpeg4Height] :: InlineQueryResult -> Maybe Integer
-- | Video duration in seconds.
[inlineQueryResultMpeg4GifMpeg4Duration] :: InlineQueryResult -> Maybe Integer
InlineQueryResultVideo :: InlineQueryResultGenericThumbnail -> Text -> Text -> Maybe Integer -> Maybe Integer -> Maybe Integer -> InlineQueryResult
[inlineQueryResultVideoGeneric] :: InlineQueryResult -> InlineQueryResultGenericThumbnail
-- | A valid URL for the embedded video player or video file.
[inlineQueryResultVideoVideoUrl] :: InlineQueryResult -> Text
-- | MIME type of the content of the video URL, text/html or
-- video/mp4.
[inlineQueryResultVideoMimeType] :: InlineQueryResult -> Text
-- | Video width.
[inlineQueryResultVideoVideoWidth] :: InlineQueryResult -> Maybe Integer
-- | Video height.
[inlineQueryResultVideoVideoHeight] :: InlineQueryResult -> Maybe Integer
-- | Video duration in seconds.
[inlineQueryResultVideoVideoDuration] :: InlineQueryResult -> Maybe Integer
InlineQueryResultAudio :: InlineQueryResultGeneric -> Text -> Maybe Text -> Maybe Integer -> InlineQueryResult
[inlineQueryResultAudioGeneric] :: InlineQueryResult -> InlineQueryResultGeneric
-- | A valid URL for the audio file.
[inlineQueryResultAudioAudioUrl] :: InlineQueryResult -> Text
-- | Performer.
[inlineQueryResultAudioPerformer] :: InlineQueryResult -> Maybe Text
-- | Audio duration in seconds.
[inlineQueryResultAudioAudioDuration] :: InlineQueryResult -> Maybe Integer
InlineQueryResultVoice :: InlineQueryResultGeneric -> Text -> Maybe Integer -> InlineQueryResult
[inlineQueryResultVoiceGeneric] :: InlineQueryResult -> InlineQueryResultGeneric
-- | A valid URL for the voice recording.
[inlineQueryResultVoiceVoiceUrl] :: InlineQueryResult -> Text
-- | Recording duration in seconds.
[inlineQueryResultVoiceVoiceDuration] :: InlineQueryResult -> Maybe Integer
InlineQueryResultDocument :: InlineQueryResultGenericThumbnail -> Text -> Text -> InlineQueryResult
[inlineQueryResultDocumentGeneric] :: InlineQueryResult -> InlineQueryResultGenericThumbnail
-- | A valid URL for the file.
[inlineQueryResultDocumentDocumentUrl] :: InlineQueryResult -> Text
-- | MIME type of the content of the file, either application/pdf
-- or application/zip.
[inlineQueryResultDocumentMimeType] :: InlineQueryResult -> Text
InlineQueryResultLocation :: InlineQueryResultGenericThumbnail -> Float -> Float -> Maybe Float -> Maybe Seconds -> Maybe Int -> Maybe Int -> InlineQueryResult
[inlineQueryResultLocationGeneric] :: InlineQueryResult -> InlineQueryResultGenericThumbnail
-- | Location latitude in degrees.
[inlineQueryResultLocationLatitude] :: InlineQueryResult -> Float
-- | Location longitude in degrees.
[inlineQueryResultLocationLongitude] :: InlineQueryResult -> Float
-- | The radius of uncertainty for the location, measured in meters;
-- 0-1500.
[inlineQueryResultLocationHorizontalAccuracy] :: InlineQueryResult -> Maybe Float
-- | Period in seconds for which the location can be updated, should be
-- between 60 and 86400.
[inlineQueryResultLocationLivePeriod] :: InlineQueryResult -> Maybe Seconds
-- | For live locations, a direction in which the user is moving, in
-- degrees. Must be between 1 and 360 if specified.
[inlineQueryResultLocationHeading] :: InlineQueryResult -> Maybe Int
-- | For live locations, a maximum distance for proximity alerts about
-- approaching another chat member, in meters. Must be between 1 and
-- 100000 if specified.
[inlineQueryResultLocationProximityAlertRadius] :: InlineQueryResult -> Maybe Int
InlineQueryResultVenue :: InlineQueryResultGenericThumbnail -> Float -> Float -> Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> InlineQueryResult
[inlineQueryResultVenueGeneric] :: InlineQueryResult -> InlineQueryResultGenericThumbnail
-- | Latitude of the venue location in degrees.
[inlineQueryResultVenueLatitude] :: InlineQueryResult -> Float
-- | Longitude of the venue location in degrees.
[inlineQueryResultVenueLongitude] :: InlineQueryResult -> Float
-- | Address of the venue.
[inlineQueryResultVenueAddress] :: InlineQueryResult -> Text
-- | Foursquare identifier of the venue if known.
[inlineQueryResultVenueFoursquareId] :: InlineQueryResult -> Maybe Text
-- | Foursquare type of the venue, if known. (For example,
-- arts_entertainment/default,
-- arts_entertainment/aquarium or food/icecream.)
[inlineQueryResultVenueFoursquareType] :: InlineQueryResult -> Maybe Text
-- | Google Places identifier of the venue.
[inlineQueryResultVenueGooglePlaceId] :: InlineQueryResult -> Maybe Text
-- | Google Places type of the venue. (See supported types
-- https://developers.google.com/places/web-service/supported_types.)
[inlineQueryResultVenueGooglePlaceType] :: InlineQueryResult -> Maybe Text
InlineQueryResultContact :: InlineQueryResultGenericThumbnail -> Text -> Text -> Maybe Text -> Maybe Text -> InlineQueryResult
[inlineQueryResultContactGeneric] :: InlineQueryResult -> InlineQueryResultGenericThumbnail
-- | Contact's phone number.
[inlineQueryResultContactPhoneNumber] :: InlineQueryResult -> Text
-- | Contact's first name.
[inlineQueryResultContactFirstName] :: InlineQueryResult -> Text
-- | Contact's last name.
[inlineQueryResultContactLastName] :: InlineQueryResult -> Maybe Text
-- | Additional data about the contact in the form of a vCard
-- https://en.wikipedia.org/wiki/VCard, 0-2048 bytes.
[inlineQueryResultContactVcard] :: InlineQueryResult -> Maybe Text
InlineQueryResultGame :: InlineQueryResultGeneric -> Text -> InlineQueryResult
[inlineQueryResultGameGeneric] :: InlineQueryResult -> InlineQueryResultGeneric
-- | Short name of the game.
[inlineQueryResultGameGameShortName] :: InlineQueryResult -> Text
InlineQueryResultCachedPhoto :: InlineQueryResultGeneric -> FileId -> InlineQueryResult
[inlineQueryResultCachedPhotoGeneric] :: InlineQueryResult -> InlineQueryResultGeneric
-- | A valid file identifier of the photo.
[inlineQueryResultCachedPhotoPhotoFileId] :: InlineQueryResult -> FileId
InlineQueryResultCachedGif :: InlineQueryResultGeneric -> FileId -> InlineQueryResult
[inlineQueryResultCachedGifGeneric] :: InlineQueryResult -> InlineQueryResultGeneric
-- | A valid file identifier for the GIF file.
[iinlineQueryResultCachedGifGifFileId] :: InlineQueryResult -> FileId
InlineQueryResultCachedMpeg4Gif :: InlineQueryResultGeneric -> FileId -> InlineQueryResult
[inlineQueryResultCachedMpeg4GifGeneric] :: InlineQueryResult -> InlineQueryResultGeneric
-- | A valid file identifier for the MPEG4 file.
[inlineQueryResultCachedMpeg4GifMpeg4FileId] :: InlineQueryResult -> FileId
InlineQueryResultCachedSticker :: InlineQueryResultGeneric -> FileId -> InlineQueryResult
[inlineQueryResultCachedStickerGeneric] :: InlineQueryResult -> InlineQueryResultGeneric
-- | A valid file identifier of the sticker.
[inlineQueryResultCachedStickerStickerFileId] :: InlineQueryResult -> FileId
InlineQueryResultCachedDocument :: InlineQueryResultGeneric -> FileId -> InlineQueryResult
[inlineQueryResultCachedDocumentGeneric] :: InlineQueryResult -> InlineQueryResultGeneric
-- | A valid file identifier for the file.
[inlineQueryResultCachedDocumentDocumentFileId] :: InlineQueryResult -> FileId
InlineQueryResultCachedVideo :: InlineQueryResultGeneric -> FileId -> InlineQueryResult
[inlineQueryResultCachedVideoGeneric] :: InlineQueryResult -> InlineQueryResultGeneric
-- | A valid file identifier for the video file.
[inlineQueryResultCachedVideoVideoFileId] :: InlineQueryResult -> FileId
InlineQueryResultCachedVoice :: InlineQueryResultGeneric -> FileId -> InlineQueryResult
[inlineQueryResultCachedVoiceGeneric] :: InlineQueryResult -> InlineQueryResultGeneric
-- | A valid file identifier for the voice message.
[inlineQueryResultCachedVoiceVoiceFileId] :: InlineQueryResult -> FileId
InlineQueryResultCachedAudio :: InlineQueryResultGeneric -> FileId -> InlineQueryResult
[inlineQueryResultCachedAudioGeneric] :: InlineQueryResult -> InlineQueryResultGeneric
-- | A valid file identifier for the audio file.
[inlineQueryResultCachedAudioAudioFileId] :: InlineQueryResult -> FileId
defInlineQueryResultArticle :: InlineQueryResultGenericThumbnail -> InlineQueryResult
defInlineQueryResultPhotoUrl :: InlineQueryResultGenericThumbnail -> Text -> InlineQueryResult
defInlineQueryResultGif :: InlineQueryResultGenericThumbnail -> Text -> InlineQueryResult
defInlineQueryResultMpeg4Gif :: InlineQueryResultGenericThumbnail -> Text -> InlineQueryResult
defInlineQueryResultVideo :: InlineQueryResultGenericThumbnail -> Text -> Text -> InlineQueryResult
defInlineQueryResultAudio :: InlineQueryResultGeneric -> Text -> InlineQueryResult
defInlineQueryResultVoice :: InlineQueryResultGeneric -> Text -> InlineQueryResult
defInlineQueryResultDocument :: InlineQueryResultGenericThumbnail -> Text -> Text -> InlineQueryResult
defInlineQueryResultLocation :: InlineQueryResultGenericThumbnail -> Float -> Float -> InlineQueryResult
defInlineQueryResultVenue :: InlineQueryResultGenericThumbnail -> Float -> Float -> Text -> InlineQueryResult
defInlineQueryResultContact :: InlineQueryResultGenericThumbnail -> Text -> Text -> InlineQueryResult
-- | This object represents a button to be shown above inline query
-- results. You must use exactly one of the optional fields.
data InlineQueryResultsButton
InlineQueryResultsButton :: Text -> Maybe WebAppInfo -> Maybe Text -> InlineQueryResultsButton
[inlineQueryResultsButtonText] :: InlineQueryResultsButton -> Text
[inlineQueryResultsButtonWebApp] :: InlineQueryResultsButton -> Maybe WebAppInfo
-- | Deep-linking parameter for the /start message sent to the bot
-- when a user presses the button. 1-64 characters, only A-Z,
-- a-z, 0-9, _ and - are allowed.
--
-- Example: An inline bot that sends YouTube videos can ask the user to
-- connect the bot to their YouTube account to adapt search results
-- accordingly. To do this, it displays a 'Connect your YouTube account'
-- button above the results, or even before showing any. The user presses
-- the button, switches to a private chat with the bot and, in doing so,
-- passes a start parameter that instructs the bot to return an OAuth
-- link. Once done, the bot can offer a switch_inline button so
-- that the user can easily return to the chat where they wanted to use
-- the bot's inline capabilities.
[inlineQueryResultsButtonStartParameter] :: InlineQueryResultsButton -> Maybe Text
defInlineQueryResultGenericThumbnail :: InlineQueryResultGeneric -> InlineQueryResultGenericThumbnail
defInlineQueryResultGeneric :: InlineQueryResultId -> InlineQueryResultGeneric
instance Data.Hashable.Class.Hashable Telegram.Bot.API.InlineMode.InlineQueryResult.InlineQueryResultId
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.InlineMode.InlineQueryResult.InlineQueryResultId
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.InlineMode.InlineQueryResult.InlineQueryResultId
instance GHC.Generics.Generic Telegram.Bot.API.InlineMode.InlineQueryResult.InlineQueryResultId
instance GHC.Show.Show Telegram.Bot.API.InlineMode.InlineQueryResult.InlineQueryResultId
instance GHC.Classes.Eq Telegram.Bot.API.InlineMode.InlineQueryResult.InlineQueryResultId
instance GHC.Show.Show Telegram.Bot.API.InlineMode.InlineQueryResult.InlineQueryResultGeneric
instance GHC.Generics.Generic Telegram.Bot.API.InlineMode.InlineQueryResult.InlineQueryResultGeneric
instance GHC.Show.Show Telegram.Bot.API.InlineMode.InlineQueryResult.InlineQueryResultGenericThumbnail
instance GHC.Generics.Generic Telegram.Bot.API.InlineMode.InlineQueryResult.InlineQueryResultGenericThumbnail
instance GHC.Show.Show Telegram.Bot.API.InlineMode.InlineQueryResult.InlineQueryResult
instance GHC.Generics.Generic Telegram.Bot.API.InlineMode.InlineQueryResult.InlineQueryResult
instance GHC.Generics.Generic Telegram.Bot.API.InlineMode.InlineQueryResult.InlineQueryResultsButton
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.InlineMode.InlineQueryResult.InlineQueryResultsButton
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.InlineMode.InlineQueryResult.InlineQueryResultsButton
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.InlineMode.InlineQueryResult.InlineQueryResult
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.InlineMode.InlineQueryResult.InlineQueryResult
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.InlineMode.InlineQueryResult.InlineQueryResultGenericThumbnail
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.InlineMode.InlineQueryResult.InlineQueryResultGenericThumbnail
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.InlineMode.InlineQueryResult.InlineQueryResultGeneric
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.InlineMode.InlineQueryResult.InlineQueryResultGeneric
module Telegram.Bot.API.InlineMode
-- | This object represents an incoming inline query. When the user sends
-- an empty query, your bot could return some default or trending
-- results.
--
-- https://core.telegram.org/bots/api#inline-mode
data InlineQuery
InlineQuery :: InlineQueryId -> User -> Maybe Location -> Text -> Text -> Maybe ChatType -> InlineQuery
-- | Unique query identifier
[inlineQueryId] :: InlineQuery -> InlineQueryId
-- | Sender
[inlineQueryFrom] :: InlineQuery -> User
-- | For bots that require user location, sender location
[inlineQueryLocation] :: InlineQuery -> Maybe Location
-- | Text of the query, up to 256 characters
[inlineQueryQuery] :: InlineQuery -> Text
-- | Offset of the results to be returned, can be controlled by bot
[inlineQueryOffset] :: InlineQuery -> Text
-- | Type of the chat, from which the inline query was sent. Can be either
-- “sender” for a private chat with the inline query sender, “private”,
-- “group”, “supergroup”, or “channel”. The chat type should be always
-- known for requests sent from official clients and most third-party
-- clients, unless the request was sent from a secret chat.
[inlineQueryChatType] :: InlineQuery -> Maybe ChatType
-- | Unique identifier for this query
newtype InlineQueryId
InlineQueryId :: Text -> InlineQueryId
type AnswerInlineQuery = "answerInlineQuery" :> ReqBody '[JSON] AnswerInlineQueryRequest :> Post '[JSON] (Response Bool)
answerInlineQuery :: AnswerInlineQueryRequest -> ClientM (Response Bool)
data AnswerInlineQueryRequest
AnswerInlineQueryRequest :: InlineQueryId -> [InlineQueryResult] -> Maybe Seconds -> Maybe Bool -> Maybe Text -> Maybe InlineQueryResultsButton -> AnswerInlineQueryRequest
-- | Unique identifier for the answered query.
[answerInlineQueryRequestInlineQueryId] :: AnswerInlineQueryRequest -> InlineQueryId
-- | A JSON-serialized array of results for the inline query.
[answerInlineQueryRequestResults] :: AnswerInlineQueryRequest -> [InlineQueryResult]
-- | The maximum amount of time in seconds that the result of the inline
-- query may be cached on the server. Defaults to 300.
[answerInlineQueryCacheTime] :: AnswerInlineQueryRequest -> Maybe Seconds
-- | Pass True, if results may be cached on the server side only for
-- the user that sent the query. By default, results may be returned to
-- any user who sends the same query.
[answerInlineQueryIsPersonal] :: AnswerInlineQueryRequest -> Maybe Bool
-- | Pass the offset that a client should send in the next query with the
-- same text to receive more results. Pass an empty string if there are
-- no more results or if you don't support pagination. Offset length
-- can't exceed 64 bytes.
[answerInlineQueryNextOffset] :: AnswerInlineQueryRequest -> Maybe Text
-- | A JSON-serialized object describing a button to be shown above inline
-- query results.
[answerInlineQueryButton] :: AnswerInlineQueryRequest -> Maybe InlineQueryResultsButton
data ChosenInlineResult
ChosenInlineResult :: InlineQueryResultId -> User -> Maybe Location -> Maybe MessageId -> InlineQueryId -> ChosenInlineResult
-- | The unique identifier for the result that was chosen.
[chosenInlineResultResultId] :: ChosenInlineResult -> InlineQueryResultId
-- | The user that chose the result.
[chosenInlineResultFrom] :: ChosenInlineResult -> User
-- | Sender location, only for bots that require user location.
[chosenInlineResultLocation] :: ChosenInlineResult -> Maybe Location
-- | Identifier of the sent inline message. Available only if there is an
-- inline keyboard attached to the message. Will be also received in
-- callback queries and can be used to edit the message.
[chosenInlineResultInlineMessageId] :: ChosenInlineResult -> Maybe MessageId
-- | The query that was used to obtain the result.
[chosenInlineResultQuery] :: ChosenInlineResult -> InlineQueryId
defAnswerInlineQuery :: InlineQueryId -> [InlineQueryResult] -> AnswerInlineQueryRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.InlineMode.InlineQuery
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.InlineMode.InlineQuery
instance GHC.Generics.Generic Telegram.Bot.API.InlineMode.InlineQueryId
instance Data.Hashable.Class.Hashable Telegram.Bot.API.InlineMode.InlineQueryId
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.InlineMode.InlineQueryId
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.InlineMode.InlineQueryId
instance GHC.Show.Show Telegram.Bot.API.InlineMode.InlineQueryId
instance GHC.Classes.Eq Telegram.Bot.API.InlineMode.InlineQueryId
instance GHC.Show.Show Telegram.Bot.API.InlineMode.InlineQuery
instance GHC.Generics.Generic Telegram.Bot.API.InlineMode.InlineQuery
instance GHC.Generics.Generic Telegram.Bot.API.InlineMode.AnswerInlineQueryRequest
instance GHC.Show.Show Telegram.Bot.API.InlineMode.ChosenInlineResult
instance GHC.Generics.Generic Telegram.Bot.API.InlineMode.ChosenInlineResult
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.InlineMode.ChosenInlineResult
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.InlineMode.ChosenInlineResult
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.InlineMode.AnswerInlineQueryRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.InlineMode.AnswerInlineQueryRequest
module Telegram.Bot.API.GettingUpdates
newtype UpdateId
UpdateId :: Int -> UpdateId
-- | This object represents an incoming update. At most one of the
-- optional parameters can be present in any given update.
data Update
Update :: UpdateId -> Maybe Message -> Maybe Message -> Maybe Message -> Maybe Message -> Maybe BusinessConnection -> Maybe Message -> Maybe Message -> Maybe BusinessMessagesDeleted -> Maybe MessageReactionUpdated -> Maybe MessageReactionCountUpdated -> Maybe InlineQuery -> Maybe ChosenInlineResult -> Maybe CallbackQuery -> Maybe ShippingQuery -> Maybe PreCheckoutQuery -> Maybe Poll -> Maybe PollAnswer -> Maybe ChatMemberUpdated -> Maybe ChatMemberUpdated -> Maybe ChatJoinRequest -> Maybe ChatBoostUpdated -> Maybe ChatBoostRemoved -> Update
-- | The update‘s unique identifier. Update identifiers start from a
-- certain positive number and increase sequentially. This ID becomes
-- especially handy if you’re using Webhooks, since it allows you to
-- ignore repeated updates or to restore the correct update sequence,
-- should they get out of order. If there are no new updates for at least
-- a week, then identifier of the next update will be chosen randomly
-- instead of sequentially.
[updateUpdateId] :: Update -> UpdateId
-- | New incoming message of any kind — text, photo, sticker, etc.
[updateMessage] :: Update -> Maybe Message
-- | New version of a message that is known to the bot and was edited
[updateEditedMessage] :: Update -> Maybe Message
-- | New incoming channel post of any kind — text, photo, sticker, etc.
[updateChannelPost] :: Update -> Maybe Message
-- | New version of a channel post that is known to the bot and was edited.
[updateEditedChannelPost] :: Update -> Maybe Message
-- | The bot was connected to or disconnected from a business account, or a
-- user edited an existing connection with the bot.
[updateBusinessConnection] :: Update -> Maybe BusinessConnection
-- | New message from a connected business account.
[updateBusinessMessage] :: Update -> Maybe Message
-- | New version of a message from a connected business account.
[updateEditedBusinessMessage] :: Update -> Maybe Message
-- | Messages were deleted from a connected business account.
[updateDeletedBusinessMessages] :: Update -> Maybe BusinessMessagesDeleted
-- | A reaction to a message was changed by a user. The bot must be an
-- administrator in the chat and must explicitly specify
-- message_reaction in the list of allowed_updates to
-- receive these updates. The update isn't received for reactions set by
-- bots.
[updateMessageReaction] :: Update -> Maybe MessageReactionUpdated
-- | Reactions to a message with anonymous reactions were changed. The bot
-- must be an administrator in the chat and must explicitly specify
-- message_reaction_count in the list of allowed_updates
-- to receive these updates. The updates are grouped and can be sent with
-- delay up to a few minutes.
[updateMessageReactionCount] :: Update -> Maybe MessageReactionCountUpdated
-- | New incoming inline query.
[updateInlineQuery] :: Update -> Maybe InlineQuery
-- | The result of an inline query that was chosen by a user and sent to
-- their chat partner. Please see our documentation on the feedback
-- collecting for details on how to enable these updates for your bot.
[updateChosenInlineResult] :: Update -> Maybe ChosenInlineResult
-- | New incoming callback query.
[updateCallbackQuery] :: Update -> Maybe CallbackQuery
-- | New incoming shipping query. Only for invoices with flexible price
[updateShippingQuery] :: Update -> Maybe ShippingQuery
-- | New incoming pre-checkout query. Contains full information about
-- checkout
[updatePreCheckoutQuery] :: Update -> Maybe PreCheckoutQuery
-- | New poll state. Bots receive only updates about stopped polls and
-- polls, which are sent by the bot.
[updatePoll] :: Update -> Maybe Poll
-- | A user changed their answer in a non-anonymous poll. Bots receive new
-- votes only in polls that were sent by the bot itself.
[updatePollAnswer] :: Update -> Maybe PollAnswer
-- | The bot's chat member status was updated in a chat. For private chats,
-- this update is received only when the bot is blocked or unblocked by
-- the user.
[updateMyChatMember] :: Update -> Maybe ChatMemberUpdated
-- | A chat member's status was updated in a chat. The bot must be an
-- administrator in the chat and must explicitly specify “chat_member” in
-- the list of allowed_updates to receive these updates.
[updateChatMember] :: Update -> Maybe ChatMemberUpdated
-- | A request to join the chat has been sent. The bot must have the
-- can_invite_users administrator right in the chat to receive these
-- updates.
[updateChatJoinRequest] :: Update -> Maybe ChatJoinRequest
-- | A chat boost was added or changed. The bot must be an administrator in
-- the chat to receive these updates.
[updateChatBoost] :: Update -> Maybe ChatBoostUpdated
-- | A boost was removed from a chat. The bot must be an administrator in
-- the chat to receive these updates.
[updateRemovedChatBoost] :: Update -> Maybe ChatBoostRemoved
updateChatId :: Update -> Maybe ChatId
extractUpdateMessage :: Update -> Maybe Message
type GetUpdatesAs a = "getUpdates" :> ReqBody '[JSON] GetUpdatesRequest :> Get '[JSON] (Response [a])
type GetUpdates = GetUpdatesAs Update
-- | Use this method to receive incoming updates using long polling. An
-- list of Update objects is returned.
--
-- NOTE: This method will not work if an outgoing webhook is set up.
--
-- NOTE: In order to avoid getting duplicate updates, recalculate offset
-- after each server response.
getUpdates :: GetUpdatesRequest -> ClientM (Response [Update])
-- | More liberal version of getUpdates funcion.
--
-- It's useful when you aren't sure that you can parse all the types of
-- updates, so you would recieve a list of Value with updates, that you
-- can parse later.
getUpdatesAsValue :: GetUpdatesRequest -> ClientM (Response [Value])
-- | Request parameters for getUpdates.
data GetUpdatesRequest
GetUpdatesRequest :: Maybe UpdateId -> Maybe Int -> Maybe Seconds -> Maybe [UpdateType] -> GetUpdatesRequest
-- | Identifier of the first update to be returned. Must be greater by one
-- than the highest among the identifiers of previously received updates.
-- By default, updates starting with the earliest unconfirmed update are
-- returned. An update is considered confirmed as soon as getUpdates is
-- called with an offset higher than its update_id. The negative offset
-- can be specified to retrieve updates starting from -offset update from
-- the end of the updates queue. All previous updates will forgotten.
[getUpdatesOffset] :: GetUpdatesRequest -> Maybe UpdateId
-- | Limits the number of updates to be retrieved. Values between 1—100 are
-- accepted. Defaults to 100.
[getUpdatesLimit] :: GetUpdatesRequest -> Maybe Int
-- | Timeout in seconds for long polling. Defaults to 0, i.e. usual short
-- polling. Should be positive, short polling should be used for testing
-- purposes only.
[getUpdatesTimeout] :: GetUpdatesRequest -> Maybe Seconds
-- | List the types of updates you want your bot to receive. For example,
-- specify [“message”, “edited_channel_post”, “callback_query”] to only
-- receive updates of these types. See GetUpdates for a complete list of
-- available update types. Specify an empty list to receive all updates
-- regardless of type (default). If not specified, the previous setting
-- will be used. Please note that this parameter doesn't affect updates
-- created before the call to the getUpdates, so unwanted updates may be
-- received for a short period of time.
[getUpdatesAllowedUpdates] :: GetUpdatesRequest -> Maybe [UpdateType]
data UpdateType
UpdateMessage :: UpdateType
UpdateEditedMessage :: UpdateType
UpdateChannelPost :: UpdateType
UpdateEditedChannelPost :: UpdateType
UpdateBusinessConnection :: UpdateType
UpdateBusinessMessage :: UpdateType
UpdateEditedBusinessMessage :: UpdateType
UpdateDeletedBusinessMessages :: UpdateType
UpdateMessageReaction :: UpdateType
UpdateMessageReactionCount :: UpdateType
UpdateInlineQuery :: UpdateType
UpdateChosenInlineResult :: UpdateType
UpdateCallbackQuery :: UpdateType
UpdateShippingQuery :: UpdateType
UpdatePreCheckoutQuery :: UpdateType
UpdatePoll :: UpdateType
UpdatePollAnswer :: UpdateType
UpdateMyChatMember :: UpdateType
UpdateChatMember :: UpdateType
UpdateChatJoinRequest :: UpdateType
UpdateChatBoost :: UpdateType
UpdateRemovedChatBoost :: UpdateType
defGetUpdates :: GetUpdatesRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.GettingUpdates.UpdateId
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.GettingUpdates.UpdateId
instance GHC.Show.Show Telegram.Bot.API.GettingUpdates.UpdateId
instance GHC.Classes.Ord Telegram.Bot.API.GettingUpdates.UpdateId
instance GHC.Classes.Eq Telegram.Bot.API.GettingUpdates.UpdateId
instance GHC.Show.Show Telegram.Bot.API.GettingUpdates.Update
instance GHC.Generics.Generic Telegram.Bot.API.GettingUpdates.Update
instance GHC.Generics.Generic Telegram.Bot.API.GettingUpdates.UpdateType
instance GHC.Generics.Generic Telegram.Bot.API.GettingUpdates.GetUpdatesRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.GettingUpdates.GetUpdatesRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.GettingUpdates.GetUpdatesRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.GettingUpdates.UpdateType
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.GettingUpdates.UpdateType
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.GettingUpdates.Update
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.GettingUpdates.Update
module Telegram.Bot.API.Games
data SendGameRequest
SendGameRequest :: Maybe BusinessConnectionId -> ChatId -> Maybe MessageThreadId -> Text -> Maybe Bool -> Maybe Bool -> Maybe MessageId -> Maybe ReplyParameters -> Maybe InlineKeyboardMarkup -> SendGameRequest
-- | Unique identifier of the business connection on behalf of which the
-- message will be sent.
[sendGameBusinessConnectionId] :: SendGameRequest -> Maybe BusinessConnectionId
-- | Unique identifier for the target chat.
[sendGameChatId] :: SendGameRequest -> ChatId
-- | Unique identifier for the target message thread (topic) of the forum;
-- for forum supergroups only.
[sendGameMessageThreadId] :: SendGameRequest -> Maybe MessageThreadId
-- | Short name of the game, serves as the unique identifier for the game.
-- Set up your games via Botfather.
[sendGameGameShortName] :: SendGameRequest -> Text
-- | Sends the message silently. Users will receive a notification with no
-- sound.
[sendGameDisableNotification] :: SendGameRequest -> Maybe Bool
-- | Protects the contents of the sent message from forwarding and saving.
[sendGameProtectContent] :: SendGameRequest -> Maybe Bool
-- | If the message is a reply, ID of the original message.
[sendGameReplyToMessageId] :: SendGameRequest -> Maybe MessageId
-- | Description of the message to reply to.
[sendGameReplyParameters] :: SendGameRequest -> Maybe ReplyParameters
-- | A JSON-serialized object for an inline keyboard. If empty, one 'Play
-- game_title' button will be shown. If not empty, the first button must
-- launch the game.
[sendGameReplyMarkup] :: SendGameRequest -> Maybe InlineKeyboardMarkup
data SetGameScoreRequest
SetGameScoreRequest :: UserId -> Integer -> Maybe Bool -> Maybe Bool -> Maybe ChatId -> Maybe MessageId -> Maybe MessageId -> SetGameScoreRequest
-- | User identifier.
[setGameScoreUserId] :: SetGameScoreRequest -> UserId
-- | New score, must be non-negative.
[setGameScoreScore] :: SetGameScoreRequest -> Integer
-- | Pass True, if the high score is allowed to decrease. This can
-- be useful when fixing mistakes or banning cheaters.
[setGameScoreForce] :: SetGameScoreRequest -> Maybe Bool
-- | Pass True, if the game message should not be automatically
-- edited to include the current scoreboard.
[setGameScoreDisableEditMessage] :: SetGameScoreRequest -> Maybe Bool
-- | Required if inline_message_id is not specified. Unique
-- identifier for the target chat
[setGameScoreChatId] :: SetGameScoreRequest -> Maybe ChatId
-- | Required if inline_message_id is not specified. Identifier of
-- the sent message.
[setGameScoreMessageId] :: SetGameScoreRequest -> Maybe MessageId
-- | Required if chat_id and message_id are not
-- specified. Identifier of the inline message.
[setGameScoreInlineMessageId] :: SetGameScoreRequest -> Maybe MessageId
data SetGameScoreResult
SetGameScoreMessage :: Message -> SetGameScoreResult
SetGameScoreMessageBool :: Bool -> SetGameScoreResult
data GetGameHighScoresRequest
GetGameHighScoresRequest :: UserId -> Maybe ChatId -> Maybe MessageId -> Maybe MessageId -> GetGameHighScoresRequest
-- | Target user id.
[getGameHighScoresUserId] :: GetGameHighScoresRequest -> UserId
-- | Required if inline_message_id is not specified. Unique
-- identifier for the target chat.
[getGameHighScoresChatId] :: GetGameHighScoresRequest -> Maybe ChatId
-- | Required if inline_message_id is not specified. Identifier of
-- the sent message.
[getGameHighScoresMessageId] :: GetGameHighScoresRequest -> Maybe MessageId
-- | Required if chat_id and message_id are not
-- specified. Identifier of the inline message.
[getGameHighScoresInlineMessageId] :: GetGameHighScoresRequest -> Maybe MessageId
type SendGame = "sendGame" :> ReqBody '[JSON] SendGameRequest :> Post '[JSON] (Response Message)
-- | Use this method to send a game. On success, the sent Message is
-- returned.
sendGame :: SendGameRequest -> ClientM (Response Message)
type SetGameScore = "setGameScore" :> ReqBody '[JSON] SetGameScoreRequest :> Post '[JSON] (Response SetGameScoreResult)
-- | Use this method to set the score of the specified user in a game
-- message. On success, if the message is not an inline message, the
-- Message is returned, otherwise True is returned. Returns an
-- error, if the new score is not greater than the user's current score
-- in the chat and force is False.
setGameScore :: SetGameScoreRequest -> ClientM (Response SetGameScoreResult)
type GetGameHighScores = "getGameHighScores" :> ReqBody '[JSON] GetGameHighScoresRequest :> Post '[JSON] (Response [GameHighScore])
defGetGameHighScores :: UserId -> GetGameHighScoresRequest
defSetGameScore :: UserId -> Integer -> SetGameScoreRequest
defSendGame :: ChatId -> Text -> SendGameRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Games.SendGameRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Games.SendGameRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Games.SetGameScoreRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Games.SetGameScoreRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Games.SetGameScoreResult
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.Games.SetGameScoreResult
instance GHC.Show.Show Telegram.Bot.API.Games.SendGameRequest
instance GHC.Generics.Generic Telegram.Bot.API.Games.SendGameRequest
instance GHC.Show.Show Telegram.Bot.API.Games.SetGameScoreRequest
instance GHC.Generics.Generic Telegram.Bot.API.Games.SetGameScoreRequest
instance GHC.Show.Show Telegram.Bot.API.Games.SetGameScoreResult
instance GHC.Generics.Generic Telegram.Bot.API.Games.SetGameScoreResult
instance GHC.Show.Show Telegram.Bot.API.Games.GetGameHighScoresRequest
instance GHC.Generics.Generic Telegram.Bot.API.Games.GetGameHighScoresRequest
module Telegram.Bot.API.Forum
type GetForumTopicIconStickers = "getForumTopicIconStickers" :> Post '[JSON] (Response [Sticker])
-- | Use this method to get custom emoji stickers, which can be used as a
-- forum topic icon by any user. Requires no parameters. Returns an
-- '[Sticker]' objects.
getForumTopicIconStickers :: ClientM (Response [Sticker])
data CreateForumTopicRequest
CreateForumTopicRequest :: SomeChatId -> Text -> Maybe Integer -> Maybe Text -> CreateForumTopicRequest
-- | Unique identifier for the target chat or username of the target
-- supergroup (in the format @supergroupusername).
[createForumTopicRequestChatId] :: CreateForumTopicRequest -> SomeChatId
-- | Topic name, 1-128 characters.
[createForumTopicName] :: CreateForumTopicRequest -> Text
-- | Color of the topic icon in RGB format. Currently, must be one of
-- 7322096 (0x6FB9F0), 16766590 (0xFFD67E), 13338331 (0xCB86DB),
-- 9367192 (0x8EEE98), 16749490 (0xFF93B2), or 16478047 (0xFB6F5F).
[createForumTopicIconColor] :: CreateForumTopicRequest -> Maybe Integer
-- | Unique identifier of the custom emoji shown as the topic icon. Use
-- getForumTopicIconStickers to get all allowed custom emoji
-- identifiers.
[createForumTopicIconCustomEmojiId] :: CreateForumTopicRequest -> Maybe Text
type CreateForumTopic = "createForumTopic" :> ReqBody '[JSON] CreateForumTopicRequest :> Post '[JSON] (Response ForumTopic)
-- | Use this method to create a topic in a forum supergroup chat. The bot
-- must be an administrator in the chat for this to work and must have
-- the can_manage_topics administrator rights. Returns
-- information about the created topic as a ForumTopic object.
createForumTopic :: CreateForumTopicRequest -> ClientM (Response ForumTopic)
data EditForumTopicRequest
EditForumTopicRequest :: SomeChatId -> MessageThreadId -> Maybe Text -> Maybe Text -> EditForumTopicRequest
-- | Unique identifier for the target chat or username of the target
-- supergroup (in the format @supergroupusername).
[editForumTopicChatId] :: EditForumTopicRequest -> SomeChatId
-- | Unique identifier for the target message thread of the forum topic.
[editForumTopicMessageThreadId] :: EditForumTopicRequest -> MessageThreadId
-- | New topic name, 0-128 characters. If not specified or empty, the
-- current name of the topic will be kept.
[editForumTopicName] :: EditForumTopicRequest -> Maybe Text
-- | New unique identifier of the custom emoji shown as the topic icon. Use
-- getForumTopicIconStickers to get all allowed custom emoji
-- identifiers. Pass an empty string to remove the icon. If not
-- specified, the current icon will be kept.
[editForumTopicIconCustomEmojiId] :: EditForumTopicRequest -> Maybe Text
type EditForumTopic = "editForumTopic" :> ReqBody '[JSON] EditForumTopicRequest :> Post '[JSON] (Response Bool)
-- | Use this method to edit name and icon of a topic in a forum supergroup
-- chat. The bot must be an administrator in the chat for this to work
-- and must have can_manage_topics administrator rights, unless
-- it is the creator of the topic. Returns True on success.
editForumTopic :: EditForumTopicRequest -> ClientM (Response Bool)
data CloseForumTopicRequest
CloseForumTopicRequest :: SomeChatId -> MessageThreadId -> CloseForumTopicRequest
-- | Unique identifier for the target chat or username of the target
-- supergroup (in the format @supergroupusername).
[closeForumTopicChatId] :: CloseForumTopicRequest -> SomeChatId
-- | Unique identifier for the target message thread of the forum topic.
[closeForumTopicMessageThreadId] :: CloseForumTopicRequest -> MessageThreadId
type CloseForumTopic = "closeForumTopic" :> ReqBody '[JSON] CloseForumTopicRequest :> Post '[JSON] (Response Bool)
-- | Use this method to close an open topic in a forum supergroup chat. The
-- bot must be an administrator in the chat for this to work and must
-- have the can_manage_topics administrator rights, unless it is
-- the creator of the topic. Returns True on success.
closeForumTopic :: CloseForumTopicRequest -> ClientM (Response Bool)
data ReopenForumTopicRequest
ReopenForumTopicRequest :: SomeChatId -> MessageThreadId -> ReopenForumTopicRequest
-- | Unique identifier for the target chat or username of the target
-- supergroup (in the format @supergroupusername).
[reopenForumTopicChatId] :: ReopenForumTopicRequest -> SomeChatId
-- | Unique identifier for the target message thread of the forum topic.
[reopenForumTopicMessageThreadId] :: ReopenForumTopicRequest -> MessageThreadId
type ReopenForumTopic = "reopenForumTopic" :> ReqBody '[JSON] ReopenForumTopicRequest :> Post '[JSON] (Response Bool)
-- | Use this method to reopen a closed topic in a forum supergroup chat.
-- The bot must be an administrator in the chat for this to work and must
-- have the can_manage_topics administrator rights, unless it is
-- the creator of the topic. Returns True on success.
reopenForumTopic :: ReopenForumTopicRequest -> ClientM (Response Bool)
data DeleteForumTopicRequest
DeleteForumTopicRequest :: SomeChatId -> MessageThreadId -> DeleteForumTopicRequest
-- | Unique identifier for the target chat or username of the target
-- supergroup (in the format @supergroupusername).
[deleteForumTopicChatId] :: DeleteForumTopicRequest -> SomeChatId
-- | Unique identifier for the target message thread of the forum topic.
[deleteForumTopicMessageThreadId] :: DeleteForumTopicRequest -> MessageThreadId
type DeleteForumTopic = "deleteForumTopic" :> ReqBody '[JSON] DeleteForumTopicRequest :> Post '[JSON] (Response Bool)
-- | Use this method to delete a forum topic along with all its messages in
-- a forum supergroup chat. The bot must be an administrator in the chat
-- for this to work and must have the can_delete_messages
-- administrator rights. Returns True on success.
deleteForumTopic :: DeleteForumTopicRequest -> ClientM (Response Bool)
data UnpinAllForumTopicMessagesRequest
UnpinAllForumTopicMessagesRequest :: SomeChatId -> MessageThreadId -> UnpinAllForumTopicMessagesRequest
-- | Unique identifier for the target chat or username of the target
-- supergroup (in the format @supergroupusername)
[unpinAllForumTopicMessagesChatId] :: UnpinAllForumTopicMessagesRequest -> SomeChatId
-- | Unique identifier for the target message thread of the forum topic.
[unpinAllForumTopicMessagesMessageThreadId] :: UnpinAllForumTopicMessagesRequest -> MessageThreadId
type UnpinAllForumTopicMessages = "unpinAllForumTopicMessages" :> ReqBody '[JSON] UnpinAllForumTopicMessagesRequest :> Post '[JSON] (Response Bool)
-- | Use this method to clear the list of pinned messages in a forum topic.
-- The bot must be an administrator in the chat for this to work and must
-- have the can_pin_messages administrator right in the
-- supergroup. Returns True on success.
unpinAllForumTopicMessages :: UnpinAllForumTopicMessagesRequest -> ClientM (Response Bool)
type UnpinAllGeneralForumTopicMessages = "unpinAllGeneralForumTopicMessages" :> RequiredQueryParam "chat_id" SomeChatId :> Post '[JSON] (Response Bool)
-- | Use this method to clear the list of pinned messages in a
-- General forum topic. The bot must be an administrator in the
-- chat for this to work and must have the can_pin_messages
-- administrator right in the supergroup. Returns True on success.
unpinAllGeneralForumTopicMessages :: SomeChatId -> ClientM (Response Bool)
data EditGeneralForumTopicRequest
EditGeneralForumTopicRequest :: SomeChatId -> Text -> EditGeneralForumTopicRequest
-- | Unique identifier for the target chat or username of the target
-- supergroup (in the format @supergroupusername).
[editGeneralForumTopicChatId] :: EditGeneralForumTopicRequest -> SomeChatId
-- | New topic name, 1-128 characters.
[editGeneralForumTopicName] :: EditGeneralForumTopicRequest -> Text
type EditGeneralForumTopic = "editGeneralForumTopic" :> ReqBody '[JSON] EditGeneralForumTopicRequest :> Post '[JSON] (Response Bool)
-- | Use this method to edit the name of the General topic in a
-- forum supergroup chat. The bot must be an administrator in the chat
-- for this to work and must have can_manage_topics
-- administrator rights. Returns True on success.
editGeneralForumTopic :: EditGeneralForumTopicRequest -> ClientM (Response Bool)
data CloseGeneralForumTopicRequest
CloseGeneralForumTopicRequest :: SomeChatId -> CloseGeneralForumTopicRequest
-- | Unique identifier for the target chat or username of the target
-- supergroup (in the format @supergroupusername).
[closeGeneralForumTopicChatId] :: CloseGeneralForumTopicRequest -> SomeChatId
type CloseGeneralForumTopic = "closeGeneralForumTopic" :> ReqBody '[JSON] CloseGeneralForumTopicRequest :> Post '[JSON] (Response Bool)
-- | Use this method to close an open General topic in a forum
-- supergroup chat. The bot must be an administrator in the chat for this
-- to work and must have the can_manage_topics administrator
-- rights. Returns True on success.
closeGeneralForumTopic :: CloseGeneralForumTopicRequest -> ClientM (Response Bool)
data ReopenGeneralForumTopicRequest
ReopenGeneralForumTopicRequest :: SomeChatId -> ReopenGeneralForumTopicRequest
-- | Unique identifier for the target chat or username of the target
-- supergroup (in the format @supergroupusername).
[reopenGeneralForumTopicRequestChatId] :: ReopenGeneralForumTopicRequest -> SomeChatId
type ReopenGeneralForumTopic = "reopenGeneralForumTopic" :> ReqBody '[JSON] ReopenGeneralForumTopicRequest :> Post '[JSON] (Response Bool)
-- | Use this method to reopen a closed General topic in a forum
-- supergroup chat. The bot must be an administrator in the chat for this
-- to work and must have the can_manage_topics administrator
-- rights. The topic will be automatically unhidden if it was hidden.
-- Returns True on success.
reopenGeneralForumTopic :: ReopenGeneralForumTopicRequest -> ClientM (Response Bool)
data HideGeneralForumTopicRequest
HideGeneralForumTopicRequest :: SomeChatId -> HideGeneralForumTopicRequest
-- | Unique identifier for the target chat or username of the target
-- supergroup (in the format @supergroupusername).
[hideGeneralForumTopicChatId] :: HideGeneralForumTopicRequest -> SomeChatId
type HideGeneralForumTopic = "hideGeneralForumTopic" :> ReqBody '[JSON] HideGeneralForumTopicRequest :> Post '[JSON] (Response Bool)
-- | Use this method to hide the General topic in a forum
-- supergroup chat. The bot must be an administrator in the chat for this
-- to work and must have the can_manage_topics administrator
-- rights. The topic will be automatically closed if it was open. Returns
-- True on success.
hideGeneralForumTopic :: HideGeneralForumTopicRequest -> ClientM (Response Bool)
data UnhideGeneralForumTopicRequest
UnhideGeneralForumTopicRequest :: SomeChatId -> UnhideGeneralForumTopicRequest
-- | Unique identifier for the target chat or username of the target
-- supergroup (in the format @supergroupusername)
[unhideGeneralForumTopicChatId] :: UnhideGeneralForumTopicRequest -> SomeChatId
type UnhideGeneralForumTopic = "unhideGeneralForumTopic" :> ReqBody '[JSON] UnhideGeneralForumTopicRequest :> Post '[JSON] (Response Bool)
-- | Use this method to unhide the General topic in a forum
-- supergroup chat. The bot must be an administrator in the chat for this
-- to work and must have the can_manage_topics administrator
-- rights. Returns True on success.
unhideGeneralForumTopic :: UnhideGeneralForumTopicRequest -> ClientM (Response Bool)
defCreateForumTopic :: SomeChatId -> Text -> CreateForumTopicRequest
defEditForumTopic :: SomeChatId -> MessageThreadId -> EditForumTopicRequest
defCloseForumTopic :: SomeChatId -> MessageThreadId -> CloseForumTopicRequest
defReopenForumTopic :: SomeChatId -> MessageThreadId -> ReopenForumTopicRequest
defDeleteForumTopic :: SomeChatId -> MessageThreadId -> DeleteForumTopicRequest
defUnpinAllForumTopicMessages :: SomeChatId -> MessageThreadId -> UnpinAllForumTopicMessagesRequest
defEditGeneralForumTopic :: SomeChatId -> Text -> EditGeneralForumTopicRequest
defCloseGeneralForumTopic :: SomeChatId -> CloseGeneralForumTopicRequest
defReopenGeneralForumTopic :: SomeChatId -> ReopenGeneralForumTopicRequest
defHideGeneralForumTopic :: SomeChatId -> HideGeneralForumTopicRequest
defUnhideGeneralForumTopic :: SomeChatId -> UnhideGeneralForumTopicRequest
instance GHC.Generics.Generic Telegram.Bot.API.Forum.CreateForumTopicRequest
instance GHC.Generics.Generic Telegram.Bot.API.Forum.EditForumTopicRequest
instance GHC.Generics.Generic Telegram.Bot.API.Forum.CloseForumTopicRequest
instance GHC.Generics.Generic Telegram.Bot.API.Forum.ReopenForumTopicRequest
instance GHC.Generics.Generic Telegram.Bot.API.Forum.DeleteForumTopicRequest
instance GHC.Generics.Generic Telegram.Bot.API.Forum.UnpinAllForumTopicMessagesRequest
instance GHC.Generics.Generic Telegram.Bot.API.Forum.EditGeneralForumTopicRequest
instance GHC.Generics.Generic Telegram.Bot.API.Forum.CloseGeneralForumTopicRequest
instance GHC.Generics.Generic Telegram.Bot.API.Forum.ReopenGeneralForumTopicRequest
instance GHC.Generics.Generic Telegram.Bot.API.Forum.HideGeneralForumTopicRequest
instance GHC.Generics.Generic Telegram.Bot.API.Forum.UnhideGeneralForumTopicRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Forum.UnhideGeneralForumTopicRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Forum.HideGeneralForumTopicRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Forum.ReopenGeneralForumTopicRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Forum.CloseGeneralForumTopicRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Forum.EditGeneralForumTopicRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Forum.UnpinAllForumTopicMessagesRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Forum.DeleteForumTopicRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Forum.ReopenForumTopicRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Forum.CloseForumTopicRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Forum.EditForumTopicRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Forum.CreateForumTopicRequest
module Telegram.Bot.API.Chat
type KickChatMember = "kickChatMember" :> RequiredQueryParam "chat_id" ChatId :> RequiredQueryParam "user_id" UserId :> Get '[JSON] (Response Bool)
-- | Use this method to kick user from chat. On success, the sent Bool is
-- returned.
kickChatMember :: ChatId -> UserId -> ClientM (Response Bool)
module Telegram.Bot.API.WebApps
data AnswerWebAppQueryRequest
AnswerWebAppQueryRequest :: Text -> InlineQueryResult -> AnswerWebAppQueryRequest
-- | Unique identifier for the query to be answered.
[answerWebAppQueryWebAppQueryId] :: AnswerWebAppQueryRequest -> Text
-- | A JSON-serialized object describing the message to be sent.
[answerWebAppQueryResult] :: AnswerWebAppQueryRequest -> InlineQueryResult
-- | Contains information about an inline message sent by a Web App on
-- behalf of a user.
newtype SentWebAppMessage
SentWebAppMessage :: Maybe InlineQueryId -> SentWebAppMessage
[sentWebAppMessageInlineMessageId] :: SentWebAppMessage -> Maybe InlineQueryId
type AnswerWebAppQuery = "answerWebAppQuery" :> ReqBody '[JSON] AnswerWebAppQueryRequest :> Post '[JSON] (Response SentWebAppMessage)
-- | Use this method to set the result of an interaction with a Web App and
-- send a corresponding message on behalf of the user to the chat from
-- which the query originated.
--
-- On success, a SentWebAppMessage object is returned.
answerWebAppQuery :: AnswerWebAppQueryRequest -> ClientM (Response SentWebAppMessage)
defAnswerWebAppQuery :: Text -> InlineQueryResult -> AnswerWebAppQueryRequest
defSentWebAppMessage :: SentWebAppMessage
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.WebApps.SentWebAppMessage
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.WebApps.SentWebAppMessage
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.WebApps.AnswerWebAppQueryRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.WebApps.AnswerWebAppQueryRequest
instance GHC.Show.Show Telegram.Bot.API.WebApps.AnswerWebAppQueryRequest
instance GHC.Generics.Generic Telegram.Bot.API.WebApps.AnswerWebAppQueryRequest
instance GHC.Show.Show Telegram.Bot.API.WebApps.SentWebAppMessage
instance GHC.Generics.Generic Telegram.Bot.API.WebApps.SentWebAppMessage
module Telegram.Bot.API.Methods
module Telegram.Bot.API.UpdatingMessages
data EditMessageResponse
EditedInlineMessage :: Bool -> EditMessageResponse
EditedMessage :: Message -> EditMessageResponse
-- | Request parameters for editMessageText.
data EditMessageTextRequest
EditMessageTextRequest :: Maybe SomeChatId -> Maybe MessageId -> Maybe MessageId -> Text -> Maybe ParseMode -> Maybe [MessageEntity] -> Maybe LinkPreviewOptions -> Maybe SomeReplyMarkup -> EditMessageTextRequest
-- | Required if editMessageTextInlineMessageId is not specified.
-- Unique identifier for the target chat or username of the target
-- channel (in the format @channelusername).
[editMessageTextChatId] :: EditMessageTextRequest -> Maybe SomeChatId
-- | Required if editMessageTextInlineMessageId is not specified.
-- Identifier of the sent message.
[editMessageTextMessageId] :: EditMessageTextRequest -> Maybe MessageId
-- | Required if editMessageTextChatId and
-- editMessageTextMessageId are not specified. Identifier of the
-- sent message.
[editMessageTextInlineMessageId] :: EditMessageTextRequest -> Maybe MessageId
-- | Text of the message to be sent.
[editMessageTextText] :: EditMessageTextRequest -> Text
-- | Send MarkdownV2, HTML or Markdown (legacy), if
-- you want Telegram apps to show bold, italic, fixed-width text or
-- inline URLs in your bot's message.
[editMessageTextParseMode] :: EditMessageTextRequest -> Maybe ParseMode
-- | A JSON-serialized list of special entities that appear in message
-- text, which can be specified instead of parse_mode.
[editMessageEntities] :: EditMessageTextRequest -> Maybe [MessageEntity]
-- | Link preview generation options for the message.
[editMessageTextLinkPreviewOptions] :: EditMessageTextRequest -> Maybe LinkPreviewOptions
-- | Additional interface options. A JSON-serialized object for an inline
-- keyboard, custom reply keyboard, instructions to remove reply keyboard
-- or to force a reply from the user.
[editMessageTextReplyMarkup] :: EditMessageTextRequest -> Maybe SomeReplyMarkup
-- | Request parameters for editMessageCaption.
data EditMessageCaptionRequest
EditMessageCaptionRequest :: Maybe SomeChatId -> Maybe MessageId -> Maybe MessageId -> Maybe Text -> Maybe ParseMode -> Maybe [MessageEntity] -> Maybe SomeReplyMarkup -> EditMessageCaptionRequest
-- | Required if editMessageCaptionMessageId is not specified.
-- Unique identifier for the target chat or username of the target
-- channel (in the format @channelusername).
[editMessageCaptionChatId] :: EditMessageCaptionRequest -> Maybe SomeChatId
-- | Required if editMessageCaptionInlineMessageId is not specified.
-- Identifier of the sent message.
[editMessageCaptionMessageId] :: EditMessageCaptionRequest -> Maybe MessageId
-- | Required if editMessageCaptionChatId and
-- editMessageCaptionMessageId are not specified. Identifier of
-- the sent message.
[editMessageCaptionInlineMessageId] :: EditMessageCaptionRequest -> Maybe MessageId
-- | New caption of the message, 0-1024 characters after entities parsing
[editMessageCaptionCaption] :: EditMessageCaptionRequest -> Maybe Text
-- | Mode for parsing entities in the message caption. See formatting
-- options for more details.
[editMessageCaptionParseMode] :: EditMessageCaptionRequest -> Maybe ParseMode
-- | A JSON-serialized list of special entities that appear in the caption,
-- which can be specified instead of parse_mode
[editMessageCaptionCaptionEntities] :: EditMessageCaptionRequest -> Maybe [MessageEntity]
-- | Additional interface options. A JSON-serialized object for an inline
-- keyboard, custom reply keyboard, instructions to remove reply keyboard
-- or to force a reply from the user.
[editMessageCaptionReplyMarkup] :: EditMessageCaptionRequest -> Maybe SomeReplyMarkup
-- | Request parameters for editMessageMedia.
data EditMessageMediaRequest
EditMessageMediaRequest :: Maybe SomeChatId -> Maybe MessageId -> Maybe MessageId -> InputMedia -> Maybe SomeReplyMarkup -> EditMessageMediaRequest
-- | Required if editMessageMediaMessageId is not specified. Unique
-- identifier for the target chat or username of the target channel (in
-- the format @channelusername).
[editMessageMediaChatId] :: EditMessageMediaRequest -> Maybe SomeChatId
-- | Required if editMessageMediaInlineMessageId is not specified.
-- Identifier of the sent message.
[editMessageMediaMessageId] :: EditMessageMediaRequest -> Maybe MessageId
-- | Required if editMessageMediaChatId and
-- editMessageMediaMessageId are not specified. Identifier of the
-- sent message.
[editMessageMediaInlineMessageId] :: EditMessageMediaRequest -> Maybe MessageId
-- | A JSON-serialized object for a new media content of the message
[editMessageMediaMedia] :: EditMessageMediaRequest -> InputMedia
-- | Additional interface options. A JSON-serialized object for an inline
-- keyboard, custom reply keyboard, instructions to remove reply keyboard
-- or to force a reply from the user.
[editMessageMediaReplyMarkup] :: EditMessageMediaRequest -> Maybe SomeReplyMarkup
-- | Request parameters for editMessageReplyMarkup.
data EditMessageReplyMarkupRequest
EditMessageReplyMarkupRequest :: Maybe SomeChatId -> Maybe MessageId -> Maybe MessageId -> Maybe SomeReplyMarkup -> EditMessageReplyMarkupRequest
-- | Required if editMessageReplyMarkupMessageId is not specified.
-- Unique identifier for the target chat or username of the target
-- channel (in the format @channelusername).
[editMessageReplyMarkupChatId] :: EditMessageReplyMarkupRequest -> Maybe SomeChatId
-- | Required if editMessageReplyMarkupInlineMessageId is not
-- specified. Identifier of the sent message.
[editMessageReplyMarkupMessageId] :: EditMessageReplyMarkupRequest -> Maybe MessageId
-- | Required if editMessageReplyMarkupChatId and
-- editMessageReplyMarkupMessageId are not specified. Identifier
-- of the sent message.
[editMessageReplyMarkupInlineMessageId] :: EditMessageReplyMarkupRequest -> Maybe MessageId
-- | Additional interface options. A JSON-serialized object for an inline
-- keyboard, custom reply keyboard, instructions to remove reply keyboard
-- or to force a reply from the user.
[editMessageReplyMarkupReplyMarkup] :: EditMessageReplyMarkupRequest -> Maybe SomeReplyMarkup
-- | Request parameters for stopPoll.
data StopPollRequest
StopPollRequest :: SomeChatId -> MessageId -> Maybe SomeReplyMarkup -> StopPollRequest
-- | Unique identifier for the target chat or username of the target
-- channel (in the format @channelusername)
[stopPollChatId] :: StopPollRequest -> SomeChatId
-- | Identifier of the original message with the poll
[stopPollMessageId] :: StopPollRequest -> MessageId
-- | A JSON-serialized object for a new message inline keyboard.
[stopPollReplyMarkup] :: StopPollRequest -> Maybe SomeReplyMarkup
type EditMessageText = "editMessageText" :> ReqBody '[JSON] EditMessageTextRequest :> Post '[JSON] (Response EditMessageResponse)
-- | Use this method to edit text and game messages. On success, if the
-- edited message is not an inline message, the edited Message is
-- returned, otherwise True is returned.
editMessageText :: EditMessageTextRequest -> ClientM (Response EditMessageResponse)
type EditMessageCaption = "editMessageCaption" :> ReqBody '[JSON] EditMessageCaptionRequest :> Post '[JSON] (Response EditMessageResponse)
-- | Use this method to edit captions of messages. On success, if the
-- edited message is not an inline message, the edited Message is
-- returned, otherwise True is returned.
editMessageCaption :: EditMessageCaptionRequest -> ClientM (Response EditMessageResponse)
type EditMessageMedia = "editMessageMedia" :> ReqBody '[JSON] EditMessageMediaRequest :> Post '[JSON] (Response EditMessageResponse)
-- | Use this method to edit animation, audio, document, photo, or video
-- messages. If a message is part of a message album, then it can be
-- edited only to an audio for audio albums, only to a document for
-- document albums and to a photo or a video otherwise. When an inline
-- message is edited, a new file can't be uploaded; use a previously
-- uploaded file via its file_id or specify a URL. On success, if the
-- edited message is not an inline message, the edited Message is
-- returned, otherwise True is returned.
editMessageMedia :: EditMessageMediaRequest -> ClientM (Response EditMessageResponse)
type EditMessageReplyMarkup = "editMessageReplyMarkup" :> ReqBody '[JSON] EditMessageReplyMarkupRequest :> Post '[JSON] (Response EditMessageResponse)
-- | Use this method to edit only the reply markup of messages. On success,
-- if the edited message is not an inline message, the edited Message is
-- returned, otherwise True is returned.
editMessageReplyMarkup :: EditMessageReplyMarkupRequest -> ClientM (Response EditMessageResponse)
type StopPoll = "stopPoll" :> ReqBody '[JSON] StopPollRequest :> Post '[JSON] (Response Poll)
-- | Use this method to stop a poll which was sent by the bot. On success,
-- the stopped Poll is returned.
stopPoll :: StopPollRequest -> ClientM (Response Poll)
defStopPoll :: SomeChatId -> MessageId -> StopPollRequest
defEditMessageReplyMarkup :: EditMessageReplyMarkupRequest
defEditMessageCaption :: EditMessageCaptionRequest
defEditMessageText :: Text -> EditMessageTextRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.UpdatingMessages.EditMessageTextRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.UpdatingMessages.EditMessageTextRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.UpdatingMessages.EditMessageCaptionRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.UpdatingMessages.EditMessageCaptionRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.UpdatingMessages.EditMessageReplyMarkupRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.UpdatingMessages.EditMessageReplyMarkupRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.UpdatingMessages.StopPollRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.UpdatingMessages.StopPollRequest
instance GHC.Generics.Generic Telegram.Bot.API.UpdatingMessages.EditMessageResponse
instance GHC.Show.Show Telegram.Bot.API.UpdatingMessages.EditMessageResponse
instance GHC.Generics.Generic Telegram.Bot.API.UpdatingMessages.EditMessageTextRequest
instance GHC.Generics.Generic Telegram.Bot.API.UpdatingMessages.EditMessageCaptionRequest
instance GHC.Generics.Generic Telegram.Bot.API.UpdatingMessages.EditMessageMediaRequest
instance GHC.Generics.Generic Telegram.Bot.API.UpdatingMessages.EditMessageReplyMarkupRequest
instance GHC.Generics.Generic Telegram.Bot.API.UpdatingMessages.StopPollRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.UpdatingMessages.EditMessageMediaRequest
instance Data.Aeson.Types.FromJSON.FromJSON Telegram.Bot.API.UpdatingMessages.EditMessageResponse
module Telegram.Bot.API.Webhook
setUpWebhook :: SetWebhookRequest -> ClientEnv -> IO (Either ClientError ())
deleteWebhook :: ClientEnv -> IO (Either ClientError ())
data SetWebhookRequest
SetWebhookRequest :: String -> Maybe InputFile -> Maybe String -> Maybe Int -> Maybe [String] -> Maybe Bool -> Maybe String -> SetWebhookRequest
[setWebhookUrl] :: SetWebhookRequest -> String
[setWebhookCertificate] :: SetWebhookRequest -> Maybe InputFile
[setWebhookIpAddress] :: SetWebhookRequest -> Maybe String
[setWebhookMaxConnections] :: SetWebhookRequest -> Maybe Int
[setWebhookAllowedUpdates] :: SetWebhookRequest -> Maybe [String]
[setWebhookDropPendingUpdates] :: SetWebhookRequest -> Maybe Bool
[setWebhookSecretToken] :: SetWebhookRequest -> Maybe String
defSetWebhook :: String -> SetWebhookRequest
defDeleteWebhook :: DeleteWebhookRequest
instance GHC.Generics.Generic Telegram.Bot.API.Webhook.SetWebhookRequest
instance GHC.Generics.Generic Telegram.Bot.API.Webhook.DeleteWebhookRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Webhook.DeleteWebhookRequest
instance Data.Aeson.Types.ToJSON.ToJSON Telegram.Bot.API.Webhook.SetWebhookRequest
instance Servant.Multipart.API.ToMultipart Servant.Multipart.API.Tmp Telegram.Bot.API.Webhook.SetWebhookRequest
module Telegram.Bot.API