nyx-bot-client 0.0.2

package/@types/ChatFullInfo.ts

@@ -0,0 +1,260 @@
+import type {
+	AcceptedGiftTypes,
+	Birthdate,
+	BusinessIntro,
+	BusinessLocation,
+	BusinessOpeningHours,
+	Chat,
+	ChatLocation,
+	ChatPermissions,
+	ChatPhoto,
+	Message,
+	ReactionType,
+} from "./";
+
+/**
+ * ## ChatFullInfo
+ * This object contains full information about a chat.
+ * @see https://core.telegram.org/bots/api#chatfullinfo
+ */
+export type ChatFullInfo = {
+	/**
+	 * Unique identifier for this 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 signed 64-bit
+	 * integer or double-precision float type are safe for storing this identifier.
+	 */
+	id: number;
+
+	/**
+	 * Type of the chat, can be either “private”, “group”, “supergroup” or “channel”
+	 */
+	type: "private" | "group" | "supergroup" | "channel";
+
+	/**
+	 * Optional. Title, for supergroups, channels and group chats
+	 */
+	title?: string;
+
+	/**
+	 * Optional. Username, for private chats, supergroups and channels if available
+	 */
+	username?: string;
+
+	/**
+	 * Optional. First name of the other party in a private chat
+	 */
+	first_name?: string;
+
+	/**
+	 * Optional. Last name of the other party in a private chat
+	 */
+	last_name?: string;
+
+	/**
+	 * Optional. True, if the supergroup chat is a forum (has topics enabled)
+	 */
+	is_forum?: boolean;
+
+	/**
+	 * Identifier of the accent color for the chat name and backgrounds of the chat photo, reply header, and link
+	 * preview. See accent colors for more details.
+	 */
+	accent_color_id: number;
+
+	/**
+	 * The maximum number of reactions that can be set on a message in the chat
+	 */
+	max_reaction_count: number;
+
+	/**
+	 * Optional. Chat photo
+	 */
+	photo?: ChatPhoto;
+
+	/**
+	 * Optional. If non-empty, the list of all active chat usernames; for private chats, supergroups and channels
+	 */
+	active_usernames?: string[];
+
+	/**
+	 * Optional. For private chats, the date of birth of the user
+	 */
+	birthdate?: Birthdate;
+
+	/**
+	 * Optional. For private chats with business accounts, the intro of the business
+	 */
+	business_intro?: BusinessIntro;
+
+	/**
+	 * Optional. For private chats with business accounts, the location of the business
+	 */
+	business_location?: BusinessLocation;
+
+	/**
+	 * Optional. For private chats with business accounts, the opening hours of the business
+	 */
+	business_opening_hours?: BusinessOpeningHours;
+
+	/**
+	 * Optional. For private chats, the personal channel of the user
+	 */
+	personal_chat?: Chat;
+
+	/**
+	 * Optional. List of available reactions allowed in the chat. If omitted, then all emoji reactions are allowed.
+	 */
+	available_reactions?: ReactionType[];
+
+	/**
+	 * Optional. Custom emoji identifier of the emoji chosen by the chat for the reply header and link preview background
+	 */
+	background_custom_emoji_id?: string;
+
+	/**
+	 * Optional. Identifier of the accent color for the chat's profile background. See profile accent colors for more
+	 * details.
+	 */
+	profile_accent_color_id?: number;
+
+	/**
+	 * Optional. Custom emoji identifier of the emoji chosen by the chat for its profile background
+	 */
+	profile_background_custom_emoji_id?: string;
+
+	/**
+	 * Optional. Custom emoji identifier of the emoji status of the chat or the other party in a private chat
+	 */
+	emoji_status_custom_emoji_id?: string;
+
+	/**
+	 * Optional. Expiration date of the emoji status of the chat or the other party in a private chat, in Unix time, if
+	 * any
+	 */
+	emoji_status_expiration_date?: number;
+
+	/**
+	 * Optional. Bio of the other party in a private chat
+	 */
+	bio?: string;
+
+	/**
+	 * Optional. True, if privacy settings of the other party in the private chat allows to use tg://user?id=<user_id>
+	 * links only in chats with the user
+	 */
+	has_private_forwards?: boolean;
+
+	/**
+	 * Optional. True, if the privacy settings of the other party restrict sending voice and video note messages in the
+	 * private chat
+	 */
+	has_restricted_voice_and_video_messages?: boolean;
+
+	/**
+	 * Optional. True, if users need to join the supergroup before they can send messages
+	 */
+	join_to_send_messages?: boolean;
+
+	/**
+	 * Optional. True, if all users directly joining the supergroup without using an invite link need to be approved by
+	 * supergroup administrators
+	 */
+	join_by_request?: boolean;
+
+	/**
+	 * Optional. Description, for groups, supergroups and channel chats
+	 */
+	description?: string;
+
+	/**
+	 * Optional. Primary invite link, for groups, supergroups and channel chats
+	 */
+	invite_link?: string;
+
+	/**
+	 * Optional. The most recent pinned message (by sending date)
+	 */
+	pinned_message?: Message;
+
+	/**
+	 * Optional. Default chat member permissions, for groups and supergroups
+	 */
+	permissions?: ChatPermissions;
+
+	/**
+	 * Information about types of gifts that are accepted by the chat or by the corresponding user for private chats
+	 */
+	accepted_gift_types: AcceptedGiftTypes;
+
+	/**
+	 * Optional. True, if paid media messages can be sent or forwarded to the channel chat. The field is available only
+	 * for channel chats.
+	 */
+	can_send_paid_media?: boolean;
+
+	/**
+	 * Optional. For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user;
+	 * in seconds
+	 */
+	slow_mode_delay?: number;
+	/**
+	 * Optional. For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to
+	 * ignore slow mode and chat permissions
+	 */
+	unrestrict_boost_count?: number;
+
+	/**
+	 * Optional. The time after which all messages sent to the chat will be automatically deleted; in seconds
+	 */
+	message_auto_delete_time?: number;
+
+	/**
+	 * Optional. True, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat
+	 * administrators.
+	 */
+	has_aggressive_anti_spam_enabled?: boolean;
+
+	/**
+	 * Optional. True, if non-administrators can only get the list of bots and administrators in the chat
+	 */
+	has_hidden_members?: boolean;
+
+	/**
+	 * Optional. True, if messages from the chat can't be forwarded to other chats
+	 */
+	has_protected_content?: boolean;
+
+	/**
+	 * Optional. True, if new chat members will have access to old messages; available only to chat administrators
+	 */
+	has_visible_history?: boolean;
+
+	/**
+	 * Optional. For supergroups, name of the group sticker set
+	 */
+	sticker_set_name?: string;
+
+	/**
+	 * Optional. True, if the bot can change the group sticker set
+	 */
+	can_set_sticker_set?: boolean;
+
+	/**
+	 * Optional. For supergroups, the name of the group's custom emoji sticker set. Custom emoji from this set can be used
+	 * by all users and bots in the group.
+	 */
+	custom_emoji_sticker_set_name?: string;
+
+	/**
+	 * Optional. Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice
+	 * versa; for supergroups and channel chats. This identifier may be greater than 32 bits and some programming
+	 * languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed
+	 * 64 bit integer or double-precision float type are safe for storing this identifier.
+	 */
+	linked_chat_id?: number;
+
+	/**
+	 * Optional. For supergroups, the location to which the supergroup is connected
+	 */
+	location?: ChatLocation;
+};

package/@types/ChatInviteLink.ts

@@ -0,0 +1,66 @@
+import type { User } from "./";
+
+/**
+ * ## ChatInviteLink
+ * Represents an invite link for a chat.
+ * @see https://core.telegram.org/bots/api#chatinvitelink
+ */
+export type ChatInviteLink = {
+	/**
+	 * The invite link. If the link was created by another chat administrator, then the second part of the link will be
+	 * replaced with “…”.
+	 */
+	invite_link: string;
+
+	/**
+	 * Creator of the link
+	 */
+	creator: User;
+
+	/**
+	 * True, if users joining the chat via the link need to be approved by chat administrators
+	 */
+	creates_join_request: boolean;
+
+	/**
+	 * True, if the link is primary
+	 */
+	is_primary: boolean;
+
+	/**
+	 * True, if the link is revoked
+	 */
+	is_revoked: boolean;
+
+	/**
+	 * Optional. Invite link name
+	 */
+	name?: string;
+
+	/**
+	 * Optional. Point in time (Unix timestamp) when the link will expire or has been expired
+	 */
+	expire_date?: number;
+
+	/**
+	 * Optional. The maximum number of users that can be members of the chat simultaneously after joining the chat via
+	 * this invite link; 1-99999
+	 */
+	member_limit?: number;
+
+	/**
+	 * Optional. Number of pending join requests created using this link
+	 */
+	pending_join_request_count?: number;
+
+	/**
+	 * Optional. The number of seconds the subscription will be active for before the next payment
+	 */
+	subscription_period?: number;
+
+	/**
+	 * Optional. The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to
+	 * be a member of the chat using the link
+	 */
+	subscription_price?: number;
+};

package/@types/ChatJoinRequest.ts

@@ -0,0 +1,42 @@
+import type { Chat, ChatInviteLink, User } from "./";
+
+/**
+ * ## ChatJoinRequest
+ * Represents a join request sent to a chat.
+ * @see https://core.telegram.org/bots/api#chatjoinrequest
+ */
+export type ChatJoinRequest = {
+	/**
+	 * Chat to which the request was sent
+	 */
+	chat: Chat;
+
+	/**
+	 * User that sent the join request
+	 */
+	from: User;
+
+	/**
+	 * Identifier of a private chat with the user who sent the join request. 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
+	 * can use this identifier for 5 minutes to send messages until the join request is processed, assuming no other
+	 * administrator contacted the user.
+	 */
+	user_chat_id: number;
+
+	/**
+	 * Date the request was sent in Unix time
+	 */
+	date: number;
+
+	/**
+	 * Optional. Bio of the user.
+	 */
+	bio?: string;
+
+	/**
+	 * Optional. Chat invite link that was used by the user to send the join request
+	 */
+	invite_link?: ChatInviteLink;
+};

package/@types/ChatLocation.ts

@@ -0,0 +1,16 @@
+/**
+ * ## ChatLocation
+ * Represents a location to which a chat is connected.
+ * @see https://core.telegram.org/bots/api#chatlocation
+ */
+export type ChatLocation = {
+	/**
+	 * The location to which the supergroup is connected. Can't be a live location.
+	 */
+	location: Location;
+
+	/**
+	 * Location address; 1-64 characters, as defined by the chat owner
+	 */
+	address: string;
+};

package/@types/ChatMember.ts

@@ -0,0 +1,28 @@
+import type {
+	ChatMemberAdministrator,
+	ChatMemberBanned,
+	ChatMemberLeft,
+	ChatMemberMember,
+	ChatMemberOwner,
+	ChatMemberRestricted,
+} from "./";
+
+/**
+ * ## ChatMember
+ * This object contains information about one member of a chat. Currently, the following 6 types of chat members are
+ * supported:
+ * - ChatMemberOwner
+ * - ChatMemberAdministrator
+ * - ChatMemberMember
+ * - ChatMemberRestricted
+ * - ChatMemberLeft
+ * - ChatMemberBanned
+ * @see https://core.telegram.org/bots/api#chatmember
+ */
+export type ChatMember =
+	| ChatMemberOwner
+	| ChatMemberAdministrator
+	| ChatMemberMember
+	| ChatMemberRestricted
+	| ChatMemberLeft
+	| ChatMemberBanned;

package/@types/ChatMemberAdministrator.ts

@@ -0,0 +1,107 @@
+import type { User } from "./";
+
+/**
+ * ## ChatMemberAdministrator
+ * Represents a chat member that has some additional privileges.
+ * @see https://core.telegram.org/bots/api#chatmemberadministrator
+ */
+export type ChatMemberAdministrator = {
+	/**
+	 * The member's status in the chat, always “administrator”
+	 */
+	status: "administrator";
+
+	/**
+	 * Information about the user
+	 */
+	user: User;
+
+	/**
+	 * True, if the bot is allowed to edit administrator privileges of that user
+	 */
+	can_be_edited: boolean;
+
+	/**
+	 * True, if the user's presence in the chat is hidden
+	 */
+	is_anonymous: boolean;
+	/**
+	 * True, if the administrator can access the chat event log, get boost list, see hidden supergroup and channel
+	 * members, report spam messages and ignore slow mode. Implied by any other administrator privilege.
+	 */
+	can_manage_chat: boolean;
+
+	/**
+	 * True, if the administrator can delete messages of other users
+	 */
+	can_delete_messages: boolean;
+
+	/**
+	 * True, if the administrator can manage video chats
+	 */
+	can_manage_video_chats: boolean;
+
+	/**
+	 * True, if the administrator can restrict, ban or unban chat members, or access supergroup statistics
+	 */
+	can_restrict_members: boolean;
+
+	/**
+	 * True, if the administrator can add new administrators with a subset of their own privileges or demote
+	 * administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by
+	 * the user)
+	 */
+	can_promote_members: 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 administrator can post stories to the chat
+	 */
+	can_post_stories: boolean;
+
+	/**
+	 * True, if the administrator can edit stories posted by other users, post stories to the chat page, pin chat stories,
+	 * and access the chat's story archive
+	 */
+	can_edit_stories: boolean;
+
+	/**
+	 * True, if the administrator can delete stories posted by other users
+	 */
+	can_delete_stories: boolean;
+
+	/**
+	 * Optional. True, if the administrator can post messages in the channel, or access channel statistics; for channels
+	 * only
+	 */
+	can_post_messages: boolean;
+
+	/**
+	 * Optional. True, if the administrator can edit messages of other users and can pin messages; for channels only
+	 */
+	can_edit_messages: boolean;
+
+	/**
+	 * Optional. True, if the user is allowed to pin messages; for groups and supergroups only
+	 */
+	can_pin_messages: boolean;
+
+	/**
+	 * Optional. True, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only
+	 */
+	can_manage_topics: boolean;
+
+	/**
+	 * Optional. Custom title for this user
+	 */
+	custom_title?: string;
+};

package/@types/ChatMemberBanned.ts

@@ -0,0 +1,23 @@
+import type { User } from "./";
+
+/**
+ * ## ChatMemberBanned
+ * Represents a chat member that was banned in the chat and can't return to the chat or view chat messages.
+ * @see https://core.telegram.org/bots/api#chatmemberbanned
+ */
+export type ChatMemberBanned = {
+	/**
+	 * The member's status in the chat, always “kicked”
+	 */
+	status: "kicked";
+
+	/**
+	 * Information about the user
+	 */
+	user: User;
+
+	/**
+	 * Date when restrictions will be lifted for this user; Unix time. If 0, then the user is banned forever
+	 */
+	until_date: number;
+};

package/@types/ChatMemberLeft.ts

@@ -0,0 +1,18 @@
+import type { User } from "./";
+
+/**
+ * ## ChatMemberLeft
+ * Represents a chat member that isn't currently a member of the chat, but may join it themselves.
+ * @see https://core.telegram.org/bots/api#chatmemberleft
+ */
+export type ChatMemberLeft = {
+	/**
+	 * The member's status in the chat, always “left”
+	 */
+	status: "left";
+
+	/**
+	 * Information about the user
+	 */
+	user: User;
+};

package/@types/ChatMemberMember.ts

@@ -0,0 +1,23 @@
+import type { User } from "./";
+
+/**
+ * ## ChatMemberMember
+ * Represents a chat member that has no additional privileges or restrictions.
+ * @see https://core.telegram.org/bots/api#chatmembermember
+ */
+export type ChatMemberMember = {
+	/**
+	 * The member's status in the chat, always “member”
+	 */
+	status: "member";
+
+	/**
+	 * Information about the user
+	 */
+	user: User;
+
+	/**
+	 * Optional. Date when the user's subscription will expire; Unix time
+	 */
+	until_date?: number;
+};

package/@types/ChatMemberOwner.ts

@@ -0,0 +1,28 @@
+import type { User } from "./";
+
+/**
+ * ## ChatMemberOwner
+ * Represents a chat member that owns the chat and has all administrator privileges.
+ * @see https://core.telegram.org/bots/api#chatmemberowner
+ */
+export type ChatMemberOwner = {
+	/**
+	 * The member's status in the chat, always “creator”
+	 */
+	status: "creator";
+
+	/**
+	 * Information about the user
+	 */
+	user: User;
+
+	/**
+	 * True, if the user's presence in the chat is hidden
+	 */
+	is_anonymous: boolean;
+
+	/**
+	 * Optional. Custom title for this user
+	 */
+	custom_title?: string;
+};