nyx-bot-client 0.0.2

package/@types/InlineQueryResultGif.ts

@@ -0,0 +1,91 @@
+import type {
+	InlineKeyboardMarkup,
+	InputMessageContent,
+	MessageEntity,
+	ParseMode,
+} from "./";
+
+/**
+ * ## InlineQueryResultGif
+ * Represents a link to an animated GIF file. By default, this animated GIF file will be sent by the user with optional
+ * caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the
+ * animation.
+ * @see https://core.telegram.org/bots/api#inlinequeryresultgif
+ */
+export type InlineQueryResultGif = {
+	/**
+	 * Type of the result, must be gif
+	 */
+	type: "gif";
+
+	/**
+	 * Unique identifier for this result, 1-64 bytes
+	 */
+	id: string;
+
+	/**
+	 * A valid URL for the GIF file. File size must not exceed 1MB
+	 */
+	gif_url: string;
+
+	/**
+	 * Optional. Width of the GIF
+	 */
+	gif_width?: number;
+
+	/**
+	 * Optional. Height of the GIF
+	 */
+	gif_height?: number;
+
+	/**
+	 * Optional. Duration of the GIF in seconds
+	 */
+	gif_duration?: number;
+
+	/**
+	 * URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result
+	 */
+	thumbnail_url: string;
+
+	/**
+	 * 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";
+
+	/**
+	 * Optional. Title for the result
+	 */
+	title?: string;
+
+	/**
+	 * Optional. Caption of the GIF file to be sent, 0-1024 characters after entities parsing
+	 */
+	caption?: string;
+
+	/**
+	 * Optional. Mode for parsing entities in the 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. Inline keyboard attached to the message
+	 */
+	reply_markup?: InlineKeyboardMarkup;
+
+	/**
+	 * Optional. Content of the message to be sent instead of the GIF animation
+	 */
+	input_message_content?: InputMessageContent;
+};

package/@types/InlineQueryResultLocation.ts

@@ -0,0 +1,82 @@
+import type { InlineKeyboardMarkup, InputMessageContent } from "./";
+
+/**
+ * ## InlineQueryResultLocation
+ * Represents a location on a map. By default, the location will be sent by the user. Alternatively, you can use
+ * input_message_content to send a message with the specified content instead of the location.
+ * @see https://core.telegram.org/bots/api#inlinequeryresultlocation
+ */
+export type InlineQueryResultLocation = {
+	/**
+	 * Type of the result, must be location
+	 */
+	type: "location";
+
+	/**
+	 * Unique identifier for this result, 1-64 Bytes
+	 */
+	id: string;
+
+	/**
+	 * Location latitude in degrees
+	 */
+	latitude: number;
+
+	/**
+	 * Location longitude in degrees
+	 */
+	longitude: number;
+
+	/**
+	 * Location title
+	 */
+	title: string;
+
+	/**
+	 * Optional. The radius of uncertainty for the location, measured in meters; 0-1500
+	 */
+	horizontal_accuracy?: number;
+
+	/**
+	 * Optional. Period in seconds during which the location can be updated, should be between 60 and 86400, or 0x7FFFFFFF
+	 * for live locations that can be edited indefinitely.
+	 */
+	live_period?: number;
+
+	/**
+	 * Optional. For live locations, a direction in which the user is moving, in degrees. Must be between 1 and 360 if
+	 * specified.
+	 */
+	heading?: number;
+
+	/**
+	 * Optional. For live locations, a maximum distance for proximity alerts about approaching another chat member, in
+	 * meters. Must be between 1 and 100000 if specified.
+	 */
+	proximity_alert_radius?: number;
+
+	/**
+	 * ptional. Inline keyboard attached to the message
+	 */
+	reply_markup?: InlineKeyboardMarkup;
+
+	/**
+	 * Optional. Content of the message to be sent instead of the location
+	 */
+	input_message_content?: InputMessageContent;
+
+	/**
+	 * Optional. Url of the thumbnail for the result
+	 */
+	thumbnail_url?: string;
+
+	/**
+	 * Optional. Thumbnail width
+	 */
+	thumbnail_width?: number;
+
+	/**
+	 * Optional. Thumbnail height
+	 */
+	thumbnail_height?: number;
+};

package/@types/InlineQueryResultMpeg4Gif.ts

@@ -0,0 +1,91 @@
+import type {
+	InlineKeyboardMarkup,
+	InputMessageContent,
+	MessageEntity,
+	ParseMode,
+} from "./";
+
+/**
+ * ## InlineQueryResultMpeg4Gif
+ * Represents a link to a video animation (H.264/MPEG-4 AVC video without sound). By default, this animated MPEG-4 file
+ * will be sent by the user with optional caption. Alternatively, you can use input_message_content to send a message
+ * with the specified content instead of the animation.
+ * @see https://core.telegram.org/bots/api#inlinequeryresultmpeg4gif
+ */
+export type InlineQueryResultMpeg4Gif = {
+	/**
+	 * Type of the result, must be mpeg4_gif
+	 */
+	type: "mpeg4_gif";
+
+	/**
+	 * Unique identifier for this result, 1-64 bytes
+	 */
+	id: string;
+
+	/**
+	 * A valid URL for the MPEG4 file. File size must not exceed 1MB
+	 */
+	mpeg4_url: string;
+
+	/**
+	 * Optional. Video width
+	 */
+	mpeg4_width?: number;
+
+	/**
+	 * Optional. Video height
+	 */
+	mpeg4_height?: number;
+
+	/**
+	 * Optional. Video duration in seconds
+	 */
+	mpeg4_duration?: number;
+
+	/**
+	 * URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result
+	 */
+	thumbnail_url: string;
+
+	/**
+	 * 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";
+
+	/**
+	 * Optional. Title for the result
+	 */
+	title?: string;
+
+	/**
+	 * Optional. Caption of the MPEG-4 file to be sent, 0-1024 characters after entities parsing
+	 */
+	caption?: string;
+
+	/**
+	 * Optional. Mode for parsing entities in the 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. Inline keyboard attached to the message
+	 */
+	reply_markup?: InlineKeyboardMarkup;
+
+	/**
+	 * Optional. Content of the message to be sent instead of the video animation
+	 */
+	input_message_content?: InputMessageContent;
+};

package/@types/InlineQueryResultPhoto.ts

@@ -0,0 +1,84 @@
+import type {
+	InlineKeyboardMarkup,
+	InputMessageContent,
+	MessageEntity,
+	ParseMode,
+} from "./";
+
+/**
+ * ## InlineQueryResultPhoto
+ * Represents a link to a photo. By default, this photo will be sent by the user with optional caption. Alternatively,
+ * you can use input_message_content to send a message with the specified content instead of the photo.
+ * @see https://core.telegram.org/bots/api#inlinequeryresultphoto
+ */
+export type InlineQueryResultPhoto = {
+	/**
+	 * Type of the result, must be photo
+	 */
+	type: "photo";
+
+	/**
+	 * Unique identifier for this result, 1-64 bytes
+	 */
+	id: string;
+
+	/**
+	 * A valid URL of the photo. Photo must be in JPEG format. Photo size must not exceed 5MB
+	 */
+	photo_url: string;
+
+	/**
+	 * URL of the thumbnail for the photo
+	 */
+	thumbnail_url: string;
+
+	/**
+	 * Optional. Width of the photo
+	 */
+	photo_width?: number;
+
+	/**
+	 * Optional. Height of the photo
+	 */
+	photo_height?: number;
+
+	/**
+	 * Optional. Title for the result
+	 */
+	title?: string;
+
+	/**
+	 * Optional. Short description of the result
+	 */
+	description?: string;
+
+	/**
+	 * Optional. Caption of the photo to be sent, 0-1024 characters after entities parsing
+	 */
+	caption?: string;
+
+	/**
+	 * Optional. Mode for parsing entities in the 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. Inline keyboard attached to the message
+	 */
+	reply_markup?: InlineKeyboardMarkup;
+
+	/**
+	 * Optional. Content of the message to be sent instead of the photo
+	 */
+	input_message_content?: InputMessageContent;
+};

package/@types/InlineQueryResultVenue.ts

@@ -0,0 +1,80 @@
+import type { InlineKeyboardMarkup, InputMessageContent } from "./";
+
+/**
+ * ## InlineQueryResultVenue
+ * Represents a venue. By default, the venue will be sent by the user. Alternatively, you can use input_message_content
+ * to send a message with the specified content instead of the venue.
+ * @see https://core.telegram.org/bots/api#inlinequeryresultvenue
+ */
+export type InlineQueryResultVenue = {
+	/**
+	 * Type of the result, must be venue
+	 */
+	type: "venue";
+
+	/**
+	 * Unique identifier for this result, 1-64 Bytes
+	 */
+	id: string;
+
+	/**
+	 * Latitude of the venue location in degrees
+	 */
+	latitude: number;
+
+	/**
+	 * Longitude of the venue location in degrees
+	 */
+	longitude: number;
+
+	/**
+	 * Title 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 type of the venue. (See supported types.)
+	 */
+	google_place_type?: string;
+
+	/**
+	 * Optional. Inline keyboard attached to the message
+	 */
+	reply_markup?: InlineKeyboardMarkup;
+
+	/**
+	 * Optional. Content of the message to be sent instead of the venue
+	 */
+	input_message_content?: InputMessageContent;
+
+	/**
+	 * Optional. Url of the thumbnail for the result
+	 */
+	thumbnail_url?: string;
+
+	/**
+	 * Optional. Thumbnail width
+	 */
+	thumbnail_width?: number;
+
+	/**
+	 * Optional. Thumbnail height
+	 */
+	thumbnail_height?: number;
+};

package/@types/InlineQueryResultVideo.ts

@@ -0,0 +1,98 @@
+import type {
+	InlineKeyboardMarkup,
+	InputMessageContent,
+	MessageEntity,
+	ParseMode,
+} from "./";
+
+/**
+ * ## InlineQueryResultVideo
+ * Represents a link to a page containing an embedded video player or a video file. By default, this video file will be
+ * sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with
+ * the specified content instead of the video.
+ * > If an InlineQueryResultVideo message contains an embedded video (e.g., YouTube), you must replace its content using
+ * > input_message_content.
+ * @see https://core.telegram.org/bots/api#inlinequeryresultvideo
+ */
+export type InlineQueryResultVideo = {
+	/**
+	 * Type of the result, must be video
+	 */
+	type: "video";
+
+	/**
+	 * Unique identifier for this result, 1-64 bytes
+	 */
+	id: string;
+
+	/**
+	 * A valid URL for the embedded video player or video file
+	 */
+	video_url: string;
+
+	/**
+	 * MIME type of the content of the video URL, “text/html” or “video/mp4”
+	 */
+	mime_type: string;
+
+	/**
+	 * URL of the thumbnail (JPEG only) for the video
+	 */
+	thumbnail_url: string;
+
+	/**
+	 * Title for the result
+	 */
+	title: string;
+
+	/**
+	 * Optional. Caption of the video to be sent, 0-1024 characters after entities parsing
+	 */
+	caption?: string;
+
+	/**
+	 * Optional. Mode for parsing entities in the video 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. Video width
+	 */
+	video_width?: number;
+
+	/**
+	 * Optional. Video height
+	 */
+	video_height?: number;
+
+	/**
+	 * Optional. Video duration in seconds
+	 */
+	video_duration?: number;
+
+	/**
+	 * Optional. Short description of the result
+	 */
+	description?: string;
+
+	/**
+	 * Optional. Inline keyboard attached to the message
+	 */
+	reply_markup?: InlineKeyboardMarkup;
+
+	/**
+	 * Optional. Content of the message to be sent instead of the video. This field is required if InlineQueryResultVideo
+	 * is used to send an HTML-page as a result (e.g., a YouTube video).
+	 */
+	input_message_content?: InputMessageContent;
+};

package/@types/InlineQueryResultVoice.ts

@@ -0,0 +1,65 @@
+import type {
+	InlineKeyboardMarkup,
+	InputMessageContent,
+	MessageEntity,
+	ParseMode,
+} from "./";
+
+/**
+ * ## InlineQueryResultVoice
+ * Represents a link to a voice recording in an .OGG container encoded with OPUS. By default, this voice recording will
+ * be sent by the user. Alternatively, you can use input_message_content to send a message with the specified content
+ * instead of the the voice message.
+ * @see https://core.telegram.org/bots/api#inlinequeryresultvoice
+ */
+export type InlineQueryResultVoice = {
+	/**
+	 * Type of the result, must be voice
+	 */
+	type: "voice";
+
+	/**
+	 * Unique identifier for this result, 1-64 bytes
+	 */
+	id: string;
+
+	/**
+	 * A valid URL for the voice recording
+	 */
+	voice_url: string;
+
+	/**
+	 * Recording title
+	 */
+	title: string;
+
+	/**
+	 * Optional. Caption, 0-1024 characters after entities parsing
+	 */
+	caption?: string;
+
+	/**
+	 * Optional. Mode for parsing entities in the voice message 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. Recording duration in seconds
+	 */
+	voice_duration?: number;
+
+	/**
+	 * Optional. Inline keyboard attached to the message
+	 */
+	reply_markup?: InlineKeyboardMarkup;
+
+	/**
+	 * Optional. Content of the message to be sent instead of the voice recording
+	 */
+	input_message_content?: InputMessageContent;
+};

package/@types/InlineQueryResultsButton.ts

@@ -0,0 +1,34 @@
+import type { AtMostOne } from "../utils";
+import type { WebAppInfo } from "./";
+
+/**
+ * ## InlineQueryResultsButton
+ * This object represents a button to be shown above inline query results. You must use exactly one of the optional
+ * fields.
+ * @see https://core.telegram.org/bots/api#inlinequeryresultsbutton
+ */
+export type InlineQueryResultsButton = {
+	/**
+	 * Label text on the button
+	 */
+	text: string;
+} & AtMostOne<{
+	/**
+	 * Optional. Description of the Web App that will be launched when the user presses the button. The Web App will be
+	 * able to switch back to the inline mode using the method switchInlineQuery inside the Web App.
+	 */
+	web_app: WebAppInfo;
+
+	/**
+	 * Optional. Deep-linking parameter for the /start message sent to the bot when a user presses the button.
+	 * 1-64 characters, only A-Z, a-z, 0-9, _ and - are allowed.
+	 *
+	 * Example: An inline bot that sends YouTube videos can ask the user to connect the bot to their YouTube account to
+	 * adapt search results accordingly. To do this, it displays a 'Connect your YouTube account' button above the
+	 * results, or even before showing any. The user presses the button, switches to a private chat with the bot and,
+	 * in doing so, passes a start parameter that instructs the bot to return an OAuth link. Once done, the bot can offer
+	 * a switch_inline button so that the user can easily return to the chat where they wanted to use the bot's inline
+	 * capabilities.
+	 */
+	start_parameter: string;
+}>;

package/@types/InputChecklist.ts

@@ -0,0 +1,39 @@
+import type { InputChecklistTask, MessageEntity, ParseMode } from "./";
+
+/**
+ * ## InputChecklist
+ * Describes a checklist to create.
+ * @see https://core.telegram.org/bots/api#inputchecklist
+ */
+export type InputChecklist = {
+	/**
+	 * Title of the checklist; 1-255 characters after entities parsing
+	 */
+	title: string;
+
+	/**
+	 * Optional. Mode for parsing entities in the title. See formatting options for more details.
+	 */
+	parse_mode?: ParseMode;
+
+	/**
+	 * Optional. List of special entities that appear in the title, which can be specified instead of parse_mode.
+	 * Currently, only bold, italic, underline, strikethrough, spoiler, and custom_emoji entities are allowed.
+	 */
+	title_entities?: MessageEntity[];
+
+	/**
+	 * List of 1-30 tasks in the checklist
+	 */
+	tasks: InputChecklistTask[];
+
+	/**
+	 * Optional. Pass True if other users can add tasks to the checklist
+	 */
+	others_can_add_tasks?: boolean;
+
+	/**
+	 * Optional. Pass True if other users can mark tasks as done or not done in the checklist
+	 */
+	others_can_mark_tasks_as_done?: boolean;
+};

package/@types/InputChecklistTask.ts

@@ -0,0 +1,30 @@
+import type { MessageEntity, ParseMode } from "./";
+
+/**
+ * ## InputChecklistTask
+ * Describes a task to add to a checklist.
+ * @see https://core.telegram.org/bots/api#inputchecklisttask
+ */
+export type InputChecklistTask = {
+	/**
+	 * Unique identifier of the task; must be positive and unique among all task identifiers currently present in the
+	 * checklist
+	 */
+	id: number;
+
+	/**
+	 * Text of the task; 1-100 characters after entities parsing
+	 */
+	text: string;
+
+	/**
+	 * Optional. Mode for parsing entities in the text. See formatting options for more details.
+	 */
+	parse_mode?: ParseMode;
+
+	/**
+	 * Optional. List of special entities that appear in the text, which can be specified instead of parse_mode.
+	 * Currently, only bold, italic, underline, strikethrough, spoiler, and custom_emoji entities are allowed.
+	 */
+	text_entities?: MessageEntity[];
+};