nyx-bot-client 0.0.2

package/@types/ChatMemberRestricted.ts

@@ -0,0 +1,99 @@
+import type { User } from "./";
+
+/**
+ * ## ChatMemberRestricted
+ * Represents a chat member that is under certain restrictions in the chat. Supergroups only.
+ * @see https://core.telegram.org/bots/api#chatmemberrestricted
+ */
+export type ChatMemberRestricted = {
+	/**
+	 * The member's status in the chat, always “restricted”
+	 */
+	status: "restricted";
+
+	/**
+	 * Information about the user
+	 */
+	user: User;
+
+	/**
+	 * True, if the user is a member of the chat at the moment of the request
+	 */
+	is_member: boolean;
+
+	/**
+	 * True, if the user is allowed to send text messages, contacts, giveaways, giveaway winners, invoices, locations and
+	 * venues
+	 */
+	can_send_messages: boolean;
+
+	/**
+	 * True, if the user is allowed to send audios
+	 */
+	can_send_audios: boolean;
+
+	/**
+	 * True, if the user is allowed to send documents
+	 */
+	can_send_documents: boolean;
+
+	/**
+	 * True, if the user is allowed to send photos
+	 */
+	can_send_photos: boolean;
+
+	/**
+	 * True, if the user is allowed to send videos
+	 */
+	can_send_videos: boolean;
+
+	/**
+	 * True, if the user is allowed to send video notes
+	 */
+	can_send_video_notes: boolean;
+
+	/**
+	 * True, if the user is allowed to send voice notes
+	 */
+	can_send_voice_notes: boolean;
+
+	/**
+	 * True, if the user is allowed to send polls
+	 */
+	can_send_polls: boolean;
+
+	/**
+	 * True, if the user is allowed to send animations, games, stickers and use inline bots
+	 */
+	can_send_other_messages: boolean;
+
+	/**
+	 * True, if the user is allowed to add web page previews to their messages
+	 */
+	can_add_web_page_previews: boolean;
+
+	/**
+	 * True, if the user is allowed to change the chat title, photo and other settings
+	 */
+	can_change_info: boolean;
+
+	/**
+	 * True, if the user is allowed to invite new users to the chat
+	 */
+	can_invite_users: boolean;
+
+	/**
+	 * True, if the user is allowed to pin messages
+	 */
+	can_pin_messages: boolean;
+
+	/**
+	 * True, if the user is allowed to create forum topics
+	 */
+	can_manage_topics: boolean;
+
+	/**
+	 * Date when restrictions will be lifted for this user; Unix time. If 0, then the user is restricted forever
+	 */
+	until_date: number;
+};

package/@types/ChatMemberUpdated.ts

@@ -0,0 +1,49 @@
+import type { Chat, ChatInviteLink, ChatMember, User } from "./";
+
+/**
+ * ## ChatMemberUpdated
+ * This object represents changes in the status of a chat member.
+ * @see https://core.telegram.org/bots/api#chatmemberupdated
+ */
+export type ChatMemberUpdated = {
+	/**
+	 * Chat the user belongs to
+	 */
+	chat: Chat;
+
+	/**
+	 * Performer of the action, which resulted in the change
+	 */
+	from: User;
+
+	/**
+	 * Date the change was done in Unix time
+	 */
+	date: number;
+
+	/**
+	 * Previous information about the chat member
+	 */
+	old_chat_member: ChatMember;
+
+	/**
+	 * New information about the chat member
+	 */
+	new_chat_member: ChatMember;
+
+	/**
+	 * Optional. Chat invite link, which was used by the user to join the chat; for joining by invite link events only.
+	 */
+	invite_link?: ChatInviteLink;
+
+	/**
+	 * Optional. True, if the user joined the chat after sending a direct join request without using an invite link and
+	 * being approved by an administrator
+	 */
+	via_join_request?: boolean;
+
+	/**
+	 * Optional. True, if the user joined the chat via a chat folder invite link
+	 */
+	via_chat_folder_invite_link?: boolean;
+};

package/@types/ChatPermissions.ts

@@ -0,0 +1,78 @@
+/**
+ * ## ChatPermissions
+ * Describes actions that a non-administrator user is allowed to take in a chat.
+ * @see https://core.telegram.org/bots/api#chatpermissions
+ */
+export type ChatPermissions = {
+	/**
+	 * Optional. True, if the user is allowed to send text messages, contacts, giveaways, giveaway winners, invoices,
+	 * locations and venues
+	 */
+	can_send_messages?: boolean;
+
+	/**
+	 * Optional. True, if the user is allowed to send audios
+	 */
+	can_send_audios?: boolean;
+
+	/**
+	 * Optional. True, if the user is allowed to send documents
+	 */
+	can_send_documents?: boolean;
+
+	/**
+	 * Optional. True, if the user is allowed to send photos
+	 */
+	can_send_photos?: boolean;
+
+	/**
+	 * Optional. True, if the user is allowed to send videos
+	 */
+	can_send_videos?: boolean;
+
+	/**
+	 * Optional. True, if the user is allowed to send video notes
+	 */
+	can_send_video_notes?: boolean;
+
+	/**
+	 * Optional. True, if the user is allowed to send voice notes
+	 */
+	can_send_voice_notes?: boolean;
+
+	/**
+	 * Optional. True, if the user is allowed to send polls
+	 */
+	can_send_polls?: boolean;
+
+	/**
+	 * Optional. True, if the user is allowed to send animations, games, stickers and use inline bots
+	 */
+	can_send_other_messages?: boolean;
+
+	/**
+	 * Optional. True, if the user is allowed to add web page previews to their messages
+	 */
+	can_add_web_page_previews?: boolean;
+
+	/**
+	 * Optional. True, if the user is allowed to change the chat title, photo and other settings. Ignored in public
+	 * supergroups
+	 */
+	can_change_info?: boolean;
+
+	/**
+	 * Optional. True, if the user is allowed to invite new users to the chat
+	 */
+	can_invite_users?: boolean;
+
+	/**
+	 * Optional. True, if the user is allowed to pin messages. Ignored in public supergroups
+	 */
+	can_pin_messages?: boolean;
+
+	/**
+	 * Optional. True, if the user is allowed to create forum topics. If omitted defaults to the value of can_pin_messages
+	 */
+	can_manage_topics?: boolean;
+};

package/@types/ChatPhoto.ts

@@ -0,0 +1,30 @@
+/**
+ * ## ChatPhoto
+ * This object represents a chat photo.
+ * @see https://core.telegram.org/bots/api#chatphoto
+ */
+export type ChatPhoto = {
+	/**
+	 * File identifier of small (160x160) chat photo. This file_id can be used only for photo download and only for as
+	 * long as the photo is not changed.
+	 */
+	small_file_id: string;
+
+	/**
+	 * Unique file identifier of small (160x160) chat photo, which is supposed to be the same over time and for different
+	 * bots. Can't be used to download or reuse the file.
+	 */
+	small_file_unique_id: string;
+
+	/**
+	 * File identifier of big (640x640) chat photo. This file_id can be used only for photo download and only for as long
+	 * as the photo is not changed.
+	 */
+	big_file_id: string;
+
+	/**
+	 * Unique file identifier of big (640x640) chat photo, which is supposed to be the same over time and for different
+	 * bots. Can't be used to download or reuse the file.
+	 */
+	big_file_unique_id: string;
+};

package/@types/ChatShared.ts

@@ -0,0 +1,36 @@
+import type { PhotoSize } from "./";
+
+/**
+ * ## ChatShared
+ * This object contains information about a chat that was shared with the bot using a KeyboardButtonRequestChat button.
+ * @see https://core.telegram.org/bots/api#chatshared
+ */
+export type ChatShared = {
+	/**
+	 * Identifier of the request
+	 */
+	request_id: number;
+
+	/**
+	 * Identifier of the shared chat. This number may have more than 32 significant bits and some programming languages
+	 * may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer
+	 * or double-precision float type are safe for storing this identifier. The bot may not have access to the chat and
+	 * could be unable to use this identifier, unless the chat is already known to the bot by some other means.
+	 */
+	chat_id: number;
+
+	/**
+	 * Optional. Title of the chat, if the title was requested by the bot.
+	 */
+	title?: string;
+
+	/**
+	 * Optional. Username of the chat, if the username was requested by the bot and available.
+	 */
+	username?: string;
+
+	/**
+	 * Optional. Available sizes of the chat photo, if the photo was requested by the bot
+	 */
+	photo?: PhotoSize[];
+};

package/@types/Checklist.ts

@@ -0,0 +1,33 @@
+import type { ChecklistTask, MessageEntity } from "./";
+
+/**
+ * ## Checklist
+ * Describes a checklist.
+ * @see https://core.telegram.org/bots/api#checklist
+ */
+export type Checklist = {
+	/**
+	 * Title of the checklist
+	 */
+	title: string;
+
+	/**
+	 * Optional. Special entities that appear in the checklist title
+	 */
+	title_entities?: MessageEntity[];
+
+	/**
+	 * List of tasks in the checklist
+	 */
+	tasks: ChecklistTask[];
+
+	/**
+	 * Optional. True, if users other than the creator of the list can add tasks to the list
+	 */
+	others_can_add_tasks?: true;
+
+	/**
+	 * Optional. True, if users other than the creator of the list can mark tasks as done or not done
+	 */
+	others_can_mark_tasks_as_done?: true;
+};

package/@types/ChecklistTask.ts

@@ -0,0 +1,33 @@
+import type { MessageEntity, User } from "./";
+
+/**
+ * ## ChecklistTask
+ * Describes a task in a checklist.
+ * @see https://core.telegram.org/bots/api#checklisttask
+ */
+export type ChecklistTask = {
+	/**
+	 * Unique identifier of the task
+	 */
+	id: number;
+
+	/**
+	 * Text of the task
+	 */
+	text: string;
+
+	/**
+	 * Optional. Special entities that appear in the task text
+	 */
+	text_entities?: MessageEntity[];
+
+	/**
+	 * Optional. User that completed the task; omitted if the task wasn't completed
+	 */
+	completed_by_user?: User;
+
+	/**
+	 * Optional. Point in time (Unix timestamp) when the task was completed; 0 if the task wasn't completed
+	 */
+	completion_date?: number;
+};

package/@types/ChecklistTasksAdded.ts

@@ -0,0 +1,19 @@
+import type { ChecklistTask, Message } from "./";
+
+/**
+ * ## ChecklistTasksAdded
+ * Describes a service message about tasks added to a checklist.
+ * @see https://core.telegram.org/bots/api#checklisttasksadded
+ */
+export type ChecklistTasksAdded = {
+	/**
+	 * Optional. Message containing the checklist to which the tasks were added. Note that the Message object in this
+	 * field will not contain the reply_to_message field even if it itself is a reply.
+	 */
+	checklist_message?: Message;
+
+	/**
+	 * List of tasks added to the checklist
+	 */
+	tasks: ChecklistTask[];
+};

package/@types/ChecklistTasksDone.ts

@@ -0,0 +1,24 @@
+import type { Message } from "./";
+
+/**
+ * ## ChecklistTasksDone
+ * Describes a service message about checklist tasks marked as done or not done.
+ * @see https://core.telegram.org/bots/api#checklisttasksdone
+ */
+export type ChecklistTasksDone = {
+	/**
+	 * Optional. Message containing the checklist whose tasks were marked as done or not done. Note that the Message
+	 * object in this field will not contain the reply_to_message field even if it itself is a reply.
+	 */
+	checklist_message?: Message;
+
+	/**
+	 * Optional. Identifiers of the tasks that were marked as done
+	 */
+	marked_as_done_task_ids?: number[];
+
+	/**
+	 * Optional. Identifiers of the tasks that were marked as not done
+	 */
+	marked_as_not_done_task_ids?: number[];
+};

package/@types/ChosenInlineResult.ts

@@ -0,0 +1,34 @@
+import type { User } from "./";
+
+/**
+ * ## ChosenInlineResult
+ * Represents a result of an inline query that was chosen by the user and sent to their chat partner.
+ * @see https://core.telegram.org/bots/api#choseninlineresult
+ */
+export type ChosenInlineResult = {
+	/**
+	 * The unique identifier for the result that was chosen
+	 */
+	result_id: string;
+
+	/**
+	 * The user that chose the result
+	 */
+	from: User;
+
+	/**
+	 * Optional. Sender location, only for bots that require user location
+	 */
+	location?: Location;
+
+	/**
+	 * Optional. Identifier of the sent inline message. Available only if there is an inline keyboard attached to the
+	 * message. Will be also received in callback queries and can be used to edit the message.
+	 */
+	inline_message_id?: string;
+
+	/**
+	 * The query that was used to obtain the result
+	 */
+	query: string;
+};

package/@types/Contact.ts

@@ -0,0 +1,33 @@
+/**
+ * ## Contact
+ * This object represents a phone contact.
+ * @see https://core.telegram.org/bots/api#contact
+ */
+export type Contact = {
+	/**
+	 * Contact's phone number
+	 */
+	phone_number: string;
+
+	/**
+	 * Contact's first name
+	 */
+	first_name: string;
+
+	/**
+	 * Optional. Contact's last name
+	 */
+	last_name?: string;
+
+	/**
+	 * Optional. Contact's user identifier in Telegram. This number may have more than 32 significant bits and some
+	 * programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant
+	 * bits, so a 64-bit integer or double-precision float type are safe for storing this identifier.
+	 */
+	user_id?: number;
+
+	/**
+	 * Optional. Additional data about the contact in the form of a [vCard](https://en.wikipedia.org/wiki/VCard)
+	 */
+	vcard?: string;
+};

package/@types/CopyTextButton.ts

@@ -0,0 +1,11 @@
+/**
+ * ## CopyTextButton
+ * This object represents an inline keyboard button that copies specified text to the clipboard.
+ * @see https://core.telegram.org/bots/api#copytextbutton
+ */
+export type CopyTextButton = {
+	/**
+	 * The text to be copied to the clipboard; 1-256 characters
+	 */
+	text: string;
+};

package/@types/Dice.ts

@@ -0,0 +1,17 @@
+/**
+ * ## Dice
+ * This object represents an animated emoji that displays a random value.
+ * @see https://core.telegram.org/bots/api#dice
+ */
+export type Dice = {
+	/**
+	 * Emoji on which the dice throw animation is based
+	 */
+	emoji: string;
+
+	/**
+	 * Value of the dice, 1-6 for “🎲”, “🎯” and “🎳” base emoji, 1-5 for “🏀” and “⚽” base emoji,
+	 * 1-64 for “🎰” base emoji
+	 */
+	value: number;
+};

package/@types/DirectMessagePriceChanged.ts

@@ -0,0 +1,17 @@
+/**
+ * ## DirectMessagePriceChanged
+ * Describes a service message about a change in the price of direct messages sent to a channel chat.
+ * @see https://core.telegram.org/bots/api#directmessagepricechanged
+ */
+export type DirectMessagePriceChanged = {
+	/**
+	 * True, if direct messages are enabled for the channel chat; false otherwise
+	 */
+	are_direct_messages_enabled: boolean;
+
+	/**
+	 * Optional. The new number of Telegram Stars that must be paid by users for each direct message sent to the
+	 * channel. Does not apply to users who have been exempted by administrators. Defaults to 0.
+	 */
+	direct_message_star_count?: number;
+};

package/@types/Document.ts

@@ -0,0 +1,41 @@
+import type { PhotoSize } from "./";
+
+/**
+ * ## Document
+ * This object represents a general file (as opposed to photos, voice messages and audio files).
+ * @see https://core.telegram.org/bots/api#document
+ */
+export type Document = {
+	/**
+	 * 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. Document thumbnail as defined by the sender
+	 */
+	thumbnail?: PhotoSize;
+
+	/**
+	 * Optional. Original filename as defined by the sender
+	 */
+	file_name?: string;
+
+	/**
+	 * ptional. MIME type of the file as defined by the sender
+	 */
+	mime_type?: 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;
+};

package/@types/EncryptedCredentials.ts

@@ -0,0 +1,23 @@
+/**
+ * ## EncryptedCredentials
+ * Describes data required for decrypting and authenticating EncryptedPassportElement. See the Telegram Passport
+ * Documentation for a complete description of the data decryption and authentication processes.
+ * @see https://core.telegram.org/bots/api#encryptedcredentials
+ */
+export type EncryptedCredentials = {
+	/**
+	 * Base64-encoded encrypted JSON-serialized data with unique user's payload, data hashes and secrets required for
+	 * EncryptedPassportElement decryption and authentication
+	 */
+	data: string;
+
+	/**
+	 * Base64-encoded data hash for data authentication
+	 */
+	hash: string;
+
+	/**
+	 * Base64-encoded secret, encrypted with the bot's public RSA key, required for data decryption
+	 */
+	secret: string;
+};