Crate tg_bot_models

Structs

AddStickerToSet	Use this method to add a new sticker to a set created by the bot. Returns True on success.
Animation	This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).
AnswerCallbackQuery	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.
AnswerInlineQuery	Use this method to send answers to an inline query. On success, True is returned.No more than 50 results per query are allowed.
AnswerPreCheckoutQuery	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.
AnswerShippingQuery	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.
Audio	This object represents an audio file to be treated as music by the Telegram clients.
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.
Chat	This object represents a chat.
ChatMember	This object contains information about one member of a chat.
ChatPhoto	This object represents a chat photo.
ChosenInlineResult	Represents a result of an inline query that was chosen by the user and sent to their chat partner.
Contact	This object represents a phone contact.
CreateNewStickerSet	Use this method to create new sticker set owned by a user. The bot will be able to edit the created sticker set. Returns True on success.
DeleteChatPhoto	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 admin rights. Returns True on success.
DeleteChatStickerSet	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 admin 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.
DeleteMessage	Use this method to delete a message, including service messages, with the following limitations:- A message can only be deleted if it was sent less than 48 hours ago.- Bots can delete outgoing messages in private chats, groups, and supergroups.- Bots can delete incoming messages in private chats.- Bots granted can_post_messages permissions can delete outgoing messages in channels.- If the bot is an administrator of a group, it can delete any message there.- If the bot has can_delete_messages permission in a supergroup or a channel, it can delete any message there.Returns True on success.
DeleteStickerFromSet	Use this method to delete a sticker from a set created by the bot. Returns True on success.
DeleteWebhook	Use this method to remove webhook integration if you decide to switch back to getUpdates. Returns True on success. Requires no parameters.
Document	This object represents a general file (as opposed to photos, voice messages and audio files).
EditMessageCaption	Use this method to edit captions of messages. On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned.
EditMessageLiveLocation	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 was sent by the bot, the edited Message is returned, otherwise True is returned.
EditMessageMedia	Use this method to edit animation, audio, document, photo, or video messages. If a message is a part of a message album, then it can be edited only to a photo or a video. Otherwise, message type can be changed arbitrarily. When inline message is edited, new file can't be uploaded. Use previously uploaded file via its file_id or specify a URL. On success, if the edited message was sent by the bot, the edited Message is returned, otherwise True is returned.
EditMessageReplyMarkup	Use this method to edit only the reply markup of messages. On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned.
EditMessageText	Use this method to edit text and game messages. On success, if edited message is sent by the bot, the edited Message is returned, otherwise True is returned.
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.
EncryptedPassportElement	Contains information about documents or other Telegram Passport elements shared with the bot by the user.
ExportChatInviteLink	Use this method to generate a new invite link for a chat; any previously generated link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns the new invite link as String on success.
File	This object represents a file ready to be downloaded. The file can be downloaded via the link https://api.telegram.org/file/bot/<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.
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.
ForwardMessage	Use this method to forward messages of any kind. On success, the sent Message is returned.
Game	This object represents a game. Use BotFather to create and edit games, their short names will act as unique identifiers.
GameHighScore	This object represents one row of the high scores table for a game.
GetChat	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.
GetChatAdministrators	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.
GetChatMember	Use this method to get information about a member of a chat. Returns a ChatMember object on success.
GetChatMembersCount	Use this method to get the number of members in a chat. Returns Int on success.
GetFile	Use this method to get basic info about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size. On success, a File object is returned. The file can then be downloaded via the link https://api.telegram.org/file/bot/<file_path>, where <file_path> is taken from the response. 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 again.
GetGameHighScores	Use this method to get data for high score tables. Will return the score of the specified user and several of his neighbors in a game. On success, returns an Array of GameHighScore objects.
GetMe	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.
GetStickerSet	Use this method to get a sticker set. On success, a StickerSet object is returned.
GetUpdates	Use this method to receive incoming updates using long polling (wiki). An Array of Update objects is returned.
GetUserProfilePhotos	Use this method to get a list of profile pictures for a user. Returns a UserProfilePhotos object.
GetWebhookInfo	Use this method to get current webhook status. Requires no parameters. On success, returns a WebhookInfo object. If the bot is using getUpdates, will return an object with the url field empty.
InlineKeyboardButton	This object represents one button of an inline keyboard. You must use exactly one of the optional fields.
InlineKeyboardMarkup	This object represents an inline keyboard that appears right next to the message it belongs to.
InlineQuery	This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results.
InlineQueryResultArticle	Represents a link to an article or web page.
InlineQueryResultAudio	Represents a link to an mp3 audio file. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.
InlineQueryResultCachedAudio	Represents a link to an mp3 audio file stored on the Telegram servers. By default, this audio file will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the audio.
InlineQueryResultCachedDocument	Represents a link to a file stored on the Telegram servers. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file.
InlineQueryResultCachedGif	Represents a link to an animated GIF file stored on the Telegram servers. By default, this animated GIF file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with specified content instead of the animation.
InlineQueryResultCachedMpeg4Gif	Represents a link to a video animation (H.264/MPEG-4 AVC video without sound) stored on the Telegram servers. By default, this animated MPEG-4 file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.
InlineQueryResultCachedPhoto	Represents a link to a photo stored on the Telegram servers. By default, this photo will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the photo.
InlineQueryResultCachedSticker	Represents a link to a sticker stored on the Telegram servers. By default, this sticker will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the sticker.
InlineQueryResultCachedVideo	Represents a link to a video file stored on the Telegram servers. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video.
InlineQueryResultCachedVoice	Represents a link to a voice message stored on the Telegram servers. By default, this voice message will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the voice message.
InlineQueryResultContact	Represents a contact with a phone number. By default, this contact will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the contact.
InlineQueryResultDocument	Represents a link to a file. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file. Currently, only .PDF and .ZIP files can be sent using this method.
InlineQueryResultGame	Represents a Game.
InlineQueryResultGif	Represents a link to an animated GIF file. By default, this animated GIF file will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.
InlineQueryResultLocation	Represents a location on a map. By default, the location will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the location.
InlineQueryResultMpeg4Gif	Represents a link to a video animation (H.264/MPEG-4 AVC video without sound). By default, this animated MPEG-4 file will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the animation.
InlineQueryResultPhoto	Represents a link to a photo. By default, this photo will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the photo.
InlineQueryResultVenue	Represents a venue. By default, the venue will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the venue.
InlineQueryResultVideo	Represents a link to a page containing an embedded video player or a video file. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video.
InlineQueryResultVoice	Represents a link to a voice recording in an .ogg container encoded with OPUS. By default, this voice recording will be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content instead of the the voice message.
InputContactMessageContent	Represents the content of a contact message to be sent as the result of an inline query.
InputLocationMessageContent	Represents the content of a location message to be sent as the result of an inline query.
InputMediaAnimation	Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent.
InputMediaAudio	Represents an audio file to be treated as music to be sent.
InputMediaDocument	Represents a general file to be sent.
InputMediaPhoto	Represents a photo to be sent.
InputMediaVideo	Represents a video to be sent.
InputTextMessageContent	Represents the content of a text message to be sent as the result of an inline query.
InputVenueMessageContent	Represents the content of a venue message to be sent as the result of an inline query.
Invoice	This object contains basic information about an invoice.
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.
KickChatMember	Use this method to kick a user from a group, a supergroup or a channel. In the case of supergroups and channels, the user will not be able to return to the group 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 admin rights. Returns True on success.
LabeledPrice	This object represents a portion of the price for goods or services.
LeaveChat	Use this method for your bot to leave a group, supergroup or channel. Returns True on success.
Location	This object represents a point on the map.
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:
MaskPosition	This object describes the position on faces where a mask should be placed by default.
Message	This object represents a message.
MessageEntity	This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.
OrderInfo	This object represents information about an order.
PassportData	Contains information about Telegram Passport data shared with the bot by the user.
PassportElementErrorDataField	Represents an issue in one of the data fields that was provided by the user. The error is considered resolved when the field's value changes.
PassportElementErrorFile	Represents an issue with a document scan. The error is considered resolved when the file with the document scan changes.
PassportElementErrorFiles	Represents an issue with a list of scans. The error is considered resolved when the list of files containing the scans changes.
PassportElementErrorFrontSide	Represents an issue with the front side of a document. The error is considered resolved when the file with the front side of the document changes.
PassportElementErrorReverseSide	Represents an issue with the reverse side of a document. The error is considered resolved when the file with reverse side of the document changes.
PassportElementErrorSelfie	Represents an issue with the selfie with a document. The error is considered resolved when the file with the selfie changes.
PassportElementErrorTranslationFile	Represents an issue with one of the files that constitute the translation of a document. The error is considered resolved when the file changes.
PassportElementErrorTranslationFiles	Represents an issue with the translated version of a document. The error is considered resolved when a file with the document translation change.
PassportElementErrorUnspecified	Represents an issue in an unspecified place. The error is considered resolved when new data is added.
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.
PhotoSize	This object represents one size of a photo or a file / sticker thumbnail.
PinChatMessage	Use this method to pin a message in a group, a supergroup, or a channel. The bot must be an administrator in the chat for this to work and must have the ‘can_pin_messages’ admin right in the supergroup or ‘can_edit_messages’ admin right in the channel. Returns True on success.
Poll	This object contains information about a poll.
PollOption	This object contains information about one answer option in a poll.
PreCheckoutQuery	This object contains information about an incoming pre-checkout query.
PromoteChatMember	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 admin rights. Pass False for all boolean parameters to demote a user. Returns True on success.
ReplyKeyboardMarkup	This object represents a custom keyboard with reply options (see Introduction to bots for details and examples).
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).
ResponseParameters	Contains information about why a request was unsuccessful.
RestrictChatMember	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 admin rights. Pass True for all boolean parameters to lift restrictions from a user. Returns True on success.
SendAnimation	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.
SendAudio	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 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.
SendChatAction	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.
SendContact	Use this method to send phone contacts. On success, the sent Message is returned.
SendDocument	Use this method to send general files. On success, the sent Message is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.
SendGame	Use this method to send a game. On success, the sent Message is returned.
SendInvoice	Use this method to send invoices. On success, the sent Message is returned.
SendLocation	Use this method to send point on the map. On success, the sent Message is returned.
SendMediaGroup	Use this method to send a group of photos or videos as an album. On success, an array of the sent Messages is returned.
SendMessage	Use this method to send text messages. On success, the sent Message is returned.
SendPhoto	Use this method to send photos. On success, the sent Message is returned.
SendPoll	Use this method to send a native poll. A native poll can't be sent to a private chat. On success, the sent Message is returned.
SendSticker	Use this method to send .webp stickers. On success, the sent Message is returned.
SendVenue	Use this method to send information about a venue. On success, the sent Message is returned.
SendVideo	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.
SendVideoNote	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.
SendVoice	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.
SetChatDescription	Use this method to change the description of a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate admin rights. Returns True on success.
SetChatPhoto	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 admin rights. Returns True on success.
SetChatStickerSet	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 admin 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.
SetChatTitle	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 admin rights. Returns True on success.
SetGameScore	Use this method to set the score of the specified user in a game. On success, if the message was sent by the bot, returns the edited Message, otherwise returns True. Returns an error, if the new score is not greater than the user's current score in the chat and force is False.
SetStickerPositionInSet	Use this method to move a sticker in a set created by the bot to a specific position . Returns True on success.
SetWebhook	Use this method to specify a url and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified url, containing a JSON-serialized Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns True on success.
ShippingAddress	This object represents a shipping address.
ShippingOption	This object represents one shipping option.
ShippingQuery	This object contains information about an incoming shipping query.
Sticker	This object represents a sticker.
StickerSet	This object represents a sticker set.
StopMessageLiveLocation	Use this method to stop updating a live location message before live_period expires. On success, if the message was sent by the bot, the sent Message is returned, otherwise True is returned.
StopPoll	Use this method to stop a poll which was sent by the bot. On success, the stopped Poll with the final results is returned.
SuccessfulPayment	This object contains basic information about a successful payment.
UnbanChatMember	Use this method to unban a previously kicked 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. Returns True on success.
UnpinChatMessage	Use this method to unpin a message in a group, a supergroup, or a channel. The bot must be an administrator in the chat for this to work and must have the ‘can_pin_messages’ admin right in the supergroup or ‘can_edit_messages’ admin right in the channel. Returns True on success.
Update	This object represents an incoming update.At most one of the optional parameters can be present in any given update.
UploadStickerFile	Use this method to upload a .png file with a sticker for later use in createNewStickerSet and addStickerToSet methods (can be used multiple times). Returns the uploaded File on success.
User	This object represents a Telegram user or bot.
UserProfilePhotos	This object represent a user's profile pictures.
Venue	This object represents a venue.
Video	This object represents a video file.
VideoNote	This object represents a video message (available in Telegram apps as of v.4.0).
Voice	This object represents a voice note.
WebhookInfo	Contains information about the current status of a webhook.

Enums

InlineQueryResult	This object represents one result of an inline query. Telegram clients currently support results of the following 20 types:
InputMedia	This object represents the content of a media message to be sent. It should be one of
InputMessageContent	This object represents the content of a message to be sent as a result of an inline query. Telegram clients currently support the following 4 types:
PassportElementError	This object represents an error in the Telegram Passport element which was submitted that should be resolved by the user. It should be one of:
PolymorphChatId
PolymorphFromChatId
PolymorphReplyMarkup