@gramio/types
Advanced tools
@gramio/types - npm Package Compare versions
Comparing version 7.0.5 to 7.0.6
| /** | ||
| * Based on Bot Api v7.0.0 (29.12.2023) | ||
| * Generated at 1/31/2024, 1:08:09 PM using {@link https://github.com/gramiojs/types | [types]} and {@link https://ark0f.github.io/tg-bot-api | [schema]} generators | ||
| * Generated at 1/31/2024, 4:36:06 PM using {@link https://github.com/gramiojs/types | [types]} and {@link https://ark0f.github.io/tg-bot-api | [schema]} generators | ||
| */ | ||
@@ -29,3 +29,3 @@ import * as Params from "./params" | ||
| */ | ||
| setWebhook: CallApiWithOptionalParams<Params.SetWebhookParams, boolean> | ||
| setWebhook: CallApiWithOptionalParams<Params.SetWebhookParams, true> | ||
| /** | ||
@@ -36,6 +36,3 @@ * Use this method to remove webhook integration if you decide to switch back to [getUpdates](https://core.telegram.org/bots/api/#getupdates). Returns *True* on success. | ||
| */ | ||
| deleteWebhook: CallApiWithOptionalParams< | ||
| Params.DeleteWebhookParams, | ||
| boolean | ||
| > | ||
| deleteWebhook: CallApiWithOptionalParams<Params.DeleteWebhookParams, true> | ||
| /** | ||
@@ -58,3 +55,3 @@ * Use this method to get current webhook status. Requires no parameters. On success, returns a [WebhookInfo](https://core.telegram.org/bots/api/#webhookinfo) object. If the bot is using [getUpdates](https://core.telegram.org/bots/api/#getupdates), will return an object with the *url* field empty. | ||
| */ | ||
| logOut: CallApiWithoutParams<boolean> | ||
| logOut: CallApiWithoutParams<true> | ||
| /** | ||
@@ -65,3 +62,3 @@ * Use this method to close the bot instance before moving it from one local server to another. You need to delete the webhook before calling this method to ensure that the bot isn't launched again after server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns *True* on success. Requires no parameters. | ||
| */ | ||
| close: CallApiWithoutParams<boolean> | ||
| close: CallApiWithoutParams<true> | ||
| /** | ||
@@ -240,6 +237,3 @@ * Use this method to send text messages. On success, the sent [Message](https://core.telegram.org/bots/api/#message) is returned. | ||
| */ | ||
| sendChatAction: CallApiWithOptionalParams< | ||
| Params.SendChatActionParams, | ||
| boolean | ||
| > | ||
| sendChatAction: CallApiWithOptionalParams<Params.SendChatActionParams, true> | ||
| /** | ||
@@ -252,3 +246,3 @@ * Use this method to change the chosen reactions on a message. Service messages can't be reacted to. Automatically forwarded messages from a channel to its discussion group have the same available reactions as messages in the channel. Returns *True* on success. | ||
| Params.SetMessageReactionParams, | ||
| boolean | ||
| true | ||
| > | ||
@@ -275,6 +269,3 @@ /** | ||
| */ | ||
| banChatMember: CallApiWithOptionalParams< | ||
| Params.BanChatMemberParams, | ||
| boolean | ||
| > | ||
| banChatMember: CallApiWithOptionalParams<Params.BanChatMemberParams, true> | ||
| /** | ||
@@ -287,3 +278,3 @@ * Use this method to unban a previously banned user in a supergroup or channel. The user will **not** return to the group or channel automatically, but will be able to join via link, etc. The bot must be an administrator for this to work. By default, this method guarantees that after the call the user is not a member of the chat, but will be able to join it. So if the user is a member of the chat they will also be **removed** from the chat. If you don't want this, use the parameter *only\_if\_banned*. Returns *True* on success. | ||
| Params.UnbanChatMemberParams, | ||
| boolean | ||
| true | ||
| > | ||
@@ -297,3 +288,3 @@ /** | ||
| Params.RestrictChatMemberParams, | ||
| boolean | ||
| true | ||
| > | ||
@@ -307,3 +298,3 @@ /** | ||
| Params.PromoteChatMemberParams, | ||
| boolean | ||
| true | ||
| > | ||
@@ -317,3 +308,3 @@ /** | ||
| Params.SetChatAdministratorCustomTitleParams, | ||
| boolean | ||
| true | ||
| > | ||
@@ -325,3 +316,3 @@ /** | ||
| */ | ||
| banChatSenderChat: CallApi<Params.BanChatSenderChatParams, boolean> | ||
| banChatSenderChat: CallApi<Params.BanChatSenderChatParams, true> | ||
| /** | ||
@@ -332,3 +323,3 @@ * Use this method to unban a previously banned channel chat in a supergroup or channel. The bot must be an administrator for this to work and must have the appropriate administrator rights. Returns *True* on success. | ||
| */ | ||
| unbanChatSenderChat: CallApi<Params.UnbanChatSenderChatParams, boolean> | ||
| unbanChatSenderChat: CallApi<Params.UnbanChatSenderChatParams, true> | ||
| /** | ||
@@ -341,3 +332,3 @@ * Use this method to set default chat permissions for all members. The bot must be an administrator in the group or a supergroup for this to work and must have the *can\_restrict\_members* administrator rights. Returns *True* on success. | ||
| Params.SetChatPermissionsParams, | ||
| boolean | ||
| true | ||
| > | ||
@@ -382,6 +373,3 @@ /** | ||
| */ | ||
| approveChatJoinRequest: CallApi< | ||
| Params.ApproveChatJoinRequestParams, | ||
| boolean | ||
| > | ||
| approveChatJoinRequest: CallApi<Params.ApproveChatJoinRequestParams, true> | ||
| /** | ||
@@ -392,6 +380,3 @@ * Use this method to decline a chat join request. The bot must be an administrator in the chat for this to work and must have the *can\_invite\_users* administrator right. Returns *True* on success. | ||
| */ | ||
| declineChatJoinRequest: CallApi< | ||
| Params.DeclineChatJoinRequestParams, | ||
| boolean | ||
| > | ||
| declineChatJoinRequest: CallApi<Params.DeclineChatJoinRequestParams, true> | ||
| /** | ||
@@ -402,3 +387,3 @@ * Use this method to set a new profile photo for the chat. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns *True* on success. | ||
| */ | ||
| setChatPhoto: CallApi<Params.SetChatPhotoParams, boolean> | ||
| setChatPhoto: CallApi<Params.SetChatPhotoParams, true> | ||
| /** | ||
@@ -409,3 +394,3 @@ * Use this method to delete a chat photo. Photos can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns *True* on success. | ||
| */ | ||
| deleteChatPhoto: CallApi<Params.DeleteChatPhotoParams, boolean> | ||
| deleteChatPhoto: CallApi<Params.DeleteChatPhotoParams, true> | ||
| /** | ||
@@ -416,3 +401,3 @@ * Use this method to change the title of a chat. Titles can't be changed for private chats. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns *True* on success. | ||
| */ | ||
| setChatTitle: CallApi<Params.SetChatTitleParams, boolean> | ||
| setChatTitle: CallApi<Params.SetChatTitleParams, true> | ||
| /** | ||
@@ -425,3 +410,3 @@ * Use this method to change the description of a group, a supergroup or a channel. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns *True* on success. | ||
| Params.SetChatDescriptionParams, | ||
| boolean | ||
| true | ||
| > | ||
@@ -433,6 +418,3 @@ /** | ||
| */ | ||
| pinChatMessage: CallApiWithOptionalParams< | ||
| Params.PinChatMessageParams, | ||
| boolean | ||
| > | ||
| pinChatMessage: CallApiWithOptionalParams<Params.PinChatMessageParams, true> | ||
| /** | ||
@@ -445,3 +427,3 @@ * Use this method to remove a message from the list of pinned messages in a chat. If the chat is not a private chat, the bot must be an administrator in the chat for this to work and must have the 'can\_pin\_messages' administrator right in a supergroup or 'can\_edit\_messages' administrator right in a channel. Returns *True* on success. | ||
| Params.UnpinChatMessageParams, | ||
| boolean | ||
| true | ||
| > | ||
@@ -453,3 +435,3 @@ /** | ||
| */ | ||
| unpinAllChatMessages: CallApi<Params.UnpinAllChatMessagesParams, boolean> | ||
| unpinAllChatMessages: CallApi<Params.UnpinAllChatMessagesParams, true> | ||
| /** | ||
@@ -460,3 +442,3 @@ * Use this method for your bot to leave a group, supergroup or channel. Returns *True* on success. | ||
| */ | ||
| leaveChat: CallApi<Params.LeaveChatParams, boolean> | ||
| leaveChat: CallApi<Params.LeaveChatParams, true> | ||
| /** | ||
@@ -497,3 +479,3 @@ * Use this method to get up to date information about the chat. Returns a [Chat](https://core.telegram.org/bots/api/#chat) object on success. | ||
| */ | ||
| setChatStickerSet: CallApi<Params.SetChatStickerSetParams, boolean> | ||
| setChatStickerSet: CallApi<Params.SetChatStickerSetParams, true> | ||
| /** | ||
@@ -504,3 +486,3 @@ * Use this method to delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Use the field *can\_set\_sticker\_set* optionally returned in [getChat](https://core.telegram.org/bots/api/#getchat) requests to check if the bot can use this method. Returns *True* on success. | ||
| */ | ||
| deleteChatStickerSet: CallApi<Params.DeleteChatStickerSetParams, boolean> | ||
| deleteChatStickerSet: CallApi<Params.DeleteChatStickerSetParams, true> | ||
| /** | ||
@@ -526,6 +508,3 @@ * Use this method to get custom emoji stickers, which can be used as a forum topic icon by any user. Requires no parameters. Returns an Array of [Sticker](https://core.telegram.org/bots/api/#sticker) objects. | ||
| */ | ||
| editForumTopic: CallApiWithOptionalParams< | ||
| Params.EditForumTopicParams, | ||
| boolean | ||
| > | ||
| editForumTopic: CallApiWithOptionalParams<Params.EditForumTopicParams, true> | ||
| /** | ||
@@ -536,3 +515,3 @@ * Use this method to close an open topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can\_manage\_topics* administrator rights, unless it is the creator of the topic. Returns *True* on success. | ||
| */ | ||
| closeForumTopic: CallApi<Params.CloseForumTopicParams, boolean> | ||
| closeForumTopic: CallApi<Params.CloseForumTopicParams, true> | ||
| /** | ||
@@ -543,3 +522,3 @@ * Use this method to reopen a closed topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can\_manage\_topics* administrator rights, unless it is the creator of the topic. Returns *True* on success. | ||
| */ | ||
| reopenForumTopic: CallApi<Params.ReopenForumTopicParams, boolean> | ||
| reopenForumTopic: CallApi<Params.ReopenForumTopicParams, true> | ||
| /** | ||
@@ -550,3 +529,3 @@ * 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. | ||
| */ | ||
| deleteForumTopic: CallApi<Params.DeleteForumTopicParams, boolean> | ||
| deleteForumTopic: CallApi<Params.DeleteForumTopicParams, true> | ||
| /** | ||
@@ -559,3 +538,3 @@ * Use this method to clear the list of pinned messages in a forum topic. The bot must be an administrator in the chat for this to work and must have the *can\_pin\_messages* administrator right in the supergroup. Returns *True* on success. | ||
| Params.UnpinAllForumTopicMessagesParams, | ||
| boolean | ||
| true | ||
| > | ||
@@ -567,3 +546,3 @@ /** | ||
| */ | ||
| editGeneralForumTopic: CallApi<Params.EditGeneralForumTopicParams, boolean> | ||
| editGeneralForumTopic: CallApi<Params.EditGeneralForumTopicParams, true> | ||
| /** | ||
@@ -574,6 +553,3 @@ * Use this method to close an open 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can\_manage\_topics* administrator rights. Returns *True* on success. | ||
| */ | ||
| closeGeneralForumTopic: CallApi< | ||
| Params.CloseGeneralForumTopicParams, | ||
| boolean | ||
| > | ||
| closeGeneralForumTopic: CallApi<Params.CloseGeneralForumTopicParams, true> | ||
| /** | ||
@@ -584,6 +560,3 @@ * Use this method to reopen a closed 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can\_manage\_topics* administrator rights. The topic will be automatically unhidden if it was hidden. Returns *True* on success. | ||
| */ | ||
| reopenGeneralForumTopic: CallApi< | ||
| Params.ReopenGeneralForumTopicParams, | ||
| boolean | ||
| > | ||
| reopenGeneralForumTopic: CallApi<Params.ReopenGeneralForumTopicParams, true> | ||
| /** | ||
@@ -594,3 +567,3 @@ * Use this method to hide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can\_manage\_topics* administrator rights. The topic will be automatically closed if it was open. Returns *True* on success. | ||
| */ | ||
| hideGeneralForumTopic: CallApi<Params.HideGeneralForumTopicParams, boolean> | ||
| hideGeneralForumTopic: CallApi<Params.HideGeneralForumTopicParams, true> | ||
| /** | ||
@@ -601,6 +574,3 @@ * Use this method to unhide the 'General' topic in a forum supergroup chat. The bot must be an administrator in the chat for this to work and must have the *can\_manage\_topics* administrator rights. Returns *True* on success. | ||
| */ | ||
| unhideGeneralForumTopic: CallApi< | ||
| Params.UnhideGeneralForumTopicParams, | ||
| boolean | ||
| > | ||
| unhideGeneralForumTopic: CallApi<Params.UnhideGeneralForumTopicParams, true> | ||
| /** | ||
@@ -613,3 +583,3 @@ * Use this method to clear the list of pinned messages in a General forum topic. The bot must be an administrator in the chat for this to work and must have the *can\_pin\_messages* administrator right in the supergroup. Returns *True* on success. | ||
| Params.UnpinAllGeneralForumTopicMessagesParams, | ||
| boolean | ||
| true | ||
| > | ||
@@ -625,3 +595,3 @@ /** | ||
| Params.AnswerCallbackQueryParams, | ||
| boolean | ||
| true | ||
| > | ||
@@ -642,6 +612,3 @@ /** | ||
| */ | ||
| setMyCommands: CallApiWithOptionalParams< | ||
| Params.SetMyCommandsParams, | ||
| boolean | ||
| > | ||
| setMyCommands: CallApiWithOptionalParams<Params.SetMyCommandsParams, true> | ||
| /** | ||
@@ -654,3 +621,3 @@ * Use this method to delete the list of the bot's commands for the given scope and user language. After deletion, [higher level commands](https://core.telegram.org/bots/api/#determining-list-of-commands) will be shown to affected users. Returns *True* on success. | ||
| Params.DeleteMyCommandsParams, | ||
| boolean | ||
| true | ||
| > | ||
@@ -671,3 +638,3 @@ /** | ||
| */ | ||
| setMyName: CallApiWithOptionalParams<Params.SetMyNameParams, boolean> | ||
| setMyName: CallApiWithOptionalParams<Params.SetMyNameParams, true> | ||
| /** | ||
@@ -689,3 +656,3 @@ * Use this method to get the current bot name for the given user language. Returns [BotName](https://core.telegram.org/bots/api/#botname) on success. | ||
| Params.SetMyDescriptionParams, | ||
| boolean | ||
| true | ||
| > | ||
@@ -708,3 +675,3 @@ /** | ||
| Params.SetMyShortDescriptionParams, | ||
| boolean | ||
| true | ||
| > | ||
@@ -727,3 +694,3 @@ /** | ||
| Params.SetChatMenuButtonParams, | ||
| boolean | ||
| true | ||
| > | ||
@@ -746,3 +713,3 @@ /** | ||
| Params.SetMyDefaultAdministratorRightsParams, | ||
| boolean | ||
| true | ||
| > | ||
@@ -765,3 +732,3 @@ /** | ||
| Params.EditMessageTextParams, | ||
| Objects.TelegramMessage | boolean | ||
| Objects.TelegramMessage | true | ||
| > | ||
@@ -775,3 +742,3 @@ /** | ||
| Params.EditMessageCaptionParams, | ||
| Objects.TelegramMessage | boolean | ||
| Objects.TelegramMessage | true | ||
| > | ||
@@ -785,3 +752,3 @@ /** | ||
| Params.EditMessageMediaParams, | ||
| Objects.TelegramMessage | boolean | ||
| Objects.TelegramMessage | true | ||
| > | ||
@@ -795,3 +762,3 @@ /** | ||
| Params.EditMessageLiveLocationParams, | ||
| Objects.TelegramMessage | boolean | ||
| Objects.TelegramMessage | true | ||
| > | ||
@@ -805,3 +772,3 @@ /** | ||
| Params.StopMessageLiveLocationParams, | ||
| Objects.TelegramMessage | boolean | ||
| Objects.TelegramMessage | true | ||
| > | ||
@@ -815,3 +782,3 @@ /** | ||
| Params.EditMessageReplyMarkupParams, | ||
| Objects.TelegramMessage | boolean | ||
| Objects.TelegramMessage | true | ||
| > | ||
@@ -841,3 +808,3 @@ /** | ||
| */ | ||
| deleteMessage: CallApi<Params.DeleteMessageParams, boolean> | ||
| deleteMessage: CallApi<Params.DeleteMessageParams, true> | ||
| /** | ||
@@ -848,3 +815,3 @@ * 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. | ||
| */ | ||
| deleteMessages: CallApi<Params.DeleteMessagesParams, boolean> | ||
| deleteMessages: CallApi<Params.DeleteMessagesParams, true> | ||
| /** | ||
@@ -893,3 +860,3 @@ * Use this method to send static .WEBP, [animated](https://telegram.org/blog/animated-stickers) .TGS, or [video](https://telegram.org/blog/video-stickers-better-reactions) .WEBM stickers. On success, the sent [Message](https://core.telegram.org/bots/api/#message) is returned. | ||
| Params.CreateNewStickerSetParams, | ||
| boolean | ||
| true | ||
| > | ||
@@ -901,3 +868,3 @@ /** | ||
| */ | ||
| addStickerToSet: CallApi<Params.AddStickerToSetParams, boolean> | ||
| addStickerToSet: CallApi<Params.AddStickerToSetParams, true> | ||
| /** | ||
@@ -908,6 +875,3 @@ * Use this method to move a sticker in a set created by the bot to a specific position. Returns *True* on success. | ||
| */ | ||
| setStickerPositionInSet: CallApi< | ||
| Params.SetStickerPositionInSetParams, | ||
| boolean | ||
| > | ||
| setStickerPositionInSet: CallApi<Params.SetStickerPositionInSetParams, true> | ||
| /** | ||
@@ -918,3 +882,3 @@ * Use this method to delete a sticker from a set created by the bot. Returns *True* on success. | ||
| */ | ||
| deleteStickerFromSet: CallApi<Params.DeleteStickerFromSetParams, boolean> | ||
| deleteStickerFromSet: CallApi<Params.DeleteStickerFromSetParams, true> | ||
| /** | ||
@@ -925,3 +889,3 @@ * Use this method to change the list of emoji assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns *True* on success. | ||
| */ | ||
| setStickerEmojiList: CallApi<Params.SetStickerEmojiListParams, boolean> | ||
| setStickerEmojiList: CallApi<Params.SetStickerEmojiListParams, true> | ||
| /** | ||
@@ -934,3 +898,3 @@ * Use this method to change search keywords assigned to a regular or custom emoji sticker. The sticker must belong to a sticker set created by the bot. Returns *True* on success. | ||
| Params.SetStickerKeywordsParams, | ||
| boolean | ||
| true | ||
| > | ||
@@ -944,3 +908,3 @@ /** | ||
| Params.SetStickerMaskPositionParams, | ||
| boolean | ||
| true | ||
| > | ||
@@ -952,3 +916,3 @@ /** | ||
| */ | ||
| setStickerSetTitle: CallApi<Params.SetStickerSetTitleParams, boolean> | ||
| setStickerSetTitle: CallApi<Params.SetStickerSetTitleParams, true> | ||
| /** | ||
@@ -961,3 +925,3 @@ * Use this method to set the thumbnail of a regular or mask sticker set. The format of the thumbnail file must match the format of the stickers in the set. Returns *True* on success. | ||
| Params.SetStickerSetThumbnailParams, | ||
| boolean | ||
| true | ||
| > | ||
@@ -971,3 +935,3 @@ /** | ||
| Params.SetCustomEmojiStickerSetThumbnailParams, | ||
| boolean | ||
| true | ||
| > | ||
@@ -979,3 +943,3 @@ /** | ||
| */ | ||
| deleteStickerSet: CallApi<Params.DeleteStickerSetParams, boolean> | ||
| deleteStickerSet: CallApi<Params.DeleteStickerSetParams, true> | ||
| /** | ||
@@ -989,3 +953,3 @@ * Use this method to send answers to an inline query. On success, *True* is returned. | ||
| Params.AnswerInlineQueryParams, | ||
| boolean | ||
| true | ||
| > | ||
@@ -1026,3 +990,3 @@ /** | ||
| Params.AnswerShippingQueryParams, | ||
| boolean | ||
| true | ||
| > | ||
@@ -1036,3 +1000,3 @@ /** | ||
| Params.AnswerPreCheckoutQueryParams, | ||
| boolean | ||
| true | ||
| > | ||
@@ -1046,3 +1010,3 @@ /** | ||
| */ | ||
| setPassportDataErrors: CallApi<Params.SetPassportDataErrorsParams, boolean> | ||
| setPassportDataErrors: CallApi<Params.SetPassportDataErrorsParams, true> | ||
| /** | ||
@@ -1064,3 +1028,3 @@ * Use this method to send a game. On success, the sent [Message](https://core.telegram.org/bots/api/#message) is returned. | ||
| Params.SetGameScoreParams, | ||
| Objects.TelegramMessage | boolean | ||
| Objects.TelegramMessage | true | ||
| > | ||
@@ -1067,0 +1031,0 @@ /** |
| { | ||
| "name": "@gramio/types", | ||
| "version": "7.0.5", | ||
| "version": "7.0.6", | ||
| "homepage": "https://github.com/gramiojs/types", | ||
@@ -5,0 +5,0 @@ "readme": "https://github.com/gramiojs/types", |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Worsened metrics
- Total package byte prevSize
- decreased by-0.12%
378903
- Lines of code
- decreased by-0.39%
9214