mirror of
https://github.com/aiogram/aiogram.git
synced 2025-12-06 16:15:51 +00:00
Added full support for the Bot API 9.0 (#1671)
* Added full support for the Bot API 9.0 * Bump version
This commit is contained in:
Alex Root Junior
GitHub
parent
25e9127db9
commit
2c2bd61551
231 changed files with 9565 additions and 389 deletions
33
.butcher/methods/convertGiftToStars/entity.json
Normal file
33
.butcher/methods/convertGiftToStars/entity.json
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Updating messages",
|
||||
"anchor": "updating-messages"
|
||||
},
|
||||
"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"
|
||||
}
|
||||
}
|
||||
|
|
@ -38,9 +38,9 @@
|
|||
{
|
||||
"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-2500",
|
||||
"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-2500</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-2500\n",
|
||||
"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"
|
||||
}
|
||||
],
|
||||
|
|
|
|||
|
|
@ -70,9 +70,9 @@
|
|||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "The number of seconds the subscription will be active for before the next payment. The currency must be set to 'XTR' (Telegram Stars) if the parameter is used. Currently, it must always be 2592000 (30 days) if specified. Any number of subscriptions can be active for a given bot at the same time, including multiple concurrent subscriptions from the same user. Subscription price must no exceed 2500 Telegram Stars.",
|
||||
"html_description": "<td>The number of seconds the subscription will be active for before the next payment. The currency must be set to “XTR” (Telegram Stars) if the parameter is used. Currently, it must always be 2592000 (30 days) if specified. Any number of subscriptions can be active for a given bot at the same time, including multiple concurrent subscriptions from the same user. Subscription price must no exceed 2500 Telegram Stars.</td>",
|
||||
"rst_description": "The number of seconds the subscription will be active for before the next payment. The currency must be set to 'XTR' (Telegram Stars) if the parameter is used. Currently, it must always be 2592000 (30 days) if specified. Any number of subscriptions can be active for a given bot at the same time, including multiple concurrent subscriptions from the same user. Subscription price must no exceed 2500 Telegram Stars.\n",
|
||||
"description": "The number of seconds the subscription will be active for before the next payment. The currency must be set to 'XTR' (Telegram Stars) if the parameter is used. Currently, it must always be 2592000 (30 days) if specified. Any number of subscriptions can be active for a given bot at the same time, including multiple concurrent subscriptions from the same user. Subscription price must no exceed 10000 Telegram Stars.",
|
||||
"html_description": "<td>The number of seconds the subscription will be active for before the next payment. The currency must be set to “XTR” (Telegram Stars) if the parameter is used. Currently, it must always be 2592000 (30 days) if specified. Any number of subscriptions can be active for a given bot at the same time, including multiple concurrent subscriptions from the same user. Subscription price must no exceed 10000 Telegram Stars.</td>",
|
||||
"rst_description": "The number of seconds the subscription will be active for before the next payment. The currency must be set to 'XTR' (Telegram Stars) if the parameter is used. Currently, it must always be 2592000 (30 days) if specified. Any number of subscriptions can be active for a given bot at the same time, including multiple concurrent subscriptions from the same user. Subscription price must no exceed 10000 Telegram Stars.\n",
|
||||
"name": "subscription_period"
|
||||
},
|
||||
{
|
||||
|
|
|
|||
33
.butcher/methods/deleteBusinessMessages/entity.json
Normal file
33
.butcher/methods/deleteBusinessMessages/entity.json
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Updating messages",
|
||||
"anchor": "updating-messages"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "deletebusinessmessages",
|
||||
"name": "deleteBusinessMessages",
|
||||
"description": "Delete messages on behalf of a business account. Requires the can_delete_outgoing_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_outgoing_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_outgoing_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"
|
||||
}
|
||||
}
|
||||
33
.butcher/methods/deleteStory/entity.json
Normal file
33
.butcher/methods/deleteStory/entity.json
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Updating messages",
|
||||
"anchor": "updating-messages"
|
||||
},
|
||||
"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"
|
||||
}
|
||||
}
|
||||
73
.butcher/methods/editStory/entity.json
Normal file
73
.butcher/methods/editStory/entity.json
Normal file
|
|
@ -0,0 +1,73 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Updating messages",
|
||||
"anchor": "updating-messages"
|
||||
},
|
||||
"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"
|
||||
}
|
||||
}
|
||||
|
|
@ -1,8 +1,8 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Stickers",
|
||||
"anchor": "stickers"
|
||||
"title": "Updating messages",
|
||||
"anchor": "updating-messages"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "getavailablegifts",
|
||||
|
|
|
|||
89
.butcher/methods/getBusinessAccountGifts/entity.json
Normal file
89
.butcher/methods/getBusinessAccountGifts/entity.json
Normal file
|
|
@ -0,0 +1,89 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Updating messages",
|
||||
"anchor": "updating-messages"
|
||||
},
|
||||
"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 True to exclude gifts that aren't saved to the account's profile page</td>",
|
||||
"rst_description": "Pass 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 True to exclude gifts that are saved to the account's profile page</td>",
|
||||
"rst_description": "Pass 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 True to exclude gifts that can be purchased an unlimited number of times</td>",
|
||||
"rst_description": "Pass 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",
|
||||
"html_description": "<td>Pass True to exclude gifts that can be purchased a limited number of times</td>",
|
||||
"rst_description": "Pass True to exclude gifts that can be purchased a limited number of times\n",
|
||||
"name": "exclude_limited"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to exclude unique gifts",
|
||||
"html_description": "<td>Pass True to exclude unique gifts</td>",
|
||||
"rst_description": "Pass 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 True to sort results by gift price instead of send date. Sorting is applied before pagination.</td>",
|
||||
"rst_description": "Pass 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"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
25
.butcher/methods/getBusinessAccountStarBalance/entity.json
Normal file
25
.butcher/methods/getBusinessAccountStarBalance/entity.json
Normal file
|
|
@ -0,0 +1,25 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Updating messages",
|
||||
"anchor": "updating-messages"
|
||||
},
|
||||
"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"
|
||||
}
|
||||
}
|
||||
65
.butcher/methods/giftPremiumSubscription/entity.json
Normal file
65
.butcher/methods/giftPremiumSubscription/entity.json
Normal file
|
|
@ -0,0 +1,65 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Updating messages",
|
||||
"anchor": "updating-messages"
|
||||
},
|
||||
"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', and 'custom_emoji' 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”, and “custom_emoji” 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', and 'custom_emoji' 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', and 'custom_emoji' 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”, and “custom_emoji” 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', and 'custom_emoji' are ignored.\n",
|
||||
"name": "text_entities"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
89
.butcher/methods/postStory/entity.json
Normal file
89
.butcher/methods/postStory/entity.json
Normal file
|
|
@ -0,0 +1,89 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Updating messages",
|
||||
"anchor": "updating-messages"
|
||||
},
|
||||
"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"
|
||||
}
|
||||
}
|
||||
41
.butcher/methods/readBusinessMessage/entity.json
Normal file
41
.butcher/methods/readBusinessMessage/entity.json
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Updating messages",
|
||||
"anchor": "updating-messages"
|
||||
},
|
||||
"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"
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Updating messages",
|
||||
"anchor": "updating-messages"
|
||||
},
|
||||
"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 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.</td>",
|
||||
"rst_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.\n",
|
||||
"name": "is_public"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
|
|
@ -1,8 +1,8 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Stickers",
|
||||
"anchor": "stickers"
|
||||
"title": "Updating messages",
|
||||
"anchor": "updating-messages"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "removechatverification",
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Stickers",
|
||||
"anchor": "stickers"
|
||||
"title": "Updating messages",
|
||||
"anchor": "updating-messages"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "removeuserverification",
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Stickers",
|
||||
"anchor": "stickers"
|
||||
"title": "Updating messages",
|
||||
"anchor": "updating-messages"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "sendgift",
|
||||
|
|
@ -46,9 +46,9 @@
|
|||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
"description": "Text that will be shown along with the gift; 0-255 characters",
|
||||
"html_description": "<td>Text that will be shown along with the gift; 0-255 characters</td>",
|
||||
"rst_description": "Text that will be shown along with the gift; 0-255 characters\n",
|
||||
"description": "Text that will be shown along with the gift; 0-128 characters",
|
||||
"html_description": "<td>Text that will be shown along with the gift; 0-128 characters</td>",
|
||||
"rst_description": "Text that will be shown along with the gift; 0-128 characters\n",
|
||||
"name": "text"
|
||||
},
|
||||
{
|
||||
|
|
|
|||
|
|
@ -30,9 +30,9 @@
|
|||
{
|
||||
"type": "Integer",
|
||||
"required": true,
|
||||
"description": "The number of Telegram Stars that must be paid to buy access to the media; 1-2500",
|
||||
"html_description": "<td>The number of Telegram Stars that must be paid to buy access to the media; 1-2500</td>",
|
||||
"rst_description": "The number of Telegram Stars that must be paid to buy access to the media; 1-2500\n",
|
||||
"description": "The number of Telegram Stars that must be paid to buy access to the media; 1-10000",
|
||||
"html_description": "<td>The number of Telegram Stars that must be paid to buy access to the media; 1-10000</td>",
|
||||
"rst_description": "The number of Telegram Stars that must be paid to buy access to the media; 1-10000\n",
|
||||
"name": "star_count"
|
||||
},
|
||||
{
|
||||
|
|
|
|||
33
.butcher/methods/setBusinessAccountBio/entity.json
Normal file
33
.butcher/methods/setBusinessAccountBio/entity.json
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Updating messages",
|
||||
"anchor": "updating-messages"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "setbusinessaccountbio",
|
||||
"name": "setBusinessAccountBio",
|
||||
"description": "Changes the bio of a managed business account. Requires the can_change_bio business bot right. Returns True on success.",
|
||||
"html_description": "<p>Changes the bio of a managed business account. Requires the <em>can_change_bio</em> business bot right. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "Changes the bio of a managed business account. Requires the *can_change_bio* business bot right. Returns :code:`True` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the business connection",
|
||||
"html_description": "<td>Unique identifier of the business connection</td>",
|
||||
"rst_description": "Unique identifier of the business connection\n",
|
||||
"name": "business_connection_id"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
"description": "The new value of the bio for the business account; 0-140 characters",
|
||||
"html_description": "<td>The new value of the bio for the business account; 0-140 characters</td>",
|
||||
"rst_description": "The new value of the bio for the business account; 0-140 characters\n",
|
||||
"name": "bio"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
41
.butcher/methods/setBusinessAccountGiftSettings/entity.json
Normal file
41
.butcher/methods/setBusinessAccountGiftSettings/entity.json
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Updating messages",
|
||||
"anchor": "updating-messages"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "setbusinessaccountgiftsettings",
|
||||
"name": "setBusinessAccountGiftSettings",
|
||||
"description": "Changes the privacy settings pertaining to incoming gifts in a managed business account. Requires the can_change_gift_settings business bot right. Returns True on success.",
|
||||
"html_description": "<p>Changes the privacy settings pertaining to incoming gifts in a managed business account. Requires the <em>can_change_gift_settings</em> business bot right. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "Changes the privacy settings pertaining to incoming gifts in a managed business account. Requires the *can_change_gift_settings* business bot right. Returns :code:`True` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the business connection",
|
||||
"html_description": "<td>Unique identifier of the business connection</td>",
|
||||
"rst_description": "Unique identifier of the business connection\n",
|
||||
"name": "business_connection_id"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": true,
|
||||
"description": "Pass True, if a button for sending a gift to the user or by the business account must always be shown in the input field",
|
||||
"html_description": "<td>Pass True, if a button for sending a gift to the user or by the business account must always be shown in the input field</td>",
|
||||
"rst_description": "Pass True, if a button for sending a gift to the user or by the business account must always be shown in the input field\n",
|
||||
"name": "show_gift_button"
|
||||
},
|
||||
{
|
||||
"type": "AcceptedGiftTypes",
|
||||
"required": true,
|
||||
"description": "Types of gifts accepted by the business account",
|
||||
"html_description": "<td>Types of gifts accepted by the business account</td>",
|
||||
"rst_description": "Types of gifts accepted by the business account\n",
|
||||
"name": "accepted_gift_types"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
41
.butcher/methods/setBusinessAccountName/entity.json
Normal file
41
.butcher/methods/setBusinessAccountName/entity.json
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Updating messages",
|
||||
"anchor": "updating-messages"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "setbusinessaccountname",
|
||||
"name": "setBusinessAccountName",
|
||||
"description": "Changes the first and last name of a managed business account. Requires the can_change_name business bot right. Returns True on success.",
|
||||
"html_description": "<p>Changes the first and last name of a managed business account. Requires the <em>can_change_name</em> business bot right. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "Changes the first and last name of a managed business account. Requires the *can_change_name* business bot right. Returns :code:`True` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the business connection",
|
||||
"html_description": "<td>Unique identifier of the business connection</td>",
|
||||
"rst_description": "Unique identifier of the business connection\n",
|
||||
"name": "business_connection_id"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
"description": "The new value of the first name for the business account; 1-64 characters",
|
||||
"html_description": "<td>The new value of the first name for the business account; 1-64 characters</td>",
|
||||
"rst_description": "The new value of the first name for the business account; 1-64 characters\n",
|
||||
"name": "first_name"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
"description": "The new value of the last name for the business account; 0-64 characters",
|
||||
"html_description": "<td>The new value of the last name for the business account; 0-64 characters</td>",
|
||||
"rst_description": "The new value of the last name for the business account; 0-64 characters\n",
|
||||
"name": "last_name"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
41
.butcher/methods/setBusinessAccountProfilePhoto/entity.json
Normal file
41
.butcher/methods/setBusinessAccountProfilePhoto/entity.json
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Updating messages",
|
||||
"anchor": "updating-messages"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "setbusinessaccountprofilephoto",
|
||||
"name": "setBusinessAccountProfilePhoto",
|
||||
"description": "Changes the profile photo of a managed business account. Requires the can_edit_profile_photo business bot right. Returns True on success.",
|
||||
"html_description": "<p>Changes the profile photo of a managed business account. Requires the <em>can_edit_profile_photo</em> business bot right. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "Changes the profile photo of a managed business account. Requires the *can_edit_profile_photo* business bot right. Returns :code:`True` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the business connection",
|
||||
"html_description": "<td>Unique identifier of the business connection</td>",
|
||||
"rst_description": "Unique identifier of the business connection\n",
|
||||
"name": "business_connection_id"
|
||||
},
|
||||
{
|
||||
"type": "InputProfilePhoto",
|
||||
"required": true,
|
||||
"description": "The new profile photo to set",
|
||||
"html_description": "<td>The new profile photo to set</td>",
|
||||
"rst_description": "The new profile photo to set\n",
|
||||
"name": "photo"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to set the public photo, which will be visible even if the main photo is hidden by the business account's privacy settings. An account can have only one public photo.",
|
||||
"html_description": "<td>Pass True to set the public photo, which will be visible even if the main photo is hidden by the business account's privacy settings. An account can have only one public photo.</td>",
|
||||
"rst_description": "Pass True to set the public photo, which will be visible even if the main photo is hidden by the business account's privacy settings. An account can have only one public photo.\n",
|
||||
"name": "is_public"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
33
.butcher/methods/setBusinessAccountUsername/entity.json
Normal file
33
.butcher/methods/setBusinessAccountUsername/entity.json
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Updating messages",
|
||||
"anchor": "updating-messages"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "setbusinessaccountusername",
|
||||
"name": "setBusinessAccountUsername",
|
||||
"description": "Changes the username of a managed business account. Requires the can_change_username business bot right. Returns True on success.",
|
||||
"html_description": "<p>Changes the username of a managed business account. Requires the <em>can_change_username</em> business bot right. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "Changes the username of a managed business account. Requires the *can_change_username* business bot right. Returns :code:`True` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the business connection",
|
||||
"html_description": "<td>Unique identifier of the business connection</td>",
|
||||
"rst_description": "Unique identifier of the business connection\n",
|
||||
"name": "business_connection_id"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": false,
|
||||
"description": "The new value of the username for the business account; 0-32 characters",
|
||||
"html_description": "<td>The new value of the username for the business account; 0-32 characters</td>",
|
||||
"rst_description": "The new value of the username for the business account; 0-32 characters\n",
|
||||
"name": "username"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
33
.butcher/methods/transferBusinessAccountStars/entity.json
Normal file
33
.butcher/methods/transferBusinessAccountStars/entity.json
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Updating messages",
|
||||
"anchor": "updating-messages"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "transferbusinessaccountstars",
|
||||
"name": "transferBusinessAccountStars",
|
||||
"description": "Transfers Telegram Stars from the business account balance to the bot's balance. Requires the can_transfer_stars business bot right. Returns True on success.",
|
||||
"html_description": "<p>Transfers Telegram Stars from the business account balance to the bot's balance. Requires the <em>can_transfer_stars</em> business bot right. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "Transfers Telegram Stars from the business account balance to the bot's balance. Requires the *can_transfer_stars* business bot right. Returns :code:`True` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the business connection",
|
||||
"html_description": "<td>Unique identifier of the business connection</td>",
|
||||
"rst_description": "Unique identifier of the business connection\n",
|
||||
"name": "business_connection_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": true,
|
||||
"description": "Number of Telegram Stars to transfer; 1-10000",
|
||||
"html_description": "<td>Number of Telegram Stars to transfer; 1-10000</td>",
|
||||
"rst_description": "Number of Telegram Stars to transfer; 1-10000\n",
|
||||
"name": "star_count"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
49
.butcher/methods/transferGift/entity.json
Normal file
49
.butcher/methods/transferGift/entity.json
Normal file
|
|
@ -0,0 +1,49 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Updating messages",
|
||||
"anchor": "updating-messages"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "transfergift",
|
||||
"name": "transferGift",
|
||||
"description": "Transfers an owned unique gift to another user. Requires the can_transfer_and_upgrade_gifts business bot right. Requires can_transfer_stars business bot right if the transfer is paid. Returns True on success.",
|
||||
"html_description": "<p>Transfers an owned unique gift to another user. Requires the <em>can_transfer_and_upgrade_gifts</em> business bot right. Requires <em>can_transfer_stars</em> business bot right if the transfer is paid. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "Transfers an owned unique gift to another user. Requires the *can_transfer_and_upgrade_gifts* business bot right. Requires *can_transfer_stars* business bot right if the transfer is paid. Returns :code:`True` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the business connection",
|
||||
"html_description": "<td>Unique identifier of the business connection</td>",
|
||||
"rst_description": "Unique identifier of the business connection\n",
|
||||
"name": "business_connection_id"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the regular gift that should be transferred",
|
||||
"html_description": "<td>Unique identifier of the regular gift that should be transferred</td>",
|
||||
"rst_description": "Unique identifier of the regular gift that should be transferred\n",
|
||||
"name": "owned_gift_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the chat which will own the gift. The chat must be active in the last 24 hours.",
|
||||
"html_description": "<td>Unique identifier of the chat which will own the gift. The chat must be active in the last 24 hours.</td>",
|
||||
"rst_description": "Unique identifier of the chat which will own the gift. The chat must be active in the last 24 hours.\n",
|
||||
"name": "new_owner_chat_id"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "The amount of Telegram Stars that will be paid for the transfer from the business account balance. If positive, then the can_transfer_stars business bot right is required.",
|
||||
"html_description": "<td>The amount of Telegram Stars that will be paid for the transfer from the business account balance. If positive, then the <em>can_transfer_stars</em> business bot right is required.</td>",
|
||||
"rst_description": "The amount of Telegram Stars that will be paid for the transfer from the business account balance. If positive, then the *can_transfer_stars* business bot right is required.\n",
|
||||
"name": "star_count"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
49
.butcher/methods/upgradeGift/entity.json
Normal file
49
.butcher/methods/upgradeGift/entity.json
Normal file
|
|
@ -0,0 +1,49 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Updating messages",
|
||||
"anchor": "updating-messages"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "upgradegift",
|
||||
"name": "upgradeGift",
|
||||
"description": "Upgrades a given regular gift to a unique gift. Requires the can_transfer_and_upgrade_gifts business bot right. Additionally requires the can_transfer_stars business bot right if the upgrade is paid. Returns True on success.",
|
||||
"html_description": "<p>Upgrades a given regular gift to a unique gift. Requires the <em>can_transfer_and_upgrade_gifts</em> business bot right. Additionally requires the <em>can_transfer_stars</em> business bot right if the upgrade is paid. Returns <em>True</em> on success.</p>",
|
||||
"rst_description": "Upgrades a given regular gift to a unique gift. Requires the *can_transfer_and_upgrade_gifts* business bot right. Additionally requires the *can_transfer_stars* business bot right if the upgrade is paid. Returns :code:`True` on success.",
|
||||
"annotations": [
|
||||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the business connection",
|
||||
"html_description": "<td>Unique identifier of the business connection</td>",
|
||||
"rst_description": "Unique identifier of the business connection\n",
|
||||
"name": "business_connection_id"
|
||||
},
|
||||
{
|
||||
"type": "String",
|
||||
"required": true,
|
||||
"description": "Unique identifier of the regular gift that should be upgraded to a unique one",
|
||||
"html_description": "<td>Unique identifier of the regular gift that should be upgraded to a unique one</td>",
|
||||
"rst_description": "Unique identifier of the regular gift that should be upgraded to a unique one\n",
|
||||
"name": "owned_gift_id"
|
||||
},
|
||||
{
|
||||
"type": "Boolean",
|
||||
"required": false,
|
||||
"description": "Pass True to keep the original gift text, sender and receiver in the upgraded gift",
|
||||
"html_description": "<td>Pass True to keep the original gift text, sender and receiver in the upgraded gift</td>",
|
||||
"rst_description": "Pass True to keep the original gift text, sender and receiver in the upgraded gift\n",
|
||||
"name": "keep_original_details"
|
||||
},
|
||||
{
|
||||
"type": "Integer",
|
||||
"required": false,
|
||||
"description": "The amount of Telegram Stars that will be paid for the upgrade from the business account balance. If gift.prepaid_upgrade_star_count > 0, then pass 0, otherwise, the can_transfer_stars business bot right is required and gift.upgrade_star_count must be passed.",
|
||||
"html_description": "<td>The amount of Telegram Stars that will be paid for the upgrade from the business account balance. If <code>gift.prepaid_upgrade_star_count > 0</code>, then pass 0, otherwise, the <em>can_transfer_stars</em> business bot right is required and <code>gift.upgrade_star_count</code> must be passed.</td>",
|
||||
"rst_description": "The amount of Telegram Stars that will be paid for the upgrade from the business account balance. If :code:`gift.prepaid_upgrade_star_count > 0`, then pass 0, otherwise, the *can_transfer_stars* business bot right is required and :code:`gift.upgrade_star_count` must be passed.\n",
|
||||
"name": "star_count"
|
||||
}
|
||||
],
|
||||
"category": "methods"
|
||||
}
|
||||
}
|
||||
|
|
@ -1,8 +1,8 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Stickers",
|
||||
"anchor": "stickers"
|
||||
"title": "Updating messages",
|
||||
"anchor": "updating-messages"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "verifychat",
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
{
|
||||
"meta": {},
|
||||
"group": {
|
||||
"title": "Stickers",
|
||||
"anchor": "stickers"
|
||||
"title": "Updating messages",
|
||||
"anchor": "updating-messages"
|
||||
},
|
||||
"object": {
|
||||
"anchor": "verifyuser",
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue