nyx-bot-client 0.0.2

package/@types/ReactionTypeEmoji.ts

@@ -0,0 +1,92 @@
+const emojis = [
+	"👍",
+	"👎",
+	"❤",
+	"🔥",
+	"🥰",
+	"👏",
+	"😁",
+	"🤔",
+	"🤯",
+	"😱",
+	"🤬",
+	"😢",
+	"🎉",
+	"🤩",
+	"🤮",
+	"💩",
+	"🙏",
+	"👌",
+	"🕊",
+	"🤡",
+	"🥱",
+	"🥴",
+	"😍",
+	"🐳",
+	"❤‍🔥",
+	"🌚",
+	"🌭",
+	"💯",
+	"🤣",
+	"⚡",
+	"🍌",
+	"🏆",
+	"💔",
+	"🤨",
+	"😐",
+	"🍓",
+	"🍾",
+	"💋",
+	"🖕",
+	"😈",
+	"😴",
+	"😭",
+	"🤓",
+	"👻",
+	"👨‍💻",
+	"👀",
+	"🎃",
+	"🙈",
+	"😇",
+	"😨",
+	"🤝",
+	"✍",
+	"🤗",
+	"🫡",
+	"🎅",
+	"🎄",
+	"☃",
+	"💅",
+	"🤪",
+	"🗿",
+	"🆒",
+	"💘",
+	"🙉",
+	"🦄",
+	"😘",
+	"💊",
+	"🙊",
+	"😎",
+	"👾",
+	"🤷‍♂",
+	"🤷",
+	"🤷‍♀",
+	"😡",
+] as const;
+
+/**
+ * ## ReactionTypeEmoji
+ * The reaction is based on an emoji.
+ * @see https://core.telegram.org/bots/api#reactiontypeemoji
+ */
+export type ReactionTypeEmoji = {
+	/**
+	 * Type of the reaction, always “emoji”
+	 */
+	type: "emoji";
+
+	/**
+	 * Reaction emoji. Currently, it can be one of "👍", "👎" ...
+	 */
+	emoji: (typeof emojis)[number] | string;
+};

package/@types/ReactionTypePaid.ts

@@ -0,0 +1,11 @@
+/**
+ * ## ReactionTypePaid
+ * The reaction is paid.
+ * #see https://core.telegram.org/bots/api#reactiontypepaid
+ */
+export type ReactionTypePaid = {
+	/**
+	 * Type of the reaction, always “paid”
+	 */
+	type: "paid";
+};

package/@types/RefundedPayment.ts

@@ -0,0 +1,35 @@
+import type { Currencies } from "./index";
+
+/**
+ * ## RefundedPayment
+ * This object contains basic information about a refunded payment.
+ * @see https://core.telegram.org/bots/api#refundedpayment
+ */
+export type RefundedPayment = {
+	/**
+	 * Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars. Currently, always “XTR”
+	 */
+	currency: Currencies | "XTR";
+
+	/**
+	 * Total refunded price in the smallest units of the currency (integer, not float/double). For example, for a price
+	 * of US$ 1.45, total_amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the
+	 * decimal point for each currency (2 for the majority of currencies).
+	 */
+	total_amount: number;
+
+	/**
+	 * Bot-specified invoice payload
+	 */
+	invoice_payload: string;
+
+	/**
+	 * Telegram payment identifier
+	 */
+	telegram_payment_charge_id: string;
+
+	/**
+	 * Optional. Provider payment identifier
+	 */
+	provider_payment_charge_id?: string;
+};

package/@types/ReplyKeyboardMarkup.ts

@@ -0,0 +1,49 @@
+import type { KeyboardButton } from "./KeyboardButton";
+
+/**
+ * ## ReplyKeyboardMarkup
+ * This object represents a custom keyboard with reply options (see Introduction to bots for details and examples). Not
+ * supported in channels and for messages sent on behalf of a Telegram Business account.
+ * @see https://core.telegram.org/bots/api#replykeyboardmarkup
+ */
+export type ReplyKeyboardMarkup = {
+	/**
+	 * Array of button rows, each represented by an Array of KeyboardButton objects
+	 */
+	keyboard?: KeyboardButton[][];
+
+	/**
+	 * Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in
+	 * which case the custom keyboard can be hidden and opened with a keyboard icon.
+	 */
+	is_persistent?: boolean;
+
+	/**
+	 * Optional. Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if
+	 * there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same
+	 * height as the app's standard keyboard.
+	 */
+	resize_keyboard?: boolean;
+
+	/**
+	 * Optional. Requests clients to hide the keyboard as soon as it's been used. The keyboard will still be available,
+	 * but clients will automatically display the usual letter-keyboard in the chat - the user can press a special button
+	 * in the input field to see the custom keyboard again. Defaults to false.
+	 */
+	one_time_keyboard?: boolean;
+
+	/**
+	 * Optional. The placeholder to be shown in the input field when the keyboard is active; 1-64 characters
+	 */
+	input_field_placeholder?: string;
+
+	/**
+	 * Optional. Use this parameter if you want to show the keyboard to 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.
+	 *
+	 * Example: A user requests to change the bot's language, bot replies to the request with a keyboard to select the
+	 * new language. Other users in the group don't see the keyboard.
+	 */
+	selective?: boolean;
+};

package/@types/ReplyKeyboardRemove.ts

@@ -0,0 +1,25 @@
+/**
+ * ## ReplyKeyboardRemove
+ * Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the
+ * default letter-keyboard. By default, custom keyboards are displayed until a new keyboard is sent by a bot. An
+ * exception is made for one-time keyboards that are hidden immediately after the user presses a button (see
+ * ReplyKeyboardMarkup). Not supported in channels and for messages sent on behalf of a Telegram Business account.
+ * @see https://core.telegram.org/bots/api#replykeyboardremove
+ */
+export type ReplyKeyboardRemove = {
+	/**
+	 * Requests clients to remove the custom keyboard (user will not be able to summon this keyboard; if you want to hide
+	 * the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup)
+	 */
+	remove_keyboard: true;
+
+	/**
+	 * Optional. Use this parameter if you want to remove the keyboard for 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.
+	 *
+	 * Example: A user votes in a poll, bot returns confirmation message in reply to the vote and removes the keyboard for
+	 * that user, while still showing the keyboard with poll options to users who haven't voted yet.
+	 */
+	selective?: boolean;
+};

package/@types/ReplyParameters.ts

@@ -0,0 +1,48 @@
+import type { ParseMode } from "./index";
+
+/**
+ * ## ReplyParameters
+ * Describes reply parameters for the message that is being sent.
+ * @see https://core.telegram.org/bots/api#replyparameters
+ */
+export type ReplyParameters = {
+	/**
+	 * Identifier of the message that will be replied to in the current chat, or in the chat chat_id if it is specified
+	 */
+	message_id: number;
+
+	/**
+	 * Optional. If the message to be replied to is from a different chat, unique identifier for the chat or username of
+	 * the channel (in the format @channelusername). Not supported for messages sent on behalf of a business account.
+	 */
+	chat_id?: number | string;
+
+	/**
+	 * Optional. Pass True if the message should be sent even if the specified message to be replied to is not found.
+	 * Always False for replies in another chat or forum topic. Always True for messages sent on behalf of a business
+	 * account.
+	 */
+	allow_sending_without_reply?: boolean;
+
+	/**
+	 * Optional. Quoted part of the message to be replied to; 0-1024 characters after entities parsing. The quote must be
+	 * an exact substring of the message to be replied to, including bold, italic, underline, strikethrough, spoiler, and
+	 * custom_emoji entities. The message will fail to send if the quote isn't found in the original message.
+	 */
+	quote?: string;
+
+	/**
+	 * Optional. Mode for parsing entities in the quote. See formatting options for more details.
+	 */
+	quote_parse_mode?: ParseMode;
+
+	/**
+	 * Optional. A JSON-serialized list of special entities that appear in the quote. It can be specified instead of
+	 * quote_parse_mode.
+	 */
+	quote_entities?: string; // todo: JSON 	Array of MessageEntity
+	/**
+	 * Optional. Position of the quote in the original message in UTF-16 code units
+	 */
+	quote_position?: number;
+};

package/@types/ResponseParameters.ts

@@ -0,0 +1,19 @@
+/**
+ * ## ResponseParameters
+ * Describes why a request was unsuccessful.
+ * @see https://core.telegram.org/bots/api#responseparameters
+ */
+export type ResponseParameters = {
+	/**
+	 * Optional. The group has been migrated to a supergroup with the specified identifier. 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.
+	 */
+	migrate_to_chat_id?: number;
+
+	/**
+	 * Optional. In case of exceeding flood control, the number of seconds left to wait before the request can be repeated
+	 */
+	retry_after?: number;
+};

package/@types/RevenueWithdrawalState.ts

@@ -0,0 +1,13 @@
+import type { RevenueWithdrawalStateFailed } from "./RevenueWithdrawalStateFailed";
+import type { RevenueWithdrawalStatePending } from "./RevenueWithdrawalStatePending";
+import type { RevenueWithdrawalStateSucceeded } from "./RevenueWithdrawalStateSucceeded";
+
+/**
+ * ## RevenueWithdrawalState
+ * This object describes the state of a revenue withdrawal operation. Currently, it can be one of
+ * @see https://core.telegram.org/bots/api#revenuewithdrawalstate
+ */
+export type RevenueWithdrawalState =
+	| RevenueWithdrawalStatePending
+	| RevenueWithdrawalStateSucceeded
+	| RevenueWithdrawalStateFailed;

package/@types/RevenueWithdrawalStateFailed.ts

@@ -0,0 +1,11 @@
+/**
+ * RevenueWithdrawalStateFailed
+ * The withdrawal failed and the transaction was refunded.
+ * #see https://core.telegram.org/bots/api#revenuewithdrawalstatefailed
+ */
+export type RevenueWithdrawalStateFailed = {
+	/**
+	 * Type of the state, always “failed”
+	 */
+	type: "failed";
+};

package/@types/RevenueWithdrawalStatePending.ts

@@ -0,0 +1,10 @@
+/**
+ * ## RevenueWithdrawalStatePending
+ * The withdrawal is in progress.
+ */
+export type RevenueWithdrawalStatePending = {
+	/**
+	 * Type of the state, always “pending”
+	 */
+	type: "pending";
+};

package/@types/RevenueWithdrawalStateSucceeded.ts

@@ -0,0 +1,21 @@
+/**
+ * ## RevenueWithdrawalStateSucceeded
+ * The withdrawal succeeded.
+ * @see https://core.telegram.org/bots/api#revenuewithdrawalstatesucceeded
+ */
+export type RevenueWithdrawalStateSucceeded = {
+	/**
+	 * Type of the state, always “succeeded”
+	 */
+	type: "succeeded";
+
+	/**
+	 * Date the withdrawal was completed in Unix time
+	 */
+	date: number;
+
+	/**
+	 * An HTTPS URL that can be used to see transaction details
+	 */
+	url: string;
+};

package/@types/SentWebAppMessage.ts

@@ -0,0 +1,12 @@
+/**
+ * ## SentWebAppMessage
+ * Describes an inline message sent by a Web App on behalf of a user.
+ * @see https://core.telegram.org/bots/api#sentwebappmessage
+ */
+export type SentWebAppMessage = {
+	/**
+	 * Optional. Identifier of the sent inline message. Available only if there is an inline keyboard attached to the
+	 * message.
+	 */
+	inline_message_id: string;
+};

package/@types/SharedUser.ts

@@ -0,0 +1,36 @@
+import type { PhotoSize } from "./PhotoSize";
+
+/**
+ * ## SharedUser
+ * This object contains information about a user that was shared with the bot using a KeyboardButtonRequestUsers button.
+ * @see https://core.telegram.org/bots/api#shareduser
+ */
+export type SharedUser = {
+	/**
+	 * Identifier of the shared user. 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 64-bit integers
+	 * or double-precision float types are safe for storing these identifiers. The bot may not have access to the user
+	 * and could be unable to use this identifier, unless the user is already known to the bot by some other means.
+	 */
+	user_id: number;
+
+	/**
+	 * Optional. First name of the user, if the name was requested by the bot
+	 */
+	first_name?: string;
+
+	/**
+	 * Optional. Last name of the user, if the name was requested by the bot
+	 */
+	last_name?: string;
+
+	/**
+	 * Optional. Username of the user, if the username was requested by the bot
+	 */
+	username?: string;
+
+	/**
+	 * Optional. Available sizes of the chat photo, if the photo was requested by the bot
+	 */
+	photo?: PhotoSize[];
+};

package/@types/ShippingAddress.ts

@@ -0,0 +1,36 @@
+/**
+ * ## ShippingAddress
+ * This object represents a shipping address.
+ * @see https://core.telegram.org/bots/api#shippingaddress
+ */
+export type ShippingAddress = {
+	/**
+	 * Two-letter ISO 3166-1 alpha-2 country code
+	 */
+	country_code: string;
+
+	/**
+	 * State, if applicable
+	 */
+	state: string;
+
+	/**
+	 * City
+	 */
+	city: string;
+
+	/**
+	 * First line for the address
+	 */
+	street_line1: string;
+
+	/**
+	 * Second line for the address
+	 */
+	street_line2: string;
+
+	/**
+	 * Address post code
+	 */
+	post_code: string;
+};

package/@types/ShippingOption.ts

@@ -0,0 +1,23 @@
+import type { LabeledPrice } from "./LabeledPrice";
+
+/**
+ * ## ShippingOption
+ * This object represents one shipping option.
+ * @see https://core.telegram.org/bots/api#shippingoption
+ */
+export type ShippingOption = {
+	/**
+	 * Shipping option identifier
+	 */
+	id: string;
+
+	/**
+	 * Option title
+	 */
+	title: string;
+
+	/**
+	 * List of price portions
+	 */
+	prices: LabeledPrice[];
+};

package/@types/ShippingQuery.ts

@@ -0,0 +1,28 @@
+import type { ShippingAddress, User } from "./";
+
+/**
+ * ## ShippingQuery
+ * This object contains information about an incoming shipping query.
+ * @see https://core.telegram.org/bots/api#shippingquery
+ */
+export type ShippingQuery = {
+	/**
+	 * Unique query identifier
+	 */
+	id: string;
+
+	/**
+	 * User who sent the query
+	 */
+	from: User;
+
+	/**
+	 * Bot-specified invoice payload
+	 */
+	invoice_payload: string;
+
+	/**
+	 * User specified shipping address
+	 */
+	shipping_address: ShippingAddress;
+};

package/@types/StarAmount.ts

@@ -0,0 +1,17 @@
+/**
+ * ## StarAmount
+ * Describes an amount of Telegram Stars.
+ * @see https://core.telegram.org/bots/api#staramount
+ */
+export type StarAmount = {
+	/**
+	 * Integer amount of Telegram Stars, rounded to 0; can be negative
+	 */
+	amount: number;
+
+	/**
+	 * Optional. The number of 1/1000000000 shares of Telegram Stars;
+	 * from -999999999 to 999999999; can be negative if and only if amount is non-positive
+	 */
+	nanostar_amount?: number;
+};

package/@types/StarTransaction.ts

@@ -0,0 +1,42 @@
+import type { TransactionPartner } from "./";
+
+/**
+ * ## StarTransaction
+ * Describes a Telegram Star transaction.
+ * @see https://core.telegram.org/bots/api#startransaction
+ */
+export type StarTransaction = {
+	/**
+	 * Unique identifier of the transaction. Coincides with the identifer of the original transaction for refund
+	 * transactions. Coincides with SuccessfulPayment.telegram_payment_charge_id for successful incoming payments from
+	 * users.
+	 */
+	id: string;
+
+	/**
+	 * Number of Telegram Stars transferred by the transaction
+	 */
+	amount: number;
+
+	/**
+	 * Optional. The number of 1/1000000000 shares of Telegram Stars transferred by the transaction; from 0 to 999999999
+	 */
+	nanostar_amount?: number;
+
+	/**
+	 * Date the transaction was created in Unix time
+	 */
+	date: number;
+
+	/**
+	 * Optional. Source of an incoming transaction (e.g., a user purchasing goods or services, Fragment refunding a failed
+	 * withdrawal). Only for incoming transactions
+	 */
+	source?: TransactionPartner;
+
+	/**
+	 * Optional. Receiver of an outgoing transaction (e.g., a user for a purchase refund, Fragment for a withdrawal). Only
+	 * for outgoing transactions
+	 */
+	receiver?: TransactionPartner;
+};

package/@types/StarTransactions.ts

@@ -0,0 +1,13 @@
+import type { StarTransaction } from "./StarTransaction";
+
+/**
+ * ## StarTransactions
+ * Contains a list of Telegram Star transactions.
+ * @see https://core.telegram.org/bots/api#startransactions
+ */
+export type StarTransactions = {
+	/**
+	 * The list of transactions
+	 */
+	transactions: StarTransaction[];
+};

package/@types/Sticker.ts

@@ -0,0 +1,86 @@
+import type { File, MaskPosition, PhotoSize } from "./";
+
+/**
+ * ## Sticker
+ * This object represents a sticker.
+ * @see https://core.telegram.org/bots/api#sticker
+ */
+export type Sticker = {
+	/**
+	 * 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;
+
+	/**
+	 * Type of the sticker, currently one of “regular”, “mask”, “custom_emoji”. The type of the sticker is independent
+	 * from its format, which is determined by the fields is_animated and is_video.
+	 */
+	type: "regular" | "mask" | "custom_emoji";
+
+	/**
+	 * Sticker width
+	 */
+	width: number;
+
+	/**
+	 * Sticker height
+	 */
+	height: number;
+
+	/**
+	 * True, if the sticker is animated
+	 */
+	is_animated: boolean;
+
+	/**
+	 * True, if the sticker is a video sticker
+	 */
+	is_voice: boolean;
+
+	/**
+	 * Optional. Sticker thumbnail in the .WEBP or .JPG format
+	 */
+	thumbnail?: PhotoSize;
+
+	/**
+	 * Optional. Emoji associated with the sticker
+	 */
+	emoji?: string;
+
+	/**
+	 * Optional. Name of the sticker set to which the sticker belongs
+	 */
+	set_name?: string;
+
+	/**
+	 * Optional. For premium regular stickers, premium animation for the sticker
+	 */
+	premium_animation?: File;
+
+	/**
+	 * Optional. For mask stickers, the position where the mask should be placed
+	 */
+	mask_position?: MaskPosition;
+
+	/**
+	 * Optional. For custom emoji stickers, unique identifier of the custom emoji
+	 */
+	custom_emoji_id?: string;
+
+	/**
+	 * Optional. True, if the sticker must be repainted to a text color in messages, the color of the Telegram Premium
+	 * badge in emoji status, white color on chat photos, or another appropriate color in other places
+	 */
+	needs_repainting?: boolean;
+
+	/**
+	 * Optional. File size in bytes
+	 */
+	file_size?: number;
+};

package/@types/StickerSet.ts

@@ -0,0 +1,33 @@
+import type { PhotoSize, Sticker } from "./";
+
+/**
+ * ## StickerSet
+ * This object represents a sticker set.
+ * @see https://core.telegram.org/bots/api#stickerset
+ */
+export type StickerSet = {
+	/**
+	 * Sticker set name
+	 */
+	name: string;
+
+	/**
+	 * Sticker set title
+	 */
+	title: string;
+
+	/**
+	 * Type of stickers in the set, currently one of “regular”, “mask”, “custom_emoji”
+	 */
+	sticker_type: Sticker["type"];
+
+	/**
+	 * List of all set stickers
+	 */
+	stickers: Sticker[];
+
+	/**
+	 * Optional. Sticker set thumbnail in the .WEBP, .TGS, or .WEBM format
+	 */
+	thumbnail?: PhotoSize;
+};