nyx-bot-client 0.0.2

package/@types/InputContactMessageContent.ts

@@ -0,0 +1,27 @@
+/**
+ * ## InputContactMessageContent
+ * Represents the content of a contact message to be sent as the result of an inline query.
+ * @see https://core.telegram.org/bots/api#inputcontactmessagecontent
+ */
+export type InputContactMessageContent = {
+	/**
+	 * Contact's phone number
+	 */
+	phone_number: string;
+
+	/**
+	 * Contact's first name
+	 */
+	first_name: string;
+
+	/**
+	 * Optional. Contact's last name
+	 */
+	last_name?: string;
+
+	/**
+	 * Optional. Additional data about the contact in the form of a [vCard](https://en.wikipedia.org/wiki/VCard),
+	 * 0-2048 bytes
+	 */
+	vcard?: string;
+};

package/@types/InputFile.ts

@@ -0,0 +1,10 @@
+import type { ReadStream } from "node:fs";
+
+/**
+ * ##
+ * InputFile
+ * This object represents the contents of a file to be uploaded. Must be posted using multipart/form-data in the usual
+ * way that files are uploaded via the browser.
+ * @see https://core.telegram.org/bots/api#inputfile
+ */
+export type InputFile = ReadStream | Buffer | File;

package/@types/InputInvoiceMessageContent.ts

@@ -0,0 +1,120 @@
+import type { Currencies, LabeledPrice } from "./";
+
+/**
+ * ## InputInvoiceMessageContent
+ * Represents the content of an invoice message to be sent as the result of an inline query.
+ * @see https://core.telegram.org/bots/api#inputinvoicemessagecontent
+ */
+export type InputInvoiceMessageContent = {
+	/**
+	 * Product name, 1-32 characters
+	 */
+	title: string;
+
+	/**
+	 * Product description, 1-255 characters
+	 */
+	description: string;
+
+	/**
+	 * Bot-defined invoice payload, 1-128 bytes. This will not be displayed to the user, use it for your internal
+	 * processes.
+	 */
+	payload: string;
+
+	/**
+	 * Optional. Payment provider token, obtained via @BotFather. Pass an empty string for payments in Telegram Stars.
+	 */
+	provider_token: string;
+
+	/**
+	 * Three-letter ISO 4217 currency code, see more on currencies. Pass “XTR” for payments in Telegram Stars.
+	 */
+	currency: Currencies | "XTR";
+
+	/**
+	 * Price breakdown, a JSON-serialized list of components (e.g. product price, tax, discount, delivery cost, delivery
+	 * tax, bonus, etc.). Must contain exactly one item for payments in Telegram Stars.
+	 */
+	prices: LabeledPrice[]; //TODO: JSON
+	/**
+	 * Optional. The maximum accepted amount for tips in the smallest units of the currency (integer, not float/double).
+	 * For example, for a maximum tip of US$ 1.45 pass max_tip_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).
+	 * Defaults to 0. Not supported for payments in [Telegram Stars](https://t.me/BotNews/90).
+	 */
+	max_tip_amount?: number;
+
+	/**
+	 * Optional. A JSON-serialized array of suggested amounts of tip in the smallest units of the currency (integer, not
+	 * float/double). At most 4 suggested tip amounts can be specified. The suggested tip amounts must be positive, passed
+	 * in a strictly increased order and must not exceed max_tip_amount.
+	 */
+	suggested_tip_amounts?: number[]; //TODO: JSON
+	/**
+	 * Optional. A JSON-serialized object for data about the invoice, which will be shared with the payment provider.
+	 * A detailed description of the required fields should be provided by the payment provider.
+	 */
+	provider_data?: string; //TODO: JSON
+	/**
+	 * Optional. URL of the product photo for the invoice. Can be a photo of the goods or a marketing image for a service.
+	 */
+	photo_url?: string;
+
+	/**
+	 * Optional. Photo size in bytes
+	 */
+	photo_size?: number;
+
+	/**
+	 * Optional. Photo width
+	 */
+	photo_width?: number;
+
+	/**
+	 * Optional. Photo height
+	 */
+	photo_height?: number;
+
+	/**
+	 * Optional. Pass True if you require the user's full name to complete the order. Ignored for payments in
+	 * [Telegram Stars](https://t.me/BotNews/90).
+	 */
+	need_name?: boolean;
+
+	/**
+	 * Optional. Pass True if you require the user's phone number to complete the order. Ignored for payments in
+	 * [Telegram Stars](https://t.me/BotNews/90).
+	 */
+	need_phone_number?: boolean;
+
+	/**
+	 * Optional. Pass True if you require the user's email address to complete the order. Ignored for payments in
+	 * [Telegram Stars](https://t.me/BotNews/90).
+	 */
+	need_email?: boolean;
+
+	/**
+	 * Optional. Pass True if you require the user's shipping address to complete the order. Ignored for payments in
+	 * [Telegram Stars](https://t.me/BotNews/90).
+	 */
+	need_shipping_address?: boolean;
+
+	/**
+	 * Optional. Pass True if the user's phone number should be sent to the provider. Ignored for payments in
+	 * [Telegram Stars](https://t.me/BotNews/90).
+	 */
+	send_phone_number_to_provider?: boolean;
+
+	/**
+	 * Optional. Pass True if the user's email address should be sent to the provider. Ignored for payments in
+	 * [Telegram Stars](https://t.me/BotNews/90).
+	 */
+	send_email_to_provider?: boolean;
+
+	/**
+	 * Optional. Pass True if the final price depends on the shipping method. Ignored for payments in
+	 * [Telegram Stars](https://t.me/BotNews/90).
+	 */
+	is_flexible?: boolean;
+};

package/@types/InputLocationMessageContent.ts

@@ -0,0 +1,39 @@
+/**
+ * ## InputLocationMessageContent
+ * Represents the content of a location message to be sent as the result of an inline query.
+ * @see https://core.telegram.org/bots/api#inputlocationmessagecontent
+ */
+export type InputLocationMessageContent = {
+	/**
+	 * Latitude of the location in degrees
+	 */
+	latitude: number;
+
+	/**
+	 * Longitude of the location in degrees
+	 */
+	longitude: number;
+
+	/**
+	 * 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;
+};

package/@types/InputMedia.ts

@@ -0,0 +1,24 @@
+import type {
+	InputMediaAnimation,
+	InputMediaAudio,
+	InputMediaDocument,
+	InputMediaPhoto,
+	InputMediaVideo,
+} from "./";
+
+/**
+ * ## InputMedia
+ * This object represents the content of a media message to be sent. It should be one of
+ * - InputMediaAnimation
+ * - InputMediaDocument
+ * - InputMediaAudio
+ * - InputMediaPhoto
+ * - InputMediaVideo
+ * @see https://core.telegram.org/bots/api#inputmedia
+ */
+export type InputMedia =
+	| InputMediaAnimation
+	| InputMediaDocument
+	| InputMediaAudio
+	| InputMediaPhoto
+	| InputMediaVideo;

package/@types/InputMediaAnimation.ts

@@ -0,0 +1,68 @@
+import type { Attachment, InputFile, MessageEntity, ParseMode } from "./";
+
+/**
+ * ## InputMediaAnimation
+ * Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent.
+ * @see https://core.telegram.org/bots/api#inputmediaanimation
+ */
+export type InputMediaAnimation = {
+	/**
+	 * Type of the result, must be animation
+	 */
+	type: "animation";
+
+	/**
+	 * 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. [More information on Sending Files](https://core.telegram.org/bots/api#sending-files)
+	 */
+	media: string | Attachment;
+	/**
+	 * 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. Ignored if the file is not uploaded using multipart/form-data. 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>. [More information on Sending Files](https://core.telegram.org/bots/api#sending-files)
+	 */
+	thumbnail?: InputFile | string;
+
+	/**
+	 * Optional. Caption of the animation to be sent, 0-1024 characters after entities parsing
+	 */
+	caption?: string;
+
+	/**
+	 * Optional. Mode for parsing entities in the animation 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. Animation width
+	 */
+	width?: number;
+
+	/**
+	 * Optional. Animation height
+	 */
+	height?: number;
+
+	/**
+	 * Optional. Animation duration in seconds
+	 */
+	duration?: number;
+
+	/**
+	 * Optional. Pass True if the animation needs to be covered with a spoiler animation
+	 */
+	has_spoiler?: boolean;
+};

package/@types/InputMediaAudio.ts

@@ -0,0 +1,58 @@
+import type { Attachment, InputFile, MessageEntity, ParseMode } from "./";
+
+/**
+ * ## InputMediaAudio
+ * Represents an audio file to be treated as music to be sent.
+ * @see https://core.telegram.org/bots/api#inputmediaaudio
+ */
+export type InputMediaAudio = {
+	/**
+	 * Type of the result, must be audio
+	 */
+	type: "audio";
+
+	/**
+	 * 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. [More information on Sending Files](https://core.telegram.org/bots/api#sending-files)
+	 */
+	media: string | Attachment;
+	/**
+	 * 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. Ignored if the file is not uploaded using multipart/form-data. 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>. [More information on Sending Files](https://core.telegram.org/bots/api#sending-files)
+	 */
+	thumbnail?: InputFile | string;
+
+	/**
+	 * Optional. Caption of the audio to be sent, 0-1024 characters after entities parsing
+	 */
+	caption?: string;
+
+	/**
+	 * Optional. Mode for parsing entities in the audio 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. Duration of the audio in seconds
+	 */
+	duration?: number;
+
+	/**
+	 * Optional. Performer of the audio
+	 */
+	performer?: string;
+
+	/**
+	 * Optional. Title of the audio
+	 */
+	title?: string;
+};

package/@types/InputMediaDocument.ts

@@ -0,0 +1,49 @@
+import type { Attachment, InputFile, MessageEntity, ParseMode } from "./";
+
+/**
+ * ## InputMediaDocument
+ * Represents a general file to be sent.
+ * @see https://core.telegram.org/bots/api#inputmediadocument
+ */
+export type InputMediaDocument = {
+	/**
+	 * Type of the result, must be document
+	 */
+	type: "document";
+
+	/**
+	 * 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. [More information on Sending Files](https://core.telegram.org/bots/api#sending-files)
+	 */
+	media: string | Attachment;
+	/**
+	 * 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. Ignored if the file is not uploaded using multipart/form-data. 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>. [More information on Sending Files](https://core.telegram.org/bots/api#sending-files)
+	 */
+	thumbnail?: InputFile | string;
+
+	/**
+	 * Optional. Caption of the document to be sent, 0-1024 characters after entities parsing
+	 */
+	caption?: string;
+
+	/**
+	 * Optional. Mode for parsing entities in the document 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. Disables automatic server-side content type detection for files uploaded using multipart/form-data.
+	 * Always True, if the document is sent as part of an album.
+	 */
+	disable_content_type_detection?: boolean;
+};

package/@types/InputMediaPhoto.ts

@@ -0,0 +1,45 @@
+import type { Attachment, MessageEntity, ParseMode } from "./";
+
+/**
+ * ## InputMediaPhoto
+ * Represents a photo to be sent.
+ * @see https://core.telegram.org/bots/api#inputmediaphoto
+ */
+export type InputMediaPhoto = {
+	/**
+	 * Type of the result, 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. [More information on Sending Files](https://core.telegram.org/bots/api#sending-files)
+	 */
+	media: string | Attachment;
+
+	/**
+	 * 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. Pass True if the photo needs to be covered with a spoiler animation
+	 */
+	has_spoiler?: boolean;
+};

package/@types/InputMediaVideo.ts

@@ -0,0 +1,85 @@
+import type { Attachment, InputFile, MessageEntity, ParseMode } from "./";
+
+/**
+ * ## InputMediaVideo
+ * Represents a video to be sent.
+ * @see https://core.telegram.org/bots/api#inputmediavideo
+ */
+export type InputMediaVideo = {
+	/**
+	 * Type of the result, 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. [More information on Sending Files](https://core.telegram.org/bots/api#sending-files)
+	 */
+	media: string | Attachment;
+	/**
+	 * 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. Ignored if the file is not uploaded using multipart/form-data. 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>. [More information on Sending Files](https://core.telegram.org/bots/api#sending-files)
+	 */
+	thumbnail?: InputFile | string;
+
+	/**
+	 * Optional. Cover for the video in the message. 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. [More information on Sending Files](https://core.telegram.org/bots/api#sending-files)
+	 */
+	cover?: InputFile | string;
+
+	/**
+	 * Optional. Start timestamp for the video in the message
+	 */
+	start_timestamp?: number;
+
+	/**
+	 * 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
+	 */
+	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;
+
+	/**
+	 * Optional. Pass True if the video needs to be covered with a spoiler animation
+	 */
+	has_spoiler?: boolean;
+};

package/@types/InputMessageContent.ts

@@ -0,0 +1,25 @@
+import type {
+	InputContactMessageContent,
+	InputInvoiceMessageContent,
+	InputLocationMessageContent,
+	InputTextMessageContent,
+	InputVenueMessageContent,
+} from "./";
+
+/**
+ * ## InputMessageContent
+ * This object represents the content of a message to be sent as a result of an inline query. Telegram clients currently
+ * support the following 5 types:
+ * - InputTextMessageContent
+ * - InputLocationMessageContent
+ * - InputVenueMessageContent
+ * - InputContactMessageContent
+ * - InputInvoiceMessageContent
+ * @see https://core.telegram.org/bots/api#inputmessagecontent
+ */
+export type InputMessageContent =
+	| InputTextMessageContent
+	| InputLocationMessageContent
+	| InputVenueMessageContent
+	| InputContactMessageContent
+	| InputInvoiceMessageContent;

package/@types/InputPaidMedia.ts

@@ -0,0 +1,11 @@
+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
+ * - InputPaidMediaPhoto
+ * - InputPaidMediaVideo
+ * @see https://core.telegram.org/bots/api#inputpaidmedia
+ */
+export type InputPaidMedia = InputPaidMediaPhoto | InputPaidMediaVideo;

package/@types/InputPaidMediaPhoto.ts

@@ -0,0 +1,21 @@
+import type { Attachment } from "./index";
+
+/**
+ * InputPaidMediaPhoto
+ * The paid media to send is a photo.
+ * @see https://core.telegram.org/bots/api#inputpaidmediaphoto
+ */
+export type InputPaidMediaPhoto = {
+	/**
+	 * Type of the media, 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.
+	 * @see https://core.telegram.org/bots/api#sending-files
+	 */
+	media: string | Attachment;
+};

package/@types/InputPaidMediaVideo.ts

@@ -0,0 +1,64 @@
+import type { InputFile } from "./InputFile";
+import type { Attachment } from "./index";
+
+/**
+ * InputPaidMediaVideo
+ * The paid media to send is a video.
+ * @see https://core.telegram.org/bots/api#inputpaidmediavideo
+ */
+export type InputPaidMediaVideo = {
+	/**
+	 * Type of the media, 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.
+	 * @see https://core.telegram.org/bots/api#sending-files
+	 */
+	media: string | Attachment;
+
+	/**
+	 * 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. Ignored if the file is not uploaded using multipart/form-data. 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>.
+	 * @see https://core.telegram.org/bots/api#sending-files
+	 */
+	thumbnail?: InputFile | string;
+
+	/**
+	 * Optional. Cover for the video in the message. 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. [More information on Sending Files](https://core.telegram.org/bots/api#sending-files)
+	 */
+	cover?: InputFile | string;
+
+	/**
+	 * Optional. Start timestamp for the video in the message
+	 */
+	start_timestamp?: number;
+
+	/**
+	 * 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/InputPollOption.ts

@@ -0,0 +1,25 @@
+import type { MessageEntity, ParseMode } from "./";
+
+/**
+ * ## InputPollOption
+ * This object contains information about one answer option in a poll to be sent.
+ * @see https://core.telegram.org/bots/api#inputpolloption
+ */
+export type InputPollOption = {
+	/**
+	 * Option text, 1-100 characters
+	 */
+	text: string;
+
+	/**
+	 * Optional. Mode for parsing entities in the text. See formatting options for more details. Currently, only custom
+	 * emoji entities are allowed
+	 */
+	text_parse_mode?: ParseMode;
+
+	/**
+	 * Optional. A JSON-serialized list of special entities that appear in the poll option text. It can be specified
+	 * instead of text_parse_mode
+	 */
+	text_entities?: MessageEntity[];
+};