users.go

package tgot

import (
	"github.com/karalef/tgot/api"
	"github.com/karalef/tgot/api/tg"
)

// WithUser creates a new User from context and user id.
// It copies the context but resets the context parameters.
func WithUser(ctx BaseContext, userID tg.ID) *User {
	return &User{
		context: ctx.ctx().with(api.NewData().SetID("user_id", userID)),
		id:      userID,
	}
}

var _ Context[*User] = &User{}

// Users contains methods for working with user.
type User struct {
	*context
	id tg.ID
}

// WithName implements Context.
func (u *User) WithName(name string) *User {
	return &User{
		context: u.context.child(name),
		id:      u.id,
	}
}

// WithChat returns ChatMember with provided chat id.
func (u *User) WithChat(chatID ChatID) *ChatMember {
	return WithChatMember(u, chatID, u.id)
}

// GetPhotos returns a list of profile pictures for a user.
func (u *User) GetPhotos() (*tg.UserProfilePhotos, error) {
	return method[*tg.UserProfilePhotos](u, "getUserProfilePhotos")
}

// SetEmojiStatus changes the emoji status for a given user that previously
// allowed the bot to manage their emoji status via the Mini App method
// [requestEmojiStatusAccess].
func (u *User) SetEmojiStatus(id string, expires int64) error {
	return u.method("setUserEmojiStatus", api.NewData().
		Set("emoji_status_custom_emoji_id", id).
		SetInt64("emoji_status_expiration_date", expires))
}

// RefundStarPayment refunds a successful payment in Telegram Stars.
func (u *User) RefundStarPayment(chargeID string) error {
	return u.method("refundStarPayment", api.NewData().
		Set("telegram_payment_charge_id", chargeID))
}

// EditStarSubscription cancels or re-enables extension of a subscription paid
// in Telegram Stars.
func (u *User) EditStarSubscription(chargeID string, isCancelled bool) error {
	return u.method("editUserStarSubscription", api.NewData().
		Set("telegram_payment_charge_id", chargeID).
		SetBool("is_canceled", isCancelled))
}

// UploadStickerFile uploads a .PNG file with a sticker for later use
// in createNewStickerSet and addStickerToSet methods.
func (u *User) UploadStickerFile(
	sticker *tg.InputFile,
	format tg.StickerFormat,
) (*tg.File, error) {
	return method[*tg.File](u, "uploadStickerFile", api.NewData().
		SetFile("sticker", sticker).
		Set("sticker_format", string(format)))
}

// PreparedInlineMessage is used to save prepared inline message.
type PreparedInlineMessage struct {
	Result            tg.InlineQueryResulter `tg:"result"`
	AllowUserChats    bool                   `tg:"allow_user_chats"`
	AllowBotChats     bool                   `tg:"allow_bot_chats"`
	AllowGroupChats   bool                   `tg:"allow_group_chats"`
	AllowChannelChats bool                   `tg:"allow_channel_chats"`
}

// SavePreparedInlineMessage stores a message that can be sent by a user of a
// Mini App.
func (u *User) SavePreparedInlineMessage(
	p PreparedInlineMessage,
) (*tg.PreparedInlineMessage, error) {
	d := api.NewDataFrom(p)
	return method[*tg.PreparedInlineMessage](u, "savePreparedInlineMessage", d)
}

// Verify verifies a user on behalf of the organization which is represented by
// the bot.
func (u *User) Verify(desc string) error {
	return u.method("verifyUser", api.NewData().Set("custom_description", desc))
}

// RemoveVerification removes verification from a user who is currently
// verified on behalf of the organization represented by the bot.
func (u *User) RemoveVerification() error {
	return u.method("removeUserVerification")
}

// Premium is used in [User.GiftPremium] method.
type Premium struct {
	MonthCount uint               `tg:"month_count"` // 3/6/12
	StarCount  uint               `tg:"star_count"`  // 1000/1500/2500
	Text       string             `tg:"text"`
	ParseMode  tg.ParseMode       `tg:"text_parse_mode"`
	Entities   []tg.MessageEntity `tg:"text_entities"`
}

// GiftPremium gifts a Telegram Premium subscription to the given user.
func (u *User) GiftPremium(p Premium) error {
	return u.method("giftPremiumSubscription", api.NewDataFrom(p))
}

// SetPassportDataErrors informs a user that some of the Telegram Passport
// elements they provided contains errors.The user will not be able to re-submit
// their Passport to you until the errors are fixed.
func (u *User) SetPassportDataErrors(errs []tg.PassportElementError) error {
	return u.method("setPassportDataErrors", api.NewData().
		SetJSON("errors", errs))
}