@grom.js/bot-api-spec 0.7.1 → 0.9.0

package/README.md

@@ -1,4 +1,4 @@
-[![bot-api](https://img.shields.io/badge/v9.4-000?style=flat&logo=telegram&logoColor=%2325A3E1&label=Bot%20API&labelColor=%23000&color=%2325A3E1)][bot-api]
+[![bot-api](https://img.shields.io/badge/v9.6-000?style=flat&logo=telegram&logoColor=%2325A3E1&label=Bot%20API&labelColor=%23000&color=%2325A3E1)][bot-api]
 [![npm](https://img.shields.io/npm/v/%40grom.js%2Fbot-api-spec?style=flat&logo=npm&logoColor=%23BB443E&logoSize=auto&label=Latest&labelColor=%23fff&color=%23BB443E)](https://www.npmjs.com/package/@grom.js/bot-api-spec)
 [![jsr](https://img.shields.io/jsr/v/%40grom/bot-api-spec?style=flat&logo=jsr&logoColor=%231B3646&logoSize=auto&label=Latest&labelColor=%23F3E051&color=%231B3646)](https://jsr.io/@grom/bot-api-spec)
 

package/dist/methods.gen.d.ts

@@ -50,6 +50,7 @@ export declare const methods: {
     restrictChatMember: ApiMethod;
     promoteChatMember: ApiMethod;
     setChatAdministratorCustomTitle: ApiMethod;
+    setChatMemberTag: ApiMethod;
     banChatSenderChat: ApiMethod;
     unbanChatSenderChat: ApiMethod;
     setChatPermissions: ApiMethod;
@@ -91,6 +92,8 @@ export declare const methods: {
     answerCallbackQuery: ApiMethod;
     getUserChatBoosts: ApiMethod;
     getBusinessConnection: ApiMethod;
+    getManagedBotToken: ApiMethod;
+    replaceManagedBotToken: ApiMethod;
     setMyCommands: ApiMethod;
     deleteMyCommands: ApiMethod;
     getMyCommands: ApiMethod;
@@ -133,6 +136,9 @@ export declare const methods: {
     repostStory: ApiMethod;
     editStory: ApiMethod;
     deleteStory: ApiMethod;
+    answerWebAppQuery: ApiMethod;
+    savePreparedInlineMessage: ApiMethod;
+    savePreparedKeyboardButton: ApiMethod;
     editMessageText: ApiMethod;
     editMessageCaption: ApiMethod;
     editMessageMedia: ApiMethod;
@@ -162,8 +168,6 @@ export declare const methods: {
     setCustomEmojiStickerSetThumbnail: ApiMethod;
     deleteStickerSet: ApiMethod;
     answerInlineQuery: ApiMethod;
-    answerWebAppQuery: ApiMethod;
-    savePreparedInlineMessage: ApiMethod;
     sendInvoice: ApiMethod;
     createInvoiceLink: ApiMethod;
     answerShippingQuery: ApiMethod;

package/dist/methods.gen.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"methods.gen.d.ts","sourceRoot":"","sources":["../src/methods.gen.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AA+0X5C;;;;;GAKG;AACH,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAsKnB,CAAA"}
+{"version":3,"file":"methods.gen.d.ts","sourceRoot":"","sources":["../src/methods.gen.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAuiY5C;;;;;GAKG;AACH,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA0KnB,CAAA"}

package/dist/methods.gen.js

@@ -3935,17 +3935,60 @@ const sendPoll = {
                 type: 'bool',
             },
             description: {
-                markdown: '_True_, if the poll allows multiple answers, ignored for polls in quiz mode, defaults to _False_',
+                markdown: 'Pass _True_, if the poll allows multiple answers, defaults to _False_',
             },
             required: false,
         },
         {
-            name: 'correct_option_id',
+            name: 'allows_revoting',
             type: {
-                type: 'int32',
+                type: 'bool',
+            },
+            description: {
+                markdown: 'Pass _True_, if the poll allows to change chosen answer options, defaults to _False_ for quizzes and to _True_ for regular polls',
+            },
+            required: false,
+        },
+        {
+            name: 'shuffle_options',
+            type: {
+                type: 'bool',
+            },
+            description: {
+                markdown: 'Pass _True_, if the poll options must be shown in random order',
+            },
+            required: false,
+        },
+        {
+            name: 'allow_adding_options',
+            type: {
+                type: 'bool',
+            },
+            description: {
+                markdown: 'Pass _True_, if answer options can be added to the poll after creation; not supported for anonymous polls and quizzes',
+            },
+            required: false,
+        },
+        {
+            name: 'hide_results_until_closes',
+            type: {
+                type: 'bool',
             },
             description: {
-                markdown: '0-based identifier of the correct answer option, required for polls in quiz mode',
+                markdown: 'Pass _True_, if poll results must be shown only after the poll closes',
+            },
+            required: false,
+        },
+        {
+            name: 'correct_option_ids',
+            type: {
+                type: 'array',
+                of: {
+                    type: 'int32',
+                },
+            },
+            description: {
+                markdown: 'An array of monotonically increasing 0-based identifiers of the correct answer options, required for polls in quiz mode',
             },
             required: false,
         },
@@ -4003,7 +4046,7 @@ const sendPoll = {
                 type: 'int32',
             },
             description: {
-                markdown: 'Amount of time in seconds the poll will be active after creation, 5-600. Can\'t be used together with _close\\_date_.',
+                markdown: 'Amount of time in seconds the poll will be active after creation, 5-2628000. Can\'t be used together with _close\\_date_.',
             },
             required: false,
         },
@@ -4013,7 +4056,7 @@ const sendPoll = {
                 type: 'int32',
             },
             description: {
-                markdown: 'Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 600 seconds in the future. Can\'t be used together with _open\\_period_.',
+                markdown: 'Point in time (Unix timestamp) when the poll will be automatically closed. Must be at least 5 and no more than 2628000 seconds in the future. Can\'t be used together with _open\\_period_.',
             },
             required: false,
         },
@@ -4027,6 +4070,40 @@ const sendPoll = {
             },
             required: false,
         },
+        {
+            name: 'description',
+            type: {
+                type: 'str',
+            },
+            description: {
+                markdown: 'Description of the poll to be sent, 0-1024 characters after entities parsing',
+            },
+            required: false,
+        },
+        {
+            name: 'description_parse_mode',
+            type: {
+                type: 'str',
+            },
+            description: {
+                markdown: 'Mode for parsing entities in the poll description. See [formatting options](https://core.telegram.org/bots/api#formatting-options) for more details.',
+            },
+            required: false,
+        },
+        {
+            name: 'description_entities',
+            type: {
+                type: 'array',
+                of: {
+                    type: 'api-type',
+                    name: 'MessageEntity',
+                },
+            },
+            description: {
+                markdown: 'An array of special entities that appear in the poll description, which can be specified instead of _description\\_parse\\_mode_',
+            },
+            required: false,
+        },
         {
             name: 'disable_notification',
             type: {
@@ -4197,7 +4274,7 @@ const sendChecklist = {
                 name: 'InlineKeyboardMarkup',
             },
             description: {
-                markdown: 'An object for an inline keyboard',
+                markdown: 'An object for an [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards)',
             },
             required: false,
         },
@@ -4396,7 +4473,7 @@ const sendDice = {
 const sendMessageDraft = {
     name: 'sendMessageDraft',
     description: {
-        markdown: 'Use this method to stream a partial message to a user while the message is being generated; supported only for bots with forum topic mode enabled. Returns _True_ on success.',
+        markdown: 'Use this method to stream a partial message to a user while the message is being generated. Returns _True_ on success.',
     },
     parameters: [
         {
@@ -5176,6 +5253,16 @@ const promoteChatMember = {
             },
             required: false,
         },
+        {
+            name: 'can_manage_tags',
+            type: {
+                type: 'bool',
+            },
+            description: {
+                markdown: 'Pass _True_ if the administrator can edit the tags of regular members; for groups and supergroups only',
+            },
+            required: false,
+        },
     ],
     returnType: {
         type: 'bool',
@@ -5232,6 +5319,56 @@ const setChatAdministratorCustomTitle = {
         literal: true,
     },
 };
+const setChatMemberTag = {
+    name: 'setChatMemberTag',
+    description: {
+        markdown: 'Use this method to set a tag for a regular member in a group or a supergroup. The bot must be an administrator in the chat for this to work and must have the _can\\_manage\\_tags_ administrator right. Returns _True_ on success.',
+    },
+    parameters: [
+        {
+            name: 'chat_id',
+            type: {
+                type: 'union',
+                types: [
+                    {
+                        type: 'int32',
+                    },
+                    {
+                        type: 'str',
+                    },
+                ],
+            },
+            description: {
+                markdown: 'Unique identifier for the target chat or username of the target supergroup (in the format `@supergroupusername`)',
+            },
+            required: true,
+        },
+        {
+            name: 'user_id',
+            type: {
+                type: 'int32',
+            },
+            description: {
+                markdown: 'Unique identifier of the target user',
+            },
+            required: true,
+        },
+        {
+            name: 'tag',
+            type: {
+                type: 'str',
+            },
+            description: {
+                markdown: 'New tag for the member; 0-16 characters, emoji are not allowed',
+            },
+            required: false,
+        },
+    ],
+    returnType: {
+        type: 'bool',
+        literal: true,
+    },
+};
 const banChatSenderChat = {
     name: 'banChatSenderChat',
     description: {
@@ -6929,6 +7066,48 @@ const getBusinessConnection = {
         name: 'BusinessConnection',
     },
 };
+const getManagedBotToken = {
+    name: 'getManagedBotToken',
+    description: {
+        markdown: 'Use this method to get the token of a managed bot. Returns the token as _String_ on success.',
+    },
+    parameters: [
+        {
+            name: 'user_id',
+            type: {
+                type: 'int32',
+            },
+            description: {
+                markdown: 'User identifier of the managed bot whose token will be returned',
+            },
+            required: true,
+        },
+    ],
+    returnType: {
+        type: 'str',
+    },
+};
+const replaceManagedBotToken = {
+    name: 'replaceManagedBotToken',
+    description: {
+        markdown: '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.',
+    },
+    parameters: [
+        {
+            name: 'user_id',
+            type: {
+                type: 'int32',
+            },
+            description: {
+                markdown: 'User identifier of the managed bot whose token will be replaced',
+            },
+            required: true,
+        },
+    ],
+    returnType: {
+        type: 'str',
+    },
+};
 const setMyCommands = {
     name: 'setMyCommands',
     description: {
@@ -7446,7 +7625,7 @@ const sendGift = {
                 ],
             },
             description: {
-                markdown: '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.',
+                markdown: '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.',
             },
             required: false,
         },
@@ -7564,7 +7743,7 @@ const giftPremiumSubscription = {
                 ],
             },
             description: {
-                markdown: '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.',
+                markdown: '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.',
             },
             required: false,
         },
@@ -8927,6 +9106,145 @@ const deleteStory = {
         literal: true,
     },
 };
+const answerWebAppQuery = {
+    name: 'answerWebAppQuery',
+    description: {
+        markdown: 'Use this method to set the result of an interaction with a [Web App](https://core.telegram.org/bots/webapps) and send a corresponding message on behalf of the user to the chat from which the query originated. On success, a [SentWebAppMessage](https://core.telegram.org/bots/api#sentwebappmessage) object is returned.',
+    },
+    parameters: [
+        {
+            name: 'web_app_query_id',
+            type: {
+                type: 'str',
+            },
+            description: {
+                markdown: 'Unique identifier for the query to be answered',
+            },
+            required: true,
+        },
+        {
+            name: 'result',
+            type: {
+                type: 'api-type',
+                name: 'InlineQueryResult',
+            },
+            description: {
+                markdown: 'An object describing the message to be sent',
+            },
+            required: true,
+        },
+    ],
+    returnType: {
+        type: 'api-type',
+        name: 'SentWebAppMessage',
+    },
+};
+const savePreparedInlineMessage = {
+    name: 'savePreparedInlineMessage',
+    description: {
+        markdown: 'Stores a message that can be sent by a user of a Mini App. Returns a [PreparedInlineMessage](https://core.telegram.org/bots/api#preparedinlinemessage) object.',
+    },
+    parameters: [
+        {
+            name: 'user_id',
+            type: {
+                type: 'int32',
+            },
+            description: {
+                markdown: 'Unique identifier of the target user that can use the prepared message',
+            },
+            required: true,
+        },
+        {
+            name: 'result',
+            type: {
+                type: 'api-type',
+                name: 'InlineQueryResult',
+            },
+            description: {
+                markdown: 'An object describing the message to be sent',
+            },
+            required: true,
+        },
+        {
+            name: 'allow_user_chats',
+            type: {
+                type: 'bool',
+            },
+            description: {
+                markdown: 'Pass _True_ if the message can be sent to private chats with users',
+            },
+            required: false,
+        },
+        {
+            name: 'allow_bot_chats',
+            type: {
+                type: 'bool',
+            },
+            description: {
+                markdown: 'Pass _True_ if the message can be sent to private chats with bots',
+            },
+            required: false,
+        },
+        {
+            name: 'allow_group_chats',
+            type: {
+                type: 'bool',
+            },
+            description: {
+                markdown: 'Pass _True_ if the message can be sent to group and supergroup chats',
+            },
+            required: false,
+        },
+        {
+            name: 'allow_channel_chats',
+            type: {
+                type: 'bool',
+            },
+            description: {
+                markdown: 'Pass _True_ if the message can be sent to channel chats',
+            },
+            required: false,
+        },
+    ],
+    returnType: {
+        type: 'api-type',
+        name: 'PreparedInlineMessage',
+    },
+};
+const savePreparedKeyboardButton = {
+    name: 'savePreparedKeyboardButton',
+    description: {
+        markdown: 'Stores a keyboard button that can be used by a user within a Mini App. Returns a [PreparedKeyboardButton](https://core.telegram.org/bots/api#preparedkeyboardbutton) object.',
+    },
+    parameters: [
+        {
+            name: 'user_id',
+            type: {
+                type: 'int32',
+            },
+            description: {
+                markdown: 'Unique identifier of the target user that can use the button',
+            },
+            required: true,
+        },
+        {
+            name: 'button',
+            type: {
+                type: 'api-type',
+                name: 'KeyboardButton',
+            },
+            description: {
+                markdown: 'An object describing the button to be saved. The button must be of the type _request\\_users_, _request\\_chat_, or _request\\_managed\\_bot_',
+            },
+            required: true,
+        },
+    ],
+    returnType: {
+        type: 'api-type',
+        name: 'PreparedKeyboardButton',
+    },
+};
 const editMessageText = {
     name: 'editMessageText',
     description: {
@@ -9569,7 +9887,7 @@ const editMessageChecklist = {
                 name: 'InlineKeyboardMarkup',
             },
             description: {
-                markdown: 'An object for the new inline keyboard for the message',
+                markdown: 'An object for the new [inline keyboard](https://core.telegram.org/bots/features#inline-keyboards) for the message',
             },
             required: false,
         },
@@ -10751,112 +11069,6 @@ const answerInlineQuery = {
         literal: true,
     },
 };
-const answerWebAppQuery = {
-    name: 'answerWebAppQuery',
-    description: {
-        markdown: 'Use this method to set the result of an interaction with a [Web App](https://core.telegram.org/bots/webapps) and send a corresponding message on behalf of the user to the chat from which the query originated. On success, a [SentWebAppMessage](https://core.telegram.org/bots/api#sentwebappmessage) object is returned.',
-    },
-    parameters: [
-        {
-            name: 'web_app_query_id',
-            type: {
-                type: 'str',
-            },
-            description: {
-                markdown: 'Unique identifier for the query to be answered',
-            },
-            required: true,
-        },
-        {
-            name: 'result',
-            type: {
-                type: 'api-type',
-                name: 'InlineQueryResult',
-            },
-            description: {
-                markdown: 'An object describing the message to be sent',
-            },
-            required: true,
-        },
-    ],
-    returnType: {
-        type: 'api-type',
-        name: 'SentWebAppMessage',
-    },
-};
-const savePreparedInlineMessage = {
-    name: 'savePreparedInlineMessage',
-    description: {
-        markdown: 'Stores a message that can be sent by a user of a Mini App. Returns a [PreparedInlineMessage](https://core.telegram.org/bots/api#preparedinlinemessage) object.',
-    },
-    parameters: [
-        {
-            name: 'user_id',
-            type: {
-                type: 'int32',
-            },
-            description: {
-                markdown: 'Unique identifier of the target user that can use the prepared message',
-            },
-            required: true,
-        },
-        {
-            name: 'result',
-            type: {
-                type: 'api-type',
-                name: 'InlineQueryResult',
-            },
-            description: {
-                markdown: 'An object describing the message to be sent',
-            },
-            required: true,
-        },
-        {
-            name: 'allow_user_chats',
-            type: {
-                type: 'bool',
-            },
-            description: {
-                markdown: 'Pass _True_ if the message can be sent to private chats with users',
-            },
-            required: false,
-        },
-        {
-            name: 'allow_bot_chats',
-            type: {
-                type: 'bool',
-            },
-            description: {
-                markdown: 'Pass _True_ if the message can be sent to private chats with bots',
-            },
-            required: false,
-        },
-        {
-            name: 'allow_group_chats',
-            type: {
-                type: 'bool',
-            },
-            description: {
-                markdown: 'Pass _True_ if the message can be sent to group and supergroup chats',
-            },
-            required: false,
-        },
-        {
-            name: 'allow_channel_chats',
-            type: {
-                type: 'bool',
-            },
-            description: {
-                markdown: 'Pass _True_ if the message can be sent to channel chats',
-            },
-            required: false,
-        },
-    ],
-    returnType: {
-        type: 'api-type',
-        name: 'PreparedInlineMessage',
-    },
-};
 const sendInvoice = {
     name: 'sendInvoice',
     description: {
@@ -11993,6 +12205,7 @@ export const methods = {
     restrictChatMember,
     promoteChatMember,
     setChatAdministratorCustomTitle,
+    setChatMemberTag,
     banChatSenderChat,
     unbanChatSenderChat,
     setChatPermissions,
@@ -12034,6 +12247,8 @@ export const methods = {
     answerCallbackQuery,
     getUserChatBoosts,
     getBusinessConnection,
+    getManagedBotToken,
+    replaceManagedBotToken,
     setMyCommands,
     deleteMyCommands,
     getMyCommands,
@@ -12076,6 +12291,9 @@ export const methods = {
     repostStory,
     editStory,
     deleteStory,
+    answerWebAppQuery,
+    savePreparedInlineMessage,
+    savePreparedKeyboardButton,
     editMessageText,
     editMessageCaption,
     editMessageMedia,
@@ -12105,8 +12323,6 @@ export const methods = {
     setCustomEmojiStickerSetThumbnail,
     deleteStickerSet,
     answerInlineQuery,
-    answerWebAppQuery,
-    savePreparedInlineMessage,
     sendInvoice,
     createInvoiceLink,
     answerShippingQuery,