nyx-bot-client 0.0.2

package/@types/EncryptedPassportElement.ts

@@ -0,0 +1,357 @@
+/**
+ *
+ */
+type PassportFile = {
+	/**
+	 *
+	 */
+	file_id: string;
+
+	/**
+	 *
+	 */
+	file_size: number;
+
+	/**
+	 *
+	 */
+	file_date: number;
+};
+
+/**
+ *
+ */
+type BaseEncryptedPassportElement = {
+	/**
+	 *
+	 */
+	type:
+		| "personal_details"
+		| "passport"
+		| "driver_license"
+		| "identity_card"
+		| "internal_passport"
+		| "address"
+		| "utility_bill"
+		| "bank_statement"
+		| "rental_agreement"
+		| "passport_registration"
+		| "temporary_registration"
+		| "phone_number"
+		| "email";
+
+	/**
+	 *
+	 */
+	hash: string;
+};
+
+/**
+ *
+ */
+type PersonalDetailsElement = {
+	/**
+	 *
+	 */
+	type: "personal_details";
+
+	/**
+	 *
+	 */
+	data?: string;
+} & BaseEncryptedPassportElement;
+
+/**
+ *
+ */
+type PassportElement = {
+	/**
+	 *
+	 */
+	type: "passport";
+
+	/**
+	 *
+	 */
+	data?: string;
+
+	/**
+	 *
+	 */
+	front_side?: PassportFile;
+
+	/**
+	 *
+	 */
+	selfie?: PassportFile;
+
+	/**
+	 *
+	 */
+	translation?: PassportFile[];
+} & BaseEncryptedPassportElement;
+
+/**
+ *
+ */
+type DriverLicenseElement = {
+	/**
+	 *
+	 */
+	type: "driver_license";
+
+	/**
+	 *
+	 */
+	data?: string;
+
+	/**
+	 *
+	 */
+	front_side?: PassportFile;
+
+	/**
+	 *
+	 */
+	reverse_side?: PassportFile;
+
+	/**
+	 *
+	 */
+	selfie?: PassportFile;
+
+	/**
+	 *
+	 */
+	translation?: PassportFile[];
+} & BaseEncryptedPassportElement;
+
+/**
+ *
+ */
+type IdentityCardElement = {
+	/**
+	 *
+	 */
+	type: "identity_card";
+
+	/**
+	 *
+	 */
+	data?: string;
+
+	/**
+	 *
+	 */
+	front_side?: PassportFile;
+
+	/**
+	 *
+	 */
+	reverse_side?: PassportFile;
+
+	/**
+	 *
+	 */
+	selfie?: PassportFile;
+
+	/**
+	 *
+	 */
+	translation?: PassportFile[];
+} & BaseEncryptedPassportElement;
+
+/**
+ *
+ */
+type InternalPassportElement = {
+	/**
+	 *
+	 */
+	type: "internal_passport";
+
+	/**
+	 *
+	 */
+	data?: string;
+
+	/**
+	 *
+	 */
+	front_side?: PassportFile;
+
+	/**
+	 *
+	 */
+	selfie?: PassportFile;
+
+	/**
+	 *
+	 */
+	translation?: PassportFile[];
+} & BaseEncryptedPassportElement;
+
+/**
+ *
+ */
+type AddressElement = {
+	/**
+	 *
+	 */
+	type: "address";
+
+	/**
+	 *
+	 */
+	data?: string;
+} & BaseEncryptedPassportElement;
+
+/**
+ *
+ */
+type UtilityBillElement = {
+	/**
+	 *
+	 */
+	type: "utility_bill";
+
+	/**
+	 *
+	 */
+	files?: PassportFile[];
+
+	/**
+	 *
+	 */
+	translation?: PassportFile[];
+} & BaseEncryptedPassportElement;
+
+/**
+ *
+ */
+type BankStatementElement = {
+	/**
+	 *
+	 */
+	type: "bank_statement";
+
+	/**
+	 *
+	 */
+	files?: PassportFile[];
+
+	/**
+	 *
+	 */
+	translation?: PassportFile[];
+} & BaseEncryptedPassportElement;
+
+/**
+ *
+ */
+type RentalAgreementElement = {
+	/**
+	 *
+	 */
+	type: "rental_agreement";
+
+	/**
+	 *
+	 */
+	files?: PassportFile[];
+
+	/**
+	 *
+	 */
+	translation?: PassportFile[];
+} & BaseEncryptedPassportElement;
+
+/**
+ *
+ */
+type PassportRegistrationElement = {
+	/**
+	 *
+	 */
+	type: "passport_registration";
+
+	/**
+	 *
+	 */
+	files?: PassportFile[];
+
+	/**
+	 *
+	 */
+	translation?: PassportFile[];
+} & BaseEncryptedPassportElement;
+
+/**
+ *
+ */
+type TemporaryRegistrationElement = {
+	/**
+	 *
+	 */
+	type: "temporary_registration";
+
+	/**
+	 *
+	 */
+	files?: PassportFile[];
+
+	/**
+	 *
+	 */
+	translation?: PassportFile[];
+} & BaseEncryptedPassportElement;
+
+/**
+ *
+ */
+type PhoneNumberElement = {
+	/**
+	 *
+	 */
+	type: "phone_number";
+
+	/**
+	 *
+	 */
+	phone_number?: string;
+} & BaseEncryptedPassportElement;
+
+/**
+ *
+ */
+type EmailElement = {
+	/**
+	 *
+	 */
+	type: "email";
+
+	/**
+	 *
+	 */
+	email?: string;
+} & BaseEncryptedPassportElement;
+
+/**
+ * ## EncryptedPassportElement
+ * Describes documents or other Telegram Passport elements shared with the bot by the user.
+ * @see https://core.telegram.org/bots/api#encryptedpassportelement
+ */
+export type EncryptedPassportElement =
+	| PersonalDetailsElement
+	| PassportElement
+	| DriverLicenseElement
+	| IdentityCardElement
+	| InternalPassportElement
+	| AddressElement
+	| UtilityBillElement
+	| BankStatementElement
+	| RentalAgreementElement
+	| PassportRegistrationElement
+	| TemporaryRegistrationElement
+	| PhoneNumberElement
+	| EmailElement;

package/@types/ExternalReplyInfo.ts

@@ -0,0 +1,159 @@
+import type {
+	Animation,
+	Audio,
+	Chat,
+	Checklist,
+	Contact,
+	Dice,
+	Document,
+	Game,
+	Giveaway,
+	GiveawayWinners,
+	Invoice,
+	LinkPreviewOptions,
+	Location,
+	MessageOrigin,
+	PaidMediaInfo,
+	PhotoSize,
+	Poll,
+	Sticker,
+	Story,
+	Venue,
+	Video,
+	VideoNote,
+	Voice,
+} from "./";
+
+/**
+ * ## ExternalReplyInfo
+ * This object contains information about a message that is being replied to, which may come from another chat or forum
+ * topic.
+ * @see https://core.telegram.org/bots/api#externalreplyinfo
+ */
+export type ExternalReplyInfo = {
+	/**
+	 * Origin of the message replied to by the given message
+	 */
+	origin: MessageOrigin;
+
+	/**
+	 * Optional. Chat the original message belongs to. Available only if the chat is a supergroup or a channel.
+	 */
+	chat?: Chat;
+
+	/**
+	 * Optional. Unique message identifier inside the original chat. Available only if the original chat is a supergroup
+	 * or a channel.
+	 */
+	message_id?: number;
+
+	/**
+	 * Optional. Options used for link preview generation for the original message, if it is a text message
+	 */
+	link_preview_options?: LinkPreviewOptions;
+
+	/**
+	 * Optional. Message is an animation, information about the animation
+	 */
+	animation?: Animation;
+
+	/**
+	 * Optional. Message is an audio file, information about the file
+	 */
+	audio?: Audio;
+
+	/**
+	 * Optional. Message is a general file, information about the file
+	 */
+	document?: Document;
+
+	/**
+	 * Optional. Message contains paid media; information about the paid media
+	 */
+	paid_media?: PaidMediaInfo;
+
+	/**
+	 * Optional. Message is a photo, available sizes of the photo
+	 */
+	photo?: PhotoSize[];
+
+	/**
+	 * Optional. Message is a sticker, information about the sticker
+	 */
+	sticker?: Sticker;
+
+	/**
+	 * Optional. Message is a forwarded story
+	 */
+	story?: Story;
+
+	/**
+	 * Optional. Message is a video, information about the video
+	 */
+	video?: Video;
+
+	/**
+	 * Optional. Message is a video note, information about the video message
+	 */
+	video_note?: VideoNote;
+
+	/**
+	 * Optional. Message is a voice message, information about the file
+	 */
+	voice?: Voice;
+
+	/**
+	 * Optional. True, if the message media is covered by a spoiler animation
+	 */
+	has_media_spoiler?: boolean;
+
+	/**
+	 * Optional. Message is a checklist
+	 */
+	checklist?: Checklist;
+
+	/**
+	 * Optional. Message is a shared contact, information about the contact
+	 */
+	contact?: Contact;
+
+	/**
+	 * Optional. Message is a dice with random value
+	 */
+	dice?: Dice;
+
+	/**
+	 * Optional. Message is a game, information about the game. [More about games](https://core.telegram.org/bots/api#games)
+	 */
+	game?: Game;
+
+	/**
+	 * Optional. Message is a scheduled giveaway, information about the giveaway
+	 */
+	giveaway?: Giveaway;
+
+	/**
+	 * Optional. A giveaway with public winners was completed
+	 */
+	giveaway_winners?: GiveawayWinners;
+
+	/**
+	 * Optional. Message is an invoice for a payment, information about the invoice. [More about payments](https://core.telegram.org/bots/api#payments)
+	 */
+	invoice?: Invoice;
+
+	/**
+	 * Optional. Message is a shared location, information about the location
+	 */
+	location?: Location;
+
+	/**
+	 * Optional. Message is a native poll, information about the poll
+	 */
+	poll?: Poll;
+
+	/**
+	 * Optional. Message is a venue, information about the venue
+	 */
+	venue?: Venue;
+};

package/@types/File.ts

@@ -0,0 +1,33 @@
+/**
+ * ## File
+ * This object represents a file ready to be downloaded. The file can be downloaded via the link
+ * `https://api.telegram.org/file/bot<token>/<file_path>`.
+ * It is guaranteed that the link will be valid for at least 1 hour. When the link expires, a new one can be requested
+ * by calling getFile.
+ * > The maximum file size to download is 20 MB
+ * @see https://core.telegram.org/bots/api#file
+ */
+export type File = {
+	/**
+	 * Identifier for this file, which can be used to download or reuse the file
+	 */
+	file_id: string;
+
+	/**
+	 * Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used
+	 * to download or reuse the file.
+	 */
+	file_unique_id: string;
+
+	/**
+	 * Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent
+	 * defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision
+	 * float type are safe for storing this value.
+	 */
+	file_size?: number;
+
+	/**
+	 * Optional. File path. Use https://api.telegram.org/file/bot<token>/<file_path> to get the file.
+	 */
+	file_path?: string;
+};

package/@types/ForceReply.ts

@@ -0,0 +1,26 @@
+/**
+ * ## ForceReply
+ * Upon receiving a message with this object, Telegram clients will 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. Not supported in channels and for
+ * messages sent on behalf of a Telegram Business account.
+ * @see https://core.telegram.org/bots/api#forcereply
+ */
+export type ForceReply = {
+	/**
+	 * Shows reply interface to the user, as if they manually selected the bot's message and tapped 'Reply'
+	 */
+	force_reply: true;
+
+	/**
+	 * Optional. The placeholder to be shown in the input field when the reply is active; 1-64 characters
+	 */
+	input_field_placeholder?: string;
+
+	/**
+	 * Optional. Use this parameter if you want to force reply from specific users only. Targets: 1) users that are
+	 * @mentioned in the text of the Message object; 2) if the bot's message is a reply to a message in the same chat and
+	 * forum topic, sender of the original message.
+	 */
+	selective?: boolean;
+};

package/@types/ForumTopic.ts

@@ -0,0 +1,26 @@
+/**
+ * ## ForumTopic
+ * This object represents a forum topic.
+ * @see https://core.telegram.org/bots/api#forumtopic
+ */
+export type ForumTopic = {
+	/**
+	 * Unique identifier of the forum topic
+	 */
+	message_thread_id: number;
+
+	/**
+	 * Name of the topic
+	 */
+	name: string;
+
+	/**
+	 * Color of the topic icon in RGB format
+	 */
+	icon_color: string;
+
+	/**
+	 * Optional. Unique identifier of the custom emoji shown as the topic icon
+	 */
+	icon_custom_emoji_id?: string;
+};

package/@types/ForumTopicClosed.ts

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

package/@types/ForumTopicCreated.ts

@@ -0,0 +1,21 @@
+/**
+ * ## ForumTopicCreated
+ * This object represents a service message about a new forum topic created in the chat.
+ * @see https://core.telegram.org/bots/api#forumtopiccreated
+ */
+export type ForumTopicCreated = {
+	/**
+	 * Name of the topic
+	 */
+	name: string;
+
+	/**
+	 * Color of the topic icon in RGB format
+	 */
+	icon_color: number;
+
+	/**
+	 * Optional. Unique identifier of the custom emoji shown as the topic icon
+	 */
+	icon_custom_emoji_id: string;
+};

package/@types/ForumTopicEdited.ts

@@ -0,0 +1,17 @@
+/**
+ * ## ForumTopicEdited
+ * This object represents a service message about an edited forum topic.
+ * @see https://core.telegram.org/bots/api#forumtopicedited
+ */
+export type ForumTopicEdited = {
+	/**
+	 * Optional. New name of the topic, if it was edited
+	 */
+	name?: string;
+
+	/**
+	 * Optional. New identifier of the custom emoji shown as the topic icon, if it was edited; an empty string if the icon
+	 * was removed
+	 */
+	icon_custom_emoji_id?: string;
+};

package/@types/ForumTopicReopened.ts

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

package/@types/Game.ts

@@ -0,0 +1,41 @@
+import type { MessageEntity, PhotoSize } from "./";
+
+/**
+ * ## Game
+ * This object represents a game. Use BotFather to create and edit games, their short names will act as unique
+ * identifiers.
+ * @see https://core.telegram.org/bots/api#game
+ */
+export type Game = {
+	/**
+	 * Title of the game
+	 */
+	title: string;
+
+	/**
+	 * Description of the game
+	 */
+	description: string;
+
+	/**
+	 * Photo that will be displayed in the game message in chats.
+	 */
+	photo: PhotoSize[];
+
+	/**
+	 * Optional. Brief description of the game or high scores included in the game message. Can be automatically edited
+	 * to include current high scores for the game when the bot calls setGameScore, or manually edited using
+	 * editMessageText. 0-4096 characters.
+	 */
+	text?: string;
+
+	/**
+	 * Optional. Special entities that appear in text, such as usernames, URLs, bot commands, etc.
+	 */
+	text_entities?: MessageEntity[];
+
+	/**
+	 * Optional. Animation that will be displayed in the game message in chats. Upload via BotFather
+	 */
+	animation?: Animation;
+};

package/@types/GameHighScore.ts

@@ -0,0 +1,23 @@
+import type { User } from "./";
+
+/**
+ * ## GameHighScore
+ * This object represents one row of the high scores table for a game.
+ * @see https://core.telegram.org/bots/api#gamehighscore
+ */
+export type GameHighScore = {
+	/**
+	 * Position in high score table for the game
+	 */
+	position: number;
+
+	/**
+	 * User
+	 */
+	user: User;
+
+	/**
+	 * Score
+	 */
+	score: number;
+};