mirror of
https://github.com/aiogram/aiogram.git
synced 2026-04-08 16:37:47 +00:00
Compare commits
127 commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
e4d3692ac2 | ||
|
|
19a6131618 | ||
|
|
0611d0d953 | ||
|
|
d5bd0b98a3 | ||
|
|
875f37f780 | ||
|
|
9f49c0413f | ||
|
|
00c1130938 | ||
|
|
3e2ca5b6b0 | ||
|
|
49eac319a3 | ||
|
|
bd75ae361e | ||
|
|
f68c24d620 | ||
|
|
73710acb4c | ||
|
|
e37eddbe8c | ||
|
|
fa844fce59 | ||
|
|
c73db32e86 | ||
|
|
f9ba9e37c6 | ||
|
|
49d0784e33 | ||
|
|
da7bfdca0c | ||
|
|
1708980ceb | ||
|
|
f2459fbcf2 | ||
|
|
ec7da0f678 | ||
|
|
a4a3f42c71 | ||
|
|
0306695b61 | ||
|
|
dcff0f99c7 | ||
|
|
ce4ddb77f4 | ||
|
|
7201e82238 | ||
|
|
b27ca9a45d | ||
|
|
79ee135331 | ||
|
|
e0c9613b87 | ||
|
|
b611e083a8 | ||
|
|
c5a403a2f1 | ||
|
|
5cc126368b | ||
|
|
af899e6773 | ||
|
|
4caf56814e | ||
|
|
0c6a705310 | ||
|
|
df7b16d5b3 | ||
|
|
ab32296d07 | ||
|
|
fdfdd847a0 | ||
|
|
99fa2460da | ||
|
|
6aa6e008c2 | ||
|
|
ab8af773cf | ||
|
|
ddcedadfbd | ||
|
|
7a517f1eba | ||
|
|
f060c08d16 | ||
|
|
77ca49518e | ||
|
|
b488808b30 | ||
|
|
e011d103c0 | ||
|
|
afecf00f4a | ||
|
|
72dd709717 | ||
|
|
3812157913 | ||
|
|
482629ac18 | ||
|
|
7a9ecdfbd9 | ||
|
|
eb84458ff5 | ||
|
|
a4256950e4 | ||
|
|
20d36a2ab8 | ||
|
|
50f84ad44c | ||
|
|
da3e84d4cf | ||
|
|
2c2bd61551 | ||
|
|
25e9127db9 | ||
|
|
870d97c783 | ||
|
|
02683b8c37 | ||
|
|
5547963311 | ||
|
|
7e8dcc6852 | ||
|
|
78748d36fd | ||
|
|
658f1fc082 | ||
|
|
925616ff79 | ||
|
|
cedbe2c500 | ||
|
|
de240b62ac | ||
|
|
cd4e811856 | ||
|
|
843c1dec7c | ||
|
|
8b4976b3de | ||
|
|
e622ada2fc | ||
|
|
b6b0ee0497 | ||
|
|
82406970c1 | ||
|
|
56db08b195 | ||
|
|
e17c84144d | ||
|
|
7b07338851 | ||
|
|
d8b9ce1be9 | ||
|
|
25833b830e | ||
|
|
6e81294685 | ||
|
|
bbdc43b737 | ||
|
|
a516b7f03f | ||
|
|
75fbe544c3 | ||
|
|
44bd8fe103 | ||
|
|
b376949647 | ||
|
|
afccd8a38f | ||
|
|
81550997f7 | ||
|
|
38e119052e | ||
|
|
1d5405ab43 | ||
|
|
f2e305e92a | ||
|
|
494e07a75a | ||
|
|
782796c217 | ||
|
|
6520b9fba2 | ||
|
|
141a550ab2 | ||
|
|
754535a2aa | ||
|
|
dfc88fc907 | ||
|
|
f2916ca03f | ||
|
|
a2af73ad78 | ||
|
|
592267dd99 | ||
|
|
fd014d2026 | ||
|
|
405bbcc36f | ||
|
|
4531c3628c | ||
|
|
51beb48257 | ||
|
|
1dbdcf0516 | ||
|
|
080878be86 | ||
|
|
718910f5b5 | ||
|
|
f9f847f603 | ||
|
|
b7d61b6379 | ||
|
|
46017f814d | ||
|
|
a76fb42ba0 | ||
|
|
7297ffa16e | ||
|
|
4bf4f8eac9 | ||
|
|
6cebbe29ac | ||
|
|
d9419ba690 | ||
|
|
3da419c434 | ||
|
|
386fc44a98 | ||
|
|
e8fc890809 | ||
|
|
fb1e5cad59 | ||
|
|
f10414c1eb | ||
|
|
e1d9bd5839 | ||
|
|
627ee09928 | ||
|
|
6aba60155c | ||
|
|
c3a08664d3 | ||
|
|
1c323ecc97 | ||
|
|
e2e1bc5573 | ||
|
|
9b0b6a68ed | ||
|
|
2215df7a0f |
1418 changed files with 61974 additions and 13396 deletions
|
|
@ -1 +1 @@
|
|||
7.8
|
||||
9.6
|
||||
|
|
|
|||
12
.butcher/enums/ButtonStyle.yml
Normal file
12
.butcher/enums/ButtonStyle.yml
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
name: ButtonStyle
|
||||
description: |
|
||||
This object represents a button style (inline- or reply-keyboard).
|
||||
|
||||
Sources:
|
||||
* https://core.telegram.org/bots/api#inlinekeyboardbutton
|
||||
* https://core.telegram.org/bots/api#keyboardbutton
|
||||
|
||||
parse:
|
||||
entity: InlineKeyboardButton
|
||||
attribute: style
|
||||
regexp: "'([a-z]+)'"
|
||||
|
|
@ -39,7 +39,14 @@ extract:
|
|||
- reply_to_story
|
||||
- business_connection_id
|
||||
- sender_business_bot
|
||||
- sender_tag
|
||||
- is_from_offline
|
||||
- has_media_spoiler
|
||||
- effect_id
|
||||
- show_caption_above_media
|
||||
- paid_star_count
|
||||
- direct_messages_topic
|
||||
- reply_to_checklist_task_id
|
||||
- suggested_post_info
|
||||
- is_paid_post
|
||||
- reply_to_poll_option_id
|
||||
|
|
|
|||
11
.butcher/enums/InputProfileType.yml
Normal file
11
.butcher/enums/InputProfileType.yml
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
name: InputProfilePhotoType
|
||||
description: |
|
||||
This object represents input profile photo type
|
||||
|
||||
Source: https://core.telegram.org/bots/api#inputprofilephoto
|
||||
multi_parse:
|
||||
attribute: type
|
||||
regexp: "must be *([a-z_]+)*"
|
||||
entities:
|
||||
- InputProfilePhotoStatic
|
||||
- InputProfilePhotoAnimated
|
||||
11
.butcher/enums/InputStoryContentPhotoType.yml
Normal file
11
.butcher/enums/InputStoryContentPhotoType.yml
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
name: InputStoryContentType
|
||||
description: |
|
||||
This object represents input story content photo type.
|
||||
|
||||
Source: https://core.telegram.org/bots/api#inputstorycontentphoto
|
||||
multi_parse:
|
||||
attribute: type
|
||||
regexp: "must be *([a-z_]+)*"
|
||||
entities:
|
||||
- InputStoryContentPhoto
|
||||
- InputStoryContentVideo
|
||||
11
.butcher/enums/OwnedGiftType.yml
Normal file
11
.butcher/enums/OwnedGiftType.yml
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
name: OwnedGiftType
|
||||
description: |
|
||||
This object represents owned gift type
|
||||
|
||||
Source: https://core.telegram.org/bots/api#ownedgift
|
||||
multi_parse:
|
||||
attribute: type
|
||||
regexp: "'([a-z_]+)'"
|
||||
entities:
|
||||
- OwnedGiftRegular
|
||||
- OwnedGiftUnique
|
||||
|
|
@ -9,3 +9,4 @@ multi_parse:
|
|||
entities:
|
||||
- ReactionTypeEmoji
|
||||
- ReactionTypeCustomEmoji
|
||||
- ReactionTypePaid
|
||||
|
|
|
|||
14
.butcher/enums/StoryAreaTypeType.yml
Normal file
14
.butcher/enums/StoryAreaTypeType.yml
Normal file
|
|
@ -0,0 +1,14 @@
|
|||
name: StoryAreaTypeType
|
||||
description: |
|
||||
This object represents input profile photo type
|
||||
|
||||
Source: https://core.telegram.org/bots/api#storyareatype
|
||||
multi_parse:
|
||||
attribute: type
|
||||
regexp: "'([a-z_]+)'"
|
||||
entities:
|
||||
- StoryAreaTypeLocation
|
||||
- StoryAreaTypeSuggestedReaction
|
||||
- StoryAreaTypeLink
|
||||
- StoryAreaTypeWeather
|
||||
- StoryAreaTypeUniqueGift
|
||||
|
|
@ -11,3 +11,6 @@ multi_parse:
|
|||
- TransactionPartnerOther
|
||||
- TransactionPartnerUser
|
||||
- TransactionPartnerTelegramAds
|
||||
- TransactionPartnerTelegramApi
|
||||
- TransactionPartnerAffiliateProgram
|
||||
- TransactionPartnerChat
|
||||
|
|
|
|||
10
.butcher/enums/TransactionPartnerUserTransactionType.yml
Normal file
10
.butcher/enums/TransactionPartnerUserTransactionType.yml
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
name: TransactionPartnerUserTransactionTypeEnum
|
||||
description: |
|
||||
This object represents type of the transaction that were made by partner user.
|
||||
|
||||
Source: https://core.telegram.org/bots/api#transactionpartneruser
|
||||
parse:
|
||||
entity: TransactionPartnerUser
|
||||
category: types
|
||||
attribute: transaction_type
|
||||
regexp: "'([a-z_]+)'"
|
||||
6
.butcher/methods/answerShippingQuery/entity.json
generated
6
.butcher/methods/answerShippingQuery/entity.json
generated
|
|
@ -38,9 +38,9 @@
|
|||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
"description": "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.",
|
||||
"html_description": "<td>Required if <em>ok</em> is <em>False</em>. 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.</td>",
|
||||
"rst_description": "Required if *ok* is :code:`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.\n",
|
||||
"description": "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.",
|
||||
"html_description": "<td>Required if <em>ok</em> is <em>False</em>. 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.</td>",
|
||||
"rst_description": "Required if *ok* is :code:`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.\n",
|
||||
"name": "error_message"
|
||||
}
|
||||
],
|
||||
|
|
|
|||
4
.butcher/methods/answerWebAppQuery/entity.json
generated
4
.butcher/methods/answerWebAppQuery/entity.json
generated
|
|
@ -1,8 +1,8 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Inline mode",
|
||||
"anchor": "inline-mode"
|
||||
"title": "Available methods",
|
||||
"anchor": "available-methods"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "answerwebappquery",
|
||||
|
|
|
|||
41
.butcher/methods/approveSuggestedPost/entity.json
generated
Normal file
41
.butcher/methods/approveSuggestedPost/entity.json
generated
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Updating messages",
|
||||
"anchor": "updating-messages"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "approvesuggestedpost",
|
||||
"name": "approveSuggestedPost",
|
||||
"description": "Use this method to approve a suggested post in a direct messages chat. The bot must have the 'can_post_messages' administrator right in the corresponding channel chat. Returns True on success.",
|
||||
"html_description": "<p>Use this method to approve a suggested post in a direct messages chat. The bot must have the 'can_post_messages' administrator right in the corresponding channel chat. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "Use this method to approve a suggested post in a direct messages chat. The bot must have the 'can_post_messages' administrator right in the corresponding channel chat. Returns :code:`True` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": true,
|
||||
"description": "Unique identifier for the target direct messages chat",
|
||||
"html_description": "<td>Unique identifier for the target direct messages chat</td>",
|
||||
"rst_description": "Unique identifier for the target direct messages chat\n",
|
||||
"name": "chat_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": true,
|
||||
"description": "Identifier of a suggested post message to approve",
|
||||
"html_description": "<td>Identifier of a suggested post message to approve</td>",
|
||||
"rst_description": "Identifier of a suggested post message to approve\n",
|
||||
"name": "message_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Point in time (Unix timestamp) when the post is expected to be published; omit if the date has already been specified when the suggested post was created. If specified, then the date must be not more than 2678400 seconds (30 days) in the future",
|
||||
"html_description": "<td>Point in time (Unix timestamp) when the post is expected to be published; omit if the date has already been specified when the suggested post was created. If specified, then the date must be not more than 2678400 seconds (30 days) in the future</td>",
|
||||
"rst_description": "Point in time (Unix timestamp) when the post is expected to be published; omit if the date has already been specified when the suggested post was created. If specified, then the date must be not more than 2678400 seconds (30 days) in the future\n",
|
||||
"name": "send_date"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
11
.butcher/methods/approveSuggestedPost/replace.yml
Normal file
11
.butcher/methods/approveSuggestedPost/replace.yml
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
annotations:
|
||||
send_date:
|
||||
parsed_type:
|
||||
type: union
|
||||
items:
|
||||
- type: std
|
||||
name: datetime.datetime
|
||||
- type: std
|
||||
name: datetime.timedelta
|
||||
- type: std
|
||||
name: int
|
||||
33
.butcher/methods/convertGiftToStars/entity.json
generated
Normal file
33
.butcher/methods/convertGiftToStars/entity.json
generated
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Available methods",
|
||||
"anchor": "available-methods"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "convertgifttostars",
|
||||
"name": "convertGiftToStars",
|
||||
"description": "Converts a given regular gift to Telegram Stars. Requires the can_convert_gifts_to_stars business bot right. Returns True on success.",
|
||||
"html_description": "<p>Converts a given regular gift to Telegram Stars. Requires the <em>can_convert_gifts_to_stars</em> business bot right. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "Converts a given regular gift to Telegram Stars. Requires the *can_convert_gifts_to_stars* business bot right. Returns :code:`True` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the business connection",
|
||||
"html_description": "<td>Unique identifier of the business connection</td>",
|
||||
"rst_description": "Unique identifier of the business connection\n",
|
||||
"name": "business_connection_id"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the regular gift that should be converted to Telegram Stars",
|
||||
"html_description": "<td>Unique identifier of the regular gift that should be converted to Telegram Stars</td>",
|
||||
"rst_description": "Unique identifier of the regular gift that should be converted to Telegram Stars\n",
|
||||
"name": "owned_gift_id"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
46
.butcher/methods/copyMessage/entity.json
generated
46
.butcher/methods/copyMessage/entity.json
generated
|
|
@ -22,11 +22,19 @@
|
|||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
|
||||
"html_description": "<td>Unique identifier for the target message thread (topic) of the forum; for forum supergroups only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n",
|
||||
"description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
|
||||
"html_description": "<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
|
||||
"name": "message_thread_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
|
||||
"html_description": "<td>Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat</td>",
|
||||
"rst_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
|
||||
"name": "direct_messages_topic_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer or String",
|
||||
"required": true,
|
||||
|
|
@ -43,6 +51,14 @@
|
|||
"rst_description": "Message identifier in the chat specified in *from_chat_id*\n",
|
||||
"name": "message_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "New start timestamp for the copied video in the message",
|
||||
"html_description": "<td>New start timestamp for the copied video in the message</td>",
|
||||
"rst_description": "New start timestamp for the copied video in the message\n",
|
||||
"name": "video_start_timestamp"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
|
|
@ -91,6 +107,30 @@
|
|||
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
|
||||
"name": "protect_content"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
|
||||
"html_description": "<td>Pass <em>True</em> to allow up to 1000 messages per second, ignoring <a href=\"https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once\">broadcasting limits</a> for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance</td>",
|
||||
"rst_description": "Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits <https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once>`_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
|
||||
"name": "allow_paid_broadcast"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
"description": "Unique identifier of the message effect to be added to the message; only available when copying to private chats",
|
||||
"html_description": "<td>Unique identifier of the message effect to be added to the message; only available when copying to private chats</td>",
|
||||
"rst_description": "Unique identifier of the message effect to be added to the message; only available when copying to private chats\n",
|
||||
"name": "message_effect_id"
|
||||
},
|
||||
{
|
||||
"type": "SuggestedPostParameters",
|
||||
"required": false,
|
||||
"description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
|
||||
"html_description": "<td>A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.</td>",
|
||||
"rst_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
|
||||
"name": "suggested_post_parameters"
|
||||
},
|
||||
{
|
||||
"type": "ReplyParameters",
|
||||
"required": false,
|
||||
|
|
|
|||
11
.butcher/methods/copyMessage/replace.yml
Normal file
11
.butcher/methods/copyMessage/replace.yml
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
annotations:
|
||||
video_start_timestamp:
|
||||
parsed_type:
|
||||
type: union
|
||||
items:
|
||||
- type: std
|
||||
name: datetime.datetime
|
||||
- type: std
|
||||
name: datetime.timedelta
|
||||
- type: std
|
||||
name: int
|
||||
14
.butcher/methods/copyMessages/entity.json
generated
14
.butcher/methods/copyMessages/entity.json
generated
|
|
@ -22,11 +22,19 @@
|
|||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
|
||||
"html_description": "<td>Unique identifier for the target message thread (topic) of the forum; for forum supergroups only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n",
|
||||
"description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
|
||||
"html_description": "<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
|
||||
"name": "message_thread_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Identifier of the direct messages topic to which the messages will be sent; required if the messages are sent to a direct messages chat",
|
||||
"html_description": "<td>Identifier of the direct messages topic to which the messages will be sent; required if the messages are sent to a direct messages chat</td>",
|
||||
"rst_description": "Identifier of the direct messages topic to which the messages will be sent; required if the messages are sent to a direct messages chat\n",
|
||||
"name": "direct_messages_topic_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer or String",
|
||||
"required": true,
|
||||
|
|
|
|||
49
.butcher/methods/createChatSubscriptionInviteLink/entity.json
generated
Normal file
49
.butcher/methods/createChatSubscriptionInviteLink/entity.json
generated
Normal file
|
|
@ -0,0 +1,49 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Available methods",
|
||||
"anchor": "available-methods"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "createchatsubscriptioninvitelink",
|
||||
"name": "createChatSubscriptionInviteLink",
|
||||
"description": "Use this method to create a subscription invite link for a channel chat. The bot must have the can_invite_users administrator rights. The link can be edited using the method editChatSubscriptionInviteLink or revoked using the method revokeChatInviteLink. Returns the new invite link as a ChatInviteLink object.",
|
||||
"html_description": "<p>Use this method to create a <a href=\"https://telegram.org/blog/superchannels-star-reactions-subscriptions#star-subscriptions\">subscription invite link</a> for a channel chat. The bot must have the <em>can_invite_users</em> administrator rights. The link can be edited using the method <a href=\"#editchatsubscriptioninvitelink\">editChatSubscriptionInviteLink</a> or revoked using the method <a href=\"#revokechatinvitelink\">revokeChatInviteLink</a>. Returns the new invite link as a <a href=\"#chatinvitelink\">ChatInviteLink</a> object.</p>",
|
||||
"rst_description": "Use this method to create a `subscription invite link <https://telegram.org/blog/superchannels-star-reactions-subscriptions#star-subscriptions>`_ for a channel chat. The bot must have the *can_invite_users* administrator rights. The link can be edited using the method :class:`aiogram.methods.edit_chat_subscription_invite_link.EditChatSubscriptionInviteLink` or revoked using the method :class:`aiogram.methods.revoke_chat_invite_link.RevokeChatInviteLink`. Returns the new invite link as a :class:`aiogram.types.chat_invite_link.ChatInviteLink` object.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "Integer or String",
|
||||
"required": true,
|
||||
"description": "Unique identifier for the target channel chat or username of the target channel (in the format @channelusername)",
|
||||
"html_description": "<td>Unique identifier for the target channel chat or username of the target channel (in the format <code>@channelusername</code>)</td>",
|
||||
"rst_description": "Unique identifier for the target channel chat or username of the target channel (in the format :code:`@channelusername`)\n",
|
||||
"name": "chat_id"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
"description": "Invite link name; 0-32 characters",
|
||||
"html_description": "<td>Invite link name; 0-32 characters</td>",
|
||||
"rst_description": "Invite link name; 0-32 characters\n",
|
||||
"name": "name"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": true,
|
||||
"description": "The number of seconds the subscription will be active for before the next payment. Currently, it must always be 2592000 (30 days).",
|
||||
"html_description": "<td>The number of seconds the subscription will be active for before the next payment. Currently, it must always be 2592000 (30 days).</td>",
|
||||
"rst_description": "The number of seconds the subscription will be active for before the next payment. Currently, it must always be 2592000 (30 days).\n",
|
||||
"name": "subscription_period"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": true,
|
||||
"description": "The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat; 1-10000",
|
||||
"html_description": "<td>The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat; 1-10000</td>",
|
||||
"rst_description": "The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat; 1-10000\n",
|
||||
"name": "subscription_price"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,11 @@
|
|||
annotations:
|
||||
subscription_period:
|
||||
parsed_type:
|
||||
type: union
|
||||
items:
|
||||
- type: std
|
||||
name: datetime.datetime
|
||||
- type: std
|
||||
name: datetime.timedelta
|
||||
- type: std
|
||||
name: int
|
||||
6
.butcher/methods/createForumTopic/entity.json
generated
6
.butcher/methods/createForumTopic/entity.json
generated
|
|
@ -7,9 +7,9 @@
|
|||
"object": {
|
||||
"anchor": "createforumtopic",
|
||||
"name": "createForumTopic",
|
||||
"description": "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.",
|
||||
"html_description": "<p>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 <em>can_manage_topics</em> administrator rights. Returns information about the created topic as a <a href=\"#forumtopic\">ForumTopic</a> object.</p>",
|
||||
"rst_description": "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 :class:`aiogram.types.forum_topic.ForumTopic` object.",
|
||||
"description": "Use this method to create a topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the can_manage_topics administrator right. Returns information about the created topic as a ForumTopic object.",
|
||||
"html_description": "<p>Use this method to create a topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the <em>can_manage_topics</em> administrator right. Returns information about the created topic as a <a href=\"#forumtopic\">ForumTopic</a> object.</p>",
|
||||
"rst_description": "Use this method to create a topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the *can_manage_topics* administrator right. Returns information about the created topic as a :class:`aiogram.types.forum_topic.ForumTopic` object.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "Integer or String",
|
||||
|
|
|
|||
22
.butcher/methods/createInvoiceLink/entity.json
generated
22
.butcher/methods/createInvoiceLink/entity.json
generated
|
|
@ -11,6 +11,14 @@
|
|||
"html_description": "<p>Use this method to create a link for an invoice. Returns the created invoice link as <em>String</em> on success.</p>",
|
||||
"rst_description": "Use this method to create a link for an invoice. Returns the created invoice link as *String* on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
"description": "Unique identifier of the business connection on behalf of which the link will be created. For payments in Telegram Stars only.",
|
||||
"html_description": "<td>Unique identifier of the business connection on behalf of which the link will be created. For payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a> only.</td>",
|
||||
"rst_description": "Unique identifier of the business connection on behalf of which the link will be created. For payments in `Telegram Stars <https://t.me/BotNews/90>`_ only.\n",
|
||||
"name": "business_connection_id"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
|
|
@ -30,9 +38,9 @@
|
|||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
"description": "Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.",
|
||||
"html_description": "<td>Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.</td>",
|
||||
"rst_description": "Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.\n",
|
||||
"description": "Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes.",
|
||||
"html_description": "<td>Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes.</td>",
|
||||
"rst_description": "Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes.\n",
|
||||
"name": "payload"
|
||||
},
|
||||
{
|
||||
|
|
@ -59,6 +67,14 @@
|
|||
"rst_description": "Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.). Must contain exactly one item for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
|
||||
"name": "prices"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "The number of seconds the subscription will be active for before the next payment. The currency must be set to 'XTR' (Telegram Stars) if the parameter is used. Currently, it must always be 2592000 (30 days) if specified. Any number of subscriptions can be active for a given bot at the same time, including multiple concurrent subscriptions from the same user. Subscription price must no exceed 10000 Telegram Stars.",
|
||||
"html_description": "<td>The number of seconds the subscription will be active for before the next payment. The currency must be set to “XTR” (Telegram Stars) if the parameter is used. Currently, it must always be 2592000 (30 days) if specified. Any number of subscriptions can be active for a given bot at the same time, including multiple concurrent subscriptions from the same user. Subscription price must no exceed 10000 Telegram Stars.</td>",
|
||||
"rst_description": "The number of seconds the subscription will be active for before the next payment. The currency must be set to 'XTR' (Telegram Stars) if the parameter is used. Currently, it must always be 2592000 (30 days) if specified. Any number of subscriptions can be active for a given bot at the same time, including multiple concurrent subscriptions from the same user. Subscription price must no exceed 10000 Telegram Stars.\n",
|
||||
"name": "subscription_period"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
|
|
|
|||
41
.butcher/methods/declineSuggestedPost/entity.json
generated
Normal file
41
.butcher/methods/declineSuggestedPost/entity.json
generated
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Updating messages",
|
||||
"anchor": "updating-messages"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "declinesuggestedpost",
|
||||
"name": "declineSuggestedPost",
|
||||
"description": "Use this method to decline a suggested post in a direct messages chat. The bot must have the 'can_manage_direct_messages' administrator right in the corresponding channel chat. Returns True on success.",
|
||||
"html_description": "<p>Use this method to decline a suggested post in a direct messages chat. The bot must have the 'can_manage_direct_messages' administrator right in the corresponding channel chat. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "Use this method to decline a suggested post in a direct messages chat. The bot must have the 'can_manage_direct_messages' administrator right in the corresponding channel chat. Returns :code:`True` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": true,
|
||||
"description": "Unique identifier for the target direct messages chat",
|
||||
"html_description": "<td>Unique identifier for the target direct messages chat</td>",
|
||||
"rst_description": "Unique identifier for the target direct messages chat\n",
|
||||
"name": "chat_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": true,
|
||||
"description": "Identifier of a suggested post message to decline",
|
||||
"html_description": "<td>Identifier of a suggested post message to decline</td>",
|
||||
"rst_description": "Identifier of a suggested post message to decline\n",
|
||||
"name": "message_id"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
"description": "Comment for the creator of the suggested post; 0-128 characters",
|
||||
"html_description": "<td>Comment for the creator of the suggested post; 0-128 characters</td>",
|
||||
"rst_description": "Comment for the creator of the suggested post; 0-128 characters\n",
|
||||
"name": "comment"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
33
.butcher/methods/deleteBusinessMessages/entity.json
generated
Normal file
33
.butcher/methods/deleteBusinessMessages/entity.json
generated
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Available methods",
|
||||
"anchor": "available-methods"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "deletebusinessmessages",
|
||||
"name": "deleteBusinessMessages",
|
||||
"description": "Delete messages on behalf of a business account. Requires the can_delete_sent_messages business bot right to delete messages sent by the bot itself, or the can_delete_all_messages business bot right to delete any message. Returns True on success.",
|
||||
"html_description": "<p>Delete messages on behalf of a business account. Requires the <em>can_delete_sent_messages</em> business bot right to delete messages sent by the bot itself, or the <em>can_delete_all_messages</em> business bot right to delete any message. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "Delete messages on behalf of a business account. Requires the *can_delete_sent_messages* business bot right to delete messages sent by the bot itself, or the *can_delete_all_messages* business bot right to delete any message. Returns :code:`True` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the business connection on behalf of which to delete the messages",
|
||||
"html_description": "<td>Unique identifier of the business connection on behalf of which to delete the messages</td>",
|
||||
"rst_description": "Unique identifier of the business connection on behalf of which to delete the messages\n",
|
||||
"name": "business_connection_id"
|
||||
},
|
||||
{
|
||||
"type": "Array of Integer",
|
||||
"required": true,
|
||||
"description": "A JSON-serialized list of 1-100 identifiers of messages to delete. All messages must be from the same chat. See deleteMessage for limitations on which messages can be deleted",
|
||||
"html_description": "<td>A JSON-serialized list of 1-100 identifiers of messages to delete. All messages must be from the same chat. See <a href=\"#deletemessage\">deleteMessage</a> for limitations on which messages can be deleted</td>",
|
||||
"rst_description": "A JSON-serialized list of 1-100 identifiers of messages to delete. All messages must be from the same chat. See :class:`aiogram.methods.delete_message.DeleteMessage` for limitations on which messages can be deleted\n",
|
||||
"name": "message_ids"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
6
.butcher/methods/deleteForumTopic/entity.json
generated
6
.butcher/methods/deleteForumTopic/entity.json
generated
|
|
@ -7,9 +7,9 @@
|
|||
"object": {
|
||||
"anchor": "deleteforumtopic",
|
||||
"name": "deleteForumTopic",
|
||||
"description": "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.",
|
||||
"html_description": "<p>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 <em>can_delete_messages</em> administrator rights. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "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 :code:`True` on success.",
|
||||
"description": "Use this method to delete a forum topic along with all its messages in a forum supergroup chat or a private chat with a user. In the case of a 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.",
|
||||
"html_description": "<p>Use this method to delete a forum topic along with all its messages in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the <em>can_delete_messages</em> administrator rights. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "Use this method to delete a forum topic along with all its messages in a forum supergroup chat or a private chat with a user. In the case of a 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 :code:`True` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "Integer or String",
|
||||
|
|
|
|||
6
.butcher/methods/deleteMessage/entity.json
generated
6
.butcher/methods/deleteMessage/entity.json
generated
|
|
@ -7,9 +7,9 @@
|
|||
"object": {
|
||||
"anchor": "deletemessage",
|
||||
"name": "deleteMessage",
|
||||
"description": "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- Service messages about a supergroup, channel, or forum topic creation can't be deleted.\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.\nReturns True on success.",
|
||||
"html_description": "<p>Use this method to delete a message, including service messages, with the following limitations:<br/>\n- A message can only be deleted if it was sent less than 48 hours ago.<br/>\n- Service messages about a supergroup, channel, or forum topic creation can't be deleted.<br/>\n- A dice message in a private chat can only be deleted if it was sent more than 24 hours ago.<br/>\n- Bots can delete outgoing messages in private chats, groups, and supergroups.<br/>\n- Bots can delete incoming messages in private chats.<br/>\n- Bots granted <em>can_post_messages</em> permissions can delete outgoing messages in channels.<br/>\n- If the bot is an administrator of a group, it can delete any message there.<br/>\n- If the bot has <em>can_delete_messages</em> permission in a supergroup or a channel, it can delete any message there.<br/>\nReturns <em>True</em> on success.</p>",
|
||||
"rst_description": "Use this method to delete a message, including service messages, with the following limitations:\n\n- A message can only be deleted if it was sent less than 48 hours ago.\n\n- Service messages about a supergroup, channel, or forum topic creation can't be deleted.\n\n- A dice message in a private chat can only be deleted if it was sent more than 24 hours ago.\n\n- Bots can delete outgoing messages in private chats, groups, and supergroups.\n\n- Bots can delete incoming messages in private chats.\n\n- Bots granted *can_post_messages* permissions can delete outgoing messages in channels.\n\n- If the bot is an administrator of a group, it can delete any message there.\n\n- If the bot has *can_delete_messages* permission in a supergroup or a channel, it can delete any message there.\n\nReturns :code:`True` on success.",
|
||||
"description": "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- Service messages about a supergroup, channel, or forum topic creation can't be deleted.\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 administrator right in a supergroup or a channel, it can delete any message there.\n- If the bot has can_manage_direct_messages administrator right in a channel, it can delete any message in the corresponding direct messages chat.\nReturns True on success.",
|
||||
"html_description": "<p>Use this method to delete a message, including service messages, with the following limitations:<br/>\n- A message can only be deleted if it was sent less than 48 hours ago.<br/>\n- Service messages about a supergroup, channel, or forum topic creation can't be deleted.<br/>\n- A dice message in a private chat can only be deleted if it was sent more than 24 hours ago.<br/>\n- Bots can delete outgoing messages in private chats, groups, and supergroups.<br/>\n- Bots can delete incoming messages in private chats.<br/>\n- Bots granted <em>can_post_messages</em> permissions can delete outgoing messages in channels.<br/>\n- If the bot is an administrator of a group, it can delete any message there.<br/>\n- If the bot has <em>can_delete_messages</em> administrator right in a supergroup or a channel, it can delete any message there.<br/>\n- If the bot has <em>can_manage_direct_messages</em> administrator right in a channel, it can delete any message in the corresponding direct messages chat.<br/>\nReturns <em>True</em> on success.</p>",
|
||||
"rst_description": "Use this method to delete a message, including service messages, with the following limitations:\n\n- A message can only be deleted if it was sent less than 48 hours ago.\n\n- Service messages about a supergroup, channel, or forum topic creation can't be deleted.\n\n- A dice message in a private chat can only be deleted if it was sent more than 24 hours ago.\n\n- Bots can delete outgoing messages in private chats, groups, and supergroups.\n\n- Bots can delete incoming messages in private chats.\n\n- Bots granted *can_post_messages* permissions can delete outgoing messages in channels.\n\n- If the bot is an administrator of a group, it can delete any message there.\n\n- If the bot has *can_delete_messages* administrator right in a supergroup or a channel, it can delete any message there.\n\n- If the bot has *can_manage_direct_messages* administrator right in a channel, it can delete any message in the corresponding direct messages chat.\n\nReturns :code:`True` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "Integer or String",
|
||||
|
|
|
|||
33
.butcher/methods/deleteStory/entity.json
generated
Normal file
33
.butcher/methods/deleteStory/entity.json
generated
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Available methods",
|
||||
"anchor": "available-methods"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "deletestory",
|
||||
"name": "deleteStory",
|
||||
"description": "Deletes a story previously posted by the bot on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns True on success.",
|
||||
"html_description": "<p>Deletes a story previously posted by the bot on behalf of a managed business account. Requires the <em>can_manage_stories</em> business bot right. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "Deletes a story previously posted by the bot on behalf of a managed business account. Requires the *can_manage_stories* business bot right. Returns :code:`True` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the business connection",
|
||||
"html_description": "<td>Unique identifier of the business connection</td>",
|
||||
"rst_description": "Unique identifier of the business connection\n",
|
||||
"name": "business_connection_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the story to delete",
|
||||
"html_description": "<td>Unique identifier of the story to delete</td>",
|
||||
"rst_description": "Unique identifier of the story to delete\n",
|
||||
"name": "story_id"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
41
.butcher/methods/editChatSubscriptionInviteLink/entity.json
generated
Normal file
41
.butcher/methods/editChatSubscriptionInviteLink/entity.json
generated
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Available methods",
|
||||
"anchor": "available-methods"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "editchatsubscriptioninvitelink",
|
||||
"name": "editChatSubscriptionInviteLink",
|
||||
"description": "Use this method to edit a subscription invite link created by the bot. The bot must have the can_invite_users administrator rights. Returns the edited invite link as a ChatInviteLink object.",
|
||||
"html_description": "<p>Use this method to edit a subscription invite link created by the bot. The bot must have the <em>can_invite_users</em> administrator rights. Returns the edited invite link as a <a href=\"#chatinvitelink\">ChatInviteLink</a> object.</p>",
|
||||
"rst_description": "Use this method to edit a subscription invite link created by the bot. The bot must have the *can_invite_users* administrator rights. Returns the edited invite link as a :class:`aiogram.types.chat_invite_link.ChatInviteLink` object.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "Integer or String",
|
||||
"required": true,
|
||||
"description": "Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
|
||||
"html_description": "<td>Unique identifier for the target chat or username of the target channel (in the format <code>@channelusername</code>)</td>",
|
||||
"rst_description": "Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n",
|
||||
"name": "chat_id"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
"description": "The invite link to edit",
|
||||
"html_description": "<td>The invite link to edit</td>",
|
||||
"rst_description": "The invite link to edit\n",
|
||||
"name": "invite_link"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
"description": "Invite link name; 0-32 characters",
|
||||
"html_description": "<td>Invite link name; 0-32 characters</td>",
|
||||
"rst_description": "Invite link name; 0-32 characters\n",
|
||||
"name": "name"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
6
.butcher/methods/editForumTopic/entity.json
generated
6
.butcher/methods/editForumTopic/entity.json
generated
|
|
@ -7,9 +7,9 @@
|
|||
"object": {
|
||||
"anchor": "editforumtopic",
|
||||
"name": "editForumTopic",
|
||||
"description": "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.",
|
||||
"html_description": "<p>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 <em>can_manage_topics</em> administrator rights, unless it is the creator of the topic. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "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 :code:`True` on success.",
|
||||
"description": "Use this method to edit name and icon of a topic in a forum supergroup chat or a private chat with a user. In the case of a 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.",
|
||||
"html_description": "<p>Use this method to edit name and icon of a topic in a forum supergroup chat or a private chat with a user. In the case of a supergroup chat the bot must be an administrator in the chat for this to work and must have the <em>can_manage_topics</em> administrator rights, unless it is the creator of the topic. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "Use this method to edit name and icon of a topic in a forum supergroup chat or a private chat with a user. In the case of a 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 :code:`True` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "Integer or String",
|
||||
|
|
|
|||
|
|
@ -7,9 +7,9 @@
|
|||
"object": {
|
||||
"anchor": "editgeneralforumtopic",
|
||||
"name": "editGeneralForumTopic",
|
||||
"description": "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.",
|
||||
"html_description": "<p>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 <em>can_manage_topics</em> administrator rights. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "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 :code:`True` on success.",
|
||||
"description": "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 the can_manage_topics administrator rights. Returns True on success.",
|
||||
"html_description": "<p>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 the <em>can_manage_topics</em> administrator rights. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "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 the *can_manage_topics* administrator rights. Returns :code:`True` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "Integer or String",
|
||||
|
|
|
|||
57
.butcher/methods/editMessageChecklist/entity.json
generated
Normal file
57
.butcher/methods/editMessageChecklist/entity.json
generated
Normal file
|
|
@ -0,0 +1,57 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Updating messages",
|
||||
"anchor": "updating-messages"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "editmessagechecklist",
|
||||
"name": "editMessageChecklist",
|
||||
"description": "Use this method to edit a checklist on behalf of a connected business account. On success, the edited Message is returned.",
|
||||
"html_description": "<p>Use this method to edit a checklist on behalf of a connected business account. On success, the edited <a href=\"#message\">Message</a> is returned.</p>",
|
||||
"rst_description": "Use this method to edit a checklist on behalf of a connected business account. On success, the edited :class:`aiogram.types.message.Message` is returned.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the business connection on behalf of which the message will be sent",
|
||||
"html_description": "<td>Unique identifier of the business connection on behalf of which the message will be sent</td>",
|
||||
"rst_description": "Unique identifier of the business connection on behalf of which the message will be sent\n",
|
||||
"name": "business_connection_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": true,
|
||||
"description": "Unique identifier for the target chat",
|
||||
"html_description": "<td>Unique identifier for the target chat</td>",
|
||||
"rst_description": "Unique identifier for the target chat\n",
|
||||
"name": "chat_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": true,
|
||||
"description": "Unique identifier for the target message",
|
||||
"html_description": "<td>Unique identifier for the target message</td>",
|
||||
"rst_description": "Unique identifier for the target message\n",
|
||||
"name": "message_id"
|
||||
},
|
||||
{
|
||||
"type": "InputChecklist",
|
||||
"required": true,
|
||||
"description": "A JSON-serialized object for the new checklist",
|
||||
"html_description": "<td>A JSON-serialized object for the new checklist</td>",
|
||||
"rst_description": "A JSON-serialized object for the new checklist\n",
|
||||
"name": "checklist"
|
||||
},
|
||||
{
|
||||
"type": "InlineKeyboardMarkup",
|
||||
"required": false,
|
||||
"description": "A JSON-serialized object for the new inline keyboard for the message",
|
||||
"html_description": "<td>A JSON-serialized object for the new <a href=\"/bots/features#inline-keyboards\">inline keyboard</a> for the message</td>",
|
||||
"rst_description": "A JSON-serialized object for the new `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_ for the message\n",
|
||||
"name": "reply_markup"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
6
.butcher/methods/editMessageMedia/entity.json
generated
6
.butcher/methods/editMessageMedia/entity.json
generated
|
|
@ -7,9 +7,9 @@
|
|||
"object": {
|
||||
"anchor": "editmessagemedia",
|
||||
"name": "editMessageMedia",
|
||||
"description": "Use this method to edit animation, audio, document, photo, or video messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.",
|
||||
"html_description": "<p>Use this method to edit animation, audio, document, photo, or video messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited <a href=\"#message\">Message</a> is returned, otherwise <em>True</em> is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within <strong>48 hours</strong> from the time they were sent.</p>",
|
||||
"rst_description": "Use this method to edit animation, audio, document, photo, or video messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited :class:`aiogram.types.message.Message` is returned, otherwise :code:`True` is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within **48 hours** from the time they were sent.",
|
||||
"description": "Use this method to edit animation, audio, document, photo, or video messages, or to add media to text messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within 48 hours from the time they were sent.",
|
||||
"html_description": "<p>Use this method to edit animation, audio, document, photo, or video messages, or to add media to text messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited <a href=\"#message\">Message</a> is returned, otherwise <em>True</em> is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within <strong>48 hours</strong> from the time they were sent.</p>",
|
||||
"rst_description": "Use this method to edit animation, audio, document, photo, or video messages, or to add media to text messages. If a message is part of a message album, then it can be edited only to an audio for audio albums, only to a document for document albums and to a photo or a video otherwise. When an inline message is edited, a new file can't be uploaded; use a previously uploaded file via its file_id or specify a URL. On success, if the edited message is not an inline message, the edited :class:`aiogram.types.message.Message` is returned, otherwise :code:`True` is returned. Note that business messages that were not sent by the bot and do not contain an inline keyboard can only be edited within **48 hours** from the time they were sent.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "String",
|
||||
|
|
|
|||
|
|
@ -1,2 +1,3 @@
|
|||
disable_web_page_preview: link_preview_is_disabled
|
||||
link_preview_options: link_preview
|
||||
parse_mode: parse_mode
|
||||
|
|
|
|||
73
.butcher/methods/editStory/entity.json
generated
Normal file
73
.butcher/methods/editStory/entity.json
generated
Normal file
|
|
@ -0,0 +1,73 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Available methods",
|
||||
"anchor": "available-methods"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "editstory",
|
||||
"name": "editStory",
|
||||
"description": "Edits a story previously posted by the bot on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns Story on success.",
|
||||
"html_description": "<p>Edits a story previously posted by the bot on behalf of a managed business account. Requires the <em>can_manage_stories</em> business bot right. Returns <a href=\"#story\">Story</a> on success.</p>",
|
||||
"rst_description": "Edits a story previously posted by the bot on behalf of a managed business account. Requires the *can_manage_stories* business bot right. Returns :class:`aiogram.types.story.Story` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the business connection",
|
||||
"html_description": "<td>Unique identifier of the business connection</td>",
|
||||
"rst_description": "Unique identifier of the business connection\n",
|
||||
"name": "business_connection_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the story to edit",
|
||||
"html_description": "<td>Unique identifier of the story to edit</td>",
|
||||
"rst_description": "Unique identifier of the story to edit\n",
|
||||
"name": "story_id"
|
||||
},
|
||||
{
|
||||
"type": "InputStoryContent",
|
||||
"required": true,
|
||||
"description": "Content of the story",
|
||||
"html_description": "<td>Content of the story</td>",
|
||||
"rst_description": "Content of the story\n",
|
||||
"name": "content"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
"description": "Caption of the story, 0-2048 characters after entities parsing",
|
||||
"html_description": "<td>Caption of the story, 0-2048 characters after entities parsing</td>",
|
||||
"rst_description": "Caption of the story, 0-2048 characters after entities parsing\n",
|
||||
"name": "caption"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
"description": "Mode for parsing entities in the story caption. See formatting options for more details.",
|
||||
"html_description": "<td>Mode for parsing entities in the story caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
|
||||
"rst_description": "Mode for parsing entities in the story caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
|
||||
"name": "parse_mode"
|
||||
},
|
||||
{
|
||||
"type": "Array of MessageEntity",
|
||||
"required": false,
|
||||
"description": "A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode",
|
||||
"html_description": "<td>A JSON-serialized list of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em></td>",
|
||||
"rst_description": "A JSON-serialized list of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
|
||||
"name": "caption_entities"
|
||||
},
|
||||
{
|
||||
"type": "Array of StoryArea",
|
||||
"required": false,
|
||||
"description": "A JSON-serialized list of clickable areas to be shown on the story",
|
||||
"html_description": "<td>A JSON-serialized list of clickable areas to be shown on the story</td>",
|
||||
"rst_description": "A JSON-serialized list of clickable areas to be shown on the story\n",
|
||||
"name": "areas"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
41
.butcher/methods/editUserStarSubscription/entity.json
generated
Normal file
41
.butcher/methods/editUserStarSubscription/entity.json
generated
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Payments",
|
||||
"anchor": "payments"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "edituserstarsubscription",
|
||||
"name": "editUserStarSubscription",
|
||||
"description": "Allows the bot to cancel or re-enable extension of a subscription paid in Telegram Stars. Returns True on success.",
|
||||
"html_description": "<p>Allows the bot to cancel or re-enable extension of a subscription paid in Telegram Stars. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "Allows the bot to cancel or re-enable extension of a subscription paid in Telegram Stars. Returns :code:`True` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": true,
|
||||
"description": "Identifier of the user whose subscription will be edited",
|
||||
"html_description": "<td>Identifier of the user whose subscription will be edited</td>",
|
||||
"rst_description": "Identifier of the user whose subscription will be edited\n",
|
||||
"name": "user_id"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
"description": "Telegram payment identifier for the subscription",
|
||||
"html_description": "<td>Telegram payment identifier for the subscription</td>",
|
||||
"rst_description": "Telegram payment identifier for the subscription\n",
|
||||
"name": "telegram_payment_charge_id"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": true,
|
||||
"description": "Pass True to cancel extension of the user subscription; the subscription must be active up to the end of the current subscription period. Pass False to allow the user to re-enable a subscription that was previously canceled by the bot.",
|
||||
"html_description": "<td>Pass <em>True</em> to cancel extension of the user subscription; the subscription must be active up to the end of the current subscription period. Pass <em>False</em> to allow the user to re-enable a subscription that was previously canceled by the bot.</td>",
|
||||
"rst_description": "Pass :code:`True` to cancel extension of the user subscription; the subscription must be active up to the end of the current subscription period. Pass :code:`False` to allow the user to re-enable a subscription that was previously canceled by the bot.\n",
|
||||
"name": "is_canceled"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
38
.butcher/methods/forwardMessage/entity.json
generated
38
.butcher/methods/forwardMessage/entity.json
generated
|
|
@ -22,11 +22,19 @@
|
|||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
|
||||
"html_description": "<td>Unique identifier for the target message thread (topic) of the forum; for forum supergroups only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n",
|
||||
"description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
|
||||
"html_description": "<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
|
||||
"name": "message_thread_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Identifier of the direct messages topic to which the message will be forwarded; required if the message is forwarded to a direct messages chat",
|
||||
"html_description": "<td>Identifier of the direct messages topic to which the message will be forwarded; required if the message is forwarded to a direct messages chat</td>",
|
||||
"rst_description": "Identifier of the direct messages topic to which the message will be forwarded; required if the message is forwarded to a direct messages chat\n",
|
||||
"name": "direct_messages_topic_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer or String",
|
||||
"required": true,
|
||||
|
|
@ -35,6 +43,14 @@
|
|||
"rst_description": "Unique identifier for the chat where the original message was sent (or channel username in the format :code:`@channelusername`)\n",
|
||||
"name": "from_chat_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "New start timestamp for the forwarded video in the message",
|
||||
"html_description": "<td>New start timestamp for the forwarded video in the message</td>",
|
||||
"rst_description": "New start timestamp for the forwarded video in the message\n",
|
||||
"name": "video_start_timestamp"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
|
|
@ -51,6 +67,22 @@
|
|||
"rst_description": "Protects the contents of the forwarded message from forwarding and saving\n",
|
||||
"name": "protect_content"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
"description": "Unique identifier of the message effect to be added to the message; only available when forwarding to private chats",
|
||||
"html_description": "<td>Unique identifier of the message effect to be added to the message; only available when forwarding to private chats</td>",
|
||||
"rst_description": "Unique identifier of the message effect to be added to the message; only available when forwarding to private chats\n",
|
||||
"name": "message_effect_id"
|
||||
},
|
||||
{
|
||||
"type": "SuggestedPostParameters",
|
||||
"required": false,
|
||||
"description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only",
|
||||
"html_description": "<td>A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only</td>",
|
||||
"rst_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only\n",
|
||||
"name": "suggested_post_parameters"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": true,
|
||||
|
|
|
|||
11
.butcher/methods/forwardMessage/replace.yml
Normal file
11
.butcher/methods/forwardMessage/replace.yml
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
annotations:
|
||||
video_start_timestamp:
|
||||
parsed_type:
|
||||
type: union
|
||||
items:
|
||||
- type: std
|
||||
name: datetime.datetime
|
||||
- type: std
|
||||
name: datetime.timedelta
|
||||
- type: std
|
||||
name: int
|
||||
14
.butcher/methods/forwardMessages/entity.json
generated
14
.butcher/methods/forwardMessages/entity.json
generated
|
|
@ -22,11 +22,19 @@
|
|||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
|
||||
"html_description": "<td>Unique identifier for the target message thread (topic) of the forum; for forum supergroups only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n",
|
||||
"description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
|
||||
"html_description": "<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
|
||||
"name": "message_thread_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Identifier of the direct messages topic to which the messages will be forwarded; required if the messages are forwarded to a direct messages chat",
|
||||
"html_description": "<td>Identifier of the direct messages topic to which the messages will be forwarded; required if the messages are forwarded to a direct messages chat</td>",
|
||||
"rst_description": "Identifier of the direct messages topic to which the messages will be forwarded; required if the messages are forwarded to a direct messages chat\n",
|
||||
"name": "direct_messages_topic_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer or String",
|
||||
"required": true,
|
||||
|
|
|
|||
16
.butcher/methods/getAvailableGifts/entity.json
generated
Normal file
16
.butcher/methods/getAvailableGifts/entity.json
generated
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Available methods",
|
||||
"anchor": "available-methods"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "getavailablegifts",
|
||||
"name": "getAvailableGifts",
|
||||
"description": "Returns the list of gifts that can be sent by the bot to users and channel chats. Requires no parameters. Returns a Gifts object.",
|
||||
"html_description": "<p>Returns the list of gifts that can be sent by the bot to users and channel chats. Requires no parameters. Returns a <a href=\"#gifts\">Gifts</a> object.</p>",
|
||||
"rst_description": "Returns the list of gifts that can be sent by the bot to users and channel chats. Requires no parameters. Returns a :class:`aiogram.types.gifts.Gifts` object.",
|
||||
"annotations": [],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
117
.butcher/methods/getBusinessAccountGifts/entity.json
generated
Normal file
117
.butcher/methods/getBusinessAccountGifts/entity.json
generated
Normal file
|
|
@ -0,0 +1,117 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Available methods",
|
||||
"anchor": "available-methods"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "getbusinessaccountgifts",
|
||||
"name": "getBusinessAccountGifts",
|
||||
"description": "Returns the gifts received and owned by a managed business account. Requires the can_view_gifts_and_stars business bot right. Returns OwnedGifts on success.",
|
||||
"html_description": "<p>Returns the gifts received and owned by a managed business account. Requires the <em>can_view_gifts_and_stars</em> business bot right. Returns <a href=\"#ownedgifts\">OwnedGifts</a> on success.</p>",
|
||||
"rst_description": "Returns the gifts received and owned by a managed business account. Requires the *can_view_gifts_and_stars* business bot right. Returns :class:`aiogram.types.owned_gifts.OwnedGifts` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the business connection",
|
||||
"html_description": "<td>Unique identifier of the business connection</td>",
|
||||
"rst_description": "Unique identifier of the business connection\n",
|
||||
"name": "business_connection_id"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to exclude gifts that aren't saved to the account's profile page",
|
||||
"html_description": "<td>Pass <em>True</em> to exclude gifts that aren't saved to the account's profile page</td>",
|
||||
"rst_description": "Pass :code:`True` to exclude gifts that aren't saved to the account's profile page\n",
|
||||
"name": "exclude_unsaved"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to exclude gifts that are saved to the account's profile page",
|
||||
"html_description": "<td>Pass <em>True</em> to exclude gifts that are saved to the account's profile page</td>",
|
||||
"rst_description": "Pass :code:`True` to exclude gifts that are saved to the account's profile page\n",
|
||||
"name": "exclude_saved"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to exclude gifts that can be purchased an unlimited number of times",
|
||||
"html_description": "<td>Pass <em>True</em> to exclude gifts that can be purchased an unlimited number of times</td>",
|
||||
"rst_description": "Pass :code:`True` to exclude gifts that can be purchased an unlimited number of times\n",
|
||||
"name": "exclude_unlimited"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique",
|
||||
"html_description": "<td>Pass <em>True</em> to exclude gifts that can be purchased a limited number of times and can be upgraded to unique</td>",
|
||||
"rst_description": "Pass :code:`True` to exclude gifts that can be purchased a limited number of times and can be upgraded to unique\n",
|
||||
"name": "exclude_limited_upgradable"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique",
|
||||
"html_description": "<td>Pass <em>True</em> to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique</td>",
|
||||
"rst_description": "Pass :code:`True` to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique\n",
|
||||
"name": "exclude_limited_non_upgradable"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to exclude unique gifts",
|
||||
"html_description": "<td>Pass <em>True</em> to exclude unique gifts</td>",
|
||||
"rst_description": "Pass :code:`True` to exclude unique gifts\n",
|
||||
"name": "exclude_unique"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram",
|
||||
"html_description": "<td>Pass <em>True</em> to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram</td>",
|
||||
"rst_description": "Pass :code:`True` to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram\n",
|
||||
"name": "exclude_from_blockchain"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to sort results by gift price instead of send date. Sorting is applied before pagination.",
|
||||
"html_description": "<td>Pass <em>True</em> to sort results by gift price instead of send date. Sorting is applied before pagination.</td>",
|
||||
"rst_description": "Pass :code:`True` to sort results by gift price instead of send date. Sorting is applied before pagination.\n",
|
||||
"name": "sort_by_price"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
"description": "Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results",
|
||||
"html_description": "<td>Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results</td>",
|
||||
"rst_description": "Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results\n",
|
||||
"name": "offset"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "The maximum number of gifts to be returned; 1-100. Defaults to 100",
|
||||
"html_description": "<td>The maximum number of gifts to be returned; 1-100. Defaults to 100</td>",
|
||||
"rst_description": "The maximum number of gifts to be returned; 1-100. Defaults to 100\n",
|
||||
"name": "limit"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to exclude gifts that can be purchased a limited number of times",
|
||||
"html_description": "<td>Pass <em>True</em> to exclude gifts that can be purchased a limited number of times</td>",
|
||||
"rst_description": "Pass :code:`True` to exclude gifts that can be purchased a limited number of times\n",
|
||||
"name": "exclude_limited",
|
||||
"deprecated": {
|
||||
"version": "9.3",
|
||||
"release_date": "2025-12-31"
|
||||
}
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
25
.butcher/methods/getBusinessAccountStarBalance/entity.json
generated
Normal file
25
.butcher/methods/getBusinessAccountStarBalance/entity.json
generated
Normal file
|
|
@ -0,0 +1,25 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Available methods",
|
||||
"anchor": "available-methods"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "getbusinessaccountstarbalance",
|
||||
"name": "getBusinessAccountStarBalance",
|
||||
"description": "Returns the amount of Telegram Stars owned by a managed business account. Requires the can_view_gifts_and_stars business bot right. Returns StarAmount on success.",
|
||||
"html_description": "<p>Returns the amount of Telegram Stars owned by a managed business account. Requires the <em>can_view_gifts_and_stars</em> business bot right. Returns <a href=\"#staramount\">StarAmount</a> on success.</p>",
|
||||
"rst_description": "Returns the amount of Telegram Stars owned by a managed business account. Requires the *can_view_gifts_and_stars* business bot right. Returns :class:`aiogram.types.star_amount.StarAmount` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the business connection",
|
||||
"html_description": "<td>Unique identifier of the business connection</td>",
|
||||
"rst_description": "Unique identifier of the business connection\n",
|
||||
"name": "business_connection_id"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
105
.butcher/methods/getChatGifts/entity.json
generated
Normal file
105
.butcher/methods/getChatGifts/entity.json
generated
Normal file
|
|
@ -0,0 +1,105 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Available methods",
|
||||
"anchor": "available-methods"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "getchatgifts",
|
||||
"name": "getChatGifts",
|
||||
"description": "Returns the gifts owned by a chat. Returns OwnedGifts on success.",
|
||||
"html_description": "<p>Returns the gifts owned by a chat. Returns <a href=\"#ownedgifts\">OwnedGifts</a> on success.</p>",
|
||||
"rst_description": "Returns the gifts owned by a chat. Returns :class:`aiogram.types.owned_gifts.OwnedGifts` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "Integer or String",
|
||||
"required": true,
|
||||
"description": "Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
|
||||
"html_description": "<td>Unique identifier for the target chat or username of the target channel (in the format <code>@channelusername</code>)</td>",
|
||||
"rst_description": "Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n",
|
||||
"name": "chat_id"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to exclude gifts that aren't saved to the chat's profile page. Always True, unless the bot has the can_post_messages administrator right in the channel.",
|
||||
"html_description": "<td>Pass <em>True</em> to exclude gifts that aren't saved to the chat's profile page. Always <em>True</em>, unless the bot has the <em>can_post_messages</em> administrator right in the channel.</td>",
|
||||
"rst_description": "Pass :code:`True` to exclude gifts that aren't saved to the chat's profile page. Always :code:`True`, unless the bot has the *can_post_messages* administrator right in the channel.\n",
|
||||
"name": "exclude_unsaved"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to exclude gifts that are saved to the chat's profile page. Always False, unless the bot has the can_post_messages administrator right in the channel.",
|
||||
"html_description": "<td>Pass <em>True</em> to exclude gifts that are saved to the chat's profile page. Always <em>False</em>, unless the bot has the <em>can_post_messages</em> administrator right in the channel.</td>",
|
||||
"rst_description": "Pass :code:`True` to exclude gifts that are saved to the chat's profile page. Always :code:`False`, unless the bot has the *can_post_messages* administrator right in the channel.\n",
|
||||
"name": "exclude_saved"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to exclude gifts that can be purchased an unlimited number of times",
|
||||
"html_description": "<td>Pass <em>True</em> to exclude gifts that can be purchased an unlimited number of times</td>",
|
||||
"rst_description": "Pass :code:`True` to exclude gifts that can be purchased an unlimited number of times\n",
|
||||
"name": "exclude_unlimited"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique",
|
||||
"html_description": "<td>Pass <em>True</em> to exclude gifts that can be purchased a limited number of times and can be upgraded to unique</td>",
|
||||
"rst_description": "Pass :code:`True` to exclude gifts that can be purchased a limited number of times and can be upgraded to unique\n",
|
||||
"name": "exclude_limited_upgradable"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique",
|
||||
"html_description": "<td>Pass <em>True</em> to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique</td>",
|
||||
"rst_description": "Pass :code:`True` to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique\n",
|
||||
"name": "exclude_limited_non_upgradable"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram",
|
||||
"html_description": "<td>Pass <em>True</em> to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram</td>",
|
||||
"rst_description": "Pass :code:`True` to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram\n",
|
||||
"name": "exclude_from_blockchain"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to exclude unique gifts",
|
||||
"html_description": "<td>Pass <em>True</em> to exclude unique gifts</td>",
|
||||
"rst_description": "Pass :code:`True` to exclude unique gifts\n",
|
||||
"name": "exclude_unique"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to sort results by gift price instead of send date. Sorting is applied before pagination.",
|
||||
"html_description": "<td>Pass <em>True</em> to sort results by gift price instead of send date. Sorting is applied before pagination.</td>",
|
||||
"rst_description": "Pass :code:`True` to sort results by gift price instead of send date. Sorting is applied before pagination.\n",
|
||||
"name": "sort_by_price"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
"description": "Offset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results",
|
||||
"html_description": "<td>Offset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results</td>",
|
||||
"rst_description": "Offset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results\n",
|
||||
"name": "offset"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "The maximum number of gifts to be returned; 1-100. Defaults to 100",
|
||||
"html_description": "<td>The maximum number of gifts to be returned; 1-100. Defaults to 100</td>",
|
||||
"rst_description": "The maximum number of gifts to be returned; 1-100. Defaults to 100\n",
|
||||
"name": "limit"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
25
.butcher/methods/getManagedBotToken/entity.json
generated
Normal file
25
.butcher/methods/getManagedBotToken/entity.json
generated
Normal file
|
|
@ -0,0 +1,25 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Available methods",
|
||||
"anchor": "available-methods"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "getmanagedbottoken",
|
||||
"name": "getManagedBotToken",
|
||||
"description": "Use this method to get the token of a managed bot. Returns the token as String on success.",
|
||||
"html_description": "<p>Use this method to get the token of a managed bot. Returns the token as <em>String</em> on success.</p>",
|
||||
"rst_description": "Use this method to get the token of a managed bot. Returns the token as *String* on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": true,
|
||||
"description": "User identifier of the managed bot whose token will be returned",
|
||||
"html_description": "<td>User identifier of the managed bot whose token will be returned</td>",
|
||||
"rst_description": "User identifier of the managed bot whose token will be returned\n",
|
||||
"name": "user_id"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
16
.butcher/methods/getMyStarBalance/entity.json
generated
Normal file
16
.butcher/methods/getMyStarBalance/entity.json
generated
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Payments",
|
||||
"anchor": "payments"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "getmystarbalance",
|
||||
"name": "getMyStarBalance",
|
||||
"description": "A method to get the current Telegram Stars balance of the bot. Requires no parameters. On success, returns a StarAmount object.",
|
||||
"html_description": "<p>A method to get the current Telegram Stars balance of the bot. Requires no parameters. On success, returns a <a href=\"#staramount\">StarAmount</a> object.</p>",
|
||||
"rst_description": "A method to get the current Telegram Stars balance of the bot. Requires no parameters. On success, returns a :class:`aiogram.types.star_amount.StarAmount` object.",
|
||||
"annotations": [],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
6
.butcher/methods/getUpdates/entity.json
generated
6
.butcher/methods/getUpdates/entity.json
generated
|
|
@ -38,9 +38,9 @@
|
|||
{
|
||||
"type": "Array of String",
|
||||
"required": false,
|
||||
"description": "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, message_reaction, and message_reaction_count (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.",
|
||||
"html_description": "<td>A JSON-serialized list of the update types you want your bot to receive. For example, specify <code>[\"message\", \"edited_channel_post\", \"callback_query\"]</code> to only receive updates of these types. See <a href=\"#update\">Update</a> for a complete list of available update types. Specify an empty list to receive all update types except <em>chat_member</em>, <em>message_reaction</em>, and <em>message_reaction_count</em> (default). If not specified, the previous setting will be used.<br/>\n<br/>\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.</td>",
|
||||
"rst_description": "A JSON-serialized list of the update types you want your bot to receive. For example, specify :code:`[\"message\", \"edited_channel_post\", \"callback_query\"]` to only receive updates of these types. See :class:`aiogram.types.update.Update` for a complete list of available update types. Specify an empty list to receive all update types except *chat_member*, *message_reaction*, and *message_reaction_count* (default). If not specified, the previous setting will be used.\n\n\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.\n",
|
||||
"description": "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, message_reaction, and message_reaction_count (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 getUpdates, so unwanted updates may be received for a short period of time.",
|
||||
"html_description": "<td>A JSON-serialized list of the update types you want your bot to receive. For example, specify <code>[\"message\", \"edited_channel_post\", \"callback_query\"]</code> to only receive updates of these types. See <a href=\"#update\">Update</a> for a complete list of available update types. Specify an empty list to receive all update types except <em>chat_member</em>, <em>message_reaction</em>, and <em>message_reaction_count</em> (default). If not specified, the previous setting will be used.<br/>\n<br/>\nPlease note that this parameter doesn't affect updates created before the call to getUpdates, so unwanted updates may be received for a short period of time.</td>",
|
||||
"rst_description": "A JSON-serialized list of the update types you want your bot to receive. For example, specify :code:`[\"message\", \"edited_channel_post\", \"callback_query\"]` to only receive updates of these types. See :class:`aiogram.types.update.Update` for a complete list of available update types. Specify an empty list to receive all update types except *chat_member*, *message_reaction*, and *message_reaction_count* (default). If not specified, the previous setting will be used.\n\n\n\nPlease note that this parameter doesn't affect updates created before the call to getUpdates, so unwanted updates may be received for a short period of time.\n",
|
||||
"name": "allowed_updates"
|
||||
}
|
||||
],
|
||||
|
|
|
|||
89
.butcher/methods/getUserGifts/entity.json
generated
Normal file
89
.butcher/methods/getUserGifts/entity.json
generated
Normal file
|
|
@ -0,0 +1,89 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Available methods",
|
||||
"anchor": "available-methods"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "getusergifts",
|
||||
"name": "getUserGifts",
|
||||
"description": "Returns the gifts owned and hosted by a user. Returns OwnedGifts on success.",
|
||||
"html_description": "<p>Returns the gifts owned and hosted by a user. Returns <a href=\"#ownedgifts\">OwnedGifts</a> on success.</p>",
|
||||
"rst_description": "Returns the gifts owned and hosted by a user. Returns :class:`aiogram.types.owned_gifts.OwnedGifts` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the user",
|
||||
"html_description": "<td>Unique identifier of the user</td>",
|
||||
"rst_description": "Unique identifier of the user\n",
|
||||
"name": "user_id"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to exclude gifts that can be purchased an unlimited number of times",
|
||||
"html_description": "<td>Pass <em>True</em> to exclude gifts that can be purchased an unlimited number of times</td>",
|
||||
"rst_description": "Pass :code:`True` to exclude gifts that can be purchased an unlimited number of times\n",
|
||||
"name": "exclude_unlimited"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to exclude gifts that can be purchased a limited number of times and can be upgraded to unique",
|
||||
"html_description": "<td>Pass <em>True</em> to exclude gifts that can be purchased a limited number of times and can be upgraded to unique</td>",
|
||||
"rst_description": "Pass :code:`True` to exclude gifts that can be purchased a limited number of times and can be upgraded to unique\n",
|
||||
"name": "exclude_limited_upgradable"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique",
|
||||
"html_description": "<td>Pass <em>True</em> to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique</td>",
|
||||
"rst_description": "Pass :code:`True` to exclude gifts that can be purchased a limited number of times and can't be upgraded to unique\n",
|
||||
"name": "exclude_limited_non_upgradable"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram",
|
||||
"html_description": "<td>Pass <em>True</em> to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram</td>",
|
||||
"rst_description": "Pass :code:`True` to exclude gifts that were assigned from the TON blockchain and can't be resold or transferred in Telegram\n",
|
||||
"name": "exclude_from_blockchain"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to exclude unique gifts",
|
||||
"html_description": "<td>Pass <em>True</em> to exclude unique gifts</td>",
|
||||
"rst_description": "Pass :code:`True` to exclude unique gifts\n",
|
||||
"name": "exclude_unique"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to sort results by gift price instead of send date. Sorting is applied before pagination.",
|
||||
"html_description": "<td>Pass <em>True</em> to sort results by gift price instead of send date. Sorting is applied before pagination.</td>",
|
||||
"rst_description": "Pass :code:`True` to sort results by gift price instead of send date. Sorting is applied before pagination.\n",
|
||||
"name": "sort_by_price"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
"description": "Offset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results",
|
||||
"html_description": "<td>Offset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results</td>",
|
||||
"rst_description": "Offset of the first entry to return as received from the previous request; use an empty string to get the first chunk of results\n",
|
||||
"name": "offset"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "The maximum number of gifts to be returned; 1-100. Defaults to 100",
|
||||
"html_description": "<td>The maximum number of gifts to be returned; 1-100. Defaults to 100</td>",
|
||||
"rst_description": "The maximum number of gifts to be returned; 1-100. Defaults to 100\n",
|
||||
"name": "limit"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
41
.butcher/methods/getUserProfileAudios/entity.json
generated
Normal file
41
.butcher/methods/getUserProfileAudios/entity.json
generated
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Available methods",
|
||||
"anchor": "available-methods"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "getuserprofileaudios",
|
||||
"name": "getUserProfileAudios",
|
||||
"description": "Use this method to get a list of profile audios for a user. Returns a UserProfileAudios object.",
|
||||
"html_description": "<p>Use this method to get a list of profile audios for a user. Returns a <a href=\"#userprofileaudios\">UserProfileAudios</a> object.</p>",
|
||||
"rst_description": "Use this method to get a list of profile audios for a user. Returns a :class:`aiogram.types.user_profile_audios.UserProfileAudios` object.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the target user",
|
||||
"html_description": "<td>Unique identifier of the target user</td>",
|
||||
"rst_description": "Unique identifier of the target user\n",
|
||||
"name": "user_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Sequential number of the first audio to be returned. By default, all audios are returned.",
|
||||
"html_description": "<td>Sequential number of the first audio to be returned. By default, all audios are returned.</td>",
|
||||
"rst_description": "Sequential number of the first audio to be returned. By default, all audios are returned.\n",
|
||||
"name": "offset"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Limits the number of audios to be retrieved. Values between 1-100 are accepted. Defaults to 100.",
|
||||
"html_description": "<td>Limits the number of audios to be retrieved. Values between 1-100 are accepted. Defaults to 100.</td>",
|
||||
"rst_description": "Limits the number of audios to be retrieved. Values between 1-100 are accepted. Defaults to 100.\n",
|
||||
"name": "limit"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
65
.butcher/methods/giftPremiumSubscription/entity.json
generated
Normal file
65
.butcher/methods/giftPremiumSubscription/entity.json
generated
Normal file
|
|
@ -0,0 +1,65 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Available methods",
|
||||
"anchor": "available-methods"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "giftpremiumsubscription",
|
||||
"name": "giftPremiumSubscription",
|
||||
"description": "Gifts a Telegram Premium subscription to the given user. Returns True on success.",
|
||||
"html_description": "<p>Gifts a Telegram Premium subscription to the given user. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "Gifts a Telegram Premium subscription to the given user. Returns :code:`True` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the target user who will receive a Telegram Premium subscription",
|
||||
"html_description": "<td>Unique identifier of the target user who will receive a Telegram Premium subscription</td>",
|
||||
"rst_description": "Unique identifier of the target user who will receive a Telegram Premium subscription\n",
|
||||
"name": "user_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": true,
|
||||
"description": "Number of months the Telegram Premium subscription will be active for the user; must be one of 3, 6, or 12",
|
||||
"html_description": "<td>Number of months the Telegram Premium subscription will be active for the user; must be one of 3, 6, or 12</td>",
|
||||
"rst_description": "Number of months the Telegram Premium subscription will be active for the user; must be one of 3, 6, or 12\n",
|
||||
"name": "month_count"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": true,
|
||||
"description": "Number of Telegram Stars to pay for the Telegram Premium subscription; must be 1000 for 3 months, 1500 for 6 months, and 2500 for 12 months",
|
||||
"html_description": "<td>Number of Telegram Stars to pay for the Telegram Premium subscription; must be 1000 for 3 months, 1500 for 6 months, and 2500 for 12 months</td>",
|
||||
"rst_description": "Number of Telegram Stars to pay for the Telegram Premium subscription; must be 1000 for 3 months, 1500 for 6 months, and 2500 for 12 months\n",
|
||||
"name": "star_count"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
"description": "Text that will be shown along with the service message about the subscription; 0-128 characters",
|
||||
"html_description": "<td>Text that will be shown along with the service message about the subscription; 0-128 characters</td>",
|
||||
"rst_description": "Text that will be shown along with the service message about the subscription; 0-128 characters\n",
|
||||
"name": "text"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
"description": "Mode for parsing entities in the text. See formatting options for more details. Entities other than 'bold', 'italic', 'underline', 'strikethrough', 'spoiler', 'custom_emoji', and 'date_time' are ignored.",
|
||||
"html_description": "<td>Mode for parsing entities in the text. See <a href=\"#formatting-options\">formatting options</a> for more details. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, “custom_emoji”, and “date_time” are ignored.</td>",
|
||||
"rst_description": "Mode for parsing entities in the text. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details. Entities other than 'bold', 'italic', 'underline', 'strikethrough', 'spoiler', 'custom_emoji', and 'date_time' are ignored.\n",
|
||||
"name": "text_parse_mode"
|
||||
},
|
||||
{
|
||||
"type": "Array of MessageEntity",
|
||||
"required": false,
|
||||
"description": "A JSON-serialized list of special entities that appear in the gift text. It can be specified instead of text_parse_mode. Entities other than 'bold', 'italic', 'underline', 'strikethrough', 'spoiler', 'custom_emoji', and 'date_time' are ignored.",
|
||||
"html_description": "<td>A JSON-serialized list of special entities that appear in the gift text. It can be specified instead of <em>text_parse_mode</em>. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, “custom_emoji”, and “date_time” are ignored.</td>",
|
||||
"rst_description": "A JSON-serialized list of special entities that appear in the gift text. It can be specified instead of *text_parse_mode*. Entities other than 'bold', 'italic', 'underline', 'strikethrough', 'spoiler', 'custom_emoji', and 'date_time' are ignored.\n",
|
||||
"name": "text_entities"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
6
.butcher/methods/leaveChat/entity.json
generated
6
.butcher/methods/leaveChat/entity.json
generated
|
|
@ -14,9 +14,9 @@
|
|||
{
|
||||
"type": "Integer or String",
|
||||
"required": true,
|
||||
"description": "Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)",
|
||||
"html_description": "<td>Unique identifier for the target chat or username of the target supergroup or channel (in the format <code>@channelusername</code>)</td>",
|
||||
"rst_description": "Unique identifier for the target chat or username of the target supergroup or channel (in the format :code:`@channelusername`)\n",
|
||||
"description": "Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername). Channel direct messages chats aren't supported; leave the corresponding channel instead.",
|
||||
"html_description": "<td>Unique identifier for the target chat or username of the target supergroup or channel (in the format <code>@channelusername</code>). Channel direct messages chats aren't supported; leave the corresponding channel instead.</td>",
|
||||
"rst_description": "Unique identifier for the target chat or username of the target supergroup or channel (in the format :code:`@channelusername`). Channel direct messages chats aren't supported; leave the corresponding channel instead.\n",
|
||||
"name": "chat_id"
|
||||
}
|
||||
],
|
||||
|
|
|
|||
6
.butcher/methods/pinChatMessage/entity.json
generated
6
.butcher/methods/pinChatMessage/entity.json
generated
|
|
@ -7,9 +7,9 @@
|
|||
"object": {
|
||||
"anchor": "pinchatmessage",
|
||||
"name": "pinChatMessage",
|
||||
"description": "Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.",
|
||||
"html_description": "<p>Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "Use this method to add a message to the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns :code:`True` on success.",
|
||||
"description": "Use this method to add a message to the list of pinned messages in a chat. In private chats and channel direct messages chats, all non-service messages can be pinned. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to pin messages in groups and channels respectively. Returns True on success.",
|
||||
"html_description": "<p>Use this method to add a message to the list of pinned messages in a chat. In private chats and channel direct messages chats, all non-service messages can be pinned. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to pin messages in groups and channels respectively. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "Use this method to add a message to the list of pinned messages in a chat. In private chats and channel direct messages chats, all non-service messages can be pinned. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to pin messages in groups and channels respectively. Returns :code:`True` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "String",
|
||||
|
|
|
|||
89
.butcher/methods/postStory/entity.json
generated
Normal file
89
.butcher/methods/postStory/entity.json
generated
Normal file
|
|
@ -0,0 +1,89 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Available methods",
|
||||
"anchor": "available-methods"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "poststory",
|
||||
"name": "postStory",
|
||||
"description": "Posts a story on behalf of a managed business account. Requires the can_manage_stories business bot right. Returns Story on success.",
|
||||
"html_description": "<p>Posts a story on behalf of a managed business account. Requires the <em>can_manage_stories</em> business bot right. Returns <a href=\"#story\">Story</a> on success.</p>",
|
||||
"rst_description": "Posts a story on behalf of a managed business account. Requires the *can_manage_stories* business bot right. Returns :class:`aiogram.types.story.Story` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the business connection",
|
||||
"html_description": "<td>Unique identifier of the business connection</td>",
|
||||
"rst_description": "Unique identifier of the business connection\n",
|
||||
"name": "business_connection_id"
|
||||
},
|
||||
{
|
||||
"type": "InputStoryContent",
|
||||
"required": true,
|
||||
"description": "Content of the story",
|
||||
"html_description": "<td>Content of the story</td>",
|
||||
"rst_description": "Content of the story\n",
|
||||
"name": "content"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": true,
|
||||
"description": "Period after which the story is moved to the archive, in seconds; must be one of 6 * 3600, 12 * 3600, 86400, or 2 * 86400",
|
||||
"html_description": "<td>Period after which the story is moved to the archive, in seconds; must be one of <code>6 * 3600</code>, <code>12 * 3600</code>, <code>86400</code>, or <code>2 * 86400</code></td>",
|
||||
"rst_description": "Period after which the story is moved to the archive, in seconds; must be one of :code:`6 * 3600`, :code:`12 * 3600`, :code:`86400`, or :code:`2 * 86400`\n",
|
||||
"name": "active_period"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
"description": "Caption of the story, 0-2048 characters after entities parsing",
|
||||
"html_description": "<td>Caption of the story, 0-2048 characters after entities parsing</td>",
|
||||
"rst_description": "Caption of the story, 0-2048 characters after entities parsing\n",
|
||||
"name": "caption"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
"description": "Mode for parsing entities in the story caption. See formatting options for more details.",
|
||||
"html_description": "<td>Mode for parsing entities in the story caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
|
||||
"rst_description": "Mode for parsing entities in the story caption. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
|
||||
"name": "parse_mode"
|
||||
},
|
||||
{
|
||||
"type": "Array of MessageEntity",
|
||||
"required": false,
|
||||
"description": "A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode",
|
||||
"html_description": "<td>A JSON-serialized list of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em></td>",
|
||||
"rst_description": "A JSON-serialized list of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
|
||||
"name": "caption_entities"
|
||||
},
|
||||
{
|
||||
"type": "Array of StoryArea",
|
||||
"required": false,
|
||||
"description": "A JSON-serialized list of clickable areas to be shown on the story",
|
||||
"html_description": "<td>A JSON-serialized list of clickable areas to be shown on the story</td>",
|
||||
"rst_description": "A JSON-serialized list of clickable areas to be shown on the story\n",
|
||||
"name": "areas"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to keep the story accessible after it expires",
|
||||
"html_description": "<td>Pass <em>True</em> to keep the story accessible after it expires</td>",
|
||||
"rst_description": "Pass :code:`True` to keep the story accessible after it expires\n",
|
||||
"name": "post_to_chat_page"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True if the content of the story must be protected from forwarding and screenshotting",
|
||||
"html_description": "<td>Pass <em>True</em> if the content of the story must be protected from forwarding and screenshotting</td>",
|
||||
"rst_description": "Pass :code:`True` if the content of the story must be protected from forwarding and screenshotting\n",
|
||||
"name": "protect_content"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
34
.butcher/methods/promoteChatMember/entity.json
generated
34
.butcher/methods/promoteChatMember/entity.json
generated
|
|
@ -38,9 +38,9 @@
|
|||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages and ignore slow mode. Implied by any other administrator privilege.",
|
||||
"html_description": "<td>Pass <em>True</em> if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages and ignore slow mode. Implied by any other administrator privilege.</td>",
|
||||
"rst_description": "Pass :code:`True` if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages and ignore slow mode. Implied by any other administrator privilege.\n",
|
||||
"description": "Pass True if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege.",
|
||||
"html_description": "<td>Pass <em>True</em> if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege.</td>",
|
||||
"rst_description": "Pass :code:`True` if the administrator can access the chat event log, get boost list, see hidden supergroup and channel members, report spam messages, ignore slow mode, and send messages to the chat without paying Telegram Stars. Implied by any other administrator privilege.\n",
|
||||
"name": "can_manage_chat"
|
||||
},
|
||||
{
|
||||
|
|
@ -62,9 +62,9 @@
|
|||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True if the administrator can restrict, ban or unban chat members, or access supergroup statistics",
|
||||
"html_description": "<td>Pass <em>True</em> if the administrator can restrict, ban or unban chat members, or access supergroup statistics</td>",
|
||||
"rst_description": "Pass :code:`True` if the administrator can restrict, ban or unban chat members, or access supergroup statistics\n",
|
||||
"description": "Pass True if the administrator can restrict, ban or unban chat members, or access supergroup statistics. For backward compatibility, defaults to True for promotions of channel administrators",
|
||||
"html_description": "<td>Pass <em>True</em> if the administrator can restrict, ban or unban chat members, or access supergroup statistics. For backward compatibility, defaults to <em>True</em> for promotions of channel administrators</td>",
|
||||
"rst_description": "Pass :code:`True` if the administrator can restrict, ban or unban chat members, or access supergroup statistics. For backward compatibility, defaults to :code:`True` for promotions of channel administrators\n",
|
||||
"name": "can_restrict_members"
|
||||
},
|
||||
{
|
||||
|
|
@ -118,9 +118,9 @@
|
|||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True if the administrator can post messages in the channel, or access channel statistics; for channels only",
|
||||
"html_description": "<td>Pass <em>True</em> if the administrator can post messages in the channel, or access channel statistics; for channels only</td>",
|
||||
"rst_description": "Pass :code:`True` if the administrator can post messages in the channel, or access channel statistics; for channels only\n",
|
||||
"description": "Pass True if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only",
|
||||
"html_description": "<td>Pass <em>True</em> if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only</td>",
|
||||
"rst_description": "Pass :code:`True` if the administrator can post messages in the channel, approve suggested posts, or access channel statistics; for channels only\n",
|
||||
"name": "can_post_messages"
|
||||
},
|
||||
{
|
||||
|
|
@ -146,6 +146,22 @@
|
|||
"html_description": "<td>Pass <em>True</em> if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only</td>",
|
||||
"rst_description": "Pass :code:`True` if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only\n",
|
||||
"name": "can_manage_topics"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True if the administrator can manage direct messages within the channel and decline suggested posts; for channels only",
|
||||
"html_description": "<td>Pass <em>True</em> if the administrator can manage direct messages within the channel and decline suggested posts; for channels only</td>",
|
||||
"rst_description": "Pass :code:`True` if the administrator can manage direct messages within the channel and decline suggested posts; for channels only\n",
|
||||
"name": "can_manage_direct_messages"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True if the administrator can edit the tags of regular members; for groups and supergroups only",
|
||||
"html_description": "<td>Pass <em>True</em> if the administrator can edit the tags of regular members; for groups and supergroups only</td>",
|
||||
"rst_description": "Pass :code:`True` if the administrator can edit the tags of regular members; for groups and supergroups only\n",
|
||||
"name": "can_manage_tags"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
|
|
|
|||
41
.butcher/methods/readBusinessMessage/entity.json
generated
Normal file
41
.butcher/methods/readBusinessMessage/entity.json
generated
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Available methods",
|
||||
"anchor": "available-methods"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "readbusinessmessage",
|
||||
"name": "readBusinessMessage",
|
||||
"description": "Marks incoming message as read on behalf of a business account. Requires the can_read_messages business bot right. Returns True on success.",
|
||||
"html_description": "<p>Marks incoming message as read on behalf of a business account. Requires the <em>can_read_messages</em> business bot right. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "Marks incoming message as read on behalf of a business account. Requires the *can_read_messages* business bot right. Returns :code:`True` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the business connection on behalf of which to read the message",
|
||||
"html_description": "<td>Unique identifier of the business connection on behalf of which to read the message</td>",
|
||||
"rst_description": "Unique identifier of the business connection on behalf of which to read the message\n",
|
||||
"name": "business_connection_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the chat in which the message was received. The chat must have been active in the last 24 hours.",
|
||||
"html_description": "<td>Unique identifier of the chat in which the message was received. The chat must have been active in the last 24 hours.</td>",
|
||||
"rst_description": "Unique identifier of the chat in which the message was received. The chat must have been active in the last 24 hours.\n",
|
||||
"name": "chat_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the message to mark as read",
|
||||
"html_description": "<td>Unique identifier of the message to mark as read</td>",
|
||||
"rst_description": "Unique identifier of the message to mark as read\n",
|
||||
"name": "message_id"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
33
.butcher/methods/removeBusinessAccountProfilePhoto/entity.json
generated
Normal file
33
.butcher/methods/removeBusinessAccountProfilePhoto/entity.json
generated
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Available methods",
|
||||
"anchor": "available-methods"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "removebusinessaccountprofilephoto",
|
||||
"name": "removeBusinessAccountProfilePhoto",
|
||||
"description": "Removes the current profile photo of a managed business account. Requires the can_edit_profile_photo business bot right. Returns True on success.",
|
||||
"html_description": "<p>Removes the current profile photo of a managed business account. Requires the <em>can_edit_profile_photo</em> business bot right. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "Removes the current profile photo of a managed business account. Requires the *can_edit_profile_photo* business bot right. Returns :code:`True` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the business connection",
|
||||
"html_description": "<td>Unique identifier of the business connection</td>",
|
||||
"rst_description": "Unique identifier of the business connection\n",
|
||||
"name": "business_connection_id"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to remove the public photo, which is visible even if the main photo is hidden by the business account's privacy settings. After the main photo is removed, the previous profile photo (if present) becomes the main photo.",
|
||||
"html_description": "<td>Pass <em>True</em> to remove the public photo, which is visible even if the main photo is hidden by the business account's privacy settings. After the main photo is removed, the previous profile photo (if present) becomes the main photo.</td>",
|
||||
"rst_description": "Pass :code:`True` to remove the public photo, which is visible even if the main photo is hidden by the business account's privacy settings. After the main photo is removed, the previous profile photo (if present) becomes the main photo.\n",
|
||||
"name": "is_public"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
25
.butcher/methods/removeChatVerification/entity.json
generated
Normal file
25
.butcher/methods/removeChatVerification/entity.json
generated
Normal file
|
|
@ -0,0 +1,25 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Available methods",
|
||||
"anchor": "available-methods"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "removechatverification",
|
||||
"name": "removeChatVerification",
|
||||
"description": "Removes verification from a chat that is currently verified on behalf of the organization represented by the bot. Returns True on success.",
|
||||
"html_description": "<p>Removes verification from a chat that is currently verified <a href=\"https://telegram.org/verify#third-party-verification\">on behalf of the organization</a> represented by the bot. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "Removes verification from a chat that is currently verified `on behalf of the organization <https://telegram.org/verify#third-party-verification>`_ represented by the bot. Returns :code:`True` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "Integer or String",
|
||||
"required": true,
|
||||
"description": "Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
|
||||
"html_description": "<td>Unique identifier for the target chat or username of the target channel (in the format <code>@channelusername</code>)</td>",
|
||||
"rst_description": "Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n",
|
||||
"name": "chat_id"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
16
.butcher/methods/removeMyProfilePhoto/entity.json
generated
Normal file
16
.butcher/methods/removeMyProfilePhoto/entity.json
generated
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Available methods",
|
||||
"anchor": "available-methods"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "removemyprofilephoto",
|
||||
"name": "removeMyProfilePhoto",
|
||||
"description": "Removes the profile photo of the bot. Requires no parameters. Returns True on success.",
|
||||
"html_description": "<p>Removes the profile photo of the bot. Requires no parameters. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "Removes the profile photo of the bot. Requires no parameters. Returns :code:`True` on success.",
|
||||
"annotations": [],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
25
.butcher/methods/removeUserVerification/entity.json
generated
Normal file
25
.butcher/methods/removeUserVerification/entity.json
generated
Normal file
|
|
@ -0,0 +1,25 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Available methods",
|
||||
"anchor": "available-methods"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "removeuserverification",
|
||||
"name": "removeUserVerification",
|
||||
"description": "Removes verification from a user who is currently verified on behalf of the organization represented by the bot. Returns True on success.",
|
||||
"html_description": "<p>Removes verification from a user who is currently verified <a href=\"https://telegram.org/verify#third-party-verification\">on behalf of the organization</a> represented by the bot. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "Removes verification from a user who is currently verified `on behalf of the organization <https://telegram.org/verify#third-party-verification>`_ represented by the bot. Returns :code:`True` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the target user",
|
||||
"html_description": "<td>Unique identifier of the target user</td>",
|
||||
"rst_description": "Unique identifier of the target user\n",
|
||||
"name": "user_id"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
25
.butcher/methods/replaceManagedBotToken/entity.json
generated
Normal file
25
.butcher/methods/replaceManagedBotToken/entity.json
generated
Normal file
|
|
@ -0,0 +1,25 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Available methods",
|
||||
"anchor": "available-methods"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "replacemanagedbottoken",
|
||||
"name": "replaceManagedBotToken",
|
||||
"description": "Use this method to revoke the current token of a managed bot and generate a new one. Returns the new token as String on success.",
|
||||
"html_description": "<p>Use this method to revoke the current token of a managed bot and generate a new one. Returns the new token as <em>String</em> on success.</p>",
|
||||
"rst_description": "Use this method to revoke the current token of a managed bot and generate a new one. Returns the new token as *String* on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": true,
|
||||
"description": "User identifier of the managed bot whose token will be replaced",
|
||||
"html_description": "<td>User identifier of the managed bot whose token will be replaced</td>",
|
||||
"rst_description": "User identifier of the managed bot whose token will be replaced\n",
|
||||
"name": "user_id"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
65
.butcher/methods/repostStory/entity.json
generated
Normal file
65
.butcher/methods/repostStory/entity.json
generated
Normal file
|
|
@ -0,0 +1,65 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Available methods",
|
||||
"anchor": "available-methods"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "repoststory",
|
||||
"name": "repostStory",
|
||||
"description": "Reposts a story on behalf of a business account from another business account. Both business accounts must be managed by the same bot, and the story on the source account must have been posted (or reposted) by the bot. Requires the can_manage_stories business bot right for both business accounts. Returns Story on success.",
|
||||
"html_description": "<p>Reposts a story on behalf of a business account from another business account. Both business accounts must be managed by the same bot, and the story on the source account must have been posted (or reposted) by the bot. Requires the <em>can_manage_stories</em> business bot right for both business accounts. Returns <a href=\"#story\">Story</a> on success.</p>",
|
||||
"rst_description": "Reposts a story on behalf of a business account from another business account. Both business accounts must be managed by the same bot, and the story on the source account must have been posted (or reposted) by the bot. Requires the *can_manage_stories* business bot right for both business accounts. Returns :class:`aiogram.types.story.Story` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the business connection",
|
||||
"html_description": "<td>Unique identifier of the business connection</td>",
|
||||
"rst_description": "Unique identifier of the business connection\n",
|
||||
"name": "business_connection_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the chat which posted the story that should be reposted",
|
||||
"html_description": "<td>Unique identifier of the chat which posted the story that should be reposted</td>",
|
||||
"rst_description": "Unique identifier of the chat which posted the story that should be reposted\n",
|
||||
"name": "from_chat_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the story that should be reposted",
|
||||
"html_description": "<td>Unique identifier of the story that should be reposted</td>",
|
||||
"rst_description": "Unique identifier of the story that should be reposted\n",
|
||||
"name": "from_story_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": true,
|
||||
"description": "Period after which the story is moved to the archive, in seconds; must be one of 6 * 3600, 12 * 3600, 86400, or 2 * 86400",
|
||||
"html_description": "<td>Period after which the story is moved to the archive, in seconds; must be one of <code>6 * 3600</code>, <code>12 * 3600</code>, <code>86400</code>, or <code>2 * 86400</code></td>",
|
||||
"rst_description": "Period after which the story is moved to the archive, in seconds; must be one of :code:`6 * 3600`, :code:`12 * 3600`, :code:`86400`, or :code:`2 * 86400`\n",
|
||||
"name": "active_period"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to keep the story accessible after it expires",
|
||||
"html_description": "<td>Pass <em>True</em> to keep the story accessible after it expires</td>",
|
||||
"rst_description": "Pass :code:`True` to keep the story accessible after it expires\n",
|
||||
"name": "post_to_chat_page"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True if the content of the story must be protected from forwarding and screenshotting",
|
||||
"html_description": "<td>Pass <em>True</em> if the content of the story must be protected from forwarding and screenshotting</td>",
|
||||
"rst_description": "Pass :code:`True` if the content of the story must be protected from forwarding and screenshotting\n",
|
||||
"name": "protect_content"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
65
.butcher/methods/savePreparedInlineMessage/entity.json
generated
Normal file
65
.butcher/methods/savePreparedInlineMessage/entity.json
generated
Normal file
|
|
@ -0,0 +1,65 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Available methods",
|
||||
"anchor": "available-methods"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "savepreparedinlinemessage",
|
||||
"name": "savePreparedInlineMessage",
|
||||
"description": "Stores a message that can be sent by a user of a Mini App. Returns a PreparedInlineMessage object.",
|
||||
"html_description": "<p>Stores a message that can be sent by a user of a Mini App. Returns a <a href=\"#preparedinlinemessage\">PreparedInlineMessage</a> object.</p>",
|
||||
"rst_description": "Stores a message that can be sent by a user of a Mini App. Returns a :class:`aiogram.types.prepared_inline_message.PreparedInlineMessage` object.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the target user that can use the prepared message",
|
||||
"html_description": "<td>Unique identifier of the target user that can use the prepared message</td>",
|
||||
"rst_description": "Unique identifier of the target user that can use the prepared message\n",
|
||||
"name": "user_id"
|
||||
},
|
||||
{
|
||||
"type": "InlineQueryResult",
|
||||
"required": true,
|
||||
"description": "A JSON-serialized object describing the message to be sent",
|
||||
"html_description": "<td>A JSON-serialized object describing the message to be sent</td>",
|
||||
"rst_description": "A JSON-serialized object describing the message to be sent\n",
|
||||
"name": "result"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True if the message can be sent to private chats with users",
|
||||
"html_description": "<td>Pass <em>True</em> if the message can be sent to private chats with users</td>",
|
||||
"rst_description": "Pass :code:`True` if the message can be sent to private chats with users\n",
|
||||
"name": "allow_user_chats"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True if the message can be sent to private chats with bots",
|
||||
"html_description": "<td>Pass <em>True</em> if the message can be sent to private chats with bots</td>",
|
||||
"rst_description": "Pass :code:`True` if the message can be sent to private chats with bots\n",
|
||||
"name": "allow_bot_chats"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True if the message can be sent to group and supergroup chats",
|
||||
"html_description": "<td>Pass <em>True</em> if the message can be sent to group and supergroup chats</td>",
|
||||
"rst_description": "Pass :code:`True` if the message can be sent to group and supergroup chats\n",
|
||||
"name": "allow_group_chats"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True if the message can be sent to channel chats",
|
||||
"html_description": "<td>Pass <em>True</em> if the message can be sent to channel chats</td>",
|
||||
"rst_description": "Pass :code:`True` if the message can be sent to channel chats\n",
|
||||
"name": "allow_channel_chats"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
33
.butcher/methods/savePreparedKeyboardButton/entity.json
generated
Normal file
33
.butcher/methods/savePreparedKeyboardButton/entity.json
generated
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Available methods",
|
||||
"anchor": "available-methods"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "savepreparedkeyboardbutton",
|
||||
"name": "savePreparedKeyboardButton",
|
||||
"description": "Stores a keyboard button that can be used by a user within a Mini App. Returns a PreparedKeyboardButton object.",
|
||||
"html_description": "<p>Stores a keyboard button that can be used by a user within a Mini App. Returns a <a href=\"#preparedkeyboardbutton\">PreparedKeyboardButton</a> object.</p>",
|
||||
"rst_description": "Stores a keyboard button that can be used by a user within a Mini App. Returns a :class:`aiogram.types.prepared_keyboard_button.PreparedKeyboardButton` object.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the target user that can use the button",
|
||||
"html_description": "<td>Unique identifier of the target user that can use the button</td>",
|
||||
"rst_description": "Unique identifier of the target user that can use the button\n",
|
||||
"name": "user_id"
|
||||
},
|
||||
{
|
||||
"type": "KeyboardButton",
|
||||
"required": true,
|
||||
"description": "A JSON-serialized object describing the button to be saved. The button must be of the type request_users, request_chat, or request_managed_bot",
|
||||
"html_description": "<td>A JSON-serialized object describing the button to be saved. The button must be of the type <em>request_users</em>, <em>request_chat</em>, or <em>request_managed_bot</em></td>",
|
||||
"rst_description": "A JSON-serialized object describing the button to be saved. The button must be of the type *request_users*, *request_chat*, or *request_managed_bot*\n",
|
||||
"name": "button"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
30
.butcher/methods/sendAnimation/entity.json
generated
30
.butcher/methods/sendAnimation/entity.json
generated
|
|
@ -30,11 +30,19 @@
|
|||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
|
||||
"html_description": "<td>Unique identifier for the target message thread (topic) of the forum; for forum supergroups only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n",
|
||||
"description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
|
||||
"html_description": "<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
|
||||
"name": "message_thread_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
|
||||
"html_description": "<td>Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat</td>",
|
||||
"rst_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
|
||||
"name": "direct_messages_topic_id"
|
||||
},
|
||||
{
|
||||
"type": "InputFile or String",
|
||||
"required": true,
|
||||
|
|
@ -131,6 +139,14 @@
|
|||
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
|
||||
"name": "protect_content"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
|
||||
"html_description": "<td>Pass <em>True</em> to allow up to 1000 messages per second, ignoring <a href=\"https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once\">broadcasting limits</a> for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance</td>",
|
||||
"rst_description": "Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits <https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once>`_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
|
||||
"name": "allow_paid_broadcast"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
|
|
@ -139,6 +155,14 @@
|
|||
"rst_description": "Unique identifier of the message effect to be added to the message; for private chats only\n",
|
||||
"name": "message_effect_id"
|
||||
},
|
||||
{
|
||||
"type": "SuggestedPostParameters",
|
||||
"required": false,
|
||||
"description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
|
||||
"html_description": "<td>A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.</td>",
|
||||
"rst_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
|
||||
"name": "suggested_post_parameters"
|
||||
},
|
||||
{
|
||||
"type": "ReplyParameters",
|
||||
"required": false,
|
||||
|
|
|
|||
30
.butcher/methods/sendAudio/entity.json
generated
30
.butcher/methods/sendAudio/entity.json
generated
|
|
@ -30,11 +30,19 @@
|
|||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
|
||||
"html_description": "<td>Unique identifier for the target message thread (topic) of the forum; for forum supergroups only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n",
|
||||
"description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
|
||||
"html_description": "<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
|
||||
"name": "message_thread_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
|
||||
"html_description": "<td>Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat</td>",
|
||||
"rst_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
|
||||
"name": "direct_messages_topic_id"
|
||||
},
|
||||
{
|
||||
"type": "InputFile or String",
|
||||
"required": true,
|
||||
|
|
@ -115,6 +123,14 @@
|
|||
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
|
||||
"name": "protect_content"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
|
||||
"html_description": "<td>Pass <em>True</em> to allow up to 1000 messages per second, ignoring <a href=\"https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once\">broadcasting limits</a> for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance</td>",
|
||||
"rst_description": "Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits <https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once>`_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
|
||||
"name": "allow_paid_broadcast"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
|
|
@ -123,6 +139,14 @@
|
|||
"rst_description": "Unique identifier of the message effect to be added to the message; for private chats only\n",
|
||||
"name": "message_effect_id"
|
||||
},
|
||||
{
|
||||
"type": "SuggestedPostParameters",
|
||||
"required": false,
|
||||
"description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
|
||||
"html_description": "<td>A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.</td>",
|
||||
"rst_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
|
||||
"name": "suggested_post_parameters"
|
||||
},
|
||||
{
|
||||
"type": "ReplyParameters",
|
||||
"required": false,
|
||||
|
|
|
|||
12
.butcher/methods/sendChatAction/entity.json
generated
12
.butcher/methods/sendChatAction/entity.json
generated
|
|
@ -22,17 +22,17 @@
|
|||
{
|
||||
"type": "Integer or String",
|
||||
"required": true,
|
||||
"description": "Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
|
||||
"html_description": "<td>Unique identifier for the target chat or username of the target channel (in the format <code>@channelusername</code>)</td>",
|
||||
"rst_description": "Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n",
|
||||
"description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername). Channel chats and channel direct messages chats aren't supported.",
|
||||
"html_description": "<td>Unique identifier for the target chat or username of the target supergroup (in the format <code>@supergroupusername</code>). Channel chats and channel direct messages chats aren't supported.</td>",
|
||||
"rst_description": "Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`). Channel chats and channel direct messages chats aren't supported.\n",
|
||||
"name": "chat_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Unique identifier for the target message thread; for supergroups only",
|
||||
"html_description": "<td>Unique identifier for the target message thread; for supergroups only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread; for supergroups only\n",
|
||||
"description": "Unique identifier for the target message thread or topic of a forum; for supergroups and private chats of bots with forum topic mode enabled only",
|
||||
"html_description": "<td>Unique identifier for the target message thread or topic of a forum; for supergroups and private chats of bots with forum topic mode enabled only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread or topic of a forum; for supergroups and private chats of bots with forum topic mode enabled only\n",
|
||||
"name": "message_thread_id"
|
||||
},
|
||||
{
|
||||
|
|
|
|||
81
.butcher/methods/sendChecklist/entity.json
generated
Normal file
81
.butcher/methods/sendChecklist/entity.json
generated
Normal file
|
|
@ -0,0 +1,81 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Available methods",
|
||||
"anchor": "available-methods"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "sendchecklist",
|
||||
"name": "sendChecklist",
|
||||
"description": "Use this method to send a checklist on behalf of a connected business account. On success, the sent Message is returned.",
|
||||
"html_description": "<p>Use this method to send a checklist on behalf of a connected business account. On success, the sent <a href=\"#message\">Message</a> is returned.</p>",
|
||||
"rst_description": "Use this method to send a checklist on behalf of a connected business account. On success, the sent :class:`aiogram.types.message.Message` is returned.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the business connection on behalf of which the message will be sent",
|
||||
"html_description": "<td>Unique identifier of the business connection on behalf of which the message will be sent</td>",
|
||||
"rst_description": "Unique identifier of the business connection on behalf of which the message will be sent\n",
|
||||
"name": "business_connection_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": true,
|
||||
"description": "Unique identifier for the target chat",
|
||||
"html_description": "<td>Unique identifier for the target chat</td>",
|
||||
"rst_description": "Unique identifier for the target chat\n",
|
||||
"name": "chat_id"
|
||||
},
|
||||
{
|
||||
"type": "InputChecklist",
|
||||
"required": true,
|
||||
"description": "A JSON-serialized object for the checklist to send",
|
||||
"html_description": "<td>A JSON-serialized object for the checklist to send</td>",
|
||||
"rst_description": "A JSON-serialized object for the checklist to send\n",
|
||||
"name": "checklist"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Sends the message silently. Users will receive a notification with no sound.",
|
||||
"html_description": "<td>Sends the message silently. Users will receive a notification with no sound.</td>",
|
||||
"rst_description": "Sends the message silently. Users will receive a notification with no sound.\n",
|
||||
"name": "disable_notification"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Protects the contents of the sent message from forwarding and saving",
|
||||
"html_description": "<td>Protects the contents of the sent message from forwarding and saving</td>",
|
||||
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
|
||||
"name": "protect_content"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
"description": "Unique identifier of the message effect to be added to the message",
|
||||
"html_description": "<td>Unique identifier of the message effect to be added to the message</td>",
|
||||
"rst_description": "Unique identifier of the message effect to be added to the message\n",
|
||||
"name": "message_effect_id"
|
||||
},
|
||||
{
|
||||
"type": "ReplyParameters",
|
||||
"required": false,
|
||||
"description": "A JSON-serialized object for description of the message to reply to",
|
||||
"html_description": "<td>A JSON-serialized object for description of the message to reply to</td>",
|
||||
"rst_description": "A JSON-serialized object for description of the message to reply to\n",
|
||||
"name": "reply_parameters"
|
||||
},
|
||||
{
|
||||
"type": "InlineKeyboardMarkup",
|
||||
"required": false,
|
||||
"description": "A JSON-serialized object for an inline keyboard",
|
||||
"html_description": "<td>A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a></td>",
|
||||
"rst_description": "A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_\n",
|
||||
"name": "reply_markup"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
30
.butcher/methods/sendContact/entity.json
generated
30
.butcher/methods/sendContact/entity.json
generated
|
|
@ -30,11 +30,19 @@
|
|||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
|
||||
"html_description": "<td>Unique identifier for the target message thread (topic) of the forum; for forum supergroups only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n",
|
||||
"description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
|
||||
"html_description": "<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
|
||||
"name": "message_thread_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
|
||||
"html_description": "<td>Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat</td>",
|
||||
"rst_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
|
||||
"name": "direct_messages_topic_id"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
|
|
@ -83,6 +91,14 @@
|
|||
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
|
||||
"name": "protect_content"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
|
||||
"html_description": "<td>Pass <em>True</em> to allow up to 1000 messages per second, ignoring <a href=\"https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once\">broadcasting limits</a> for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance</td>",
|
||||
"rst_description": "Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits <https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once>`_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
|
||||
"name": "allow_paid_broadcast"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
|
|
@ -91,6 +107,14 @@
|
|||
"rst_description": "Unique identifier of the message effect to be added to the message; for private chats only\n",
|
||||
"name": "message_effect_id"
|
||||
},
|
||||
{
|
||||
"type": "SuggestedPostParameters",
|
||||
"required": false,
|
||||
"description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
|
||||
"html_description": "<td>A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.</td>",
|
||||
"rst_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
|
||||
"name": "suggested_post_parameters"
|
||||
},
|
||||
{
|
||||
"type": "ReplyParameters",
|
||||
"required": false,
|
||||
|
|
|
|||
30
.butcher/methods/sendDice/entity.json
generated
30
.butcher/methods/sendDice/entity.json
generated
|
|
@ -30,11 +30,19 @@
|
|||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
|
||||
"html_description": "<td>Unique identifier for the target message thread (topic) of the forum; for forum supergroups only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n",
|
||||
"description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
|
||||
"html_description": "<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
|
||||
"name": "message_thread_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
|
||||
"html_description": "<td>Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat</td>",
|
||||
"rst_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
|
||||
"name": "direct_messages_topic_id"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
|
|
@ -59,6 +67,14 @@
|
|||
"rst_description": "Protects the contents of the sent message from forwarding\n",
|
||||
"name": "protect_content"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
|
||||
"html_description": "<td>Pass <em>True</em> to allow up to 1000 messages per second, ignoring <a href=\"https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once\">broadcasting limits</a> for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance</td>",
|
||||
"rst_description": "Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits <https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once>`_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
|
||||
"name": "allow_paid_broadcast"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
|
|
@ -67,6 +83,14 @@
|
|||
"rst_description": "Unique identifier of the message effect to be added to the message; for private chats only\n",
|
||||
"name": "message_effect_id"
|
||||
},
|
||||
{
|
||||
"type": "SuggestedPostParameters",
|
||||
"required": false,
|
||||
"description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
|
||||
"html_description": "<td>A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.</td>",
|
||||
"rst_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
|
||||
"name": "suggested_post_parameters"
|
||||
},
|
||||
{
|
||||
"type": "ReplyParameters",
|
||||
"required": false,
|
||||
|
|
|
|||
30
.butcher/methods/sendDocument/entity.json
generated
30
.butcher/methods/sendDocument/entity.json
generated
|
|
@ -30,11 +30,19 @@
|
|||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
|
||||
"html_description": "<td>Unique identifier for the target message thread (topic) of the forum; for forum supergroups only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n",
|
||||
"description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
|
||||
"html_description": "<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
|
||||
"name": "message_thread_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
|
||||
"html_description": "<td>Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat</td>",
|
||||
"rst_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
|
||||
"name": "direct_messages_topic_id"
|
||||
},
|
||||
{
|
||||
"type": "InputFile or String",
|
||||
"required": true,
|
||||
|
|
@ -99,6 +107,14 @@
|
|||
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
|
||||
"name": "protect_content"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
|
||||
"html_description": "<td>Pass <em>True</em> to allow up to 1000 messages per second, ignoring <a href=\"https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once\">broadcasting limits</a> for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance</td>",
|
||||
"rst_description": "Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits <https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once>`_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
|
||||
"name": "allow_paid_broadcast"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
|
|
@ -107,6 +123,14 @@
|
|||
"rst_description": "Unique identifier of the message effect to be added to the message; for private chats only\n",
|
||||
"name": "message_effect_id"
|
||||
},
|
||||
{
|
||||
"type": "SuggestedPostParameters",
|
||||
"required": false,
|
||||
"description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
|
||||
"html_description": "<td>A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.</td>",
|
||||
"rst_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
|
||||
"name": "suggested_post_parameters"
|
||||
},
|
||||
{
|
||||
"type": "ReplyParameters",
|
||||
"required": false,
|
||||
|
|
|
|||
20
.butcher/methods/sendGame/entity.json
generated
20
.butcher/methods/sendGame/entity.json
generated
|
|
@ -22,17 +22,17 @@
|
|||
{
|
||||
"type": "Integer",
|
||||
"required": true,
|
||||
"description": "Unique identifier for the target chat",
|
||||
"html_description": "<td>Unique identifier for the target chat</td>",
|
||||
"rst_description": "Unique identifier for the target chat\n",
|
||||
"description": "Unique identifier for the target chat. Games can't be sent to channel direct messages chats and channel chats.",
|
||||
"html_description": "<td>Unique identifier for the target chat. Games can't be sent to channel direct messages chats and channel chats.</td>",
|
||||
"rst_description": "Unique identifier for the target chat. Games can't be sent to channel direct messages chats and channel chats.\n",
|
||||
"name": "chat_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
|
||||
"html_description": "<td>Unique identifier for the target message thread (topic) of the forum; for forum supergroups only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n",
|
||||
"description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
|
||||
"html_description": "<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
|
||||
"name": "message_thread_id"
|
||||
},
|
||||
{
|
||||
|
|
@ -59,6 +59,14 @@
|
|||
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
|
||||
"name": "protect_content"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
|
||||
"html_description": "<td>Pass <em>True</em> to allow up to 1000 messages per second, ignoring <a href=\"https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once\">broadcasting limits</a> for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance</td>",
|
||||
"rst_description": "Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits <https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once>`_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
|
||||
"name": "allow_paid_broadcast"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
|
|
|
|||
73
.butcher/methods/sendGift/entity.json
generated
Normal file
73
.butcher/methods/sendGift/entity.json
generated
Normal file
|
|
@ -0,0 +1,73 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Available methods",
|
||||
"anchor": "available-methods"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "sendgift",
|
||||
"name": "sendGift",
|
||||
"description": "Sends a gift to the given user or channel chat. The gift can't be converted to Telegram Stars by the receiver. Returns True on success.",
|
||||
"html_description": "<p>Sends a gift to the given user or channel chat. The gift can't be converted to Telegram Stars by the receiver. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "Sends a gift to the given user or channel chat. The gift can't be converted to Telegram Stars by the receiver. Returns :code:`True` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Required if chat_id is not specified. Unique identifier of the target user who will receive the gift.",
|
||||
"html_description": "<td>Required if <em>chat_id</em> is not specified. Unique identifier of the target user who will receive the gift.</td>",
|
||||
"rst_description": "Required if *chat_id* is not specified. Unique identifier of the target user who will receive the gift.\n",
|
||||
"name": "user_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer or String",
|
||||
"required": false,
|
||||
"description": "Required if user_id is not specified. Unique identifier for the chat or username of the channel (in the format @channelusername) that will receive the gift.",
|
||||
"html_description": "<td>Required if <em>user_id</em> is not specified. Unique identifier for the chat or username of the channel (in the format <code>@channelusername</code>) that will receive the gift.</td>",
|
||||
"rst_description": "Required if *user_id* is not specified. Unique identifier for the chat or username of the channel (in the format :code:`@channelusername`) that will receive the gift.\n",
|
||||
"name": "chat_id"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
"description": "Identifier of the gift; limited gifts can't be sent to channel chats",
|
||||
"html_description": "<td>Identifier of the gift; limited gifts can't be sent to channel chats</td>",
|
||||
"rst_description": "Identifier of the gift; limited gifts can't be sent to channel chats\n",
|
||||
"name": "gift_id"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to pay for the gift upgrade from the bot's balance, thereby making the upgrade free for the receiver",
|
||||
"html_description": "<td>Pass <em>True</em> to pay for the gift upgrade from the bot's balance, thereby making the upgrade free for the receiver</td>",
|
||||
"rst_description": "Pass :code:`True` to pay for the gift upgrade from the bot's balance, thereby making the upgrade free for the receiver\n",
|
||||
"name": "pay_for_upgrade"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
"description": "Text that will be shown along with the gift; 0-128 characters",
|
||||
"html_description": "<td>Text that will be shown along with the gift; 0-128 characters</td>",
|
||||
"rst_description": "Text that will be shown along with the gift; 0-128 characters\n",
|
||||
"name": "text"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
"description": "Mode for parsing entities in the text. See formatting options for more details. Entities other than 'bold', 'italic', 'underline', 'strikethrough', 'spoiler', 'custom_emoji', and 'date_time' are ignored.",
|
||||
"html_description": "<td>Mode for parsing entities in the text. See <a href=\"#formatting-options\">formatting options</a> for more details. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, “custom_emoji”, and “date_time” are ignored.</td>",
|
||||
"rst_description": "Mode for parsing entities in the text. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details. Entities other than 'bold', 'italic', 'underline', 'strikethrough', 'spoiler', 'custom_emoji', and 'date_time' are ignored.\n",
|
||||
"name": "text_parse_mode"
|
||||
},
|
||||
{
|
||||
"type": "Array of MessageEntity",
|
||||
"required": false,
|
||||
"description": "A JSON-serialized list of special entities that appear in the gift text. It can be specified instead of text_parse_mode. Entities other than 'bold', 'italic', 'underline', 'strikethrough', 'spoiler', 'custom_emoji', and 'date_time' are ignored.",
|
||||
"html_description": "<td>A JSON-serialized list of special entities that appear in the gift text. It can be specified instead of <em>text_parse_mode</em>. Entities other than “bold”, “italic”, “underline”, “strikethrough”, “spoiler”, “custom_emoji”, and “date_time” are ignored.</td>",
|
||||
"rst_description": "A JSON-serialized list of special entities that appear in the gift text. It can be specified instead of *text_parse_mode*. Entities other than 'bold', 'italic', 'underline', 'strikethrough', 'spoiler', 'custom_emoji', and 'date_time' are ignored.\n",
|
||||
"name": "text_entities"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
36
.butcher/methods/sendInvoice/entity.json
generated
36
.butcher/methods/sendInvoice/entity.json
generated
|
|
@ -22,11 +22,19 @@
|
|||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
|
||||
"html_description": "<td>Unique identifier for the target message thread (topic) of the forum; for forum supergroups only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n",
|
||||
"description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
|
||||
"html_description": "<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
|
||||
"name": "message_thread_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
|
||||
"html_description": "<td>Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat</td>",
|
||||
"rst_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
|
||||
"name": "direct_messages_topic_id"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
|
|
@ -46,9 +54,9 @@
|
|||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
"description": "Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.",
|
||||
"html_description": "<td>Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.</td>",
|
||||
"rst_description": "Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.\n",
|
||||
"description": "Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes.",
|
||||
"html_description": "<td>Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes.</td>",
|
||||
"rst_description": "Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal processes.\n",
|
||||
"name": "payload"
|
||||
},
|
||||
{
|
||||
|
|
@ -211,6 +219,14 @@
|
|||
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
|
||||
"name": "protect_content"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
|
||||
"html_description": "<td>Pass <em>True</em> to allow up to 1000 messages per second, ignoring <a href=\"https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once\">broadcasting limits</a> for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance</td>",
|
||||
"rst_description": "Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits <https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once>`_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
|
||||
"name": "allow_paid_broadcast"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
|
|
@ -219,6 +235,14 @@
|
|||
"rst_description": "Unique identifier of the message effect to be added to the message; for private chats only\n",
|
||||
"name": "message_effect_id"
|
||||
},
|
||||
{
|
||||
"type": "SuggestedPostParameters",
|
||||
"required": false,
|
||||
"description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
|
||||
"html_description": "<td>A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.</td>",
|
||||
"rst_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
|
||||
"name": "suggested_post_parameters"
|
||||
},
|
||||
{
|
||||
"type": "ReplyParameters",
|
||||
"required": false,
|
||||
|
|
|
|||
30
.butcher/methods/sendLocation/entity.json
generated
30
.butcher/methods/sendLocation/entity.json
generated
|
|
@ -30,11 +30,19 @@
|
|||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
|
||||
"html_description": "<td>Unique identifier for the target message thread (topic) of the forum; for forum supergroups only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n",
|
||||
"description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
|
||||
"html_description": "<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
|
||||
"name": "message_thread_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
|
||||
"html_description": "<td>Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat</td>",
|
||||
"rst_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
|
||||
"name": "direct_messages_topic_id"
|
||||
},
|
||||
{
|
||||
"type": "Float",
|
||||
"required": true,
|
||||
|
|
@ -99,6 +107,14 @@
|
|||
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
|
||||
"name": "protect_content"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
|
||||
"html_description": "<td>Pass <em>True</em> to allow up to 1000 messages per second, ignoring <a href=\"https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once\">broadcasting limits</a> for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance</td>",
|
||||
"rst_description": "Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits <https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once>`_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
|
||||
"name": "allow_paid_broadcast"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
|
|
@ -107,6 +123,14 @@
|
|||
"rst_description": "Unique identifier of the message effect to be added to the message; for private chats only\n",
|
||||
"name": "message_effect_id"
|
||||
},
|
||||
{
|
||||
"type": "SuggestedPostParameters",
|
||||
"required": false,
|
||||
"description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
|
||||
"html_description": "<td>A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.</td>",
|
||||
"rst_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
|
||||
"name": "suggested_post_parameters"
|
||||
},
|
||||
{
|
||||
"type": "ReplyParameters",
|
||||
"required": false,
|
||||
|
|
|
|||
28
.butcher/methods/sendMediaGroup/entity.json
generated
28
.butcher/methods/sendMediaGroup/entity.json
generated
|
|
@ -7,9 +7,9 @@
|
|||
"object": {
|
||||
"anchor": "sendmediagroup",
|
||||
"name": "sendMediaGroup",
|
||||
"description": "Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of Messages that were sent is returned.",
|
||||
"html_description": "<p>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 <a href=\"#message\">Messages</a> that were sent is returned.</p>",
|
||||
"rst_description": "Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of `Messages <https://core.telegram.org/bots/api#message>`_ that were sent is returned.",
|
||||
"description": "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 objects that were sent is returned.",
|
||||
"html_description": "<p>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 <a href=\"#message\">Message</a> objects that were sent is returned.</p>",
|
||||
"rst_description": "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 :class:`aiogram.types.message.Message` objects that were sent is returned.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "String",
|
||||
|
|
@ -30,11 +30,19 @@
|
|||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
|
||||
"html_description": "<td>Unique identifier for the target message thread (topic) of the forum; for forum supergroups only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n",
|
||||
"description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
|
||||
"html_description": "<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
|
||||
"name": "message_thread_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Identifier of the direct messages topic to which the messages will be sent; required if the messages are sent to a direct messages chat",
|
||||
"html_description": "<td>Identifier of the direct messages topic to which the messages will be sent; required if the messages are sent to a direct messages chat</td>",
|
||||
"rst_description": "Identifier of the direct messages topic to which the messages will be sent; required if the messages are sent to a direct messages chat\n",
|
||||
"name": "direct_messages_topic_id"
|
||||
},
|
||||
{
|
||||
"type": "Array of InputMediaAudio, InputMediaDocument, InputMediaPhoto and InputMediaVideo",
|
||||
"required": true,
|
||||
|
|
@ -59,6 +67,14 @@
|
|||
"rst_description": "Protects the contents of the sent messages from forwarding and saving\n",
|
||||
"name": "protect_content"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
|
||||
"html_description": "<td>Pass <em>True</em> to allow up to 1000 messages per second, ignoring <a href=\"https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once\">broadcasting limits</a> for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance</td>",
|
||||
"rst_description": "Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits <https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once>`_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
|
||||
"name": "allow_paid_broadcast"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
|
|
|
|||
30
.butcher/methods/sendMessage/entity.json
generated
30
.butcher/methods/sendMessage/entity.json
generated
|
|
@ -30,11 +30,19 @@
|
|||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
|
||||
"html_description": "<td>Unique identifier for the target message thread (topic) of the forum; for forum supergroups only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n",
|
||||
"description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
|
||||
"html_description": "<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
|
||||
"name": "message_thread_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
|
||||
"html_description": "<td>Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat</td>",
|
||||
"rst_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
|
||||
"name": "direct_messages_topic_id"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
|
|
@ -83,6 +91,14 @@
|
|||
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
|
||||
"name": "protect_content"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
|
||||
"html_description": "<td>Pass <em>True</em> to allow up to 1000 messages per second, ignoring <a href=\"https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once\">broadcasting limits</a> for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance</td>",
|
||||
"rst_description": "Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits <https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once>`_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
|
||||
"name": "allow_paid_broadcast"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
|
|
@ -91,6 +107,14 @@
|
|||
"rst_description": "Unique identifier of the message effect to be added to the message; for private chats only\n",
|
||||
"name": "message_effect_id"
|
||||
},
|
||||
{
|
||||
"type": "SuggestedPostParameters",
|
||||
"required": false,
|
||||
"description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
|
||||
"html_description": "<td>A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.</td>",
|
||||
"rst_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
|
||||
"name": "suggested_post_parameters"
|
||||
},
|
||||
{
|
||||
"type": "ReplyParameters",
|
||||
"required": false,
|
||||
|
|
|
|||
65
.butcher/methods/sendMessageDraft/entity.json
generated
Normal file
65
.butcher/methods/sendMessageDraft/entity.json
generated
Normal file
|
|
@ -0,0 +1,65 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Available methods",
|
||||
"anchor": "available-methods"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "sendmessagedraft",
|
||||
"name": "sendMessageDraft",
|
||||
"description": "Use this method to stream a partial message to a user while the message is being generated. Returns True on success.",
|
||||
"html_description": "<p>Use this method to stream a partial message to a user while the message is being generated. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "Use this method to stream a partial message to a user while the message is being generated. Returns :code:`True` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": true,
|
||||
"description": "Unique identifier for the target private chat",
|
||||
"html_description": "<td>Unique identifier for the target private chat</td>",
|
||||
"rst_description": "Unique identifier for the target private chat\n",
|
||||
"name": "chat_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Unique identifier for the target message thread",
|
||||
"html_description": "<td>Unique identifier for the target message thread</td>",
|
||||
"rst_description": "Unique identifier for the target message thread\n",
|
||||
"name": "message_thread_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the message draft; must be non-zero. Changes of drafts with the same identifier are animated",
|
||||
"html_description": "<td>Unique identifier of the message draft; must be non-zero. Changes of drafts with the same identifier are animated</td>",
|
||||
"rst_description": "Unique identifier of the message draft; must be non-zero. Changes of drafts with the same identifier are animated\n",
|
||||
"name": "draft_id"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
"description": "Text of the message to be sent, 1-4096 characters after entities parsing",
|
||||
"html_description": "<td>Text of the message to be sent, 1-4096 characters after entities parsing</td>",
|
||||
"rst_description": "Text of the message to be sent, 1-4096 characters after entities parsing\n",
|
||||
"name": "text"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
"description": "Mode for parsing entities in the message text. See formatting options for more details.",
|
||||
"html_description": "<td>Mode for parsing entities in the message text. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
|
||||
"rst_description": "Mode for parsing entities in the message text. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
|
||||
"name": "parse_mode"
|
||||
},
|
||||
{
|
||||
"type": "Array of MessageEntity",
|
||||
"required": false,
|
||||
"description": "A JSON-serialized list of special entities that appear in message text, which can be specified instead of parse_mode",
|
||||
"html_description": "<td>A JSON-serialized list of special entities that appear in message text, which can be specified instead of <em>parse_mode</em></td>",
|
||||
"rst_description": "A JSON-serialized list of special entities that appear in message text, which can be specified instead of *parse_mode*\n",
|
||||
"name": "entities"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
66
.butcher/methods/sendPaidMedia/entity.json
generated
66
.butcher/methods/sendPaidMedia/entity.json
generated
|
|
@ -7,24 +7,48 @@
|
|||
"object": {
|
||||
"anchor": "sendpaidmedia",
|
||||
"name": "sendPaidMedia",
|
||||
"description": "Use this method to send paid media to channel chats. On success, the sent Message is returned.",
|
||||
"html_description": "<p>Use this method to send paid media to channel chats. On success, the sent <a href=\"#message\">Message</a> is returned.</p>",
|
||||
"rst_description": "Use this method to send paid media to channel chats. On success, the sent :class:`aiogram.types.message.Message` is returned.",
|
||||
"description": "Use this method to send paid media. On success, the sent Message is returned.",
|
||||
"html_description": "<p>Use this method to send paid media. On success, the sent <a href=\"#message\">Message</a> is returned.</p>",
|
||||
"rst_description": "Use this method to send paid media. On success, the sent :class:`aiogram.types.message.Message` is returned.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
"description": "Unique identifier of the business connection on behalf of which the message will be sent",
|
||||
"html_description": "<td>Unique identifier of the business connection on behalf of which the message will be sent</td>",
|
||||
"rst_description": "Unique identifier of the business connection on behalf of which the message will be sent\n",
|
||||
"name": "business_connection_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer or String",
|
||||
"required": true,
|
||||
"description": "Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
|
||||
"html_description": "<td>Unique identifier for the target chat or username of the target channel (in the format <code>@channelusername</code>)</td>",
|
||||
"rst_description": "Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n",
|
||||
"description": "Unique identifier for the target chat or username of the target channel (in the format @channelusername). If the chat is a channel, all Telegram Star proceeds from this media will be credited to the chat's balance. Otherwise, they will be credited to the bot's balance.",
|
||||
"html_description": "<td>Unique identifier for the target chat or username of the target channel (in the format <code>@channelusername</code>). If the chat is a channel, all Telegram Star proceeds from this media will be credited to the chat's balance. Otherwise, they will be credited to the bot's balance.</td>",
|
||||
"rst_description": "Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`). If the chat is a channel, all Telegram Star proceeds from this media will be credited to the chat's balance. Otherwise, they will be credited to the bot's balance.\n",
|
||||
"name": "chat_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
|
||||
"html_description": "<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
|
||||
"name": "message_thread_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
|
||||
"html_description": "<td>Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat</td>",
|
||||
"rst_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
|
||||
"name": "direct_messages_topic_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": true,
|
||||
"description": "The number of Telegram Stars that must be paid to buy access to the media",
|
||||
"html_description": "<td>The number of Telegram Stars that must be paid to buy access to the media</td>",
|
||||
"rst_description": "The number of Telegram Stars that must be paid to buy access to the media\n",
|
||||
"description": "The number of Telegram Stars that must be paid to buy access to the media; 1-25000",
|
||||
"html_description": "<td>The number of Telegram Stars that must be paid to buy access to the media; 1-25000</td>",
|
||||
"rst_description": "The number of Telegram Stars that must be paid to buy access to the media; 1-25000\n",
|
||||
"name": "star_count"
|
||||
},
|
||||
{
|
||||
|
|
@ -35,6 +59,14 @@
|
|||
"rst_description": "A JSON-serialized array describing the media to be sent; up to 10 items\n",
|
||||
"name": "media"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
"description": "Bot-defined paid media payload, 0-128 bytes. This will not be displayed to the user, use it for your internal processes.",
|
||||
"html_description": "<td>Bot-defined paid media payload, 0-128 bytes. This will not be displayed to the user, use it for your internal processes.</td>",
|
||||
"rst_description": "Bot-defined paid media payload, 0-128 bytes. This will not be displayed to the user, use it for your internal processes.\n",
|
||||
"name": "payload"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
|
|
@ -83,6 +115,22 @@
|
|||
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
|
||||
"name": "protect_content"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
|
||||
"html_description": "<td>Pass <em>True</em> to allow up to 1000 messages per second, ignoring <a href=\"https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once\">broadcasting limits</a> for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance</td>",
|
||||
"rst_description": "Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits <https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once>`_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
|
||||
"name": "allow_paid_broadcast"
|
||||
},
|
||||
{
|
||||
"type": "SuggestedPostParameters",
|
||||
"required": false,
|
||||
"description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
|
||||
"html_description": "<td>A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.</td>",
|
||||
"rst_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
|
||||
"name": "suggested_post_parameters"
|
||||
},
|
||||
{
|
||||
"type": "ReplyParameters",
|
||||
"required": false,
|
||||
|
|
|
|||
30
.butcher/methods/sendPhoto/entity.json
generated
30
.butcher/methods/sendPhoto/entity.json
generated
|
|
@ -30,11 +30,19 @@
|
|||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
|
||||
"html_description": "<td>Unique identifier for the target message thread (topic) of the forum; for forum supergroups only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n",
|
||||
"description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
|
||||
"html_description": "<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
|
||||
"name": "message_thread_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
|
||||
"html_description": "<td>Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat</td>",
|
||||
"rst_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
|
||||
"name": "direct_messages_topic_id"
|
||||
},
|
||||
{
|
||||
"type": "InputFile or String",
|
||||
"required": true,
|
||||
|
|
@ -99,6 +107,14 @@
|
|||
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
|
||||
"name": "protect_content"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
|
||||
"html_description": "<td>Pass <em>True</em> to allow up to 1000 messages per second, ignoring <a href=\"https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once\">broadcasting limits</a> for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance</td>",
|
||||
"rst_description": "Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits <https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once>`_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
|
||||
"name": "allow_paid_broadcast"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
|
|
@ -107,6 +123,14 @@
|
|||
"rst_description": "Unique identifier of the message effect to be added to the message; for private chats only\n",
|
||||
"name": "message_effect_id"
|
||||
},
|
||||
{
|
||||
"type": "SuggestedPostParameters",
|
||||
"required": false,
|
||||
"description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
|
||||
"html_description": "<td>A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.</td>",
|
||||
"rst_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
|
||||
"name": "suggested_post_parameters"
|
||||
},
|
||||
{
|
||||
"type": "ReplyParameters",
|
||||
"required": false,
|
||||
|
|
|
|||
|
|
@ -1,3 +1,4 @@
|
|||
explanation_parse_mode: parse_mode
|
||||
question_parse_mode: parse_mode
|
||||
description_parse_mode: parse_mode
|
||||
protect_content: protect_content
|
||||
|
|
|
|||
122
.butcher/methods/sendPoll/entity.json
generated
122
.butcher/methods/sendPoll/entity.json
generated
|
|
@ -22,17 +22,17 @@
|
|||
{
|
||||
"type": "Integer or String",
|
||||
"required": true,
|
||||
"description": "Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
|
||||
"html_description": "<td>Unique identifier for the target chat or username of the target channel (in the format <code>@channelusername</code>)</td>",
|
||||
"rst_description": "Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n",
|
||||
"description": "Unique identifier for the target chat or username of the target channel (in the format @channelusername). Polls can't be sent to channel direct messages chats.",
|
||||
"html_description": "<td>Unique identifier for the target chat or username of the target channel (in the format <code>@channelusername</code>). Polls can't be sent to channel direct messages chats.</td>",
|
||||
"rst_description": "Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`). Polls can't be sent to channel direct messages chats.\n",
|
||||
"name": "chat_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
|
||||
"html_description": "<td>Unique identifier for the target message thread (topic) of the forum; for forum supergroups only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n",
|
||||
"description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
|
||||
"html_description": "<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
|
||||
"name": "message_thread_id"
|
||||
},
|
||||
{
|
||||
|
|
@ -62,9 +62,9 @@
|
|||
{
|
||||
"type": "Array of InputPollOption",
|
||||
"required": true,
|
||||
"description": "A JSON-serialized list of 2-10 answer options",
|
||||
"html_description": "<td>A JSON-serialized list of 2-10 answer options</td>",
|
||||
"rst_description": "A JSON-serialized list of 2-10 answer options\n",
|
||||
"description": "A JSON-serialized list of 2-12 answer options",
|
||||
"html_description": "<td>A JSON-serialized list of 2-12 answer options</td>",
|
||||
"rst_description": "A JSON-serialized list of 2-12 answer options\n",
|
||||
"name": "options"
|
||||
},
|
||||
{
|
||||
|
|
@ -86,18 +86,50 @@
|
|||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "True, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to False",
|
||||
"html_description": "<td><em>True</em>, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to <em>False</em></td>",
|
||||
"rst_description": ":code:`True`, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to :code:`False`\n",
|
||||
"description": "Pass True, if the poll allows multiple answers, defaults to False",
|
||||
"html_description": "<td>Pass <em>True</em>, if the poll allows multiple answers, defaults to <em>False</em></td>",
|
||||
"rst_description": "Pass :code:`True`, if the poll allows multiple answers, defaults to :code:`False`\n",
|
||||
"name": "allows_multiple_answers"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "0-based identifier of the correct answer option, required for polls in quiz mode",
|
||||
"html_description": "<td>0-based identifier of the correct answer option, required for polls in quiz mode</td>",
|
||||
"rst_description": "0-based identifier of the correct answer option, required for polls in quiz mode\n",
|
||||
"name": "correct_option_id"
|
||||
"description": "Pass True, if the poll allows to change chosen answer options, defaults to False for quizzes and to True for regular polls",
|
||||
"html_description": "<td>Pass <em>True</em>, if the poll allows to change chosen answer options, defaults to <em>False</em> for quizzes and to <em>True</em> for regular polls</td>",
|
||||
"rst_description": "Pass :code:`True`, if the poll allows to change chosen answer options, defaults to :code:`False` for quizzes and to :code:`True` for regular polls\n",
|
||||
"name": "allows_revoting"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True, if the poll options must be shown in random order",
|
||||
"html_description": "<td>Pass <em>True</em>, if the poll options must be shown in random order</td>",
|
||||
"rst_description": "Pass :code:`True`, if the poll options must be shown in random order\n",
|
||||
"name": "shuffle_options"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True, if answer options can be added to the poll after creation; not supported for anonymous polls and quizzes",
|
||||
"html_description": "<td>Pass <em>True</em>, if answer options can be added to the poll after creation; not supported for anonymous polls and quizzes</td>",
|
||||
"rst_description": "Pass :code:`True`, if answer options can be added to the poll after creation; not supported for anonymous polls and quizzes\n",
|
||||
"name": "allow_adding_options"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True, if poll results must be shown only after the poll closes",
|
||||
"html_description": "<td>Pass <em>True</em>, if poll results must be shown only after the poll closes</td>",
|
||||
"rst_description": "Pass :code:`True`, if poll results must be shown only after the poll closes\n",
|
||||
"name": "hide_results_until_closes"
|
||||
},
|
||||
{
|
||||
"type": "Array of Integer",
|
||||
"required": false,
|
||||
"description": "A JSON-serialized list of monotonically increasing 0-based identifiers of the correct answer options, required for polls in quiz mode",
|
||||
"html_description": "<td>A JSON-serialized list of monotonically increasing 0-based identifiers of the correct answer options, required for polls in quiz mode</td>",
|
||||
"rst_description": "A JSON-serialized list of monotonically increasing 0-based identifiers of the correct answer options, required for polls in quiz mode\n",
|
||||
"name": "correct_option_ids"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
|
|
@ -126,17 +158,17 @@
|
|||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with close_date.",
|
||||
"html_description": "<td>Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with <em>close_date</em>.</td>",
|
||||
"rst_description": "Amount of time in seconds the poll will be active after creation, 5-600. Can't be used together with *close_date*.\n",
|
||||
"description": "Amount of time in seconds the poll will be active after creation, 5-2628000. Can't be used together with close_date.",
|
||||
"html_description": "<td>Amount of time in seconds the poll will be active after creation, 5-2628000. Can't be used together with <em>close_date</em>.</td>",
|
||||
"rst_description": "Amount of time in seconds the poll will be active after creation, 5-2628000. Can't be used together with *close_date*.\n",
|
||||
"name": "open_period"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "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.",
|
||||
"html_description": "<td>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 <em>open_period</em>.</td>",
|
||||
"rst_description": "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*.\n",
|
||||
"description": "Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 2628000 seconds in the future. Can't be used together with open_period.",
|
||||
"html_description": "<td>Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 2628000 seconds in the future. Can't be used together with <em>open_period</em>.</td>",
|
||||
"rst_description": "Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 2628000 seconds in the future. Can't be used together with *open_period*.\n",
|
||||
"name": "close_date"
|
||||
},
|
||||
{
|
||||
|
|
@ -147,6 +179,30 @@
|
|||
"rst_description": "Pass :code:`True` if the poll needs to be immediately closed. This can be useful for poll preview.\n",
|
||||
"name": "is_closed"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
"description": "Description of the poll to be sent, 0-1024 characters after entities parsing",
|
||||
"html_description": "<td>Description of the poll to be sent, 0-1024 characters after entities parsing</td>",
|
||||
"rst_description": "Description of the poll to be sent, 0-1024 characters after entities parsing\n",
|
||||
"name": "description"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
"description": "Mode for parsing entities in the poll description. See formatting options for more details.",
|
||||
"html_description": "<td>Mode for parsing entities in the poll description. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
|
||||
"rst_description": "Mode for parsing entities in the poll description. See `formatting options <https://core.telegram.org/bots/api#formatting-options>`_ for more details.\n",
|
||||
"name": "description_parse_mode"
|
||||
},
|
||||
{
|
||||
"type": "Array of MessageEntity",
|
||||
"required": false,
|
||||
"description": "A JSON-serialized list of special entities that appear in the poll description, which can be specified instead of description_parse_mode",
|
||||
"html_description": "<td>A JSON-serialized list of special entities that appear in the poll description, which can be specified instead of <em>description_parse_mode</em></td>",
|
||||
"rst_description": "A JSON-serialized list of special entities that appear in the poll description, which can be specified instead of *description_parse_mode*\n",
|
||||
"name": "description_entities"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
|
|
@ -163,6 +219,14 @@
|
|||
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
|
||||
"name": "protect_content"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
|
||||
"html_description": "<td>Pass <em>True</em> to allow up to 1000 messages per second, ignoring <a href=\"https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once\">broadcasting limits</a> for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance</td>",
|
||||
"rst_description": "Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits <https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once>`_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
|
||||
"name": "allow_paid_broadcast"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
|
|
@ -199,6 +263,18 @@
|
|||
"release_date": "2023-12-29"
|
||||
}
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "0-based identifier of the correct answer option, required for polls in quiz mode",
|
||||
"html_description": "<td>0-based identifier of the correct answer option, required for polls in quiz mode</td>",
|
||||
"rst_description": "0-based identifier of the correct answer option, required for polls in quiz mode\n",
|
||||
"name": "correct_option_id",
|
||||
"deprecated": {
|
||||
"version": "9.6",
|
||||
"release_date": "2026-04-03"
|
||||
}
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
|
|
|
|||
30
.butcher/methods/sendSticker/entity.json
generated
30
.butcher/methods/sendSticker/entity.json
generated
|
|
@ -30,11 +30,19 @@
|
|||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
|
||||
"html_description": "<td>Unique identifier for the target message thread (topic) of the forum; for forum supergroups only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n",
|
||||
"description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
|
||||
"html_description": "<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
|
||||
"name": "message_thread_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
|
||||
"html_description": "<td>Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat</td>",
|
||||
"rst_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
|
||||
"name": "direct_messages_topic_id"
|
||||
},
|
||||
{
|
||||
"type": "InputFile or String",
|
||||
"required": true,
|
||||
|
|
@ -67,6 +75,14 @@
|
|||
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
|
||||
"name": "protect_content"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
|
||||
"html_description": "<td>Pass <em>True</em> to allow up to 1000 messages per second, ignoring <a href=\"https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once\">broadcasting limits</a> for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance</td>",
|
||||
"rst_description": "Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits <https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once>`_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
|
||||
"name": "allow_paid_broadcast"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
|
|
@ -75,6 +91,14 @@
|
|||
"rst_description": "Unique identifier of the message effect to be added to the message; for private chats only\n",
|
||||
"name": "message_effect_id"
|
||||
},
|
||||
{
|
||||
"type": "SuggestedPostParameters",
|
||||
"required": false,
|
||||
"description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
|
||||
"html_description": "<td>A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.</td>",
|
||||
"rst_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
|
||||
"name": "suggested_post_parameters"
|
||||
},
|
||||
{
|
||||
"type": "ReplyParameters",
|
||||
"required": false,
|
||||
|
|
|
|||
30
.butcher/methods/sendVenue/entity.json
generated
30
.butcher/methods/sendVenue/entity.json
generated
|
|
@ -30,11 +30,19 @@
|
|||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
|
||||
"html_description": "<td>Unique identifier for the target message thread (topic) of the forum; for forum supergroups only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n",
|
||||
"description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
|
||||
"html_description": "<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
|
||||
"name": "message_thread_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
|
||||
"html_description": "<td>Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat</td>",
|
||||
"rst_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
|
||||
"name": "direct_messages_topic_id"
|
||||
},
|
||||
{
|
||||
"type": "Float",
|
||||
"required": true,
|
||||
|
|
@ -115,6 +123,14 @@
|
|||
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
|
||||
"name": "protect_content"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
|
||||
"html_description": "<td>Pass <em>True</em> to allow up to 1000 messages per second, ignoring <a href=\"https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once\">broadcasting limits</a> for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance</td>",
|
||||
"rst_description": "Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits <https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once>`_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
|
||||
"name": "allow_paid_broadcast"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
|
|
@ -123,6 +139,14 @@
|
|||
"rst_description": "Unique identifier of the message effect to be added to the message; for private chats only\n",
|
||||
"name": "message_effect_id"
|
||||
},
|
||||
{
|
||||
"type": "SuggestedPostParameters",
|
||||
"required": false,
|
||||
"description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
|
||||
"html_description": "<td>A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.</td>",
|
||||
"rst_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
|
||||
"name": "suggested_post_parameters"
|
||||
},
|
||||
{
|
||||
"type": "ReplyParameters",
|
||||
"required": false,
|
||||
|
|
|
|||
46
.butcher/methods/sendVideo/entity.json
generated
46
.butcher/methods/sendVideo/entity.json
generated
|
|
@ -30,11 +30,19 @@
|
|||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
|
||||
"html_description": "<td>Unique identifier for the target message thread (topic) of the forum; for forum supergroups only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n",
|
||||
"description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
|
||||
"html_description": "<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
|
||||
"name": "message_thread_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
|
||||
"html_description": "<td>Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat</td>",
|
||||
"rst_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
|
||||
"name": "direct_messages_topic_id"
|
||||
},
|
||||
{
|
||||
"type": "InputFile or String",
|
||||
"required": true,
|
||||
|
|
@ -75,6 +83,22 @@
|
|||
"rst_description": "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>. :ref:`More information on Sending Files » <sending-files>`\n",
|
||||
"name": "thumbnail"
|
||||
},
|
||||
{
|
||||
"type": "InputFile or String",
|
||||
"required": false,
|
||||
"description": "Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass 'attach://<file_attach_name>' to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files",
|
||||
"html_description": "<td>Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. <a href=\"#sending-files\">More information on Sending Files »</a></td>",
|
||||
"rst_description": "Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass 'attach://<file_attach_name>' to upload a new one using multipart/form-data under <file_attach_name> name. :ref:`More information on Sending Files » <sending-files>`\n",
|
||||
"name": "cover"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Start timestamp for the video in the message",
|
||||
"html_description": "<td>Start timestamp for the video in the message</td>",
|
||||
"rst_description": "Start timestamp for the video in the message\n",
|
||||
"name": "start_timestamp"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
|
|
@ -139,6 +163,14 @@
|
|||
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
|
||||
"name": "protect_content"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
|
||||
"html_description": "<td>Pass <em>True</em> to allow up to 1000 messages per second, ignoring <a href=\"https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once\">broadcasting limits</a> for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance</td>",
|
||||
"rst_description": "Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits <https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once>`_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
|
||||
"name": "allow_paid_broadcast"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
|
|
@ -147,6 +179,14 @@
|
|||
"rst_description": "Unique identifier of the message effect to be added to the message; for private chats only\n",
|
||||
"name": "message_effect_id"
|
||||
},
|
||||
{
|
||||
"type": "SuggestedPostParameters",
|
||||
"required": false,
|
||||
"description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
|
||||
"html_description": "<td>A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.</td>",
|
||||
"rst_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
|
||||
"name": "suggested_post_parameters"
|
||||
},
|
||||
{
|
||||
"type": "ReplyParameters",
|
||||
"required": false,
|
||||
|
|
|
|||
|
|
@ -5,3 +5,13 @@ annotations:
|
|||
references:
|
||||
category: types
|
||||
name: InputFile
|
||||
start_timestamp:
|
||||
parsed_type:
|
||||
type: union
|
||||
items:
|
||||
- type: std
|
||||
name: datetime.datetime
|
||||
- type: std
|
||||
name: datetime.timedelta
|
||||
- type: std
|
||||
name: int
|
||||
|
|
|
|||
30
.butcher/methods/sendVideoNote/entity.json
generated
30
.butcher/methods/sendVideoNote/entity.json
generated
|
|
@ -30,11 +30,19 @@
|
|||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
|
||||
"html_description": "<td>Unique identifier for the target message thread (topic) of the forum; for forum supergroups only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n",
|
||||
"description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
|
||||
"html_description": "<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
|
||||
"name": "message_thread_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
|
||||
"html_description": "<td>Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat</td>",
|
||||
"rst_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
|
||||
"name": "direct_messages_topic_id"
|
||||
},
|
||||
{
|
||||
"type": "InputFile or String",
|
||||
"required": true,
|
||||
|
|
@ -83,6 +91,14 @@
|
|||
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
|
||||
"name": "protect_content"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
|
||||
"html_description": "<td>Pass <em>True</em> to allow up to 1000 messages per second, ignoring <a href=\"https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once\">broadcasting limits</a> for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance</td>",
|
||||
"rst_description": "Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits <https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once>`_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
|
||||
"name": "allow_paid_broadcast"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
|
|
@ -91,6 +107,14 @@
|
|||
"rst_description": "Unique identifier of the message effect to be added to the message; for private chats only\n",
|
||||
"name": "message_effect_id"
|
||||
},
|
||||
{
|
||||
"type": "SuggestedPostParameters",
|
||||
"required": false,
|
||||
"description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
|
||||
"html_description": "<td>A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.</td>",
|
||||
"rst_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
|
||||
"name": "suggested_post_parameters"
|
||||
},
|
||||
{
|
||||
"type": "ReplyParameters",
|
||||
"required": false,
|
||||
|
|
|
|||
30
.butcher/methods/sendVoice/entity.json
generated
30
.butcher/methods/sendVoice/entity.json
generated
|
|
@ -30,11 +30,19 @@
|
|||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
|
||||
"html_description": "<td>Unique identifier for the target message thread (topic) of the forum; for forum supergroups only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n",
|
||||
"description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only",
|
||||
"html_description": "<td>Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only</td>",
|
||||
"rst_description": "Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only\n",
|
||||
"name": "message_thread_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat",
|
||||
"html_description": "<td>Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat</td>",
|
||||
"rst_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n",
|
||||
"name": "direct_messages_topic_id"
|
||||
},
|
||||
{
|
||||
"type": "InputFile or String",
|
||||
"required": true,
|
||||
|
|
@ -91,6 +99,14 @@
|
|||
"rst_description": "Protects the contents of the sent message from forwarding and saving\n",
|
||||
"name": "protect_content"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
|
||||
"html_description": "<td>Pass <em>True</em> to allow up to 1000 messages per second, ignoring <a href=\"https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once\">broadcasting limits</a> for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance</td>",
|
||||
"rst_description": "Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits <https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once>`_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
|
||||
"name": "allow_paid_broadcast"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
|
|
@ -99,6 +115,14 @@
|
|||
"rst_description": "Unique identifier of the message effect to be added to the message; for private chats only\n",
|
||||
"name": "message_effect_id"
|
||||
},
|
||||
{
|
||||
"type": "SuggestedPostParameters",
|
||||
"required": false,
|
||||
"description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.",
|
||||
"html_description": "<td>A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.</td>",
|
||||
"rst_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n",
|
||||
"name": "suggested_post_parameters"
|
||||
},
|
||||
{
|
||||
"type": "ReplyParameters",
|
||||
"required": false,
|
||||
|
|
|
|||
33
.butcher/methods/setBusinessAccountBio/entity.json
generated
Normal file
33
.butcher/methods/setBusinessAccountBio/entity.json
generated
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Available methods",
|
||||
"anchor": "available-methods"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "setbusinessaccountbio",
|
||||
"name": "setBusinessAccountBio",
|
||||
"description": "Changes the bio of a managed business account. Requires the can_change_bio business bot right. Returns True on success.",
|
||||
"html_description": "<p>Changes the bio of a managed business account. Requires the <em>can_change_bio</em> business bot right. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "Changes the bio of a managed business account. Requires the *can_change_bio* business bot right. Returns :code:`True` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the business connection",
|
||||
"html_description": "<td>Unique identifier of the business connection</td>",
|
||||
"rst_description": "Unique identifier of the business connection\n",
|
||||
"name": "business_connection_id"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
"description": "The new value of the bio for the business account; 0-140 characters",
|
||||
"html_description": "<td>The new value of the bio for the business account; 0-140 characters</td>",
|
||||
"rst_description": "The new value of the bio for the business account; 0-140 characters\n",
|
||||
"name": "bio"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
41
.butcher/methods/setBusinessAccountGiftSettings/entity.json
generated
Normal file
41
.butcher/methods/setBusinessAccountGiftSettings/entity.json
generated
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Available methods",
|
||||
"anchor": "available-methods"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "setbusinessaccountgiftsettings",
|
||||
"name": "setBusinessAccountGiftSettings",
|
||||
"description": "Changes the privacy settings pertaining to incoming gifts in a managed business account. Requires the can_change_gift_settings business bot right. Returns True on success.",
|
||||
"html_description": "<p>Changes the privacy settings pertaining to incoming gifts in a managed business account. Requires the <em>can_change_gift_settings</em> business bot right. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "Changes the privacy settings pertaining to incoming gifts in a managed business account. Requires the *can_change_gift_settings* business bot right. Returns :code:`True` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the business connection",
|
||||
"html_description": "<td>Unique identifier of the business connection</td>",
|
||||
"rst_description": "Unique identifier of the business connection\n",
|
||||
"name": "business_connection_id"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": true,
|
||||
"description": "Pass True, if a button for sending a gift to the user or by the business account must always be shown in the input field",
|
||||
"html_description": "<td>Pass <em>True</em>, if a button for sending a gift to the user or by the business account must always be shown in the input field</td>",
|
||||
"rst_description": "Pass :code:`True`, if a button for sending a gift to the user or by the business account must always be shown in the input field\n",
|
||||
"name": "show_gift_button"
|
||||
},
|
||||
{
|
||||
"type": "AcceptedGiftTypes",
|
||||
"required": true,
|
||||
"description": "Types of gifts accepted by the business account",
|
||||
"html_description": "<td>Types of gifts accepted by the business account</td>",
|
||||
"rst_description": "Types of gifts accepted by the business account\n",
|
||||
"name": "accepted_gift_types"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
41
.butcher/methods/setBusinessAccountName/entity.json
generated
Normal file
41
.butcher/methods/setBusinessAccountName/entity.json
generated
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Available methods",
|
||||
"anchor": "available-methods"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "setbusinessaccountname",
|
||||
"name": "setBusinessAccountName",
|
||||
"description": "Changes the first and last name of a managed business account. Requires the can_change_name business bot right. Returns True on success.",
|
||||
"html_description": "<p>Changes the first and last name of a managed business account. Requires the <em>can_change_name</em> business bot right. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "Changes the first and last name of a managed business account. Requires the *can_change_name* business bot right. Returns :code:`True` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the business connection",
|
||||
"html_description": "<td>Unique identifier of the business connection</td>",
|
||||
"rst_description": "Unique identifier of the business connection\n",
|
||||
"name": "business_connection_id"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
"description": "The new value of the first name for the business account; 1-64 characters",
|
||||
"html_description": "<td>The new value of the first name for the business account; 1-64 characters</td>",
|
||||
"rst_description": "The new value of the first name for the business account; 1-64 characters\n",
|
||||
"name": "first_name"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
"description": "The new value of the last name for the business account; 0-64 characters",
|
||||
"html_description": "<td>The new value of the last name for the business account; 0-64 characters</td>",
|
||||
"rst_description": "The new value of the last name for the business account; 0-64 characters\n",
|
||||
"name": "last_name"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
41
.butcher/methods/setBusinessAccountProfilePhoto/entity.json
generated
Normal file
41
.butcher/methods/setBusinessAccountProfilePhoto/entity.json
generated
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Available methods",
|
||||
"anchor": "available-methods"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "setbusinessaccountprofilephoto",
|
||||
"name": "setBusinessAccountProfilePhoto",
|
||||
"description": "Changes the profile photo of a managed business account. Requires the can_edit_profile_photo business bot right. Returns True on success.",
|
||||
"html_description": "<p>Changes the profile photo of a managed business account. Requires the <em>can_edit_profile_photo</em> business bot right. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "Changes the profile photo of a managed business account. Requires the *can_edit_profile_photo* business bot right. Returns :code:`True` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the business connection",
|
||||
"html_description": "<td>Unique identifier of the business connection</td>",
|
||||
"rst_description": "Unique identifier of the business connection\n",
|
||||
"name": "business_connection_id"
|
||||
},
|
||||
{
|
||||
"type": "InputProfilePhoto",
|
||||
"required": true,
|
||||
"description": "The new profile photo to set",
|
||||
"html_description": "<td>The new profile photo to set</td>",
|
||||
"rst_description": "The new profile photo to set\n",
|
||||
"name": "photo"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to set the public photo, which will be visible even if the main photo is hidden by the business account's privacy settings. An account can have only one public photo.",
|
||||
"html_description": "<td>Pass <em>True</em> to set the public photo, which will be visible even if the main photo is hidden by the business account's privacy settings. An account can have only one public photo.</td>",
|
||||
"rst_description": "Pass :code:`True` to set the public photo, which will be visible even if the main photo is hidden by the business account's privacy settings. An account can have only one public photo.\n",
|
||||
"name": "is_public"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
33
.butcher/methods/setBusinessAccountUsername/entity.json
generated
Normal file
33
.butcher/methods/setBusinessAccountUsername/entity.json
generated
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Available methods",
|
||||
"anchor": "available-methods"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "setbusinessaccountusername",
|
||||
"name": "setBusinessAccountUsername",
|
||||
"description": "Changes the username of a managed business account. Requires the can_change_username business bot right. Returns True on success.",
|
||||
"html_description": "<p>Changes the username of a managed business account. Requires the <em>can_change_username</em> business bot right. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "Changes the username of a managed business account. Requires the *can_change_username* business bot right. Returns :code:`True` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the business connection",
|
||||
"html_description": "<td>Unique identifier of the business connection</td>",
|
||||
"rst_description": "Unique identifier of the business connection\n",
|
||||
"name": "business_connection_id"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
"description": "The new value of the username for the business account; 0-32 characters",
|
||||
"html_description": "<td>The new value of the username for the business account; 0-32 characters</td>",
|
||||
"rst_description": "The new value of the username for the business account; 0-32 characters\n",
|
||||
"name": "username"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
41
.butcher/methods/setChatMemberTag/entity.json
generated
Normal file
41
.butcher/methods/setChatMemberTag/entity.json
generated
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Available methods",
|
||||
"anchor": "available-methods"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "setchatmembertag",
|
||||
"name": "setChatMemberTag",
|
||||
"description": "Use this method to set a tag for a regular member in a group or a supergroup. The bot must be an administrator in the chat for this to work and must have the can_manage_tags administrator right. Returns True on success.",
|
||||
"html_description": "<p>Use this method to set a tag for a regular member in a group or a supergroup. The bot must be an administrator in the chat for this to work and must have the <em>can_manage_tags</em> administrator right. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "Use this method to set a tag for a regular member in a group or a supergroup. The bot must be an administrator in the chat for this to work and must have the *can_manage_tags* administrator right. Returns :code:`True` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "Integer or String",
|
||||
"required": true,
|
||||
"description": "Unique identifier for the target chat or username of the target supergroup (in the format @supergroupusername)",
|
||||
"html_description": "<td>Unique identifier for the target chat or username of the target supergroup (in the format <code>@supergroupusername</code>)</td>",
|
||||
"rst_description": "Unique identifier for the target chat or username of the target supergroup (in the format :code:`@supergroupusername`)\n",
|
||||
"name": "chat_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the target user",
|
||||
"html_description": "<td>Unique identifier of the target user</td>",
|
||||
"rst_description": "Unique identifier of the target user\n",
|
||||
"name": "user_id"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
"description": "New tag for the member; 0-16 characters, emoji are not allowed",
|
||||
"html_description": "<td>New tag for the member; 0-16 characters, emoji are not allowed</td>",
|
||||
"rst_description": "New tag for the member; 0-16 characters, emoji are not allowed\n",
|
||||
"name": "tag"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
12
.butcher/methods/setMessageReaction/entity.json
generated
12
.butcher/methods/setMessageReaction/entity.json
generated
|
|
@ -7,9 +7,9 @@
|
|||
"object": {
|
||||
"anchor": "setmessagereaction",
|
||||
"name": "setMessageReaction",
|
||||
"description": "Use this method to change the chosen reactions on a message. Service messages can't be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. Returns True on success.",
|
||||
"html_description": "<p>Use this method to change the chosen reactions on a message. Service messages can't be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "Use this method to change the chosen reactions on a message. Service messages can't be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. Returns :code:`True` on success.",
|
||||
"description": "Use this method to change the chosen reactions on a message. Service messages of some types can't be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. Bots can't use paid reactions. Returns True on success.",
|
||||
"html_description": "<p>Use this method to change the chosen reactions on a message. Service messages of some types can't be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. Bots can't use paid reactions. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "Use this method to change the chosen reactions on a message. Service messages of some types can't be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. Bots can't use paid reactions. Returns :code:`True` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "Integer or String",
|
||||
|
|
@ -30,9 +30,9 @@
|
|||
{
|
||||
"type": "Array of ReactionType",
|
||||
"required": false,
|
||||
"description": "A JSON-serialized list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators.",
|
||||
"html_description": "<td>A JSON-serialized list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators.</td>",
|
||||
"rst_description": "A JSON-serialized list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators.\n",
|
||||
"description": "A JSON-serialized list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators. Paid reactions can't be used by bots.",
|
||||
"html_description": "<td>A JSON-serialized list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators. Paid reactions can't be used by bots.</td>",
|
||||
"rst_description": "A JSON-serialized list of reaction types to set on the message. Currently, as non-premium users, bots can set up to one reaction per message. A custom emoji reaction can be used if it is either already present on the message or explicitly allowed by chat administrators. Paid reactions can't be used by bots.\n",
|
||||
"name": "reaction"
|
||||
},
|
||||
{
|
||||
|
|
|
|||
25
.butcher/methods/setMyProfilePhoto/entity.json
generated
Normal file
25
.butcher/methods/setMyProfilePhoto/entity.json
generated
Normal file
|
|
@ -0,0 +1,25 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Available methods",
|
||||
"anchor": "available-methods"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "setmyprofilephoto",
|
||||
"name": "setMyProfilePhoto",
|
||||
"description": "Changes the profile photo of the bot. Returns True on success.",
|
||||
"html_description": "<p>Changes the profile photo of the bot. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "Changes the profile photo of the bot. Returns :code:`True` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "InputProfilePhoto",
|
||||
"required": true,
|
||||
"description": "The new profile photo to set",
|
||||
"html_description": "<td>The new profile photo to set</td>",
|
||||
"rst_description": "The new profile photo to set\n",
|
||||
"name": "photo"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
12
.butcher/methods/setStickerSetThumbnail/entity.json
generated
12
.butcher/methods/setStickerSetThumbnail/entity.json
generated
|
|
@ -30,17 +30,17 @@
|
|||
{
|
||||
"type": "InputFile or String",
|
||||
"required": false,
|
||||
"description": "A .WEBP or .PNG image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a .TGS animation with a thumbnail up to 32 kilobytes in size (see https://core.telegram.org/stickers#animation-requirements for animated sticker technical requirements), or a WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-requirements for video 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 information on Sending Files. Animated and video sticker set thumbnails can't be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail.",
|
||||
"html_description": "<td>A <strong>.WEBP</strong> or <strong>.PNG</strong> image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a <strong>.TGS</strong> animation with a thumbnail up to 32 kilobytes in size (see <a href=\"/stickers#animation-requirements\"/><a href=\"https://core.telegram.org/stickers#animation-requirements\">https://core.telegram.org/stickers#animation-requirements</a> for animated sticker technical requirements), or a <strong>WEBM</strong> video with the thumbnail up to 32 kilobytes in size; see <a href=\"/stickers#video-requirements\"/><a href=\"https://core.telegram.org/stickers#video-requirements\">https://core.telegram.org/stickers#video-requirements</a> for video sticker technical requirements. Pass a <em>file_id</em> 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. <a href=\"#sending-files\">More information on Sending Files »</a>. Animated and video sticker set thumbnails can't be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail.</td>",
|
||||
"rst_description": "A **.WEBP** or **.PNG** image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a **.TGS** animation with a thumbnail up to 32 kilobytes in size (see `https://core.telegram.org/stickers#animation-requirements <https://core.telegram.org/stickers#animation-requirements>`_`https://core.telegram.org/stickers#animation-requirements <https://core.telegram.org/stickers#animation-requirements>`_ for animated sticker technical requirements), or a **WEBM** video with the thumbnail up to 32 kilobytes in size; see `https://core.telegram.org/stickers#video-requirements <https://core.telegram.org/stickers#video-requirements>`_`https://core.telegram.org/stickers#video-requirements <https://core.telegram.org/stickers#video-requirements>`_ for video 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. :ref:`More information on Sending Files » <sending-files>`. Animated and video sticker set thumbnails can't be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail.\n",
|
||||
"description": "A .WEBP or .PNG image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a .TGS animation with a thumbnail up to 32 kilobytes in size (see https://core.telegram.org/stickers#animation-requirements for animated sticker technical requirements), or a .WEBM video with the thumbnail up to 32 kilobytes in size; see https://core.telegram.org/stickers#video-requirements for video 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 information on Sending Files. Animated and video sticker set thumbnails can't be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail.",
|
||||
"html_description": "<td>A <strong>.WEBP</strong> or <strong>.PNG</strong> image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a <strong>.TGS</strong> animation with a thumbnail up to 32 kilobytes in size (see <a href=\"/stickers#animation-requirements\"/><a href=\"https://core.telegram.org/stickers#animation-requirements\">https://core.telegram.org/stickers#animation-requirements</a> for animated sticker technical requirements), or a <strong>.WEBM</strong> video with the thumbnail up to 32 kilobytes in size; see <a href=\"/stickers#video-requirements\"/><a href=\"https://core.telegram.org/stickers#video-requirements\">https://core.telegram.org/stickers#video-requirements</a> for video sticker technical requirements. Pass a <em>file_id</em> 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. <a href=\"#sending-files\">More information on Sending Files »</a>. Animated and video sticker set thumbnails can't be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail.</td>",
|
||||
"rst_description": "A **.WEBP** or **.PNG** image with the thumbnail, must be up to 128 kilobytes in size and have a width and height of exactly 100px, or a **.TGS** animation with a thumbnail up to 32 kilobytes in size (see `https://core.telegram.org/stickers#animation-requirements <https://core.telegram.org/stickers#animation-requirements>`_`https://core.telegram.org/stickers#animation-requirements <https://core.telegram.org/stickers#animation-requirements>`_ for animated sticker technical requirements), or a **.WEBM** video with the thumbnail up to 32 kilobytes in size; see `https://core.telegram.org/stickers#video-requirements <https://core.telegram.org/stickers#video-requirements>`_`https://core.telegram.org/stickers#video-requirements <https://core.telegram.org/stickers#video-requirements>`_ for video 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. :ref:`More information on Sending Files » <sending-files>`. Animated and video sticker set thumbnails can't be uploaded via HTTP URL. If omitted, then the thumbnail is dropped and the first sticker is used as the thumbnail.\n",
|
||||
"name": "thumbnail"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
"description": "Format of the thumbnail, must be one of 'static' for a .WEBP or .PNG image, 'animated' for a .TGS animation, or 'video' for a WEBM video",
|
||||
"html_description": "<td>Format of the thumbnail, must be one of “static” for a <strong>.WEBP</strong> or <strong>.PNG</strong> image, “animated” for a <strong>.TGS</strong> animation, or “video” for a <strong>WEBM</strong> video</td>",
|
||||
"rst_description": "Format of the thumbnail, must be one of 'static' for a **.WEBP** or **.PNG** image, 'animated' for a **.TGS** animation, or 'video' for a **WEBM** video\n",
|
||||
"description": "Format of the thumbnail, must be one of 'static' for a .WEBP or .PNG image, 'animated' for a .TGS animation, or 'video' for a .WEBM video",
|
||||
"html_description": "<td>Format of the thumbnail, must be one of “static” for a <strong>.WEBP</strong> or <strong>.PNG</strong> image, “animated” for a <strong>.TGS</strong> animation, or “video” for a <strong>.WEBM</strong> video</td>",
|
||||
"rst_description": "Format of the thumbnail, must be one of 'static' for a **.WEBP** or **.PNG** image, 'animated' for a **.TGS** animation, or 'video' for a **.WEBM** video\n",
|
||||
"name": "format"
|
||||
}
|
||||
],
|
||||
|
|
|
|||
41
.butcher/methods/setUserEmojiStatus/entity.json
generated
Normal file
41
.butcher/methods/setUserEmojiStatus/entity.json
generated
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Available methods",
|
||||
"anchor": "available-methods"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "setuseremojistatus",
|
||||
"name": "setUserEmojiStatus",
|
||||
"description": "Changes the emoji status for a given user that previously allowed the bot to manage their emoji status via the Mini App method requestEmojiStatusAccess. Returns True on success.",
|
||||
"html_description": "<p>Changes the emoji status for a given user that previously allowed the bot to manage their emoji status via the Mini App method <a href=\"/bots/webapps#initializing-mini-apps\">requestEmojiStatusAccess</a>. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "Changes the emoji status for a given user that previously allowed the bot to manage their emoji status via the Mini App method `requestEmojiStatusAccess <https://core.telegram.org/bots/webapps#initializing-mini-apps>`_. Returns :code:`True` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the target user",
|
||||
"html_description": "<td>Unique identifier of the target user</td>",
|
||||
"rst_description": "Unique identifier of the target user\n",
|
||||
"name": "user_id"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
"description": "Custom emoji identifier of the emoji status to set. Pass an empty string to remove the status.",
|
||||
"html_description": "<td>Custom emoji identifier of the emoji status to set. Pass an empty string to remove the status.</td>",
|
||||
"rst_description": "Custom emoji identifier of the emoji status to set. Pass an empty string to remove the status.\n",
|
||||
"name": "emoji_status_custom_emoji_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "Expiration date of the emoji status, if any",
|
||||
"html_description": "<td>Expiration date of the emoji status, if any</td>",
|
||||
"rst_description": "Expiration date of the emoji status, if any\n",
|
||||
"name": "emoji_status_expiration_date"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
11
.butcher/methods/setUserEmojiStatus/replace.yml
Normal file
11
.butcher/methods/setUserEmojiStatus/replace.yml
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
annotations:
|
||||
emoji_status_expiration_date:
|
||||
parsed_type:
|
||||
type: union
|
||||
items:
|
||||
- type: std
|
||||
name: datetime.datetime
|
||||
- type: std
|
||||
name: datetime.timedelta
|
||||
- type: std
|
||||
name: int
|
||||
6
.butcher/methods/setWebhook/entity.json
generated
6
.butcher/methods/setWebhook/entity.json
generated
|
|
@ -7,9 +7,9 @@
|
|||
"object": {
|
||||
"anchor": "setwebhook",
|
||||
"name": "setWebhook",
|
||||
"description": "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.\nIf you'd like to make sure that the webhook was set by you, you can specify secret data in the parameter secret_token. If specified, the request will contain a header 'X-Telegram-Bot-Api-Secret-Token' with the secret token as content.\nNotes\n1. You will not be able to receive updates using getUpdates for as long as an outgoing webhook is set up.\n2. 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.\n3. Ports currently supported for webhooks: 443, 80, 88, 8443.\nIf you're having any trouble setting up webhooks, please check out this amazing guide to webhooks.",
|
||||
"html_description": "<p>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 <a href=\"#update\">Update</a>. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns <em>True</em> on success.</p><p>If you'd like to make sure that the webhook was set by you, you can specify secret data in the parameter <em>secret_token</em>. If specified, the request will contain a header “X-Telegram-Bot-Api-Secret-Token” with the secret token as content.</p><blockquote>\n<p><strong>Notes</strong><br/>\n<strong>1.</strong> You will not be able to receive updates using <a href=\"#getupdates\">getUpdates</a> for as long as an outgoing webhook is set up.<br/>\n<strong>2.</strong> To use a self-signed certificate, you need to upload your <a href=\"/bots/self-signed\">public key certificate</a> using <em>certificate</em> parameter. Please upload as InputFile, sending a String will not work.<br/>\n<strong>3.</strong> Ports currently supported <em>for webhooks</em>: <strong>443, 80, 88, 8443</strong>.</p>\n<p>If you're having any trouble setting up webhooks, please check out this <a href=\"/bots/webhooks\">amazing guide to webhooks</a>.</p>\n</blockquote>",
|
||||
"rst_description": "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 :class:`aiogram.types.update.Update`. In case of an unsuccessful request, we will give up after a reasonable amount of attempts. Returns :code:`True` on success.\nIf you'd like to make sure that the webhook was set by you, you can specify secret data in the parameter *secret_token*. If specified, the request will contain a header 'X-Telegram-Bot-Api-Secret-Token' with the secret token as content.\n\n **Notes**\n \n **1.** You will not be able to receive updates using :class:`aiogram.methods.get_updates.GetUpdates` for as long as an outgoing webhook is set up.\n \n **2.** To use a self-signed certificate, you need to upload your `public key certificate <https://core.telegram.org/bots/self-signed>`_ using *certificate* parameter. Please upload as InputFile, sending a String will not work.\n \n **3.** Ports currently supported *for webhooks*: **443, 80, 88, 8443**.\n If you're having any trouble setting up webhooks, please check out this `amazing guide to webhooks <https://core.telegram.org/bots/webhooks>`_.",
|
||||
"description": "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 (a request with response HTTP status code different from 2XY), we will repeat the request and give up after a reasonable amount of attempts. Returns True on success.\nIf you'd like to make sure that the webhook was set by you, you can specify secret data in the parameter secret_token. If specified, the request will contain a header 'X-Telegram-Bot-Api-Secret-Token' with the secret token as content.\nNotes\n1. You will not be able to receive updates using getUpdates for as long as an outgoing webhook is set up.\n2. 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.\n3. Ports currently supported for webhooks: 443, 80, 88, 8443.\nIf you're having any trouble setting up webhooks, please check out this amazing guide to webhooks.",
|
||||
"html_description": "<p>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 <a href=\"#update\">Update</a>. In case of an unsuccessful request (a request with response <a href=\"https://en.wikipedia.org/wiki/List_of_HTTP_status_codes\">HTTP status code</a> different from <code>2XY</code>), we will repeat the request and give up after a reasonable amount of attempts. Returns <em>True</em> on success.</p><p>If you'd like to make sure that the webhook was set by you, you can specify secret data in the parameter <em>secret_token</em>. If specified, the request will contain a header “X-Telegram-Bot-Api-Secret-Token” with the secret token as content.</p><blockquote>\n<p><strong>Notes</strong><br/>\n<strong>1.</strong> You will not be able to receive updates using <a href=\"#getupdates\">getUpdates</a> for as long as an outgoing webhook is set up.<br/>\n<strong>2.</strong> To use a self-signed certificate, you need to upload your <a href=\"/bots/self-signed\">public key certificate</a> using <em>certificate</em> parameter. Please upload as InputFile, sending a String will not work.<br/>\n<strong>3.</strong> Ports currently supported <em>for webhooks</em>: <strong>443, 80, 88, 8443</strong>.</p>\n<p>If you're having any trouble setting up webhooks, please check out this <a href=\"/bots/webhooks\">amazing guide to webhooks</a>.</p>\n</blockquote>",
|
||||
"rst_description": "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 :class:`aiogram.types.update.Update`. In case of an unsuccessful request (a request with response `HTTP status code <https://en.wikipedia.org/wiki/List_of_HTTP_status_codes>`_ different from :code:`2XY`), we will repeat the request and give up after a reasonable amount of attempts. Returns :code:`True` on success.\nIf you'd like to make sure that the webhook was set by you, you can specify secret data in the parameter *secret_token*. If specified, the request will contain a header 'X-Telegram-Bot-Api-Secret-Token' with the secret token as content.\n\n **Notes**\n \n **1.** You will not be able to receive updates using :class:`aiogram.methods.get_updates.GetUpdates` for as long as an outgoing webhook is set up.\n \n **2.** To use a self-signed certificate, you need to upload your `public key certificate <https://core.telegram.org/bots/self-signed>`_ using *certificate* parameter. Please upload as InputFile, sending a String will not work.\n \n **3.** Ports currently supported *for webhooks*: **443, 80, 88, 8443**.\n If you're having any trouble setting up webhooks, please check out this `amazing guide to webhooks <https://core.telegram.org/bots/webhooks>`_.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "String",
|
||||
|
|
|
|||
33
.butcher/methods/transferBusinessAccountStars/entity.json
generated
Normal file
33
.butcher/methods/transferBusinessAccountStars/entity.json
generated
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Available methods",
|
||||
"anchor": "available-methods"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "transferbusinessaccountstars",
|
||||
"name": "transferBusinessAccountStars",
|
||||
"description": "Transfers Telegram Stars from the business account balance to the bot's balance. Requires the can_transfer_stars business bot right. Returns True on success.",
|
||||
"html_description": "<p>Transfers Telegram Stars from the business account balance to the bot's balance. Requires the <em>can_transfer_stars</em> business bot right. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "Transfers Telegram Stars from the business account balance to the bot's balance. Requires the *can_transfer_stars* business bot right. Returns :code:`True` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the business connection",
|
||||
"html_description": "<td>Unique identifier of the business connection</td>",
|
||||
"rst_description": "Unique identifier of the business connection\n",
|
||||
"name": "business_connection_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": true,
|
||||
"description": "Number of Telegram Stars to transfer; 1-10000",
|
||||
"html_description": "<td>Number of Telegram Stars to transfer; 1-10000</td>",
|
||||
"rst_description": "Number of Telegram Stars to transfer; 1-10000\n",
|
||||
"name": "star_count"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
49
.butcher/methods/transferGift/entity.json
generated
Normal file
49
.butcher/methods/transferGift/entity.json
generated
Normal file
|
|
@ -0,0 +1,49 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Available methods",
|
||||
"anchor": "available-methods"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "transfergift",
|
||||
"name": "transferGift",
|
||||
"description": "Transfers an owned unique gift to another user. Requires the can_transfer_and_upgrade_gifts business bot right. Requires can_transfer_stars business bot right if the transfer is paid. Returns True on success.",
|
||||
"html_description": "<p>Transfers an owned unique gift to another user. Requires the <em>can_transfer_and_upgrade_gifts</em> business bot right. Requires <em>can_transfer_stars</em> business bot right if the transfer is paid. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "Transfers an owned unique gift to another user. Requires the *can_transfer_and_upgrade_gifts* business bot right. Requires *can_transfer_stars* business bot right if the transfer is paid. Returns :code:`True` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the business connection",
|
||||
"html_description": "<td>Unique identifier of the business connection</td>",
|
||||
"rst_description": "Unique identifier of the business connection\n",
|
||||
"name": "business_connection_id"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the regular gift that should be transferred",
|
||||
"html_description": "<td>Unique identifier of the regular gift that should be transferred</td>",
|
||||
"rst_description": "Unique identifier of the regular gift that should be transferred\n",
|
||||
"name": "owned_gift_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the chat which will own the gift. The chat must be active in the last 24 hours.",
|
||||
"html_description": "<td>Unique identifier of the chat which will own the gift. The chat must be active in the last 24 hours.</td>",
|
||||
"rst_description": "Unique identifier of the chat which will own the gift. The chat must be active in the last 24 hours.\n",
|
||||
"name": "new_owner_chat_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "The amount of Telegram Stars that will be paid for the transfer from the business account balance. If positive, then the can_transfer_stars business bot right is required.",
|
||||
"html_description": "<td>The amount of Telegram Stars that will be paid for the transfer from the business account balance. If positive, then the <em>can_transfer_stars</em> business bot right is required.</td>",
|
||||
"rst_description": "The amount of Telegram Stars that will be paid for the transfer from the business account balance. If positive, then the *can_transfer_stars* business bot right is required.\n",
|
||||
"name": "star_count"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
|
|
@ -7,9 +7,9 @@
|
|||
"object": {
|
||||
"anchor": "unpinallchatmessages",
|
||||
"name": "unpinAllChatMessages",
|
||||
"description": "Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns True on success.",
|
||||
"html_description": "<p>Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "Use this method to clear the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can_pin_messages' administrator right in a supergroup or 'can_edit_messages' administrator right in a channel. Returns :code:`True` on success.",
|
||||
"description": "Use this method to clear the list of pinned messages in a chat. In private chats and channel direct messages chats, no additional rights are required to unpin all pinned messages. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to unpin all pinned messages in groups and channels respectively. Returns True on success.",
|
||||
"html_description": "<p>Use this method to clear the list of pinned messages in a chat. In private chats and channel direct messages chats, no additional rights are required to unpin all pinned messages. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to unpin all pinned messages in groups and channels respectively. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "Use this method to clear the list of pinned messages in a chat. In private chats and channel direct messages chats, no additional rights are required to unpin all pinned messages. Conversely, the bot must be an administrator with the 'can_pin_messages' right or the 'can_edit_messages' right to unpin all pinned messages in groups and channels respectively. Returns :code:`True` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "Integer or String",
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue