mirror of
https://github.com/aiogram/aiogram.git
synced 2026-04-08 16:37:47 +00:00
Compare commits
325 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 | ||
|
|
60f93b3b46 | ||
|
|
cf3a6c3d59 | ||
|
|
3ba724e2fa | ||
|
|
98c2a4fb57 | ||
|
|
2516f32168 | ||
|
|
a3d6c1615e | ||
|
|
ac96f0d233 | ||
|
|
d2cd3d0fd8 | ||
|
|
7807981252 | ||
|
|
4ddc320e21 | ||
|
|
2ac2650165 | ||
|
|
1f41b14f95 | ||
|
|
ad28ce9689 | ||
|
|
0b595ba5e4 | ||
|
|
648395c1a2 | ||
|
|
03409450d0 | ||
|
|
7f47609585 | ||
|
|
46e033e6da | ||
|
|
5f05dfc664 | ||
|
|
7a96067952 | ||
|
|
11efa8e186 | ||
|
|
3baa7383c1 | ||
|
|
4b468da109 | ||
|
|
cad9b3ba76 | ||
|
|
f288a66cb4 | ||
|
|
1888039cee | ||
|
|
1f7bbeb355 | ||
|
|
dcfc9632f3 | ||
|
|
835813ca2e | ||
|
|
f568ef09e8 | ||
|
|
1df3adaba1 | ||
|
|
7760ab1d0d | ||
|
|
0df95a0276 | ||
|
|
69c359d23a | ||
|
|
0335bb14fc | ||
|
|
9bab51c908 | ||
|
|
b64587d4a7 | ||
|
|
afd1e6da74 | ||
|
|
0c2ef663da | ||
|
|
e224bb162d | ||
|
|
e3dc7d576b | ||
|
|
b08ba78898 | ||
|
|
f50e058725 | ||
|
|
b5d94f17b5 | ||
|
|
895f4f8dce | ||
|
|
972eeafce5 | ||
|
|
a7d3e9a720 | ||
|
|
1ef7655fd7 | ||
|
|
25c76b7d74 | ||
|
|
f45863a0b9 | ||
|
|
cf2980a9c1 | ||
|
|
6d655330af | ||
|
|
849482da1f | ||
|
|
6ad287c329 | ||
|
|
f1c9fc50f0 | ||
|
|
4729978c60 | ||
|
|
9756dac877 | ||
|
|
057478621b | ||
|
|
5f157beb26 | ||
|
|
b49939aaff | ||
|
|
acf52f468c | ||
|
|
506dacc0ff | ||
|
|
0c9eeda8a7 | ||
|
|
30cee817f4 | ||
|
|
bc08d90ce5 | ||
|
|
ee71117807 | ||
|
|
a2e75e5345 | ||
|
|
a585fb08de | ||
|
|
a37deff396 | ||
|
|
27dddff7f5 | ||
|
|
53849b01a7 | ||
|
|
eef50a2edb | ||
|
|
eaa56623ff | ||
|
|
75323ac8c3 | ||
|
|
e5176b4434 | ||
|
|
18b32f065d | ||
|
|
0cf5afeb99 | ||
|
|
e6e2601d4b | ||
|
|
298e9821a4 | ||
|
|
091b82e13f | ||
|
|
f7af9e7f4a | ||
|
|
bff483b8a7 | ||
|
|
844d6f58f5 | ||
|
|
d3c63797b0 | ||
|
|
eeafe4696c | ||
|
|
24f59da70d | ||
|
|
1281bf551a | ||
|
|
d394af83bd | ||
|
|
233d3c469d | ||
|
|
6795b3de05 | ||
|
|
756cfeba0a | ||
|
|
a2e5f9a8b8 | ||
|
|
69a07e3b0c | ||
|
|
fc9e2b82c6 | ||
|
|
94939660c7 | ||
|
|
c8dff11d1e | ||
|
|
09af2a1c8b | ||
|
|
ead79a1927 | ||
|
|
423796a445 | ||
|
|
3d63bf3b99 | ||
|
|
ce4e1a706d | ||
|
|
e17e3bc71c | ||
|
|
ebade3d51f | ||
|
|
7b0a6d2050 | ||
|
|
82f9365180 | ||
|
|
dd1e8085bf | ||
|
|
c1bafea3e8 | ||
|
|
c208bcf748 | ||
|
|
0fc718deeb | ||
|
|
5b59ca679a | ||
|
|
7e45f482d4 | ||
|
|
9bced29923 | ||
|
|
3ad5ed6bc2 | ||
|
|
9a2a72fe97 | ||
|
|
29d766fef2 | ||
|
|
2f1ae0a686 | ||
|
|
6153b4f805 | ||
|
|
7b30caed53 | ||
|
|
e76f4c38ad | ||
|
|
9b5e462068 | ||
|
|
228a86afdc | ||
|
|
a355daba49 | ||
|
|
180a7297ff | ||
|
|
475b1861e5 | ||
|
|
e3def608f1 | ||
|
|
d8e7801963 | ||
|
|
3b21262d34 | ||
|
|
eef277ae65 | ||
|
|
1cf6ce251b | ||
|
|
0a9bee4bd2 | ||
|
|
c6c838f689 | ||
|
|
98771fdf31 | ||
|
|
cf3044687a | ||
|
|
a2ed142557 | ||
|
|
d180fd7a46 | ||
|
|
564292dd79 | ||
|
|
cad42580dd | ||
|
|
f681afb879 | ||
|
|
67382553e5 | ||
|
|
b5ef05c01a | ||
|
|
eacea996d4 | ||
|
|
890a57cd15 | ||
|
|
0895e0f49c | ||
|
|
1dcb830b9d | ||
|
|
c3dc6fe7a8 | ||
|
|
fec138977d | ||
|
|
a0828f6ddf | ||
|
|
8a77939d5b | ||
|
|
490381b57f | ||
|
|
ac62184443 | ||
|
|
83a01f014c | ||
|
|
c229cf8c7b | ||
|
|
69c2e1282f | ||
|
|
28cc2384e8 | ||
|
|
b94123de3d | ||
|
|
b56628bb2e | ||
|
|
995a0d7e9b | ||
|
|
5cf8d7b565 | ||
|
|
8fd110cdd1 | ||
|
|
0161322598 | ||
|
|
04bd0c9e7c | ||
|
|
e1be9dd668 | ||
|
|
6eb5ef2606 | ||
|
|
397f30b58b | ||
|
|
ca4c1b4b95 | ||
|
|
806f8f67d5 | ||
|
|
2cf224da49 | ||
|
|
ee8e457c5f | ||
|
|
bff2ed0a86 | ||
|
|
b7be9c2b81 | ||
|
|
787ad6b094 | ||
|
|
a0ae934c14 | ||
|
|
678b3cfe7d | ||
|
|
bc0932a745 | ||
|
|
5a14098803 | ||
|
|
5b17bd4393 | ||
|
|
d0d0ff1be0 | ||
|
|
2093b45799 | ||
|
|
16649ec896 | ||
|
|
8ff992bf1d | ||
|
|
577b44cdc1 | ||
|
|
3facba2730 | ||
|
|
0cec7d4933 | ||
|
|
ac124f5b08 | ||
|
|
4d12e073ee | ||
|
|
fac0a533b0 | ||
|
|
f87deea4fb | ||
|
|
068875534b | ||
|
|
a80031509e | ||
|
|
020db29e6d | ||
|
|
c516ea9d6a | ||
|
|
68c0516f69 | ||
|
|
7adc39bd82 | ||
|
|
56e969660e | ||
|
|
b9abf701a0 | ||
|
|
6d6bcd0a9b | ||
|
|
4e7c66726f | ||
|
|
73033643e7 |
2255 changed files with 96640 additions and 58024 deletions
|
|
@ -1 +1 @@
|
||||||
6.7
|
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]+)'"
|
||||||
12
.butcher/enums/ChatBoostSourceType.yml
Normal file
12
.butcher/enums/ChatBoostSourceType.yml
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
name: ChatBoostSourceType
|
||||||
|
description: |
|
||||||
|
This object represents a type of chat boost source.
|
||||||
|
|
||||||
|
Source: https://core.telegram.org/bots/api#chatboostsource
|
||||||
|
multi_parse:
|
||||||
|
attribute: source
|
||||||
|
regexp: "'([a-z_]+)'"
|
||||||
|
entities:
|
||||||
|
- ChatBoostSourcePremium
|
||||||
|
- ChatBoostSourceGiftCode
|
||||||
|
- ChatBoostSourceGiveaway
|
||||||
|
|
@ -31,3 +31,22 @@ extract:
|
||||||
- caption
|
- caption
|
||||||
- caption_entities
|
- caption_entities
|
||||||
- reply_to_message
|
- reply_to_message
|
||||||
|
- quote
|
||||||
|
- forward_origin
|
||||||
|
- external_reply
|
||||||
|
- link_preview_options
|
||||||
|
- sender_boost_count
|
||||||
|
- 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
|
||||||
|
|
|
||||||
12
.butcher/enums/InputPaidMediaType.yml
Normal file
12
.butcher/enums/InputPaidMediaType.yml
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
name: InputPaidMediaType
|
||||||
|
description: |
|
||||||
|
This object represents the type of a media in a paid message.
|
||||||
|
|
||||||
|
Source: https://core.telegram.org/bots/api#inputpaidmedia
|
||||||
|
multi_parse:
|
||||||
|
format: rst
|
||||||
|
attribute: type
|
||||||
|
regexp: '\*([a-z_]+)\*'
|
||||||
|
entities:
|
||||||
|
- InputPaidMediaPhoto
|
||||||
|
- InputPaidMediaVideo
|
||||||
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
|
||||||
8
.butcher/enums/KeyboardButtonPollTypeType.yml
Normal file
8
.butcher/enums/KeyboardButtonPollTypeType.yml
Normal file
|
|
@ -0,0 +1,8 @@
|
||||||
|
name: KeyboardButtonPollTypeType
|
||||||
|
description: |
|
||||||
|
This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed.
|
||||||
|
|
||||||
|
Source: https://core.telegram.org/bots/api#keyboardbuttonpolltype
|
||||||
|
static:
|
||||||
|
QUIZ: "quiz"
|
||||||
|
REGULAR: "regular"
|
||||||
13
.butcher/enums/MessageOriginType.yml
Normal file
13
.butcher/enums/MessageOriginType.yml
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
name: MessageOriginType
|
||||||
|
description: |
|
||||||
|
This object represents origin of a message.
|
||||||
|
|
||||||
|
Source: https://core.telegram.org/bots/api#messageorigin
|
||||||
|
multi_parse:
|
||||||
|
attribute: type
|
||||||
|
regexp: "'([a-z_]+)'"
|
||||||
|
entities:
|
||||||
|
- MessageOriginUser
|
||||||
|
- MessageOriginHiddenUser
|
||||||
|
- MessageOriginChat
|
||||||
|
- MessageOriginChannel
|
||||||
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
|
||||||
13
.butcher/enums/PaidMediaType.yml
Normal file
13
.butcher/enums/PaidMediaType.yml
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
name: PaidMediaType
|
||||||
|
description: |
|
||||||
|
This object represents the type of a media in a paid message.
|
||||||
|
|
||||||
|
Source: https://core.telegram.org/bots/api#paidmedia
|
||||||
|
multi_parse:
|
||||||
|
format: rst
|
||||||
|
attribute: type
|
||||||
|
regexp: "'([a-z]+)'"
|
||||||
|
entities:
|
||||||
|
- PaidMediaPhoto
|
||||||
|
- PaidMediaPreview
|
||||||
|
- PaidMediaVideo
|
||||||
12
.butcher/enums/ReactionTypeType.yml
Normal file
12
.butcher/enums/ReactionTypeType.yml
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
name: ReactionTypeType
|
||||||
|
description: |
|
||||||
|
This object represents reaction type.
|
||||||
|
|
||||||
|
Source: https://core.telegram.org/bots/api#reactiontype
|
||||||
|
multi_parse:
|
||||||
|
attribute: type
|
||||||
|
regexp: "'([a-z_]+)'"
|
||||||
|
entities:
|
||||||
|
- ReactionTypeEmoji
|
||||||
|
- ReactionTypeCustomEmoji
|
||||||
|
- ReactionTypePaid
|
||||||
12
.butcher/enums/RevenueWithdrawalStateType.yml
Normal file
12
.butcher/enums/RevenueWithdrawalStateType.yml
Normal file
|
|
@ -0,0 +1,12 @@
|
||||||
|
name: RevenueWithdrawalStateType
|
||||||
|
description: |
|
||||||
|
This object represents a revenue withdrawal state type
|
||||||
|
|
||||||
|
Source: https://core.telegram.org/bots/api#revenuewithdrawalstate
|
||||||
|
multi_parse:
|
||||||
|
attribute: type
|
||||||
|
regexp: "'([a-z_]+)'"
|
||||||
|
entities:
|
||||||
|
- RevenueWithdrawalStateFailed
|
||||||
|
- RevenueWithdrawalStatePending
|
||||||
|
- RevenueWithdrawalStateSucceeded
|
||||||
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
|
||||||
16
.butcher/enums/TransactionPartnerType.yml
Normal file
16
.butcher/enums/TransactionPartnerType.yml
Normal file
|
|
@ -0,0 +1,16 @@
|
||||||
|
name: TransactionPartnerType
|
||||||
|
description: |
|
||||||
|
This object represents a type of transaction partner.
|
||||||
|
|
||||||
|
Source: https://core.telegram.org/bots/api#transactionpartner
|
||||||
|
multi_parse:
|
||||||
|
attribute: type
|
||||||
|
regexp: "'([a-z_]+)'"
|
||||||
|
entities:
|
||||||
|
- TransactionPartnerFragment
|
||||||
|
- 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/addStickerToSet/entity.json
generated
6
.butcher/methods/addStickerToSet/entity.json
generated
|
|
@ -7,9 +7,9 @@
|
||||||
"object": {
|
"object": {
|
||||||
"anchor": "addstickertoset",
|
"anchor": "addstickertoset",
|
||||||
"name": "addStickerToSet",
|
"name": "addStickerToSet",
|
||||||
"description": "Use this method to add a new sticker to a set created by the bot. The format of the added sticker must match the format of the other stickers in the set. Emoji sticker sets can have up to 200 stickers. Animated and video sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers. Returns True on success.",
|
"description": "Use this method to add a new sticker to a set created by the bot. Emoji sticker sets can have up to 200 stickers. Other sticker sets can have up to 120 stickers. Returns True on success.",
|
||||||
"html_description": "<p>Use this method to add a new sticker to a set created by the bot. The format of the added sticker must match the format of the other stickers in the set. Emoji sticker sets can have up to 200 stickers. Animated and video sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers. Returns <em>True</em> on success.</p>",
|
"html_description": "<p>Use this method to add a new sticker to a set created by the bot. Emoji sticker sets can have up to 200 stickers. Other sticker sets can have up to 120 stickers. Returns <em>True</em> on success.</p>",
|
||||||
"rst_description": "Use this method to add a new sticker to a set created by the bot. The format of the added sticker must match the format of the other stickers in the set. Emoji sticker sets can have up to 200 stickers. Animated and video sticker sets can have up to 50 stickers. Static sticker sets can have up to 120 stickers. Returns :code:`True` on success.",
|
"rst_description": "Use this method to add a new sticker to a set created by the bot. Emoji sticker sets can have up to 200 stickers. Other sticker sets can have up to 120 stickers. Returns :code:`True` on success.",
|
||||||
"annotations": [
|
"annotations": [
|
||||||
{
|
{
|
||||||
"type": "Integer",
|
"type": "Integer",
|
||||||
|
|
|
||||||
6
.butcher/methods/answerShippingQuery/entity.json
generated
6
.butcher/methods/answerShippingQuery/entity.json
generated
|
|
@ -38,9 +38,9 @@
|
||||||
{
|
{
|
||||||
"type": "String",
|
"type": "String",
|
||||||
"required": false,
|
"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.",
|
"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>",
|
"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",
|
"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"
|
"name": "error_message"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
|
|
|
||||||
4
.butcher/methods/answerWebAppQuery/entity.json
generated
4
.butcher/methods/answerWebAppQuery/entity.json
generated
|
|
@ -1,8 +1,8 @@
|
||||||
{
|
{
|
||||||
"meta": {},
|
"meta": {},
|
||||||
"group": {
|
"group": {
|
||||||
"title": "Inline mode",
|
"title": "Available methods",
|
||||||
"anchor": "inline-mode"
|
"anchor": "available-methods"
|
||||||
},
|
},
|
||||||
"object": {
|
"object": {
|
||||||
"anchor": "answerwebappquery",
|
"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
|
||||||
6
.butcher/methods/banChatMember/entity.json
generated
6
.butcher/methods/banChatMember/entity.json
generated
|
|
@ -30,9 +30,9 @@
|
||||||
{
|
{
|
||||||
"type": "Integer",
|
"type": "Integer",
|
||||||
"required": false,
|
"required": false,
|
||||||
"description": "Date when the user will be unbanned, unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only.",
|
"description": "Date when the user will be unbanned; Unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only.",
|
||||||
"html_description": "<td>Date when the user will be unbanned, unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only.</td>",
|
"html_description": "<td>Date when the user will be unbanned; Unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only.</td>",
|
||||||
"rst_description": "Date when the user will be unbanned, unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only.\n",
|
"rst_description": "Date when the user will be unbanned; Unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever. Applied for supergroups and channels only.\n",
|
||||||
"name": "until_date"
|
"name": "until_date"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|
|
||||||
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"
|
||||||
|
}
|
||||||
|
}
|
||||||
3
.butcher/methods/copyMessage/default.yml
Normal file
3
.butcher/methods/copyMessage/default.yml
Normal file
|
|
@ -0,0 +1,3 @@
|
||||||
|
parse_mode: parse_mode
|
||||||
|
protect_content: protect_content
|
||||||
|
show_caption_above_media: show_caption_above_media
|
||||||
98
.butcher/methods/copyMessage/entity.json
generated
98
.butcher/methods/copyMessage/entity.json
generated
|
|
@ -7,9 +7,9 @@
|
||||||
"object": {
|
"object": {
|
||||||
"anchor": "copymessage",
|
"anchor": "copymessage",
|
||||||
"name": "copyMessage",
|
"name": "copyMessage",
|
||||||
"description": "Use this method to copy messages of any kind. Service messages and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success.",
|
"description": "Use this method to copy messages of any kind. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessage, but the copied message doesn't have a link to the original message. Returns the MessageId of the sent message on success.",
|
||||||
"html_description": "<p>Use this method to copy messages of any kind. Service messages and invoice messages can't be copied. A quiz <a href=\"#poll\">poll</a> can be copied only if the value of the field <em>correct_option_id</em> is known to the bot. The method is analogous to the method <a href=\"#forwardmessage\">forwardMessage</a>, but the copied message doesn't have a link to the original message. Returns the <a href=\"#messageid\">MessageId</a> of the sent message on success.</p>",
|
"html_description": "<p>Use this method to copy messages of any kind. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz <a href=\"#poll\">poll</a> can be copied only if the value of the field <em>correct_option_id</em> is known to the bot. The method is analogous to the method <a href=\"#forwardmessage\">forwardMessage</a>, but the copied message doesn't have a link to the original message. Returns the <a href=\"#messageid\">MessageId</a> of the sent message on success.</p>",
|
||||||
"rst_description": "Use this method to copy messages of any kind. Service messages and invoice messages can't be copied. A quiz :class:`aiogram.methods.poll.Poll` can be copied only if the value of the field *correct_option_id* is known to the bot. The method is analogous to the method :class:`aiogram.methods.forward_message.ForwardMessage`, but the copied message doesn't have a link to the original message. Returns the :class:`aiogram.types.message_id.MessageId` of the sent message on success.",
|
"rst_description": "Use this method to copy messages of any kind. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz :class:`aiogram.methods.poll.Poll` can be copied only if the value of the field *correct_option_id* is known to the bot. The method is analogous to the method :class:`aiogram.methods.forward_message.ForwardMessage`, but the copied message doesn't have a link to the original message. Returns the :class:`aiogram.types.message_id.MessageId` of the sent message on success.",
|
||||||
"annotations": [
|
"annotations": [
|
||||||
{
|
{
|
||||||
"type": "Integer or String",
|
"type": "Integer or String",
|
||||||
|
|
@ -22,11 +22,19 @@
|
||||||
{
|
{
|
||||||
"type": "Integer",
|
"type": "Integer",
|
||||||
"required": false,
|
"required": false,
|
||||||
"description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
|
"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 the forum; for forum supergroups only</td>",
|
"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 the forum; for forum supergroups only\n",
|
"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"
|
"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",
|
"type": "Integer or String",
|
||||||
"required": true,
|
"required": true,
|
||||||
|
|
@ -43,6 +51,14 @@
|
||||||
"rst_description": "Message identifier in the chat specified in *from_chat_id*\n",
|
"rst_description": "Message identifier in the chat specified in *from_chat_id*\n",
|
||||||
"name": "message_id"
|
"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",
|
"type": "String",
|
||||||
"required": false,
|
"required": false,
|
||||||
|
|
@ -67,6 +83,14 @@
|
||||||
"rst_description": "A JSON-serialized list of special entities that appear in the new caption, which can be specified instead of *parse_mode*\n",
|
"rst_description": "A JSON-serialized list of special entities that appear in the new caption, which can be specified instead of *parse_mode*\n",
|
||||||
"name": "caption_entities"
|
"name": "caption_entities"
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"type": "Boolean",
|
||||||
|
"required": false,
|
||||||
|
"description": "Pass True, if the caption must be shown above the message media. Ignored if a new caption isn't specified.",
|
||||||
|
"html_description": "<td>Pass <em>True</em>, if the caption must be shown above the message media. Ignored if a new caption isn't specified.</td>",
|
||||||
|
"rst_description": "Pass :code:`True`, if the caption must be shown above the message media. Ignored if a new caption isn't specified.\n",
|
||||||
|
"name": "show_caption_above_media"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"type": "Boolean",
|
"type": "Boolean",
|
||||||
"required": false,
|
"required": false,
|
||||||
|
|
@ -84,12 +108,44 @@
|
||||||
"name": "protect_content"
|
"name": "protect_content"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "Integer",
|
"type": "Boolean",
|
||||||
"required": false,
|
"required": false,
|
||||||
"description": "If the message is a reply, ID of the original message",
|
"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>If the message is a reply, ID of the original message</td>",
|
"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": "If the message is a reply, ID of the original message\n",
|
"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": "reply_to_message_id"
|
"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,
|
||||||
|
"description": "Description of the message to reply to",
|
||||||
|
"html_description": "<td>Description of the message to reply to</td>",
|
||||||
|
"rst_description": "Description of the message to reply to\n",
|
||||||
|
"name": "reply_parameters"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply",
|
||||||
|
"required": false,
|
||||||
|
"description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user",
|
||||||
|
"html_description": "<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user</td>",
|
||||||
|
"rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user\n",
|
||||||
|
"name": "reply_markup"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "Boolean",
|
"type": "Boolean",
|
||||||
|
|
@ -97,15 +153,23 @@
|
||||||
"description": "Pass True if the message should be sent even if the specified replied-to message is not found",
|
"description": "Pass True if the message should be sent even if the specified replied-to message is not found",
|
||||||
"html_description": "<td>Pass <em>True</em> if the message should be sent even if the specified replied-to message is not found</td>",
|
"html_description": "<td>Pass <em>True</em> if the message should be sent even if the specified replied-to message is not found</td>",
|
||||||
"rst_description": "Pass :code:`True` if the message should be sent even if the specified replied-to message is not found\n",
|
"rst_description": "Pass :code:`True` if the message should be sent even if the specified replied-to message is not found\n",
|
||||||
"name": "allow_sending_without_reply"
|
"name": "allow_sending_without_reply",
|
||||||
|
"deprecated": {
|
||||||
|
"version": "7.0",
|
||||||
|
"release_date": "2023-12-29"
|
||||||
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply",
|
"type": "Integer",
|
||||||
"required": false,
|
"required": false,
|
||||||
"description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.",
|
"description": "If the message is a reply, ID of the original message",
|
||||||
"html_description": "<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove reply keyboard or to force a reply from the user.</td>",
|
"html_description": "<td>If the message is a reply, ID of the original message</td>",
|
||||||
"rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove reply keyboard or to force a reply from the user.\n",
|
"rst_description": "If the message is a reply, ID of the original message\n",
|
||||||
"name": "reply_markup"
|
"name": "reply_to_message_id",
|
||||||
|
"deprecated": {
|
||||||
|
"version": "7.0",
|
||||||
|
"release_date": "2023-12-29"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"category": "methods"
|
"category": "methods"
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,11 @@
|
||||||
annotations:
|
annotations:
|
||||||
parse_mode:
|
video_start_timestamp:
|
||||||
value: UNSET_PARSE_MODE
|
parsed_type:
|
||||||
protect_content:
|
type: union
|
||||||
value: UNSET_PROTECT_CONTENT
|
items:
|
||||||
|
- type: std
|
||||||
|
name: datetime.datetime
|
||||||
|
- type: std
|
||||||
|
name: datetime.timedelta
|
||||||
|
- type: std
|
||||||
|
name: int
|
||||||
|
|
|
||||||
81
.butcher/methods/copyMessages/entity.json
generated
Normal file
81
.butcher/methods/copyMessages/entity.json
generated
Normal file
|
|
@ -0,0 +1,81 @@
|
||||||
|
{
|
||||||
|
"meta": {},
|
||||||
|
"group": {
|
||||||
|
"title": "Available methods",
|
||||||
|
"anchor": "available-methods"
|
||||||
|
},
|
||||||
|
"object": {
|
||||||
|
"anchor": "copymessages",
|
||||||
|
"name": "copyMessages",
|
||||||
|
"description": "Use this method to copy messages of any kind. If some of the specified messages can't be found or copied, they are skipped. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll can be copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the method forwardMessages, but the copied messages don't have a link to the original message. Album grouping is kept for copied messages. On success, an array of MessageId of the sent messages is returned.",
|
||||||
|
"html_description": "<p>Use this method to copy messages of any kind. If some of the specified messages can't be found or copied, they are skipped. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz <a href=\"#poll\">poll</a> can be copied only if the value of the field <em>correct_option_id</em> is known to the bot. The method is analogous to the method <a href=\"#forwardmessages\">forwardMessages</a>, but the copied messages don't have a link to the original message. Album grouping is kept for copied messages. On success, an array of <a href=\"#messageid\">MessageId</a> of the sent messages is returned.</p>",
|
||||||
|
"rst_description": "Use this method to copy messages of any kind. If some of the specified messages can't be found or copied, they are skipped. Service messages, paid media messages, giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz :class:`aiogram.methods.poll.Poll` can be copied only if the value of the field *correct_option_id* is known to the bot. The method is analogous to the method :class:`aiogram.methods.forward_messages.ForwardMessages`, but the copied messages don't have a link to the original message. Album grouping is kept for copied messages. On success, an array of :class:`aiogram.types.message_id.MessageId` of the sent messages is returned.",
|
||||||
|
"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": "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 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,
|
||||||
|
"description": "Unique identifier for the chat where the original messages were sent (or channel username in the format @channelusername)",
|
||||||
|
"html_description": "<td>Unique identifier for the chat where the original messages were sent (or channel username in the format <code>@channelusername</code>)</td>",
|
||||||
|
"rst_description": "Unique identifier for the chat where the original messages were sent (or channel username in the format :code:`@channelusername`)\n",
|
||||||
|
"name": "from_chat_id"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "Array of Integer",
|
||||||
|
"required": true,
|
||||||
|
"description": "A JSON-serialized list of 1-100 identifiers of messages in the chat from_chat_id to copy. The identifiers must be specified in a strictly increasing order.",
|
||||||
|
"html_description": "<td>A JSON-serialized list of 1-100 identifiers of messages in the chat <em>from_chat_id</em> to copy. The identifiers must be specified in a strictly increasing order.</td>",
|
||||||
|
"rst_description": "A JSON-serialized list of 1-100 identifiers of messages in the chat *from_chat_id* to copy. The identifiers must be specified in a strictly increasing order.\n",
|
||||||
|
"name": "message_ids"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "Boolean",
|
||||||
|
"required": false,
|
||||||
|
"description": "Sends the messages silently. Users will receive a notification with no sound.",
|
||||||
|
"html_description": "<td>Sends the messages <a href=\"https://telegram.org/blog/channels-2-0#silent-messages\">silently</a>. Users will receive a notification with no sound.</td>",
|
||||||
|
"rst_description": "Sends the messages `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound.\n",
|
||||||
|
"name": "disable_notification"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "Boolean",
|
||||||
|
"required": false,
|
||||||
|
"description": "Protects the contents of the sent messages from forwarding and saving",
|
||||||
|
"html_description": "<td>Protects the contents of the sent messages from forwarding and saving</td>",
|
||||||
|
"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 copy the messages without their captions",
|
||||||
|
"html_description": "<td>Pass <em>True</em> to copy the messages without their captions</td>",
|
||||||
|
"rst_description": "Pass :code:`True` to copy the messages without their captions\n",
|
||||||
|
"name": "remove_caption"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"category": "methods"
|
||||||
|
}
|
||||||
|
}
|
||||||
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": {
|
"object": {
|
||||||
"anchor": "createforumtopic",
|
"anchor": "createforumtopic",
|
||||||
"name": "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.",
|
"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. 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>",
|
"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. 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.",
|
"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": [
|
"annotations": [
|
||||||
{
|
{
|
||||||
"type": "Integer or String",
|
"type": "Integer or String",
|
||||||
|
|
|
||||||
90
.butcher/methods/createInvoiceLink/entity.json
generated
90
.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>",
|
"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.",
|
"rst_description": "Use this method to create a link for an invoice. Returns the created invoice link as *String* on success.",
|
||||||
"annotations": [
|
"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",
|
"type": "String",
|
||||||
"required": true,
|
"required": true,
|
||||||
|
|
@ -30,41 +38,49 @@
|
||||||
{
|
{
|
||||||
"type": "String",
|
"type": "String",
|
||||||
"required": true,
|
"required": true,
|
||||||
"description": "Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use for your internal processes.",
|
"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 for your internal processes.</td>",
|
"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 for your internal processes.\n",
|
"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"
|
"name": "payload"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "String",
|
"type": "String",
|
||||||
"required": true,
|
"required": false,
|
||||||
"description": "Payment provider token, obtained via BotFather",
|
"description": "Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars.",
|
||||||
"html_description": "<td>Payment provider token, obtained via <a href=\"https://t.me/botfather\">BotFather</a></td>",
|
"html_description": "<td>Payment provider token, obtained via <a href=\"https://t.me/botfather\">@BotFather</a>. Pass an empty string for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
|
||||||
"rst_description": "Payment provider token, obtained via `BotFather <https://t.me/botfather>`_\n",
|
"rst_description": "Payment provider token, obtained via `@BotFather <https://t.me/botfather>`_. Pass an empty string for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
|
||||||
"name": "provider_token"
|
"name": "provider_token"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "String",
|
"type": "String",
|
||||||
"required": true,
|
"required": true,
|
||||||
"description": "Three-letter ISO 4217 currency code, see more on currencies",
|
"description": "Three-letter ISO 4217 currency code, see more on currencies. Pass 'XTR' for payments in Telegram Stars.",
|
||||||
"html_description": "<td>Three-letter ISO 4217 currency code, see <a href=\"/bots/payments#supported-currencies\">more on currencies</a></td>",
|
"html_description": "<td>Three-letter ISO 4217 currency code, see <a href=\"/bots/payments#supported-currencies\">more on currencies</a>. Pass “XTR” for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
|
||||||
"rst_description": "Three-letter ISO 4217 currency code, see `more on currencies <https://core.telegram.org/bots/payments#supported-currencies>`_\n",
|
"rst_description": "Three-letter ISO 4217 currency code, see `more on currencies <https://core.telegram.org/bots/payments#supported-currencies>`_. Pass 'XTR' for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
|
||||||
"name": "currency"
|
"name": "currency"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "Array of LabeledPrice",
|
"type": "Array of LabeledPrice",
|
||||||
"required": true,
|
"required": true,
|
||||||
"description": "Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)",
|
"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.",
|
||||||
"html_description": "<td>Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)</td>",
|
"html_description": "<td>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 <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
|
||||||
"rst_description": "Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus, etc.)\n",
|
"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"
|
"name": "prices"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "Integer",
|
"type": "Integer",
|
||||||
"required": false,
|
"required": false,
|
||||||
"description": "The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0",
|
"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 maximum accepted amount for tips in the <em>smallest units</em> of the currency (integer, <strong>not</strong> float/double). For example, for a maximum tip of <code>US$ 1.45</code> pass <code>max_tip_amount = 145</code>. See the <em>exp</em> parameter in <a href=\"/bots/payments/currencies.json\">currencies.json</a>, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0</td>",
|
"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 maximum accepted amount for tips in the *smallest units* of the currency (integer, **not** float/double). For example, for a maximum tip of :code:`US$ 1.45` pass :code:`max_tip_amount = 145`. See the *exp* parameter in `currencies.json <https://core.telegram.org/bots/payments/currencies.json>`_, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0\n",
|
"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,
|
||||||
|
"description": "The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double). For example, for a maximum tip of US$ 1.45 pass max_tip_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in Telegram Stars.",
|
||||||
|
"html_description": "<td>The maximum accepted amount for tips in the <em>smallest units</em> of the currency (integer, <strong>not</strong> float/double). For example, for a maximum tip of <code>US$ 1.45</code> pass <code>max_tip_amount = 145</code>. See the <em>exp</em> parameter in <a href=\"/bots/payments/currencies.json\">currencies.json</a>, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
|
||||||
|
"rst_description": "The maximum accepted amount for tips in the *smallest units* of the currency (integer, **not** float/double). For example, for a maximum tip of :code:`US$ 1.45` pass :code:`max_tip_amount = 145`. See the *exp* parameter in `currencies.json <https://core.telegram.org/bots/payments/currencies.json>`_, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies). Defaults to 0. Not supported for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
|
||||||
"name": "max_tip_amount"
|
"name": "max_tip_amount"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|
@ -118,57 +134,57 @@
|
||||||
{
|
{
|
||||||
"type": "Boolean",
|
"type": "Boolean",
|
||||||
"required": false,
|
"required": false,
|
||||||
"description": "Pass True if you require the user's full name to complete the order",
|
"description": "Pass True if you require the user's full name to complete the order. Ignored for payments in Telegram Stars.",
|
||||||
"html_description": "<td>Pass <em>True</em> if you require the user's full name to complete the order</td>",
|
"html_description": "<td>Pass <em>True</em> if you require the user's full name to complete the order. Ignored for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
|
||||||
"rst_description": "Pass :code:`True` if you require the user's full name to complete the order\n",
|
"rst_description": "Pass :code:`True` if you require the user's full name to complete the order. Ignored for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
|
||||||
"name": "need_name"
|
"name": "need_name"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "Boolean",
|
"type": "Boolean",
|
||||||
"required": false,
|
"required": false,
|
||||||
"description": "Pass True if you require the user's phone number to complete the order",
|
"description": "Pass True if you require the user's phone number to complete the order. Ignored for payments in Telegram Stars.",
|
||||||
"html_description": "<td>Pass <em>True</em> if you require the user's phone number to complete the order</td>",
|
"html_description": "<td>Pass <em>True</em> if you require the user's phone number to complete the order. Ignored for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
|
||||||
"rst_description": "Pass :code:`True` if you require the user's phone number to complete the order\n",
|
"rst_description": "Pass :code:`True` if you require the user's phone number to complete the order. Ignored for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
|
||||||
"name": "need_phone_number"
|
"name": "need_phone_number"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "Boolean",
|
"type": "Boolean",
|
||||||
"required": false,
|
"required": false,
|
||||||
"description": "Pass True if you require the user's email address to complete the order",
|
"description": "Pass True if you require the user's email address to complete the order. Ignored for payments in Telegram Stars.",
|
||||||
"html_description": "<td>Pass <em>True</em> if you require the user's email address to complete the order</td>",
|
"html_description": "<td>Pass <em>True</em> if you require the user's email address to complete the order. Ignored for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
|
||||||
"rst_description": "Pass :code:`True` if you require the user's email address to complete the order\n",
|
"rst_description": "Pass :code:`True` if you require the user's email address to complete the order. Ignored for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
|
||||||
"name": "need_email"
|
"name": "need_email"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "Boolean",
|
"type": "Boolean",
|
||||||
"required": false,
|
"required": false,
|
||||||
"description": "Pass True if you require the user's shipping address to complete the order",
|
"description": "Pass True if you require the user's shipping address to complete the order. Ignored for payments in Telegram Stars.",
|
||||||
"html_description": "<td>Pass <em>True</em> if you require the user's shipping address to complete the order</td>",
|
"html_description": "<td>Pass <em>True</em> if you require the user's shipping address to complete the order. Ignored for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
|
||||||
"rst_description": "Pass :code:`True` if you require the user's shipping address to complete the order\n",
|
"rst_description": "Pass :code:`True` if you require the user's shipping address to complete the order. Ignored for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
|
||||||
"name": "need_shipping_address"
|
"name": "need_shipping_address"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "Boolean",
|
"type": "Boolean",
|
||||||
"required": false,
|
"required": false,
|
||||||
"description": "Pass True if the user's phone number should be sent to the provider",
|
"description": "Pass True if the user's phone number should be sent to the provider. Ignored for payments in Telegram Stars.",
|
||||||
"html_description": "<td>Pass <em>True</em> if the user's phone number should be sent to the provider</td>",
|
"html_description": "<td>Pass <em>True</em> if the user's phone number should be sent to the provider. Ignored for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
|
||||||
"rst_description": "Pass :code:`True` if the user's phone number should be sent to the provider\n",
|
"rst_description": "Pass :code:`True` if the user's phone number should be sent to the provider. Ignored for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
|
||||||
"name": "send_phone_number_to_provider"
|
"name": "send_phone_number_to_provider"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "Boolean",
|
"type": "Boolean",
|
||||||
"required": false,
|
"required": false,
|
||||||
"description": "Pass True if the user's email address should be sent to the provider",
|
"description": "Pass True if the user's email address should be sent to the provider. Ignored for payments in Telegram Stars.",
|
||||||
"html_description": "<td>Pass <em>True</em> if the user's email address should be sent to the provider</td>",
|
"html_description": "<td>Pass <em>True</em> if the user's email address should be sent to the provider. Ignored for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
|
||||||
"rst_description": "Pass :code:`True` if the user's email address should be sent to the provider\n",
|
"rst_description": "Pass :code:`True` if the user's email address should be sent to the provider. Ignored for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
|
||||||
"name": "send_email_to_provider"
|
"name": "send_email_to_provider"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "Boolean",
|
"type": "Boolean",
|
||||||
"required": false,
|
"required": false,
|
||||||
"description": "Pass True if the final price depends on the shipping method",
|
"description": "Pass True if the final price depends on the shipping method. Ignored for payments in Telegram Stars.",
|
||||||
"html_description": "<td>Pass <em>True</em> if the final price depends on the shipping method</td>",
|
"html_description": "<td>Pass <em>True</em> if the final price depends on the shipping method. Ignored for payments in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>.</td>",
|
||||||
"rst_description": "Pass :code:`True` if the final price depends on the shipping method\n",
|
"rst_description": "Pass :code:`True` if the final price depends on the shipping method. Ignored for payments in `Telegram Stars <https://t.me/BotNews/90>`_.\n",
|
||||||
"name": "is_flexible"
|
"name": "is_flexible"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
|
|
|
||||||
20
.butcher/methods/createNewStickerSet/entity.json
generated
20
.butcher/methods/createNewStickerSet/entity.json
generated
|
|
@ -43,14 +43,6 @@
|
||||||
"rst_description": "A JSON-serialized list of 1-50 initial stickers to be added to the sticker set\n",
|
"rst_description": "A JSON-serialized list of 1-50 initial stickers to be added to the sticker set\n",
|
||||||
"name": "stickers"
|
"name": "stickers"
|
||||||
},
|
},
|
||||||
{
|
|
||||||
"type": "String",
|
|
||||||
"required": true,
|
|
||||||
"description": "Format of stickers in the set, must be one of 'static', 'animated', 'video'",
|
|
||||||
"html_description": "<td>Format of stickers in the set, must be one of “static”, “animated”, “video”</td>",
|
|
||||||
"rst_description": "Format of stickers in the set, must be one of 'static', 'animated', 'video'\n",
|
|
||||||
"name": "sticker_format"
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
"type": "String",
|
"type": "String",
|
||||||
"required": false,
|
"required": false,
|
||||||
|
|
@ -66,6 +58,18 @@
|
||||||
"html_description": "<td>Pass <em>True</em> if stickers in the sticker set must be repainted to the color of text when used in messages, the accent color if used as emoji status, white on chat photos, or another appropriate color based on context; for custom emoji sticker sets only</td>",
|
"html_description": "<td>Pass <em>True</em> if stickers in the sticker set must be repainted to the color of text when used in messages, the accent color if used as emoji status, white on chat photos, or another appropriate color based on context; for custom emoji sticker sets only</td>",
|
||||||
"rst_description": "Pass :code:`True` if stickers in the sticker set must be repainted to the color of text when used in messages, the accent color if used as emoji status, white on chat photos, or another appropriate color based on context; for custom emoji sticker sets only\n",
|
"rst_description": "Pass :code:`True` if stickers in the sticker set must be repainted to the color of text when used in messages, the accent color if used as emoji status, white on chat photos, or another appropriate color based on context; for custom emoji sticker sets only\n",
|
||||||
"name": "needs_repainting"
|
"name": "needs_repainting"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "String",
|
||||||
|
"required": false,
|
||||||
|
"description": "Format of stickers in the set, must be one of 'static', 'animated', 'video'",
|
||||||
|
"html_description": "<td>Format of stickers in the set, must be one of “static”, “animated”, “video”</td>",
|
||||||
|
"rst_description": "Format of stickers in the set, must be one of 'static', 'animated', 'video'\n",
|
||||||
|
"name": "sticker_format",
|
||||||
|
"deprecated": {
|
||||||
|
"version": "7.2",
|
||||||
|
"release_date": "2024-03-31"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"category": "methods"
|
"category": "methods"
|
||||||
|
|
|
||||||
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": {
|
"object": {
|
||||||
"anchor": "deleteforumtopic",
|
"anchor": "deleteforumtopic",
|
||||||
"name": "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.",
|
"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. 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>",
|
"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. 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.",
|
"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": [
|
"annotations": [
|
||||||
{
|
{
|
||||||
"type": "Integer or String",
|
"type": "Integer or String",
|
||||||
|
|
|
||||||
6
.butcher/methods/deleteMessage/entity.json
generated
6
.butcher/methods/deleteMessage/entity.json
generated
|
|
@ -7,9 +7,9 @@
|
||||||
"object": {
|
"object": {
|
||||||
"anchor": "deletemessage",
|
"anchor": "deletemessage",
|
||||||
"name": "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.",
|
"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> permission in a supergroup or a channel, it can delete any message there.<br/>\nReturns <em>True</em> on success.</p>",
|
"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* permission in a supergroup or a channel, it can delete any message there.\n\nReturns :code:`True` on success.",
|
"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": [
|
"annotations": [
|
||||||
{
|
{
|
||||||
"type": "Integer or String",
|
"type": "Integer or String",
|
||||||
|
|
|
||||||
33
.butcher/methods/deleteMessages/entity.json
generated
Normal file
33
.butcher/methods/deleteMessages/entity.json
generated
Normal file
|
|
@ -0,0 +1,33 @@
|
||||||
|
{
|
||||||
|
"meta": {},
|
||||||
|
"group": {
|
||||||
|
"title": "Updating messages",
|
||||||
|
"anchor": "updating-messages"
|
||||||
|
},
|
||||||
|
"object": {
|
||||||
|
"anchor": "deletemessages",
|
||||||
|
"name": "deleteMessages",
|
||||||
|
"description": "Use this method to delete multiple messages simultaneously. If some of the specified messages can't be found, they are skipped. Returns True on success.",
|
||||||
|
"html_description": "<p>Use this method to delete multiple messages simultaneously. If some of the specified messages can't be found, they are skipped. Returns <em>True</em> on success.</p>",
|
||||||
|
"rst_description": "Use this method to delete multiple messages simultaneously. If some of the specified messages can't be found, they are skipped. 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"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "Array of Integer",
|
||||||
|
"required": true,
|
||||||
|
"description": "A JSON-serialized list of 1-100 identifiers of messages to delete. 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. 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. See :class:`aiogram.methods.delete_message.DeleteMessage` for limitations on which messages can be deleted\n",
|
||||||
|
"name": "message_ids"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"category": "methods"
|
||||||
|
}
|
||||||
|
}
|
||||||
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": {
|
"object": {
|
||||||
"anchor": "editforumtopic",
|
"anchor": "editforumtopic",
|
||||||
"name": "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.",
|
"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. 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>",
|
"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. 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.",
|
"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": [
|
"annotations": [
|
||||||
{
|
{
|
||||||
"type": "Integer or String",
|
"type": "Integer or String",
|
||||||
|
|
|
||||||
|
|
@ -7,9 +7,9 @@
|
||||||
"object": {
|
"object": {
|
||||||
"anchor": "editgeneralforumtopic",
|
"anchor": "editgeneralforumtopic",
|
||||||
"name": "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.",
|
"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 <em>can_manage_topics</em> administrator rights. Returns <em>True</em> on success.</p>",
|
"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 *can_manage_topics* administrator rights. Returns :code:`True` on success.",
|
"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": [
|
"annotations": [
|
||||||
{
|
{
|
||||||
"type": "Integer or String",
|
"type": "Integer or String",
|
||||||
|
|
|
||||||
2
.butcher/methods/editMessageCaption/default.yml
Normal file
2
.butcher/methods/editMessageCaption/default.yml
Normal file
|
|
@ -0,0 +1,2 @@
|
||||||
|
parse_mode: parse_mode
|
||||||
|
show_caption_above_media: show_caption_above_media
|
||||||
22
.butcher/methods/editMessageCaption/entity.json
generated
22
.butcher/methods/editMessageCaption/entity.json
generated
|
|
@ -7,10 +7,18 @@
|
||||||
"object": {
|
"object": {
|
||||||
"anchor": "editmessagecaption",
|
"anchor": "editmessagecaption",
|
||||||
"name": "editMessageCaption",
|
"name": "editMessageCaption",
|
||||||
"description": "Use this method to edit captions of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.",
|
"description": "Use this method to edit captions of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. 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 captions of messages. 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.</p>",
|
"html_description": "<p>Use this method to edit captions of messages. 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 captions of messages. 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.",
|
"rst_description": "Use this method to edit captions of messages. 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": [
|
"annotations": [
|
||||||
|
{
|
||||||
|
"type": "String",
|
||||||
|
"required": false,
|
||||||
|
"description": "Unique identifier of the business connection on behalf of which the message to be edited was sent",
|
||||||
|
"html_description": "<td>Unique identifier of the business connection on behalf of which the message to be edited was sent</td>",
|
||||||
|
"rst_description": "Unique identifier of the business connection on behalf of which the message to be edited was sent\n",
|
||||||
|
"name": "business_connection_id"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"type": "Integer or String",
|
"type": "Integer or String",
|
||||||
"required": false,
|
"required": false,
|
||||||
|
|
@ -59,6 +67,14 @@
|
||||||
"rst_description": "A JSON-serialized list of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
|
"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"
|
"name": "caption_entities"
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"type": "Boolean",
|
||||||
|
"required": false,
|
||||||
|
"description": "Pass True, if the caption must be shown above the message media. Supported only for animation, photo and video messages.",
|
||||||
|
"html_description": "<td>Pass <em>True</em>, if the caption must be shown above the message media. Supported only for animation, photo and video messages.</td>",
|
||||||
|
"rst_description": "Pass :code:`True`, if the caption must be shown above the message media. Supported only for animation, photo and video messages.\n",
|
||||||
|
"name": "show_caption_above_media"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"type": "InlineKeyboardMarkup",
|
"type": "InlineKeyboardMarkup",
|
||||||
"required": false,
|
"required": false,
|
||||||
|
|
|
||||||
|
|
@ -1,3 +0,0 @@
|
||||||
annotations:
|
|
||||||
parse_mode:
|
|
||||||
value: UNSET_PARSE_MODE
|
|
||||||
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"
|
||||||
|
}
|
||||||
|
}
|
||||||
22
.butcher/methods/editMessageLiveLocation/entity.json
generated
22
.butcher/methods/editMessageLiveLocation/entity.json
generated
|
|
@ -11,6 +11,14 @@
|
||||||
"html_description": "<p>Use this method to edit live location messages. A location can be edited until its <em>live_period</em> expires or editing is explicitly disabled by a call to <a href=\"#stopmessagelivelocation\">stopMessageLiveLocation</a>. 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.</p>",
|
"html_description": "<p>Use this method to edit live location messages. A location can be edited until its <em>live_period</em> expires or editing is explicitly disabled by a call to <a href=\"#stopmessagelivelocation\">stopMessageLiveLocation</a>. 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.</p>",
|
||||||
"rst_description": "Use this method to edit live location messages. A location can be edited until its *live_period* expires or editing is explicitly disabled by a call to :class:`aiogram.methods.stop_message_live_location.StopMessageLiveLocation`. 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.",
|
"rst_description": "Use this method to edit live location messages. A location can be edited until its *live_period* expires or editing is explicitly disabled by a call to :class:`aiogram.methods.stop_message_live_location.StopMessageLiveLocation`. 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.",
|
||||||
"annotations": [
|
"annotations": [
|
||||||
|
{
|
||||||
|
"type": "String",
|
||||||
|
"required": false,
|
||||||
|
"description": "Unique identifier of the business connection on behalf of which the message to be edited was sent",
|
||||||
|
"html_description": "<td>Unique identifier of the business connection on behalf of which the message to be edited was sent</td>",
|
||||||
|
"rst_description": "Unique identifier of the business connection on behalf of which the message to be edited was sent\n",
|
||||||
|
"name": "business_connection_id"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"type": "Integer or String",
|
"type": "Integer or String",
|
||||||
"required": false,
|
"required": false,
|
||||||
|
|
@ -36,7 +44,7 @@
|
||||||
"name": "inline_message_id"
|
"name": "inline_message_id"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "Float number",
|
"type": "Float",
|
||||||
"required": true,
|
"required": true,
|
||||||
"description": "Latitude of new location",
|
"description": "Latitude of new location",
|
||||||
"html_description": "<td>Latitude of new location</td>",
|
"html_description": "<td>Latitude of new location</td>",
|
||||||
|
|
@ -44,7 +52,7 @@
|
||||||
"name": "latitude"
|
"name": "latitude"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "Float number",
|
"type": "Float",
|
||||||
"required": true,
|
"required": true,
|
||||||
"description": "Longitude of new location",
|
"description": "Longitude of new location",
|
||||||
"html_description": "<td>Longitude of new location</td>",
|
"html_description": "<td>Longitude of new location</td>",
|
||||||
|
|
@ -52,7 +60,15 @@
|
||||||
"name": "longitude"
|
"name": "longitude"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "Float number",
|
"type": "Integer",
|
||||||
|
"required": false,
|
||||||
|
"description": "New period in seconds during which the location can be updated, starting from the message send date. If 0x7FFFFFFF is specified, then the location can be updated forever. Otherwise, the new value must not exceed the current live_period by more than a day, and the live location expiration date must remain within the next 90 days. If not specified, then live_period remains unchanged",
|
||||||
|
"html_description": "<td>New period in seconds during which the location can be updated, starting from the message send date. If 0x7FFFFFFF is specified, then the location can be updated forever. Otherwise, the new value must not exceed the current <em>live_period</em> by more than a day, and the live location expiration date must remain within the next 90 days. If not specified, then <em>live_period</em> remains unchanged</td>",
|
||||||
|
"rst_description": "New period in seconds during which the location can be updated, starting from the message send date. If 0x7FFFFFFF is specified, then the location can be updated forever. Otherwise, the new value must not exceed the current *live_period* by more than a day, and the live location expiration date must remain within the next 90 days. If not specified, then *live_period* remains unchanged\n",
|
||||||
|
"name": "live_period"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "Float",
|
||||||
"required": false,
|
"required": false,
|
||||||
"description": "The radius of uncertainty for the location, measured in meters; 0-1500",
|
"description": "The radius of uncertainty for the location, measured in meters; 0-1500",
|
||||||
"html_description": "<td>The radius of uncertainty for the location, measured in meters; 0-1500</td>",
|
"html_description": "<td>The radius of uncertainty for the location, measured in meters; 0-1500</td>",
|
||||||
|
|
|
||||||
14
.butcher/methods/editMessageMedia/entity.json
generated
14
.butcher/methods/editMessageMedia/entity.json
generated
|
|
@ -7,10 +7,18 @@
|
||||||
"object": {
|
"object": {
|
||||||
"anchor": "editmessagemedia",
|
"anchor": "editmessagemedia",
|
||||||
"name": "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.",
|
"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. 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.</p>",
|
"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. 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.",
|
"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": [
|
"annotations": [
|
||||||
|
{
|
||||||
|
"type": "String",
|
||||||
|
"required": false,
|
||||||
|
"description": "Unique identifier of the business connection on behalf of which the message to be edited was sent",
|
||||||
|
"html_description": "<td>Unique identifier of the business connection on behalf of which the message to be edited was sent</td>",
|
||||||
|
"rst_description": "Unique identifier of the business connection on behalf of which the message to be edited was sent\n",
|
||||||
|
"name": "business_connection_id"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"type": "Integer or String",
|
"type": "Integer or String",
|
||||||
"required": false,
|
"required": false,
|
||||||
|
|
|
||||||
14
.butcher/methods/editMessageReplyMarkup/entity.json
generated
14
.butcher/methods/editMessageReplyMarkup/entity.json
generated
|
|
@ -7,10 +7,18 @@
|
||||||
"object": {
|
"object": {
|
||||||
"anchor": "editmessagereplymarkup",
|
"anchor": "editmessagereplymarkup",
|
||||||
"name": "editMessageReplyMarkup",
|
"name": "editMessageReplyMarkup",
|
||||||
"description": "Use this method to edit only the reply markup of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.",
|
"description": "Use this method to edit only the reply markup of messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. 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 only the reply markup of messages. 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.</p>",
|
"html_description": "<p>Use this method to edit only the reply markup of messages. 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 only the reply markup of messages. 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.",
|
"rst_description": "Use this method to edit only the reply markup of messages. 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": [
|
"annotations": [
|
||||||
|
{
|
||||||
|
"type": "String",
|
||||||
|
"required": false,
|
||||||
|
"description": "Unique identifier of the business connection on behalf of which the message to be edited was sent",
|
||||||
|
"html_description": "<td>Unique identifier of the business connection on behalf of which the message to be edited was sent</td>",
|
||||||
|
"rst_description": "Unique identifier of the business connection on behalf of which the message to be edited was sent\n",
|
||||||
|
"name": "business_connection_id"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"type": "Integer or String",
|
"type": "Integer or String",
|
||||||
"required": false,
|
"required": false,
|
||||||
|
|
|
||||||
3
.butcher/methods/editMessageText/default.yml
Normal file
3
.butcher/methods/editMessageText/default.yml
Normal file
|
|
@ -0,0 +1,3 @@
|
||||||
|
disable_web_page_preview: link_preview_is_disabled
|
||||||
|
link_preview_options: link_preview
|
||||||
|
parse_mode: parse_mode
|
||||||
36
.butcher/methods/editMessageText/entity.json
generated
36
.butcher/methods/editMessageText/entity.json
generated
|
|
@ -7,10 +7,18 @@
|
||||||
"object": {
|
"object": {
|
||||||
"anchor": "editmessagetext",
|
"anchor": "editmessagetext",
|
||||||
"name": "editMessageText",
|
"name": "editMessageText",
|
||||||
"description": "Use this method to edit text and game messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned.",
|
"description": "Use this method to edit text and game messages. On success, if the edited message is not an inline message, the edited Message is returned, otherwise True is returned. 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 text and <a href=\"#games\">game</a> messages. 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.</p>",
|
"html_description": "<p>Use this method to edit text and <a href=\"#games\">game</a> messages. 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 text and `game <https://core.telegram.org/bots/api#games>`_ messages. 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.",
|
"rst_description": "Use this method to edit text and `game <https://core.telegram.org/bots/api#games>`_ messages. 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": [
|
"annotations": [
|
||||||
|
{
|
||||||
|
"type": "String",
|
||||||
|
"required": false,
|
||||||
|
"description": "Unique identifier of the business connection on behalf of which the message to be edited was sent",
|
||||||
|
"html_description": "<td>Unique identifier of the business connection on behalf of which the message to be edited was sent</td>",
|
||||||
|
"rst_description": "Unique identifier of the business connection on behalf of which the message to be edited was sent\n",
|
||||||
|
"name": "business_connection_id"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"type": "Integer or String",
|
"type": "Integer or String",
|
||||||
"required": false,
|
"required": false,
|
||||||
|
|
@ -60,12 +68,12 @@
|
||||||
"name": "entities"
|
"name": "entities"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "Boolean",
|
"type": "LinkPreviewOptions",
|
||||||
"required": false,
|
"required": false,
|
||||||
"description": "Disables link previews for links in this message",
|
"description": "Link preview generation options for the message",
|
||||||
"html_description": "<td>Disables link previews for links in this message</td>",
|
"html_description": "<td>Link preview generation options for the message</td>",
|
||||||
"rst_description": "Disables link previews for links in this message\n",
|
"rst_description": "Link preview generation options for the message\n",
|
||||||
"name": "disable_web_page_preview"
|
"name": "link_preview_options"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "InlineKeyboardMarkup",
|
"type": "InlineKeyboardMarkup",
|
||||||
|
|
@ -74,6 +82,18 @@
|
||||||
"html_description": "<td>A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>.</td>",
|
"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",
|
"rst_description": "A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_.\n",
|
||||||
"name": "reply_markup"
|
"name": "reply_markup"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "Boolean",
|
||||||
|
"required": false,
|
||||||
|
"description": "Disables link previews for links in this message",
|
||||||
|
"html_description": "<td>Disables link previews for links in this message</td>",
|
||||||
|
"rst_description": "Disables link previews for links in this message\n",
|
||||||
|
"name": "disable_web_page_preview",
|
||||||
|
"deprecated": {
|
||||||
|
"version": "7.0",
|
||||||
|
"release_date": "2023-12-29"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"category": "methods"
|
"category": "methods"
|
||||||
|
|
|
||||||
|
|
@ -1,5 +0,0 @@
|
||||||
annotations:
|
|
||||||
parse_mode:
|
|
||||||
value: UNSET_PARSE_MODE
|
|
||||||
disable_web_page_preview:
|
|
||||||
value: UNSET_DISABLE_WEB_PAGE_PREVIEW
|
|
||||||
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"
|
||||||
|
}
|
||||||
|
}
|
||||||
1
.butcher/methods/forwardMessage/default.yml
Normal file
1
.butcher/methods/forwardMessage/default.yml
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
protect_content: protect_content
|
||||||
44
.butcher/methods/forwardMessage/entity.json
generated
44
.butcher/methods/forwardMessage/entity.json
generated
|
|
@ -7,9 +7,9 @@
|
||||||
"object": {
|
"object": {
|
||||||
"anchor": "forwardmessage",
|
"anchor": "forwardmessage",
|
||||||
"name": "forwardMessage",
|
"name": "forwardMessage",
|
||||||
"description": "Use this method to forward messages of any kind. Service messages can't be forwarded. On success, the sent Message is returned.",
|
"description": "Use this method to forward messages of any kind. Service messages and messages with protected content can't be forwarded. On success, the sent Message is returned.",
|
||||||
"html_description": "<p>Use this method to forward messages of any kind. Service messages can't be forwarded. On success, the sent <a href=\"#message\">Message</a> is returned.</p>",
|
"html_description": "<p>Use this method to forward messages of any kind. Service messages and messages with protected content can't be forwarded. On success, the sent <a href=\"#message\">Message</a> is returned.</p>",
|
||||||
"rst_description": "Use this method to forward messages of any kind. Service messages can't be forwarded. On success, the sent :class:`aiogram.types.message.Message` is returned.",
|
"rst_description": "Use this method to forward messages of any kind. Service messages and messages with protected content can't be forwarded. On success, the sent :class:`aiogram.types.message.Message` is returned.",
|
||||||
"annotations": [
|
"annotations": [
|
||||||
{
|
{
|
||||||
"type": "Integer or String",
|
"type": "Integer or String",
|
||||||
|
|
@ -22,11 +22,19 @@
|
||||||
{
|
{
|
||||||
"type": "Integer",
|
"type": "Integer",
|
||||||
"required": false,
|
"required": false,
|
||||||
"description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
|
"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 the forum; for forum supergroups only</td>",
|
"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 the forum; for forum supergroups only\n",
|
"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"
|
"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",
|
"type": "Integer or String",
|
||||||
"required": true,
|
"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",
|
"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"
|
"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",
|
"type": "Boolean",
|
||||||
"required": false,
|
"required": false,
|
||||||
|
|
@ -51,6 +67,22 @@
|
||||||
"rst_description": "Protects the contents of the forwarded message from forwarding and saving\n",
|
"rst_description": "Protects the contents of the forwarded message from forwarding and saving\n",
|
||||||
"name": "protect_content"
|
"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",
|
"type": "Integer",
|
||||||
"required": true,
|
"required": true,
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,11 @@
|
||||||
annotations:
|
annotations:
|
||||||
protect_content:
|
video_start_timestamp:
|
||||||
value: UNSET_PROTECT_CONTENT
|
parsed_type:
|
||||||
|
type: union
|
||||||
|
items:
|
||||||
|
- type: std
|
||||||
|
name: datetime.datetime
|
||||||
|
- type: std
|
||||||
|
name: datetime.timedelta
|
||||||
|
- type: std
|
||||||
|
name: int
|
||||||
|
|
|
||||||
73
.butcher/methods/forwardMessages/entity.json
generated
Normal file
73
.butcher/methods/forwardMessages/entity.json
generated
Normal file
|
|
@ -0,0 +1,73 @@
|
||||||
|
{
|
||||||
|
"meta": {},
|
||||||
|
"group": {
|
||||||
|
"title": "Available methods",
|
||||||
|
"anchor": "available-methods"
|
||||||
|
},
|
||||||
|
"object": {
|
||||||
|
"anchor": "forwardmessages",
|
||||||
|
"name": "forwardMessages",
|
||||||
|
"description": "Use this method to forward multiple messages of any kind. If some of the specified messages can't be found or forwarded, they are skipped. Service messages and messages with protected content can't be forwarded. Album grouping is kept for forwarded messages. On success, an array of MessageId of the sent messages is returned.",
|
||||||
|
"html_description": "<p>Use this method to forward multiple messages of any kind. If some of the specified messages can't be found or forwarded, they are skipped. Service messages and messages with protected content can't be forwarded. Album grouping is kept for forwarded messages. On success, an array of <a href=\"#messageid\">MessageId</a> of the sent messages is returned.</p>",
|
||||||
|
"rst_description": "Use this method to forward multiple messages of any kind. If some of the specified messages can't be found or forwarded, they are skipped. Service messages and messages with protected content can't be forwarded. Album grouping is kept for forwarded messages. On success, an array of :class:`aiogram.types.message_id.MessageId` of the sent messages is returned.",
|
||||||
|
"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": "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 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,
|
||||||
|
"description": "Unique identifier for the chat where the original messages were sent (or channel username in the format @channelusername)",
|
||||||
|
"html_description": "<td>Unique identifier for the chat where the original messages were sent (or channel username in the format <code>@channelusername</code>)</td>",
|
||||||
|
"rst_description": "Unique identifier for the chat where the original messages were sent (or channel username in the format :code:`@channelusername`)\n",
|
||||||
|
"name": "from_chat_id"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "Array of Integer",
|
||||||
|
"required": true,
|
||||||
|
"description": "A JSON-serialized list of 1-100 identifiers of messages in the chat from_chat_id to forward. The identifiers must be specified in a strictly increasing order.",
|
||||||
|
"html_description": "<td>A JSON-serialized list of 1-100 identifiers of messages in the chat <em>from_chat_id</em> to forward. The identifiers must be specified in a strictly increasing order.</td>",
|
||||||
|
"rst_description": "A JSON-serialized list of 1-100 identifiers of messages in the chat *from_chat_id* to forward. The identifiers must be specified in a strictly increasing order.\n",
|
||||||
|
"name": "message_ids"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "Boolean",
|
||||||
|
"required": false,
|
||||||
|
"description": "Sends the messages silently. Users will receive a notification with no sound.",
|
||||||
|
"html_description": "<td>Sends the messages <a href=\"https://telegram.org/blog/channels-2-0#silent-messages\">silently</a>. Users will receive a notification with no sound.</td>",
|
||||||
|
"rst_description": "Sends the messages `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound.\n",
|
||||||
|
"name": "disable_notification"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "Boolean",
|
||||||
|
"required": false,
|
||||||
|
"description": "Protects the contents of the forwarded messages from forwarding and saving",
|
||||||
|
"html_description": "<td>Protects the contents of the forwarded messages from forwarding and saving</td>",
|
||||||
|
"rst_description": "Protects the contents of the forwarded messages from forwarding and saving\n",
|
||||||
|
"name": "protect_content"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"category": "methods"
|
||||||
|
}
|
||||||
|
}
|
||||||
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"
|
||||||
|
}
|
||||||
|
}
|
||||||
25
.butcher/methods/getBusinessConnection/entity.json
generated
Normal file
25
.butcher/methods/getBusinessConnection/entity.json
generated
Normal file
|
|
@ -0,0 +1,25 @@
|
||||||
|
{
|
||||||
|
"meta": {},
|
||||||
|
"group": {
|
||||||
|
"title": "Available methods",
|
||||||
|
"anchor": "available-methods"
|
||||||
|
},
|
||||||
|
"object": {
|
||||||
|
"anchor": "getbusinessconnection",
|
||||||
|
"name": "getBusinessConnection",
|
||||||
|
"description": "Use this method to get information about the connection of the bot with a business account. Returns a BusinessConnection object on success.",
|
||||||
|
"html_description": "<p>Use this method to get information about the connection of the bot with a business account. Returns a <a href=\"#businessconnection\">BusinessConnection</a> object on success.</p>",
|
||||||
|
"rst_description": "Use this method to get information about the connection of the bot with a business account. Returns a :class:`aiogram.types.business_connection.BusinessConnection` object 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"
|
||||||
|
}
|
||||||
|
}
|
||||||
6
.butcher/methods/getChat/entity.json
generated
6
.butcher/methods/getChat/entity.json
generated
|
|
@ -7,9 +7,9 @@
|
||||||
"object": {
|
"object": {
|
||||||
"anchor": "getchat",
|
"anchor": "getchat",
|
||||||
"name": "getChat",
|
"name": "getChat",
|
||||||
"description": "Use this method to get up to date information about the chat (current name of the user for one-on-one conversations, current username of a user, group or channel, etc.). Returns a Chat object on success.",
|
"description": "Use this method to get up-to-date information about the chat. Returns a ChatFullInfo object on success.",
|
||||||
"html_description": "<p>Use this method to get up to date information about the chat (current name of the user for one-on-one conversations, current username of a user, group or channel, etc.). Returns a <a href=\"#chat\">Chat</a> object on success.</p>",
|
"html_description": "<p>Use this method to get up-to-date information about the chat. Returns a <a href=\"#chatfullinfo\">ChatFullInfo</a> object on success.</p>",
|
||||||
"rst_description": "Use this method to get up to date information about the chat (current name of the user for one-on-one conversations, current username of a user, group or channel, etc.). Returns a :class:`aiogram.types.chat.Chat` object on success.",
|
"rst_description": "Use this method to get up-to-date information about the chat. Returns a :class:`aiogram.types.chat_full_info.ChatFullInfo` object on success.",
|
||||||
"annotations": [
|
"annotations": [
|
||||||
{
|
{
|
||||||
"type": "Integer or String",
|
"type": "Integer or String",
|
||||||
|
|
|
||||||
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"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -14,9 +14,9 @@
|
||||||
{
|
{
|
||||||
"type": "Array of String",
|
"type": "Array of String",
|
||||||
"required": true,
|
"required": true,
|
||||||
"description": "List of custom emoji identifiers. At most 200 custom emoji identifiers can be specified.",
|
"description": "A JSON-serialized list of custom emoji identifiers. At most 200 custom emoji identifiers can be specified.",
|
||||||
"html_description": "<td>List of custom emoji identifiers. At most 200 custom emoji identifiers can be specified.</td>",
|
"html_description": "<td>A JSON-serialized list of custom emoji identifiers. At most 200 custom emoji identifiers can be specified.</td>",
|
||||||
"rst_description": "List of custom emoji identifiers. At most 200 custom emoji identifiers can be specified.\n",
|
"rst_description": "A JSON-serialized list of custom emoji identifiers. At most 200 custom emoji identifiers can be specified.\n",
|
||||||
"name": "custom_emoji_ids"
|
"name": "custom_emoji_ids"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
|
|
|
||||||
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"
|
||||||
|
}
|
||||||
|
}
|
||||||
33
.butcher/methods/getStarTransactions/entity.json
generated
Normal file
33
.butcher/methods/getStarTransactions/entity.json
generated
Normal file
|
|
@ -0,0 +1,33 @@
|
||||||
|
{
|
||||||
|
"meta": {},
|
||||||
|
"group": {
|
||||||
|
"title": "Payments",
|
||||||
|
"anchor": "payments"
|
||||||
|
},
|
||||||
|
"object": {
|
||||||
|
"anchor": "getstartransactions",
|
||||||
|
"name": "getStarTransactions",
|
||||||
|
"description": "Returns the bot's Telegram Star transactions in chronological order. On success, returns a StarTransactions object.",
|
||||||
|
"html_description": "<p>Returns the bot's Telegram Star transactions in chronological order. On success, returns a <a href=\"#startransactions\">StarTransactions</a> object.</p>",
|
||||||
|
"rst_description": "Returns the bot's Telegram Star transactions in chronological order. On success, returns a :class:`aiogram.types.star_transactions.StarTransactions` object.",
|
||||||
|
"annotations": [
|
||||||
|
{
|
||||||
|
"type": "Integer",
|
||||||
|
"required": false,
|
||||||
|
"description": "Number of transactions to skip in the response",
|
||||||
|
"html_description": "<td>Number of transactions to skip in the response</td>",
|
||||||
|
"rst_description": "Number of transactions to skip in the response\n",
|
||||||
|
"name": "offset"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "Integer",
|
||||||
|
"required": false,
|
||||||
|
"description": "The maximum number of transactions to be retrieved. Values between 1-100 are accepted. Defaults to 100.",
|
||||||
|
"html_description": "<td>The maximum number of transactions to be retrieved. Values between 1-100 are accepted. Defaults to 100.</td>",
|
||||||
|
"rst_description": "The maximum number of transactions to be retrieved. Values between 1-100 are accepted. Defaults to 100.\n",
|
||||||
|
"name": "limit"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"category": "methods"
|
||||||
|
}
|
||||||
|
}
|
||||||
6
.butcher/methods/getUpdates/entity.json
generated
6
.butcher/methods/getUpdates/entity.json
generated
|
|
@ -38,9 +38,9 @@
|
||||||
{
|
{
|
||||||
"type": "Array of String",
|
"type": "Array of String",
|
||||||
"required": false,
|
"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 (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.",
|
"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 [“message”, “edited_channel_post”, “callback_query”] 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> (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>",
|
"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 ['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* (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",
|
"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"
|
"name": "allowed_updates"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
|
|
|
||||||
33
.butcher/methods/getUserChatBoosts/entity.json
generated
Normal file
33
.butcher/methods/getUserChatBoosts/entity.json
generated
Normal file
|
|
@ -0,0 +1,33 @@
|
||||||
|
{
|
||||||
|
"meta": {},
|
||||||
|
"group": {
|
||||||
|
"title": "Available methods",
|
||||||
|
"anchor": "available-methods"
|
||||||
|
},
|
||||||
|
"object": {
|
||||||
|
"anchor": "getuserchatboosts",
|
||||||
|
"name": "getUserChatBoosts",
|
||||||
|
"description": "Use this method to get the list of boosts added to a chat by a user. Requires administrator rights in the chat. Returns a UserChatBoosts object.",
|
||||||
|
"html_description": "<p>Use this method to get the list of boosts added to a chat by a user. Requires administrator rights in the chat. Returns a <a href=\"#userchatboosts\">UserChatBoosts</a> object.</p>",
|
||||||
|
"rst_description": "Use this method to get the list of boosts added to a chat by a user. Requires administrator rights in the chat. Returns a :class:`aiogram.types.user_chat_boosts.UserChatBoosts` object.",
|
||||||
|
"annotations": [
|
||||||
|
{
|
||||||
|
"type": "Integer or String",
|
||||||
|
"required": true,
|
||||||
|
"description": "Unique identifier for the chat or username of the channel (in the format @channelusername)",
|
||||||
|
"html_description": "<td>Unique identifier for the chat or username of the channel (in the format <code>@channelusername</code>)</td>",
|
||||||
|
"rst_description": "Unique identifier for the chat or username of the channel (in the format :code:`@channelusername`)\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"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"category": "methods"
|
||||||
|
}
|
||||||
|
}
|
||||||
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",
|
"type": "Integer or String",
|
||||||
"required": true,
|
"required": true,
|
||||||
"description": "Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername)",
|
"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>)</td>",
|
"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`)\n",
|
"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"
|
"name": "chat_id"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
|
|
|
||||||
14
.butcher/methods/pinChatMessage/entity.json
generated
14
.butcher/methods/pinChatMessage/entity.json
generated
|
|
@ -7,10 +7,18 @@
|
||||||
"object": {
|
"object": {
|
||||||
"anchor": "pinchatmessage",
|
"anchor": "pinchatmessage",
|
||||||
"name": "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.",
|
"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. 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>",
|
"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. 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.",
|
"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": [
|
"annotations": [
|
||||||
|
{
|
||||||
|
"type": "String",
|
||||||
|
"required": false,
|
||||||
|
"description": "Unique identifier of the business connection on behalf of which the message will be pinned",
|
||||||
|
"html_description": "<td>Unique identifier of the business connection on behalf of which the message will be pinned</td>",
|
||||||
|
"rst_description": "Unique identifier of the business connection on behalf of which the message will be pinned\n",
|
||||||
|
"name": "business_connection_id"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"type": "Integer or String",
|
"type": "Integer or String",
|
||||||
"required": true,
|
"required": true,
|
||||||
|
|
|
||||||
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"
|
||||||
|
}
|
||||||
|
}
|
||||||
96
.butcher/methods/promoteChatMember/entity.json
generated
96
.butcher/methods/promoteChatMember/entity.json
generated
|
|
@ -38,27 +38,11 @@
|
||||||
{
|
{
|
||||||
"type": "Boolean",
|
"type": "Boolean",
|
||||||
"required": false,
|
"required": false,
|
||||||
"description": "Pass True if the administrator can access the chat event log, chat statistics, message statistics in channels, see channel members, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege",
|
"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, chat statistics, message statistics in channels, see channel members, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege</td>",
|
"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, chat statistics, message statistics in channels, see channel members, see anonymous administrators in supergroups and ignore slow mode. Implied by any other administrator privilege\n",
|
"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"
|
"name": "can_manage_chat"
|
||||||
},
|
},
|
||||||
{
|
|
||||||
"type": "Boolean",
|
|
||||||
"required": false,
|
|
||||||
"description": "Pass True if the administrator can create channel posts, channels only",
|
|
||||||
"html_description": "<td>Pass <em>True</em> if the administrator can create channel posts, channels only</td>",
|
|
||||||
"rst_description": "Pass :code:`True` if the administrator can create channel posts, channels only\n",
|
|
||||||
"name": "can_post_messages"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"type": "Boolean",
|
|
||||||
"required": false,
|
|
||||||
"description": "Pass True if the administrator can edit messages of other users and can pin messages, channels only",
|
|
||||||
"html_description": "<td>Pass <em>True</em> if the administrator can edit messages of other users and can pin messages, channels only</td>",
|
|
||||||
"rst_description": "Pass :code:`True` if the administrator can edit messages of other users and can pin messages, channels only\n",
|
|
||||||
"name": "can_edit_messages"
|
|
||||||
},
|
|
||||||
{
|
{
|
||||||
"type": "Boolean",
|
"type": "Boolean",
|
||||||
"required": false,
|
"required": false,
|
||||||
|
|
@ -78,9 +62,9 @@
|
||||||
{
|
{
|
||||||
"type": "Boolean",
|
"type": "Boolean",
|
||||||
"required": false,
|
"required": false,
|
||||||
"description": "Pass True if the administrator can restrict, ban or unban chat members",
|
"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</td>",
|
"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\n",
|
"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"
|
"name": "can_restrict_members"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|
@ -110,18 +94,74 @@
|
||||||
{
|
{
|
||||||
"type": "Boolean",
|
"type": "Boolean",
|
||||||
"required": false,
|
"required": false,
|
||||||
"description": "Pass True if the administrator can pin messages, supergroups only",
|
"description": "Pass True if the administrator can post stories to the chat",
|
||||||
"html_description": "<td>Pass <em>True</em> if the administrator can pin messages, supergroups only</td>",
|
"html_description": "<td>Pass <em>True</em> if the administrator can post stories to the chat</td>",
|
||||||
"rst_description": "Pass :code:`True` if the administrator can pin messages, supergroups only\n",
|
"rst_description": "Pass :code:`True` if the administrator can post stories to the chat\n",
|
||||||
|
"name": "can_post_stories"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "Boolean",
|
||||||
|
"required": false,
|
||||||
|
"description": "Pass True if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive",
|
||||||
|
"html_description": "<td>Pass <em>True</em> if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive</td>",
|
||||||
|
"rst_description": "Pass :code:`True` if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories, and access the chat's story archive\n",
|
||||||
|
"name": "can_edit_stories"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "Boolean",
|
||||||
|
"required": false,
|
||||||
|
"description": "Pass True if the administrator can delete stories posted by other users",
|
||||||
|
"html_description": "<td>Pass <em>True</em> if the administrator can delete stories posted by other users</td>",
|
||||||
|
"rst_description": "Pass :code:`True` if the administrator can delete stories posted by other users\n",
|
||||||
|
"name": "can_delete_stories"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "Boolean",
|
||||||
|
"required": false,
|
||||||
|
"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"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "Boolean",
|
||||||
|
"required": false,
|
||||||
|
"description": "Pass True if the administrator can edit messages of other users and can pin messages; for channels only",
|
||||||
|
"html_description": "<td>Pass <em>True</em> if the administrator can edit messages of other users and can pin messages; for channels only</td>",
|
||||||
|
"rst_description": "Pass :code:`True` if the administrator can edit messages of other users and can pin messages; for channels only\n",
|
||||||
|
"name": "can_edit_messages"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "Boolean",
|
||||||
|
"required": false,
|
||||||
|
"description": "Pass True if the administrator can pin messages; for supergroups only",
|
||||||
|
"html_description": "<td>Pass <em>True</em> if the administrator can pin messages; for supergroups only</td>",
|
||||||
|
"rst_description": "Pass :code:`True` if the administrator can pin messages; for supergroups only\n",
|
||||||
"name": "can_pin_messages"
|
"name": "can_pin_messages"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "Boolean",
|
"type": "Boolean",
|
||||||
"required": false,
|
"required": false,
|
||||||
"description": "Pass True if the user is allowed to create, rename, close, and reopen forum topics, supergroups only",
|
"description": "Pass True if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only",
|
||||||
"html_description": "<td>Pass <em>True</em> if the user is allowed to create, rename, close, and reopen forum topics, supergroups only</td>",
|
"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, supergroups only\n",
|
"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"
|
"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"
|
"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/refundStarPayment/entity.json
generated
Normal file
33
.butcher/methods/refundStarPayment/entity.json
generated
Normal file
|
|
@ -0,0 +1,33 @@
|
||||||
|
{
|
||||||
|
"meta": {},
|
||||||
|
"group": {
|
||||||
|
"title": "Payments",
|
||||||
|
"anchor": "payments"
|
||||||
|
},
|
||||||
|
"object": {
|
||||||
|
"anchor": "refundstarpayment",
|
||||||
|
"name": "refundStarPayment",
|
||||||
|
"description": "Refunds a successful payment in Telegram Stars. Returns True on success.",
|
||||||
|
"html_description": "<p>Refunds a successful payment in <a href=\"https://t.me/BotNews/90\">Telegram Stars</a>. Returns <em>True</em> on success.</p>",
|
||||||
|
"rst_description": "Refunds a successful payment in `Telegram Stars <https://t.me/BotNews/90>`_. Returns :code:`True` on success.",
|
||||||
|
"annotations": [
|
||||||
|
{
|
||||||
|
"type": "Integer",
|
||||||
|
"required": true,
|
||||||
|
"description": "Identifier of the user whose payment will be refunded",
|
||||||
|
"html_description": "<td>Identifier of the user whose payment will be refunded</td>",
|
||||||
|
"rst_description": "Identifier of the user whose payment will be refunded\n",
|
||||||
|
"name": "user_id"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "String",
|
||||||
|
"required": true,
|
||||||
|
"description": "Telegram payment identifier",
|
||||||
|
"html_description": "<td>Telegram payment identifier</td>",
|
||||||
|
"rst_description": "Telegram payment identifier\n",
|
||||||
|
"name": "telegram_payment_charge_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"
|
||||||
|
}
|
||||||
|
}
|
||||||
49
.butcher/methods/replaceStickerInSet/entity.json
generated
Normal file
49
.butcher/methods/replaceStickerInSet/entity.json
generated
Normal file
|
|
@ -0,0 +1,49 @@
|
||||||
|
{
|
||||||
|
"meta": {},
|
||||||
|
"group": {
|
||||||
|
"title": "Stickers",
|
||||||
|
"anchor": "stickers"
|
||||||
|
},
|
||||||
|
"object": {
|
||||||
|
"anchor": "replacestickerinset",
|
||||||
|
"name": "replaceStickerInSet",
|
||||||
|
"description": "Use this method to replace an existing sticker in a sticker set with a new one. The method is equivalent to calling deleteStickerFromSet, then addStickerToSet, then setStickerPositionInSet. Returns True on success.",
|
||||||
|
"html_description": "<p>Use this method to replace an existing sticker in a sticker set with a new one. The method is equivalent to calling <a href=\"#deletestickerfromset\">deleteStickerFromSet</a>, then <a href=\"#addstickertoset\">addStickerToSet</a>, then <a href=\"#setstickerpositioninset\">setStickerPositionInSet</a>. Returns <em>True</em> on success.</p>",
|
||||||
|
"rst_description": "Use this method to replace an existing sticker in a sticker set with a new one. The method is equivalent to calling :class:`aiogram.methods.delete_sticker_from_set.DeleteStickerFromSet`, then :class:`aiogram.methods.add_sticker_to_set.AddStickerToSet`, then :class:`aiogram.methods.set_sticker_position_in_set.SetStickerPositionInSet`. Returns :code:`True` on success.",
|
||||||
|
"annotations": [
|
||||||
|
{
|
||||||
|
"type": "Integer",
|
||||||
|
"required": true,
|
||||||
|
"description": "User identifier of the sticker set owner",
|
||||||
|
"html_description": "<td>User identifier of the sticker set owner</td>",
|
||||||
|
"rst_description": "User identifier of the sticker set owner\n",
|
||||||
|
"name": "user_id"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "String",
|
||||||
|
"required": true,
|
||||||
|
"description": "Sticker set name",
|
||||||
|
"html_description": "<td>Sticker set name</td>",
|
||||||
|
"rst_description": "Sticker set name\n",
|
||||||
|
"name": "name"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "String",
|
||||||
|
"required": true,
|
||||||
|
"description": "File identifier of the replaced sticker",
|
||||||
|
"html_description": "<td>File identifier of the replaced sticker</td>",
|
||||||
|
"rst_description": "File identifier of the replaced sticker\n",
|
||||||
|
"name": "old_sticker"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "InputSticker",
|
||||||
|
"required": true,
|
||||||
|
"description": "A JSON-serialized object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set remains unchanged.",
|
||||||
|
"html_description": "<td>A JSON-serialized object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set remains unchanged.</td>",
|
||||||
|
"rst_description": "A JSON-serialized object with information about the added sticker. If exactly the same sticker had already been added to the set, then the set remains unchanged.\n",
|
||||||
|
"name": "sticker"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"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"
|
||||||
|
}
|
||||||
|
}
|
||||||
6
.butcher/methods/restrictChatMember/entity.json
generated
6
.butcher/methods/restrictChatMember/entity.json
generated
|
|
@ -46,9 +46,9 @@
|
||||||
{
|
{
|
||||||
"type": "Integer",
|
"type": "Integer",
|
||||||
"required": false,
|
"required": false,
|
||||||
"description": "Date when restrictions will be lifted for the user, unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever",
|
"description": "Date when restrictions will be lifted for the user; Unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever",
|
||||||
"html_description": "<td>Date when restrictions will be lifted for the user, unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever</td>",
|
"html_description": "<td>Date when restrictions will be lifted for the user; Unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever</td>",
|
||||||
"rst_description": "Date when restrictions will be lifted for the user, unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever\n",
|
"rst_description": "Date when restrictions will be lifted for the user; Unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever\n",
|
||||||
"name": "until_date"
|
"name": "until_date"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
|
|
|
||||||
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"
|
||||||
|
}
|
||||||
|
}
|
||||||
3
.butcher/methods/sendAnimation/default.yml
Normal file
3
.butcher/methods/sendAnimation/default.yml
Normal file
|
|
@ -0,0 +1,3 @@
|
||||||
|
parse_mode: parse_mode
|
||||||
|
protect_content: protect_content
|
||||||
|
show_caption_above_media: show_caption_above_media
|
||||||
92
.butcher/methods/sendAnimation/entity.json
generated
92
.butcher/methods/sendAnimation/entity.json
generated
|
|
@ -11,6 +11,14 @@
|
||||||
"html_description": "<p>Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent <a href=\"#message\">Message</a> is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future.</p>",
|
"html_description": "<p>Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent <a href=\"#message\">Message</a> is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future.</p>",
|
||||||
"rst_description": "Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent :class:`aiogram.types.message.Message` is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future.",
|
"rst_description": "Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On success, the sent :class:`aiogram.types.message.Message` is returned. Bots can currently send animation files of up to 50 MB in size, this limit may be changed in the future.",
|
||||||
"annotations": [
|
"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",
|
"type": "Integer or String",
|
||||||
"required": true,
|
"required": true,
|
||||||
|
|
@ -22,11 +30,19 @@
|
||||||
{
|
{
|
||||||
"type": "Integer",
|
"type": "Integer",
|
||||||
"required": false,
|
"required": false,
|
||||||
"description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
|
"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 the forum; for forum supergroups only</td>",
|
"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 the forum; for forum supergroups only\n",
|
"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"
|
"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",
|
"type": "InputFile or String",
|
||||||
"required": true,
|
"required": true,
|
||||||
|
|
@ -91,6 +107,14 @@
|
||||||
"rst_description": "A JSON-serialized list of special entities that appear in the caption, which can be specified instead of *parse_mode*\n",
|
"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"
|
"name": "caption_entities"
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"type": "Boolean",
|
||||||
|
"required": false,
|
||||||
|
"description": "Pass True, if the caption must be shown above the message media",
|
||||||
|
"html_description": "<td>Pass <em>True</em>, if the caption must be shown above the message media</td>",
|
||||||
|
"rst_description": "Pass :code:`True`, if the caption must be shown above the message media\n",
|
||||||
|
"name": "show_caption_above_media"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"type": "Boolean",
|
"type": "Boolean",
|
||||||
"required": false,
|
"required": false,
|
||||||
|
|
@ -116,12 +140,44 @@
|
||||||
"name": "protect_content"
|
"name": "protect_content"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "Integer",
|
"type": "Boolean",
|
||||||
"required": false,
|
"required": false,
|
||||||
"description": "If the message is a reply, ID of the original message",
|
"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>If the message is a reply, ID of the original message</td>",
|
"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": "If the message is a reply, ID of the original message\n",
|
"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": "reply_to_message_id"
|
"name": "allow_paid_broadcast"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "String",
|
||||||
|
"required": false,
|
||||||
|
"description": "Unique identifier of the message effect to be added to the message; for private chats only",
|
||||||
|
"html_description": "<td>Unique identifier of the message effect to be added to the message; for private chats only</td>",
|
||||||
|
"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,
|
||||||
|
"description": "Description of the message to reply to",
|
||||||
|
"html_description": "<td>Description of the message to reply to</td>",
|
||||||
|
"rst_description": "Description of the message to reply to\n",
|
||||||
|
"name": "reply_parameters"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply",
|
||||||
|
"required": false,
|
||||||
|
"description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user",
|
||||||
|
"html_description": "<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user</td>",
|
||||||
|
"rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user\n",
|
||||||
|
"name": "reply_markup"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "Boolean",
|
"type": "Boolean",
|
||||||
|
|
@ -129,15 +185,23 @@
|
||||||
"description": "Pass True if the message should be sent even if the specified replied-to message is not found",
|
"description": "Pass True if the message should be sent even if the specified replied-to message is not found",
|
||||||
"html_description": "<td>Pass <em>True</em> if the message should be sent even if the specified replied-to message is not found</td>",
|
"html_description": "<td>Pass <em>True</em> if the message should be sent even if the specified replied-to message is not found</td>",
|
||||||
"rst_description": "Pass :code:`True` if the message should be sent even if the specified replied-to message is not found\n",
|
"rst_description": "Pass :code:`True` if the message should be sent even if the specified replied-to message is not found\n",
|
||||||
"name": "allow_sending_without_reply"
|
"name": "allow_sending_without_reply",
|
||||||
|
"deprecated": {
|
||||||
|
"version": "7.0",
|
||||||
|
"release_date": "2023-12-29"
|
||||||
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply",
|
"type": "Integer",
|
||||||
"required": false,
|
"required": false,
|
||||||
"description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.",
|
"description": "If the message is a reply, ID of the original message",
|
||||||
"html_description": "<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove reply keyboard or to force a reply from the user.</td>",
|
"html_description": "<td>If the message is a reply, ID of the original message</td>",
|
||||||
"rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove reply keyboard or to force a reply from the user.\n",
|
"rst_description": "If the message is a reply, ID of the original message\n",
|
||||||
"name": "reply_markup"
|
"name": "reply_to_message_id",
|
||||||
|
"deprecated": {
|
||||||
|
"version": "7.0",
|
||||||
|
"release_date": "2023-12-29"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"category": "methods"
|
"category": "methods"
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,7 @@
|
||||||
annotations:
|
annotations:
|
||||||
parse_mode:
|
thumbnail:
|
||||||
value: UNSET_PARSE_MODE
|
parsed_type:
|
||||||
protect_content:
|
type: entity
|
||||||
value: UNSET_PROTECT_CONTENT
|
references:
|
||||||
|
category: types
|
||||||
|
name: InputFile
|
||||||
|
|
|
||||||
2
.butcher/methods/sendAudio/default.yml
Normal file
2
.butcher/methods/sendAudio/default.yml
Normal file
|
|
@ -0,0 +1,2 @@
|
||||||
|
parse_mode: parse_mode
|
||||||
|
protect_content: protect_content
|
||||||
84
.butcher/methods/sendAudio/entity.json
generated
84
.butcher/methods/sendAudio/entity.json
generated
|
|
@ -11,6 +11,14 @@
|
||||||
"html_description": "<p>Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .MP3 or .M4A format. On success, the sent <a href=\"#message\">Message</a> is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future.</p><p>For sending voice messages, use the <a href=\"#sendvoice\">sendVoice</a> method instead.</p>",
|
"html_description": "<p>Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .MP3 or .M4A format. On success, the sent <a href=\"#message\">Message</a> is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future.</p><p>For sending voice messages, use the <a href=\"#sendvoice\">sendVoice</a> method instead.</p>",
|
||||||
"rst_description": "Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .MP3 or .M4A format. On success, the sent :class:`aiogram.types.message.Message` is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future.\nFor sending voice messages, use the :class:`aiogram.methods.send_voice.SendVoice` method instead.",
|
"rst_description": "Use this method to send audio files, if you want Telegram clients to display them in the music player. Your audio must be in the .MP3 or .M4A format. On success, the sent :class:`aiogram.types.message.Message` is returned. Bots can currently send audio files of up to 50 MB in size, this limit may be changed in the future.\nFor sending voice messages, use the :class:`aiogram.methods.send_voice.SendVoice` method instead.",
|
||||||
"annotations": [
|
"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",
|
"type": "Integer or String",
|
||||||
"required": true,
|
"required": true,
|
||||||
|
|
@ -22,11 +30,19 @@
|
||||||
{
|
{
|
||||||
"type": "Integer",
|
"type": "Integer",
|
||||||
"required": false,
|
"required": false,
|
||||||
"description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
|
"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 the forum; for forum supergroups only</td>",
|
"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 the forum; for forum supergroups only\n",
|
"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"
|
"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",
|
"type": "InputFile or String",
|
||||||
"required": true,
|
"required": true,
|
||||||
|
|
@ -108,12 +124,44 @@
|
||||||
"name": "protect_content"
|
"name": "protect_content"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "Integer",
|
"type": "Boolean",
|
||||||
"required": false,
|
"required": false,
|
||||||
"description": "If the message is a reply, ID of the original message",
|
"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>If the message is a reply, ID of the original message</td>",
|
"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": "If the message is a reply, ID of the original message\n",
|
"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": "reply_to_message_id"
|
"name": "allow_paid_broadcast"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "String",
|
||||||
|
"required": false,
|
||||||
|
"description": "Unique identifier of the message effect to be added to the message; for private chats only",
|
||||||
|
"html_description": "<td>Unique identifier of the message effect to be added to the message; for private chats only</td>",
|
||||||
|
"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,
|
||||||
|
"description": "Description of the message to reply to",
|
||||||
|
"html_description": "<td>Description of the message to reply to</td>",
|
||||||
|
"rst_description": "Description of the message to reply to\n",
|
||||||
|
"name": "reply_parameters"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply",
|
||||||
|
"required": false,
|
||||||
|
"description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user",
|
||||||
|
"html_description": "<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user</td>",
|
||||||
|
"rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user\n",
|
||||||
|
"name": "reply_markup"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "Boolean",
|
"type": "Boolean",
|
||||||
|
|
@ -121,15 +169,23 @@
|
||||||
"description": "Pass True if the message should be sent even if the specified replied-to message is not found",
|
"description": "Pass True if the message should be sent even if the specified replied-to message is not found",
|
||||||
"html_description": "<td>Pass <em>True</em> if the message should be sent even if the specified replied-to message is not found</td>",
|
"html_description": "<td>Pass <em>True</em> if the message should be sent even if the specified replied-to message is not found</td>",
|
||||||
"rst_description": "Pass :code:`True` if the message should be sent even if the specified replied-to message is not found\n",
|
"rst_description": "Pass :code:`True` if the message should be sent even if the specified replied-to message is not found\n",
|
||||||
"name": "allow_sending_without_reply"
|
"name": "allow_sending_without_reply",
|
||||||
|
"deprecated": {
|
||||||
|
"version": "7.0",
|
||||||
|
"release_date": "2023-12-29"
|
||||||
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply",
|
"type": "Integer",
|
||||||
"required": false,
|
"required": false,
|
||||||
"description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.",
|
"description": "If the message is a reply, ID of the original message",
|
||||||
"html_description": "<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove reply keyboard or to force a reply from the user.</td>",
|
"html_description": "<td>If the message is a reply, ID of the original message</td>",
|
||||||
"rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove reply keyboard or to force a reply from the user.\n",
|
"rst_description": "If the message is a reply, ID of the original message\n",
|
||||||
"name": "reply_markup"
|
"name": "reply_to_message_id",
|
||||||
|
"deprecated": {
|
||||||
|
"version": "7.0",
|
||||||
|
"release_date": "2023-12-29"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"category": "methods"
|
"category": "methods"
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,7 @@
|
||||||
annotations:
|
annotations:
|
||||||
parse_mode:
|
thumbnail:
|
||||||
value: UNSET_PARSE_MODE
|
parsed_type:
|
||||||
protect_content:
|
type: entity
|
||||||
value: UNSET_PROTECT_CONTENT
|
references:
|
||||||
|
category: types
|
||||||
|
name: InputFile
|
||||||
|
|
|
||||||
20
.butcher/methods/sendChatAction/entity.json
generated
20
.butcher/methods/sendChatAction/entity.json
generated
|
|
@ -11,20 +11,28 @@
|
||||||
"html_description": "<p>Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns <em>True</em> on success.</p><blockquote>\n<p>Example: The <a href=\"https://t.me/imagebot\">ImageBot</a> needs some time to process a request and upload the image. Instead of sending a text message along the lines of “Retrieving image, please wait…”, the bot may use <a href=\"#sendchataction\">sendChatAction</a> with <em>action</em> = <em>upload_photo</em>. The user will see a “sending photo” status for the bot.</p>\n</blockquote><p>We only recommend using this method when a response from the bot will take a <strong>noticeable</strong> amount of time to arrive.</p>",
|
"html_description": "<p>Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns <em>True</em> on success.</p><blockquote>\n<p>Example: The <a href=\"https://t.me/imagebot\">ImageBot</a> needs some time to process a request and upload the image. Instead of sending a text message along the lines of “Retrieving image, please wait…”, the bot may use <a href=\"#sendchataction\">sendChatAction</a> with <em>action</em> = <em>upload_photo</em>. The user will see a “sending photo” status for the bot.</p>\n</blockquote><p>We only recommend using this method when a response from the bot will take a <strong>noticeable</strong> amount of time to arrive.</p>",
|
||||||
"rst_description": "Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns :code:`True` on success.\n\n Example: The `ImageBot <https://t.me/imagebot>`_ needs some time to process a request and upload the image. Instead of sending a text message along the lines of 'Retrieving image, please wait…', the bot may use :class:`aiogram.methods.send_chat_action.SendChatAction` with *action* = *upload_photo*. The user will see a 'sending photo' status for the bot.\n\nWe only recommend using this method when a response from the bot will take a **noticeable** amount of time to arrive.",
|
"rst_description": "Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns :code:`True` on success.\n\n Example: The `ImageBot <https://t.me/imagebot>`_ needs some time to process a request and upload the image. Instead of sending a text message along the lines of 'Retrieving image, please wait…', the bot may use :class:`aiogram.methods.send_chat_action.SendChatAction` with *action* = *upload_photo*. The user will see a 'sending photo' status for the bot.\n\nWe only recommend using this method when a response from the bot will take a **noticeable** amount of time to arrive.",
|
||||||
"annotations": [
|
"annotations": [
|
||||||
|
{
|
||||||
|
"type": "String",
|
||||||
|
"required": false,
|
||||||
|
"description": "Unique identifier of the business connection on behalf of which the action will be sent",
|
||||||
|
"html_description": "<td>Unique identifier of the business connection on behalf of which the action will be sent</td>",
|
||||||
|
"rst_description": "Unique identifier of the business connection on behalf of which the action will be sent\n",
|
||||||
|
"name": "business_connection_id"
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"type": "Integer or String",
|
"type": "Integer or String",
|
||||||
"required": true,
|
"required": true,
|
||||||
"description": "Unique identifier for the target chat or username of the target channel (in the format @channelusername)",
|
"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 channel (in the format <code>@channelusername</code>)</td>",
|
"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 channel (in the format :code:`@channelusername`)\n",
|
"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"
|
"name": "chat_id"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "Integer",
|
"type": "Integer",
|
||||||
"required": false,
|
"required": false,
|
||||||
"description": "Unique identifier for the target message thread; supergroups only",
|
"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; supergroups only</td>",
|
"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; supergroups only\n",
|
"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"
|
"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"
|
||||||
|
}
|
||||||
|
}
|
||||||
1
.butcher/methods/sendContact/default.yml
Normal file
1
.butcher/methods/sendContact/default.yml
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
protect_content: protect_content
|
||||||
84
.butcher/methods/sendContact/entity.json
generated
84
.butcher/methods/sendContact/entity.json
generated
|
|
@ -11,6 +11,14 @@
|
||||||
"html_description": "<p>Use this method to send phone contacts. On success, the sent <a href=\"#message\">Message</a> is returned.</p>",
|
"html_description": "<p>Use this method to send phone contacts. On success, the sent <a href=\"#message\">Message</a> is returned.</p>",
|
||||||
"rst_description": "Use this method to send phone contacts. On success, the sent :class:`aiogram.types.message.Message` is returned.",
|
"rst_description": "Use this method to send phone contacts. On success, the sent :class:`aiogram.types.message.Message` is returned.",
|
||||||
"annotations": [
|
"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",
|
"type": "Integer or String",
|
||||||
"required": true,
|
"required": true,
|
||||||
|
|
@ -22,11 +30,19 @@
|
||||||
{
|
{
|
||||||
"type": "Integer",
|
"type": "Integer",
|
||||||
"required": false,
|
"required": false,
|
||||||
"description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only",
|
"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 the forum; for forum supergroups only</td>",
|
"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 the forum; for forum supergroups only\n",
|
"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"
|
"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",
|
"type": "String",
|
||||||
"required": true,
|
"required": true,
|
||||||
|
|
@ -76,12 +92,44 @@
|
||||||
"name": "protect_content"
|
"name": "protect_content"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "Integer",
|
"type": "Boolean",
|
||||||
"required": false,
|
"required": false,
|
||||||
"description": "If the message is a reply, ID of the original message",
|
"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>If the message is a reply, ID of the original message</td>",
|
"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": "If the message is a reply, ID of the original message\n",
|
"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": "reply_to_message_id"
|
"name": "allow_paid_broadcast"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "String",
|
||||||
|
"required": false,
|
||||||
|
"description": "Unique identifier of the message effect to be added to the message; for private chats only",
|
||||||
|
"html_description": "<td>Unique identifier of the message effect to be added to the message; for private chats only</td>",
|
||||||
|
"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,
|
||||||
|
"description": "Description of the message to reply to",
|
||||||
|
"html_description": "<td>Description of the message to reply to</td>",
|
||||||
|
"rst_description": "Description of the message to reply to\n",
|
||||||
|
"name": "reply_parameters"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"type": "InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply",
|
||||||
|
"required": false,
|
||||||
|
"description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user",
|
||||||
|
"html_description": "<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user</td>",
|
||||||
|
"rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user\n",
|
||||||
|
"name": "reply_markup"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "Boolean",
|
"type": "Boolean",
|
||||||
|
|
@ -89,15 +137,23 @@
|
||||||
"description": "Pass True if the message should be sent even if the specified replied-to message is not found",
|
"description": "Pass True if the message should be sent even if the specified replied-to message is not found",
|
||||||
"html_description": "<td>Pass <em>True</em> if the message should be sent even if the specified replied-to message is not found</td>",
|
"html_description": "<td>Pass <em>True</em> if the message should be sent even if the specified replied-to message is not found</td>",
|
||||||
"rst_description": "Pass :code:`True` if the message should be sent even if the specified replied-to message is not found\n",
|
"rst_description": "Pass :code:`True` if the message should be sent even if the specified replied-to message is not found\n",
|
||||||
"name": "allow_sending_without_reply"
|
"name": "allow_sending_without_reply",
|
||||||
|
"deprecated": {
|
||||||
|
"version": "7.0",
|
||||||
|
"release_date": "2023-12-29"
|
||||||
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply",
|
"type": "Integer",
|
||||||
"required": false,
|
"required": false,
|
||||||
"description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.",
|
"description": "If the message is a reply, ID of the original message",
|
||||||
"html_description": "<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove reply keyboard or to force a reply from the user.</td>",
|
"html_description": "<td>If the message is a reply, ID of the original message</td>",
|
||||||
"rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove reply keyboard or to force a reply from the user.\n",
|
"rst_description": "If the message is a reply, ID of the original message\n",
|
||||||
"name": "reply_markup"
|
"name": "reply_to_message_id",
|
||||||
|
"deprecated": {
|
||||||
|
"version": "7.0",
|
||||||
|
"release_date": "2023-12-29"
|
||||||
|
}
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"category": "methods"
|
"category": "methods"
|
||||||
|
|
|
||||||
|
|
@ -1,3 +0,0 @@
|
||||||
annotations:
|
|
||||||
protect_content:
|
|
||||||
value: UNSET_PROTECT_CONTENT
|
|
||||||
1
.butcher/methods/sendDice/default.yml
Normal file
1
.butcher/methods/sendDice/default.yml
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
protect_content: protect_content
|
||||||
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