nyx-bot-client 1.0.0 → 1.0.2

package/@types/BackgroundFillSolid.ts

@@ -12,5 +12,5 @@ export type BackgroundFillSolid = {
 	/**
 	 * The color of the background fill in the RGB24 format
 	 */
-	color: string;
+	color: number;
 };

package/@types/BackgroundTypePattern.ts

@@ -31,10 +31,10 @@ export type BackgroundTypePattern = {
 	 * Optional. True, if the background fill must be applied only to the pattern itself. All other pixels are black in
 	 * this case. For dark themes only
 	 */
-	is_blurred: boolean;
+	is_inverted?: true;
 
 	/**
 	 * Optional. True, if the background moves slightly when the device is tilted
 	 */
-	is_moving: boolean;
+	is_moving?: true;
 };

package/@types/BackgroundTypeWallpaper.ts

@@ -24,10 +24,10 @@ export type BackgroundTypeWallpaper = {
 	/**
 	 * Optional. True, if the wallpaper is downscaled to fit in a 450x450 square and then box-blurred with radius 12
 	 */
-	is_blurred: boolean;
+	is_blurred?: true;
 
 	/**
 	 * Optional. True, if the background moves slightly when the device is tilted
 	 */
-	is_moving: boolean;
+	is_moving?: true;
 };

package/@types/BotAccessSettings.ts

@@ -0,0 +1,18 @@
+import type { User } from "./";
+
+/**
+ * ## BotAccessSettings
+ * This object describes the access settings of a bot.
+ * @see https://core.telegram.org/bots/api#botaccesssettings
+ */
+export type BotAccessSettings = {
+	/**
+	 * True, if only selected users can access the bot. The bot's owner can always access it.
+	 */
+	is_access_restricted: boolean;
+
+	/**
+	 * Optional. The list of other users who have access to the bot if the access is restricted
+	 */
+	added_users?: User[];
+};

package/@types/ChatMemberRestricted.ts

@@ -77,6 +77,11 @@ export type ChatMemberRestricted = {
 	 */
 	can_add_web_page_previews: boolean;
 
+	/**
+	 * True, if the user is allowed to react to messages
+	 */
+	can_react_to_messages: boolean;
+
 	/**
 	 * True, if the user is allowed to edit their own tag
 	 */

package/@types/ChatPermissions.ts

@@ -56,7 +56,14 @@ export type ChatPermissions = {
 	can_add_web_page_previews?: boolean;
 
 	/**
-	 * Optional. True, if the user is allowed to edit their own tag
+	 * Optional. True, if the user is allowed to react to messages. If omitted, defaults to the value of
+	 * can_send_messages.
+	 */
+	can_react_to_messages?: boolean;
+
+	/**
+	 * Optional. True, if the user is allowed to edit their own tag. If omitted, defaults to the value of
+	 * can_pin_messages.
 	 */
 	can_edit_tag?: boolean;
 

package/@types/ExternalReplyInfo.ts

@@ -11,6 +11,7 @@ import type {
 	GiveawayWinners,
 	Invoice,
 	LinkPreviewOptions,
+	LivePhoto,
 	Location,
 	MessageOrigin,
 	PaidMediaInfo,
@@ -67,6 +68,11 @@ export type ExternalReplyInfo = {
 	 */
 	document?: Document;
 
+	/**
+	 * Optional. Message is a live photo, information about the live photo
+	 */
+	live_photo?: LivePhoto;
+
 	/**
 	 * Optional. Message contains paid media; information about the paid media
 	 */

package/@types/ForumTopic.ts

@@ -17,7 +17,7 @@ export type ForumTopic = {
 	/**
 	 * Color of the topic icon in RGB format
 	 */
-	icon_color: string;
+	icon_color: number;
 
 	/**
 	 * Optional. Unique identifier of the custom emoji shown as the topic icon

package/@types/ForumTopicCreated.ts

@@ -17,7 +17,7 @@ export type ForumTopicCreated = {
 	/**
 	 * Optional. Unique identifier of the custom emoji shown as the topic icon
 	 */
-	icon_custom_emoji_id: string;
+	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

package/@types/Giveaway.ts

@@ -9,7 +9,7 @@ export type Giveaway = {
 	/**
 	 * The list of chats which the user must join to participate in the giveaway
 	 */
-	chat: Chat;
+	chats: Chat[];
 
 	/**
 	 * Point in time (Unix timestamp) when winners of the giveaway will be selected
@@ -19,7 +19,7 @@ export type Giveaway = {
 	/**
 	 * The number of users which are supposed to be selected as winners of the giveaway
 	 */
-	winner_count?: number;
+	winner_count: number;
 
 	/**
 	 * Optional. True, if only users who join the chats after the giveaway started should be eligible to win

package/@types/GiveawayCompleted.ts

@@ -14,16 +14,16 @@ export type GiveawayCompleted = {
 	/**
 	 * Optional. Number of undistributed prizes
 	 */
-	unclaimed_prize_count: number;
+	unclaimed_prize_count?: number;
 
 	/**
 	 * Optional. Message with the giveaway that was completed, if it wasn't deleted
 	 */
-	giveaway_message: Message;
+	giveaway_message?: Message;
 
 	/**
 	 * Optional. True, if the giveaway is a Telegram Star giveaway. Otherwise, currently, the giveaway is a Telegram
 	 * Premium giveaway.
 	 */
-	is_star_giveaway: boolean;
+	is_star_giveaway?: true;
 };

package/@types/InlineQueryResultArticle.ts

@@ -44,15 +44,15 @@ export type InlineQueryResultArticle = {
 	/**
 	 * Optional. Url of the thumbnail for the result
 	 */
-	thumb_url?: string;
+	thumbnail_url?: string;
 
 	/**
 	 * Optional. Thumbnail width
 	 */
-	thumb_width?: number;
+	thumbnail_width?: number;
 
 	/**
 	 * Optional. Thumbnail height
 	 */
-	thumb_height?: number;
+	thumbnail_height?: number;
 };

package/@types/InlineQueryResultGif.ts

@@ -52,7 +52,7 @@ export type InlineQueryResultGif = {
 	 * Optional. MIME type of the thumbnail, must be one of “image/jpeg”, “image/gif”, or “video/mp4”. Defaults to
 	 * “image/jpeg”
 	 */
-	thumbnail_mime_type: "image/jpeg" | "image/gif" | "video/mp4";
+	thumbnail_mime_type?: "image/jpeg" | "image/gif" | "video/mp4";
 
 	/**
 	 * Optional. Title for the result

package/@types/InlineQueryResultMpeg4Gif.ts

@@ -52,7 +52,7 @@ export type InlineQueryResultMpeg4Gif = {
 	 * Optional. MIME type of the thumbnail, must be one of “image/jpeg”, “image/gif”, or “video/mp4”. Defaults to
 	 * “image/jpeg”
 	 */
-	thumbnail_mime_type: "image/jpeg" | "image/gif" | "video/mp4";
+	thumbnail_mime_type?: "image/jpeg" | "image/gif" | "video/mp4";
 
 	/**
 	 * Optional. Title for the result

package/@types/InlineQueryResultVenue.ts

@@ -48,6 +48,11 @@ export type InlineQueryResultVenue = {
 	 */
 	foursquare_type?: string;
 
+	/**
+	 * Optional. Google Places identifier of the venue
+	 */
+	google_place_id?: string;
+
 	/**
 	 * Optional. Google Places type of the venue. (See supported types.)
 	 */

package/@types/InlineQueryResultsButton.ts

@@ -1,5 +1,5 @@
-import type { AtMostOne } from "../utils";
 import type { WebAppInfo } from "./";
+import type { AtMostOne } from "./utils";
 
 /**
  * ## InlineQueryResultsButton

package/@types/InputInvoiceMessageContent.ts

@@ -25,7 +25,7 @@ export type InputInvoiceMessageContent = {
 	/**
 	 * Optional. Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars.
 	 */
-	provider_token: string;
+	provider_token?: string;
 
 	/**
 	 * Three-letter ISO 4217 currency code, see more on currencies. Pass “XTR” for payments in Telegram Stars.

package/@types/InputMedia.ts

@@ -2,6 +2,7 @@ import type {
 	InputMediaAnimation,
 	InputMediaAudio,
 	InputMediaDocument,
+	InputMediaLivePhoto,
 	InputMediaPhoto,
 	InputMediaVideo,
 } from "./";
@@ -10,8 +11,9 @@ import type {
  * ## InputMedia
  * This object represents the content of a media message to be sent. It should be one of
  * - InputMediaAnimation
- * - InputMediaDocument
  * - InputMediaAudio
+ * - InputMediaDocument
+ * - InputMediaLivePhoto
  * - InputMediaPhoto
  * - InputMediaVideo
  * @see https://core.telegram.org/bots/api#inputmedia
@@ -20,5 +22,6 @@ export type InputMedia =
 	| InputMediaAnimation
 	| InputMediaDocument
 	| InputMediaAudio
+	| InputMediaLivePhoto
 	| InputMediaPhoto
 	| InputMediaVideo;

package/@types/InputMediaLivePhoto.ts

@@ -0,0 +1,54 @@
+import type { Attachment, MessageEntity, ParseMode } from "./";
+
+/**
+ * ## InputMediaLivePhoto
+ * Represents a live photo to be sent.
+ * @see https://core.telegram.org/bots/api#inputmedialivephoto
+ */
+export type InputMediaLivePhoto = {
+	/**
+	 * Type of the result, must be live_photo
+	 */
+	type: "live_photo";
+
+	/**
+	 * Video of the live photo to send. Pass a file_id to send a file that exists on the Telegram servers (recommended)
+	 * or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name.
+	 * Sending live photos by a URL is currently unsupported.
+	 * [More information on Sending Files](https://core.telegram.org/bots/api#sending-files)
+	 */
+	media: string | Attachment;
+
+	/**
+	 * The static photo to send. Pass a file_id to send a file that exists on the Telegram servers (recommended) or pass
+	 * “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. Sending
+	 * live photos by a URL is currently unsupported.
+	 * [More information on Sending Files](https://core.telegram.org/bots/api#sending-files)
+	 */
+	photo: string | Attachment;
+
+	/**
+	 * Optional. Caption of the live photo to be sent, 0-1024 characters after entities parsing
+	 */
+	caption?: string;
+
+	/**
+	 * Optional. Mode for parsing entities in the live photo caption. See formatting options for more details.
+	 */
+	parse_mode?: ParseMode;
+
+	/**
+	 * Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode
+	 */
+	caption_entities?: MessageEntity[];
+
+	/**
+	 * Optional. Pass True, if the caption must be shown above the message media
+	 */
+	show_caption_above_media?: boolean;
+
+	/**
+	 * Optional. Pass True if the live photo needs to be covered with a spoiler animation
+	 */
+	has_spoiler?: boolean;
+};

package/@types/InputMediaLocation.ts

@@ -0,0 +1,26 @@
+/**
+ * ## InputMediaLocation
+ * Represents a location to be sent.
+ * @see https://core.telegram.org/bots/api#inputmedialocation
+ */
+export type InputMediaLocation = {
+	/**
+	 * Type of the result, must be location
+	 */
+	type: "location";
+
+	/**
+	 * Latitude of the location
+	 */
+	latitude: number;
+
+	/**
+	 * Longitude of the location
+	 */
+	longitude: number;
+
+	/**
+	 * Optional. The radius of uncertainty for the location, measured in meters; 0-1500
+	 */
+	horizontal_accuracy?: number;
+};

package/@types/InputMediaSticker.ts

@@ -0,0 +1,26 @@
+import type { Attachment } from "./";
+
+/**
+ * ## InputMediaSticker
+ * Represents a sticker file to be sent.
+ * @see https://core.telegram.org/bots/api#inputmediasticker
+ */
+export type InputMediaSticker = {
+	/**
+	 * Type of the result, must be sticker
+	 */
+	type: "sticker";
+
+	/**
+	 * File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL
+	 * for Telegram to get a .WEBP sticker from the Internet, or pass “attach://<file_attach_name>” to upload a new
+	 * .WEBP, .TGS, or .WEBM sticker using multipart/form-data under <file_attach_name> name.
+	 * [More information on Sending Files](https://core.telegram.org/bots/api#sending-files)
+	 */
+	media: string | Attachment;
+
+	/**
+	 * Optional. Emoji associated with the sticker; only for just uploaded stickers
+	 */
+	emoji?: string;
+};

package/@types/InputMediaVenue.ts

@@ -0,0 +1,52 @@
+/**
+ * ## InputMediaVenue
+ * Represents a venue to be sent.
+ * @see https://core.telegram.org/bots/api#inputmediavenue
+ */
+export type InputMediaVenue = {
+	/**
+	 * Type of the result, must be venue
+	 */
+	type: "venue";
+
+	/**
+	 * Latitude of the location
+	 */
+	latitude: number;
+
+	/**
+	 * Longitude of the location
+	 */
+	longitude: number;
+
+	/**
+	 * Name of the venue
+	 */
+	title: string;
+
+	/**
+	 * Address of the venue
+	 */
+	address: string;
+
+	/**
+	 * Optional. Foursquare identifier of the venue
+	 */
+	foursquare_id?: string;
+
+	/**
+	 * Optional. Foursquare type of the venue, if known. (For example, “arts_entertainment/default”,
+	 * “arts_entertainment/aquarium” or “food/icecream”.)
+	 */
+	foursquare_type?: string;
+
+	/**
+	 * Optional. Google Places identifier of the venue
+	 */
+	google_place_id?: string;
+
+	/**
+	 * Optional. Google Places type of the venue. (See [supported types](https://developers.google.com/places/web-service/supported_types).)
+	 */
+	google_place_type?: string;
+};

package/@types/InputPaidMedia.ts

@@ -1,11 +1,16 @@
+import type { InputPaidMediaLivePhoto } from "./InputPaidMediaLivePhoto";
 import type { InputPaidMediaPhoto } from "./InputPaidMediaPhoto";
 import type { InputPaidMediaVideo } from "./InputPaidMediaVideo";
 
 /**
  * ## InputPaidMedia
  * This object describes the paid media to be sent. Currently, it can be one of
+ * - InputPaidMediaLivePhoto
  * - InputPaidMediaPhoto
  * - InputPaidMediaVideo
  * @see https://core.telegram.org/bots/api#inputpaidmedia
  */
-export type InputPaidMedia = InputPaidMediaPhoto | InputPaidMediaVideo;
+export type InputPaidMedia =
+	| InputPaidMediaLivePhoto
+	| InputPaidMediaPhoto
+	| InputPaidMediaVideo;

package/@types/InputPaidMediaLivePhoto.ts

@@ -0,0 +1,29 @@
+import type { Attachment } from "./index";
+
+/**
+ * InputPaidMediaLivePhoto
+ * The paid media to send is a live photo.
+ * @see https://core.telegram.org/bots/api#inputpaidmedialivephoto
+ */
+export type InputPaidMediaLivePhoto = {
+	/**
+	 * Type of the media, must be live_photo
+	 */
+	type: "live_photo";
+
+	/**
+	 * Video of the live photo to send. Pass a file_id to send a file that exists on the Telegram servers (recommended)
+	 * or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name.
+	 * Sending live photos by a URL is currently unsupported.
+	 * @see https://core.telegram.org/bots/api#sending-files
+	 */
+	media: string | Attachment;
+
+	/**
+	 * The static photo to send. Pass a file_id to send a file that exists on the Telegram servers (recommended) or pass
+	 * “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. Sending
+	 * live photos by a URL is currently unsupported.
+	 * @see https://core.telegram.org/bots/api#sending-files
+	 */
+	photo: string | Attachment;
+};

package/@types/InputPollMedia.ts

@@ -0,0 +1,33 @@
+import type {
+	InputMediaAnimation,
+	InputMediaAudio,
+	InputMediaDocument,
+	InputMediaLivePhoto,
+	InputMediaLocation,
+	InputMediaPhoto,
+	InputMediaVenue,
+	InputMediaVideo,
+} from "./";
+
+/**
+ * ## InputPollMedia
+ * This object represents the content of a poll description or a quiz explanation to be sent. It should be one of
+ * - InputMediaAnimation
+ * - InputMediaAudio
+ * - InputMediaDocument
+ * - InputMediaLivePhoto
+ * - InputMediaLocation
+ * - InputMediaPhoto
+ * - InputMediaVenue
+ * - InputMediaVideo
+ * @see https://core.telegram.org/bots/api#inputpollmedia
+ */
+export type InputPollMedia =
+	| InputMediaAnimation
+	| InputMediaAudio
+	| InputMediaDocument
+	| InputMediaLivePhoto
+	| InputMediaLocation
+	| InputMediaPhoto
+	| InputMediaVenue
+	| InputMediaVideo;

package/@types/InputPollOption.ts

@@ -1,4 +1,4 @@
-import type { MessageEntity, ParseMode } from "./";
+import type { InputPollOptionMedia, MessageEntity, ParseMode } from "./";
 
 /**
  * ## InputPollOption
@@ -22,4 +22,9 @@ export type InputPollOption = {
 	 * instead of text_parse_mode
 	 */
 	text_entities?: MessageEntity[];
+
+	/**
+	 * Optional. Media added to the poll option
+	 */
+	media?: InputPollOptionMedia;
 };

package/@types/InputPollOptionMedia.ts

@@ -0,0 +1,30 @@
+import type {
+	InputMediaAnimation,
+	InputMediaLivePhoto,
+	InputMediaLocation,
+	InputMediaPhoto,
+	InputMediaSticker,
+	InputMediaVenue,
+	InputMediaVideo,
+} from "./";
+
+/**
+ * ## InputPollOptionMedia
+ * This object represents the content of a poll option to be sent. It should be one of
+ * - InputMediaAnimation
+ * - InputMediaLivePhoto
+ * - InputMediaLocation
+ * - InputMediaPhoto
+ * - InputMediaSticker
+ * - InputMediaVenue
+ * - InputMediaVideo
+ * @see https://core.telegram.org/bots/api#inputpolloptionmedia
+ */
+export type InputPollOptionMedia =
+	| InputMediaAnimation
+	| InputMediaLivePhoto
+	| InputMediaLocation
+	| InputMediaPhoto
+	| InputMediaSticker
+	| InputMediaVenue
+	| InputMediaVideo;

package/@types/KeyboardButton.ts

@@ -1,10 +1,11 @@
-import type { AtMostOne } from "../utils";
 import type {
 	KeyboardButtonPollType,
 	KeyboardButtonRequestChat,
+	KeyboardButtonRequestManagedBot,
 	KeyboardButtonRequestUsers,
 	WebAppInfo,
 } from "./";
+import type { AtMostOne } from "./utils";
 
 /**
  * ## KeyboardButton
@@ -48,6 +49,13 @@ export type KeyboardButton =
 				 */
 				request_chat?: KeyboardButtonRequestChat;
 
+				/**
+				 * Optional. If specified, pressing the button will ask the user to create and share a bot that will be managed
+				 * by the current bot. Available for bots that enabled management of other bots in the @BotFather Mini App.
+				 * Available in private chats only.
+				 */
+				request_managed_bot?: KeyboardButtonRequestManagedBot;
+
 				/**
 				 * Optional. If True, the user's phone number will be sent as a contact when the button is pressed. Available in
 				 * private chats only.

package/@types/KeyboardButtonRequestChat.ts

@@ -40,12 +40,12 @@ export type KeyboardButtonRequestChat = {
 	 * Optional. A JSON-serialized object listing the required administrator rights of the user in the chat. The rights
 	 * must be a superset of bot_administrator_rights. If not specified, no additional restrictions are applied.
 	 */
-	user_administrator_rights?: Partial<ChatAdministratorRights>;
+	user_administrator_rights?: ChatAdministratorRights;
 	/**
 	 * Optional. A JSON-serialized object listing the required administrator rights of the bot in the chat. The rights
 	 * must be a subset of user_administrator_rights. If not specified, no additional restrictions are applied.
 	 */
-	bot_administrator_rights?: Partial<ChatAdministratorRights>;
+	bot_administrator_rights?: ChatAdministratorRights;
 	/**
 	 * Optional. Pass True to request a chat with the bot as a member. Otherwise, no additional restrictions are applied.
 	 */

package/@types/KeyboardButtonRequestManagedBot.ts

@@ -0,0 +1,22 @@
+/**
+ * ## KeyboardButtonRequestManagedBot
+ * This object defines the parameters for the creation of a managed bot. Information about the created bot will be
+ * shared with the bot using the update managed_bot and a Message with the field managed_bot_created.
+ * @see https://core.telegram.org/bots/api#keyboardbuttonrequestmanagedbot
+ */
+export type KeyboardButtonRequestManagedBot = {
+	/**
+	 * Signed 32-bit identifier of the request. Must be unique within the message
+	 */
+	request_id: number;
+
+	/**
+	 * Optional. Suggested name for the bot
+	 */
+	suggested_name?: string;
+
+	/**
+	 * Optional. Suggested username for the bot
+	 */
+	suggested_username?: string;
+};

package/@types/LivePhoto.ts

@@ -0,0 +1,51 @@
+import type { PhotoSize } from "./";
+
+/**
+ * ## LivePhoto
+ * This object represents a live photo.
+ * @see https://core.telegram.org/bots/api#livephoto
+ */
+export type LivePhoto = {
+	/**
+	 * Optional. Available sizes of the corresponding static photo
+	 */
+	photo?: PhotoSize[];
+
+	/**
+	 * Identifier for the video file which can be used to download or reuse the file
+	 */
+	file_id: string;
+
+	/**
+	 * Unique identifier for the video 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;
+
+	/**
+	 * Video width as defined by the sender
+	 */
+	width: number;
+
+	/**
+	 * Video height as defined by the sender
+	 */
+	height: number;
+
+	/**
+	 * Duration of the video in seconds as defined by the sender
+	 */
+	duration: number;
+
+	/**
+	 * Optional. MIME type of the file as defined by the sender
+	 */
+	mime_type?: string;
+
+	/**
+	 * Optional. File size in bytes. It can be bigger than 2^31 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 value.
+	 */
+	file_size?: number;
+};