OpenSource/teloxide
OpenSource/teloxide
1
0
Fork 0
mirror of https://github.com/teloxide/teloxide.git synced 2024-12-23 06:51:01 +01:00
Code Issues Projects Releases Packages Wiki Activity
teloxide/crates/teloxide-core/schema.ron
Maybe Waffle 7c2cf65988 fix a link in schema
2023-01-14 20:20:32 +04:00

4201 lines
227 KiB
Text
Raw Blame History

//! This file is written in [RON] (Rusty Object Notation).
//!
//! This "schema" is a formalized version of the
//! [telegram bot api documentation][tbadoc] which is not machine readable.
//! (note: this schema currently covers only API methods and **not** types).
//!
//! Also, note that this file is **hand written** and may contain typos,
//! deviations from original doc, and other kinds of typical human errors.
//! If you found an error please open an issue (or make a PR) on [github].
//!
//! This schema is targeting code generation for API wrappers in a statically
//! typed language, though you may use it whatever you want.
//!
//! This scheme also has some intentional differences from original doc:
//! * New types:
//! + `ChatId` - type of `chat_id` parameter, in the original documentation
//! written as `Integer or String
//! + `UserId` - type of `user_id` parameters
//! + `ChatAction` - type of `action` param in `sendChatAction` method
//! + `AllowedUpdate` inner type of `allowed_updates` in `getUpdates` and
//! `setWebhook` (so type is `ArrayOf(AllowedUpdate)`)
//! + `ReplyMarkup` - type of `reply_markup` parameter, in the original
//! documentation written as `InlineKeyboardMarkup or ReplyKeyboardMarkup or
//! ReplyKeyboardRemove or ForceReply`
//! + `ParseMode` type of `parse_mode` params
//! + `PollType` type of poll, either “quiz” or “regular”
//! + `DiceEmoji` emoji that can be used in `sendDice` one of “🎲”, “🎯”, or “🏀”
//! + `TargetMessage` either `inline_message_id: String` or `chat_id: ChatId` and `message_id: i64`
//! + `InputSticker`
//! * Integers represented with more strict (when possible) types, e.g.:
//! `u8` (unsigned, 8-bit integer), `u32` (unsigned, 32-bit),
//! `i64` (signed, 64-bit), etc
//! * Instead of optional parameters `Option(Ty)` is used
//! * Instead of `InputFile or String` just `InputFile` is used (assuming that
//! `InputFile` is a sum-type or something and it can contain `String`s)
//! * `f64` ~= `Float number`
//!
//! [tbadoc]: https://core.telegram.org/bots/api
//! [RON]: https://github.com/ron-rs/ron
//! [github]: https://github.com/WaffleLapkin/tg-methods-schema
Schema(
api_version: ApiVersion(ver: "6.1", date: "June 20, 2022"),
methods: [
Method(
names: ("getUpdates", "GetUpdates", "get_updates"),
return_ty: ArrayOf(RawTy("Update")),
doc: Doc(
md: "Use this method to receive incoming updates using long polling ([wiki]). An Array of [Update] objects is returned.",
md_links: {
"wiki": "https://en.wikipedia.org/wiki/Push_technology#Long_polling",
"Update": "https://core.telegram.org/bots/api#update",
},
),
tg_doc: "https://core.telegram.org/bots/api#getupdates",
tg_category: "Getting updates",
params: [
Param(
name: "offset",
ty: Option(i32),
descr: Doc(
md: "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.",
md_links: {
"getUpdates": "https://core.telegram.org/bots/api#getupdates",
}
)
),
Param(
name: "limit",
ty: Option(u8),
descr: Doc(md: "Limits the number of updates to be retrieved. Values between 1-100 are accepted. Defaults to 100."),
),
Param(
name: "timeout",
ty: Option(u32),
descr: Doc(md: "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."),
),
Param(
name: "allowed_updates",
ty: Option(ArrayOf(RawTy("AllowedUpdate"))),
descr: Doc(
md: "A JSON-serialized list of the update types you want your bot to receive. For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types. See [Update] for a complete list of available update types. Specify an empty list to receive all update types except chat_member (default). If not specified, the previous setting will be used.\n\nPlease 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.",
md_links: {"Update":"https://core.telegram.org/bots/api#update"},
),
)
],
notes: [
(md: "This method will not work if an outgoing webhook is set up."),
(md: "In order to avoid getting duplicate updates, recalculate _offset_ after each server response.")
],
),
Method(
names: ("setWebhook", "SetWebhook", "set_webhook"),
return_ty: True,
doc: Doc(
md: "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.\n\nIf you'd like to make sure that the Webhook request comes from Telegram, we recommend using a secret path in the URL, e.g. `https://www.example.com/<token>`. Since nobody else knows your bot's token, you can be pretty sure it's us.",
md_links: {"Update":"https://core.telegram.org/bots/api#update"},
),
tg_doc: "https://core.telegram.org/bots/api#setwebhook",
tg_category: "Getting updates",
params: [
Param(
name: "url",
ty: String,
descr: Doc(md: "HTTPS url to send updates to. Use an empty string to remove webhook integration"),
),
Param(
name: "certificate",
ty: Option(RawTy("InputFile")),
descr: Doc(
md: "Upload your public key certificate so that the root certificate in use can be checked. See our [self-signed guide] for details.",
md_links: {"self-signed guide":"https://core.telegram.org/bots/self-signed"},
)
),
Param(
name: "ip_address",
ty: Option(String),
descr: Doc(md: "The fixed IP address which will be used to send webhook requests instead of the IP address resolved through DNS"),
),
Param(
name: "max_connections",
ty: Option(u8),
descr: Doc(md: "Maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery, 1-100. Defaults to 40. Use lower values to limit the load on your bot's server, and higher values to increase your bot's throughput.")
),
Param(
name: "allowed_updates",
ty: Option(ArrayOf(RawTy("AllowedUpdate"))),
descr: Doc(
md: "A JSON-serialized list of the update types you want your bot to receive. For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types. See [Update] 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.\n\nPlease note that this parameter doesn't affect updates created before the call to the setWebhook, so unwanted updates may be received for a short period of time.",
md_links: {"Update":"https://core.telegram.org/bots/api#update"},
),
),
Param(
name: "drop_pending_updates",
ty: Option(bool),
descr: Doc(md: "Pass _True_ to drop all pending updates")
),
Param(
name: "secret_token",
ty: Option(String),
descr: Doc(md: "A secret token to be sent in a header “X-Telegram-Bot-Api-Secret-Token” in every webhook request, 1-256 characters. Only characters `A-Z`, `a-z`, `0-9`, `_` and `-` are allowed. The header is useful to ensure that the request comes from a webhook set by you."),
),
],
notes: [
(
md: "You will not be able to receive updates using [getUpdates] for as long as an outgoing webhook is set up.",
md_links: {"getUpdates": "https://core.telegram.org/bots/api#getupdates"},
),
(
md: "To use a self-signed certificate, you need to upload your [public key certificate] using certificate parameter. Please upload as InputFile, sending a String will not work.",
md_links: {"public key certificate":"https://core.telegram.org/bots/self-signed"}
),
(md: "Ports currently supported for Webhooks: **443**, **80**, **88**, **8443**."),
(
md: "If you're having any trouble setting up webhooks, please check out this [amazing guide to Webhooks].",
md_links: {"amazing guide to Webhooks": "https://core.telegram.org/bots/webhooks"}
)
]
),
Method(
names: ("deleteWebhook", "DeleteWebhook", "delete_webhook"),
return_ty: True,
doc: Doc(
md: "Use this method to remove webhook integration if you decide to switch back to [getUpdates]. Returns True on success. Requires no parameters.",
md_links: {"getUpdates":"https://core.telegram.org/bots/api#getupdates"},
),
tg_doc: "https://core.telegram.org/bots/api#deletewebhook",
tg_category: "Getting updates",
params: [
Param(
name: "drop_pending_updates",
ty: Option(bool),
descr: Doc(md: "Pass _True_ to drop all pending updates"),
)
],
),
Method(
names: ("getWebhookInfo", "GetWebhookInfo", "get_webhook_info"),
return_ty: RawTy("WebhookInfo"),
doc: Doc(
md: "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.",
md_links: {
"WebhookInfo": "https://core.telegram.org/bots/api#webhookinfo",
"getUpdates": "https://core.telegram.org/bots/api#getupdates",
}
),
tg_doc: "https://core.telegram.org/bots/api#getwebhookinfo",
tg_category: "Getting updates",
params: [],
),
Method(
names: ("getMe", "GetMe", "get_me"),
return_ty: RawTy("Me"),
doc: Doc(
md: "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.",
md_links: {"User": "https://core.telegram.org/bots/api#user"}
),
tg_doc: "https://core.telegram.org/bots/api#getme",
tg_category: "Available methods",
params: [],
),
Method(
names: ("logOut", "LogOut", "log_out"),
return_ty: True,
doc: Doc(md: "Use this method to log out from the cloud Bot API server before launching the bot locally. You **must** log out the bot before running it locally, otherwise there is no guarantee that the bot will receive updates. After a successful call, you can immediately log in on a local server, but will not be able to log in back to the cloud Bot API server for 10 minutes. Returns _True_ on success. Requires no parameters."),
tg_doc: "https://core.telegram.org/bots/api#logout",
tg_category: "Available methods",
params: [],
),
Method(
names: ("close", "Close", "close"),
return_ty: True,
doc: Doc(md: "Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn't launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns _True_ on success. Requires no parameters."),
tg_doc: "https://core.telegram.org/bots/api#close",
tg_category: "Available methods",
params: [],
),
Method(
names: ("sendMessage", "SendMessage", "send_message"),
return_ty: RawTy("Message"),
doc: Doc(
md: "Use this method to send text messages. On success, the sent [Message] is returned.",
md_links: {"Message": "https://core.telegram.org/bots/api#message"},
),
tg_doc: "https://core.telegram.org/bots/api#sendmessage",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
Param(
name: "message_thread_id",
ty: Option(i32),
descr: Doc(md: "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"),
),
Param(
name: "text",
ty: String,
descr: Doc(md: "Text of the message to be sent, 1-4096 characters after entities parsing")
),
Param(
name: "parse_mode",
ty: Option(RawTy("ParseMode")),
descr: Doc(
md: "Mode for parsing entities in the message text. See [formatting options] for more details.",
md_links: {"formatting options": "https://core.telegram.org/bots/api#formatting-options"}
)
),
Param(
name: "entities",
ty: Option(ArrayOf(RawTy("MessageEntity"))),
descr: Doc(md: "List of special entities that appear in the message text, which can be specified instead of _parse\\_mode_"),
),
Param(
name: "disable_web_page_preview",
ty: Option(bool),
descr: Doc(md: "Disables link previews for links in this message")
),
Param(
name: "disable_notification",
ty: Option(bool),
descr: Doc(
md: "Sends the message [silently]. Users will receive a notification with no sound.",
md_links: {"silently": "https://telegram.org/blog/channels-2-0#silent-messages"}
)
),
Param(
name: "protect_content",
ty: Option(bool),
descr: Doc(md: "Protects the contents of sent messages from forwarding and saving"),
),
Param(
name: "reply_to_message_id",
ty: Option(RawTy("MessageId")),
descr: Doc(md: "If the message is a reply, ID of the original message")
),
Param(
name: "allow_sending_without_reply",
ty: Option(bool),
descr: Doc(md: "Pass _True_, if the message should be sent even if the specified replied-to message is not found")
),
Param(
name: "reply_markup",
ty: Option(RawTy("ReplyMarkup")),
descr: Doc(
md: "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.",
md_links: {
"inline keyboard": "https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating",
"custom reply keyboard": "https://core.telegram.org/bots#keyboards",
}
),
),
],
),
Method(
names: ("forwardMessage", "ForwardMessage", "forward_message"),
return_ty: RawTy("Message"),
doc: Doc(
md: "Use this method to forward messages of any kind. On success, the sent [Message] is returned.",
md_links: {"Message": "https://core.telegram.org/bots/api#message"},
),
tg_doc: "https://core.telegram.org/bots/api#forwardmessage",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)"),
),
Param(
name: "message_thread_id",
ty: Option(i32),
descr: Doc(md: "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"),
),
Param(
name: "from_chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the chat where the original message was sent (or channel username in the format `@channelusername`)"),
),
Param(
name: "disable_notification",
ty: Option(bool),
descr: Doc(
md: "Sends the message [silently]. Users will receive a notification with no sound.",
md_links: {"silently": "https://telegram.org/blog/channels-2-0#silent-messages"}
)
),
Param(
name: "protect_content",
ty: Option(bool),
descr: Doc(md: "Protects the contents of sent messages from forwarding and saving"),
),
Param(
name: "message_id",
ty: RawTy("MessageId"),
descr: Doc(md: "Message identifier in the chat specified in _from\\_chat\\_id_")
),
],
),
Method(
names: ("copyMessage", "CopyMessage", "copy_message"),
return_ty: RawTy("MessageId"),
doc: Doc(
md: "Use this method to copy messages of any kind. 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.",
md_links: {"MessageId": "https://core.telegram.org/bots/api#messageid"},
),
tg_doc: "https://core.telegram.org/bots/api#copymessage",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)"),
),
Param(
name: "message_thread_id",
ty: Option(i32),
descr: Doc(md: "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"),
),
Param(
name: "from_chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the chat where the original message was sent (or channel username in the format `@channelusername`)"),
),
Param(
name: "message_id",
ty: RawTy("MessageId"),
descr: Doc(md: "Message identifier in the chat specified in _from\\_chat\\_id_")
),
Param(
name: "caption",
ty: Option(String),
descr: Doc(md: "New caption for media, 0-1024 characters after entities parsing. If not specified, the original caption is kept"),
),
Param(
name: "parse_mode",
ty: Option(RawTy("ParseMode")),
descr: Doc(
md: "Mode for parsing entities in the photo caption. See [formatting options] for more details.",
md_links: {"formatting options": "https://core.telegram.org/bots/api#formatting-options"}
)
),
Param(
name: "caption_entities",
ty: Option(ArrayOf(RawTy("MessageEntity"))),
descr: Doc(md: "List of special entities that appear in the new caption, which can be specified instead of _parse\\_mode_"),
),
Param(
name: "disable_notification",
ty: Option(bool),
descr: Doc(
md: "Sends the message [silently]. Users will receive a notification with no sound.",
md_links: {"silently": "https://telegram.org/blog/channels-2-0#silent-messages"}
)
),
Param(
name: "protect_content",
ty: Option(bool),
descr: Doc(md: "Protects the contents of sent messages from forwarding and saving"),
),
Param(
name: "reply_to_message_id",
ty: Option(RawTy("MessageId")),
descr: Doc(md: "If the message is a reply, ID of the original message")
),
Param(
name: "allow_sending_without_reply",
ty: Option(bool),
descr: Doc(md: "Pass _True_, if the message should be sent even if the specified replied-to message is not found")
),
Param(
name: "reply_markup",
ty: Option(RawTy("ReplyMarkup")),
descr: Doc(
md: "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.",
md_links: {
"inline keyboard": "https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating",
"custom reply keyboard": "https://core.telegram.org/bots#keyboards",
},
),
),
],
),
Method(
names: ("sendPhoto", "SendPhoto", "send_photo"),
return_ty: RawTy("Message"),
doc: Doc(
md: "Use this method to send photos. On success, the sent [Message] is returned.",
md_links: {"Message": "https://core.telegram.org/bots/api#message"},
),
tg_doc: "https://core.telegram.org/bots/api#sendphoto",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
Param(
name: "message_thread_id",
ty: Option(i32),
descr: Doc(md: "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"),
),
Param(
name: "photo",
ty: RawTy("InputFile"),
descr: Doc(
md: "Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. [More info on Sending Files »]",
md_links: {"More info on Sending Files »": "https://core.telegram.org/bots/api#sending-files"},
)
),
Param(
name: "caption",
ty: Option(String),
descr: Doc(md: "Photo caption (may also be used when resending photos by _file\\_id_), 0-1024 characters after entities parsing")
),
Param(
name: "parse_mode",
ty: Option(RawTy("ParseMode")),
descr: Doc(
md: "Mode for parsing entities in the photo caption. See [formatting options] for more details.",
md_links: {"formatting options": "https://core.telegram.org/bots/api#formatting-options"}
)
),
Param(
name: "caption_entities",
ty: Option(ArrayOf(RawTy("MessageEntity"))),
descr: Doc(md: "List of special entities that appear in the photo caption, which can be specified instead of _parse\\_mode_"),
),
Param(
name: "has_spoiler",
ty: Option(bool),
descr: Doc(md: "Pass True if the photo needs to be covered with a spoiler animation"),
),
Param(
name: "disable_notification",
ty: Option(bool),
descr: Doc(
md: "Sends the message [silently]. Users will receive a notification with no sound.",
md_links: {"silently": "https://telegram.org/blog/channels-2-0#silent-messages"}
)
),
Param(
name: "protect_content",
ty: Option(bool),
descr: Doc(md: "Protects the contents of sent messages from forwarding and saving"),
),
Param(
name: "reply_to_message_id",
ty: Option(RawTy("MessageId")),
descr: Doc(md: "If the message is a reply, ID of the original message")
),
Param(
name: "allow_sending_without_reply",
ty: Option(bool),
descr: Doc(md: "Pass _True_, if the message should be sent even if the specified replied-to message is not found")
),
Param(
name: "reply_markup",
ty: Option(RawTy("ReplyMarkup")),
descr: Doc(
md: "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.",
md_links: {
"inline keyboard": "https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating",
"custom reply keyboard": "https://core.telegram.org/bots#keyboards",
},
),
),
],
),
Method(
names: ("sendAudio", "SendAudio", "send_audio"),
return_ty: RawTy("Message"),
doc: Doc(
md: "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.\n\nFor sending voice messages, use the [sendVoice] method instead.",
md_links: {
"Message": "https://core.telegram.org/bots/api#message",
"sendVoice": "https://core.telegram.org/bots/api#sendvoice",
},
),
tg_doc: "https://core.telegram.org/bots/api#sendaudio",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)"),
),
Param(
name: "message_thread_id",
ty: Option(i32),
descr: Doc(md: "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"),
),
Param(
name: "audio",
ty: RawTy("InputFile"),
descr: Doc(
md: "Audio file to send. Pass a file_id as String to send an audio file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an audio file from the Internet, or upload a new one using multipart/form-data. [More info on Sending Files »]",
md_links: {"More info on Sending Files »": "https://core.telegram.org/bots/api#sending-files"},
),
),
Param(
name: "caption",
ty: Option(String),
descr: Doc(md: "Audio caption, 0-1024 characters after entities parsing"),
),
Param(
name: "parse_mode",
ty: Option(RawTy("ParseMode")),
descr: Doc(
md: "Mode for parsing entities in the audio caption. See [formatting options] for more details.",
md_links: {"formatting options": "https://core.telegram.org/bots/api#formatting-options"},
),
),
Param(
name: "caption_entities",
ty: Option(ArrayOf(RawTy("MessageEntity"))),
descr: Doc(md: "List of special entities that appear in the photo caption, which can be specified instead of _parse\\_mode_"),
),
Param(
name: "duration",
ty: Option(u32),
descr: Doc(md: "Duration of the audio in seconds"),
),
Param(
name: "performer",
ty: Option(String),
descr: Doc(md: "Performer"),
),
Param(
name: "title",
ty: Option(String),
descr: Doc(md: "Track name"),
),
Param(
name: "thumb",
ty: Option(RawTy("InputFile")),
descr: Doc(
md: "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 multipart/form-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 multipart/form-data under <file_attach_name>. [More info on Sending Files »]",
md_links: {"More info on Sending Files »": "https://core.telegram.org/bots/api#sending-files"},
),
),
Param(
name: "disable_notification",
ty: Option(bool),
descr: Doc(
md: "Sends the message [silently]. Users will receive a notification with no sound.",
md_links: {"silently": "https://telegram.org/blog/channels-2-0#silent-messages"},
)
),
Param(
name: "protect_content",
ty: Option(bool),
descr: Doc(md: "Protects the contents of sent messages from forwarding and saving"),
),
Param(
name: "reply_to_message_id",
ty: Option(RawTy("MessageId")),
descr: Doc(md: "If the message is a reply, ID of the original message")
),
Param(
name: "allow_sending_without_reply",
ty: Option(bool),
descr: Doc(md: "Pass _True_, if the message should be sent even if the specified replied-to message is not found")
),
Param(
name: "reply_markup",
ty: Option(RawTy("ReplyMarkup")),
descr: Doc(
md: "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.",
md_links: {
"inline keyboard": "https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating",
"custom reply keyboard": "https://core.telegram.org/bots#keyboards",
}
),
),
],
),
Method(
names: ("sendDocument", "SendDocument", "send_document"),
return_ty: RawTy("Message"),
doc: Doc(
md: "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.",
md_links: { "Message": "https://core.telegram.org/bots/api#message" },
),
tg_doc: "https://core.telegram.org/bots/api#senddocument",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)"),
),
Param(
name: "message_thread_id",
ty: Option(i32),
descr: Doc(md: "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"),
),
Param(
name: "document",
ty: RawTy("InputFile"),
descr: Doc(
md: "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 »]",
md_links: {"More info on Sending Files »": "https://core.telegram.org/bots/api#sending-files"},
),
),
Param(
name: "thumb",
ty: Option(RawTy("InputFile")),
descr: Doc(
md: "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 multipart/form-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 multipart/form-data under <file_attach_name>. [More info on Sending Files »]",
md_links: {"More info on Sending Files »": "https://core.telegram.org/bots/api#sending-files"},
),
),
Param(
name: "caption",
ty: Option(String),
descr: Doc(md: "Document caption (may also be used when resending documents by _file\\_id_), 0-1024 characters after entities parsing"),
),
Param(
name: "parse_mode",
ty: Option(RawTy("ParseMode")),
descr: Doc(
md: "Mode for parsing entities in the audio caption. See [formatting options] for more details.",
md_links: {"formatting options": "https://core.telegram.org/bots/api#formatting-options"},
),
),
Param(
name: "caption_entities",
ty: Option(ArrayOf(RawTy("MessageEntity"))),
descr: Doc(md: "List of special entities that appear in the photo caption, which can be specified instead of _parse\\_mode_"),
),
Param(
name: "disable_content_type_detection",
ty: Option(bool),
descr: Doc(md: "Disables automatic server-side content type detection for files uploaded using multipart/form-data."),
),
Param(
name: "disable_notification",
ty: Option(bool),
descr: Doc(
md: "Sends the message [silently]. Users will receive a notification with no sound.",
md_links: {"silently": "https://telegram.org/blog/channels-2-0#silent-messages"},
)
),
Param(
name: "protect_content",
ty: Option(bool),
descr: Doc(md: "Protects the contents of sent messages from forwarding and saving"),
),
Param(
name: "reply_to_message_id",
ty: Option(RawTy("MessageId")),
descr: Doc(md: "If the message is a reply, ID of the original message")
),
Param(
name: "allow_sending_without_reply",
ty: Option(bool),
descr: Doc(md: "Pass _True_, if the message should be sent even if the specified replied-to message is not found")
),
Param(
name: "reply_markup",
ty: Option(RawTy("ReplyMarkup")),
descr: Doc(
md: "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.",
md_links: {
"inline keyboard": "https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating",
"custom reply keyboard": "https://core.telegram.org/bots#keyboards",
}
),
),
],
),
Method(
names: ("sendVideo", "SendVideo", "send_video"),
return_ty: RawTy("Message"),
doc: Doc(
md: "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.",
md_links: {
"Document": "https://core.telegram.org/bots/api#document",
"Message": "https://core.telegram.org/bots/api#message",
},
),
tg_doc: "https://core.telegram.org/bots/api#sendvideo",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)"),
),
Param(
name: "message_thread_id",
ty: Option(i32),
descr: Doc(md: "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"),
),
Param(
name: "video",
ty: RawTy("InputFile"),
descr: Doc(
md: "Video to send. Pass a file_id as String to send a 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 »]",
md_links: {"More info on Sending Files »": "https://core.telegram.org/bots/api#sending-files"},
),
),
Param(
name: "duration",
ty: Option(u32),
descr: Doc(md: "Duration of the video in seconds"),
),
Param(
name: "width",
ty: Option(u32),
descr: Doc(md: "Video width"),
),
Param(
name: "height",
ty: Option(u32),
descr: Doc(md: "Video height"),
),
Param(
name: "thumb",
ty: Option(RawTy("InputFile")),
descr: Doc(
md: "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 multipart/form-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 multipart/form-data under <file_attach_name>. [More info on Sending Files »]",
md_links: {"More info on Sending Files »": "https://core.telegram.org/bots/api#sending-files"},
),
),
Param(
name: "caption",
ty: Option(String),
descr: Doc(md: "Video caption (may also be used when resending videos by _file\\_id_), 0-1024 characters after entities parsing"),
),
Param(
name: "parse_mode",
ty: Option(RawTy("ParseMode")),
descr: Doc(
md: "Mode for parsing entities in the video caption. See [formatting options] for more details.",
md_links: {"formatting options": "https://core.telegram.org/bots/api#formatting-options"},
),
),
Param(
name: "caption_entities",
ty: Option(ArrayOf(RawTy("MessageEntity"))),
descr: Doc(md: "List of special entities that appear in the caption, which can be specified instead of _parse\\_mode_"),
),
Param(
name: "has_spoiler",
ty: Option(bool),
descr: Doc(md: "Pass True if the video needs to be covered with a spoiler animation"),
),
Param(
name: "supports_streaming",
ty: Option(bool),
descr: Doc(md: "Pass _True_, if the uploaded video is suitable for streaming"),
),
Param(
name: "disable_notification",
ty: Option(bool),
descr: Doc(
md: "Sends the message [silently]. Users will receive a notification with no sound.",
md_links: {"silently": "https://telegram.org/blog/channels-2-0#silent-messages"},
)
),
Param(
name: "protect_content",
ty: Option(bool),
descr: Doc(md: "Protects the contents of sent messages from forwarding and saving"),
),
Param(
name: "reply_to_message_id",
ty: Option(RawTy("MessageId")),
descr: Doc(md: "If the message is a reply, ID of the original message")
),
Param(
name: "allow_sending_without_reply",
ty: Option(bool),
descr: Doc(md: "Pass _True_, if the message should be sent even if the specified replied-to message is not found")
),
Param(
name: "reply_markup",
ty: Option(RawTy("ReplyMarkup")),
descr: Doc(
md: "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.",
md_links: {
"inline keyboard": "https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating",
"custom reply keyboard": "https://core.telegram.org/bots#keyboards",
}
),
),
],
),
Method(
names: ("sendAnimation", "SendAnimation", "send_animation"),
return_ty: RawTy("Message"),
doc: Doc(
md: "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.",
md_links: { "Message": "https://core.telegram.org/bots/api#message" },
),
tg_doc: "https://core.telegram.org/bots/api#sendanimation",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)"),
),
Param(
name: "message_thread_id",
ty: Option(i32),
descr: Doc(md: "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"),
),
Param(
name: "animation",
ty: RawTy("InputFile"),
descr: Doc(
md: "Animation to send. Pass a file_id as String to send a 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 »]",
md_links: {"More info on Sending Files »": "https://core.telegram.org/bots/api#sending-files"},
),
),
Param(
name: "duration",
ty: Option(u32),
descr: Doc(md: "Duration of the animation in seconds"),
),
Param(
name: "width",
ty: Option(u32),
descr: Doc(md: "Animation width"),
),
Param(
name: "height",
ty: Option(u32),
descr: Doc(md: "Animation height"),
),
Param(
name: "thumb",
ty: Option(RawTy("InputFile")),
descr: Doc(
md: "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 multipart/form-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 multipart/form-data under <file_attach_name>. [More info on Sending Files »]",
md_links: {"More info on Sending Files »": "https://core.telegram.org/bots/api#sending-files"},
),
),
Param(
name: "caption",
ty: Option(String),
descr: Doc(md: "Animation caption (may also be used when resending videos by _file\\_id_), 0-1024 characters after entities parsing"),
),
Param(
name: "parse_mode",
ty: Option(RawTy("ParseMode")),
descr: Doc(
md: "Mode for parsing entities in the animation caption. See [formatting options] for more details.",
md_links: {"formatting options": "https://core.telegram.org/bots/api#formatting-options"},
),
),
Param(
name: "caption_entities",
ty: Option(ArrayOf(RawTy("MessageEntity"))),
descr: Doc(md: "List of special entities that appear in the photo caption, which can be specified instead of _parse\\_mode_"),
),
Param(
name: "has_spoiler",
ty: Option(bool),
descr: Doc(md: "Pass True if the animation needs to be covered with a spoiler animation"),
),
Param(
name: "disable_notification",
ty: Option(bool),
descr: Doc(
md: "Sends the message [silently]. Users will receive a notification with no sound.",
md_links: {"silently": "https://telegram.org/blog/channels-2-0#silent-messages"},
)
),
Param(
name: "protect_content",
ty: Option(bool),
descr: Doc(md: "Protects the contents of sent messages from forwarding and saving"),
),
Param(
name: "reply_to_message_id",
ty: Option(RawTy("MessageId")),
descr: Doc(md: "If the message is a reply, ID of the original message")
),
Param(
name: "allow_sending_without_reply",
ty: Option(bool),
descr: Doc(md: "Pass _True_, if the message should be sent even if the specified replied-to message is not found")
),
Param(
name: "reply_markup",
ty: Option(RawTy("ReplyMarkup")),
descr: Doc(
md: "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.",
md_links: {
"inline keyboard": "https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating",
"custom reply keyboard": "https://core.telegram.org/bots#keyboards",
}
),
),
],
),
Method(
names: ("sendVoice", "SendVoice", "send_voice"),
return_ty: RawTy("Message"),
doc: Doc(
md: "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.",
md_links: {
"Audio": "https://core.telegram.org/bots/api#audio",
"Document": "https://core.telegram.org/bots/api#document",
"Message": "https://core.telegram.org/bots/api#message",
},
),
tg_doc: "https://core.telegram.org/bots/api#sendvoice",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)"),
),
Param(
name: "message_thread_id",
ty: Option(i32),
descr: Doc(md: "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"),
),
Param(
name: "voice",
ty: RawTy("InputFile"),
descr: Doc(
md: "Audio file to send. Pass a file_id as String to send an audio file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an audio file from the Internet, or upload a new one using multipart/form-data. [More info on Sending Files »]",
md_links: {"More info on Sending Files »": "https://core.telegram.org/bots/api#sending-files"},
),
),
Param(
name: "caption",
ty: Option(String),
descr: Doc(md: "Voice message caption, 0-1024 characters after entities parsing"),
),
Param(
name: "parse_mode",
ty: Option(RawTy("ParseMode")),
descr: Doc(
md: "Mode for parsing entities in the voice message caption. See [formatting options] for more details.",
md_links: {"formatting options": "https://core.telegram.org/bots/api#formatting-options"},
),
),
Param(
name: "caption_entities",
ty: Option(ArrayOf(RawTy("MessageEntity"))),
descr: Doc(md: "List of special entities that appear in the photo caption, which can be specified instead of _parse\\_mode_"),
),
Param(
name: "duration",
ty: Option(u32),
descr: Doc(md: "Duration of the voice message in seconds"),
),
Param(
name: "disable_notification",
ty: Option(bool),
descr: Doc(
md: "Sends the message [silently]. Users will receive a notification with no sound.",
md_links: {"silently": "https://telegram.org/blog/channels-2-0#silent-messages"},
)
),
Param(
name: "reply_to_message_id",
ty: Option(RawTy("MessageId")),
descr: Doc(md: "If the message is a reply, ID of the original message")
),
Param(
name: "allow_sending_without_reply",
ty: Option(bool),
descr: Doc(md: "Pass _True_, if the message should be sent even if the specified replied-to message is not found")
),
Param(
name: "reply_markup",
ty: Option(RawTy("ReplyMarkup")),
descr: Doc(
md: "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.",
md_links: {
"inline keyboard": "https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating",
"custom reply keyboard": "https://core.telegram.org/bots#keyboards",
}
),
),
],
),
Method(
names: ("sendVideoNote", "SendVideoNote", "send_video_note"),
return_ty: RawTy("Message"),
doc: Doc(
md: "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.",
md_links: {
"v.4.0": "https://core.telegram.org/bots/api#document",
"Message": "https://core.telegram.org/bots/api#message",
},
),
tg_doc: "https://core.telegram.org/bots/api#sendvideonote",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)"),
),
Param(
name: "message_thread_id",
ty: Option(i32),
descr: Doc(md: "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"),
),
Param(
name: "video_note",
ty: RawTy("InputFile"),
descr: Doc(
md: "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",
md_links: {"More info on Sending Files »": "https://core.telegram.org/bots/api#sending-files"},
),
),
Param(
name: "duration",
ty: Option(u32),
descr: Doc(md: "Duration of the video in seconds"),
),
Param(
name: "length",
ty: Option(u32),
descr: Doc(md: "Video width and height, i.e. diameter of the video message"),
),
Param(
name: "thumb",
ty: Option(RawTy("InputFile")),
descr: Doc(
md: "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 multipart/form-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 multipart/form-data under <file_attach_name>. [More info on Sending Files »]",
md_links: {"More info on Sending Files »": "https://core.telegram.org/bots/api#sending-files"},
),
),
Param(
name: "disable_notification",
ty: Option(bool),
descr: Doc(
md: "Sends the message [silently]. Users will receive a notification with no sound.",
md_links: {"silently": "https://telegram.org/blog/channels-2-0#silent-messages"},
)
),
Param(
name: "protect_content",
ty: Option(bool),
descr: Doc(md: "Protects the contents of sent messages from forwarding and saving"),
),
Param(
name: "reply_to_message_id",
ty: Option(RawTy("MessageId")),
descr: Doc(md: "If the message is a reply, ID of the original message")
),
Param(
name: "allow_sending_without_reply",
ty: Option(bool),
descr: Doc(md: "Pass _True_, if the message should be sent even if the specified replied-to message is not found")
),
Param(
name: "reply_markup",
ty: Option(RawTy("ReplyMarkup")),
descr: Doc(
md: "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.",
md_links: {
"inline keyboard": "https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating",
"custom reply keyboard": "https://core.telegram.org/bots#keyboards",
}
),
),
],
),
Method(
names: ("sendMediaGroup", "SendMediaGroup", "send_media_group"),
return_ty: ArrayOf(RawTy("Message")),
doc: Doc(
md: "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 [Message]s that were sent is returned.",
md_links: {"Message": "https://core.telegram.org/bots/api#message"},
),
tg_doc: "https://core.telegram.org/bots/api#sendmediagroup",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
Param(
name: "message_thread_id",
ty: Option(i32),
descr: Doc(md: "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"),
),
Param(
name: "media",
ty: ArrayOf(RawTy("InputMedia")),
descr: Doc(md: "A JSON-serialized array describing messages to be sent, must include 2-10 items")
),
Param(
name: "disable_notification",
ty: Option(bool),
descr: Doc(
md: "Sends the message [silently]. Users will receive a notification with no sound.",
md_links: {"silently": "https://telegram.org/blog/channels-2-0#silent-messages"}
)
),
Param(
name: "protect_content",
ty: Option(bool),
descr: Doc(md: "Protects the contents of sent messages from forwarding and saving"),
),
Param(
name: "reply_to_message_id",
ty: Option(RawTy("MessageId")),
descr: Doc(md: "If the message is a reply, ID of the original message")
),
Param(
name: "allow_sending_without_reply",
ty: Option(bool),
descr: Doc(md: "Pass _True_, if the message should be sent even if the specified replied-to message is not found")
),
],
),
Method(
names: ("sendLocation", "SendLocation", "send_location"),
return_ty: RawTy("Message"),
doc: Doc(
md: "Use this method to send point on the map. On success, the sent [Message] is returned.",
md_links: {"Message": "https://core.telegram.org/bots/api#message"},
),
tg_doc: "https://core.telegram.org/bots/api#sendlocation",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)"),
),
Param(
name: "message_thread_id",
ty: Option(i32),
descr: Doc(md: "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"),
),
Param(
name: "latitude",
ty: f64,
descr: Doc(md: "Latitude of the location"),
),
Param(
name: "longitude",
ty: f64,
descr: Doc(md: "Longitude of the location"),
),
Param(
name: "horizontal_accuracy",
ty: Option(f64),
descr: Doc(md: "The radius of uncertainty for the location, measured in meters; 0-1500"),
),
Param(
name: "live_period",
ty: Option(u32),
descr: Doc(
md: "Period in seconds for which the location will be updated (see [Live Locations], should be between 60 and 86400.",
md_links: {"Live Locations": "https://telegram.org/blog/live-locations"}
)
),
Param(
name: "heading",
ty: Option(u16),
descr: Doc(md: "For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.")
),
Param(
name: "proximity_alert_radius",
ty: Option(u32),
descr: Doc(md: "For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.")
),
Param(
name: "disable_notification",
ty: Option(bool),
descr: Doc(
md: "Sends the message [silently]. Users will receive a notification with no sound.",
md_links: {"silently": "https://telegram.org/blog/channels-2-0#silent-messages"}
)
),
Param(
name: "protect_content",
ty: Option(bool),
descr: Doc(md: "Protects the contents of sent messages from forwarding and saving"),
),
Param(
name: "reply_to_message_id",
ty: Option(RawTy("MessageId")),
descr: Doc(md: "If the message is a reply, ID of the original message")
),
Param(
name: "allow_sending_without_reply",
ty: Option(bool),
descr: Doc(md: "Pass _True_, if the message should be sent even if the specified replied-to message is not found")
),
Param(
name: "reply_markup",
ty: Option(RawTy("ReplyMarkup")),
descr: Doc(
md: "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.",
md_links: {
"inline keyboard": "https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating",
"custom reply keyboard": "https://core.telegram.org/bots#keyboards",
}
),
),
],
),
Method(
names: ("editMessageLiveLocation", "EditMessageLiveLocation", "edit_message_live_location"),
return_ty: RawTy("Message"),
doc: Doc(
md: "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, the edited Message is returned.",
md_links: {"stopMessageLiveLocation": "https://core.telegram.org/bots/api#stopmessagelivelocation"},
),
tg_doc: "https://core.telegram.org/bots/api#editmessagelivelocation",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
Param(
name: "message_id",
ty: RawTy("MessageId"),
descr: Doc(md: "Identifier of the message to edit")
),
Param(
name: "latitude",
ty: f64,
descr: Doc(md: "Latitude of new location"),
),
Param(
name: "longitude",
ty: f64,
descr: Doc(md: "Longitude of new location"),
),
Param(
name: "horizontal_accuracy",
ty: Option(f64),
descr: Doc(md: "The radius of uncertainty for the location, measured in meters; 0-1500"),
),
Param(
name: "heading",
ty: Option(u16),
descr: Doc(md: "For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.")
),
Param(
name: "proximity_alert_radius",
ty: Option(u32),
descr: Doc(md: "For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.")
),
Param(
name: "reply_markup",
ty: Option(RawTy("ReplyMarkup")),
descr: Doc(
md: "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.",
md_links: {
"inline keyboard": "https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating",
"custom reply keyboard": "https://core.telegram.org/bots#keyboards",
}
),
),
],
sibling: Some("editMessageLiveLocationInline"),
),
Method(
names: ("editMessageLiveLocationInline", "EditMessageLiveLocationInline", "edit_message_live_location_inline"),
return_ty: RawTy("Message"),
doc: Doc(
md: "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, True is returned.",
md_links: {"stopMessageLiveLocation": "https://core.telegram.org/bots/api#stopmessagelivelocation"},
),
tg_doc: "https://core.telegram.org/bots/api#editmessagelivelocation",
tg_category: "Available methods",
params: [
Param(
name: "inline_message_id",
ty: String,
descr: Doc(md: "Identifier of the inline message"),
),
Param(
name: "latitude",
ty: f64,
descr: Doc(md: "Latitude of new location"),
),
Param(
name: "longitude",
ty: f64,
descr: Doc(md: "Longitude of new location"),
),
Param(
name: "horizontal_accuracy",
ty: Option(f64),
descr: Doc(md: "The radius of uncertainty for the location, measured in meters; 0-1500"),
),
Param(
name: "heading",
ty: Option(u16),
descr: Doc(md: "For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if specified.")
),
Param(
name: "proximity_alert_radius",
ty: Option(u32),
descr: Doc(md: "For live locations, a maximum distance for proximity alerts about approaching another chat member, in meters. Must be between 1 and 100000 if specified.")
),
Param(
name: "reply_markup",
ty: Option(RawTy("ReplyMarkup")),
descr: Doc(
md: "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.",
md_links: {
"inline keyboard": "https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating",
"custom reply keyboard": "https://core.telegram.org/bots#keyboards",
}
),
),
],
sibling: Some("editMessageLiveLocation"),
),
Method(
names: ("stopMessageLiveLocation", "StopMessageLiveLocation", "stop_message_live_location"),
return_ty: RawTy("Message"),
doc: Doc(
md: "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, the edited Message is returned.",
md_links: {
"Message": "https://core.telegram.org/bots/api#message",
"stopMessageLiveLocation": "https://core.telegram.org/bots/api#stopmessagelivelocation",
},
),
tg_doc: "https://core.telegram.org/bots/api#editmessagelivelocation",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
Param(
name: "message_id",
ty: RawTy("MessageId"),
descr: Doc(md: "Identifier of the message to edit")
),
Param(
name: "latitude",
ty: f64,
descr: Doc(md: "Latitude of new location"),
),
Param(
name: "longitude",
ty: f64,
descr: Doc(md: "Longitude of new location"),
),
Param(
name: "reply_markup",
ty: Option(RawTy("ReplyMarkup")),
descr: Doc(
md: "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.",
md_links: {
"inline keyboard": "https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating",
"custom reply keyboard": "https://core.telegram.org/bots#keyboards",
}
),
),
],
sibling: Some("stopMessageLiveLocationInline"),
),
Method(
names: ("stopMessageLiveLocationInline", "StopMessageLiveLocationInline", "stop_message_live_location_inline"),
return_ty: RawTy("Message"),
doc: Doc(
md: "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, True is returned.",
md_links: {"stopMessageLiveLocation": "https://core.telegram.org/bots/api#stopmessagelivelocation"},
),
tg_doc: "https://core.telegram.org/bots/api#editmessagelivelocation",
tg_category: "Available methods",
params: [
Param(
name: "inline_message_id",
ty: String,
descr: Doc(md: "Identifier of the inline message"),
),
Param(
name: "latitude",
ty: f64,
descr: Doc(md: "Latitude of new location"),
),
Param(
name: "longitude",
ty: f64,
descr: Doc(md: "Longitude of new location"),
),
Param(
name: "reply_markup",
ty: Option(RawTy("ReplyMarkup")),
descr: Doc(
md: "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.",
md_links: {
"inline keyboard": "https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating",
"custom reply keyboard": "https://core.telegram.org/bots#keyboards",
}
),
),
],
sibling: Some("stopMessageLiveLocation"),
),
Method(
names: ("sendVenue", "SendVenue", "send_venue"),
return_ty: RawTy("Message"),
doc: Doc(
md: "Use this method to send information about a venue. On success, the sent [Message] is returned.",
md_links: {"Message": "https://core.telegram.org/bots/api#message"},
),
tg_doc: "https://core.telegram.org/bots/api#sendvenue",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
Param(
name: "message_thread_id",
ty: Option(i32),
descr: Doc(md: "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"),
),
Param(
name: "latitude",
ty: f64,
descr: Doc(md: "Latitude of new location"),
),
Param(
name: "longitude",
ty: f64,
descr: Doc(md: "Longitude of new location"),
),
Param(
name: "title",
ty: String,
descr: Doc(md: "Name of the venue")
),
Param(
name: "address",
ty: String,
descr: Doc(md: "Address of the venue")
),
Param(
name: "foursquare_id",
ty: Option(String),
descr: Doc(md: "Foursquare identifier of the venue")
),
Param(
name: "foursquare_type",
ty: Option(String),
descr: Doc(md: "Foursquare type of the venue, if known. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium” or “food/icecream”.)")
),
Param(
name: "google_place_id",
ty: Option(String),
descr: Doc(md: "Google Places identifier of the venue")
),
Param(
name: "google_place_type",
ty: Option(String),
descr: Doc(
md: "Google Places type of the venue. (See [supported types].)",
md_links: {"supported types":"https://developers.google.com/places/web-service/supported_types"},
),
),
Param(
name: "disable_notification",
ty: Option(bool),
descr: Doc(
md: "Sends the message [silently]. Users will receive a notification with no sound.",
md_links: {"silently": "https://telegram.org/blog/channels-2-0#silent-messages"}
)
),
Param(
name: "protect_content",
ty: Option(bool),
descr: Doc(md: "Protects the contents of sent messages from forwarding and saving"),
),
Param(
name: "reply_to_message_id",
ty: Option(RawTy("MessageId")),
descr: Doc(md: "If the message is a reply, ID of the original message")
),
Param(
name: "allow_sending_without_reply",
ty: Option(bool),
descr: Doc(md: "Pass _True_, if the message should be sent even if the specified replied-to message is not found")
),
Param(
name: "reply_markup",
ty: Option(RawTy("ReplyMarkup")),
descr: Doc(
md: "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.",
md_links: {
"inline keyboard": "https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating",
"custom reply keyboard": "https://core.telegram.org/bots#keyboards",
}
),
),
],
),
Method(
names: ("sendContact", "SendContact", "send_contact"),
return_ty: RawTy("Message"),
doc: Doc(
md: "Use this method to send phone contacts. On success, the sent [Message] is returned.",
md_links: {"Message": "https://core.telegram.org/bots/api#message"},
),
tg_doc: "https://core.telegram.org/bots/api#sendcontact",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
Param(
name: "message_thread_id",
ty: Option(i32),
descr: Doc(md: "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"),
),
Param(
name: "phone_number",
ty: String,
descr: Doc(md: "Contact's phone number"),
),
Param(
name: "first_name",
ty: String,
descr: Doc(md: "Contact's first name"),
),
Param(
name: "last_name",
ty: Option(String),
descr: Doc(md: "Contact's last name")
),
Param(
name: "vcard",
ty: Option(String),
descr: Doc(
md: "Additional data about the contact in the form of a [vCard], 0-2048 bytes",
md_links: {"vCard": "https://en.wikipedia.org/wiki/VCard"}
)
),
Param(
name: "disable_notification",
ty: Option(bool),
descr: Doc(
md: "Sends the message [silently]. Users will receive a notification with no sound.",
md_links: {"silently": "https://telegram.org/blog/channels-2-0#silent-messages"}
)
),
Param(
name: "protect_content",
ty: Option(bool),
descr: Doc(md: "Protects the contents of sent messages from forwarding and saving"),
),
Param(
name: "reply_to_message_id",
ty: Option(RawTy("MessageId")),
descr: Doc(md: "If the message is a reply, ID of the original message")
),
Param(
name: "allow_sending_without_reply",
ty: Option(bool),
descr: Doc(md: "Pass _True_, if the message should be sent even if the specified replied-to message is not found")
),
Param(
name: "reply_markup",
ty: Option(RawTy("ReplyMarkup")),
descr: Doc(
md: "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.",
md_links: {
"inline keyboard": "https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating",
"custom reply keyboard": "https://core.telegram.org/bots#keyboards",
}
),
),
],
),
Method(
names: ("sendPoll", "SendPoll", "send_poll"),
return_ty: RawTy("Message"),
doc: Doc(
md: "Use this method to send phone contacts. On success, the sent [Message] is returned.",
md_links: {"Message": "https://core.telegram.org/bots/api#message"},
),
tg_doc: "https://core.telegram.org/bots/api#sendpoll",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
Param(
name: "message_thread_id",
ty: Option(i32),
descr: Doc(md: "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"),
),
Param(
name: "question",
ty: String,
descr: Doc(md: "Poll question, 1-300 characters"),
),
Param(
name: "options",
ty: ArrayOf(String),
descr: Doc(md: "A JSON-serialized list of answer options, 2-10 strings 1-100 characters each"),
),
Param(
name: "is_anonymous",
ty: Option(bool),
descr: Doc(md: "True, if the poll needs to be anonymous, defaults to True")
),
Param(
name: "type",
ty: Option(RawTy("PollType")),
descr: Doc(md: "Poll type, “quiz” or “regular”, defaults to “regular”")
),
Param(
name: "allows_multiple_answers",
ty: Option(bool),
descr: Doc(md: "True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False")
),
Param(
name: "correct_option_id",
ty: Option(u8),
descr: Doc(md: "0-based identifier of the correct answer option, required for polls in quiz mode")
),
Param(
name: "explanation",
ty: Option(String),
descr: Doc(md: "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")
),
Param(
name: "explanation_parse_mode",
ty: Option(RawTy("ParseMode")),
descr: Doc(
md: "Mode for parsing entities in the message text. See [formatting options] for more details.",
md_links: {"formatting options": "https://core.telegram.org/bots/api#formatting-options"}
)
),
Param(
name: "explanation_entities",
ty: Option(ArrayOf(RawTy("MessageEntity"))),
descr: Doc(md: "List of special entities that appear in the poll explanation, which can be specified instead of _parse\\_mode_"),
),
Param(
name: "open_period",
ty: Option(u16),
descr: Doc(md: "Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with close_date.")
),
Param(
name: "close_date",
ty: Option(u64),
descr: Doc(md: "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.")
),
Param(
name: "is_closed",
ty: Option(bool),
descr: Doc(md: "Pass True, if the poll needs to be immediately closed. This can be useful for poll preview.")
),
Param(
name: "disable_notification",
ty: Option(bool),
descr: Doc(
md: "Sends the message [silently]. Users will receive a notification with no sound.",
md_links: {"silently": "https://telegram.org/blog/channels-2-0#silent-messages"}
)
),
Param(
name: "protect_content",
ty: Option(bool),
descr: Doc(md: "Protects the contents of sent messages from forwarding and saving"),
),
Param(
name: "reply_to_message_id",
ty: Option(RawTy("MessageId")),
descr: Doc(md: "If the message is a reply, ID of the original message")
),
Param(
name: "allow_sending_without_reply",
ty: Option(bool),
descr: Doc(md: "Pass _True_, if the message should be sent even if the specified replied-to message is not found")
),
Param(
name: "reply_markup",
ty: Option(RawTy("ReplyMarkup")),
descr: Doc(
md: "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.",
md_links: {
"inline keyboard": "https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating",
"custom reply keyboard": "https://core.telegram.org/bots#keyboards",
}
),
),
],
),
Method(
names: ("sendDice", "SendDice", "send_dice"),
return_ty: RawTy("Message"),
doc: Doc(
md: "Use this method to send an animated emoji that will display a random value. On success, the sent [Message] is returned.",
md_links: {"Message": "https://core.telegram.org/bots/api#message"},
),
tg_doc: "https://core.telegram.org/bots/api#senddice",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
Param(
name: "message_thread_id",
ty: Option(i32),
descr: Doc(md: "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"),
),
Param(
name: "emoji",
ty: Option(RawTy("DiceEmoji")),
descr: Doc(md: "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 “🎲”"),
),
Param(
name: "disable_notification",
ty: Option(bool),
descr: Doc(
md: "Sends the message [silently]. Users will receive a notification with no sound.",
md_links: {"silently": "https://telegram.org/blog/channels-2-0#silent-messages"}
)
),
Param(
name: "protect_content",
ty: Option(bool),
descr: Doc(md: "Protects the contents of sent messages from forwarding and saving"),
),
Param(
name: "reply_to_message_id",
ty: Option(RawTy("MessageId")),
descr: Doc(md: "If the message is a reply, ID of the original message")
),
Param(
name: "allow_sending_without_reply",
ty: Option(bool),
descr: Doc(md: "Pass _True_, if the message should be sent even if the specified replied-to message is not found")
),
Param(
name: "reply_markup",
ty: Option(RawTy("ReplyMarkup")),
descr: Doc(
md: "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.",
md_links: {
"inline keyboard": "https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating",
"custom reply keyboard": "https://core.telegram.org/bots#keyboards",
}
),
),
],
),
Method(
names: ("sendChatAction", "SendChatAction", "send_chat_action"),
return_ty: True,
doc: Doc(
md: "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.\n\n> 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.\n\nWe only recommend using this method when a response from the bot will take a **noticeable** amount of time to arrive.",
md_links: {"ImageBot": "https://t.me/imagebot"},
),
tg_doc: "https://core.telegram.org/bots/api#sendchataction",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
Param(
name: "action",
ty: RawTy("ChatAction"),
descr: Doc(
md: "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_audio or upload_audio for [audio files], upload_document for [general files], choose_sticker for [stickers], find_location for [location data], record_video_note or upload_video_note for [video notes].",
md_links: {
"text messages": "https://core.telegram.org/bots/api#sendmessage",
"photos": "https://core.telegram.org/bots/api#sendphoto",
"videos": "https://core.telegram.org/bots/api#sendvideo",
"audio files": "https://core.telegram.org/bots/api#sendaudio",
"general files": "https://core.telegram.org/bots/api#senddocument",
"stickers": "https://core.telegram.org/bots/api#sendsticker",
"location data": "https://core.telegram.org/bots/api#sendlocation",
"video notes": "https://core.telegram.org/bots/api#sendvideonote",
}
),
),
Param(
name: "message_thread_id",
ty: Option(i32),
descr: Doc(md: "Unique identifier for the target message thread; supergroups only")
),
],
),
Method(
names: ("getUserProfilePhotos", "GetUserProfilePhotos", "get_user_profile_photos"),
return_ty: RawTy("UserProfilePhotos"),
doc: Doc(
md: "Use this method to get a list of profile pictures for a user. Returns a [UserProfilePhotos] object.",
md_links: {"UserProfilePhotos": "https://core.telegram.org/bots/api#userprofilephotos"},
),
tg_doc: "https://core.telegram.org/bots/api#getuserprofilephotos",
tg_category: "Available methods",
params: [
Param(
name: "user_id",
ty: RawTy("UserId"),
descr: Doc(md: "Unique identifier of the target user")
),
Param(
name: "offset",
ty: Option(u32),
descr: Doc(md: "Sequential number of the first photo to be returned. By default, all photos are returned.")
),
Param(
name: "limit",
ty: Option(u8),
descr: Doc(md: "Limits the number of photos to be retrieved. Values between 1-100 are accepted. Defaults to 100.")
),
],
),
Method(
names: ("getFile", "GetFile", "get_file"),
return_ty: RawTy("File"),
doc: Doc(
md: "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<token>/<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.",
md_links: {
"File": "https://core.telegram.org/bots/api#file",
"getFile": "https://core.telegram.org/bots/api#getfile",
},
),
tg_doc: "https://core.telegram.org/bots/api#getuserprofilephotos",
tg_category: "Available methods",
params: [
Param(
name: "file_id",
ty: String,
descr: Doc(md: "File identifier to get info about")
),
],
),
Method(
names: ("banChatMember", "BanChatMember", "ban_chat_member"),
return_ty: True,
doc: Doc(
md: "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 admin rights. Returns _True_ on success.",
md_links: {"unbanned": "https://core.telegram.org/bots/api#unbanchatmember"},
),
tg_doc: "https://core.telegram.org/bots/api#kickchatmember",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
Param(
name: "user_id",
ty: RawTy("UserId"),
descr: Doc(md: "Unique identifier of the target user")
),
Param(
name: "until_date",
ty: Option(u64),
descr: Doc(md: "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")
),
Param(
name: "revoke_messages",
ty: Option(bool),
descr: Doc(md: "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.")
),
],
),
// deprecated
Method(
names: ("kickChatMember", "KickChatMember", "kick_chat_member"),
return_ty: True,
doc: Doc(
md: "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.",
md_links: {"unbanned": "https://core.telegram.org/bots/api#unbanchatmember"},
),
tg_doc: "https://core.telegram.org/bots/api#kickchatmember",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
Param(
name: "user_id",
ty: RawTy("UserId"),
descr: Doc(md: "Unique identifier of the target user")
),
Param(
name: "until_date",
ty: Option(u64),
descr: Doc(md: "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")
),
Param(
name: "revoke_messages",
ty: Option(bool),
descr: Doc(md: "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.")
),
],
),
Method(
names: ("unbanChatMember", "UnbanChatMember", "unban_chat_member"),
return_ty: True,
doc: Doc(md: "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. 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."),
tg_doc: "https://core.telegram.org/bots/api#unbanchatmember",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
Param(
name: "user_id",
ty: RawTy("UserId"),
descr: Doc(md: "Unique identifier of the target user")
),
Param(
name: "only_if_banned",
ty: Option(bool),
descr: Doc(md: "Do nothing if the user is not banned"),
)
],
),
Method(
names: ("restrictChatMember", "RestrictChatMember", "restrict_chat_member"),
return_ty: True,
doc: Doc(md: "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 permissions to lift restrictions from a user. Returns _True_ on success."),
tg_doc: "https://core.telegram.org/bots/api#restrictchatmember",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
Param(
name: "user_id",
ty: RawTy("UserId"),
descr: Doc(md: "Unique identifier of the target user")
),
Param(
name: "permissions",
ty: RawTy("ChatPermissions"),
descr: Doc(md: "A JSON-serialized object for new user permissions")
),
Param(
name: "until_date",
ty: Option(u64),
descr: Doc(md: "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")
),
],
),
Method(
names: ("promoteChatMember", "PromoteChatMember", "promote_chat_member"),
return_ty: True,
doc: Doc(md: "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."),
tg_doc: "https://core.telegram.org/bots/api#promotechatmember",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
Param(
name: "user_id",
ty: RawTy("UserId"),
descr: Doc(md: "Unique identifier of the target user")
),
Param(
name: "is_anonymous",
ty: Option(bool),
descr: Doc(md: "Pass True, if the administrator's presence in the chat is hidden")
),
Param(
name: "can_manage_chat",
ty: Option(bool),
descr: Doc(md: "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"),
),
Param(
name: "can_post_messages",
ty: Option(bool),
descr: Doc(md: "Pass True, if the administrator can create channel posts, channels only")
),
Param(
name: "can_edit_messages",
ty: Option(bool),
descr: Doc(md: "Pass True, if the administrator can edit messages of other users and can pin messages, channels only")
),
Param(
name: "can_delete_messages",
ty: Option(bool),
descr: Doc(md: "Pass True, if the administrator can delete messages of other users")
),
Param(
name: "can_manage_video_chats",
ty: Option(bool),
descr: Doc(md: "Pass True, if the administrator can manage video chats, supergroups only")
),
Param(
name: "can_restrict_members",
ty: Option(bool),
descr: Doc(md: "Pass True, if the administrator can restrict, ban or unban chat members")
),
Param(
name: "can_promote_members",
ty: Option(bool),
descr: Doc(md: "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)")
),
Param(
name: "can_change_info",
ty: Option(bool),
descr: Doc(md: "Pass True, if the administrator can change chat title, photo and other settings")
),
Param(
name: "can_invite_users",
ty: Option(bool),
descr: Doc(md: "Pass True, if the administrator can invite new users to the chat")
),
Param(
name: "can_pin_messages",
ty: Option(bool),
descr: Doc(md: "Pass True, if the administrator can pin messages, supergroups only")
),
Param(
name: "can_manage_topics",
ty: Option(bool),
descr: Doc(md: "Pass True if the user is allowed to create, rename, close, and reopen forum topics, supergroups only")
),
],
),
Method(
names: ("setChatAdministratorCustomTitle", "SetChatAdministratorCustomTitle", "set_chat_administrator_custom_title"),
return_ty: True,
doc: Doc(md: "Use this method to set a custom title for an administrator in a supergroup promoted by the bot. Returns _True_on success."),
tg_doc: "https://core.telegram.org/bots/api#setchatadministratorcustomtitle",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
Param(
name: "user_id",
ty: RawTy("UserId"),
descr: Doc(md: "Unique identifier of the target user")
),
Param(
name: "custom_title",
ty: String,
descr: Doc(md: "New custom title for the administrator; 0-16 characters, emoji are not allowed")
),
],
),
Method(
names: ("banChatSenderChat", "BanChatSenderChat", "ban_chat_sender_chat"),
return_ty: True,
doc: Doc(md: "Use this method to ban a channel chat in a supergroup or a channel. The owner of the chat will not be able to send messages and join live streams on behalf of the chat, unless it is unbanned first. The bot must be an administrator in the supergroup or channel for this to work and must have the appropriate administrator rights."),
tg_doc: "https://core.telegram.org/bots/api#banchatsenderchat",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
Param(
name: "sender_chat_id",
ty: RawTy("ChatId"),
descr: Doc(md: "Unique identifier of the target sender chat")
),
],
),
Method(
names: ("unbanChatSenderChat", "UnbanChatSenderChat", "unban_chat_sender_chat"),
return_ty: True,
doc: Doc(md: "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."),
tg_doc: "https://core.telegram.org/bots/api#unbanchatsenderchat",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
Param(
name: "sender_chat_id",
ty: RawTy("ChatId"),
descr: Doc(md: "Unique identifier of the target sender chat")
),
],
),
Method(
names: ("setChatPermissions", "SetChatPermissions", "set_chat_permissions"),
return_ty: True,
doc: Doc(md: "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_ admin rights. Returns _True_ on success."),
tg_doc: "https://core.telegram.org/bots/api#setchatpermissions",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
Param(
name: "permissions",
ty: RawTy("ChatPermissions"),
descr: Doc(md: "New default chat permissions")
),
],
),
Method(
names: ("exportChatInviteLink", "ExportChatInviteLink", "export_chat_invite_link"),
return_ty: String,
doc: Doc(md: "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.\n\n> Note: Each administrator in a chat generates their own invite links. Bots can't use invite links generated by other administrators. If you want your bot to work with invite links, it will need to generate its own link using exportChatInviteLink — after this the link will become available to the bot via the getChat method. If your bot needs to generate a new invite link replacing its previous one, use exportChatInviteLink again."),
tg_doc: "https://core.telegram.org/bots/api#exportchatinvitelink",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
],
),
Method(
names: ("createChatInviteLink", "CreateChatInviteLink", "create_chat_invite_link"),
return_ty: RawTy("ChatInviteLink"),
doc: Doc(
md: "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 admin rights. The link can be revoked using the method [revokeChatInviteLink]. Returns the new invite link as [ChatInviteLink] object.",
md_links: {
"revokeChatInviteLink": "https://core.telegram.org/bots/api#revokechatinvitelink",
"ChatInviteLink": "https://core.telegram.org/bots/api#chatinvitelink",
}
),
tg_doc: "https://core.telegram.org/bots/api#createchatinvitelink",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
Param(
name: "name",
ty: Option(String),
descr: Doc(md: "Invite link name; 0-32 characters")
),
Param(
name: "expire_date",
ty: Option(i64),
descr: Doc(md: "Point in time (Unix timestamp) when the link will expire")
),
Param(
name: "member_limit",
ty: Option(u32),
descr: Doc(md: "Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999")
),
Param(
name: "creates_join_request",
ty: Option(bool) ,
descr: Doc(md: "True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified")
),
],
),
Method(
names: ("editChatInviteLink", "EditChatInviteLink", "edit_chat_invite_link"),
return_ty: String,
doc: Doc(
md: "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 admin rights. Returns the edited invite link as a [ChatInviteLink] object.",
md_links: {"ChatInviteLink": "https://core.telegram.org/bots/api#chatinvitelink"}
),
tg_doc: "https://core.telegram.org/bots/api#editchatinvitelink",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
Param(
name: "invite_link",
ty: String,
descr: Doc(md: "The invite link to edit")
),
Param(
name: "name",
ty: Option(String),
descr: Doc(md: "Invite link name; 0-32 characters")
),
Param(
name: "expire_date",
ty: Option(i64),
descr: Doc(md: "Point in time (Unix timestamp) when the link will expire")
),
Param(
name: "member_limit",
ty: Option(u32),
descr: Doc(md: "Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999")
),
Param(
name: "creates_join_request",
ty: Option(bool) ,
descr: Doc(md: "True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can't be specified")
),
],
),
Method(
names: ("revokeChatInviteLink", "RevokeChatInviteLink", "revoke_chat_invite_link"),
return_ty: String,
doc: Doc(
md: "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 admin rights. Returns the revoked invite link as [ChatInviteLink] object.",
md_links: {"ChatInviteLink": "https://core.telegram.org/bots/api#chatinvitelink"}
),
tg_doc: "https://core.telegram.org/bots/api#editchatinvitelink",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
Param(
name: "invite_link",
ty: String,
descr: Doc(md: "The invite link to revoke")
),
],
),
Method(
names: ("approveChatJoinRequest", "ApproveChatJoinRequest", "approve_chat_join_request"),
return_ty: True,
doc: Doc(md: "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."),
tg_doc: "https://core.telegram.org/bots/api#approvechatjoinrequest",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
Param(
name: "user_id",
ty: RawTy("UserId"),
descr: Doc(md: "Unique identifier of the target user")
),
],
),
Method(
names: ("declineChatJoinRequest", "DeclineChatJoinRequest", "decline_chat_join_request"),
return_ty: True,
doc: Doc(md: "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."),
tg_doc: "https://core.telegram.org/bots/api#declinechatjoinrequest",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
Param(
name: "user_id",
ty: RawTy("UserId"),
descr: Doc(md: "Unique identifier of the target user")
),
],
),
Method(
names: ("setChatPhoto", "SetChatPhoto", "set_chat_photo"),
return_ty: True,
doc: Doc(md: "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."),
tg_doc: "https://core.telegram.org/bots/api#setchatphoto",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
Param(
name: "photo",
ty: RawTy("InputFile"),
descr: Doc(md: "New chat photo, uploaded using multipart/form-data")
),
],
),
Method(
names: ("deleteChatPhoto", "DeleteChatPhoto", "delete_chat_photo"),
return_ty: String,
doc: Doc(md: "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."),
tg_doc: "https://core.telegram.org/bots/api#deletechatphoto",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
],
),
Method(
names: ("setChatTitle", "SetChatTitle", "set_chat_title"),
return_ty: True,
doc: Doc(md: "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."),
tg_doc: "https://core.telegram.org/bots/api#setchattitle",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
Param(
name: "title",
ty: String,
descr: Doc(md: "New chat title, 1-255 characters")
),
],
),
Method(
names: ("setChatDescription", "SetChatDescription", "set_chat_description"),
return_ty: True,
doc: Doc(md: "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 admin rights. Returns _True_ on success."),
tg_doc: "https://core.telegram.org/bots/api#setchatdescription",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
Param(
name: "description",
ty: Option(String),
descr: Doc(md: "New chat description, 0-255 characters")
),
],
),
Method(
names: ("pinChatMessage", "PinChatMessage", "pin_chat_message"),
return_ty: True,
doc: Doc(md: "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."),
tg_doc: "https://core.telegram.org/bots/api#pinchatmessage",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
Param(
name: "message_id",
ty: RawTy("MessageId"),
descr: Doc(md: "Identifier of a message to pin"),
),
Param(
name: "disable_notification",
ty: Option(bool),
descr: Doc(md: "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.")
),
],
),
Method(
names: ("unpinChatMessage", "UnpinChatMessage", "unpin_chat_message"),
return_ty: True,
doc: Doc(md: "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' admin right in a supergroup or 'can_edit_messages' admin right in a channel. Returns _True_ on success."),
tg_doc: "https://core.telegram.org/bots/api#unpinchatmessage",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
Param(
name: "message_id",
ty: Option(RawTy("MessageId")),
descr: Doc(md: "Identifier of a message to unpin. If not specified, the most recent pinned message (by sending date) will be unpinned.")
),
],
),
Method(
names: ("unpinAllChatMessages", "UnpinAllChatMessages", "unpin_all_chat_messages"),
return_ty: True,
doc: Doc(md: "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' admin right in a supergroup or 'can_edit_messages' admin right in a channel. Returns _True_ on success."),
tg_doc: "https://core.telegram.org/bots/api#unpinallchatmessages",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
],
),
Method(
names: ("leaveChat", "LeaveChat", "leave_chat"),
return_ty: True,
doc: Doc(md: "Use this method for your bot to leave a group, supergroup or channel. Returns _True_ on success."),
tg_doc: "https://core.telegram.org/bots/api#leavechat",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
],
),
Method(
names: ("getChat", "GetChat", "get_chat"),
return_ty: RawTy("Chat"),
doc: Doc(
md: "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.",
md_links: {"Chat": "https://core.telegram.org/bots/api#chat"},
),
tg_doc: "https://core.telegram.org/bots/api#getchat",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
],
),
Method(
names: ("getChatAdministrators", "GetChatAdministrators", "get_chat_administrators"),
return_ty: ArrayOf(RawTy("ChatMember")),
doc: Doc(
md: "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.",
md_links: {"ChatMember": "https://core.telegram.org/bots/api#chatmember"},
),
tg_doc: "https://core.telegram.org/bots/api#getchatadministrators",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
],
),
Method(
names: ("getChatMemberCount", "GetChatMemberCount", "get_chat_member_count"),
return_ty: u32,
doc: Doc(md: "Use this method to get the number of members in a chat. Returns _Int_ on success."),
tg_doc: "https://core.telegram.org/bots/api#getchatmemberscount",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
],
),
// deprecated
Method(
names: ("getChatMembersCount", "GetChatMembersCount", "get_chat_members_count"),
return_ty: u32,
doc: Doc(md: "Use this method to get the number of members in a chat. Returns _Int_ on success."),
tg_doc: "https://core.telegram.org/bots/api#getchatmemberscount",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
],
),
Method(
names: ("getChatMember", "GetChatMember", "get_chat_member"),
return_ty: RawTy("ChatMember"),
doc: Doc(
md: "Use this method to get information about a member of a chat. Returns a [ChatMember] object on success.",
md_links: {"ChatMember": "https://core.telegram.org/bots/api#chatmember"}
),
tg_doc: "https://core.telegram.org/bots/api#getchatmember",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
Param(
name: "user_id",
ty: RawTy("UserId"),
descr: Doc(md: "Unique identifier of the target user")
),
],
),
Method(
names: ("setChatStickerSet", "SetChatStickerSet", "set_chat_sticker_set"),
return_ty: True,
doc: Doc(md: "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."),
tg_doc: "https://core.telegram.org/bots/api#set_chat_sticker_set",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
Param(
name: "sticker_set_name",
ty: String,
descr: Doc(md: "Name of the sticker set to be set as the group sticker set")
),
],
),
Method(
names: ("deleteChatStickerSet", "DeleteChatStickerSet", "delete_chat_sticker_set"),
return_ty: True,
doc: Doc(
md: "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.",
md_links: {"getChat": "https://core.telegram.org/bots/api#getchat"}
),
tg_doc: "https://core.telegram.org/bots/api#deletechatstickerset",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
],
),
Method(
names: ("getForumTopicIconStickers", "GetForumTopicIconStickers", "get_forum_topic_icon_stickers"),
return_ty: ArrayOf(RawTy("Sticker")),
doc: Doc(md: "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 Array of `Sticker` objects."),
tg_doc: "https://core.telegram.org/bots/api#getforumtopiciconstickers",
tg_category: "Available methods",
params: [],
),
Method(
names: ("createForumTopic", "CreateForumTopic", "create_forum_topic"),
return_ty: RawTy("ForumTopic"),
doc: Doc(md: "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."),
tg_doc: "https://core.telegram.org/bots/api#createforumtopic",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
Param(
name: "name",
ty: String,
descr: Doc(md: "Topic name, 1-128 characters")
),
Param(
name: "icon_color",
// FIXME: use an Rgb or something
ty: u32,
descr: Doc(md: "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)")
),
Param(
name: "icon_custom_emoji_id",
ty: String,
descr: Doc(md: "Unique identifier of the custom emoji shown as the topic icon. Use `getForumTopicIconStickers` to get all allowed custom emoji identifiers.")
),
],
),
Method(
names: ("editForumTopic", "EditForumTopic", "edit_forum_topic"),
return_ty: True,
doc: Doc(md: "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."),
tg_doc: "https://core.telegram.org/bots/api#editforumtopic",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
Param(
name: "message_thread_id",
ty: i32,
descr: Doc(md: "Unique identifier for the target message thread of the forum topic"),
),
Param(
name: "name",
ty: Option(String),
descr: Doc(md: "Topic name, 0-128 characters. If not specified or empty, the current name of the topic will be kept")
),
Param(
name: "icon_custom_emoji_id",
ty: Option(String),
descr: Doc(md: "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")
),
],
),
Method(
names: ("closeForumTopic", "CloseForumTopic", "close_forum_topic"),
return_ty: True,
doc: Doc(md: "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."),
tg_doc: "https://core.telegram.org/bots/api#closeforumtopic",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
Param(
name: "message_thread_id",
ty: i32,
descr: Doc(md: "Unique identifier for the target message thread of the forum topic"),
),
],
),
Method(
names: ("reopenForumTopic", "ReopenForumTopic", "reopen_forum_topic"),
return_ty: True,
doc: Doc(md: "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."),
tg_doc: "https://core.telegram.org/bots/api#reopenforumtopic",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
Param(
name: "message_thread_id",
ty: i32,
descr: Doc(md: "Unique identifier for the target message thread of the forum topic"),
),
],
),
Method(
names: ("deleteForumTopic", "DeleteForumTopic", "delete_forum_topic"),
return_ty: True,
doc: Doc(md: "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."),
tg_doc: "https://core.telegram.org/bots/api#deleteforumtopic",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
Param(
name: "message_thread_id",
ty: i32,
descr: Doc(md: "Unique identifier for the target message thread of the forum topic"),
),
],
),
Method(
names: ("unpinAllForumTopicMessages", "UnpinAllForumTopicMessages", "unpin_all_forum_topic_messages"),
return_ty: True,
doc: Doc(md: "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."),
tg_doc: "https://core.telegram.org/bots/api#unpinallforumtopicmessages",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
Param(
name: "message_thread_id",
ty: i32,
descr: Doc(md: "Unique identifier for the target message thread of the forum topic"),
),
],
),
Method(
names: ("editGeneralForumTopic", "EditGeneralForumTopic", "edit_general_forum_topic"),
return_ty: True,
doc: Doc(md: "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."),
tg_doc: "https://core.telegram.org/bots/api#editgeneralforumtopic",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
Param(
name: "name",
ty: String,
descr: Doc(md: "New topic name, 1-128 characters"),
),
],
),
Method(
names: ("closeGeneralForumTopic", "CloseGeneralForumTopic", "close_general_forum_topic"),
return_ty: True,
doc: Doc(md: "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."),
tg_doc: "https://core.telegram.org/bots/api#closegeneralforumtopic",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
],
),
Method(
names: ("reopenGeneralForumTopic", "ReopenGeneralForumTopic", "reopen_general_forum_topic"),
return_ty: True,
doc: Doc(md: "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."),
tg_doc: "https://core.telegram.org/bots/api#reopengeneralforumtopic",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
],
),
Method(
names: ("hideGeneralForumTopic", "HideGeneralForumTopic", "hide_general_forum_topic"),
return_ty: True,
doc: Doc(md: "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."),
tg_doc: "https://core.telegram.org/bots/api#hidegeneralforumtopic",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
],
),
Method(
names: ("unhideGeneralForumTopic", "UnhideGeneralForumTopic", "unhide_general_forum_topic"),
return_ty: True,
doc: Doc(md: "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."),
tg_doc: "https://core.telegram.org/bots/api#unhidegeneralforumtopic",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)")
),
],
),
Method(
names: ("answerCallbackQuery", "AnswerCallbackQuery", "answer_callback_query"),
return_ty: True,
doc: Doc(
md: "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.\n\n>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.",
md_links: {
"inline keyboards": "https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating",
"@Botfather": "https://t.me/botfather",
}
),
tg_doc: "https://core.telegram.org/bots/api#answercallbackquery",
tg_category: "Available methods",
params: [
Param(
name: "callback_query_id",
ty: String,
descr: Doc(md: "Unique identifier for the query to be answered"),
),
Param(
name: "text",
ty: Option(String),
descr: Doc(md: "Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters"),
),
Param(
name: "show_alert",
ty: Option(bool),
descr: Doc(md: "If true, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to false."),
),
Param(
name: "url",
ty: Option(String),
descr: Doc(
md: "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.\n\nOtherwise, you may use links like `t.me/your\\_bot?start=XXXX` that open your bot with a parameter.",
md_links: {
"Game": "https://core.telegram.org/bots/api#game",
"@Botfather": "https://t.me/botfather",
"callback_game": "https://core.telegram.org/bots/api#inlinekeyboardbutton",
},
),
),
Param(
name: "cache_time",
ty: Option(u32),
descr: Doc(md: "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."),
),
],
),
Method(
names: ("setMyCommands", "SetMyCommands", "set_my_commands"),
return_ty: True,
doc: Doc(md: "Use this method to change the list of the bot's commands. Returns _True_ on success."),
tg_doc: "https://core.telegram.org/bots/api#setmycommands",
tg_category: "Available methods",
params: [
Param(
name: "commands",
ty: ArrayOf(RawTy("BotCommand")),
descr: Doc(md: "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.")
),
Param(
name: "scope",
ty: Option(RawTy("BotCommandScope")),
descr: Doc(md: "A JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to BotCommandScopeDefault.")
),
Param(
name: "language_code",
ty: Option(String),
descr: Doc(md: "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")
),
],
),
Method(
names: ("getMyCommands", "GetMyCommands", "get_my_commands"),
return_ty: ArrayOf(RawTy("BotCommand")),
doc: Doc(
md: "Use this method to get the current list of the bot's commands. Requires no parameters. Returns Array of [BotCommand] on success.",
md_links: {"BotCommand": "https://core.telegram.org/bots/api#botcommand"},
),
tg_doc: "https://core.telegram.org/bots/api#getmycommands",
tg_category: "Available methods",
params: [
Param(
name: "scope",
ty: Option(RawTy("BotCommandScope")),
descr: Doc(md: "A JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to BotCommandScopeDefault.")
),
Param(
name: "language_code",
ty: Option(String),
descr: Doc(md: "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")
),
],
),
Method(
names: ("setChatMenuButton", "SetChatMenuButton", "set_chat_menu_button"),
return_ty: True,
doc: Doc(md: "Use this method to change the bot's menu button in a private chat, or the default menu button."),
tg_doc: "https://core.telegram.org/bots/api#setchatmenubutton",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: Option(RawTy("ChatId")),
descr: Doc(md: "Unique identifier for the target private chat. If not specified, default bot's menu button will be changed."),
),
Param(
name: "menu_button",
ty: Option(RawTy("MenuButton")),
descr: Doc(md: "An object for the new bot's menu button. Defaults to MenuButtonDefault"),
)
]
),
Method(
names: ("getChatMenuButton", "GetChatMenuButton", "get_chat_menu_button"),
return_ty: RawTy("MenuButton"),
doc: Doc(md: "Use this method to get the current value of the bot's menu button in a private chat, or the default menu button."),
tg_doc: "https://core.telegram.org/bots/api#getchatmenubutton",
tg_category: "Available methods",
params: [
Param(
name: "chat_id",
ty: Option(RawTy("ChatId")),
descr: Doc(md: "Unique identifier for the target private chat. If not specified, default bot's menu button will be returned"),
),
]
),
Method(
names: ("setMyDefaultAdministratorRights", "SetMyDefaultAdministratorRights", "set_my_default_administrator_rights"),
return_ty: True,
doc: Doc(md: "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."),
tg_doc: "https://core.telegram.org/bots/api#setmydefaultadministratorrights",
tg_category: "Available methods",
params: [
Param(
name: "rights",
ty: Option(RawTy("ChatAdministratorRights")),
descr: Doc(md: "A JSON-serialized object describing new default administrator rights. If not specified, the default administrator rights will be cleared."),
),
Param(
name: "for_channels",
ty: Option(bool),
descr: Doc(md: "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."),
)
]
),
Method(
names: ("getMyDefaultAdministratorRights", "GetMyDefaultAdministratorRights", "get_my_default_administrator_rights"),
return_ty: RawTy("ChatAdministratorRights"),
doc: Doc(md: "Use this method to get the current value of the bot's menu button in a private chat, or the default menu button."),
tg_doc: "https://core.telegram.org/bots/api#setmydefaultadministratorrights",
tg_category: "Available methods",
params: [
Param(
name: "for_channels",
ty: Option(bool),
descr: Doc(md: "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."),
)
]
),
Method(
names: ("deleteMyCommands", "DeleteMyCommands", "delete_my_commands"),
return_ty: True,
doc: Doc(
md: "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.",
md_links: {"higher level commands":"https://core.telegram.org/bots/api#determining-list-of-commands"},
),
tg_doc: "https://core.telegram.org/bots/api#deletemycommands",
tg_category: "Available methods",
params: [
Param(
name: "scope",
ty: Option(RawTy("BotCommandScope")),
descr: Doc(md: "A JSON-serialized object, describing scope of users for which the commands are relevant. Defaults to BotCommandScopeDefault.")
),
Param(
name: "language_code",
ty: Option(String),
descr: Doc(md: "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")
),
],
),
Method(
names: ("answerInlineQuery", "AnswerInlineQuery", "answer_inline_query"),
return_ty: True,
doc: Doc(md: "Use this method to send answers to an inline query. On success, _True_ is returned. No more than **50** results per query are allowed."),
tg_doc: "https://core.telegram.org/bots/api#answerinlinequery",
tg_category: "Inline Mode",
params: [
Param(
name: "inline_query_id",
ty: String,
descr: Doc(md: "Unique identifier for the answered query")
),
Param(
name: "results",
ty: ArrayOf(RawTy("InlineQueryResult")),
descr: Doc(md: "A JSON-serialized array of results for the inline query")
),
Param(
name: "cache_time",
ty: Option(u32),
descr: Doc(md: "The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300.")
),
Param(
name: "is_personal",
ty: Option(bool),
descr: Doc(md: "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")
),
Param(
name: "next_offset",
ty: Option(String),
descr: Doc(md: "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.")
),
Param(
name: "switch_pm_text",
ty: Option(String),
descr: Doc(md: "If passed, clients will display a button with specified text that switches the user to a private chat with the bot and sends the bot a start message with the parameter switch_pm_parameter")
),
Param(
name: "switch_pm_parameter",
ty: Option(String),
descr: Doc(
md: "[Deep-linking] parameter for the /start message sent to the bot when user presses the switch button. 1-64 characters, only `A-Z`, `a-z`, `0-9`, `_` and `-` are allowed.\n\n_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.",
md_links: {
"Deep-linking": "https://core.telegram.org/bots#deep-linking",
"switch_inline": "https://core.telegram.org/bots/api#inlinekeyboardmarkup",
},
),
),
],
),
Method(
names: ("answerWebAppQuery", "AnswerWebAppQuery", "answer_web_app_query"),
return_ty: RawTy("SentWebAppMessage"),
doc: Doc(
md: "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.",
md_links: {"Web App": "https://core.telegram.org/bots/webapps"}
),
tg_doc: "https://core.telegram.org/bots/api#answerwebappquery",
tg_category: "Inline Mode",
params: [
Param(
name: "web_app_query_id",
ty: String,
descr: Doc(md: "Unique identifier for the query to be answered")
),
Param(
name :"result",
ty: RawTy("InlineQueryResult"),
descr: Doc(md: "A JSON-serialized object describing the message to be sent"),
),
]
),
Method(
names: ("editMessageText", "EditMessageText", "edit_message_text"),
return_ty: RawTy("Message"),
doc: Doc(
md: "Use this method to edit text and [games] messages. On success, the edited Message is returned.",
md_links: {"games": "https://core.telegram.org/bots/api#games"},
),
tg_doc: "https://core.telegram.org/bots/api#editmessagetext",
tg_category: "Updating messages",
sibling: Some("editMessageTextInline"),
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`).")
),
Param(
name: "message_id",
ty: RawTy("MessageId"),
descr: Doc(md: "Identifier of the message to edit")
),
Param(
name: "text",
ty: String,
descr: Doc(md: "New text of the message, 1-4096 characters after entities parsing")
),
Param(
name: "parse_mode",
ty: Option(RawTy("ParseMode")),
descr: Doc(
md: "Mode for parsing entities in the message text. See [formatting options] for more details.",
md_links: {"formatting options": "https://core.telegram.org/bots/api#formatting-options"}
)
),
Param(
name: "entities",
ty: Option(ArrayOf(RawTy("MessageEntity"))),
descr: Doc(md: "List of special entities that appear in message text, which can be specified instead of _parse\\_mode_"),
),
Param(
name: "disable_web_page_preview",
ty: Option(bool),
descr: Doc(md: "Disables link previews for links in this message")
),
Param(
name: "reply_markup",
ty: Option(RawTy("InlineKeyboardMarkup")),
descr: Doc(
md: "A JSON-serialized object for an [inline keyboard].",
md_links: {"inline keyboard": "https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating"},
),
),
],
),
Method(
names: ("editMessageTextInline", "EditMessageTextInline", "edit_message_text_inline"),
return_ty: True,
doc: Doc(
md: "Use this method to edit text and [games] messages. On success, _True_ is returned.",
md_links: {"games": "https://core.telegram.org/bots/api#games"},
),
tg_doc: "https://core.telegram.org/bots/api#editmessagetext",
tg_category: "Updating messages",
sibling: Some("editMessageText"),
params: [
Param(
name: "inline_message_id",
ty: String,
descr: Doc(md: "Identifier of the inline message")
),
Param(
name: "text",
ty: String,
descr: Doc(md: "New text of the message, 1-4096 characters after entities parsing")
),
Param(
name: "parse_mode",
ty: Option(RawTy("ParseMode")),
descr: Doc(
md: "Mode for parsing entities in the message text. See [formatting options] for more details.",
md_links: {"formatting options": "https://core.telegram.org/bots/api#formatting-options"}
)
),
Param(
name: "entities",
ty: Option(ArrayOf(RawTy("MessageEntity"))),
descr: Doc(md: "List of special entities that appear in message text, which can be specified instead of _parse\\_mode_"),
),
Param(
name: "disable_web_page_preview",
ty: Option(bool),
descr: Doc(md: "Disables link previews for links in this message")
),
Param(
name: "reply_markup",
ty: Option(RawTy("InlineKeyboardMarkup")),
descr: Doc(
md: "A JSON-serialized object for an [inline keyboard].",
md_links: {"inline keyboard": "https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating"}
),
),
],
),
Method(
names: ("editMessageCaption", "EditMessageCaption", "edit_message_caption"),
return_ty: RawTy("Message"),
doc: Doc(md: "Use this method to edit captions of messages. On success, the edited Message is returned."),
tg_doc: "https://core.telegram.org/bots/api#editmessagecaption",
tg_category: "Updating messages",
sibling: Some("editMessageCaptionInline"),
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`).")
),
Param(
name: "message_id",
ty: RawTy("MessageId"),
descr: Doc(md: "Identifier of the message to edit")
),
Param(
name: "caption",
ty: Option(String),
descr: Doc(md: "New caption of the message, 0-1024 characters after entities parsing")
),
Param(
name: "parse_mode",
ty: Option(RawTy("ParseMode")),
descr: Doc(
md: "Mode for parsing entities in the message text. See [formatting options] for more details.",
md_links: {"formatting options": "https://core.telegram.org/bots/api#formatting-options"}
)
),
Param(
name: "caption_entities",
ty: Option(ArrayOf(RawTy("MessageEntity"))),
descr: Doc(md: "List of special entities that appear in the caption, which can be specified instead of _parse\\_mode_"),
),
Param(
name: "reply_markup",
ty: Option(RawTy("InlineKeyboardMarkup")),
descr: Doc(
md: "A JSON-serialized object for an [inline keyboard].",
md_links: {"inline keyboard": "https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating",}
),
),
],
),
Method(
names: ("editMessageCaptionInline", "EditMessageCaptionInline", "edit_message_caption_inline"),
return_ty: True,
doc: Doc(md: "Use this method to edit captions of messages. On success, _True_ is returned."),
tg_doc: "https://core.telegram.org/bots/api#editmessagetext",
tg_category: "Updating messages",
sibling: Some("editMessageCaption"),
params: [
Param(
name: "inline_message_id",
ty: String,
descr: Doc(md: "Identifier of the inline message")
),
Param(
name: "caption",
ty: Option(String),
descr: Doc(md: "New caption of the message, 0-1024 characters after entities parsing")
),
Param(
name: "parse_mode",
ty: Option(RawTy("ParseMode")),
descr: Doc(
md: "Mode for parsing entities in the message text. See [formatting options] for more details.",
md_links: {"formatting options": "https://core.telegram.org/bots/api#formatting-options"}
)
),
Param(
name: "caption_entities",
ty: Option(ArrayOf(RawTy("MessageEntity"))),
descr: Doc(md: "List of special entities that appear in the caption, which can be specified instead of _parse\\_mode_"),
),
Param(
name: "reply_markup",
ty: Option(RawTy("InlineKeyboardMarkup")),
descr: Doc(
md: "A JSON-serialized object for an [inline keyboard].",
md_links: {"inline keyboard": "https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating"}
),
),
],
),
Method(
names: ("editMessageMedia", "EditMessageMedia", "edit_message_media"),
return_ty: RawTy("Message"),
doc: Doc(md: "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, the edited Message is returned."),
tg_doc: "https://core.telegram.org/bots/api#editmessagemedia",
tg_category: "Updating messages",
sibling: Some("editMessageMediaInline"),
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`).")
),
Param(
name: "message_id",
ty: RawTy("MessageId"),
descr: Doc(md: "Identifier of the message to edit")
),
Param(
name: "media",
ty: RawTy("InputMedia"),
descr: Doc(md: "A JSON-serialized object for a new media content of the message")
),
Param(
name: "reply_markup",
ty: Option(RawTy("InlineKeyboardMarkup")),
descr: Doc(
md: "A JSON-serialized object for an [inline keyboard].",
md_links: {"inline keyboard": "https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating"}
),
),
],
),
Method(
names: ("editMessageMediaInline", "EditMessageMediaInline", "edit_message_media_inline"),
return_ty: True,
doc: Doc(md: "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, _True_ is returned."),
tg_doc: "https://core.telegram.org/bots/api#editmessagemediainline",
tg_category: "Updating messages",
sibling: Some("editMessageMedia"),
params: [
Param(
name: "inline_message_id",
ty: String,
descr: Doc(md: "Identifier of the inline message")
),
Param(
name: "media",
ty: RawTy("InputMedia"),
descr: Doc(md: "A JSON-serialized object for a new media content of the message")
),
Param(
name: "reply_markup",
ty: Option(RawTy("InlineKeyboardMarkup")),
descr: Doc(
md: "A JSON-serialized object for an [inline keyboard].",
md_links: {"inline keyboard": "https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating",}
),
),
],
),
Method(
names: ("editMessageReplyMarkup", "EditMessageReplyMarkup", "edit_message_reply_markup"),
return_ty: RawTy("Message"),
doc: Doc(md: "Use this method to edit only the reply markup of messages. On success, the edited Message is returned."),
tg_doc: "https://core.telegram.org/bots/api#editmessagereplymarkup",
tg_category: "Updating messages",
sibling: Some("editMessageMediaInline"),
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`).")
),
Param(
name: "message_id",
ty: RawTy("MessageId"),
descr: Doc(md: "Identifier of the message to edit")
),
Param(
name: "reply_markup",
ty: Option(RawTy("InlineKeyboardMarkup")),
descr: Doc(
md: "A JSON-serialized object for an [inline keyboard].",
md_links: {"inline keyboard": "https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating",}
),
),
],
),
Method(
names: ("editMessageReplyMarkupInline", "EditMessageReplyMarkupInline", "edit_message_reply_markup_inline"),
return_ty: True,
doc: Doc(md: "Use this method to edit only the reply markup of messages. On success, _True_ is returned."),
tg_doc: "https://core.telegram.org/bots/api#editmessagereplymarkup",
tg_category: "Updating messages",
sibling: Some("editMessageReplyMarkup"),
params: [
Param(
name: "inline_message_id",
ty: String,
descr: Doc(md: "Identifier of the inline message")
),
Param(
name: "reply_markup",
ty: Option(RawTy("InlineKeyboardMarkup")),
descr: Doc(
md: "A JSON-serialized object for an [inline keyboard].",
md_links: {"inline keyboard": "https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating",}
),
),
],
),
Method(
names: ("stopPoll", "StopPoll", "stop_poll"),
return_ty: RawTy("Poll"),
doc: Doc(md: "Use this method to stop a poll which was sent by the bot. On success, the stopped Poll with the final results is returned."),
tg_doc: "https://core.telegram.org/bots/api#stoppoll",
tg_category: "Updating messages",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`).")
),
Param(
name: "message_id",
ty: RawTy("MessageId"),
descr: Doc(md: "Identifier of the message to edit")
),
Param(
name: "reply_markup",
ty: Option(RawTy("InlineKeyboardMarkup")),
descr: Doc(
md: "A JSON-serialized object for an [inline keyboard].",
md_links: {"inline keyboard": "https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating",}
),
),
],
),
Method(
names: ("deleteMessage", "DeleteMessage", "delete_message"),
return_ty: True,
doc: Doc(md: "Use this method to delete a message, including service messages, with the following limitations:\n- A message can only be deleted if it was sent less than 48 hours ago.\n- A dice message in a private chat can only be deleted if it was sent more than 24 hours ago.\n- Bots can delete outgoing messages in private chats, groups, and supergroups.\n- Bots can delete incoming messages in private chats.\n- Bots granted can_post_messages permissions can delete outgoing messages in channels.\n- If the bot is an administrator of a group, it can delete any message there.\n- If the bot has can_delete_messages permission in a supergroup or a channel, it can delete any message there.\n\nReturns True on success."),
tg_doc: "https://core.telegram.org/bots/api#delete_message",
tg_category: "Updating messages",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`).")
),
Param(
name: "message_id",
ty: RawTy("MessageId"),
descr: Doc(md: "Identifier of the message to delete")
),
],
),
Method(
names: ("sendSticker", "SendSticker", "send_sticker"),
return_ty: RawTy("Message"),
doc: Doc(
md: "Use this method to send static .WEBP or [animated] .TGS stickers. On success, the sent Message is returned.",
md_links: {"animated": "https://telegram.org/blog/animated-stickers"}
),
tg_doc: "https://core.telegram.org/bots/api#sendsticker",
tg_category: "Stickers",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target chat or username of the target channel (in the format `@channelusername`).")
),
Param(
name: "message_thread_id",
ty: Option(i32),
descr: Doc(md: "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"),
),
Param(
name: "sticker",
ty: RawTy("InputFile"),
descr: Doc(
md: "Sticker to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. [More info on Sending Files »]",
md_links: {"More info on Sending Files »": "https://core.telegram.org/bots/api#sending-files"},
)
),
Param(
name: "disable_notification",
ty: Option(bool),
descr: Doc(
md: "Sends the message [silently]. Users will receive a notification with no sound.",
md_links: {"silently": "https://telegram.org/blog/channels-2-0#silent-messages"}
)
),
Param(
name: "protect_content",
ty: Option(bool),
descr: Doc(md: "Protects the contents of sent messages from forwarding and saving"),
),
Param(
name: "reply_to_message_id",
ty: Option(i32),
descr: Doc(md: "If the message is a reply, ID of the original message")
),
Param(
name: "allow_sending_without_reply",
ty: Option(bool),
descr: Doc(md: "Pass _True_, if the message should be sent even if the specified replied-to message is not found")
),
Param(
name: "reply_markup",
ty: Option(RawTy("ReplyMarkup")),
descr: Doc(
md: "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.",
md_links: {
"inline keyboard": "https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating",
"custom reply keyboard": "https://core.telegram.org/bots#keyboards",
}
),
),
],
),
Method(
names: ("getStickerSet", "GetStickerSet", "get_sticker_set"),
return_ty: RawTy("StickerSet"),
doc: Doc(md: "Use this method to get a sticker set. On success, a StickerSet object is returned."),
tg_doc: "https://core.telegram.org/bots/api#getstickerset",
tg_category: "Stickers",
params: [
Param(
name: "name",
ty: String,
descr: Doc(md: "Name of the sticker set"),
),
],
),
Method(
names: ("getCustomEmojiStickers", "GetCustomEmojiStickers", "get_custom_emoji_stickers"),
return_ty: ArrayOf(RawTy("Sticker")),
doc: Doc(md: "Use this method to get information about custom emoji stickers by their identifiers. Returns an Array of Sticker objects."),
tg_doc: "https://core.telegram.org/bots/api#getcustomemojistickers",
tg_category: "Stickers",
params: [
Param(
name: "custom_emoji_ids",
ty: ArrayOf(String),
descr: Doc(md: "List of custom emoji identifiers. At most 200 custom emoji identifiers can be specified."),
),
],
),
Method(
names: ("uploadStickerFile", "UploadStickerFile", "upload_sticker_file"),
return_ty: RawTy("FileMeta"),
doc: Doc(md: "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."),
tg_doc: "https://core.telegram.org/bots/api#uploadstickerfile",
tg_category: "Stickers",
params: [
Param(
name: "user_id",
ty: RawTy("UserId"),
descr: Doc(md: "User identifier of sticker file owner"),
),
Param(
name: "png_sticker",
ty: RawTy("InputFile"),
descr: Doc(
md: "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. [More info on Sending Files »]",
md_links: {"More info on Sending Files »": "https://core.telegram.org/bots/api#sending-files"},
),
),
],
),
Method(
names: ("createNewStickerSet", "CreateNewStickerSet", "create_new_sticker_set"),
return_ty: True,
doc: Doc(md: "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. You must use exactly one of the fields _png\\_sticker_ or _tgs\\_sticker_. Returns _True_ on success."),
tg_doc: "https://core.telegram.org/bots/api#createstickerset",
tg_category: "Stickers",
params: [
Param(
name: "user_id",
ty: RawTy("UserId"),
descr: Doc(md: "User identifier of sticker file owner"),
),
Param(
name: "name",
ty: String,
descr: Doc(md: "Short name of sticker set, to be used in `t.me/addstickers/` 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\\_<bot username>”. <bot\\_username>_ is case insensitive. 1-64 characters."),
),
Param(
name: "title",
ty: String,
descr: Doc(md: "Sticker set title, 1-64 characters"),
),
Param(
name: "sticker",
ty: RawTy("InputSticker"),
descr: Doc(
md: "**PNG** image, **TGS** animation or **WEBM** video 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. [More info on Sending Files »]",
md_links: {"More info on Sending Files »": "https://core.telegram.org/bots/api#sending-files"},
),
),
Param(
name: "emojis",
ty: String,
descr: Doc(md: "One or more emoji corresponding to the sticker"),
),
Param(
name: "sticker_type",
ty: Option(RawTy("StickerType")),
descr: Doc(md: "Type of stickers in the set, pass “regular” or “mask”. Custom emoji sticker sets can't be created via the Bot API at the moment. By default, a regular sticker set is created."),
),
Param(
name: "mask_position",
ty: Option(RawTy("MaskPosition")),
descr: Doc(md: "A JSON-serialized object for position where the mask should be placed on faces"),
),
],
),
Method(
names: ("addStickerToSet", "AddStickerToSet", "add_sticker_to_set"),
return_ty: True,
doc: Doc(md: "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."),
tg_doc: "https://core.telegram.org/bots/api#addstickertoset",
tg_category: "Stickers",
params: [
Param(
name: "user_id",
ty: RawTy("UserId"),
descr: Doc(md: "User identifier of sticker file owner"),
),
Param(
name: "name",
ty: String,
descr: Doc(md: "Sticker set name"),
),
Param(
name: "sticker",
ty: RawTy("InputSticker"),
descr: Doc(
md: "**PNG** or **TGS** 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. [More info on Sending Files »]",
md_links: {"More info on Sending Files »": "https://core.telegram.org/bots/api#sending-files"},
),
),
Param(
name: "emojis",
ty: String,
descr: Doc(md: "One or more emoji corresponding to the sticker"),
),
Param(
name: "mask_position",
ty: Option(RawTy("MaskPosition")),
descr: Doc(md: "A JSON-serialized object for position where the mask should be placed on faces"),
),
],
),
Method(
names: ("setStickerPositionInSet", "SetStickerPositionInSet", "set_sticker_position_in_set"),
return_ty: True,
doc: Doc(md: "Use this method to move a sticker in a set created by the bot to a specific position. Returns _True_ on success."),
tg_doc: "https://core.telegram.org/bots/api#setstickerpositioninset",
tg_category: "Stickers",
params: [
Param(
name: "sticker",
ty: String,
descr: Doc(md: "File identifier of the sticker"),
),
Param(
name: "position",
ty: u32,
descr: Doc(md: "New sticker position in the set, zero-based"),
),
],
),
Method(
names: ("deleteStickerFromSet", "DeleteStickerFromSet", "delete_sticker_from_set"),
return_ty: True,
doc: Doc(md: "Use this method to delete a sticker from a set created by the bot. Returns _True_ on success."),
tg_doc: "https://core.telegram.org/bots/api#deletestickerfromset",
tg_category: "Stickers",
params: [
Param(
name: "sticker",
ty: String,
descr: Doc(md: "File identifier of the sticker"),
),
],
),
Method(
names: ("setStickerSetThumb", "SetStickerSetThumb", "set_sticker_set_thumb"),
return_ty: True,
doc: Doc(md: "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."),
tg_doc: "https://core.telegram.org/bots/api#setstickersetthumb",
tg_category: "Stickers",
params: [
Param(
name: "name",
ty: String,
descr: Doc(md: "Name of the sticker set"),
),
Param(
name: "user_id",
ty: RawTy("UserId"),
descr: Doc(md: "User identifier of sticker file owner"),
),
Param(
name: "thumb",
ty: Option(RawTy("InputFile")),
descr: Doc(
md: "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. [More info on Sending Files »]. Animated sticker set thumbnail can't be uploaded via HTTP URL.",
md_links: {"More info on Sending Files »": "https://core.telegram.org/bots/api#sending-files"},
),
),
],
),
Method(
names: ("sendInvoice", "SendInvoice", "send_invoice"),
return_ty: RawTy("Message"),
doc: Doc(
md: "Use this method to send invoices. On success, the sent [Message] is returned.",
md_links: {"Message":"https://core.telegram.org/bots/api#message"}
),
tg_doc: "https://core.telegram.org/bots/api#sendinvoice",
tg_category: "Payments",
params: [
Param(
name: "chat_id",
ty: RawTy("Recipient"),
descr: Doc(md: "Unique identifier for the target private chat"),
),
Param(
name: "message_thread_id",
ty: Option(i32),
descr: Doc(md: "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"),
),
Param(
name: "title",
ty: String,
descr: Doc(md: "Product name, 1-32 characters"),
),
Param(
name: "description",
ty: String,
descr: Doc(md: "Product description, 1-255 characters"),
),
Param(
name: "payload",
ty: String,
descr: Doc(md: "Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes."),
),
Param(
name: "provider_token",
ty: String,
descr: Doc(
md: "Payments provider token, obtained via [Botfather]",
md_links: {"Botfather":"https://t.me/botfather"}
),
),
Param(
name: "currency",
ty: String,
descr: Doc(md: "Three-letter ISO 4217 currency code, see more on currencies"),
),
Param(
name: "prices",
ty: ArrayOf(RawTy("LabeledPrice")),
descr: Doc(md: "Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)"),
),
Param(
name: "max_tip_amount",
ty: Option(u32),
descr: Doc(
md: "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",
md_links: {"`currencies.json`":"https://core.telegram.org/bots/payments/currencies.json"}
),
),
Param(
name: "suggested_tip_amounts",
ty: Option(ArrayOf(u32)),
descr: Doc(md: "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_."),
),
Param(
name: "start_parameter",
ty: Option(String),
descr: Doc(md: "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"),
),
Param(
name: "provider_data",
ty: Option(String),
descr: Doc(md: "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.")
),
Param(
name: "photo_url",
ty: Option(String),
descr: Doc(md: "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.")
),
Param(
name: "photo_size",
ty: Option(String),
descr: Doc(md: "Photo size in bytes")
),
Param(
name: "photo_width",
ty: Option(String),
descr: Doc(md: "Photo width")
),
Param(
name: "photo_height",
ty: Option(String),
descr: Doc(md: "Photo height")
),
Param(
name: "need_name",
ty: Option(bool),
descr: Doc(md: "Pass _True_, if you require the user's full name to complete the order")
),
Param(
name: "need_phone_number",
ty: Option(bool),
descr: Doc(md: "Pass _True_, if you require the user's phone number to complete the order")
),
Param(
name: "need_email",
ty: Option(bool),
descr: Doc(md: "Pass _True_, if you require the user's email address to complete the order")
),
Param(
name: "need_shipping_address",
ty: Option(bool),
descr: Doc(md: "Pass _True_, if you require the user's shipping address to complete the order")
),
Param(
name: "send_phone_number_to_provider",
ty: Option(bool),
descr: Doc(md: "Pass _True_, if user's phone number should be sent to provider")
),
Param(
name: "send_email_to_provider",
ty: Option(bool),
descr: Doc(md: "Pass _True_, if user's email address should be sent to provider")
),
Param(
name: "is_flexible",
ty: Option(bool),
descr: Doc(md: "Pass _True_, if the final price depends on the shipping method")
),
Param(
name: "disable_notification",
ty: Option(bool),
descr: Doc(
md: "Sends the message [silently]. Users will receive a notification with no sound.",
md_links: {"silently": "https://telegram.org/blog/channels-2-0#silent-messages"}
)
),
Param(
name: "protect_content",
ty: Option(bool),
descr: Doc(md: "Protects the contents of sent messages from forwarding and saving"),
),
Param(
name: "reply_to_message_id",
ty: Option(i32),
descr: Doc(md: "If the message is a reply, ID of the original message")
),
Param(
name: "allow_sending_without_reply",
ty: Option(bool),
descr: Doc(md: "Pass _True_, if the message should be sent even if the specified replied-to message is not found")
),
Param(
name: "reply_markup",
ty: Option(RawTy("InlineKeyboardMarkup")),
descr: Doc(
md: "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.",
md_links: {"inline keyboard": "https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating"}
),
),
],
),
Method(
names: ("createInvoiceLink", "CreateInvoiceLink", "create_invoice_link"),
return_ty: String,
doc: Doc(md: "Use this method to create a link for an invoice. Returns the created invoice link as String on success."),
tg_doc: "https://core.telegram.org/bots/api#createinvoicelink",
tg_category: "Payments",
params: [
Param(
name: "title",
ty: String,
descr: Doc(md: "Product name, 1-32 characters"),
),
Param(
name: "description",
ty: String,
descr: Doc(md: "Product description, 1-255 characters"),
),
Param(
name: "payload",
ty: String,
descr: Doc(md: "Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes."),
),
Param(
name: "provider_token",
ty: String,
descr: Doc(
md: "Payments provider token, obtained via [Botfather]",
md_links: {"Botfather":"https://t.me/botfather"}
),
),
Param(
name: "currency",
ty: String,
descr: Doc(md: "Three-letter ISO 4217 currency code, see more on currencies"),
),
Param(
name: "prices",
ty: ArrayOf(RawTy("LabeledPrice")),
descr: Doc(md: "Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)"),
),
Param(
name: "max_tip_amount",
ty: Option(u32),
descr: Doc(
md: "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",
md_links: {"`currencies.json`":"https://core.telegram.org/bots/payments/currencies.json"}
),
),
Param(
name: "suggested_tip_amounts",
ty: Option(ArrayOf(u32)),
descr: Doc(md: "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_."),
),
Param(
name: "provider_data",
ty: Option(String),
descr: Doc(md: "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.")
),
Param(
name: "photo_url",
ty: Option(String),
descr: Doc(md: "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.")
),
Param(
name: "photo_size",
ty: Option(String),
descr: Doc(md: "Photo size in bytes")
),
Param(
name: "photo_width",
ty: Option(String),
descr: Doc(md: "Photo width")
),
Param(
name: "photo_height",
ty: Option(String),
descr: Doc(md: "Photo height")
),
Param(
name: "need_name",
ty: Option(bool),
descr: Doc(md: "Pass _True_, if you require the user's full name to complete the order")
),
Param(
name: "need_phone_number",
ty: Option(bool),
descr: Doc(md: "Pass _True_, if you require the user's phone number to complete the order")
),
Param(
name: "need_email",
ty: Option(bool),
descr: Doc(md: "Pass _True_, if you require the user's email address to complete the order")
),
Param(
name: "need_shipping_address",
ty: Option(bool),
descr: Doc(md: "Pass _True_, if you require the user's shipping address to complete the order")
),
Param(
name: "send_phone_number_to_provider",
ty: Option(bool),
descr: Doc(md: "Pass _True_, if user's phone number should be sent to provider")
),
Param(
name: "send_email_to_provider",
ty: Option(bool),
descr: Doc(md: "Pass _True_, if user's email address should be sent to provider")
),
Param(
name: "is_flexible",
ty: Option(bool),
descr: Doc(md: "Pass _True_, if the final price depends on the shipping method")
),
],
),
Method(
names: ("answerShippingQuery", "AnswerShippingQuery", "answer_shipping_query"),
return_ty: True,
doc: Doc(
md: "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.",
md_links: {"Update":"https://core.telegram.org/bots/api#update"},
),
tg_doc: "https://core.telegram.org/bots/api#answershippingquery",
tg_category: "Payments",
params: [
Param(
name: "shipping_query_id",
ty: String,
descr: Doc(md: "Unique identifier for the query to be answered"),
),
Param(
name: "ok",
ty: bool,
descr: Doc(md: "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)"),
),
Param(
name: "shipping_options",
ty: Option(ArrayOf(RawTy("ShippingOption"))),
descr: Doc(md: "Required if ok is True. A JSON-serialized array of available shipping options."),
),
Param(
name: "error_message",
ty: Option(String),
descr: Doc(md: "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."),
),
],
),
Method(
names: ("answerPreCheckoutQuery", "AnswerPreCheckoutQuery", "answer_pre_checkout_query"),
return_ty: True,
doc: Doc(
md: "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.",
md_links: {"Update":"https://core.telegram.org/bots/api#update"},
),
tg_doc: "https://core.telegram.org/bots/api#answershippingquery",
tg_category: "Payments",
params: [
Param(
name: "pre_checkout_query_id",
ty: String,
descr: Doc(md: "Unique identifier for the query to be answered"),
),
Param(
name: "ok",
ty: bool,
descr: Doc(md: "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."),
),
Param(
name: "error_message",
ty: Option(String),
descr: Doc(md: "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."),
),
],
),
Method(
names: ("setPassportDataErrors", "SetPassportDataErrors", "set_passport_data_errors"),
return_ty: True,
doc: Doc(md: "Informs a user that some of the Telegram Passport elements they provided contains errors. The user will not be able to re-submit their Passport to you until the errors are fixed (the contents of the field for which you returned the error must change). Returns _True_ on success.\n\nUse 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."),
tg_doc: "https://core.telegram.org/bots/api#setpassportdataerrors",
tg_category: "Telegram Passport",
params: [
Param(
name: "user_id",
ty: RawTy("UserId"),
descr: Doc(md: "User identifier"),
),
Param(
name: "errors",
ty: ArrayOf(RawTy("PassportElementError")),
descr: Doc(md: "A JSON-serialized array describing the errors"),
),
],
),
Method(
names: ("sendGame", "SendGame", "send_game"),
return_ty: RawTy("Message"),
doc: Doc(
md: "Use this method to send a game. On success, the sent [Message] is returned.",
md_links: {"Message": "https://core.telegram.org/bots/api#message"}
),
tg_doc: "https://core.telegram.org/bots/api#sendgame",
tg_category: "Games",
params: [
Param(
name: "chat_id",
ty: u32,
descr: Doc(md: "Unique identifier for the target chat"),
),
Param(
name: "message_thread_id",
ty: Option(i32),
descr: Doc(md: "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"),
),
Param(
name: "game_short_name",
ty: String,
descr: Doc(md: "Short name of the game, serves as the unique identifier for the game. Set up your games via Botfather."),
),
Param(
name: "disable_notification",
ty: Option(bool),
descr: Doc(
md: "Sends the message [silently]. Users will receive a notification with no sound.",
md_links: {"silently": "https://telegram.org/blog/channels-2-0#silent-messages"}
)
),
Param(
name: "protect_content",
ty: Option(bool),
descr: Doc(md: "Protects the contents of sent messages from forwarding and saving"),
),
Param(
name: "reply_to_message_id",
ty: Option(i32),
descr: Doc(md: "If the message is a reply, ID of the original message")
),
Param(
name: "allow_sending_without_reply",
ty: Option(bool),
descr: Doc(md: "Pass _True_, if the message should be sent even if the specified replied-to message is not found")
),
Param(
name: "reply_markup",
ty: Option(RawTy("ReplyMarkup")),
descr: Doc(
md: "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.",
md_links: {"inline keyboard": "https://core.telegram.org/bots#inline-keyboards-and-on-the-fly-updating"},
),
),
],
),
Method(
names: ("setGameScore", "SetGameScore", "set_game_score"),
return_ty: RawTy("Message"),
doc: Doc(
md: "Use this method to set the score of the specified user in a game. On success, returns the edited [Message]. Returns an error, if the new score is not greater than the user's current score in the chat and force is False.",
md_links: {"Message": "https://core.telegram.org/bots/api#message"}
),
tg_doc: "https://core.telegram.org/bots/api#setgamescore",
tg_category: "Games",
params: [
Param(
name: "user_id",
ty: RawTy("UserId"),
descr: Doc(md: "User identifier"),
),
Param(
name: "score",
ty: u64,
descr: Doc(md: "New score"),
),
Param(
name: "force",
ty: Option(bool),
descr: Doc(md: "Pass True, if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters"),
),
Param(
name: "disable_edit_message",
ty: Option(bool),
descr: Doc(md: "Pass True, if the game message should not be automatically edited to include the current scoreboard"),
),
Param(
name: "chat_id",
ty: u32,
descr: Doc(md: "Unique identifier for the target chat")
),
Param(
name: "message_id",
ty: RawTy("MessageId"),
descr: Doc(md: "Identifier of the message to edit")
),
],
sibling: Some("setGameScoreInline"),
),
Method(
names: ("setGameScoreInline", "SetGameScoreInline", "set_game_score_inline"),
return_ty: RawTy("Message"),
doc: Doc(md: "Use this method to set the score of the specified user in a game. On success, 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."),
tg_doc: "https://core.telegram.org/bots/api#setgamescore",
tg_category: "Games",
params: [
Param(
name: "user_id",
ty: RawTy("UserId"),
descr: Doc(md: "User identifier"),
),
Param(
name: "score",
ty: u64,
descr: Doc(md: "New score"),
),
Param(
name: "force",
ty: Option(bool),
descr: Doc(md: "Pass True, if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters"),
),
Param(
name: "disable_edit_message",
ty: Option(bool),
descr: Doc(md: "Pass True, if the game message should not be automatically edited to include the current scoreboard"),
),
Param(
name: "inline_message_id",
ty: String,
descr: Doc(md: "Identifier of the inline message"),
),
],
sibling: Some("setGameScore"),
),
Method(
names: ("getGameHighScores", "GetGameHighScores", "get_game_high_scores"),
return_ty: True,
doc: Doc(
md: "Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. On success, returns an Array of [GameHighScore] objects.\n\n> This method will currently return scores for the target user, plus two of their closest neighbors on each side. Will also return the top three users if the user and his neighbors are not among them. Please note that this behavior is subject to change.",
md_links: {"GameHighScore": "https://core.telegram.org/bots/api#gamehighscore"},
),
tg_doc: "https://core.telegram.org/bots/api#getgamehighscores",
tg_category: "Games",
params: [
Param(
name: "user_id",
ty: RawTy("UserId"),
descr: Doc(md: "User identifier"),
),
Param(
name: "target",
ty: RawTy("TargetMessage"),
descr: Doc(md: "Target message")
)
],
),
],
tg_categories: {
"Getting updates": "https://core.telegram.org/bots/api#getting-updates",
"Available methods": "https://core.telegram.org/bots/api#available-methods",
"Inline Mode": "https://core.telegram.org/bots/api#inline-mode",
"Updating messages": "https://core.telegram.org/bots/api#updating-messages",
"Stickers": "https://core.telegram.org/bots/api#stickers",
"Payments": "https://core.telegram.org/bots/api#payments",
"Telegram Passport": "https://core.telegram.org/bots/api#telegram-passport",
"Games": "https://core.telegram.org/bots/api#games",
}
)
Reference in a new issue View git blame Copy permalink