nyx-bot-client 0.0.2

package/@types/InlineQueryResultCachedAudio.ts

@@ -0,0 +1,55 @@
+import type {
+	InlineKeyboardMarkup,
+	InputMessageContent,
+	MessageEntity,
+	ParseMode,
+} from "./";
+
+/**
+ * ## InlineQueryResultCachedAudio
+ * Represents a link to an MP3 audio file stored on the Telegram servers. 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#inlinequeryresultcachedaudio
+ */
+export type InlineQueryResultCachedAudio = {
+	/**
+	 * Type of the result, must be audio
+	 */
+	type: "audio";
+
+	/**
+	 * Unique identifier for this result, 1-64 bytes
+	 */
+	id: string;
+
+	/**
+	 * A valid file identifier for the audio file
+	 */
+	audio_file_id: 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. 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;
+};

package/@types/InlineQueryResultCachedDocument.ts

@@ -0,0 +1,65 @@
+import type {
+	InlineKeyboardMarkup,
+	InputMessageContent,
+	MessageEntity,
+	ParseMode,
+} from "./";
+
+/**
+ * ## InlineQueryResultCachedDocument
+ * Represents a link to a file stored on the Telegram servers. By default, this file will be sent by the user with an
+ * optional caption. Alternatively, you can use input_message_content to send a message with the specified content
+ * instead of the file.
+ * @see https://core.telegram.org/bots/api#inlinequeryresultcacheddocument
+ */
+export type InlineQueryResultCachedDocument = {
+	/**
+	 * Type of the result, must be document
+	 */
+	type: "document";
+
+	/**
+	 * Unique identifier for this result, 1-64 bytes
+	 */
+	id: string;
+
+	/**
+	 * Title for the result
+	 */
+	title: string;
+
+	/**
+	 * A valid file identifier for the file
+	 */
+	document_file_id: string;
+
+	/**
+	 * Optional. Short description of the result
+	 */
+	description?: string;
+
+	/**
+	 * Optional. Caption of the document to be sent, 0-1024 characters after entities parsing
+	 */
+	caption?: string;
+
+	/**
+	 * Optional. Mode for parsing entities in the document 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. Inline keyboard attached to the message
+	 */
+	reply_markup?: InlineKeyboardMarkup;
+
+	/**
+	 * Optional. Content of the message to be sent instead of the file
+	 */
+	input_message_content?: InputMessageContent;
+};

package/@types/InlineQueryResultCachedGif.ts

@@ -0,0 +1,65 @@
+import type {
+	InlineKeyboardMarkup,
+	InputMessageContent,
+	MessageEntity,
+	ParseMode,
+} from "./";
+
+/**
+ * ## InlineQueryResultCachedGif
+ * Represents a link to an animated GIF file stored on the Telegram servers. By default, this animated GIF file will be
+ * sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with
+ * specified content instead of the animation.
+ * @see https://core.telegram.org/bots/api#inlinequeryresultcachedgif
+ */
+export type InlineQueryResultCachedGif = {
+	/**
+	 * Type of the result, must be gif
+	 */
+	type: "gif";
+
+	/**
+	 * Unique identifier for this result, 1-64 bytes
+	 */
+	id: string;
+
+	/**
+	 * A valid file identifier for the GIF file
+	 */
+	gif_file_id: string;
+
+	/**
+	 * Optional. Title for the result
+	 */
+	title?: string;
+
+	/**
+	 * Optional. Caption of the GIF file to be sent, 0-1024 characters after entities parsing
+	 */
+	caption?: string;
+
+	/**
+	 * Optional. Mode for parsing entities in the 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. Pass True, if the caption must be shown above the message media
+	 */
+	show_caption_above_media?: boolean;
+
+	/**
+	 * Optional. Inline keyboard attached to the message
+	 */
+	reply_markup?: InlineKeyboardMarkup;
+
+	/**
+	 * Optional. Content of the message to be sent instead of the GIF animation
+	 */
+	input_message_content?: InputMessageContent;
+};

package/@types/InlineQueryResultCachedMpeg4Gif.ts

@@ -0,0 +1,65 @@
+import type {
+	InlineKeyboardMarkup,
+	InputMessageContent,
+	MessageEntity,
+	ParseMode,
+} from "./";
+
+/**
+ * ## InlineQueryResultCachedMpeg4Gif
+ * Represents a link to a video animation (H.264/MPEG-4 AVC video without sound) stored on the Telegram servers. By
+ * default, this animated MPEG-4 file will be sent by the user with an optional caption. Alternatively, you can use
+ * `input_message_content` to send a message with the specified content instead of the animation.
+ * @see https://core.telegram.org/bots/api#inlinequeryresultcachedmpeg4gif
+ */
+export type InlineQueryResultCachedMpeg4Gif = {
+	/**
+	 * Type of the result, must be mpeg4_gif
+	 */
+	type: "mpeg4_gif";
+
+	/**
+	 * Unique identifier for this result, 1-64 bytes
+	 */
+	id: string;
+
+	/**
+	 * A valid file identifier for the MPEG4 file
+	 */
+	mpeg4_file_id: string;
+
+	/**
+	 * Optional. Title for the result
+	 */
+	title?: string;
+
+	/**
+	 * Optional. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing
+	 */
+	caption?: string;
+
+	/**
+	 * Optional. Mode for parsing entities in the 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. Pass True, if the caption must be shown above the message media
+	 */
+	show_caption_above_media?: boolean;
+
+	/**
+	 * Optional. Inline keyboard attached to the message
+	 */
+	reply_markup?: InlineKeyboardMarkup;
+
+	/**
+	 * Optional. Content of the message to be sent instead of the video animation
+	 */
+	input_message_content?: InputMessageContent;
+};

package/@types/InlineQueryResultCachedPhoto.ts

@@ -0,0 +1,70 @@
+import type {
+	InlineKeyboardMarkup,
+	InputMessageContent,
+	MessageEntity,
+	ParseMode,
+} from "./";
+
+/**
+ * ## InlineQueryResultCachedPhoto
+ * Represents a link to a photo stored on the Telegram servers. By default, this photo will be sent by the user with an
+ * optional caption. Alternatively, you can use input_message_content to send a message with the specified content
+ * instead of the photo.
+ * @see https://core.telegram.org/bots/api#inlinequeryresultcachedphoto
+ */
+export type InlineQueryResultCachedPhoto = {
+	/**
+	 * Type of the result, must be photo
+	 */
+	type: "photo";
+
+	/**
+	 * Unique identifier for this result, 1-64 bytes
+	 */
+	id: string;
+
+	/**
+	 * A valid file identifier of the photo
+	 */
+	photo_file_id: string;
+
+	/**
+	 * Optional. Title for the result
+	 */
+	title?: string;
+
+	/**
+	 * Optional. Short description of the result
+	 */
+	description?: string;
+
+	/**
+	 * Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing
+	 */
+	caption?: string;
+
+	/**
+	 * Optional. Mode for parsing entities in the photo 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. Pass True, if the caption must be shown above the message media
+	 */
+	show_caption_above_media?: boolean;
+
+	/**
+	 * Optional. Inline keyboard attached to the message
+	 */
+	reply_markup?: InlineKeyboardMarkup;
+
+	/**
+	 * Optional. Content of the message to be sent instead of the photo
+	 */
+	input_message_content?: InputMessageContent;
+};

package/@types/InlineQueryResultCachedSticker.ts

@@ -0,0 +1,34 @@
+import type { InlineKeyboardMarkup, InputMessageContent } from "./";
+
+/**
+ * ## InlineQueryResultCachedSticker
+ * Represents a link to a sticker stored on the Telegram servers. By default, this sticker will be sent by the user.
+ * Alternatively, you can use input_message_content to send a message with the specified content instead of the sticker.
+ * @see https://core.telegram.org/bots/api#inlinequeryresultcachedsticker
+ */
+export type InlineQueryResultCachedSticker = {
+	/**
+	 * Type of the result, must be sticker
+	 */
+	type: "sticker";
+
+	/**
+	 * Unique identifier for this result, 1-64 bytes
+	 */
+	id: string;
+
+	/**
+	 * A valid file identifier of the sticker
+	 */
+	sticker_file_id: string;
+
+	/**
+	 * Optional. Inline keyboard attached to the message
+	 */
+	reply_markup?: InlineKeyboardMarkup;
+
+	/**
+	 * Optional. Content of the message to be sent instead of the sticker
+	 */
+	input_message_content?: InputMessageContent;
+};

package/@types/InlineQueryResultCachedVideo.ts

@@ -0,0 +1,70 @@
+import type {
+	InlineKeyboardMarkup,
+	InputMessageContent,
+	MessageEntity,
+	ParseMode,
+} from "./";
+
+/**
+ * ## InlineQueryResultCachedVideo
+ * Represents a link to a video file stored on the Telegram servers. By default, this video file will be sent by the
+ * user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified
+ * content instead of the video.
+ * @see https://core.telegram.org/bots/api#inlinequeryresultcachedvideo
+ */
+export type InlineQueryResultCachedVideo = {
+	/**
+	 * Type of the result, must be video
+	 */
+	type: "video";
+
+	/**
+	 * Unique identifier for this result, 1-64 bytes
+	 */
+	id: string;
+
+	/**
+	 * A valid file identifier for the video file
+	 */
+	video_file_id: string;
+
+	/**
+	 * Title for the result
+	 */
+	title: string;
+
+	/**
+	 * Optional. Short description of the result
+	 */
+	description?: string;
+
+	/**
+	 * Optional. Caption of the video to be sent, 0-1024 characters after entities parsing
+	 */
+	caption?: string;
+
+	/**
+	 * Optional. Mode for parsing entities in the video 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. Pass True, if the caption must be shown above the message media
+	 */
+	show_caption_above_media?: boolean;
+
+	/**
+	 * Optional. Inline keyboard attached to the message
+	 */
+	reply_markup?: InlineKeyboardMarkup;
+
+	/**
+	 * Optional. Content of the message to be sent instead of the video
+	 */
+	input_message_content?: InputMessageContent;
+};

package/@types/InlineQueryResultCachedVoice.ts

@@ -0,0 +1,60 @@
+import type {
+	InlineKeyboardMarkup,
+	InputMessageContent,
+	MessageEntity,
+	ParseMode,
+} from "./";
+
+/**
+ * ## InlineQueryResultCachedVoice
+ * Represents a link to a voice message stored on the Telegram servers. By default, this voice message will be sent by
+ * the user. Alternatively, you can use input_message_content to send a message with the specified content instead of
+ * the voice message.
+ * @see https://core.telegram.org/bots/api#inlinequeryresultcachedvoice
+ */
+export type InlineQueryResultCachedVoice = {
+	/**
+	 * Type of the result, must be voice
+	 */
+	type: "voice";
+
+	/**
+	 * Unique identifier for this result, 1-64 bytes
+	 */
+	id: string;
+
+	/**
+	 * A valid file identifier for the voice message
+	 */
+	voice_file_id: string;
+
+	/**
+	 * Voice message title
+	 */
+	title: string;
+
+	/**
+	 * Optional. Caption, 0-1024 characters after entities parsing
+	 */
+	caption?: string;
+
+	/**
+	 * Optional. Mode for parsing entities in the voice message 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. Inline keyboard attached to the message
+	 */
+	reply_markup?: InlineKeyboardMarkup;
+
+	/**
+	 * Optional. Content of the message to be sent instead of the voice message
+	 */
+	input_message_content?: InputMessageContent;
+};

package/@types/InlineQueryResultContact.ts

@@ -0,0 +1,64 @@
+import type { InlineKeyboardMarkup, InputMessageContent } from "./";
+
+/**
+ * ## InlineQueryResultContact
+ * Represents a contact with a phone number. By default, this contact will be sent by the user. Alternatively, you can
+ * use input_message_content to send a message with the specified content instead of the contact.
+ * @see https://core.telegram.org/bots/api#inlinequeryresultcontact
+ */
+export type InlineQueryResultContact = {
+	/**
+	 * Type of the result, must be contact
+	 */
+	type: "contact";
+
+	/**
+	 * Unique identifier for this result, 1-64 Bytes
+	 */
+	id: string;
+
+	/**
+	 * Contact's phone number
+	 */
+	phone_number: string;
+
+	/**
+	 * Contact's first name
+	 */
+	first_name: string;
+
+	/**
+	 * Optional. Contact's last name
+	 */
+	last_name?: string;
+
+	/**
+	 * Optional. Additional data about the contact in the form of a vCard, 0-2048 bytes
+	 */
+	vcard?: string;
+
+	/**
+	 * Optional. Inline keyboard attached to the message
+	 */
+	reply_markup?: InlineKeyboardMarkup;
+
+	/**
+	 * Optional. Content of the message to be sent instead of the contact
+	 */
+	input_message_content?: InputMessageContent;
+
+	/**
+	 * Optional. Url of the thumbnail for the result
+	 */
+	thumbnail_url?: string;
+
+	/**
+	 * Optional. Thumbnail width
+	 */
+	thumbnail_width?: number;
+
+	/**
+	 * Optional. Thumbnail height
+	 */
+	thumbnail_height?: number;
+};

package/@types/InlineQueryResultDocument.ts

@@ -0,0 +1,85 @@
+import type {
+	InlineKeyboardMarkup,
+	InputMessageContent,
+	MessageEntity,
+	ParseMode,
+} from "./";
+
+/**
+ * ## InlineQueryResultDocument
+ * Represents a link to a file. By default, this file will be sent by the user with an optional caption. Alternatively,
+ * you can use input_message_content to send a message with the specified content instead of the file. Currently, only
+ * .PDF and .ZIP files can be sent using this method.
+ * @see https://core.telegram.org/bots/api#inlinequeryresultdocument
+ */
+export type InlineQueryResultDocument = {
+	/**
+	 * Type of the result, must be document
+	 */
+	type: "document";
+
+	/**
+	 * Unique identifier for this result, 1-64 bytes
+	 */
+	id: string;
+
+	/**
+	 * Title for the result
+	 */
+	title: string;
+
+	/**
+	 * Optional. Caption of the document to be sent, 0-1024 characters after entities parsing
+	 */
+	caption?: string;
+
+	/**
+	 * Optional. Mode for parsing entities in the document 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[];
+
+	/**
+	 * A valid URL for the file
+	 */
+	document_url: string;
+
+	/**
+	 * String	MIME type of the content of the file, either “application/pdf” or “application/zip”
+	 */
+	mime_type: "application/pdf" | "application/zip";
+
+	/**
+	 * Optional. Short description of the result
+	 */
+	description?: string;
+
+	/**
+	 * Optional. Inline keyboard attached to the message
+	 */
+	reply_markup?: InlineKeyboardMarkup;
+
+	/**
+	 * Optional. Content of the message to be sent instead of the file
+	 */
+	input_message_content?: InputMessageContent;
+
+	/**
+	 * Optional. URL of the thumbnail (JPEG only) for the file
+	 */
+	thumbnail_url?: string;
+
+	/**
+	 * Optional. Thumbnail width
+	 */
+	thumbnail_width?: number;
+
+	/**
+	 * Optional. Thumbnail height
+	 */
+	thumbnail_height?: number;
+};

package/@types/InlineQueryResultGame.ts

@@ -0,0 +1,29 @@
+import type { InlineKeyboardMarkup } from "./";
+
+/**
+ * ## InlineQueryResultGame
+ * Represents a link to a photo. By default, this photo will be sent by the user with optional caption. Alternatively,
+ * you can use input_message_content to send a message with the specified content instead of the photo.
+ * @see https://core.telegram.org/bots/api#inlinequeryresultgame
+ */
+export type InlineQueryResultGame = {
+	/**
+	 * Type of the result, must be game
+	 */
+	type: "game";
+
+	/**
+	 * Unique identifier for this result, 1-64 bytes
+	 */
+	id: string;
+
+	/**
+	 * Short name of the game
+	 */
+	game_short_name: string;
+
+	/**
+	 * Optional. Inline keyboard attached to the message
+	 */
+	reply_markup?: InlineKeyboardMarkup;
+};