nyx-bot-client 0.0.2

package/@types/PassportElementError.ts

@@ -0,0 +1,37 @@
+import type {
+	PassportElementErrorDataField,
+	PassportElementErrorFile,
+	PassportElementErrorFiles,
+	PassportElementErrorFrontSide,
+	PassportElementErrorReverseSide,
+	PassportElementErrorSelfie,
+	PassportElementErrorTranslationFile,
+	PassportElementErrorTranslationFiles,
+	PassportElementErrorUnspecified,
+} from "./";
+
+/**
+ * ## PassportElementError
+ * This object represents an error in the Telegram Passport element which was submitted that should be resolved by the
+ * user. It should be one of:
+ * - PassportElementErrorDataField
+ * - PassportElementErrorFrontSide
+ * - PassportElementErrorReverseSide
+ * - PassportElementErrorSelfie
+ * - PassportElementErrorFile
+ * - PassportElementErrorFiles
+ * - PassportElementErrorTranslationFile
+ * - PassportElementErrorTranslationFiles
+ * - PassportElementErrorUnspecified
+ * @see https://core.telegram.org/bots/api#passportelementerror
+ */
+export type PassportElementError =
+	| PassportElementErrorDataField
+	| PassportElementErrorFrontSide
+	| PassportElementErrorReverseSide
+	| PassportElementErrorSelfie
+	| PassportElementErrorFile
+	| PassportElementErrorFiles
+	| PassportElementErrorTranslationFile
+	| PassportElementErrorTranslationFiles
+	| PassportElementErrorUnspecified;

package/@types/PassportElementErrorDataField.ts

@@ -0,0 +1,39 @@
+/**
+ * ## PassportElementErrorDataField
+ * Represents an issue in one of the data fields that was provided by the user. The error is considered resolved when
+ * the field's value changes.
+ * @see https://core.telegram.org/bots/api#passportelementerrordatafield
+ */
+export type PassportElementErrorDataField = {
+	/**
+	 * Error source, must be data
+	 */
+	source: "data";
+
+	/**
+	 * The section of the user's Telegram Passport which has the error, one of “personal_details”, “passport”,
+	 * “driver_license”, “identity_card”, “internal_passport”, “address”
+	 */
+	type:
+		| "personal_details"
+		| "passport"
+		| "driver_license"
+		| "identity_card"
+		| "internal_passport"
+		| "address";
+
+	/**
+	 * Name of the data field which has the error
+	 */
+	field_name: string;
+
+	/**
+	 * Base64-encoded data hash
+	 */
+	data_hash: string;
+
+	/**
+	 * Error message
+	 */
+	message: string;
+};

package/@types/PassportElementErrorFile.ts

@@ -0,0 +1,33 @@
+/**
+ * ## PassportElementErrorFile
+ * Represents an issue with a document scan. The error is considered resolved when the file with the document scan
+ * changes.
+ * @see https://core.telegram.org/bots/api#passportelementerrorfile
+ */
+export type PassportElementErrorFile = {
+	/**
+	 * Error source, must be file
+	 */
+	source: "file";
+
+	/**
+	 * The section of the user's Telegram Passport which has the issue, one of “utility_bill”, “bank_statement”,
+	 * “rental_agreement”, “passport_registration”, “temporary_registration”
+	 */
+	type:
+		| "utility_bill"
+		| "bank_statement"
+		| "rental_agreement"
+		| "passport_registration"
+		| "temporary_registration";
+
+	/**
+	 * Base64-encoded file hash
+	 */
+	file_hash: string;
+
+	/**
+	 * Error message
+	 */
+	message: string;
+};

package/@types/PassportElementErrorFiles.ts

@@ -0,0 +1,33 @@
+/**
+ * ## PassportElementErrorFiles
+ * Represents an issue with a list of scans. The error is considered resolved when the list of files containing the
+ * scans changes.
+ * @see https://core.telegram.org/bots/api#passportelementerrorfiles
+ */
+export type PassportElementErrorFiles = {
+	/**
+	 * Error source, must be files
+	 */
+	source: "files";
+
+	/**
+	 * The section of the user's Telegram Passport which has the issue, one of “utility_bill”, “bank_statement”,
+	 * “rental_agreement”, “passport_registration”, “temporary_registration”
+	 */
+	type:
+		| "utility_bill"
+		| "bank_statement"
+		| "rental_agreement"
+		| "passport_registration"
+		| "temporary_registration";
+
+	/**
+	 * List of base64-encoded file hashes
+	 */
+	file_hashes: string[];
+
+	/**
+	 * Error message
+	 */
+	message: string;
+};

package/@types/PassportElementErrorFrontSide.ts

@@ -0,0 +1,28 @@
+/**
+ * ## PassportElementErrorFrontSide
+ * Represents an issue with the front side of a document. The error is considered resolved when the file with the front
+ * side of the document changes.
+ * @see https://core.telegram.org/bots/api#passportelementerrorfrontside
+ */
+export type PassportElementErrorFrontSide = {
+	/**
+	 * Error source, must be front_side
+	 */
+	source: "front_side";
+
+	/**
+	 * The section of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”,
+	 * “identity_card”, “internal_passport”
+	 */
+	type: "passport" | "driver_license" | "identity_card" | "internal_passport";
+
+	/**
+	 * Base64-encoded hash of the file with the front side of the document
+	 */
+	file_hash: string;
+
+	/**
+	 * Error message
+	 */
+	message: string;
+};

package/@types/PassportElementErrorReverseSide.ts

@@ -0,0 +1,27 @@
+/**
+ * ## PassportElementErrorReverseSide
+ * Represents an issue with the reverse side of a document. The error is considered resolved when the file with reverse
+ * side of the document changes.
+ * @see https://core.telegram.org/bots/api#passportelementerrorreverseside
+ */
+export type PassportElementErrorReverseSide = {
+	/**
+	 * Error source, must be reverse_side
+	 */
+	source: "reverse_side";
+
+	/**
+	 * The section of the user's Telegram Passport which has the issue, one of “driver_license”, “identity_card”
+	 */
+	type: "driver_license" | "identity_card";
+
+	/**
+	 * Base64-encoded hash of the file with the reverse side of the document
+	 */
+	file_hash: string;
+
+	/**
+	 * Error message
+	 */
+	message: string;
+};

package/@types/PassportElementErrorSelfie.ts

@@ -0,0 +1,28 @@
+/**
+ * ## PassportElementErrorSelfie
+ * Represents an issue with the selfie with a document. The error is considered resolved when the file with the selfie
+ * changes.
+ * @see https://core.telegram.org/bots/api#passportelementerrorselfie
+ */
+export type PassportElementErrorSelfie = {
+	/**
+	 * Error source, must be selfie
+	 */
+	source: "selfie";
+
+	/**
+	 * The section of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”,
+	 * “identity_card”, “internal_passport”
+	 */
+	type: "passport" | "driver_license" | "identity_card" | "internal_passport";
+
+	/**
+	 * Base64-encoded hash of the file with the selfie
+	 */
+	file_hash: string;
+
+	/**
+	 * Error message
+	 */
+	message: string;
+};

package/@types/PassportElementErrorTranslationFile.ts

@@ -0,0 +1,38 @@
+/**
+ * ## PassportElementErrorTranslationFile
+ * Represents an issue with one of the files that constitute the translation of a document. The error is considered
+ * resolved when the file changes.
+ * @see https://core.telegram.org/bots/api#passportelementerrortranslationfile
+ */
+export type PassportElementErrorTranslationFile = {
+	/**
+	 * Error source, must be translation_file
+	 */
+	source: "translation_file";
+
+	/**
+	 * Type of element of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”,
+	 * “identity_card”, “internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”,
+	 * “passport_registration”, “temporary_registration”
+	 */
+	type:
+		| "passport"
+		| "driver_license"
+		| "identity_card"
+		| "internal_passport"
+		| "utility_bill"
+		| "bank_statement"
+		| "rental_agreement"
+		| "passport_registration"
+		| "temporary_registration";
+
+	/**
+	 * Base64-encoded file hash
+	 */
+	file_hash: string;
+
+	/**
+	 * Error message
+	 */
+	message: string;
+};

package/@types/PassportElementErrorTranslationFiles.ts

@@ -0,0 +1,38 @@
+/**
+ * ## PassportElementErrorTranslationFiles
+ * Represents an issue with the translated version of a document. The error is considered resolved when a file with the
+ * document translation change.
+ * @see https://core.telegram.org/bots/api#passportelementerrortranslationfiles
+ */
+export type PassportElementErrorTranslationFiles = {
+	/**
+	 * Error source, must be translation_files
+	 */
+	source: "translation_files";
+
+	/**
+	 * Type of element of the user's Telegram Passport which has the issue, one of “passport”, “driver_license”,
+	 * “identity_card”, “internal_passport”, “utility_bill”, “bank_statement”, “rental_agreement”,
+	 * “passport_registration”, “temporary_registration”
+	 */
+	type:
+		| "passport"
+		| "driver_license"
+		| "identity_card"
+		| "internal_passport"
+		| "utility_bill"
+		| "bank_statement"
+		| "rental_agreement"
+		| "passport_registration"
+		| "temporary_registration";
+
+	/**
+	 * List of base64-encoded file hashes
+	 */
+	file_hashes: string[];
+
+	/**
+	 * Error message
+	 */
+	message: string;
+};

package/@types/PassportElementErrorUnspecified.ts

@@ -0,0 +1,49 @@
+import type {
+	PassportElementErrorDataField,
+	PassportElementErrorFile,
+	PassportElementErrorFiles,
+	PassportElementErrorFrontSide,
+	PassportElementErrorReverseSide,
+	PassportElementErrorSelfie,
+	PassportElementErrorTranslationFile,
+	PassportElementErrorTranslationFiles,
+} from "./";
+
+/**
+ * ## PassportElementErrorUnspecified
+ * Represents an issue in an unspecified place. The error is considered resolved when new data is added.
+ * @see https://core.telegram.org/bots/api#passportelementerrorunspecified
+ */
+export type PassportElementErrorUnspecified = {
+	/**
+	 * Error source, must be unspecified
+	 */
+	source: "unspecified";
+
+	/**
+	 * Type of element of the user's Telegram Passport which has the issue
+	 */
+	type: Extract<
+		(
+			| PassportElementErrorDataField
+			| PassportElementErrorFrontSide
+			| PassportElementErrorReverseSide
+			| PassportElementErrorSelfie
+			| PassportElementErrorFile
+			| PassportElementErrorFiles
+			| PassportElementErrorTranslationFile
+			| PassportElementErrorTranslationFiles
+		)["type"],
+		string
+	>;
+
+	/**
+	 * Base64-encoded element hash
+	 */
+	element_hash: string;
+
+	/**
+	 * Error message
+	 */
+	message: string;
+};

package/@types/PassportFile.ts

@@ -0,0 +1,28 @@
+/**
+ * ## PassportFile
+ * This object represents a file uploaded to Telegram Passport. Currently all Telegram Passport files are in JPEG format
+ * when decrypted and don't exceed 10MB.
+ * @see https://core.telegram.org/bots/api#passportfile
+ */
+export type PassportFile = {
+	/**
+	 * Identifier for this file, which can be used to download or reuse the file
+	 */
+	file_id: string;
+
+	/**
+	 * Unique identifier for this 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;
+
+	/**
+	 * File size in bytes
+	 */
+	file_size: number;
+
+	/**
+	 * Unix time when the file was uploaded
+	 */
+	file_date: number;
+};

package/@types/PhotoSize.ts

@@ -0,0 +1,32 @@
+/**
+ * ## PhotoSize
+ * This object represents one size of a photo or a file / sticker thumbnail.
+ * @see https://core.telegram.org/bots/api#photosize
+ */
+export type PhotoSize = {
+	/**
+	 * Identifier for this file, which can be used to download or reuse the file
+	 */
+	file_id: string;
+
+	/**
+	 * Unique identifier for this 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;
+
+	/**
+	 * Photo width
+	 */
+	width: number;
+
+	/**
+	 * Photo height
+	 */
+	height: number;
+
+	/**
+	 * Optional. File size in bytes
+	 */
+	file_size?: number;
+};

package/@types/Poll.ts

@@ -0,0 +1,81 @@
+import type { MessageEntity, PollOption } from "./";
+
+/**
+ * ## Poll
+ * This object contains information about a poll.
+ * @see https://core.telegram.org/bots/api#poll
+ */
+export type Poll = {
+	/**
+	 * Unique poll identifier
+	 */
+	id: string;
+
+	/**
+	 * Poll question, 1-300 characters
+	 */
+	question: string;
+
+	/**
+	 * Optional. Special entities that appear in the question. Currently, only custom emoji entities are allowed in poll
+	 * questions
+	 */
+	question_entities?: MessageEntity[];
+
+	/**
+	 * List of poll options
+	 */
+	options: PollOption[];
+
+	/**
+	 * Total number of users that voted in the poll
+	 */
+	total_voter_count: number;
+
+	/**
+	 * True, if the poll is closed
+	 */
+	is_closed: boolean;
+
+	/**
+	 * True, if the poll is anonymous
+	 */
+	is_anonymous: boolean;
+
+	/**
+	 * Poll type, currently can be “regular” or “quiz”
+	 */
+	type: "regular" | "quiz";
+
+	/**
+	 * True, if the poll allows multiple answers
+	 */
+	allows_multiple_answers: boolean;
+
+	/**
+	 * Optional. 0-based identifier of the correct answer option. Available only for polls in the quiz mode, which are
+	 * closed, or was sent (not forwarded) by the bot or to the private chat with the bot.
+	 */
+	correct_option_id?: number;
+
+	/**
+	 * Optional. Text that is shown when a user chooses an incorrect answer or taps on the lamp icon in a quiz-style poll,
+	 * 0-200 characters
+	 */
+	explanation?: string;
+
+	/**
+	 * Optional. Special entities like usernames, URLs, bot commands, etc. that appear in the explanation
+	 */
+	explanation_entities?: MessageEntity[];
+
+	/**
+	 * Optional. Amount of time in seconds the poll will be active after creation
+	 */
+	open_period?: number;
+
+	/**
+	 * Optional. Point in time (Unix timestamp) when the poll will be automatically closed
+	 */
+	close_date?: number;
+};

package/@types/PollAnswer.ts

@@ -0,0 +1,28 @@
+import type { Chat, User } from "./";
+
+/**
+ * ## PollAnswer
+ * This object represents an answer of a user in a non-anonymous poll.
+ * @see https://core.telegram.org/bots/api#pollanswer
+ */
+export type PollAnswer = {
+	/**
+	 * Unique poll identifier
+	 */
+	poll_id: string;
+
+	/**
+	 * Optional. The chat that changed the answer to the poll, if the voter is anonymous
+	 */
+	voter_chat: Chat;
+
+	/**
+	 * Optional. The user that changed the answer to the poll, if the voter isn't anonymous
+	 */
+	user: User;
+
+	/**
+	 * 0-based identifiers of chosen answer options. May be empty if the vote was retracted.
+	 */
+	option_ids: number[];
+};

package/@types/PollOption.ts

@@ -0,0 +1,24 @@
+import type { MessageEntity } from "./MessageEntity";
+
+/**
+ * ## PollOption
+ * This object contains information about one answer option in a poll.
+ * @see https://core.telegram.org/bots/api#polloption
+ */
+export type PollOption = {
+	/**
+	 * Option text, 1-100 characters
+	 */
+	text: string;
+
+	/**
+	 * Optional. Special entities that appear in the option text. Currently, only custom emoji entities are allowed in
+	 * poll option texts
+	 */
+	text_entities?: MessageEntity[];
+
+	/**
+	 * Number of users that voted for this option
+	 */
+	voter_count: number;
+};

package/@types/PreCheckoutQuery.ts

@@ -0,0 +1,45 @@
+import type { Currencies, OrderInfo, User } from "./";
+
+/**
+ * ## PreCheckoutQuery
+ * This object contains information about an incoming pre-checkout query.
+ * @see https://core.telegram.org/bots/api#precheckoutquery
+ */
+export type PreCheckoutQuery = {
+	/**
+	 * Unique query identifier
+	 */
+	id: string;
+
+	/**
+	 * User who sent the query
+	 */
+	from: User;
+
+	/**
+	 * 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;
+
+	/**
+	 * Bot-specified invoice payload
+	 */
+	invoice_payload: string;
+
+	/**
+	 * Optional. Identifier of the shipping option chosen by the user
+	 */
+	shipping_option_id?: string;
+
+	/**
+	 * Optional. Order information provided by the user
+	 */
+	order_info?: OrderInfo;
+};

package/@types/ProximityAlertTriggered.ts

@@ -0,0 +1,24 @@
+import type { User } from "./User";
+
+/**
+ * ## ProximityAlertTriggered
+ * This object represents the content of a service message, sent whenever a user in the chat triggers a proximity alert
+ * set by another user.
+ * @see https://core.telegram.org/bots/api#proximityalerttriggered
+ */
+export type ProximityAlertTriggered = {
+	/**
+	 * User that triggered the alert
+	 */
+	traveler: User;
+
+	/**
+	 * User that set the alert
+	 */
+	watcher: User;
+
+	/**
+	 * The distance between the users
+	 */
+	distance: number;
+};

package/@types/ReactionCount.ts

@@ -0,0 +1,18 @@
+import type { ReactionType } from "./ReactionType";
+
+/**
+ * ## ReactionCount
+ * Represents a reaction added to a message along with the number of times it was added.
+ * @see https://core.telegram.org/bots/api#reactioncount
+ */
+export type ReactionCount = {
+	/**
+	 * Type of the reaction
+	 */
+	type: ReactionType;
+
+	/**
+	 * Number of times the reaction was added
+	 */
+	total_count: number;
+};

package/@types/ReactionType.ts

@@ -0,0 +1,18 @@
+import type {
+	ReactionTypeCustomEmoji,
+	ReactionTypeEmoji,
+	ReactionTypePaid,
+} from "./";
+
+/**
+ * ## ReactionType
+ * This object describes the type of a reaction. Currently, it can be one of
+ * - ReactionTypeEmoji
+ * - ReactionTypeCustomEmoji
+ * - ReactionTypePaid
+ * @see https://core.telegram.org/bots/api#reactiontype
+ */
+export type ReactionType =
+	| ReactionTypeEmoji
+	| ReactionTypeCustomEmoji
+	| ReactionTypePaid;

package/@types/ReactionTypeCustomEmoji.ts

@@ -0,0 +1,16 @@
+/**
+ * ## ReactionTypeCustomEmoji
+ * The reaction is based on a custom emoji.
+ * #see https://core.telegram.org/bots/api#reactiontypecustomemoji
+ */
+export type ReactionTypeCustomEmoji = {
+	/**
+	 * Type of the reaction, always “custom_emoji”
+	 */
+	type: "custom_emoji";
+
+	/**
+	 * Custom emoji identifier
+	 */
+	custom_emoji_id: string;
+};