Merge pull request #60 from OvyFlash/bot-api-8.0

BotAPI 8.0 implementation

Author: OvyFlash

configs.go

@@ -1331,6 +1331,30 @@ func (config UserProfilePhotosConfig) params() (Params, error) {
 	return params, nil
 }
 
+// SetUserEmojiStatusConfig changes the emoji status for a given user that
+// previously allowed the bot to manage their emoji status via
+// the Mini App method requestEmojiStatusAccess.
+// Returns True on success.
+type SetUserEmojiStatusConfig struct {
+	UserID                    int64 // required
+	EmojiStatusCustomEmojiID  string
+	EmojiStatusExpirationDate int64
+}
+
+func (SetUserEmojiStatusConfig) method() string {
+	return "setUserEmojiStatus"
+}
+
+func (config SetUserEmojiStatusConfig) params() (Params, error) {
+	params := make(Params)
+
+	params.AddNonZero64("user_id", config.UserID)
+	params.AddNonEmpty("emoji_status_custom_emoji_id", config.EmojiStatusCustomEmojiID)
+	params.AddNonZero64("emoji_status_expiration_date	", config.EmojiStatusExpirationDate)
+
+	return params, nil
+}
+
 // FileConfig has information about a file hosted on Telegram.
 type FileConfig struct {
 	FileID string
@@ -1497,6 +1521,38 @@ func (config AnswerWebAppQueryConfig) params() (Params, error) {
 	return params, err
 }
 
+// SavePreparedInlineMessageConfig stores a message that can be sent by a user of a Mini App.
+// Returns a PreparedInlineMessage object.
+type SavePreparedInlineMessageConfig[T InlineQueryResults] struct {
+	UserID            int64 // required
+	Result            T     // required
+	AllowUserChats    bool
+	AllowBotChats     bool
+	AllowGroupChats   bool
+	AllowChannelChats bool
+}
+
+func (config SavePreparedInlineMessageConfig[T]) method() string {
+	return "savePreparedInlineMessage"
+}
+
+func (config SavePreparedInlineMessageConfig[T]) params() (Params, error) {
+	params := make(Params)
+
+	params.AddNonZero64("user_id", config.UserID)
+	err := params.AddInterface("result", config.Result)
+	if err != nil {
+		return params, err
+	}
+
+	params.AddBool("allow_user_chats", config.AllowUserChats)
+	params.AddBool("allow_bot_chats", config.AllowBotChats)
+	params.AddBool("allow_group_chats", config.AllowGroupChats)
+	params.AddBool("allow_channel_chats", config.AllowChannelChats)
+
+	return params, err
+}
+
 // CallbackConfig contains information on making a CallbackQuery response.
 type CallbackConfig struct {
 	CallbackQueryID string `json:"callback_query_id"`
@@ -2087,12 +2143,14 @@ func (config InvoiceConfig) method() string {
 
 // InvoiceLinkConfig contains information for createInvoiceLink method
 type InvoiceLinkConfig struct {
+	BusinessConnectionID      BusinessConnectionID
 	Title                     string         // Required
 	Description               string         // Required
 	Payload                   string         // Required
 	ProviderToken             string         // Required
 	Currency                  string         // Required
 	Prices                    []LabeledPrice // Required
+	SubscriptionPeriod        int
 	MaxTipAmount              int
 	SuggestedTipAmounts       []int
 	ProviderData              string
@@ -2110,7 +2168,10 @@ type InvoiceLinkConfig struct {
 }
 
 func (config InvoiceLinkConfig) params() (Params, error) {
-	params := make(Params)
+	params, err := config.BusinessConnectionID.params()
+	if err != nil {
+		return params, err
+	}
 
 	params["title"] = config.Title
 	params["description"] = config.Description
@@ -2120,6 +2181,7 @@ func (config InvoiceLinkConfig) params() (Params, error) {
 		return params, err
 	}
 
+	params.AddNonZero("subscription_period", config.SubscriptionPeriod)
 	params.AddNonEmpty("provider_token", config.ProviderToken)
 	params.AddNonZero("max_tip_amount", config.MaxTipAmount)
 	if len(config.SuggestedTipAmounts) > 0 {
@@ -2233,6 +2295,28 @@ func (config RefundStarPaymentConfig) params() (Params, error) {
 	return params, nil
 }
 
+// EditUserStarSubscriptionConfig allows the bot to cancel or re-enable extension
+// of a subscription paid in Telegram Stars. Returns True on success.
+type EditUserStarSubscriptionConfig struct {
+	UserID                  int64  // required
+	TelegramPaymentChargeID string // required
+	IsCanceled              bool   // required
+}
+
+func (config EditUserStarSubscriptionConfig) method() string {
+	return "editUserStarSubscription"
+}
+
+func (config EditUserStarSubscriptionConfig) params() (Params, error) {
+	params := make(Params)
+
+	params["telegram_payment_charge_id"] = config.TelegramPaymentChargeID
+	params.AddNonZero64("user_id", config.UserID)
+	params.AddBool("is_canceled", config.IsCanceled)
+
+	return params, nil
+}
+
 // DeleteMessageConfig contains information of a message in a chat to delete.
 type DeleteMessageConfig struct {
 	BaseChatMessage
@@ -2259,6 +2343,54 @@ func (config DeleteMessagesConfig) params() (Params, error) {
 	return config.BaseChatMessages.params()
 }
 
+// GetAvailableGiftsConfig returns the list of gifts that can be sent by the bot
+// to users and channel chats. Requires no parameters. Returns a Gifts object.
+type GetAvailableGiftsConfig struct{}
+
+func (config GetAvailableGiftsConfig) method() string {
+	return "getAvailableGifts"
+}
+
+func (config GetAvailableGiftsConfig) params() (Params, error) {
+	return nil, nil
+}
+
+// SendGiftConfig sends a gift to the given user or channel chat.
+// The gift can't be converted to Telegram Stars by the receiver.
+// Returns True on success.
+type SendGiftConfig struct {
+	UserID        int64
+	Chat          ChatConfig
+	GiftID        string // required
+	PayForUpgrade bool
+	Text          string
+	TextParseMode string
+	TextEntities  []MessageEntity
+}
+
+func (config SendGiftConfig) method() string {
+	return "sendGift"
+}
+
+func (config SendGiftConfig) params() (Params, error) {
+	params := make(Params)
+	params.AddNonZero64("user_id", config.UserID)
+
+	p1, err := config.Chat.params()
+	if err != nil {
+		return params, err
+	}
+	params.Merge(p1)
+
+	params.AddNonEmpty("gift_id", config.GiftID)
+	params.AddBool("pay_for_upgrade", config.PayForUpgrade)
+	params.AddNonEmpty("text", config.Text)
+	params.AddNonEmpty("text_parse_mode", config.Text)
+	params.AddInterface("text_entities", config.TextEntities)
+
+	return params, nil
+}
+
 // PinChatMessageConfig contains information of a message in a chat to pin.
 type PinChatMessageConfig struct {
 	BaseChatMessage

helper_methods.go

@@ -345,6 +345,17 @@ func NewUserProfilePhotos(userID int64) UserProfilePhotosConfig {
 	}
 }
 
+// NewSetUserEmojiStatus changes the user's emoji status.
+//
+// userID is the ID of the user you wish to get profile photos from.
+func NewSetUserEmojiStatus(userID int64, emojiID string, statusExpDate int64) SetUserEmojiStatusConfig {
+	return SetUserEmojiStatusConfig{
+		UserID:                    userID,
+		EmojiStatusCustomEmojiID:  emojiID,
+		EmojiStatusExpirationDate: statusExpDate,
+	}
+}
+
 // NewUpdate gets updates since the last Offset.
 //
 // offset is the last Update ID to include.

types.go

@@ -3226,6 +3226,38 @@ type ForumTopic struct {
 	IconCustomEmojiID string `json:"icon_custom_emoji_id,omitempty"`
 }
 
+// Gift object represents a gift that can be sent by the bot.
+type Gift struct {
+	// ID is an unique identifier of the gift
+	ID string `json:"id"`
+	// Sticker is the sticker that represents the gift
+	Sticker Sticker `json:"sticker"`
+	// StarCount is the number of Telegram Stars that
+	// must be paid to send the sticker
+	StarCount int `json:"star_count"`
+	// UpgradeStarCount is the number of Telegram Stars that
+	// must be paid to upgrade the gift to a unique one
+	//
+	// optional
+	UpgradeStarCount int `json:"upgrade_star_count,omitempty"`
+	// TotalCount is the total number of the gifts of this type that
+	// can be sent; for limited gifts only
+	//
+	// optional
+	TotalCount int `json:"total_count,omitempty"`
+	// RemainingCount is the number of remaining gifts of this type that
+	// can be sent; for limited gifts only
+	//
+	// optional
+	RemainingCount int `json:"remaining_count,omitempty"`
+}
+
+// Gifts object represents a list of gifts.
+type Gifts struct {
+	// Gifts is the list of gifts
+	Gifts []Gift `json:"gifts"`
+}
+
 // BotCommand represents a bot command.
 type BotCommand struct {
 	// Command text of the command, 1-32 characters.
@@ -3993,6 +4025,29 @@ type InlineQuery struct {
 	Location *Location `json:"location,omitempty"`
 }
 
+// InlineQueryResults defines a type constraint interface that includes all valid
+// inline query result types supported by the Telegram Bot API. This interface
+// allows methods to accept any of these result types, enabling strict type checking
+// and ensuring only supported inline query results are used.
+type InlineQueryResults interface {
+	InlineQueryResultCachedAudio |
+		InlineQueryResultCachedDocument |
+		InlineQueryResultCachedPhoto |
+		InlineQueryResultCachedSticker |
+		InlineQueryResultCachedVideo |
+		InlineQueryResultCachedVoice |
+		InlineQueryResultArticle |
+		InlineQueryResultAudio |
+		InlineQueryResultContact |
+		InlineQueryResultGame |
+		InlineQueryResultDocument |
+		InlineQueryResultLocation |
+		InlineQueryResultPhoto |
+		InlineQueryResultVenue |
+		InlineQueryResultVideo |
+		InlineQueryResultVoice
+}
+
 // InlineQueryResultCachedAudio is an inline query response with cached audio.
 type InlineQueryResultCachedAudio struct {
 	// Type of the result, must be audio
@@ -4862,6 +4917,15 @@ type SentWebAppMessage struct {
 	InlineMessageID string `json:"inline_message_id,omitempty"`
 }
 
+// PreparedInlineMessage describes an inline message to be sent by a user of a Mini App.
+type PreparedInlineMessage struct {
+	// ID is an unique identifier of the prepared message
+	ID string `json:"id"`
+	// ExpirationDate of the prepared message, in Unix time.
+	// Expired prepared messages can no longer be used
+	ExpirationDate int64 `json:"expiration_date"`
+}
+
 // InputTextMessageContent contains text for displaying
 // as an inline query result.
 type InputTextMessageContent struct {
@@ -5138,6 +5202,19 @@ type SuccessfulPayment struct {
 	TotalAmount int `json:"total_amount"`
 	// InvoicePayload bot specified invoice payload
 	InvoicePayload string `json:"invoice_payload"`
+	// SubscriptionExpirationDate is an expiration date of the subscription,
+	// in Unix time; for recurring payments only
+	//
+	// optional
+	SubscriptionExpirationDate int64 `json:"subscription_expiration_date,omitempty"`
+	// IsRecurring is True, if the payment is a recurring payment for a subscription
+	//
+	// optional
+	IsRecurring bool `json:"is_recurring,omitempty"`
+	// IsFirstRecurring is True, if the payment is the first payment for a subscription
+	//
+	// optional
+	IsFirstRecurring bool `json:"is_first_recurring,omitempty"`
 	// ShippingOptionID identifier of the shipping option chosen by the user
 	//
 	// optional
@@ -5266,12 +5343,24 @@ type TransactionPartner struct {
 	//
 	// optional
 	InvoicePayload string `json:"invoice_payload,omitempty"`
+	// SubscriptionPeriod is the duration of the paid subscription.
+	// Can be available only for “invoice_payment” transactions.
+	// Represent only in "user" state
+	//
+	// optional
+	SubscriptionPeriod int64 `json:"subscription_period,omitempty"`
 	// PaidMedia is the nformation about the paid media
 	// bought by the user
 	// Represent only in "user" state
 	//
 	// optional
 	PaidMedia []PaidMedia `json:"paid_media,omitempty"`
+	// Gift is the gift sent to the user by the bot;
+	// for “gift_purchase” transactions only
+	// Represent only in "user" state
+	//
+	// optional
+	Gift *Gift `json:"gift,omitempty"`
 	// RequestCount is the number of successful requests that
 	// exceeded regular limits and were therefore billed
 	// Represent only in "telegram_api" state

types_test.go

@@ -297,6 +297,7 @@ var (
 	_ Chattable = DeleteChatPhotoConfig{}
 	_ Chattable = DeleteChatStickerSetConfig{}
 	_ Chattable = DeleteMessageConfig{}
+	_ Chattable = GetAvailableGiftsConfig{}
 	_ Chattable = DeleteMyCommandsConfig{}
 	_ Chattable = DeleteWebhookConfig{}
 	_ Chattable = DocumentConfig{}
@@ -347,6 +348,7 @@ var (
 	_ Chattable = UpdateConfig{}
 	_ Chattable = SetMessageReactionConfig{}
 	_ Chattable = UserProfilePhotosConfig{}
+	_ Chattable = SetUserEmojiStatusConfig{}
 	_ Chattable = VenueConfig{}
 	_ Chattable = VideoConfig{}
 	_ Chattable = VideoNoteConfig{}