nyx-bot-client 0.0.2

package/@types/GeneralForumTopicHidden.ts

@@ -0,0 +1,7 @@
+/**
+ * ## GeneralForumTopicHidden
+ * This object represents a service message about General forum topic hidden in the chat. Currently holds no
+ * information.
+ * @see https://core.telegram.org/bots/api#generalforumtopichidden
+ */
+export type GeneralForumTopicHidden = Record<string, never>;

package/@types/GeneralForumTopicUnhidden.ts

@@ -0,0 +1,7 @@
+/**
+ * ## GeneralForumTopicUnhidden
+ * This object represents a service message about General forum topic unhidden in the chat. Currently holds no
+ * information.
+ * @see https://core.telegram.org/bots/api#generalforumtopicunhidden
+ */
+export type GeneralForumTopicUnhidden = Record<string, never>;

package/@types/Gift.ts

@@ -0,0 +1,38 @@
+import type { Sticker } from "./";
+
+/**
+ * ## Gift
+ * This object represents a gift that can be sent by the bot.
+ * @see https://core.telegram.org/bots/api#gift
+ */
+export type Gift = {
+	/**
+	 * Unique identifier of the gift
+	 */
+	id: string;
+
+	/**
+	 * The sticker that represents the gift
+	 */
+	sticker: Sticker;
+
+	/**
+	 * The number of Telegram Stars that must be paid to send the sticker
+	 */
+	star_count: number;
+
+	/**
+	 * Optional. The number of Telegram Stars that must be paid to upgrade the gift to a unique one
+	 */
+	upgrade_star_count?: number;
+
+	/**
+	 * Optional. The total number of the gifts of this type that can be sent; for limited gifts only
+	 */
+	total_count?: number;
+
+	/**
+	 * Optional. The number of remaining gifts of this type that can be sent; for limited gifts only
+	 */
+	remaining_count?: number;
+};

package/@types/GiftInfo.ts

@@ -0,0 +1,52 @@
+import type { Gift } from "./Gift";
+import type { MessageEntity } from "./MessageEntity";
+
+/**
+ * ## GiftInfo
+ * Describes a service message about a regular gift that was sent or received.
+ * @see https://core.telegram.org/bots/api#giftinfo
+ */
+export type GiftInfo = {
+	/**
+	 * Information about the gift
+	 */
+	gift: Gift;
+
+	/**
+	 * Optional. Unique identifier of the received gift for the bot; only present
+	 * for gifts received on behalf of business accounts
+	 */
+	owned_gift_id?: string;
+
+	/**
+	 * Optional. Number of Telegram Stars that can be claimed by the receiver by
+	 * converting the gift; omitted if conversion to Telegram Stars is impossible
+	 */
+	convert_star_count?: number;
+
+	/**
+	 * Optional. Number of Telegram Stars that were prepaid by the sender for the ability to upgrade the gift
+	 */
+	prepaid_upgrade_star_count?: number;
+
+	/**
+	 * Optional. True, if the gift can be upgraded to a unique gift
+	 */
+	can_be_upgraded?: true;
+
+	/**
+	 * Optional. Text of the message that was added to the gift
+	 */
+	text?: string;
+
+	/**
+	 * Optional. Special entities that appear in the text
+	 */
+	entities?: MessageEntity[];
+
+	/**
+	 * Optional. True, if the sender and gift text are shown only to the gift
+	 * receiver; otherwise, everyone will be able to see them
+	 */
+	is_private?: true;
+};

package/@types/Gifts.ts

@@ -0,0 +1,13 @@
+import type { Gift } from "./";
+
+/**
+ * ## Gifts
+ * This object represent a list of gifts.
+ * @see https://core.telegram.org/bots/api#gifts
+ */
+export type Gifts = {
+	/**
+	 * The list of gifts
+	 */
+	gifts: Gift[];
+};

package/@types/Giveaway.ts

@@ -0,0 +1,55 @@
+import type { Chat } from "./";
+
+/**
+ * ## Giveaway
+ * This object represents a message about a scheduled giveaway.
+ * @see https://core.telegram.org/bots/api#giveaway
+ */
+export type Giveaway = {
+	/**
+	 * The list of chats which the user must join to participate in the giveaway
+	 */
+	chat: Chat;
+
+	/**
+	 * Point in time (Unix timestamp) when winners of the giveaway will be selected
+	 */
+	winners_selection_date: number;
+
+	/**
+	 * The number of users which are supposed to be selected as winners of the giveaway
+	 */
+	winner_count?: number;
+
+	/**
+	 * Optional. True, if only users who join the chats after the giveaway started should be eligible to win
+	 */
+	only_new_members?: boolean;
+
+	/**
+	 * Optional. True, if the list of giveaway winners will be visible to everyone
+	 */
+	has_public_winners?: boolean;
+
+	/**
+	 * Optional. Description of additional giveaway prize
+	 */
+	prize_description?: string;
+
+	/**
+	 * Optional. A list of two-letter ISO 3166-1 alpha-2 country codes indicating the countries from which eligible users
+	 * for the giveaway must come. If empty, then all users can participate in the giveaway. Users with a phone number
+	 * that was bought on Fragment can always participate in giveaways.
+	 */
+	country_codes?: string[];
+
+	/**
+	 * Optional. The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only
+	 */
+	prize_star_count?: number;
+
+	/**
+	 * Optional. The number of months the Telegram Premium subscription won from the giveaway will be active for
+	 */
+	premium_subscription_month_count?: number;
+};

package/@types/GiveawayCompleted.ts

@@ -0,0 +1,29 @@
+import type { Message } from "./";
+
+/**
+ * ## GiveawayCompleted
+ * This object represents a service message about the completion of a giveaway without public winners.
+ * @see https://core.telegram.org/bots/api#giveawaycompleted
+ */
+export type GiveawayCompleted = {
+	/**
+	 * Number of winners in the giveaway
+	 */
+	winner_count: number;
+
+	/**
+	 * Optional. Number of undistributed prizes
+	 */
+	unclaimed_prize_count: number;
+
+	/**
+	 * Optional. Message with the giveaway that was completed, if it wasn't deleted
+	 */
+	giveaway_message: Message;
+
+	/**
+	 * Optional. True, if the giveaway is a Telegram Star giveaway. Otherwise, currently, the giveaway is a Telegram
+	 * Premium giveaway.
+	 */
+	is_star_giveaway: boolean;
+};

package/@types/GiveawayCreated.ts

@@ -0,0 +1,11 @@
+/**
+ * ## GiveawayCreated
+ * This object represents a service message about the creation of a scheduled giveaway.
+ * @see https://core.telegram.org/bots/api#giveawaycreated
+ */
+export type GiveawayCreated = {
+	/**
+	 * Optional. The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only
+	 */
+	prize_star_count?: number;
+};

package/@types/GiveawayWinners.ts

@@ -0,0 +1,68 @@
+import type { Chat, User } from "./";
+
+/**
+ * ## GiveawayWinners
+ * This object represents a message about the completion of a giveaway with public winners.
+ * @see https://core.telegram.org/bots/api#giveawaywinners
+ */
+export type GiveawayWinners = {
+	/**
+	 * The chat that created the giveaway
+	 */
+	chat: Chat;
+
+	/**
+	 * Identifier of the message with the giveaway in the chat
+	 */
+	giveaway_message_id: number;
+
+	/**
+	 * Point in time (Unix timestamp) when winners of the giveaway were selected
+	 */
+	winners_selection_date: number;
+
+	/**
+	 * Total number of winners in the giveaway
+	 */
+	winner_count: number;
+
+	/**
+	 * List of up to 100 winners of the giveaway
+	 */
+	winners: User[];
+
+	/**
+	 * Optional. The number of other chats the user had to join in order to be eligible for the giveaway
+	 */
+	additional_chat_count?: number;
+
+	/**
+	 * Optional. The number of Telegram Stars that were split between giveaway winners; for Telegram Star giveaways only
+	 */
+	prize_star_count?: number;
+
+	/**
+	 * Optional. The number of months the Telegram Premium subscription won from the giveaway will be active for
+	 */
+	premium_subscription_month_count?: number;
+
+	/**
+	 * Optional. Number of undistributed prizes
+	 */
+	unclaimed_prize_count?: number;
+
+	/**
+	 * Optional. True, if only users who had joined the chats after the giveaway started were eligible to win
+	 */
+	only_new_members?: boolean;
+
+	/**
+	 * Optional. True, if the giveaway was canceled because the payment for it was refunded
+	 */
+	was_refunded?: boolean;
+
+	/**
+	 * Optional. Description of additional giveaway prize
+	 */
+	prize_description?: string;
+};

package/@types/InaccessibleMessage.ts

@@ -0,0 +1,23 @@
+import type { Chat } from "./";
+
+/**
+ * ## InaccessibleMessage
+ * This object describes a message that was deleted or is otherwise inaccessible to the bot.
+ * @see https://core.telegram.org/bots/api#inaccessiblemessage
+ */
+export type InaccessibleMessage = {
+	/**
+	 * Chat the message belonged to
+	 */
+	chat: Chat;
+
+	/**
+	 * Unique message identifier inside the chat
+	 */
+	message_id: number;
+
+	/**
+	 * Always 0. The field can be used to differentiate regular and inaccessible messages.
+	 */
+	date: 0;
+};

package/@types/InlineKeyboardButton.ts

@@ -0,0 +1,88 @@
+import type {
+	CallbackGame,
+	CopyTextButton,
+	LoginUrl,
+	SwitchInlineQueryChosenChat,
+	WebAppInfo,
+} from "./";
+
+/**
+ * ## InlineKeyboardButton
+ * This object represents one button of an inline keyboard. Exactly one of the optional fields must be used to specify
+ * type of the button.
+ * @see https://core.telegram.org/bots/api#inlinekeyboardbutton
+ */
+export type InlineKeyboardButton = {
+	/**
+	 * Label text on the button
+	 */
+	text: string;
+
+	/**
+	 * Optional. HTTP or tg:// URL to be opened when the button is pressed. Links tg://user?id=<user_id> can be used to
+	 * mention a user by their identifier without using a username, if this is allowed by their privacy settings.
+	 */
+	url?: string;
+
+	/**
+	 * Optional. Data to be sent in a callback query to the bot when the button is pressed, 1-64 bytes
+	 */
+	callback_data?: string;
+
+	/**
+	 * Optional. Description of the Web App that will be launched when the user presses the button. The Web App will be
+	 * able to send an arbitrary message on behalf of the user using the method answerWebAppQuery. Available only in
+	 * private chats between a user and the bot. Not supported for messages sent on behalf of a Telegram Business account.
+	 */
+	web_app?: WebAppInfo;
+
+	/**
+	 * Optional. An HTTPS URL used to automatically authorize the user. Can be used as a replacement for the Telegram
+	 * Login Widget.
+	 */
+	login_url?: LoginUrl;
+
+	/**
+	 * Optional. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert
+	 * the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's
+	 * username will be inserted. Not supported for messages sent on behalf of a Telegram Business account.
+	 */
+	switch_inline_query?: string;
+
+	/**
+	 * Optional. If set, pressing the button will insert the bot's username and the specified inline query in the current
+	 * chat's input field. May be empty, in which case only the bot's username will be inserted.
+	 *
+	 * This offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting
+	 * something from multiple options. Not supported in channels and for messages sent on behalf of a Telegram Business
+	 * account.
+	 */
+	switch_inline_query_current_chat?: string;
+
+	/**
+	 * Optional. If set, pressing the button will prompt the user to select one of their chats of the specified type, open
+	 * that chat and insert the bot's username and the specified inline query in the input field. Not supported for
+	 * messages sent on behalf of a Telegram Business account.
+	 */
+	switch_inline_query_chosen_chat?: SwitchInlineQueryChosenChat;
+
+	/**
+	 * Optional. Description of the button that copies the specified text to the clipboard.
+	 */
+	copy_text?: CopyTextButton;
+
+	/**
+	 * Optional. Description of the game that will be launched when the user presses the button.
+	 * NOTE: This type of button must always be the first button in the first row.
+	 */
+	callback_game?: CallbackGame;
+
+	/**
+	 * Optional. Specify True, to send a Pay button. Substrings “⭐” and “XTR” in the buttons's text will be replaced with
+	 * a Telegram Star icon.
+	 *
+	 * NOTE: This type of button must always be the first button in the first row and can only be used in invoice
+	 * messages.
+	 */
+	pay?: boolean;
+};

package/@types/InlineKeyboardMarkup.ts

@@ -0,0 +1,13 @@
+import type { InlineKeyboardButton } from "./";
+
+/**
+ * ## InlineKeyboardMarkup
+ * This object represents an inline keyboard that appears right next to the message it belongs to.
+ * @see https://core.telegram.org/bots/api#inlinekeyboardmarkup
+ */
+export type InlineKeyboardMarkup = {
+	/**
+	 * Array of button rows, each represented by an Array of InlineKeyboardButton objects
+	 */
+	inline_keyboard: InlineKeyboardButton[][];
+};

package/@types/InlineQuery.ts

@@ -0,0 +1,41 @@
+import type { Location, User } from "./";
+
+/**
+ * ## InlineQuery
+ * This object represents an incoming inline query. When the user sends an empty query, your bot could return some
+ * default or trending results.
+ * @see https://core.telegram.org/bots/api#inlinequery
+ */
+export type InlineQuery = {
+	/**
+	 * Unique identifier for this query
+	 */
+	id: string;
+
+	/**
+	 * Sender
+	 */
+	from: User;
+
+	/**
+	 * Text of the query (up to 256 characters)
+	 */
+	query: string;
+
+	/**
+	 * Offset of the results to be returned, can be controlled by the bot
+	 */
+	offset: string;
+
+	/**
+	 * Optional. Type of the chat from which the inline query was sent. Can be either “sender” for a private chat with
+	 * the inline query sender, “private”, “group”, “supergroup”, or “channel”. The chat type should be always known for
+	 * requests sent from official clients and most third-party clients, unless the request was sent from a secret chat
+	 */
+	chat_type?: "sender" | "private" | "group" | "supergroup" | "channel";
+
+	/**
+	 * Optional. Sender location, only for bots that request user location
+	 */
+	location?: Location;
+};

package/@types/InlineQueryResult.ts

@@ -0,0 +1,70 @@
+import type {
+	InlineQueryResultArticle,
+	InlineQueryResultAudio,
+	InlineQueryResultCachedAudio,
+	InlineQueryResultCachedDocument,
+	InlineQueryResultCachedGif,
+	InlineQueryResultCachedMpeg4Gif,
+	InlineQueryResultCachedPhoto,
+	InlineQueryResultCachedSticker,
+	InlineQueryResultCachedVideo,
+	InlineQueryResultCachedVoice,
+	InlineQueryResultContact,
+	InlineQueryResultDocument,
+	InlineQueryResultGame,
+	InlineQueryResultGif,
+	InlineQueryResultLocation,
+	InlineQueryResultMpeg4Gif,
+	InlineQueryResultPhoto,
+	InlineQueryResultVenue,
+	InlineQueryResultVideo,
+	InlineQueryResultVoice,
+} from "./";
+
+/**
+ * ## InlineQueryResult
+ * This object represents one result of an inline query. Telegram clients currently support results of the following
+ * 20 types:
+ * - InlineQueryResultCachedAudio
+ * - InlineQueryResultCachedDocument
+ * - InlineQueryResultCachedGif
+ * - InlineQueryResultCachedMpeg4Gif
+ * - InlineQueryResultCachedPhoto
+ * - InlineQueryResultCachedSticker
+ * - InlineQueryResultCachedVideo
+ * - InlineQueryResultCachedVoice
+ * - InlineQueryResultArticle
+ * - InlineQueryResultAudio
+ * - InlineQueryResultContact
+ * - InlineQueryResultGame
+ * - InlineQueryResultDocument
+ * - InlineQueryResultGif
+ * - InlineQueryResultLocation
+ * - InlineQueryResultMpeg4Gif
+ * - InlineQueryResultPhoto
+ * - InlineQueryResultVenue
+ * - InlineQueryResultVideo
+ * - InlineQueryResultVoice
+ * @see https://core.telegram.org/bots/api#inlinequeryresult
+ */
+export type InlineQueryResult =
+	| InlineQueryResultCachedAudio
+	| InlineQueryResultCachedDocument
+	| InlineQueryResultCachedGif
+	| InlineQueryResultCachedMpeg4Gif
+	| InlineQueryResultCachedPhoto
+	| InlineQueryResultCachedSticker
+	| InlineQueryResultCachedVideo
+	| InlineQueryResultCachedVoice
+	| InlineQueryResultArticle
+	| InlineQueryResultAudio
+	| InlineQueryResultContact
+	| InlineQueryResultGame
+	| InlineQueryResultDocument
+	| InlineQueryResultGif
+	| InlineQueryResultLocation
+	| InlineQueryResultMpeg4Gif
+	| InlineQueryResultPhoto
+	| InlineQueryResultVenue
+	| InlineQueryResultVideo
+	| InlineQueryResultVoice;

package/@types/InlineQueryResultArticle.ts

@@ -0,0 +1,58 @@
+import type { InlineKeyboardMarkup, InputMessageContent } from "./";
+
+/**
+ * ## InlineQueryResultArticle
+ * Represents a link to an article or web page.
+ * @see https://core.telegram.org/bots/api#inlinequeryresultarticle
+ */
+export type InlineQueryResultArticle = {
+	/**
+	 * Type of the result, must be article
+	 */
+	type: "article";
+
+	/**
+	 * Unique identifier for this result, 1-64 Bytes
+	 */
+	id: string;
+
+	/**
+	 * Title of the result
+	 */
+	title: string;
+
+	/**
+	 * Content of the message to be sent
+	 */
+	input_message_content: InputMessageContent;
+
+	/**
+	 * Optional. Inline keyboard attached to the message
+	 */
+	reply_markup?: InlineKeyboardMarkup;
+
+	/**
+	 * Optional. URL of the result
+	 */
+	url?: string;
+
+	/**
+	 * Optional. Short description of the result
+	 */
+	description?: string;
+
+	/**
+	 * Optional. Url of the thumbnail for the result
+	 */
+	thumb_url?: string;
+
+	/**
+	 * Optional. Thumbnail width
+	 */
+	thumb_width?: number;
+
+	/**
+	 * Optional. Thumbnail height
+	 */
+	thumb_height?: number;
+};

package/@types/InlineQueryResultAudio.ts

@@ -0,0 +1,69 @@
+import type {
+	InlineKeyboardMarkup,
+	InputMessageContent,
+	MessageEntity,
+	ParseMode,
+} from "./";
+
+/**
+ * ## InlineQueryResultAudio
+ * Represents a link to an MP3 audio file. By default, this audio file will be sent by the user. Alternatively, you can
+ * use input_message_content to send a message with the specified content instead of the audio.
+ * @see https://core.telegram.org/bots/api#inlinequeryresultaudio
+ */
+export type InlineQueryResultAudio = {
+	/**
+	 * Type of the result, must be audio
+	 */
+	type: "audio";
+
+	/**
+	 * Unique identifier for this result, 1-64 bytes
+	 */
+	id: string;
+
+	/**
+	 * A valid URL for the audio file
+	 */
+	audio_url: string;
+
+	/**
+	 * Title
+	 */
+	title: string;
+
+	/**
+	 * Optional. Caption, 0-1024 characters after entities parsing
+	 */
+	caption?: string;
+
+	/**
+	 * Optional. Mode for parsing entities in the audio caption. See formatting options for more details.
+	 */
+	parse_mode?: ParseMode;
+
+	/**
+	 * Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
+	 */
+	caption_entities?: MessageEntity[];
+
+	/**
+	 * Optional. Performer
+	 */
+	performer?: string;
+
+	/**
+	 * Optional. Audio duration in seconds
+	 */
+	audio_duration?: number;
+
+	/**
+	 * Optional. Inline keyboard attached to the message
+	 */
+	reply_markup?: InlineKeyboardMarkup;
+
+	/**
+	 * Optional. Content of the message to be sent instead of the audio
+	 */
+	input_message_content?: InputMessageContent;
+};