nyx-bot-client 0.0.2

package/@types/MessageEntity.ts

@@ -0,0 +1,109 @@
+import type { User } from "./";
+
+/**
+ * ## MessageEntity
+ * This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.
+ * @see https://core.telegram.org/bots/api#messageentity
+ */
+export type MessageEntity = {
+	/**
+	 * Offset in UTF-16 code units to the start of the entity
+	 */
+	offset: number;
+
+	/**
+	 * Length of the entity in UTF-16 code units
+	 */
+	length: number;
+} & (
+	| {
+			/**
+			 * Type of the entity. Currently, can be
+			 * “mention” (@username),
+			 * “hashtag” (#hashtag or #hashtag@chatusername),
+			 * “cashtag” ($USD),
+			 * “bot_command” (/start@jobs_bot),
+			 * “url” (https://telegram.org),
+			 * “email” (do-not-reply@telegram.org),
+			 * “phone_number” (+1-212-555-0123),
+			 * “bold” (bold text),
+			 * “italic” (italic text),
+			 * “underline” (underlined text),
+			 * “strikethrough” (strikethrough text),
+			 * “spoiler” (spoiler message),
+			 * “blockquote” (block quotation),
+			 * “expandable_blockquote” (collapsed-by-default block quotation),
+			 * “code” (monowidth string),
+			 * “pre” (monowidth block),
+			 * “text_link” (for clickable text URLs),
+			 * “text_mention” (for users without usernames),
+			 * “custom_emoji” (for inline custom emoji stickers)
+			 */
+			type:
+				| "mention"
+				| "hashtag"
+				| "cashtag"
+				| "bot_command"
+				| "email"
+				| "phone_number"
+				| "bold"
+				| "italic"
+				| "underline"
+				| "strikethrough"
+				| "spoiler"
+				| "blockquote"
+				| "expandable_blockquote"
+				| "code"
+				| "text_link";
+	  }
+	| {
+			/**
+			 * Type of the entity.
+			 * “url” (https://telegram.org),
+			 */
+			type: "url";
+
+			/**
+			 * Optional. For “text_link” only, URL that will be opened after user taps on the text
+			 */
+			url: string;
+	  }
+	| {
+			/**
+			 * Type of the entity.
+			 * “text_mention” (for users without usernames),
+			 */
+			type: "text_mention";
+
+			/**
+			 * Optional. For “text_mention” only, the mentioned user
+			 */
+			user: User;
+	  }
+	| {
+			/**
+			 * Type of the entity.
+			 * “pre” (monowidth block),
+			 */
+			type: "pre";
+
+			/**
+			 * Optional. For “pre” only, the programming language of the entity text
+			 */
+			language: string;
+	  }
+	| {
+			/**
+			 * Type of the entity.
+			 * “custom_emoji” (for inline custom emoji stickers)
+			 */
+			type: "custom_emoji";
+
+			/**
+			 * Optional. For “custom_emoji” only, unique identifier of the custom emoji. Use getCustomEmojiStickers to get
+			 * full
+			 * information about the sticker
+			 */
+			custom_emoji_id: string;
+	  }
+);

package/@types/MessageId.ts

@@ -0,0 +1,11 @@
+/**
+ * ## MessageId
+ * This object represents a unique message identifier.
+ * @see https://core.telegram.org/bots/api#messageid
+ */
+export type MessageId = {
+	/**
+	 * Unique message identifier
+	 */
+	message_id: number;
+};

package/@types/MessageOrigin.ts

@@ -0,0 +1,21 @@
+import type {
+	MessageOriginChannel,
+	MessageOriginChat,
+	MessageOriginHiddenUser,
+	MessageOriginUser,
+} from "./";
+
+/**
+ * ## MessageOrigin
+ * This object describes the origin of a message. It can be one of
+ * - MessageOriginUser
+ * - MessageOriginHiddenUser
+ * - MessageOriginChat
+ * - MessageOriginChannel
+ * @see https://core.telegram.org/bots/api#messageorigin
+ */
+export type MessageOrigin =
+	| MessageOriginUser
+	| MessageOriginHiddenUser
+	| MessageOriginChat
+	| MessageOriginChannel;

package/@types/MessageOriginChannel.ts

@@ -0,0 +1,33 @@
+import type { Chat } from "./";
+
+/**
+ * ## MessageOriginChannel
+ * The message was originally sent to a channel chat.
+ * @see https://core.telegram.org/bots/api#messageoriginchannel
+ */
+export type MessageOriginChannel = {
+	/**
+	 * Type of the message origin, always “channel”
+	 */
+	type: "channel";
+
+	/**
+	 * Date the message was sent originally in Unix time
+	 */
+	date: number;
+
+	/**
+	 * Channel chat to which the message was originally sent
+	 */
+	chat: Chat;
+
+	/**
+	 * Unique message identifier inside the chat
+	 */
+	message_id: number;
+
+	/**
+	 * Optional. Signature of the original post author
+	 */
+	author_signature?: string;
+};

package/@types/MessageOriginChat.ts

@@ -0,0 +1,28 @@
+import type { Chat } from "./";
+
+/**
+ * ## MessageOriginChat
+ * The message was originally sent on behalf of a chat to a group chat.
+ * @see https://core.telegram.org/bots/api#messageoriginchat
+ */
+export type MessageOriginChat = {
+	/**
+	 * Type of the message origin, always “chat”
+	 */
+	type: "chat";
+
+	/**
+	 * Date the message was sent originally in Unix time
+	 */
+	date: number;
+
+	/**
+	 * Chat that sent the message originally
+	 */
+	sender_chat: Chat;
+
+	/**
+	 * Optional. For messages originally sent by an anonymous chat administrator, original message author signature
+	 */
+	author_signature?: string;
+};

package/@types/MessageOriginHiddenUser.ts

@@ -0,0 +1,21 @@
+/**
+ * ## MessageOriginHiddenUser
+ * The message was originally sent by an unknown user.
+ * @see https://core.telegram.org/bots/api#messageoriginhiddenuser
+ */
+export type MessageOriginHiddenUser = {
+	/**
+	 * Type of the message origin, always “hidden_user”
+	 */
+	type: "hidden_user";
+
+	/**
+	 * Date the message was sent originally in Unix time
+	 */
+	date: number;
+
+	/**
+	 * Name of the user that sent the message originally
+	 */
+	sender_user_name: string;
+};

package/@types/MessageOriginUser.ts

@@ -0,0 +1,23 @@
+import type { User } from "./User";
+
+/**
+ * ## MessageOriginUser
+ * The message was originally sent by a known user.
+ * @see https://core.telegram.org/bots/api#messageoriginuser
+ */
+export type MessageOriginUser = {
+	/**
+	 * Type of the message origin, always “user”
+	 */
+	type: "user";
+
+	/**
+	 * Date the message was sent originally in Unix time
+	 */
+	date: number;
+
+	/**
+	 * User that sent the message originally
+	 */
+	sender_user: User;
+};

package/@types/MessageReactionCountUpdated.ts

@@ -0,0 +1,28 @@
+import type { Chat, ReactionCount } from "./";
+
+/**
+ * ## MessageReactionCountUpdated
+ * This object represents reaction changes on a message with anonymous reactions.
+ * @see https://core.telegram.org/bots/api#messagereactioncountupdated
+ */
+export type MessageReactionCountUpdated = {
+	/**
+	 * The chat containing the message
+	 */
+	chat: Chat;
+
+	/**
+	 * Unique message identifier inside the chat
+	 */
+	message_id: number;
+
+	/**
+	 * Date of the change in Unix time
+	 */
+	date: number;
+
+	/**
+	 * List of reactions that are present on the message
+	 */
+	reactions: ReactionCount[];
+};

package/@types/MessageReactionUpdated.ts

@@ -0,0 +1,43 @@
+import type { Chat, ReactionType, User } from "./";
+
+/**
+ * ## MessageReactionUpdated
+ * This object represents a change of a reaction on a message performed by a user.
+ * @see https://core.telegram.org/bots/api#messagereactionupdated
+ */
+export type MessageReactionUpdated = {
+	/**
+	 * The chat containing the message the user reacted to
+	 */
+	chat: Chat;
+
+	/**
+	 * Unique identifier of the message inside the chat
+	 */
+	message_id: number;
+
+	/**
+	 * Optional. The user that changed the reaction, if the user isn't anonymous
+	 */
+	user: User;
+
+	/**
+	 * Optional. The chat on behalf of which the reaction was changed, if the user is anonymous
+	 */
+	actor_chat: Chat;
+
+	/**
+	 * Date of the change in Unix time
+	 */
+	date: number;
+
+	/**
+	 * Previous list of reaction types that were set by the user
+	 */
+	old_reaction: ReactionType[];
+
+	/**
+	 * New list of reaction types that have been set by the user
+	 */
+	new_reaction: ReactionType[];
+};

package/@types/OrderInfo.ts

@@ -0,0 +1,28 @@
+import type { ShippingAddress } from "./";
+
+/**
+ * ## OrderInfo
+ * This object represents information about an order.
+ * @see https://core.telegram.org/bots/api#orderinfo
+ */
+export type OrderInfo = {
+	/**
+	 * Optional. User name
+	 */
+	name?: string;
+
+	/**
+	 * Optional. User's phone number
+	 */
+	phone_number?: string;
+
+	/**
+	 * Optional. User email
+	 */
+	email?: string;
+
+	/**
+	 * Optional. User shipping address
+	 */
+	shipping_address: ShippingAddress;
+};

package/@types/OwnedGift.ts

@@ -0,0 +1,11 @@
+import type { OwnedGiftRegular, OwnedGiftUnique } from "./";
+
+/**
+ * ## OwnedGift
+ * This object describes a gift received and owned by a user or a chat.
+ * Currently, it can be one of:
+ * - OwnedGiftRegular
+ * - OwnedGiftUnique
+ * @see https://core.telegram.org/bots/api#ownedgift
+ */
+export type OwnedGift = OwnedGiftRegular | OwnedGiftUnique;

package/@types/OwnedGiftRegular.ts

@@ -0,0 +1,77 @@
+import type { Gift, MessageEntity, User } from "./";
+
+/**
+ * ## OwnedGiftRegular
+ * Describes a regular gift owned by a user or a chat.
+ * @see https://core.telegram.org/bots/api#ownedgiftregular
+ */
+export type OwnedGiftRegular = {
+	/**
+	 * Type of the gift, always “regular”
+	 */
+	type: "regular";
+
+	/**
+	 * Information about the regular gift
+	 */
+	gift: Gift;
+
+	/**
+	 * Optional. Unique identifier of the gift for the bot; for gifts received on behalf of business accounts only
+	 */
+	owned_gift_id?: string;
+
+	/**
+	 * Optional. Sender of the gift if it is a known user
+	 */
+	sender_user?: User;
+
+	/**
+	 * Date the gift was sent in Unix time
+	 */
+	send_date: number;
+
+	/**
+	 * Optional. Text of the message that was added to the gift
+	 */
+	text?: string;
+
+	/**
+	 * Optional. Special entities that appear in the text
+	 */
+	entities?: MessageEntity[];
+
+	/**
+	 * Optional. True, if the sender and gift text are shown only to the gift
+	 * receiver; otherwise, everyone will be able to see them
+	 */
+	is_private?: true;
+
+	/**
+	 * Optional. True, if the gift is displayed on the account's profile page; for
+	 * gifts received on behalf of business accounts only
+	 */
+	is_saved?: true;
+
+	/**
+	 * Optional. True, if the gift can be upgraded to a unique gift; for gifts
+	 * received on behalf of business accounts only
+	 */
+	can_be_upgraded?: true;
+
+	/**
+	 * Optional. True, if the gift was refunded and isn't available anymore
+	 */
+	was_refunded?: true;
+
+	/**
+	 * Optional. Number of Telegram Stars that can be claimed by the receiver
+	 * instead of the gift; omitted if the gift cannot be converted to Telegram Stars
+	 */
+	convert_star_count?: number;
+
+	/**
+	 * Optional. Number of Telegram Stars that were paid by the sender for the ability to upgrade the gift
+	 */
+	prepaid_upgrade_star_count?: number;
+};

package/@types/OwnedGiftUnique.ts

@@ -0,0 +1,57 @@
+import type { Gift, User } from "./";
+
+/**
+ * ## OwnedGiftUnique
+ * Describes a unique gift owned by a user or a chat.
+ * @see https://core.telegram.org/bots/api#ownedgiftunique
+ */
+export type OwnedGiftUnique = {
+	/**
+	 * Type of the gift, always “unique”
+	 */
+	type: "unique";
+
+	/**
+	 * Information about the unique gift
+	 */
+	gift: Gift;
+
+	/**
+	 * Optional. Unique identifier of the gift for the bot; for gifts received on behalf of business accounts only
+	 */
+	owned_gift_id?: string;
+
+	/**
+	 * Optional. Sender of the gift if it is a known user
+	 */
+	sender_user?: User;
+
+	/**
+	 * Date the gift was sent in Unix time
+	 */
+	send_date: number;
+
+	/**
+	 * Optional. True, if the gift is displayed on the account's profile page; for
+	 * gifts received on behalf of business accounts only
+	 */
+	is_saved?: true;
+
+	/**
+	 * Optional. True, if the gift can be transferred to another owner; for gifts
+	 * received on behalf of business accounts only
+	 */
+	can_be_transferred?: true;
+
+	/**
+	 * 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/OwnedGifts.ts

@@ -0,0 +1,23 @@
+import type { OwnedGift } from "./";
+
+/**
+ * ## OwnedGifts
+ * Contains the list of gifts received and owned by a user or a chat.
+ * @see https://core.telegram.org/bots/api#ownedgifts
+ */
+export type OwnedGifts = {
+	/**
+	 * The total number of gifts owned by the user or the chat
+	 */
+	total_count: number;
+
+	/**
+	 * The list of gifts
+	 */
+	gifts: OwnedGift[];
+
+	/**
+	 * Optional. Offset for the next request. If empty, then there are no more results
+	 */
+	next_offset?: string;
+};

package/@types/PaidMedia.ts

@@ -0,0 +1,13 @@
+import type { PaidMediaPhoto } from "./PaidMediaPhoto";
+import type { PaidMediaPreview } from "./PaidMediaPreview";
+import type { PaidMediaVideo } from "./PaidMediaVideo";
+
+/**
+ * ## PaidMedia
+ * This object describes paid media. Currently, it can be one of
+ * - PaidMediaPreview
+ * - PaidMediaPhoto
+ * - PaidMediaVideo
+ * @see https://core.telegram.org/bots/api#paidmedia
+ */
+export type PaidMedia = PaidMediaPreview | PaidMediaPhoto | PaidMediaVideo;

package/@types/PaidMediaInfo.ts

@@ -0,0 +1,18 @@
+import type { PaidMedia } from "./PaidMedia";
+
+/**
+ * ## PaidMediaInfo
+ * Describes the paid media added to a message.
+ * @see https://core.telegram.org/bots/api#paidmediainfo
+ */
+export type PaidMediaInfo = {
+	/**
+	 * The number of Telegram Stars that must be paid to buy access to the media
+	 */
+	star_count: number;
+
+	/**
+	 * Information about the paid media
+	 */
+	paid_media: PaidMedia[];
+};

package/@types/PaidMediaPhoto.ts

@@ -0,0 +1,18 @@
+import type { PhotoSize } from "./PhotoSize";
+
+/**
+ * ## PaidMediaPhoto
+ * The paid media is a photo.
+ * @see https://core.telegram.org/bots/api#paidmediaphoto
+ */
+export type PaidMediaPhoto = {
+	/**
+	 * Type of the paid media, always “photo”
+	 */
+	type: "photo";
+
+	/**
+	 * The photo
+	 */
+	photo: PhotoSize[];
+};

package/@types/PaidMediaPreview.ts

@@ -0,0 +1,26 @@
+/**
+ * ## PaidMediaPreview
+ * The paid media isn't available before the payment.
+ * @see https://core.telegram.org/bots/api#paidmediapreview
+ */
+export type PaidMediaPreview = {
+	/**
+	 * Type of the paid media, always “preview”
+	 */
+	type: "preview";
+
+	/**
+	 * Optional. Media width as defined by the sender
+	 */
+	width?: number;
+
+	/**
+	 * Optional. Media height as defined by the sender
+	 */
+	height?: number;
+
+	/**
+	 * Optional. Duration of the media in seconds as defined by the sender
+	 */
+	duration?: number;
+};

package/@types/PaidMediaPurchased.ts

@@ -0,0 +1,18 @@
+import type { User } from "./User";
+
+/**
+ * ## PaidMediaPreview
+ * This object contains information about a paid media purchase.
+ * @see https://core.telegram.org/bots/api#paidmediapurchased
+ */
+export type PaidMediaPurchased = {
+	/**
+	 * User who purchased the media
+	 */
+	from: User;
+
+	/**
+	 * Bot-specified paid media payload
+	 */
+	paid_media_payload: string;
+};

package/@types/PaidMediaVideo.ts

@@ -0,0 +1,18 @@
+import type { Video } from "./Video";
+
+/**
+ * ## PaidMediaVideo
+ * The paid media is a video.
+ * @see https://core.telegram.org/bots/api#paidmediavideo
+ */
+export type PaidMediaVideo = {
+	/**
+	 * Type of the paid media, always “video”
+	 */
+	type: "video";
+
+	/**
+	 * The video
+	 */
+	photo: Video[];
+};

package/@types/PaidMessagePriceChanged.ts

@@ -0,0 +1,16 @@
+/**
+ * ## PaidMessagePriceChanged
+ * This object represents a service message about a change in the price for paid messages in a chat.
+ * @see https://core.telegram.org/bots/api#paidmessagepricechanged
+ */
+export type PaidMessagePriceChanged = {
+	/**
+	 * New price for paid messages in the chat, in the smallest units of the currency (integer, not float). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json for the number of digits past the decimal point for each currency (https://core.telegram.org/bots/payments/currencies.json), it may be different for each currency.
+	 */
+	amount: number;
+
+	/**
+	 * Three-letter ISO 4217 currency code
+	 */
+	currency: string;
+};

package/@types/PassportData.ts

@@ -0,0 +1,18 @@
+import type { EncryptedCredentials, EncryptedPassportElement } from "./";
+
+/**
+ * ## PassportData
+ * Describes Telegram Passport data shared with the bot by the user.
+ * @see https://core.telegram.org/bots/api#passportdata
+ */
+export type PassportData = {
+	/**
+	 * Array with information about documents and other Telegram Passport elements that was shared with the bot
+	 */
+	data: EncryptedPassportElement[];
+
+	/**
+	 * Encrypted credentials required to decrypt the data
+	 */
+	credentials: EncryptedCredentials;
+};