/*

* Echotron

* Copyright (C) 2018-2022 The Echotron Devs

*

* Echotron is free software: you can redistribute it and/or modify

* it under the terms of the GNU Lesser General Public License as published by

* the Free Software Foundation, either version 3 of the License, or

* (at your option) any later version.

*

* Echotron is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

* GNU General Public License for more details.

*

* You should have received a copy of the GNU General Public License

* along with this program. If not, see <http://www.gnu.org/licenses/>.

*/

package echotron

// ParseMode is a custom type for the various frequent options used by some methods of the API.

type ParseMode string

// These are all the possible options that can be used by some methods.

const (

Markdown ParseMode = "Markdown"

MarkdownV2 = "MarkdownV2"

HTML = "HTML"

)

// PollType is a custom type for the various types of poll that can be sent.

type PollType string

// These are all the possible poll types.

const (

Quiz PollType = "quiz"

Regular = "regular"

Any = ""

)

// DiceEmoji is a custom type for the various emojis that can be sent through the SendDice method.

type DiceEmoji string

// These are all the possible emojis that can be sent through the SendDice method.

const (

Die DiceEmoji = "🎲"

Darts = "🎯"

Basket = "🏀"

Goal = "⚽️"

Bowling = "🎳"

Slot = "🎰"

)

// ChatAction is a custom type for the various actions that can be sent through the SendChatAction method.

type ChatAction string

// These are all the possible actions that can be sent through the SendChatAction method.

const (

Typing ChatAction = "typing"

UploadPhoto = "upload_photo"

RecordVideo = "record_video"

UploadVideo = "upload_video"

RecordAudio = "record_audio"

UploadAudio = "upload_audio"

UploadDocument = "upload_document"

FindLocation = "find_location"

RecordVideoNote = "record_video_note"

UploadVideoNote = "upload_video_note"

ChooseSticker = "choose_sticker"

)

// MessageEntityType is a custom type for the various MessageEntity types used in various methods.

type MessageEntityType string

// These are all the possible types for MessageEntityType.

const (

MentionEntity MessageEntityType = "mention"

HashtagEntity = "hashtag"

CashtagEntity = "cashtag"

BotCommandEntity = "bot_command"

UrlEntity = "url"

EmailEntity = "email"

PhoneNumberEntity = "phone_number"

BoldEntity = "bold"

ItalicEntity = "italic"

UnderlineEntity = "underline"

StrikethroughEntity = "strikethrough"

SpoilerEntity = "spoiler"

BlockQuoteEntity = "blockquote"

ExpandableBlockQuoteEntity = "expandable_blockquote"

CodeEntity = "code"

PreEntity = "pre"

TextLinkEntity = "text_link"

TextMentionEntity = "text_mention"

CustomEmojiEntity = "custom_emoji"

)

// UpdateType is a custom type for the various update types that a bot can be subscribed to.

type UpdateType string

// These are all the possible types that a bot can be subscribed to.

const (

MessageUpdate UpdateType = "message"

EditedMessageUpdate = "edited_message"

ChannelPostUpdate = "channel_post"

EditedChannelPostUpdate = "edited_channel_post"

InlineQueryUpdate = "inline_query"

ChosenInlineResultUpdate = "chosen_inline_result"

CallbackQueryUpdate = "callback_query"

ShippingQueryUpdate = "shipping_query"

PreCheckoutQueryUpdate = "pre_checkout_query"

PollUpdate = "poll"

PollAnswerUpdate = "poll_answer"

MyChatMemberUpdate = "my_chat_member"

ChatMemberUpdate = "chat_member"

)

// ReplyMarkup is an interface for the various keyboard types.

type ReplyMarkup interface {

ImplementsReplyMarkup()

}

// KeyboardButton represents a button in a keyboard.

type KeyboardButton struct {

}

// KeyboardButtonPollType represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed.

type KeyboardButtonPollType struct {

Type PollType `json:"type"`

}

// KeyboardButtonRequestUsers defines the criteria used to request suitable users.

// The identifiers of the selected users will be shared with the bot when the corresponding button is pressed.

type KeyboardButtonRequestUsers struct {

}

// KeyboardButtonRequestChat defines the criteria used to request a suitable chat.

// The identifier of the selected chat will be shared with the bot when the corresponding button is pressed.

type KeyboardButtonRequestChat struct {

}

// ReplyKeyboardMarkup represents a custom keyboard with reply options.

type ReplyKeyboardMarkup struct {

}

// ImplementsReplyMarkup is a dummy method which exists to implement the interface ReplyMarkup.

func (i ReplyKeyboardMarkup) ImplementsReplyMarkup() {}

// ReplyKeyboardRemove is used to remove the current custom keyboard and display the default letter-keyboard.

// By default, custom keyboards are displayed until a new keyboard is sent by a bot.

// An exception is made for one-time keyboards that are hidden immediately after the user presses a button (see ReplyKeyboardMarkup).

// RemoveKeyboard MUST BE true.

type ReplyKeyboardRemove struct {

RemoveKeyboard bool `json:"remove_keyboard"`

Selective bool `json:"selective"`

}

// ImplementsReplyMarkup is a dummy method which exists to implement the interface ReplyMarkup.

func (r ReplyKeyboardRemove) ImplementsReplyMarkup() {}

// InlineKeyboardButton represents a button in an inline keyboard.

type InlineKeyboardButton struct {

}

// InlineKeyboardMarkup represents an inline keyboard.

type InlineKeyboardMarkup struct {

InlineKeyboard [][]InlineKeyboardButton `json:"inline_keyboard" query:"inline_keyboard"`

}

// ImplementsReplyMarkup is a dummy method which exists to implement the interface ReplyMarkup.

func (i InlineKeyboardMarkup) ImplementsReplyMarkup() {}

// ForceReply is used to display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply').

// This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode.

type ForceReply struct {

}

// ImplementsReplyMarkup is a dummy method which exists to implement the interface ReplyMarkup.

func (f ForceReply) ImplementsReplyMarkup() {}

// UpdateOptions contains the optional parameters used by the GetUpdates method.

type UpdateOptions struct {

}

// WebhookOptions contains the optional parameters used by the SetWebhook method.

type WebhookOptions struct {

}

// BaseOptions contains the optional parameters used frequently in some Telegram API methods.

type BaseOptions struct {

}

// MessageOptions contains the optional parameters used by some Telegram API methods.

type MessageOptions struct {

}

// PinMessageOptions contains the optional parameters used by the PinChatMember method.

type PinMessageOptions struct {

BusinessConnectionID string `query:"business_connection_id"`

DisableNotification bool `query:"disable_notification"`

}

// UnpinMessageOptions contains the optional parameters used by the UnpinChatMember method.

type UnpinMessageOptions struct {

BusinessConnectionID string `query:"business_connection_id"`

MessageID int `query:"message_id"`

}

// ForwardOptions contains the optional parameters used by the ForwardMessage method.

type ForwardOptions struct {

}

// CopyOptions contains the optional parameters used by the CopyMessage method.

type CopyOptions struct {

}

// CopyMessagesOptions contains the optional parameters used by the CopyMessages methods.

type CopyMessagesOptions struct {

}

// StickerOptions contains the optional parameters used by the SendSticker method.

type StickerOptions struct {

}

// InputFile is a struct which contains data about a file to be sent.

type InputFile struct {

}

// NewInputFileID is a wrapper for InputFile which only fills the id field.

func NewInputFileID(ID string) InputFile {

return InputFile{id: ID}

}

// NewInputFilePath is a wrapper for InputFile which only fills the path field.

func NewInputFilePath(filePath string) InputFile {

return InputFile{path: filePath}

}

// NewInputFileURL is a wrapper for InputFile which only fills the url field.

func NewInputFileURL(url string) InputFile {

return InputFile{url: url}

}

// NewInputFileBytes is a wrapper for InputFile which only fills the path and content fields.

func NewInputFileBytes(fileName string, content []byte) InputFile {

return InputFile{path: fileName, content: content}

}

// PhotoOptions contains the optional parameters used by the SendPhoto method.

type PhotoOptions struct {

}

// AudioOptions contains the optional parameters used by the SendAudio method.

type AudioOptions struct {

}

// DocumentOptions contains the optional parameters used by the SendDocument method.

type DocumentOptions struct {

}

// VideoOptions contains the optional parameters used by the SendVideo method.

type VideoOptions struct {

}

// AnimationOptions contains the optional parameters used by the SendAnimation method.

type AnimationOptions struct {

}

// VoiceOptions contains the optional parameters used by the SendVoice method.

type VoiceOptions struct {

}

// VideoNoteOptions contains the optional parameters used by the SendVideoNote method.

type VideoNoteOptions struct {

}

// PaidMediaOptions contains the optional parameters used by the SendPaidMedia method.

type PaidMediaOptions struct {

}

// MediaGroupOptions contains the optional parameters used by the SendMediaGroup method.

type MediaGroupOptions struct {

}

// This is a custom constant to set an infinite live period value in LocationOptions and EditLocationOptions.

const InfiniteLivePeriod = 0x7FFFFFFF

// LocationOptions contains the optional parameters used by the SendLocation method.

type LocationOptions struct {

}

// EditLocationOptions contains the optional parameters used by the EditMessageLiveLocation method.

type EditLocationOptions struct {

}

// StopLocationOptions contains the optional parameters used by the StopMessageLiveLocation method.

type StopLocationOptions struct {

ReplyMarkup ReplyMarkup `query:"reply_markup"`

BusinessConnectionID string `query:"business_connection_id"`

}

// VenueOptions contains the optional parameters used by the SendVenue method.

type VenueOptions struct {

}

// ContactOptions contains the optional parameters used by the SendContact method.

type ContactOptions struct {

}

// PollOptions contains the optional parameters used by the SendPoll method.

type PollOptions struct {

}

// StopPollOptions contains the optional parameters used by the StopPoll method.

type StopPollOptions struct {

ReplyMarkup ReplyMarkup `query:"reply_markup"`

BusinessConnectionID string `query:"business_connection_id"`

}

// BanOptions contains the optional parameters used by the BanChatMember method.

type BanOptions struct {

UntilDate int `query:"until_date"`

RevokeMessages bool `query:"revoke_messages"`

}

// UnbanOptions contains the optional parameters used by the UnbanChatMember method.

type UnbanOptions struct {

OnlyIfBanned bool `query:"only_if_banned"`

}

// RestrictOptions contains the optional parameters used by the RestrictChatMember method.

type RestrictOptions struct {

UseIndependentChatPermissions bool `query:"use_independent_chat_permissions"`

UntilDate int `query:"until_date"`

}

// PromoteOptions contains the optional parameters used by the PromoteChatMember method.

type PromoteOptions struct {

}

// UserProfileOptions contains the optional parameters used by the GetUserProfilePhotos method.

type UserProfileOptions struct {

Offset int `query:"offset"`

Limit int `query:"limit"`

}

// ChatPermissionsOptions contains the optional parameters used by the SetChatPermissions method.

type ChatPermissionsOptions struct {

UseIndependentChatPermissions bool `query:"use_independent_chat_permissions"`

}

// InviteLinkOptions contains the optional parameters used by the CreateChatInviteLink and EditChatInviteLink methods.

type InviteLinkOptions struct {

}

// ChatSubscriptionInviteOptions contains the optional parameters used by the CreateChatSubscriptionInviteLink and EditChatSubscriptionInviteLink methods.

type ChatSubscriptionInviteOptions struct {

Name string `query:"name"`

}

// CallbackQueryOptions contains the optional parameters used by the AnswerCallbackQuery method.

type CallbackQueryOptions struct {

}

// MessageIDOptions is a struct which contains data about a message to edit.

type MessageIDOptions struct {

}

// NewMessageID is a wrapper for MessageIDOptions which only fills the chatID and messageID fields.

func NewMessageID(chatID int64, messageID int) MessageIDOptions {

return MessageIDOptions{chatID: chatID, messageID: messageID}

}

// NewInlineMessageID is a wrapper for MessageIDOptions which only fills the inlineMessageID fields.

func NewInlineMessageID(ID string) MessageIDOptions {

return MessageIDOptions{inlineMessageID: ID}

}

// MessageTextOptions contains the optional parameters used by the EditMessageText method.

type MessageTextOptions struct {

}

// MessageCaptionOptions contains the optional parameters used by the EditMessageCaption method.

type MessageCaptionOptions struct {

}

// MessageMediaOptions contains the optional parameters used by the EditMessageMedia method.

type MessageMediaOptions struct {

ReplyMarkup ReplyMarkup `query:"reply_markup"`

BusinessConnectionID string `query:"business_connection_id"`

}

// MessageReplyMarkupOptions contains the optional parameters used by the EditMessageReplyMarkup method.

type MessageReplyMarkupOptions struct {

BusinessConnectionID string `query:"business_connection_id"`

ReplyMarkup InlineKeyboardMarkup `query:"reply_markup"`

}

// CommandOptions contains the optional parameters used by the SetMyCommands, DeleteMyCommands and GetMyCommands methods.

type CommandOptions struct {

LanguageCode string `query:"language_code"`

Scope BotCommandScope `query:"scope"`

}

// InvoiceOptions contains the optional parameters used by the SendInvoice API method.

type InvoiceOptions struct {

}

// CreateInvoiceLinkOptions contains the optional parameters used by the CreateInvoiceLink API method.

type CreateInvoiceLinkOptions struct {

}

// ShippingOption represents one shipping option.

type ShippingOption struct {

}

// ShippingQueryOptions contains the optional parameters used by the AnswerShippingQuery API method.

type ShippingQueryOptions struct {

ErrorMessage string `query:"error_message"`

ShippingOptions []ShippingOption `query:"shipping_options"`

}

// PreCheckoutOptions contains the optional parameters used by the AnswerPreCheckoutQuery API method.

type PreCheckoutOptions struct {

ErrorMessage string `query:"error_message"`

}

// CreateTopicOptions contains the optional parameters used by the CreateForumTopic API method.

type CreateTopicOptions struct {

IconCustomEmojiID string `query:"icon_custom_emoji_id"`

IconColor IconColor `query:"icon_color"`

}

// EditTopicOptions contains the optional parameters used by the EditForumTopic API method.

type EditTopicOptions struct {

Name string `query:"name"`

IconCustomEmojiID string `query:"icon_custom_emoji_id"`

}

// ChatActionOptions contains the optional parameters used by the SendChatAction API method.

type ChatActionOptions struct {

BusinessConnectionID string `query:"business_connection_id"`

MessageThreadID int `query:"message_thread_id"`

}

// MessageReactionOptions contains the optional parameters used by the SetMessageReaction API method.

type MessageReactionOptions struct {

Reaction []ReactionType `query:"reaction"`

IsBig bool `query:"is_big"`

}