nyx-bot-client 0.0.2

package/@types/UniqueGiftInfo.ts

@@ -0,0 +1,42 @@
+import type { UniqueGift } from "./";
+
+/**
+ * ## UniqueGiftInfo
+ * Describes a service message about a unique gift that was sent or received.
+ * @see https://core.telegram.org/bots/api#uniquegiftinfo
+ */
+export type UniqueGiftInfo = {
+	/**
+	 * Information about the gift
+	 */
+	gift: UniqueGift;
+
+	/**
+	 * Origin of the gift. Currently, either "upgrade" for gifts upgraded from regular gifts, "transfer" for gifts
+	 * transferred from other users or channels, or "resale" for gifts bought from other users
+	 */
+	origin: string;
+
+	/**
+	 * Optional. For gifts bought from other users, the price paid for the gift
+	 */
+	last_resale_star_count?: number;
+
+	/**
+	 * Optional. Unique identifier of the received gift for the bot; only present for gifts received on behalf of
+	 * business accounts
+	 */
+	owned_gift_id?: string;
+
+	/**
+	 * Optional. Number of Telegram Stars that must be paid to transfer the gift; omitted if the bot cannot transfer
+	 * the gift
+	 */
+	transfer_star_count?: number;
+
+	/**
+	 * Optional. Point in time (Unix timestamp) when the gift can be transferred. If it is in the past, then the gift
+	 * can be transferred now
+	 */
+	next_transfer_date?: number;
+};

package/@types/UniqueGiftModel.ts

@@ -0,0 +1,23 @@
+import type { Sticker } from "./";
+
+/**
+ * ## UniqueGiftModel
+ * This object describes the model of a unique gift.
+ * @see https://core.telegram.org/bots/api#uniquegiftmodel
+ */
+export type UniqueGiftModel = {
+	/**
+	 * Name of the model
+	 */
+	name: string;
+
+	/**
+	 * The sticker that represents the unique gift
+	 */
+	sticker: Sticker;
+
+	/**
+	 * The number of unique gifts that receive this model for every 1000 gifts upgraded
+	 */
+	rarity_per_mille: number;
+};

package/@types/UniqueGiftSymbol.ts

@@ -0,0 +1,23 @@
+import type { Sticker } from "./";
+
+/**
+ * ## UniqueGiftSymbol
+ * This object describes the symbol shown on the pattern of a unique gift.
+ * @see https://core.telegram.org/bots/api#uniquegiftsymbol
+ */
+export type UniqueGiftSymbol = {
+	/**
+	 * Name of the symbol
+	 */
+	name: string;
+
+	/**
+	 * The sticker that represents the unique gift
+	 */
+	sticker: Sticker;
+
+	/**
+	 * The number of unique gifts that receive this model for every 1000 gifts upgraded
+	 */
+	rarity_per_mille: number;
+};

package/@types/Update.ts

@@ -0,0 +1,177 @@
+import type { AtMostOne } from "../utils";
+import type {
+	BusinessConnection,
+	BusinessMessagesDeleted,
+	CallbackQuery,
+	ChatBoostRemoved,
+	ChatBoostUpdated,
+	ChatJoinRequest,
+	ChatMemberUpdated,
+	ChosenInlineResult,
+	InlineQuery,
+	Message,
+	MessageReactionCountUpdated,
+	MessageReactionUpdated,
+	PaidMediaPurchased,
+	Poll,
+	PollAnswer,
+	PreCheckoutQuery,
+	ShippingQuery,
+} from "./";
+
+/**
+ * @see https://core.telegram.org/bots/api#update
+ */
+export type EventTypes = {
+	/**
+	 * New incoming message of any kind - text, photo, sticker, etc.
+	 */
+	message: Message;
+
+	/**
+	 * New version of a message that is known to the bot and was edited. This update may at times be triggered by changes
+	 * to message fields that are either unavailable or not actively used by your bot.
+	 */
+	edited_message: Message;
+
+	/**
+	 * New incoming channel post of any kind - text, photo, sticker, etc.
+	 */
+	channel_post: Message;
+
+	/**
+	 * New version of a channel post that is known to the bot and was edited. This update may at times be triggered by
+	 * changes to message fields that are either unavailable or not actively used by your bot.
+	 */
+	edited_channel_post: Message;
+
+	/**
+	 * The bot was connected to or disconnected from a business account, or a user edited an existing connection with the
+	 * bot
+	 */
+	business_connection: BusinessConnection;
+
+	/**
+	 * New message from a connected business account
+	 */
+	business_message: Message;
+
+	/**
+	 * New version of a message from a connected business account
+	 */
+	edited_business_message: Message;
+
+	/**
+	 * Messages were deleted from a connected business account
+	 */
+	deleted_business_messages: BusinessMessagesDeleted;
+
+	/**
+	 * A reaction to a message was changed by a user. The bot must be an administrator in the chat and must explicitly
+	 * specify "message_reaction" in the list of allowed_updates to receive these updates. The update isn't received for
+	 * reactions set by bots.
+	 */
+	message_reaction: MessageReactionUpdated;
+
+	/**
+	 * Reactions to a message with anonymous reactions were changed. The bot must be an administrator in the chat and must
+	 * explicitly specify "message_reaction_count" in the list of allowed_updates to receive these updates. The updates
+	 * are grouped and can be sent with delay up to a few minutes.
+	 */
+	message_reaction_count: MessageReactionCountUpdated;
+
+	/**
+	 * New incoming inline query
+	 */
+	inline_query: InlineQuery;
+
+	/**
+	 * The result of an inline query that was chosen by a user and sent to their chat partner. Please see our
+	 * documentation on the feedback collecting for details on how to enable these updates for your bot.
+	 */
+	chosen_inline_result: ChosenInlineResult;
+
+	/**
+	 * New incoming callback query
+	 */
+	callback_query: CallbackQuery;
+
+	/**
+	 * New incoming shipping query. Only for invoices with flexible price
+	 */
+	shipping_query: ShippingQuery;
+
+	/**
+	 * New incoming pre-checkout query. Contains full information about checkout
+	 */
+	pre_checkout_query: PreCheckoutQuery;
+
+	/**
+	 * A user purchased paid media with a non-empty payload sent by the bot in a non-channel chat
+	 */
+	purchased_paid_media: PaidMediaPurchased;
+
+	/**
+	 * New poll state. Bots receive only updates about manually stopped polls and polls, which are sent by the bot
+	 */
+	poll: Poll;
+
+	/**
+	 * A user changed their answer in a non-anonymous poll. Bots receive new votes only in polls that were sent by the bot
+	 * itself.
+	 */
+	poll_answer: PollAnswer;
+
+	/**
+	 * The bot's chat member status was updated in a chat. For private chats, this update is received only when the bot is
+	 * blocked or unblocked by the user.
+	 */
+	my_chat_member: ChatMemberUpdated;
+
+	/**
+	 * A chat member's status was updated in a chat. The bot must be an administrator in the chat and must explicitly
+	 * specify "chat_member" in the list of allowed_updates to receive these updates.
+	 */
+	chat_member: ChatMemberUpdated;
+
+	/**
+	 * A request to join the chat has been sent. The bot must have the can_invite_users administrator right in the chat to
+	 * receive these updates.
+	 */
+	chat_join_request: ChatJoinRequest;
+
+	/**
+	 * A chat boost was added or changed. The bot must be an administrator in the chat to receive these updates.
+	 */
+	chat_boost: ChatBoostUpdated;
+
+	/**
+	 * A boost was removed from a chat. The bot must be an administrator in the chat to receive these updates.
+	 */
+	removed_chat_boost: ChatBoostRemoved;
+};
+
+/**
+ * All possible update types.
+ * @see https://core.telegram.org/bots/api#update
+ */
+export type UpdateType = keyof EventTypes;
+
+/**
+ * ## Update
+ * This object represents an incoming update.
+ * At most one of the optional parameters can be present in any given update.
+ * @see https://core.telegram.org/bots/api#update
+ */
+export type Update = {
+	/**
+	 * The update's unique identifier. Update identifiers start from a certain positive number and increase sequentially.
+	 * This identifier becomes especially handy if you're using [webhooks](https://core.telegram.org/bots/api#setwebhook),
+	 * since it allows you to ignore repeated updates or to restore the correct update sequence, should they get out of
+	 * order. If there are no new updates for at least a week, then identifier of the next update will be chosen randomly
+	 * instead of sequentially.
+	 */
+	update_id: number;
+} & AtMostOne<{
+	[K in UpdateType]: EventTypes[K];
+}>;

package/@types/User.ts

@@ -0,0 +1,74 @@
+/**
+ * ## User
+ * This object represents a Telegram user or bot.
+ * @see https://core.telegram.org/bots/api#user
+ */
+export type User = {
+	/**
+	 * Unique identifier for this user or bot. 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.
+	 */
+	id: number;
+
+	/**
+	 * True, if this user is a bot
+	 */
+	is_bot: boolean;
+
+	/**
+	 * User's or bot's first name
+	 */
+	first_name: string;
+
+	/**
+	 * Optional. User's or bot's last name
+	 */
+	last_name?: string;
+
+	/**
+	 * Optional. User's or bot's username
+	 */
+	username?: string;
+
+	/**
+	 * Optional. IETF language tag of the user's language
+	 */
+	language_code?: string;
+
+	/**
+	 * Optional. True, if this user is a Telegram Premium user
+	 */
+	is_premium?: boolean;
+
+	/**
+	 * Optional. True, if this user added the bot to the attachment menu
+	 */
+	added_to_attachment_menu?: boolean;
+
+	/**
+	 * Optional. True, if the bot can be invited to groups. Returned only in getMe.
+	 */
+	can_join_groups?: boolean;
+
+	/**
+	 * Optional. True, if privacy mode is disabled for the bot. Returned only in getMe.
+	 */
+	can_read_all_group_messages?: boolean;
+
+	/**
+	 * Optional. True, if the bot supports inline queries. Returned only in getMe.
+	 */
+	supports_inline_queries?: boolean;
+
+	/**
+	 * Optional. True, if the bot can be connected to a Telegram Business account to receive its messages. Returned only
+	 * in getMe.
+	 */
+	can_connect_to_business?: boolean;
+
+	/**
+	 * Optional. True, if the bot has a main Web App. Returned only in getMe.
+	 */
+	has_main_web_app?: boolean;
+};

package/@types/UserProfilePhotos.ts

@@ -0,0 +1,18 @@
+import type { PhotoSize } from "./";
+
+/**
+ * ## UserProfilePhotos
+ * This object represent a user's profile pictures.
+ * @see https://core.telegram.org/bots/api#userprofilephotos
+ */
+export type UserProfilePhotos = {
+	/**
+	 * Total number of profile pictures the target user has
+	 */
+	total_count: number;
+
+	/**
+	 * Requested profile pictures (in up to 4 sizes each)
+	 */
+	photos: PhotoSize[][];
+};

package/@types/UsersShared.ts

@@ -0,0 +1,19 @@
+import type { SharedUser } from "./";
+
+/**
+ * ## UsersShared
+ * This object contains information about the users whose identifiers were shared with the bot using a
+ * KeyboardButtonRequestUsers button.
+ * @see https://core.telegram.org/bots/api#usersshared
+ */
+export type UsersShared = {
+	/**
+	 * Identifier of the request
+	 */
+	request_id: number;
+
+	/**
+	 * Information about users shared with the bot.
+	 */
+	users: SharedUser[];
+};

package/@types/Venue.ts

@@ -0,0 +1,48 @@
+import type { Location } from "./";
+
+/**
+ * ## Venue
+ * This object represents a venue.
+ * @see https://core.telegram.org/bots/api#venue
+ */
+export type Venue = {
+	/**
+	 * Venue location. Can't be a live location
+	 */
+	location: Location;
+
+	/**
+	 * Name of the venue
+	 */
+	title: string;
+
+	/**
+	 * Address of the venue
+	 */
+	address: string;
+
+	/**
+	 * Optional. Foursquare identifier of the venue
+	 */
+	foursquare_id?: string;
+
+	/**
+	 * Optional. Foursquare identifier of the venue
+	 */
+	foursquare_type?: string;
+
+	/**
+	 * Optional. Foursquare type of the venue. (For example, “arts_entertainment/default”, “arts_entertainment/aquarium”
+	 * or “food/icecream”.)
+	 */
+	google_place_id?: string;
+
+	/**
+	 * Optional. Google Places identifier of the venue
+	 */
+	google_place_type?: string;
+
+	/**
+	 * Optional. Google Places type of the venue. (See supported types.)
+	 */
+};

package/@types/Video.ts

@@ -0,0 +1,66 @@
+import type { PhotoSize } from "./";
+
+/**
+ * ## Video
+ * This object represents a video file.
+ * @see https://core.telegram.org/bots/api#video
+ */
+export type Video = {
+	/**
+	 * 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;
+
+	/**
+	 * Video width as defined by the sender
+	 */
+	width: number;
+
+	/**
+	 * Video height as defined by the sender
+	 */
+	height: number;
+
+	/**
+	 * Duration of the video in seconds as defined by the sender
+	 */
+	duration: number;
+
+	/**
+	 * Optional. Video thumbnail
+	 */
+	thumbnail?: PhotoSize;
+
+	/**
+	 * Optional. Available sizes of the cover of the video in the message
+	 */
+	cover?: PhotoSize[];
+
+	/**
+	 * Optional. Timestamp in seconds from which the video will play in the message
+	 */
+	start_timestamp?: number;
+
+	/**
+	 * Optional. Original filename as defined by the sender
+	 */
+	file_name?: string;
+
+	/**
+	 * Optional. 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/VideoChatEnded.ts

@@ -0,0 +1,11 @@
+/**
+ * ## VideoChatEnded
+ * This object represents a service message about a video chat ended in the chat.
+ * @see https://core.telegram.org/bots/api#videochatended
+ */
+export type VideoChatEnded = {
+	/**
+	 * Video chat duration in seconds
+	 */
+	duration: number;
+};

package/@types/VideoChatParticipantsInvited.ts

@@ -0,0 +1,13 @@
+import type { User } from "./";
+
+/**
+ * ## VideoChatParticipantsInvited
+ * This object represents a service message about new members invited to a video chat.
+ * @see https://core.telegram.org/bots/api#videochatparticipantsinvited
+ */
+export type VideoChatParticipantsInvited = {
+	/**
+	 * New members that were invited to the video chat
+	 */
+	users: User[];
+};

package/@types/VideoChatScheduled.ts

@@ -0,0 +1,11 @@
+/**
+ * ## VideoChatScheduled
+ * This object represents a service message about a video chat scheduled in the chat.
+ * @see https://core.telegram.org/bots/api#videochatscheduled
+ */
+export type VideoChatScheduled = {
+	/**
+	 * Point in time (Unix timestamp) when the video chat is supposed to be started by a chat administrator
+	 */
+	start_date: number;
+};

package/@types/VideoChatStarted.ts

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

package/@types/VideoNote.ts

@@ -0,0 +1,39 @@
+import type { PhotoSize } from "./";
+
+/**
+ * ## VideoNote
+ * This object represents a video message (available in Telegram apps as of v.4.0).
+ * @see https://core.telegram.org/bots/api#videonote
+ */
+export type VideoNote = {
+	/**
+	 * 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;
+
+	/**
+	 * Video width and height (diameter of the video message) as defined by the sender
+	 */
+	length: number;
+
+	/**
+	 * Duration of the video in seconds as defined by the sender
+	 */
+	duration: number;
+
+	/**
+	 * Optional. Video thumbnail
+	 */
+	thumbnail?: PhotoSize;
+
+	/**
+	 * Optional. File size in bytes
+	 */
+	file_size?: number;
+};

package/@types/Voice.ts

@@ -0,0 +1,34 @@
+/**
+ * ## Voice
+ * This object represents a voice note.
+ * @see https://core.telegram.org/bots/api#voice
+ */
+export type Voice = {
+	/**
+	 * 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;
+
+	/**
+	 * Duration of the audio in seconds as defined by the sender
+	 */
+	duration: number;
+
+	/**
+	 * Optional. 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/WebAppData.ts

@@ -0,0 +1,17 @@
+/**
+ * ## WebAppData
+ * Describes data sent from a Web App to the bot.
+ * @see https://core.telegram.org/bots/api#webappdata
+ */
+export type WebAppData = {
+	/**
+	 * The data. Be aware that a bad client can send arbitrary data in this field.
+	 */
+	data: string;
+
+	/**
+	 * Text of the web_app keyboard button from which the Web App was opened. Be aware that a bad client can send
+	 * arbitrary data in this field.
+	 */
+	button_text: string;
+};

package/@types/WebAppInfo.ts

@@ -0,0 +1,11 @@
+/**
+ * ## WebAppInfo
+ * Describes a Web App.
+ * @see https://core.telegram.org/bots/api#webappinfo
+ */
+export type WebAppInfo = {
+	/**
+	 * An HTTPS URL of a Web App to be opened with additional data as specified in Initializing Web Apps
+	 */
+	url: string;
+};