nyx-bot-client 0.0.2

package/@types/InputProfilePhoto.ts

@@ -0,0 +1,10 @@
+import type { InputProfilePhotoAnimated, InputProfilePhotoStatic } from "./";
+
+/**
+ * ## InputProfilePhoto
+ * This object describes a profile photo to be set for a user or bot.
+ * @see https://core.telegram.org/bots/api#inputprofilephoto
+ */
+export type InputProfilePhoto =
+	| InputProfilePhotoStatic
+	| InputProfilePhotoAnimated;

package/@types/InputProfilePhotoAnimated.ts

@@ -0,0 +1,23 @@
+/**
+ * ## InputProfilePhotoAnimated
+ * Represents an animated profile photo.
+ * @see https://core.telegram.org/bots/api#inputprofilephotoanimated
+ */
+export type InputProfilePhotoAnimated = {
+	/**
+	 * Type of the profile photo, must be 'animated'
+	 */
+	type: "animated";
+
+	/**
+	 * The animated profile photo. Use “attach://<file_attach_name>” if uploaded
+	 * via multipart/form-data.
+	 */
+	animation: string;
+
+	/**
+	 * Optional. Timestamp in seconds of the frame that will be used as the static
+	 * profile photo. Defaults to 0.0.
+	 */
+	main_frame_timestamp?: number;
+};

package/@types/InputProfilePhotoStatic.ts

@@ -0,0 +1,18 @@
+/**
+ * ## InputProfilePhotoStatic
+ * Represents a static profile photo in the .JPG format.
+ * @see https://core.telegram.org/bots/api#inputprofilephotostatic
+ */
+export type InputProfilePhotoStatic = {
+	/**
+	 * Type of the profile photo, must be 'static'
+	 */
+	type: "static";
+
+	/**
+	 * The static profile photo. Profile photos can't be reused and can only be
+	 * uploaded as a new file, so you can pass “attach://<file_attach_name>” if
+	 * the photo was uploaded using multipart/form-data under <file_attach_name>.
+	 */
+	photo: string;
+};

package/@types/InputSticker.ts

@@ -0,0 +1,38 @@
+import type { InputFile, MaskPosition } from "./";
+
+/**
+ * ## InputSticker
+ * This object describes a sticker to be added to a sticker set.
+ * @see https://core.telegram.org/bots/api#inputsticker
+ */
+export type InputSticker = {
+	/**
+	 * The added sticker. Pass a file_id as a String to send a file that already exists on the Telegram servers, pass an
+	 * HTTP URL as a String for Telegram to get a file from the Internet, upload a new one using multipart/form-data, or
+	 * pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name.
+	 * Animated and video stickers can't be uploaded via HTTP URL. [More information on Sending Files](https://core.telegram.org/bots/api#sending-files)
+	 */
+	sticker: InputFile | string;
+
+	/**
+	 * Format of the added sticker, must be one of “static” for a .WEBP or .PNG image, “animated” for a .TGS animation,
+	 * “video” for a WEBM video
+	 */
+	format: "static" | "animated" | "video";
+
+	/**
+	 * List of 1-20 emoji associated with the sticker
+	 */
+	emoji_list: string[];
+
+	/**
+	 * Optional. Position where the mask should be placed on faces. For “mask” stickers only.
+	 */
+	mask_position?: MaskPosition;
+
+	/**
+	 * Optional. List of 0-20 search keywords for the sticker with total length of up to 64 characters. For “regular”
+	 * and “custom_emoji” stickers only.
+	 */
+	keywords?: string[];
+};

package/@types/InputStoryContent.ts

@@ -0,0 +1,11 @@
+import type { InputStoryContentPhoto, InputStoryContentVideo } from "./";
+
+/**
+ * ## InputStoryContent
+ * This object describes the content of a story to be set for a user or chat.
+ * Currently, it can be one of:
+ * - InputStoryContentPhoto
+ * - InputStoryContentVideo
+ * @see https://core.telegram.org/bots/api#inputstorycontent
+ */
+export type InputStoryContent = InputStoryContentPhoto | InputStoryContentVideo;

package/@types/InputStoryContentPhoto.ts

@@ -0,0 +1,29 @@
+/**
+ * ## InputStoryContentPhoto
+ * Represents a photo to be used as story content.
+ * @see https://core.telegram.org/bots/api#inputstorycontentphoto
+ */
+export type InputStoryContentPhoto = {
+	/**
+	 * Type of the story content, must be 'photo'
+	 */
+	type: "photo";
+
+	/**
+	 * 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 file from the
+	 * Internet, or pass “attach://<file_attach_name>” to upload a new one using
+	 * multipart/form-data under <file_attach_name> name.
+	 */
+	media: string;
+
+	/**
+	 * Optional. Thumbnail of the file sent; can be ignored if thumbnail
+	 * generation for the file is supported server-side. The thumbnail should be
+	 * in JPEG format and less than 200 kB in size. A thumbnail's width and height
+	 * should not exceed 320. Thumbnails can't be reused and can be only uploaded
+	 * as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail
+	 * was uploaded using multipart/form-data under <file_attach_name>.
+	 */
+	thumbnail?: string;
+};

package/@types/InputStoryContentVideo.ts

@@ -0,0 +1,49 @@
+/**
+ * ## InputStoryContentVideo
+ * Represents a video to be used as story content.
+ * @see https://core.telegram.org/bots/api#inputstorycontentvideo
+ */
+export type InputStoryContentVideo = {
+	/**
+	 * Type of the story content, must be 'video'
+	 */
+	type: "video";
+
+	/**
+	 * 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 file from the
+	 * Internet, or pass “attach://<file_attach_name>” to upload a new one using
+	 * multipart/form-data under <file_attach_name> name.
+	 */
+	media: string;
+
+	/**
+	 * Optional. Thumbnail of the file sent; can be ignored if thumbnail
+	 * generation for the file is supported server-side. The thumbnail should be
+	 * in JPEG format and less than 200 kB in size. A thumbnail's width and height
+	 * should not exceed 320. Thumbnails can't be reused and can be only uploaded
+	 * as a new file, so you can pass “attach://<file_attach_name>” if the
+	 * thumbnail was uploaded using multipart/form-data under <file_attach_name>.
+	 */
+	thumbnail?: string;
+
+	/**
+	 * Optional. Video width
+	 */
+	width?: number;
+
+	/**
+	 * Optional. Video height
+	 */
+	height?: number;
+
+	/**
+	 * Optional. Video duration in seconds
+	 */
+	duration?: number;
+
+	/**
+	 * Optional. Pass True if the uploaded video is suitable for streaming
+	 */
+	supports_streaming?: boolean;
+};

package/@types/InputTextMessageContent.ts

@@ -0,0 +1,28 @@
+import type { LinkPreviewOptions, MessageEntity, ParseMode } from "./";
+
+/**
+ * ## InputTextMessageContent
+ * Represents the content of a text message to be sent as the result of an inline query.
+ * @see https://core.telegram.org/bots/api#inputtextmessagecontent
+ */
+export type InputTextMessageContent = {
+	/**
+	 * Text of the message to be sent, 1-4096 characters
+	 */
+	message_text: string;
+
+	/**
+	 * Optional. Mode for parsing entities in the message text. See formatting options for more details.
+	 */
+	parse_mode?: ParseMode;
+
+	/**
+	 * Optional. List of special entities that appear in message text, which can be specified instead of parse_mode
+	 */
+	entities?: MessageEntity[];
+
+	/**
+	 * Optional. Link preview generation options for the message
+	 */
+	link_preview_options?: LinkPreviewOptions;
+};

package/@types/InputVenueMessageContent.ts

@@ -0,0 +1,47 @@
+/**
+ * ## InputVenueMessageContent
+ * Represents the content of a venue message to be sent as the result of an inline query.
+ * @see https://core.telegram.org/bots/api#inputvenuemessagecontent
+ */
+export type InputVenueMessageContent = {
+	/**
+	 * Latitude of the venue in degrees
+	 */
+	latitude: number;
+
+	/**
+	 * Longitude of the venue in degrees
+	 */
+	longitude: number;
+
+	/**
+	 * Name of the venue
+	 */
+	title: string;
+
+	/**
+	 * Address of the venue
+	 */
+	address: string;
+
+	/**
+	 * Optional. Foursquare identifier of the venue, if known
+	 */
+	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.)
+	 */
+	google_place_type?: string;
+};

package/@types/Invoice.ts

@@ -0,0 +1,35 @@
+import type { Currencies } from "./index";
+
+/**
+ * ## Invoice
+ * This object contains basic information about an invoice.
+ * @see https://core.telegram.org/bots/api#invoice
+ */
+export type Invoice = {
+	/**
+	 * Product name
+	 */
+	title: string;
+
+	/**
+	 * Product description
+	 */
+	description: string;
+
+	/**
+	 * Unique bot deep-linking parameter that can be used to generate this invoice
+	 */
+	start_parameter: string;
+
+	/**
+	 * 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;
+};

package/@types/KeyboardButton.ts

@@ -0,0 +1,61 @@
+import type { AtMostOne } from "../utils";
+import type {
+	KeyboardButtonPollType,
+	KeyboardButtonRequestChat,
+	KeyboardButtonRequestUsers,
+	WebAppInfo,
+} from "./";
+
+/**
+ * ## KeyboardButton
+ * This object represents one button of the reply keyboard. At most one of the optional fields must be used to specify
+ * type of the button. For simple text buttons, String can be used instead of this object to specify the button text.
+ * @see https://core.telegram.org/bots/api#keyboardbutton
+ */
+export type KeyboardButton =
+	| string
+	| ({
+			/**
+			 * Text of the button. If none of the optional fields are used, it will be sent as a message when the button is
+			 * pressed
+			 */
+			text: string;
+	  } & Partial<
+			AtMostOne<{
+				/**
+				 * Optional. If specified, pressing the button will open a list of suitable users. Identifiers of selected users
+				 * will be sent to the bot in a “users_shared” service message. Available in private chats only.
+				 */
+				request_users?: KeyboardButtonRequestUsers;
+
+				/**
+				 * Optional. If specified, pressing the button will open a list of suitable chats. Tapping on a chat will send
+				 * its identifier to the bot in a “chat_shared” service message. Available in private chats only.
+				 */
+				request_chat?: KeyboardButtonRequestChat;
+
+				/**
+				 * Optional. If True, the user's phone number will be sent as a contact when the button is pressed. Available in
+				 * private chats only.
+				 */
+				request_contact?: boolean;
+
+				/**
+				 * Optional. If True, the user's current location will be sent when the button is pressed. Available in private
+				 * chats only.
+				 */
+				request_location?: boolean;
+
+				/**
+				 * Optional. If specified, the user will be asked to create a poll and send it to the bot when the button is
+				 * pressed. Available in private chats only.
+				 */
+				request_poll?: KeyboardButtonPollType;
+
+				/**
+				 * Optional. If specified, the described Web App will be launched when the button is pressed. The Web App will
+				 * be able to send a “web_app_data” service message. Available in private chats only.
+				 */
+				web_app?: WebAppInfo;
+			}>
+	  >);

package/@types/KeyboardButtonPollType.ts

@@ -0,0 +1,13 @@
+/**
+ * ## KeyboardButtonPollType
+ * This object represents type of a poll, which is allowed to be created and sent when the corresponding button is
+ * pressed.
+ * @see https://core.telegram.org/bots/api#keyboardbuttonpolltype
+ */
+export type KeyboardButtonPollType = {
+	/**
+	 * Optional. If quiz is passed, the user will be allowed to create only polls in the quiz mode. If regular is passed,
+	 * only regular polls will be allowed. Otherwise, the user will be allowed to create a poll of any type.
+	 */
+	type?: "quiz" | "regular";
+};

package/@types/KeyboardButtonRequestChat.ts

@@ -0,0 +1,68 @@
+import type { ChatAdministratorRights } from "./ChatAdministratorRights";
+
+/**
+ * ## KeyboardButtonRequestChat
+ * This object defines the criteria used to request a suitable chat. Information about the selected chat will be shared
+ * with the bot when the corresponding button is pressed. The bot will be granted requested rights in the chat if
+ * appropriate. [More about requesting chats](https://core.telegram.org/bots/features#chat-and-user-selection).
+ * @see https://core.telegram.org/bots/api#keyboardbuttonrequestchat
+ */
+export type KeyboardButtonRequestChat = {
+	/**
+	 * Signed 32-bit identifier of the request, which will be received back in the ChatShared object. Must be unique
+	 * within the message
+	 */
+	request_id: number;
+
+	/**
+	 * Pass True to request a channel chat, pass False to request a group or a supergroup chat.
+	 */
+	chat_is_channel: boolean;
+
+	/**
+	 * Optional. Pass True to request a forum supergroup, pass False to request a non-forum chat. If not specified, no
+	 * additional restrictions are applied.
+	 */
+	chat_is_forum?: boolean;
+
+	/**
+	 * Optional. Pass True to request a supergroup or a channel with a username, pass False to request a chat without a
+	 * username. If not specified, no additional restrictions are applied.
+	 */
+	chat_has_username?: boolean;
+
+	/**
+	 * Optional. Pass True to request a chat owned by the user. Otherwise, no additional restrictions are applied.
+	 */
+	chat_is_created?: boolean;
+
+	/**
+	 * 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>;
+	/**
+	 * 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>;
+	/**
+	 * Optional. Pass True to request a chat with the bot as a member. Otherwise, no additional restrictions are applied.
+	 */
+	bot_is_member?: boolean;
+
+	/**
+	 * Optional. Pass True to request the chat's title
+	 */
+	request_title?: boolean;
+
+	/**
+	 * Optional. Pass True to request the chat's username
+	 */
+	request_username?: boolean;
+
+	/**
+	 * Optional. Pass True to request the chat's photo
+	 */
+	request_photo?: boolean;
+};

package/@types/KeyboardButtonRequestUsers.ts

@@ -0,0 +1,45 @@
+/**
+ * ## KeyboardButtonRequestUsers
+ * This object defines the criteria used to request suitable users. Information about the selected users will be shared
+ * with the bot when the corresponding button is pressed. [More about requesting users](https://core.telegram.org/bots/features#chat-and-user-selection)
+ * @see https://core.telegram.org/bots/api#keyboardbuttonrequestusers
+ */
+export type KeyboardButtonRequestUsers = {
+	/**
+	 * Signed 32-bit identifier of the request that will be received back in the UsersShared object. Must be unique within
+	 * the message
+	 */
+	request_id: number;
+
+	/**
+	 * Optional. Pass True to request bots, pass False to request regular users. If not specified, no additional
+	 * restrictions are applied.
+	 */
+	user_is_bot?: boolean;
+
+	/**
+	 * Optional. Pass True to request premium users, pass False to request non-premium users. If not specified, no
+	 * additional restrictions are applied.
+	 */
+	user_is_premium?: boolean;
+
+	/**
+	 * Optional. The maximum number of users to be selected; 1-10. Defaults to 1.
+	 */
+	max_quantity?: number;
+
+	/**
+	 * Optional. Pass True to request the users' first and last names
+	 */
+	request_name?: boolean;
+
+	/**
+	 * Optional. Pass True to request the users' usernames
+	 */
+	request_username?: boolean;
+
+	/**
+	 * Optional. Pass True to request the users' photos
+	 */
+	request_photo?: boolean;
+};

package/@types/LabeledPrice.ts

@@ -0,0 +1,18 @@
+/**
+ * ## LabeledPrice
+ * This object represents a portion of the price for goods or services.
+ * @see https://core.telegram.org/bots/api#labeledprice
+ */
+export type LabeledPrice = {
+	/**
+	 * Portion label
+	 */
+	label: string;
+
+	/**
+	 * Price of the product 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).
+	 */
+	amount: number;
+};

package/@types/LinkPreviewOptions.ts

@@ -0,0 +1,32 @@
+/**
+ * ## LinkPreviewOptions
+ * Describes the options used for link preview generation.
+ * @see https://core.telegram.org/bots/api#linkpreviewoptions
+ */
+export type LinkPreviewOptions = {
+	/**
+	 * Optional. True, if the link preview is disabled
+	 */
+	is_disabled?: boolean;
+
+	/**
+	 * Optional. URL to use for the link preview. If empty, then the first URL found in the message text will be used
+	 */
+	url?: string;
+	/**
+	 * Optional. True, if the media in the link preview is supposed to be shrunk; ignored if the URL isn't explicitly
+	 * specified or media size change isn't supported for the preview
+	 */
+	prefer_small_media?: boolean;
+	/**
+	 * Optional. True, if the media in the link preview is supposed to be enlarged; ignored if the URL isn't explicitly
+	 * specified or media size change isn't supported for the preview
+	 */
+	prefer_large_media?: boolean;
+
+	/**
+	 * Optional. True, if the link preview must be shown above the message text; otherwise, the link preview will be shown
+	 * below the message text
+	 */
+	show_above_text?: boolean;
+};

package/@types/Location.ts

@@ -0,0 +1,38 @@
+/**
+ * ## Location
+ * his object represents a point on the map.
+ * @see https://core.telegram.org/bots/api#location
+ */
+export type Location = {
+	/**
+	 * Latitude as defined by the sender
+	 */
+	latitude: number;
+
+	/**
+	 * Longitude as defined by the sender
+	 */
+	longitude: number;
+
+	/**
+	 * Optional. The radius of uncertainty for the location, measured in meters; 0-1500
+	 */
+	horizontal_accuracy?: number;
+
+	/**
+	 * Optional. Time relative to the message sending date, during which the location can be updated; in seconds.
+	 * For active live locations only.
+	 */
+	live_period?: number;
+
+	/**
+	 * Optional. The direction in which user is moving, in degrees; 1-360. For active live locations only.
+	 */
+	heading?: number;
+
+	/**
+	 * Optional. The maximum distance for proximity alerts about approaching another chat member, in meters. For sent
+	 * live locations only.
+	 */
+	proximity_alert_radius?: number;
+};

package/@types/LocationAddress.ts

@@ -0,0 +1,26 @@
+/**
+ * ## LocationAddress
+ * Describes the physical address of a location.
+ * @see https://core.telegram.org/bots/api#locationaddress
+ */
+export type LocationAddress = {
+	/**
+	 * The two-letter ISO 3166-1 alpha-2 country code of the country where the location is located
+	 */
+	country_code: string;
+
+	/**
+	 * Optional. State of the location
+	 */
+	state?: string;
+
+	/**
+	 * Optional. City of the location
+	 */
+	city?: string;
+
+	/**
+	 * Optional. Street address of the location
+	 */
+	street?: string;
+};

package/@types/LoginUrl.ts

@@ -0,0 +1,37 @@
+/**
+ * ## LoginUrl
+ * This object represents a parameter of the inline keyboard button used to automatically authorize a user. Serves as a
+ * great replacement for the Telegram Login Widget when the user is coming from Telegram. All the user needs to do is
+ * tap/click a button and confirm that they want to log in:
+ * Telegram apps support these buttons as of version 5.7.
+ * > Sample bot: @discussbot
+ * @see https://core.telegram.org/bots/api#loginurl
+ */
+export type LoginUrl = {
+	/**
+	 * An HTTPS URL to be opened with user authorization data added to the query string when the button is pressed.
+	 * If the user refuses to provide authorization data, the original URL without information about the user will be
+	 * opened. The data added is the same as described in Receiving authorization data.
+	 *
+	 * NOTE: You must always check the hash of the received data to verify the authentication and the integrity of the
+	 * data as described in Checking authorization.
+	 */
+	url: string;
+
+	/**
+	 * Optional. New text of the button in forwarded messages.
+	 */
+	forward_text?: string;
+
+	/**
+	 * Optional. Username of a bot, which will be used for user authorization. See Setting up a bot for more details.
+	 * If not specified, the current bot's username will be assumed. The url's domain must be the same as the domain
+	 * linked with the bot. See Linking your domain to the bot for more details.
+	 */
+	bot_username?: string;
+
+	/**
+	 * Optional. Pass True to request the permission for your bot to send messages to the user.
+	 */
+	request_write_access?: boolean;
+};

package/@types/MaskPosition.ts

@@ -0,0 +1,28 @@
+/**
+ * ## MaskPosition
+ * This object describes the position on faces where a mask should be placed by default.
+ * @see https://core.telegram.org/bots/api#maskposition
+ */
+export type MaskPosition = {
+	/**
+	 * The part of the face relative to which the mask should be placed. One of “forehead”, “eyes”, “mouth”, or “chin”.
+	 */
+	point: "forehead" | "eyes" | "mouth" | "chin";
+
+	/**
+	 * Shift by X-axis measured in widths of the mask scaled to the face size, from left to right. For example,
+	 * choosing -1.0 will place mask just to the left of the default mask position.
+	 */
+	x_shift: number;
+
+	/**
+	 * Shift by Y-axis measured in heights of the mask scaled to the face size, from top to bottom. For example,
+	 * 1.0 will place the mask just below the default mask position.
+	 */
+	y_shift: number;
+
+	/**
+	 * Mask scaling coefficient. For example, 2.0 means double size.
+	 */
+	scale: number;
+};