nyx-bot-client 0.0.6 → 0.0.8

package/@types/AcceptedGiftTypes.ts

@@ -23,4 +23,9 @@ export type AcceptedGiftTypes = {
 	 * True, if a Telegram Premium subscription is accepted
 	 */
 	premium_subscription: boolean;
+
+	/**
+	 * True, if transfers of unique gifts from channels are accepted
+	 */
+	gifts_from_channels: boolean;
 };

package/@types/Chat.ts

@@ -39,5 +39,10 @@ export type Chat = {
 	/**
 	 * Optional. True, if the supergroup chat is a forum (has topics enabled)
 	 */
-	is_forum?: boolean;
+	is_forum?: true;
+
+	/**
+	 * Optional. True, if the chat is the direct messages chat of a channel
+	 */
+	is_direct_messages?: true;
 };

package/@types/ChatAdministratorRights.ts

@@ -81,4 +81,10 @@ export type ChatAdministratorRights = {
 	 * Optional. True, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only
 	 */
 	can_manage_topics?: boolean;
+
+	/**
+	 * Optional. True, if the administrator can manage direct messages of the channel and decline suggested posts; for
+	 * channels only
+	 */
+	can_manage_direct_messages?: boolean;
 };

package/@types/ChatFullInfo.ts

@@ -10,6 +10,8 @@ import type {
 	ChatPhoto,
 	Message,
 	ReactionType,
+	UniqueGiftColors,
+	UserRating,
 } from "./";
 
 /**
@@ -53,7 +55,12 @@ export type ChatFullInfo = {
 	/**
 	 * Optional. True, if the supergroup chat is a forum (has topics enabled)
 	 */
-	is_forum?: boolean;
+	is_forum?: true;
+
+	/**
+	 * Optional. True, if the chat is the direct messages chat of a channel
+	 */
+	is_direct_messages?: true;
 
 	/**
 	 * Identifier of the accent color for the chat name and backgrounds of the chat photo, reply header, and link
@@ -101,6 +108,11 @@ export type ChatFullInfo = {
 	 */
 	personal_chat?: Chat;
 
+	/**
+	 * Optional. Information about the corresponding channel chat; for direct messages chats only
+	 */
+	parent_chat?: Chat;
+
 	/**
 	 * Optional. List of available reactions allowed in the chat. If omitted, then all emoji reactions are allowed.
 	 */
@@ -257,4 +269,20 @@ export type ChatFullInfo = {
 	 * Optional. For supergroups, the location to which the supergroup is connected
 	 */
 	location?: ChatLocation;
+
+	/**
+	 * Optional. For private chats, the rating of the user if any
+	 */
+	rating?: UserRating;
+
+	/**
+	 * Optional. The color scheme based on a unique gift that must be used for the chat's name, message replies and
+	 * link previews
+	 */
+	unique_gift_colors?: UniqueGiftColors;
+
+	/**
+	 * Optional. The number of Telegram Stars a general user have to pay to send a message to the chat
+	 */
+	paid_message_star_count?: number;
 };

package/@types/ChatMemberAdministrator.ts

@@ -83,22 +83,28 @@ export type ChatMemberAdministrator = {
 	 * Optional. True, if the administrator can post messages in the channel, or access channel statistics; for channels
 	 * only
 	 */
-	can_post_messages: boolean;
+	can_post_messages?: boolean;
 
 	/**
 	 * Optional. True, if the administrator can edit messages of other users and can pin messages; for channels only
 	 */
-	can_edit_messages: boolean;
+	can_edit_messages?: boolean;
 
 	/**
 	 * Optional. True, if the user is allowed to pin messages; for groups and supergroups only
 	 */
-	can_pin_messages: boolean;
+	can_pin_messages?: boolean;
 
 	/**
 	 * Optional. True, if the user is allowed to create, rename, close, and reopen forum topics; for supergroups only
 	 */
-	can_manage_topics: boolean;
+	can_manage_topics?: boolean;
+
+	/**
+	 * Optional. True, if the administrator can manage direct messages of the channel and decline suggested posts; for
+	 * channels only
+	 */
+	can_manage_direct_messages?: boolean;
 
 	/**
 	 * Optional. Custom title for this user

package/@types/ChecklistTask.ts

@@ -1,4 +1,4 @@
-import type { MessageEntity, User } from "./";
+import type { Chat, MessageEntity, User } from "./";
 
 /**
  * ## ChecklistTask
@@ -22,10 +22,15 @@ export type ChecklistTask = {
 	text_entities?: MessageEntity[];
 
 	/**
-	 * Optional. User that completed the task; omitted if the task wasn't completed
+	 * Optional. User that completed the task; omitted if the task wasn't completed by a user
 	 */
 	completed_by_user?: User;
 
+	/**
+	 * Optional. Chat that completed the task; omitted if the task wasn't completed by a chat
+	 */
+	completed_by_chat?: Chat;
+
 	/**
 	 * Optional. Point in time (Unix timestamp) when the task was completed; 0 if the task wasn't completed
 	 */

package/@types/DirectMessagesTopic.ts

@@ -0,0 +1,20 @@
+import type { User } from "./User";
+
+/**
+ * ## DirectMessagesTopic
+ * Describes a topic of a direct messages chat.
+ * @see https://core.telegram.org/bots/api#directmessagestopic
+ */
+export type DirectMessagesTopic = {
+	/**
+	 * Unique identifier of the topic. 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.
+	 */
+	topic_id: number;
+
+	/**
+	 * Optional. Information about the user that created the topic. Currently, it is always present
+	 */
+	user?: User;
+};

package/@types/ForumTopic.ts

@@ -23,4 +23,10 @@ export type ForumTopic = {
 	 * Optional. Unique identifier of the custom emoji shown as the topic icon
 	 */
 	icon_custom_emoji_id?: string;
+
+	/**
+	 * Optional. True, if the name of the topic wasn't specified explicitly by its creator and likely needs to be changed
+	 * by the bot
+	 */
+	is_name_implicit?: true;
 };

package/@types/ForumTopicCreated.ts

@@ -18,4 +18,10 @@ export type ForumTopicCreated = {
 	 * Optional. Unique identifier of the custom emoji shown as the topic icon
 	 */
 	icon_custom_emoji_id: string;
+
+	/**
+	 * Optional. True, if the name of the topic wasn't specified explicitly by its creator and likely needs to be changed
+	 * by the bot
+	 */
+	is_name_implicit?: true;
 };

package/@types/Gift.ts

@@ -1,4 +1,4 @@
-import type { Sticker } from "./";
+import type { Chat, GiftBackground, Sticker } from "./";
 
 /**
  * ## Gift
@@ -26,6 +26,16 @@ export type Gift = {
 	 */
 	upgrade_star_count?: number;
 
+	/**
+	 * Optional. True, if the gift can only be purchased by Telegram Premium subscribers
+	 */
+	is_premium?: true;
+
+	/**
+	 * Optional. True, if the gift can be used (after being upgraded) to customize a user's appearance
+	 */
+	has_colors?: true;
+
 	/**
 	 * Optional. The total number of the gifts of this type that can be sent; for limited gifts only
 	 */
@@ -35,4 +45,29 @@ export type Gift = {
 	 * Optional. The number of remaining gifts of this type that can be sent; for limited gifts only
 	 */
 	remaining_count?: number;
+
+	/**
+	 * Optional. The total number of gifts of this type that can be sent by the bot; for limited gifts only
+	 */
+	personal_total_count?: number;
+
+	/**
+	 * Optional. The number of remaining gifts of this type that can be sent by the bot; for limited gifts only
+	 */
+	personal_remaining_count?: number;
+
+	/**
+	 * Optional. Background of the gift
+	 */
+	background?: GiftBackground;
+
+	/**
+	 * Optional. The total number of different unique gifts that can be obtained by upgrading the gift
+	 */
+	unique_gift_variant_count?: number;
+
+	/**
+	 * Optional. Information about the chat that published the gift
+	 */
+	publisher_chat?: Chat;
 };

package/@types/GiftBackground.ts

@@ -0,0 +1,21 @@
+/**
+ * ## GiftBackground
+ * This object describes the background of a gift.
+ * @see https://core.telegram.org/bots/api#giftbackground
+ */
+export type GiftBackground = {
+	/**
+	 * Center color of the background in RGB format
+	 */
+	center_color: number;
+
+	/**
+	 * Edge color of the background in RGB format
+	 */
+	edge_color: number;
+
+	/**
+	 * Text color of the background in RGB format
+	 */
+	text_color: number;
+};

package/@types/GiftInfo.ts

@@ -29,6 +29,11 @@ export type GiftInfo = {
 	 */
 	prepaid_upgrade_star_count?: number;
 
+	/**
+	 * Optional. True, if the gift's upgrade was purchased after the gift was sent
+	 */
+	is_upgrade_separate?: true;
+
 	/**
 	 * Optional. True, if the gift can be upgraded to a unique gift
 	 */
@@ -49,4 +54,9 @@ export type GiftInfo = {
 	 * receiver; otherwise, everyone will be able to see them
 	 */
 	is_private?: true;
+
+	/**
+	 * Optional. Unique number reserved for this gift when upgraded. See the number field in UniqueGift
+	 */
+	unique_gift_number?: number;
 };

package/@types/Message.ts

@@ -11,6 +11,7 @@ import type {
 	Contact,
 	Dice,
 	DirectMessagePriceChanged,
+	DirectMessagesTopic,
 	Document,
 	ExternalReplyInfo,
 	ForumTopicClosed,
@@ -43,6 +44,11 @@ import type {
 	Sticker,
 	Story,
 	SuccessfulPayment,
+	SuggestedPostApprovalFailed,
+	SuggestedPostDeclined,
+	SuggestedPostInfo,
+	SuggestedPostPaid,
+	SuggestedPostRefunded,
 	TextQuote,
 	UniqueGiftInfo,
 	User,
@@ -71,10 +77,16 @@ export type Message = {
 	message_id: number;
 
 	/**
-	 * Optional. Unique identifier of a message thread to which the message belongs; for supergroups only
+	 * Optional. Unique identifier of a message thread or forum topic to which the message belongs; for supergroups and
+	 * private chats only
 	 */
 	message_thread_id?: number;
 
+	/**
+	 * Optional. Information about the direct messages chat topic that contains the message
+	 */
+	direct_messages_topic?: DirectMessagesTopic;
+
 	/**
 	 * Optional. Sender of the message; may be empty for messages sent to channels. For backward compatibility, if the
 	 * message was sent on behalf of a chat, the field contains a fake sender user in non-channel chats
@@ -123,7 +135,7 @@ export type Message = {
 	forward_origin?: MessageOrigin;
 
 	/**
-	 * Optional. True, if the message is sent to a forum topic
+	 * Optional. True, if the message is sent to a topic in a forum supergroup or a private chat with the bot
 	 */
 	is_topic_message?: boolean;
 
@@ -153,6 +165,11 @@ export type Message = {
 	 */
 	reply_to_story?: Story;
 
+	/**
+	 * Optional. Identifier of the specific checklist task that is being replied to
+	 */
+	reply_to_checklist_task_id?: number;
+
 	/**
 	 * Optional. Bot through which the message was sent
 	 */
@@ -166,13 +183,19 @@ export type Message = {
 	/**
 	 * Optional. True, if the message can't be forwarded
 	 */
-	has_protected_content?: boolean;
+	has_protected_content?: true;
 
 	/**
 	 * Optional. True, if the message was sent by an implicit action, for example, as an away or a greeting business
 	 * message, or as a scheduled message
 	 */
-	is_from_offline?: boolean;
+	is_from_offline?: true;
+
+	/**
+	 * Optional. True, if the message is a paid post. Note that such posts must not be deleted for 24 hours to receive the
+	 * payment and can't be edited.
+	 */
+	is_paid_post?: true;
 
 	/**
 	 * Optional. The unique identifier of a media message group this message belongs to
@@ -206,6 +229,12 @@ export type Message = {
 	 */
 	link_preview_options?: LinkPreviewOptions;
 
+	/**
+	 * Optional. Information about suggested post parameters if the message is a suggested post in a channel direct
+	 * messages chat. If the message is an approved or declined suggested post, then it can't be edited.
+	 */
+	suggested_post_info?: SuggestedPostInfo;
+
 	/**
 	 * Optional. Unique identifier of the message effect added to the message
 	 */
@@ -426,6 +455,11 @@ export type Message = {
 	 */
 	unique_gift?: UniqueGiftInfo;
 
+	/**
+	 * Optional. Service message: upgrade of a gift was purchased after the gift was sent
+	 */
+	gift_upgrade_sent?: GiftInfo;
+
 	/**
 	 * Optional. The domain name of the website on which the user has logged in. [More about Telegram Login](https://core.telegram.org/widgets/login)
 	 */
@@ -530,6 +564,31 @@ export type Message = {
 	 */
 	paid_message_price_changed?: PaidMessagePriceChanged;
 
+	/**
+	 * Optional. Service message: a suggested post was approved
+	 */
+	suggested_post_approved?: SuggestedPostInfo;
+
+	/**
+	 * Optional. Service message: approval of a suggested post has failed
+	 */
+	suggested_post_approval_failed?: SuggestedPostApprovalFailed;
+
+	/**
+	 * Optional. Service message: a suggested post was declined
+	 */
+	suggested_post_declined?: SuggestedPostDeclined;
+
+	/**
+	 * Optional. Service message: payment for a suggested post was received
+	 */
+	suggested_post_paid?: SuggestedPostPaid;
+
+	/**
+	 * Optional. Service message: payment for a suggested post was refunded
+	 */
+	suggested_post_refunded?: SuggestedPostRefunded;
+
 	/**
 	 * Optional. Service message: video chat scheduled
 	 */
@@ -563,35 +622,69 @@ export type Message = {
 
 export const messageTypes = [
 	"text",
+	"suggested_post_info",
 	"animation",
 	"audio",
-	"contact",
-	"dice",
 	"document",
-	"game",
-	"invoice",
-	"location",
-	"passport_data",
+	"paid_media",
 	"photo",
-	"pinned_message",
-	"poll",
 	"sticker",
+	"story",
 	"video",
 	"video_note",
 	"voice",
-	"successful_payment",
-	"refunded_payment",
-	"migrate_from_chat_id",
-	"migrate_to_chat_id",
+	"checklist",
+	"contact",
+	"dice",
+	"game",
+	"poll",
+	"venue",
+	"location",
 	"new_chat_members",
-	"new_chat_photo",
-	"new_chat_title",
 	"left_chat_member",
+	"new_chat_title",
+	"new_chat_photo",
 	"delete_chat_photo",
 	"group_chat_created",
 	"supergroup_chat_created",
 	"channel_chat_created",
 	"message_auto_delete_timer_changed",
+	"migrate_to_chat_id",
+	"migrate_from_chat_id",
+	"pinned_message",
+	"invoice",
+	"successful_payment",
+	"refunded_payment",
+	"users_shared",
+	"chat_shared",
+	"gift",
+	"unique_gift",
+	"gift_upgrade_sent",
+	"connected_website",
+	"write_access_allowed",
+	"passport_data",
+	"proximity_alert_triggered",
+	"boost_added",
+	"chat_background_set",
+	"checklist_tasks_done",
+	"checklist_tasks_added",
+	"direct_message_price_changed",
+	"forum_topic_created",
+	"forum_topic_edited",
+	"forum_topic_closed",
+	"forum_topic_reopened",
+	"general_forum_topic_hidden",
+	"general_forum_topic_unhidden",
+	"giveaway_created",
+	"giveaway",
+	"giveaway_winners",
+	"giveaway_completed",
+	"paid_message_price_changed",
+	"suggested_post_approved",
+	"suggested_post_approval_failed",
+	"suggested_post_declined",
+	"suggested_post_paid",
+	"suggested_post_refunded",
 	"video_chat_scheduled",
 	"video_chat_started",
 	"video_chat_ended",

package/@types/OwnedGiftRegular.ts

@@ -74,4 +74,15 @@ export type OwnedGiftRegular = {
 	 * Optional. Number of Telegram Stars that were paid by the sender for the ability to upgrade the gift
 	 */
 	prepaid_upgrade_star_count?: number;
+
+	/**
+	 * Optional. True, if the gift's upgrade was purchased after the gift was sent; for gifts received on behalf of
+	 * business accounts only
+	 */
+	is_upgrade_separate?: true;
+
+	/**
+	 * Optional. Unique number reserved for this gift when upgraded. See the number field in UniqueGift
+	 */
+	unique_gift_number?: number;
 };

package/@types/ReplyParameters.ts

@@ -41,8 +41,14 @@ export type ReplyParameters = {
 	 * 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;
+
+	/**
+	 * Optional. Identifier of the specific checklist task to be replied to
+	 */
+	checklist_task_id?: number;
 };

package/@types/Sticker.ts

@@ -38,6 +38,11 @@ export type Sticker = {
 	 */
 	is_animated: boolean;
 
+	/**
+	 * True, if the sticker is a video sticker
+	 */
+	is_video: boolean;
+
 	/**
 	 * True, if the sticker is a video sticker
 	 */

package/@types/SuggestedPostApprovalFailed.ts

@@ -0,0 +1,20 @@
+import type { Message, SuggestedPostPrice } from "./";
+
+/**
+ * ## SuggestedPostApprovalFailed
+ * Describes a service message about the failed approval of a suggested post. Currently, only caused by insufficient
+ * user funds at the time of approval.
+ * @see https://core.telegram.org/bots/api#suggestedpostapprovalfailed
+ */
+export type SuggestedPostApprovalFailed = {
+	/**
+	 * Optional. Message containing the suggested post whose approval has failed. Note that the Message object in this
+	 * field will not contain the reply_to_message field even if it itself is a reply.
+	 */
+	suggested_post_message?: Message;
+
+	/**
+	 * Expected price of the post
+	 */
+	price?: SuggestedPostPrice;
+};

package/@types/SuggestedPostApproved.ts

@@ -0,0 +1,24 @@
+import type { Message, SuggestedPostPrice } from "./";
+
+/**
+ * ## SuggestedPostApproved
+ * Describes a service message about the approval of a suggested post.
+ * @see https://core.telegram.org/bots/api#suggestedpostapproved
+ */
+export type SuggestedPostApproved = {
+	/**
+	 * Optional. Message containing the suggested post. Note that the Message object in this field will not contain the
+	 * reply_to_message field even if it itself is a reply.
+	 */
+	suggested_post_message?: Message;
+
+	/**
+	 * Optional. Amount paid for the post
+	 */
+	price?: SuggestedPostPrice;
+
+	/**
+	 * Date when the post will be published
+	 */
+	send_date: number;
+};

package/@types/SuggestedPostDeclined.ts

@@ -0,0 +1,19 @@
+import type { Message } from "./";
+
+/**
+ * ## SuggestedPostDeclined
+ * Describes a service message about the rejection of a suggested post.
+ * @see https://core.telegram.org/bots/api#suggestedpostdeclined
+ */
+export type SuggestedPostDeclined = {
+	/**
+	 * Optional. Message containing the suggested post. Note that the Message object in this field will not contain the
+	 * reply_to_message field even if it itself is a reply.
+	 */
+	suggested_post_message?: Message;
+
+	/**
+	 * Optional. Comment with which the post was declined
+	 */
+	comment?: string;
+};

package/@types/SuggestedPostInfo.ts

@@ -0,0 +1,24 @@
+import type { SuggestedPostPrice } from "./";
+
+/**
+ * ## SuggestedPostInfo
+ * Contains information about a suggested post.
+ * @see https://core.telegram.org/bots/api#suggestedpostinfo
+ */
+export type SuggestedPostInfo = {
+	/**
+	 * State of the suggested post. Currently, it can be one of “pending”, “approved”, “declined”.
+	 */
+	state: "pending" | "approved" | "declined";
+
+	/**
+	 * Optional. Proposed price of the post. If the field is omitted, then the post is unpaid.
+	 */
+	price?: SuggestedPostPrice;
+
+	/**
+	 * Optional. Proposed send date of the post. If the field is omitted, then the post can be published at any time
+	 * within 30 days at the sole discretion of the user or administrator who approves it.
+	 */
+	send_date?: number;
+};

package/@types/SuggestedPostPaid.ts

@@ -0,0 +1,30 @@
+import type { Message, StarAmount } from "./";
+
+/**
+ * ## SuggestedPostPaid
+ * Describes a service message about a successful payment for a suggested post.
+ * @see https://core.telegram.org/bots/api#suggestedpostpaid
+ */
+export type SuggestedPostPaid = {
+	/**
+	 * Optional. Message containing the suggested post. Note that the Message object in this field will not contain the
+	 * reply_to_message field even if it itself is a reply.
+	 */
+	suggested_post_message: Message;
+
+	/**
+	 * Currency in which the payment was made. Currently, one of “XTR” for Telegram Stars or “TON” for toncoins
+	 */
+	currency: "XTR" | "TON";
+
+	/**
+	 * Optional. The amount of the currency that was received by the channel in nanotoncoins; for payments in toncoins
+	 * only
+	 */
+	amount?: number;
+
+	/**
+	 * Optional. The amount of Telegram Stars that was received by the channel; for payments in Telegram Stars only
+	 */
+	star_amount?: StarAmount;
+};