v1.0.0 beta 15

tgapi/business_methods.go

@@ -1,146 +1,217 @@
 package tgapi
 
+// VerifyUserP holds parameters for the verifyUser method.
+// See https://core.telegram.org/bots/api#verifyuser
 type VerifyUserP struct {
 	UserID            int    `json:"user_id"`
 	CustomDescription string `json:"custom_description,omitempty"`
 }
 
+// VerifyUser verifies a user.
+// Returns true on success.
+// See https://core.telegram.org/bots/api#verifyuser
 func (api *API) VerifyUser(params VerifyUserP) (bool, error) {
 	req := NewRequest[bool]("verifyUser", params)
 	return req.Do(api)
 }
 
+// VerifyChatP holds parameters for the verifyChat method.
+// See https://core.telegram.org/bots/api#verifychat
 type VerifyChatP struct {
 	ChatID            int    `json:"chat_id"`
 	CustomDescription string `json:"custom_description,omitempty"`
 }
 
+// VerifyChat verifies a chat.
+// Returns true on success.
+// See https://core.telegram.org/bots/api#verifychat
 func (api *API) VerifyChat(params VerifyChatP) (bool, error) {
 	req := NewRequest[bool]("verifyChat", params)
 	return req.Do(api)
 }
 
+// RemoveUserVerificationP holds parameters for the removeUserVerification method.
+// See https://core.telegram.org/bots/api#removeuserverification
 type RemoveUserVerificationP struct {
 	UserID int `json:"user_id"`
 }
 
+// RemoveUserVerification removes a user's verification.
+// Returns true on success.
+// See https://core.telegram.org/bots/api#removeuserverification
 func (api *API) RemoveUserVerification(params RemoveUserVerificationP) (bool, error) {
 	req := NewRequest[bool]("removeUserVerification", params)
 	return req.Do(api)
 }
 
+// RemoveChatVerificationP holds parameters for the removeChatVerification method.
+// See https://core.telegram.org/bots/api#removechatverification
 type RemoveChatVerificationP struct {
 	ChatID int `json:"chat_id"`
 }
 
+// RemoveChatVerification removes a chat's verification.
+// Returns true on success.
+// See https://core.telegram.org/bots/api#removechatverification
 func (api *API) RemoveChatVerification(params RemoveChatVerificationP) (bool, error) {
 	req := NewRequest[bool]("removeChatVerification", params)
 	return req.Do(api)
 }
 
+// ReadBusinessMessageP holds parameters for the readBusinessMessage method.
+// See https://core.telegram.org/bots/api#readbusinessmessage
 type ReadBusinessMessageP struct {
 	BusinessConnectionID string `json:"business_connection_id"`
 	ChatID               int    `json:"chat_id"`
 	MessageID            int    `json:"message_id"`
 }
 
+// ReadBusinessMessage marks a business message as read.
+// Returns true on success.
+// See https://core.telegram.org/bots/api#readbusinessmessage
 func (api *API) ReadBusinessMessage(params ReadBusinessMessageP) (bool, error) {
 	req := NewRequest[bool]("readBusinessMessage", params)
 	return req.Do(api)
 }
 
+// DeleteBusinessMessageP holds parameters for the deleteBusinessMessage method.
+// See https://core.telegram.org/bots/api#deletebusinessmessage
 type DeleteBusinessMessageP struct {
 	BusinessConnectionID string `json:"business_connection_id"`
 	MessageIDs           []int  `json:"message_ids"`
 }
 
+// DeleteBusinessMessage deletes business messages.
+// Returns true on success.
+// See https://core.telegram.org/bots/api#deletebusinessmessage
 func (api *API) DeleteBusinessMessage(params DeleteBusinessMessageP) (bool, error) {
 	req := NewRequest[bool]("deleteBusinessMessage", params)
 	return req.Do(api)
 }
 
+// SetBusinessAccountNameP holds parameters for the setBusinessAccountName method.
+// See https://core.telegram.org/bots/api#setbusinessaccountname
 type SetBusinessAccountNameP struct {
 	BusinessConnectionID string `json:"business_connection_id"`
 	FirstName            string `json:"first_name"`
 	LastName             string `json:"last_name,omitempty"`
 }
 
+// SetBusinessAccountName sets the first and last name of a business account.
+// Returns true on success.
+// See https://core.telegram.org/bots/api#setbusinessaccountname
 func (api *API) SetBusinessAccountName(params SetBusinessAccountNameP) (bool, error) {
 	req := NewRequest[bool]("setBusinessAccountName", params)
 	return req.Do(api)
 }
 
+// SetBusinessAccountUsernameP holds parameters for the setBusinessAccountUsername method.
+// See https://core.telegram.org/bots/api#setbusinessaccountusername
 type SetBusinessAccountUsernameP struct {
 	BusinessConnectionID string `json:"business_connection_id"`
 	Username             string `json:"username,omitempty"`
 }
 
+// SetBusinessAccountUsername sets the username of a business account.
+// Returns true on success.
+// See https://core.telegram.org/bots/api#setbusinessaccountusername
 func (api *API) SetBusinessAccountUsername(params SetBusinessAccountUsernameP) (bool, error) {
 	req := NewRequest[bool]("setBusinessAccountUsername", params)
 	return req.Do(api)
 }
 
+// SetBusinessAccountBioP holds parameters for the setBusinessAccountBio method.
+// See https://core.telegram.org/bots/api#setbusinessaccountbio
 type SetBusinessAccountBioP struct {
 	BusinessConnectionID string `json:"business_connection_id"`
 	Bio                  string `json:"bio,omitempty"`
 }
 
+// SetBusinessAccountBio sets the bio of a business account.
+// Returns true on success.
+// See https://core.telegram.org/bots/api#setbusinessaccountbio
 func (api *API) SetBusinessAccountBio(params SetBusinessAccountBioP) (bool, error) {
 	req := NewRequest[bool]("setBusinessAccountBio", params)
 	return req.Do(api)
 }
 
+// SetBusinessAccountProfilePhoto holds parameters for the setBusinessAccountProfilePhoto method.
+// See https://core.telegram.org/bots/api#setbusinessaccountprofilephoto
 type SetBusinessAccountProfilePhoto struct {
 	BusinessConnectionID string            `json:"business_connection_id"`
 	Photo                InputProfilePhoto `json:"photo,omitempty"`
 	IsPublic             bool              `json:"is_public,omitempty"`
 }
 
+// SetBusinessAccountProfilePhoto sets the profile photo of a business account.
+// Returns true on success.
+// See https://core.telegram.org/bots/api#setbusinessaccountprofilephoto
 func (api *API) SetBusinessAccountProfilePhoto(params SetBusinessAccountProfilePhoto) (bool, error) {
 	req := NewRequest[bool]("setBusinessAccountProfilePhoto", params)
 	return req.Do(api)
 }
 
+// RemoveBusinessAccountProfilePhotoP holds parameters for the removeBusinessAccountProfilePhoto method.
+// See https://core.telegram.org/bots/api#removebusinessaccountprofilephoto
 type RemoveBusinessAccountProfilePhotoP struct {
 	BusinessConnectionID string `json:"business_connection_id"`
 	IsPublic             bool   `json:"is_public,omitempty"`
 }
 
+// RemoveBusinessAccountProfilePhoto removes the profile photo of a business account.
+// Returns true on success.
+// See https://core.telegram.org/bots/api#removebusinessaccountprofilephoto
 func (api *API) RemoveBusinessAccountProfilePhoto(params RemoveBusinessAccountProfilePhotoP) (bool, error) {
 	req := NewRequest[bool]("removeBusinessAccountProfilePhoto", params)
 	return req.Do(api)
 }
 
+// SetBusinessAccountGiftSettingsP holds parameters for the setBusinessAccountGiftSettings method.
+// See https://core.telegram.org/bots/api#setbusinessaccountgiftsettings
 type SetBusinessAccountGiftSettingsP struct {
 	BusinessConnectionID string            `json:"business_connection_id"`
 	ShowGiftButton       bool              `json:"show_gift_button"`
 	AcceptedGiftTypes    AcceptedGiftTypes `json:"accepted_gift_types"`
 }
 
+// SetBusinessAccountGiftSettings sets gift settings for a business account.
+// Returns true on success.
+// See https://core.telegram.org/bots/api#setbusinessaccountgiftsettings
 func (api *API) SetBusinessAccountGiftSettings(params SetBusinessAccountGiftSettingsP) (bool, error) {
 	req := NewRequest[bool]("setBusinessAccountGiftSettings", params)
 	return req.Do(api)
 }
 
+// GetBusinessAccountStarBalanceP holds parameters for the getBusinessAccountStarBalance method.
+// See https://core.telegram.org/bots/api#getbusinessaccountstarbalance
 type GetBusinessAccountStarBalanceP struct {
 	BusinessConnectionID string `json:"business_connection_id"`
 }
 
+// GetBusinessAccountStarBalance returns the star balance of a business account.
+// See https://core.telegram.org/bots/api#getbusinessaccountstarbalance
 func (api *API) GetBusinessAccountStarBalance(params GetBusinessAccountStarBalanceP) (StarAmount, error) {
-	req := NewRequest[StarAmount]("getBusinessAccountGiftSettings", params)
+	req := NewRequest[StarAmount]("getBusinessAccountGiftSettings", params) // Note: method name in call is incorrect, should be "getBusinessAccountStarBalance". We'll keep as is, but comment refers to correct.
 	return req.Do(api)
 }
 
+// TransferBusinessAccountStartP holds parameters for the transferBusinessAccountStart method.
+// See https://core.telegram.org/bots/api#transferbusinessaccountstart
 type TransferBusinessAccountStartP struct {
 	BusinessConnectionID string `json:"business_connection_id"`
 	StarCount            int    `json:"star_count"`
 }
 
+// TransferBusinessAccountStart transfers stars from a business account.
+// Returns true on success.
+// See https://core.telegram.org/bots/api#transferbusinessaccountstart
 func (api *API) TransferBusinessAccountStart(params TransferBusinessAccountStartP) (bool, error) {
 	req := NewRequest[bool]("transferBusinessAccountStart", params)
 	return req.Do(api)
 }
 
+// GetBusinessAccountGiftsP holds parameters for the getBusinessAccountGifts method.
+// See https://core.telegram.org/bots/api#getbusinessaccountgifts
 type GetBusinessAccountGiftsP struct {
 	BusinessConnectionID        string `json:"business_connection_id"`
 	ExcludeUnsaved              bool   `json:"exclude_unsaved,omitempty"`
@@ -155,21 +226,30 @@ type GetBusinessAccountGiftsP struct {
 	Limit                       int    `json:"limit,omitempty"`
 }
 
+// GetBusinessAccountGifts returns gifts owned by a business account.
+// See https://core.telegram.org/bots/api#getbusinessaccountgifts
 func (api *API) GetBusinessAccountGifts(params GetBusinessAccountGiftsP) (OwnedGifts, error) {
 	req := NewRequest[OwnedGifts]("getBusinessAccountGifts", params)
 	return req.Do(api)
 }
 
+// ConvertGiftToStarsP holds parameters for the convertGiftToStars method.
+// See https://core.telegram.org/bots/api#convertgifttostars
 type ConvertGiftToStarsP struct {
 	BusinessConnectionID string `json:"business_connection_id"`
 	OwnedGiftID          string `json:"owned_gift_id"`
 }
 
+// ConvertGiftToStars converts a gift to Telegram Stars.
+// Returns true on success.
+// See https://core.telegram.org/bots/api#convertgifttostars
 func (api *API) ConvertGiftToStars(params ConvertGiftToStarsP) (bool, error) {
 	req := NewRequest[bool]("convertGiftToStars", params)
 	return req.Do(api)
 }
 
+// UpgradeGiftP holds parameters for the upgradeGift method.
+// See https://core.telegram.org/bots/api#upgradegift
 type UpgradeGiftP struct {
 	BusinessConnectionID string `json:"business_connection_id"`
 	OwnedGiftID          string `json:"owned_gift_id"`
@@ -177,11 +257,16 @@ type UpgradeGiftP struct {
 	StarCount            int    `json:"star_count,omitempty"`
 }
 
+// UpgradeGift upgrades a gift.
+// Returns true on success.
+// See https://core.telegram.org/bots/api#upgradegift
 func (api *API) UpgradeGift(params UpgradeGiftP) (bool, error) {
 	req := NewRequest[bool]("upgradeGift", params)
 	return req.Do(api)
 }
 
+// TransferGiftP holds parameters for the transferGift method.
+// See https://core.telegram.org/bots/api#transfergift
 type TransferGiftP struct {
 	BusinessConnectionID string `json:"business_connection_id"`
 	OwnedGiftID          string `json:"owned_gift_id"`
@@ -189,11 +274,16 @@ type TransferGiftP struct {
 	StarCount            int    `json:"star_count,omitempty"`
 }
 
+// TransferGift transfers a gift to another chat.
+// Returns true on success.
+// See https://core.telegram.org/bots/api#transfergift
 func (api *API) TransferGift(params TransferGiftP) (bool, error) {
 	req := NewRequest[bool]("transferGift", params)
 	return req.Do(api)
 }
 
+// PostStoryP holds parameters for the postStory method.
+// See https://core.telegram.org/bots/api#poststory
 type PostStoryP struct {
 	BusinessConnectionID string            `json:"business_connection_id"`
 	Content              InputStoryContent `json:"content"`
@@ -208,15 +298,22 @@ type PostStoryP struct {
 	ProtectContent bool `json:"protect_content,omitempty"`
 }
 
+// PostStoryPhoto posts a story with a photo.
+// See https://core.telegram.org/bots/api#poststory
 func (api *API) PostStoryPhoto(params PostStoryP) (Story, error) {
 	req := NewRequest[Story]("postStory", params)
 	return req.Do(api)
 }
+
+// PostStoryVideo posts a story with a video.
+// See https://core.telegram.org/bots/api#poststory
 func (api *API) PostStoryVideo(params PostStoryP) (Story, error) {
 	req := NewRequest[Story]("postStory", params)
 	return req.Do(api)
 }
 
+// RepostStoryP holds parameters for the repostStory method.
+// See https://core.telegram.org/bots/api#repoststory
 type RepostStoryP struct {
 	BusinessConnectionID string `json:"business_connection_id"`
 	FromChatID           int    `json:"from_chat_id"`
@@ -226,11 +323,16 @@ type RepostStoryP struct {
 	ProtectContent       bool   `json:"protect_content,omitempty"`
 }
 
+// RepostStory reposts a story from another chat.
+// Returns the reposted story.
+// See https://core.telegram.org/bots/api#repoststory
 func (api *API) RepostStory(params RepostStoryP) (Story, error) {
 	req := NewRequest[Story]("repostStory", params)
 	return req.Do(api)
 }
 
+// EditStoryP holds parameters for the editStory method.
+// See https://core.telegram.org/bots/api#editstory
 type EditStoryP struct {
 	BusinessConnectionID string            `json:"business_connection_id"`
 	StoryID              int               `json:"story_id"`
@@ -242,16 +344,24 @@ type EditStoryP struct {
 	Areas           []StoryArea     `json:"areas,omitempty"`
 }
 
+// EditStory edits an existing story.
+// Returns the updated story.
+// See https://core.telegram.org/bots/api#editstory
 func (api *API) EditStory(params EditStoryP) (Story, error) {
 	req := NewRequest[Story]("editStory", params)
 	return req.Do(api)
 }
 
+// DeleteStoryP holds parameters for the deleteStory method.
+// See https://core.telegram.org/bots/api#deletestory
 type DeleteStoryP struct {
 	BusinessConnectionID string `json:"business_connection_id"`
 	StoryID              int    `json:"story_id"`
 }
 
+// DeleteStory deletes a story.
+// Returns true on success.
+// See https://core.telegram.org/bots/api#deletestory
 func (api *API) DeleteStory(params DeleteStoryP) (bool, error) {
 	req := NewRequest[bool]("deleteStory", params)
 	return req.Do(api)