nyx-bot-client 1.0.0 → 1.0.2

package/@types/ManagedBotCreated.ts

@@ -0,0 +1,13 @@
+import type { User } from "./";
+
+/**
+ * ## ManagedBotCreated
+ * This object contains information about the bot that was created to be managed by the current bot.
+ * @see https://core.telegram.org/bots/api#managedbotcreated
+ */
+export type ManagedBotCreated = {
+	/**
+	 * Information about the bot. The bot's token can be fetched using the method getManagedBotToken.
+	 */
+	bot: User;
+};

package/@types/ManagedBotUpdated.ts

@@ -0,0 +1,18 @@
+import type { User } from "./";
+
+/**
+ * ## ManagedBotUpdated
+ * This object contains information about the creation or token update of a bot that is managed by the current bot.
+ * @see https://core.telegram.org/bots/api#managedbotupdated
+ */
+export type ManagedBotUpdated = {
+	/**
+	 * User that created the bot
+	 */
+	user: User;
+
+	/**
+	 * Information about the bot. Token of the bot can be fetched using the method getManagedBotToken.
+	 */
+	bot: User;
+};

package/@types/Message.ts

@@ -31,7 +31,9 @@ import type {
 	InlineKeyboardMarkup,
 	Invoice,
 	LinkPreviewOptions,
+	LivePhoto,
 	Location,
+	ManagedBotCreated,
 	MaybeInaccessibleMessage,
 	MessageAutoDeleteTimerChanged,
 	MessageEntity,
@@ -41,6 +43,8 @@ import type {
 	PassportData,
 	PhotoSize,
 	Poll,
+	PollOptionAdded,
+	PollOptionDeleted,
 	ProximityAlertTriggered,
 	RefundedPayment,
 	Sticker,
@@ -125,6 +129,13 @@ export type Message = {
 	 */
 	date: number;
 
+	/**
+	 * Optional. The unique identifier for the guest query. Use this identifier with the method answerGuestQuery to send
+	 * a response message. If non-empty, the message belongs to the chat where the guest bot was summoned, which may not
+	 * coincide with other existing bot chats sharing the same identifier.
+	 */
+	guest_query_id?: string;
+
 	/**
 	 * Optional. Unique identifier of the business connection from which the message was received. If non-empty, the
 	 * message belongs to a chat of the corresponding business account that is independent from any potential bot chat
@@ -178,11 +189,26 @@ export type Message = {
 	 */
 	reply_to_checklist_task_id?: number;
 
+	/**
+	 * Optional. Persistent identifier of the specific poll option that is being replied to
+	 */
+	reply_to_poll_option_id?: string;
+
 	/**
 	 * Optional. Bot through which the message was sent
 	 */
 	via_bot?: User;
 
+	/**
+	 * Optional. For a message sent by a guest bot, this is the user whose original message triggered the bot's response
+	 */
+	guest_bot_caller_user?: User;
+
+	/**
+	 * Optional. For a message sent by a guest bot, this is the chat whose original message triggered the bot's response
+	 */
+	guest_bot_caller_chat?: Chat;
+
 	/**
 	 * Optional. Date the message was last edited in Unix time
 	 */
@@ -264,6 +290,12 @@ export type Message = {
 	 */
 	document?: Document;
 
+	/**
+	 * Optional. Message is a live photo, information about the live photo. For backward compatibility, when this field
+	 * is set, the photo field will also be set
+	 */
+	live_photo?: LivePhoto;
+
 	/**
 	 * Optional. Message contains paid media; information about the paid media
 	 */
@@ -577,11 +609,26 @@ export type Message = {
 	 */
 	giveaway_completed?: GiveawayCompleted;
 
+	/**
+	 * Optional. Service message: user created a bot that will be managed by the current bot
+	 */
+	managed_bot_created?: ManagedBotCreated;
+
 	/**
 	 * Optional. Service message: the price for paid messages has changed in the chat
 	 */
 	paid_message_price_changed?: PaidMessagePriceChanged;
 
+	/**
+	 * Optional. Service message: answer option was added to a poll
+	 */
+	poll_option_added?: PollOptionAdded;
+
+	/**
+	 * Optional. Service message: answer option was deleted from a poll
+	 */
+	poll_option_deleted?: PollOptionDeleted;
+
 	/**
 	 * Optional. Service message: a suggested post was approved
 	 */
@@ -644,6 +691,7 @@ export const messageTypes = [
 	"animation",
 	"audio",
 	"document",
+	"live_photo",
 	"paid_media",
 	"photo",
 	"sticker",
@@ -699,7 +747,10 @@ export const messageTypes = [
 	"giveaway",
 	"giveaway_winners",
 	"giveaway_completed",
+	"managed_bot_created",
 	"paid_message_price_changed",
+	"poll_option_added",
+	"poll_option_deleted",
 	"suggested_post_approved",
 	"suggested_post_approval_failed",
 	"suggested_post_declined",

package/@types/MessageReactionUpdated.ts

@@ -19,12 +19,12 @@ export type MessageReactionUpdated = {
 	/**
 	 * Optional. The user that changed the reaction, if the user isn't anonymous
 	 */
-	user: User;
+	user?: User;
 
 	/**
 	 * Optional. The chat on behalf of which the reaction was changed, if the user is anonymous
 	 */
-	actor_chat: Chat;
+	actor_chat?: Chat;
 
 	/**
 	 * Date of the change in Unix time

package/@types/OrderInfo.ts

@@ -24,5 +24,5 @@ export type OrderInfo = {
 	/**
 	 * Optional. User shipping address
 	 */
-	shipping_address: ShippingAddress;
+	shipping_address?: ShippingAddress;
 };

package/@types/OwnedGiftUnique.ts

@@ -1,4 +1,4 @@
-import type { Gift, User } from "./";
+import type { UniqueGift, User } from "./";
 
 /**
  * ## OwnedGiftUnique
@@ -14,7 +14,7 @@ export type OwnedGiftUnique = {
 	/**
 	 * Information about the unique gift
 	 */
-	gift: Gift;
+	gift: UniqueGift;
 
 	/**
 	 * Optional. Unique identifier of the gift for the bot; for gifts received on behalf of business accounts only

package/@types/PaidMedia.ts

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

package/@types/PaidMediaLivePhoto.ts

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

package/@types/PaidMediaVideo.ts

@@ -14,5 +14,5 @@ export type PaidMediaVideo = {
 	/**
 	 * The video
 	 */
-	photo: Video[];
+	video: Video;
 };

package/@types/PaidMessagePriceChanged.ts

@@ -1,16 +1,12 @@
 /**
  * ## PaidMessagePriceChanged
- * This object represents a service message about a change in the price for paid messages in a chat.
+ * Describes a service message about a change in the price of paid messages within 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.
+	 * The new number of Telegram Stars that must be paid by non-administrator users of the supergroup chat for each
+	 * sent message
 	 */
-	amount: number;
-
-	/**
-	 * Three-letter ISO 4217 currency code
-	 */
-	currency: string;
+	paid_message_star_count: number;
 };

package/@types/Poll.ts

@@ -1,4 +1,4 @@
-import type { MessageEntity, PollOption } from "./";
+import type { MessageEntity, PollMedia, PollOption } from "./";
 
 /**
  * ## Poll
@@ -53,10 +53,27 @@ export type Poll = {
 	allows_multiple_answers: boolean;
 
 	/**
-	 * Optional. 0-based identifier of the correct answer option. Available only for polls in the quiz mode, which are
-	 * closed, or was sent (not forwarded) by the bot or to the private chat with the bot.
+	 * True, if the poll allows to change the chosen answer options
 	 */
-	correct_option_id?: number;
+	allows_revoting: boolean;
+
+	/**
+	 * True if voting is limited to users who have been members of the chat where the poll was originally sent for more
+	 * than 24 hours
+	 */
+	members_only: boolean;
+
+	/**
+	 * Optional. A list of two-letter ISO 3166-1 alpha-2 country codes indicating the countries from which users can vote
+	 * in the poll. If omitted, then users from any country can participate in the poll.
+	 */
+	country_codes?: string[];
+
+	/**
+	 * Optional. Array of 0-based identifiers of the correct answer options. Available only for polls in quiz mode which
+	 * are closed or were sent (not forwarded) by the bot or to the private chat with the bot.
+	 */
+	correct_option_ids?: number[];
 
 	/**
 	 * Optional. Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll,
@@ -69,6 +86,11 @@ export type Poll = {
 	 */
 	explanation_entities?: MessageEntity[];
 
+	/**
+	 * Optional. Media added to the quiz explanation
+	 */
+	explanation_media?: PollMedia;
+
 	/**
 	 * Optional. Amount of time in seconds the poll will be active after creation
 	 */
@@ -78,4 +100,19 @@ export type Poll = {
 	 * Optional. Point in time (Unix timestamp) when the poll will be automatically closed
 	 */
 	close_date?: number;
+
+	/**
+	 * Optional. Description of the poll; for polls inside the Message object only
+	 */
+	description?: string;
+
+	/**
+	 * Optional. Special entities like usernames, URLs, bot commands, etc. that appear in the description
+	 */
+	description_entities?: MessageEntity[];
+
+	/**
+	 * Optional. Media added to the poll description; for polls inside the Message object only
+	 */
+	media?: PollMedia;
 };

package/@types/PollAnswer.ts

@@ -14,15 +14,20 @@ export type PollAnswer = {
 	/**
 	 * Optional. The chat that changed the answer to the poll, if the voter is anonymous
 	 */
-	voter_chat: Chat;
+	voter_chat?: Chat;
 
 	/**
 	 * Optional. The user that changed the answer to the poll, if the voter isn't anonymous
 	 */
-	user: User;
+	user?: User;
 
 	/**
 	 * 0-based identifiers of chosen answer options. May be empty if the vote was retracted.
 	 */
 	option_ids: number[];
+
+	/**
+	 * Persistent identifiers of the chosen answer options. May be empty if the vote was retracted.
+	 */
+	option_persistent_ids: string[];
 };

package/@types/PollMedia.ts

@@ -0,0 +1,63 @@
+import type {
+	Animation,
+	Audio,
+	Document,
+	LivePhoto,
+	Location,
+	PhotoSize,
+	Sticker,
+	Venue,
+	Video,
+} from "./";
+
+/**
+ * ## PollMedia
+ * At most one of the optional fields can be present in any given object.
+ * @see https://core.telegram.org/bots/api#pollmedia
+ */
+export type PollMedia = {
+	/**
+	 * Optional. Media is an animation, information about the animation
+	 */
+	animation?: Animation;
+
+	/**
+	 * Optional. Media is an audio file, information about the file; currently, can't be received in a poll option
+	 */
+	audio?: Audio;
+
+	/**
+	 * Optional. Media is a general file, information about the file; currently, can't be received in a poll option
+	 */
+	document?: Document;
+
+	/**
+	 * Optional. Media is a live photo, information about the live photo
+	 */
+	live_photo?: LivePhoto;
+
+	/**
+	 * Optional. Media is a shared location, information about the location
+	 */
+	location?: Location;
+
+	/**
+	 * Optional. Media is a photo, available sizes of the photo
+	 */
+	photo?: PhotoSize[];
+
+	/**
+	 * Optional. Media is a sticker, information about the sticker; currently, for poll options only
+	 */
+	sticker?: Sticker;
+
+	/**
+	 * Optional. Media is a venue, information about the venue
+	 */
+	venue?: Venue;
+
+	/**
+	 * Optional. Media is a video, information about the video
+	 */
+	video?: Video;
+};

package/@types/PollOption.ts

@@ -1,4 +1,4 @@
-import type { MessageEntity } from "./MessageEntity";
+import type { Chat, MessageEntity, PollMedia, User } from "./";
 
 /**
  * ## PollOption
@@ -6,6 +6,11 @@ import type { MessageEntity } from "./MessageEntity";
  * @see https://core.telegram.org/bots/api#polloption
  */
 export type PollOption = {
+	/**
+	 * Unique identifier of the option, persistent on option addition and deletion
+	 */
+	persistent_id: string;
+
 	/**
 	 * Option text, 1-100 characters
 	 */
@@ -18,7 +23,28 @@ export type PollOption = {
 	text_entities?: MessageEntity[];
 
 	/**
-	 * Number of users that voted for this option
+	 * Optional. Media added to the poll option
+	 */
+	media?: PollMedia;
+
+	/**
+	 * Number of users who voted for this option; may be 0 if unknown
 	 */
 	voter_count: number;
+
+	/**
+	 * Optional. User who added the option; omitted if the option wasn't added by a user after poll creation
+	 */
+	added_by_user?: User;
+
+	/**
+	 * Optional. Chat that added the option; omitted if the option wasn't added by a chat after poll creation
+	 */
+	added_by_chat?: Chat;
+
+	/**
+	 * Optional. Point in time (Unix timestamp) when the option was added; omitted if the option existed in the original
+	 * poll
+	 */
+	addition_date?: number;
 };

package/@types/PollOptionAdded.ts

@@ -0,0 +1,29 @@
+import type { MaybeInaccessibleMessage, MessageEntity } from "./";
+
+/**
+ * ## PollOptionAdded
+ * Describes a service message about an option added to a poll.
+ * @see https://core.telegram.org/bots/api#polloptionadded
+ */
+export type PollOptionAdded = {
+	/**
+	 * Optional. Message containing the poll to which the option was added, if known. Note that the Message object in this
+	 * field will not contain the reply_to_message field even if it itself is a reply.
+	 */
+	poll_message?: MaybeInaccessibleMessage;
+
+	/**
+	 * Unique identifier of the added option
+	 */
+	option_persistent_id: string;
+
+	/**
+	 * Option text
+	 */
+	option_text: string;
+
+	/**
+	 * Optional. Special entities that appear in the option_text
+	 */
+	option_text_entities?: MessageEntity[];
+};

package/@types/PollOptionDeleted.ts

@@ -0,0 +1,29 @@
+import type { MaybeInaccessibleMessage, MessageEntity } from "./";
+
+/**
+ * ## PollOptionDeleted
+ * Describes a service message about an option deleted from a poll.
+ * @see https://core.telegram.org/bots/api#polloptiondeleted
+ */
+export type PollOptionDeleted = {
+	/**
+	 * Optional. Message containing the poll from which the option was deleted, if known. Note that the Message object in
+	 * this field will not contain the reply_to_message field even if it itself is a reply.
+	 */
+	poll_message?: MaybeInaccessibleMessage;
+
+	/**
+	 * Unique identifier of the deleted option
+	 */
+	option_persistent_id: string;
+
+	/**
+	 * Option text
+	 */
+	option_text: string;
+
+	/**
+	 * Optional. Special entities that appear in the option_text
+	 */
+	option_text_entities?: MessageEntity[];
+};

package/@types/PreparedKeyboardButton.ts

@@ -0,0 +1,11 @@
+/**
+ * ## PreparedKeyboardButton
+ * Describes a keyboard button to be used by a user of a Mini App.
+ * @see https://core.telegram.org/bots/api#preparedkeyboardbutton
+ */
+export type PreparedKeyboardButton = {
+	/**
+	 * Unique identifier of the keyboard button
+	 */
+	id: string;
+};

package/@types/ReplyKeyboardMarkup.ts

@@ -10,7 +10,7 @@ export type ReplyKeyboardMarkup = {
 	/**
 	 * Array of button rows, each represented by an Array of KeyboardButton objects
 	 */
-	keyboard?: KeyboardButton[][];
+	keyboard: KeyboardButton[][];
 
 	/**
 	 * Optional. Requests clients to always show the keyboard when the regular keyboard is hidden. Defaults to false, in

package/@types/ReplyParameters.ts

@@ -1,4 +1,4 @@
-import type { ParseMode } from "./index";
+import type { MessageEntity, ParseMode } from "./index";
 
 /**
  * ## ReplyParameters
@@ -40,7 +40,7 @@ export type ReplyParameters = {
 	 * 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
+	quote_entities?: MessageEntity[];
 
 	/**
 	 * Optional. Position of the quote in the original message in UTF-16 code units
@@ -51,4 +51,9 @@ export type ReplyParameters = {
 	 * Optional. Identifier of the specific checklist task to be replied to
 	 */
 	checklist_task_id?: number;
+
+	/**
+	 * Optional. Persistent identifier of the specific poll option to be replied to
+	 */
+	poll_option_id?: string;
 };

package/@types/SentGuestMessage.ts

@@ -0,0 +1,11 @@
+/**
+ * ## SentGuestMessage
+ * Describes an inline message sent by a guest bot.
+ * @see https://core.telegram.org/bots/api#sentguestmessage
+ */
+export type SentGuestMessage = {
+	/**
+	 * Identifier of the sent inline message
+	 */
+	inline_message_id: string;
+};

package/@types/SentWebAppMessage.ts

@@ -8,5 +8,5 @@ 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;
+	inline_message_id?: string;
 };

package/@types/SwitchInlineQueryChosenChat.ts

@@ -9,7 +9,7 @@ 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;
+	query?: string;
 
 	/**
 	 * Optional. True, if private chats with users can be chosen

package/@types/TextQuote.ts

@@ -15,7 +15,7 @@ export type TextQuote = {
 	 * 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[];
+	entities?: MessageEntity[];
 
 	/**
 	 * Approximate quote position in the original message in UTF-16 code units as specified by the sender
@@ -26,5 +26,5 @@ export type TextQuote = {
 	 * Optional. True, if the quote was chosen manually by the message sender. Otherwise, the quote was added
 	 * automatically by the server.
 	 */
-	is_manual: boolean;
+	is_manual?: true;
 };

package/@types/Update.ts

@@ -1,4 +1,3 @@
-import type { AtMostOne } from "../utils";
 import type {
 	BusinessConnection,
 	BusinessMessagesDeleted,
@@ -9,6 +8,7 @@ import type {
 	ChatMemberUpdated,
 	ChosenInlineResult,
 	InlineQuery,
+	ManagedBotUpdated,
 	Message,
 	MessageReactionCountUpdated,
 	MessageReactionUpdated,
@@ -18,6 +18,7 @@ import type {
 	PreCheckoutQuery,
 	ShippingQuery,
 } from "./";
+import type { AtMostOne } from "./utils";
 
 /**
  * @see https://core.telegram.org/bots/api#update
@@ -66,6 +67,12 @@ export type EventTypes = {
 	 */
 	deleted_business_messages: BusinessMessagesDeleted;
 
+	/**
+	 * New guest message. The bot can use the field Message.guest_query_id and the method answerGuestQuery to send a
+	 * message in response.
+	 */
+	guest_message: Message;
+
 	/**
 	 * 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
@@ -149,6 +156,11 @@ export type EventTypes = {
 	 * A boost was removed from a chat. The bot must be an administrator in the chat to receive these updates.
 	 */
 	removed_chat_boost: ChatBoostRemoved;
+
+	/**
+	 * A new bot was created to be managed by the bot or token of a bot was changed
+	 */
+	managed_bot: ManagedBotUpdated;
 };
 
 /**