nyx-bot-client 0.0.2

package/@types/BusinessBotRights.ts

@@ -0,0 +1,65 @@
+/**
+ * ## BusinessBotRights
+ * Represents the rights of a business bot.
+ * @see https://core.telegram.org/bots/api#businessbotrights
+ */
+export type BusinessBotRights = {
+	/**
+	 * Optional. True, if the bot can send and edit messages in the private chats
+	 * that had incoming messages in the last 24 hours
+	 */
+	can_reply?: true;
+	/**
+	 * Optional. True, if the bot can mark incoming private messages as read
+	 */
+	can_read_messages?: true;
+	/**
+	 * Optional. True, if the bot can delete messages sent by the bot
+	 */
+	can_delete_sent_messages?: true;
+	/**
+	 * Optional. True, if the bot can delete all private messages in managed chats
+	 */
+	can_delete_all_messages?: true;
+	/**
+	 * Optional. True, if the bot can edit the first and last name of the business account
+	 */
+	can_edit_name?: true;
+	/**
+	 * Optional. True, if the bot can edit the bio of the business account
+	 */
+	can_edit_bio?: true;
+	/**
+	 * Optional. True, if the bot can edit the profile photo of the business account
+	 */
+	can_edit_profile_photo?: true;
+	/**
+	 * Optional. True, if the bot can edit the username of the business account
+	 */
+	can_edit_username?: true;
+	/**
+	 * Optional. True, if the bot can change the privacy settings pertaining to gifts for the business account
+	 */
+	can_change_gift_settings?: true;
+	/**
+	 * Optional. True, if the bot can view gifts and the amount of Telegram Stars owned by the business account
+	 */
+	can_view_gifts_and_stars?: true;
+	/**
+	 * Optional. True, if the bot can convert regular gifts owned by the business account to Telegram Stars
+	 */
+	can_convert_gifts_to_stars?: true;
+	/**
+	 * Optional. True, if the bot can transfer and upgrade gifts owned by the business account
+	 */
+	can_transfer_and_upgrade_gifts?: true;
+	/**
+	 * Optional. True, if the bot can transfer Telegram Stars received by the
+	 * business account to its own account, or use them to upgrade and transfer gifts
+	 */
+	can_transfer_stars?: true;
+	/**
+	 * Optional. True, if the bot can post, edit and delete stories on behalf of the business account
+	 */
+	can_manage_stories?: true;
+};

package/@types/BusinessConnection.ts

@@ -0,0 +1,41 @@
+import type { BusinessBotRights, User } from "./";
+
+/**
+ * ## BusinessConnection
+ * Describes the connection of the bot with a business account.
+ * @see https://core.telegram.org/bots/api#businessconnection
+ */
+export type BusinessConnection = {
+	/**
+	 * Unique identifier of the business connection
+	 */
+	id: string;
+
+	/**
+	 * Business account user that created the business connection
+	 */
+	user: User;
+
+	/**
+	 * Identifier of a private chat with the user who created the business connection. 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_chat_id: number;
+
+	/**
+	 * Date the connection was established in Unix time
+	 */
+	date: number;
+
+	/**
+	 * Optional. Rights of the business bot
+	 */
+	rights?: BusinessBotRights;
+
+	/**
+	 * True, if the connection is active
+	 */
+	is_enabled: boolean;
+};

package/@types/BusinessIntro.ts

@@ -0,0 +1,23 @@
+import type { Sticker } from "./";
+
+/**
+ * ## BusinessIntro
+ * Contains information about the start page settings of a Telegram Business account.
+ * @see https://core.telegram.org/bots/api#businessintro
+ */
+export type BusinessIntro = {
+	/**
+	 * Optional. Title text of the business intro
+	 */
+	title?: string;
+
+	/**
+	 * Optional. Message text of the business intro
+	 */
+	message?: string;
+
+	/**
+	 * Optional. Sticker of the business intro
+	 */
+	sticker?: Sticker;
+};

package/@types/BusinessLocation.ts

@@ -0,0 +1,18 @@
+import type { Location } from "./";
+
+/**
+ * ## BusinessLocation
+ * Contains information about the location of a Telegram Business account.
+ * @see https://core.telegram.org/bots/api#businesslocation
+ */
+export type BusinessLocation = {
+	/**
+	 * Address of the business
+	 */
+	address: string;
+
+	/**
+	 * Optional. Location of the business
+	 */
+	location?: Location;
+};

package/@types/BusinessMessagesDeleted.ts

@@ -0,0 +1,24 @@
+import type { Chat } from "./";
+
+/**
+ * ## BusinessMessagesDeleted
+ * This object is received when messages are deleted from a connected business account.
+ * @see https://core.telegram.org/bots/api#businessmessagesdeleted
+ */
+export type BusinessMessagesDeleted = {
+	/**
+	 * Unique identifier of the business connection
+	 */
+	business_connection_id: string;
+
+	/**
+	 * Information about a chat in the business account. The bot may not have access to the chat or the corresponding
+	 * user.
+	 */
+	chat: Chat;
+
+	/**
+	 * The list of identifiers of deleted messages in the chat of the business account
+	 */
+	message_ids: number[];
+};

package/@types/BusinessOpeningHours.ts

@@ -0,0 +1,18 @@
+import type { BusinessOpeningHoursInterval } from "./";
+
+/**
+ * ## BusinessOpeningHours
+ * Describes the opening hours of a business.
+ * @see https://core.telegram.org/bots/api#businessopeninghours
+ */
+export type BusinessOpeningHours = {
+	/**
+	 * Unique name of the time zone for which the opening hours are defined
+	 */
+	time_zone_name: string;
+
+	/**
+	 * List of time intervals describing business opening hours
+	 */
+	opening_hours: BusinessOpeningHoursInterval[];
+};

package/@types/BusinessOpeningHoursInterval.ts

@@ -0,0 +1,18 @@
+/**
+ * ## BusinessOpeningHoursInterval
+ * Describes an interval of time during which a business is open.
+ * @see https://core.telegram.org/bots/api#businessopeninghoursinterval
+ */
+export type BusinessOpeningHoursInterval = {
+	/**
+	 * The minute's sequence number in a week, starting on Monday, marking the start of the time interval during which the
+	 * business is open; 0 - 7 * 24 * 60
+	 */
+	opening_minute: number;
+
+	/**
+	 * The minute's sequence number in a week, starting on Monday, marking the end of the time interval during which the
+	 * business is open; 0 - 8 * 24 * 60
+	 */
+	closing_minute: number;
+};

package/@types/CallbackGame.ts

@@ -0,0 +1,6 @@
+/**
+ * ## CallbackGame
+ * A placeholder, currently holds no information. Use BotFather to set up your game.
+ * @see https://core.telegram.org/bots/api#callbackgame
+ */
+export type CallbackGame = Record<string, never>;

package/@types/CallbackQuery.ts

@@ -0,0 +1,49 @@
+import type { MaybeInaccessibleMessage, User } from "./";
+
+/**
+ * ## answerCallbackQuery
+ * Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the
+ * user as a notification at the top of the chat screen or as an alert. On success, True is returned.
+ * > Alternatively, the user can be redirected to the specified Game URL. For this option to work, you must first create
+ * a game for your bot via @BotFather and accept the terms. Otherwise, you may use links like `t.me/your_bot?start=XXXX`
+ * that open your bot with a parameter.
+ * @see https://core.telegram.org/bots/api#callbackquery
+ */
+export type CallbackQuery = {
+	/**
+	 * Unique identifier for this query
+	 */
+	id: string;
+
+	/**
+	 * Sender
+	 */
+	from: User;
+
+	/**
+	 * Optional. Message sent by the bot with the callback button that originated the query
+	 */
+	message?: MaybeInaccessibleMessage;
+
+	/**
+	 * Optional. Identifier of the message sent via the bot in inline mode, that originated the query.
+	 */
+	inline_message_id?: string;
+
+	/**
+	 * Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent.
+	 * Useful for high scores in games.
+	 */
+	chat_instance: string;
+
+	/**
+	 * Optional. Data associated with the callback button. Be aware that the message originated the query can contain no
+	 * callback buttons with this data.
+	 */
+	data?: string;
+
+	/**
+	 * Optional. Short name of a Game to be returned, serves as the unique identifier for the game
+	 */
+	game_short_name?: string;
+};

package/@types/Chat.ts

@@ -0,0 +1,43 @@
+/**
+ * ## Chat
+ * This object represents a chat.
+ * @see https://core.telegram.org/bots/api#chat
+ */
+export type Chat = {
+	/**
+	 * 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: string;
+
+	/**
+	 * 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;
+};

package/@types/ChatAdministratorRights.ts

@@ -0,0 +1,84 @@
+/**
+ * ## ChatAdministratorRights
+ * Represents the rights of an administrator in a chat.
+ * @see https://core.telegram.org/bots/api#chatadministratorrights
+ */
+export type ChatAdministratorRights = {
+	/**
+	 * 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;
+
+	/**
+	 * 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;
+};

package/@types/ChatBackground.ts

@@ -0,0 +1,13 @@
+import type { BackgroundType } from "./";
+
+/**
+ * ## ChatBackground
+ * This object represents a chat background.
+ * @see https://core.telegram.org/bots/api#chatbackground
+ */
+export type ChatBackground = {
+	/**
+	 * Type of the background
+	 */
+	type: BackgroundType;
+};

package/@types/ChatBoost.ts

@@ -0,0 +1,29 @@
+import type { ChatBoostSource } from "./";
+
+/**
+ * ## ChatBoost
+ * This object contains information about a chat boost.
+ * @see https://core.telegram.org/bots/api#chatboost
+ */
+export type ChatBoost = {
+	/**
+	 * Unique identifier of the boost
+	 */
+	boost_id: string;
+
+	/**
+	 * Point in time (Unix timestamp) when the chat was boosted
+	 */
+	add_date: number;
+
+	/**
+	 * Point in time (Unix timestamp) when the boost will automatically expire, unless the booster's Telegram Premium
+	 * subscription is prolonged
+	 */
+	expiration_date: number;
+
+	/**
+	 * Source of the added boost
+	 */
+	source: ChatBoostSource;
+};

package/@types/ChatBoostAdded.ts

@@ -0,0 +1,11 @@
+/**
+ * ## ChatBoostAdded
+ * This object contains information about a chat boost.
+ * @see https://core.telegram.org/bots/api#chatboostadded
+ */
+export type ChatBoostAdded = {
+	/**
+	 * Number of boosts added by the user
+	 */
+	boost_count: number;
+};

package/@types/ChatBoostRemoved.ts

@@ -0,0 +1,28 @@
+import type { Chat, ChatBoostSource } from "./";
+
+/**
+ * ## ChatBoostRemoved
+ * This object represents a boost removed from a chat.
+ * @see https://core.telegram.org/bots/api#chatboostremoved
+ */
+export type ChatBoostRemoved = {
+	/**
+	 * Chat which was boosted
+	 */
+	chat: Chat;
+
+	/**
+	 * Unique identifier of the boost
+	 */
+	boost_id: string;
+
+	/**
+	 * Point in time (Unix timestamp) when the boost was removed
+	 */
+	remove_date: number;
+
+	/**
+	 * Source of the removed boost
+	 */
+	source: ChatBoostSource;
+};

package/@types/ChatBoostSource.ts

@@ -0,0 +1,18 @@
+import type {
+	ChatBoostSourceGiftCode,
+	ChatBoostSourceGiveaway,
+	ChatBoostSourcePremium,
+} from "./";
+
+/**
+ * ## ChatBoostSource
+ * This object describes the source of a chat boost. It can be one of
+ * - ChatBoostSourcePremium
+ * - ChatBoostSourceGiftCode
+ * - ChatBoostSourceGiveaway
+ * @see https://core.telegram.org/bots/api#chatboostsource
+ */
+export type ChatBoostSource =
+	| ChatBoostSourcePremium
+	| ChatBoostSourceGiftCode
+	| ChatBoostSourceGiveaway;

package/@types/ChatBoostSourceGiftCode.ts

@@ -0,0 +1,19 @@
+import type { User } from "./";
+
+/**
+ * ## ChatBoostSourceGiftCode
+ * The boost was obtained by the creation of Telegram Premium gift codes to boost a chat. Each such code boosts the chat
+ * 4 times for the duration of the corresponding Telegram Premium subscription.
+ * @see https://core.telegram.org/bots/api#chatboostsourcegiftcode
+ */
+export type ChatBoostSourceGiftCode = {
+	/**
+	 * Source of the boost, always “gift_code”
+	 */
+	source: "gift_code";
+
+	/**
+	 * User for which the gift code was created
+	 */
+	user: User;
+};

package/@types/ChatBoostSourceGiveaway.ts

@@ -0,0 +1,35 @@
+import type { User } from "./";
+
+/**
+ * ## ChatBoostSourceGiveaway
+ * The boost was obtained by the creation of a Telegram Premium giveaway. This boosts the chat 4 times for the duration
+ * of the corresponding Telegram Premium subscription.
+ * @see https://core.telegram.org/bots/api#chatboostsourcegiveaway
+ */
+export type ChatBoostSourceGiveaway = {
+	/**
+	 * Source of the boost, always “giveaway”
+	 */
+	source: "giveaway";
+
+	/**
+	 * Identifier of a message in the chat with the giveaway; the message could have been deleted already. May be 0 if
+	 * the message isn't sent yet.
+	 */
+	giveaway_message_id: number;
+
+	/**
+	 * Optional. User that won the prize in the giveaway if any
+	 */
+	user?: User;
+
+	/**
+	 * Optional. The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only
+	 */
+	prize_star_count?: number;
+
+	/**
+	 * Optional. True, if the giveaway was completed, but there was no user to win the prize
+	 */
+	is_unclaimed?: boolean;
+};

package/@types/ChatBoostSourcePremium.ts

@@ -0,0 +1,19 @@
+import type { User } from "./";
+
+/**
+ * ## ChatBoostSourcePremium
+ * The boost was obtained by subscribing to Telegram Premium or by gifting a Telegram Premium subscription to another
+ * user.
+ * @see https://core.telegram.org/bots/api#chatboostsourcepremium
+ */
+export type ChatBoostSourcePremium = {
+	/**
+	 * Source of the boost, always “premium”
+	 */
+	source: "premium";
+
+	/**
+	 * User that boosted the chat
+	 */
+	user: User;
+};

package/@types/ChatBoostUpdated.ts

@@ -0,0 +1,18 @@
+import type { Chat, ChatBoost } from "./";
+
+/**
+ * ## ChatBoostUpdated
+ * This object represents a boost added to a chat or changed.
+ * @see https://core.telegram.org/bots/api#chatboostupdated
+ */
+export type ChatBoostUpdated = {
+	/**
+	 * Chat which was boosted
+	 */
+	chat: Chat;
+
+	/**
+	 * Information about the chat boost
+	 */
+	boost: ChatBoost;
+};