nyx-bot-client 0.0.2

package/@types/Story.ts

@@ -0,0 +1,18 @@
+import type { Chat } from "./Chat";
+
+/**
+ * ## Story
+ * This object represents a story.
+ * @see https://core.telegram.org/bots/api#story
+ */
+export type Story = {
+	/**
+	 * Chat that posted the story
+	 */
+	chat: Chat;
+
+	/**
+	 * Unique identifier for the story in the chat
+	 */
+	id: number;
+};

package/@types/StoryArea.ts

@@ -0,0 +1,18 @@
+import type { StoryAreaPosition, StoryAreaType } from "./";
+
+/**
+ * ## StoryArea
+ * Describes a clickable area on a story media.
+ * @see https://core.telegram.org/bots/api#storyarea
+ */
+export type StoryArea = {
+	/**
+	 * Position of the area
+	 */
+	position: StoryAreaPosition;
+
+	/**
+	 * Type of the area
+	 */
+	type: StoryAreaType;
+};

package/@types/StoryAreaPosition.ts

@@ -0,0 +1,36 @@
+/**
+ * ## StoryAreaPosition
+ * Describes the position of a clickable area within a story.
+ * @see https://core.telegram.org/bots/api#storyareaposition
+ */
+export type StoryAreaPosition = {
+	/**
+	 * The abscissa of the area's center, as a percentage of the media width
+	 */
+	x_percentage: number;
+
+	/**
+	 * The ordinate of the area's center, as a percentage of the media height
+	 */
+	y_percentage: number;
+
+	/**
+	 * The width of the area's rectangle, as a percentage of the media width
+	 */
+	width_percentage: number;
+
+	/**
+	 * The height of the area's rectangle, as a percentage of the media height
+	 */
+	height_percentage: number;
+
+	/**
+	 * The clockwise rotation angle of the rectangle, in degrees; 0-360
+	 */
+	rotation_angle: number;
+
+	/**
+	 * The radius of the rectangle corner rounding, as a percentage of the media
+	 */
+	corner_radius_percentage: number;
+};

package/@types/StoryAreaType.ts

@@ -0,0 +1,24 @@
+import type {
+	StoryAreaTypeLink,
+	StoryAreaTypeLocation,
+	StoryAreaTypeSuggestedReaction,
+	StoryAreaTypeUniqueGift,
+	StoryAreaTypeWeather,
+} from "./";
+
+/**
+ * ## StoryAreaType
+ * Describes the type of a clickable area on a story. Currently, it can be one of:
+ * - StoryAreaTypeLocation
+ * - StoryAreaTypeSuggestedReaction
+ * - StoryAreaTypeLink
+ * - StoryAreaTypeWeather
+ * - StoryAreaTypeUniqueGift
+ * @see https://core.telegram.org/bots/api#storyareatype
+ */
+export type StoryAreaType =
+	| StoryAreaTypeLocation
+	| StoryAreaTypeSuggestedReaction
+	| StoryAreaTypeLink
+	| StoryAreaTypeWeather
+	| StoryAreaTypeUniqueGift;

package/@types/StoryAreaTypeLink.ts

@@ -0,0 +1,16 @@
+/**
+ * ## StoryAreaTypeLink
+ * Describes a story area pointing to an HTTP or tg:// link. Currently, a story can have up to 3 link areas.
+ * @see https://core.telegram.org/bots/api#storyareatypelink
+ */
+export type StoryAreaTypeLink = {
+	/**
+	 * Type of the area, always “link”
+	 */
+	type: "link";
+
+	/**
+	 * HTTP or tg:// URL to be opened when the area is clicked
+	 */
+	url: string;
+};

package/@types/StoryAreaTypeLocation.ts

@@ -0,0 +1,28 @@
+import type { LocationAddress } from "./";
+
+/**
+ * ## StoryAreaTypeLocation
+ * Describes a story area pointing to a location. Currently, a story can have up to 10 location areas.
+ * @see https://core.telegram.org/bots/api#storyareatypelocation
+ */
+export type StoryAreaTypeLocation = {
+	/**
+	 * Type of the area, always “location”
+	 */
+	type: "location";
+
+	/**
+	 * Location latitude in degrees
+	 */
+	latitude: number;
+
+	/**
+	 * Location longitude in degrees
+	 */
+	longitude: number;
+
+	/**
+	 * Optional. Address of the location
+	 */
+	address?: LocationAddress;
+};

package/@types/StoryAreaTypeSuggestedReaction.ts

@@ -0,0 +1,29 @@
+import type { ReactionType } from "./";
+
+/**
+ * ## StoryAreaTypeSuggestedReaction
+ * Describes a story area pointing to a suggested reaction. Currently, a story
+ * can have up to 5 suggested reaction areas.
+ * @see https://core.telegram.org/bots/api#storyareatypesuggestedreaction
+ */
+export type StoryAreaTypeSuggestedReaction = {
+	/**
+	 * Type of the area, always “suggested_reaction”
+	 */
+	type: "suggested_reaction";
+
+	/**
+	 * Type of the reaction
+	 */
+	reaction_type: ReactionType;
+
+	/**
+	 * Optional. Pass True if the reaction area has a dark background
+	 */
+	is_dark?: boolean;
+
+	/**
+	 * Optional. Pass True if reaction area corner is flipped
+	 */
+	is_flipped?: boolean;
+};

package/@types/StoryAreaTypeUniqueGift.ts

@@ -0,0 +1,16 @@
+/**
+ * ## StoryAreaTypeUniqueGift
+ * Describes a story area pointing to a unique gift. Currently, a story can have at most 1 unique gift area.
+ * @see https://core.telegram.org/bots/api#storyareatypeuniquegift
+ */
+export type StoryAreaTypeUniqueGift = {
+	/**
+	 * Type of the area, always “unique_gift”
+	 */
+	type: "unique_gift";
+
+	/**
+	 * Unique name of the gift
+	 */
+	name: string;
+};

package/@types/StoryAreaTypeWeather.ts

@@ -0,0 +1,26 @@
+/**
+ * ## StoryAreaTypeWeather
+ * Describes a story area containing weather information. Currently, a story can have up to 3 weather areas.
+ * @see https://core.telegram.org/bots/api#storyareatypeweather
+ */
+export type StoryAreaTypeWeather = {
+	/**
+	 * Type of the area, always “weather”
+	 */
+	type: "weather";
+
+	/**
+	 * Temperature, in degree Celsius
+	 */
+	temperature: number;
+
+	/**
+	 * Emoji representing the weather
+	 */
+	emoji: string;
+
+	/**
+	 * A color of the area background in the ARGB format
+	 */
+	background_color: number;
+};

package/@types/SuccessfulPayment.ts

@@ -0,0 +1,60 @@
+import type { Currencies, OrderInfo } from "./";
+
+/**
+ * ## SuccessfulPayment
+ * This object contains basic information about a successful payment.
+ * @see https://core.telegram.org/bots/api#successfulpayment
+ */
+export type SuccessfulPayment = {
+	/**
+	 * Three-letter ISO 4217 currency code, or “XTR” for payments in Telegram Stars
+	 */
+	currency: Currencies | "XTR";
+
+	/**
+	 * Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45
+	 * pass 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;
+
+	/**
+	 * Optional. Expiration date of the subscription, in Unix time; for recurring payments only
+	 */
+	subscription_expiration_date?: number;
+
+	/**
+	 * Optional. True, if the payment is a recurring payment for a subscription
+	 */
+	is_recurring?: boolean;
+
+	/**
+	 * Optional. True, if the payment is the first payment for a subscription
+	 */
+	is_first_recurring?: boolean;
+
+	/**
+	 * Optional. Identifier of the shipping option chosen by the user
+	 */
+	shipping_option_id?: string;
+
+	/**
+	 * Optional. Order information provided by the user
+	 */
+	order_info?: OrderInfo;
+
+	/**
+	 * Telegram payment identifier
+	 */
+	telegram_payment_charge_id: string;
+
+	/**
+	 * Provider payment identifier
+	 */
+	provider_payment_charge_id: string;
+};

package/@types/SwitchInlineQueryChosenChat.ts

@@ -0,0 +1,33 @@
+/**
+ * ## SwitchInlineQueryChosenChat
+ * This object represents an inline button that switches the current user to inline mode in a chosen chat, with an
+ * optional default inline query.
+ * @see https://core.telegram.org/bots/api#switchinlinequerychosenchat
+ */
+export type SwitchInlineQueryChosenChat = {
+	/**
+	 * Optional. The default inline query to be inserted in the input field. If left empty, only the bot's username will
+	 * be inserted
+	 */
+	query: string;
+
+	/**
+	 * Optional. True, if private chats with users can be chosen
+	 */
+	allow_user_chats?: boolean;
+
+	/**
+	 * Optional. True, if private chats with bots can be chosen
+	 */
+	allow_bot_chats?: boolean;
+
+	/**
+	 * Optional. True, if group and supergroup chats can be chosen
+	 */
+	allow_group_chats?: boolean;
+
+	/**
+	 * Optional. True, if channel chats can be chosen
+	 */
+	allow_channel_chats?: boolean;
+};

package/@types/TextQuote.ts

@@ -0,0 +1,30 @@
+import type { MessageEntity } from "./";
+
+/**
+ * ## TextQuote
+ * This object contains information about the quoted part of a message that is replied to by the given message.
+ * @see https://core.telegram.org/bots/api#textquote
+ */
+export type TextQuote = {
+	/**
+	 * Text of the quoted part of a message that is replied to by the given message
+	 */
+	text: string;
+
+	/**
+	 * Optional. Special entities that appear in the quote. Currently, only bold, italic, underline, strikethrough,
+	 * spoiler, and custom_emoji entities are kept in quotes.
+	 */
+	entities: MessageEntity[];
+
+	/**
+	 * Approximate quote position in the original message in UTF-16 code units as specified by the sender
+	 */
+	position: number;
+
+	/**
+	 * Optional. True, if the quote was chosen manually by the message sender. Otherwise, the quote was added
+	 * automatically by the server.
+	 */
+	is_manual: boolean;
+};

package/@types/TransactionPartner.ts

@@ -0,0 +1,31 @@
+import type {
+	TransactionPartnerAffiliateProgram,
+	TransactionPartnerChat,
+	TransactionPartnerFragment,
+	TransactionPartnerOther,
+	TransactionPartnerTelegramAds,
+	TransactionPartnerTelegramApi,
+	TransactionPartnerUser,
+} from "./";
+
+/**
+ * ## TransactionPartner
+ * This object describes the source of a transaction, or its recipient for outgoing transactions. Currently, it can be
+ * one of
+ * - TransactionPartnerUser
+ * - TransactionPartnerChat
+ * - TransactionPartnerAffiliateProgram
+ * - TransactionPartnerFragment
+ * - TransactionPartnerTelegramAds
+ * - TransactionPartnerTelegramApi
+ * - TransactionPartnerOther
+ * @see https://core.telegram.org/bots/api#transactionpartner
+ */
+export type TransactionPartner =
+	| TransactionPartnerUser
+	| TransactionPartnerChat
+	| TransactionPartnerAffiliateProgram
+	| TransactionPartnerFragment
+	| TransactionPartnerTelegramAds
+	| TransactionPartnerTelegramApi
+	| TransactionPartnerOther;

package/@types/TransactionPartnerAffiliateProgram.ts

@@ -0,0 +1,24 @@
+import type { User } from "./";
+
+/**
+ * ## TransactionPartnerAffiliateProgram
+ * Describes the affiliate program that issued the affiliate commission received via this transaction.
+ * @see https://core.telegram.org/bots/api#transactionpartneraffiliateprogram
+ */
+export type TransactionPartnerAffiliateProgram = {
+	/**
+	 * Type of the transaction partner, always “affiliate_program”
+	 */
+	type: "affiliate_program";
+
+	/**
+	 * Optional. Information about the bot that sponsored the affiliate program
+	 */
+	sponsor_user?: User;
+
+	/**
+	 * The number of Telegram Stars received by the bot for each 1000 Telegram Stars received by the affiliate program
+	 * sponsor from referred users
+	 */
+	commission_per_mille: number;
+};

package/@types/TransactionPartnerChat.ts

@@ -0,0 +1,21 @@
+import type { Chat, Gift } from "./";
+
+/**
+ * Describes a transaction with a chat.
+ */
+export type TransactionPartnerChat = {
+	/**
+	 * Type of the transaction partner, always “chat”
+	 */
+	type: "chat";
+
+	/**
+	 * Information about the chat
+	 */
+	chat: Chat;
+
+	/**
+	 * Optional. The gift sent to the chat by the bot
+	 */
+	gift?: Gift;
+};

package/@types/TransactionPartnerFragment.ts

@@ -0,0 +1,18 @@
+import type { RevenueWithdrawalState } from "./RevenueWithdrawalState";
+
+/**
+ * ## TransactionPartnerFragment
+ * Describes a withdrawal transaction with Fragment.
+ * @see https://core.telegram.org/bots/api#transactionpartnerfragment
+ */
+export type TransactionPartnerFragment = {
+	/**
+	 * Type of the transaction partner, always “fragment”
+	 */
+	type: "fragment";
+
+	/**
+	 * Optional. State of the transaction if the transaction is outgoing
+	 */
+	withdrawal_state?: RevenueWithdrawalState;
+};

package/@types/TransactionPartnerOther.ts

@@ -0,0 +1,11 @@
+/**
+ * ## TransactionPartnerOther
+ * Describes a transaction with an unknown source or recipient.
+ * @see https://core.telegram.org/bots/api#transactionpartneruser
+ */
+export type TransactionPartnerOther = {
+	/**
+	 * Type of the transaction partner, always “other”
+	 */
+	type: "other";
+};

package/@types/TransactionPartnerTelegramAds.ts

@@ -0,0 +1,11 @@
+/**
+ * ## TransactionPartnerTelegramAds
+ * Describes a withdrawal transaction to the Telegram Ads platform.
+ * @see https://core.telegram.org/bots/api#transactionpartnertelegramads
+ */
+export type TransactionPartnerTelegramAds = {
+	/**
+	 * Type of the transaction partner, always “telegram_ads”
+	 */
+	type: "telegram_ads";
+};

package/@types/TransactionPartnerTelegramApi.ts

@@ -0,0 +1,16 @@
+/**
+ * ## TransactionPartnerTelegramApi
+ * Describes a transaction with payment for paid broadcasting.
+ * @see https://core.telegram.org/bots/api#transactionpartnertelegramapi
+ */
+export type TransactionPartnerTelegramApi = {
+	/**
+	 * Type of the transaction partner, always “telegram_api”
+	 */
+	type: "telegram_api";
+
+	/**
+	 * The number of successful requests that exceeded regular limits and were therefore billed
+	 */
+	request_count: number;
+};

package/@types/TransactionPartnerUser.ts

@@ -0,0 +1,70 @@
+import type { AffiliateInfo, Gift, PaidMedia, User } from "./";
+
+/**
+ * ## TransactionPartnerUser
+ * Describes a transaction with a user.
+ * @see https://core.telegram.org/bots/api#transactionpartneruser
+ */
+export type TransactionPartnerUser = {
+	/**
+	 * Type of the transaction partner, always “user”
+	 */
+	type: "user";
+
+	/**
+	 * Type of the transaction, currently one of:
+	 * - "invoice_payment" for payments via invoices
+	 * - "paid_media_payment" for payments for paid media
+	 * - "gift_purchase" for gifts sent by the bot
+	 * - "premium_purchase" for Telegram Premium subscriptions gifted by the bot
+	 * - "business_account_transfer" for direct transfers from managed business accounts
+	 */
+	transaction_type:
+		| "invoice_payment"
+		| "paid_media_payment"
+		| "gift_purchase"
+		| "premium_purchase"
+		| "business_account_transfer";
+
+	/**
+	 * Information about the user
+	 */
+	user: User;
+
+	/**
+	 * Optional. Information about the affiliate that received a commission via this transaction.
+	 * Can be available only for “invoice_payment” and “paid_media_payment” transactions.
+	 */
+	affiliate?: AffiliateInfo;
+
+	/**
+	 * Optional. Bot-specified invoice payload. Can be available only for “invoice_payment” transactions.
+	 */
+	invoice_payload?: string;
+
+	/**
+	 * Optional. The duration of the paid subscription. Can be available only for “invoice_payment” transactions.
+	 */
+	subscription_period?: number;
+
+	/**
+	 * Optional. Information about the paid media bought by the user; for “paid_media_payment” transactions only
+	 */
+	paid_media?: PaidMedia[];
+
+	/**
+	 * Optional. Bot-specified paid media payload. Can be available only for “paid_media_payment” transactions.
+	 */
+	paid_media_payload?: string;
+
+	/**
+	 * Optional. The gift sent to the user by the bot; for “gift_purchase” transactions only
+	 */
+	gift?: Gift;
+
+	/**
+	 * Optional. Number of months the gifted Telegram Premium subscription will be active for;
+	 * for “premium_purchase” transactions only
+	 */
+	premium_subscription_duration?: number;
+};

package/@types/UniqueGift.ts

@@ -0,0 +1,38 @@
+import type { UniqueGiftBackdrop, UniqueGiftModel, UniqueGiftSymbol } from "./";
+
+/**
+ * ## UniqueGift
+ * This object describes a unique gift that was upgraded from a regular gift.
+ * @see https://core.telegram.org/bots/api#uniquegift
+ */
+export type UniqueGift = {
+	/**
+	 * Human-readable name of the regular gift from which this unique gift was upgraded
+	 */
+	base_name: string;
+
+	/**
+	 * Unique name of the gift. This name can be used in https://t.me/nft/... links and story areas
+	 */
+	name: string;
+
+	/**
+	 * Unique number of the upgraded gift among gifts upgraded from the same regular gift
+	 */
+	number: number;
+
+	/**
+	 * Model of the gift
+	 */
+	model: UniqueGiftModel;
+
+	/**
+	 * Symbol of the gift
+	 */
+	symbol: UniqueGiftSymbol;
+
+	/**
+	 * Backdrop of the gift
+	 */
+	backdrop: UniqueGiftBackdrop;
+};

package/@types/UniqueGiftBackdrop.ts

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

package/@types/UniqueGiftBackdropColors.ts

@@ -0,0 +1,26 @@
+/**
+ * ## UniqueGiftBackdropColors
+ * This object describes the colors of the backdrop of a unique gift.
+ * @see https://core.telegram.org/bots/api#uniquegiftbackdropcolors
+ */
+export type UniqueGiftBackdropColors = {
+	/**
+	 * The color in the center of the backdrop in RGB format
+	 */
+	center_color: number;
+
+	/**
+	 * The color on the edges of the backdrop in RGB format
+	 */
+	edge_color: number;
+
+	/**
+	 * The color to be applied to the symbol in RGB format
+	 */
+	symbol_color: number;
+
+	/**
+	 * The color for the text on the backdrop in RGB format
+	 */
+	text_color: number;
+};