@mtcute/core 0.16.7 → 0.16.9

package/highlevel/methods/messages/send-reply.d.ts

@@ -0,0 +1,12 @@
+import { ITelegramClient } from '../../client.types.js';
+import { Message } from '../../types/messages/message.js';
+import { ParametersSkip2 } from '../../types/utils.js';
+import { sendMedia } from './send-media.js';
+import { sendMediaGroup } from './send-media-group.js';
+import { sendText } from './send-text.js';
+/** Send a text in reply to a given message */
+export declare function replyText(client: ITelegramClient, message: Message, ...params: ParametersSkip2<typeof sendText>): ReturnType<typeof sendText>;
+/** Send a media in reply to a given message */
+export declare function replyMedia(client: ITelegramClient, message: Message, ...params: ParametersSkip2<typeof sendMedia>): ReturnType<typeof sendMedia>;
+/** Send a media group in reply to a given message */
+export declare function replyMediaGroup(client: ITelegramClient, message: Message, ...params: ParametersSkip2<typeof sendMediaGroup>): ReturnType<typeof sendMediaGroup>;

package/highlevel/methods/messages/send-scheduled.d.ts

@@ -0,0 +1,14 @@
+import { MaybeArray } from '../../../types/utils.js';
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike, Message } from '../../types/index.js';
+/**
+ * Send previously scheduled message(s)
+ *
+ * Note that if the message belongs to a media group,
+ * the entire group will be sent, and all the messages
+ * will be returned.
+ *
+ * @param peer  Chat where the messages were scheduled
+ * @param ids  ID(s) of the messages
+ */
+export declare function sendScheduled(client: ITelegramClient, peer: InputPeerLike, ids: MaybeArray<number>): Promise<Message[]>;

package/highlevel/methods/messages/send-text.d.ts

@@ -0,0 +1,31 @@
+import { ITelegramClient } from '../../client.types.js';
+import { ReplyMarkup } from '../../types/bots/keyboards/index.js';
+import { Message } from '../../types/messages/message.js';
+import { InputText } from '../../types/misc/entities.js';
+import { InputPeerLike } from '../../types/peers/index.js';
+import { CommonSendParams } from './send-common.js';
+/**
+ * Send a text message
+ *
+ * @param chatId  ID of the chat, its username, phone or `"me"` or `"self"`
+ * @param text  Text of the message
+ * @param params  Additional sending parameters
+ */
+export declare function sendText(client: ITelegramClient, chatId: InputPeerLike, text: InputText, params?: CommonSendParams & {
+    /**
+     * For bots: inline or reply markup or an instruction
+     * to hide a reply keyboard or to force a reply.
+     */
+    replyMarkup?: ReplyMarkup;
+    /**
+     * Whether to disable links preview in this message
+     */
+    disableWebPreview?: boolean;
+    /**
+     * Whether to invert media position.
+     *
+     * Currently only supported for web previews and makes the
+     * client render the preview above the caption and not below.
+     */
+    invertMedia?: boolean;
+}): Promise<Message>;

package/highlevel/methods/messages/send-typing.d.ts

@@ -0,0 +1,29 @@
+import { tl } from '@mtcute/tl';
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike, TypingStatus } from '../../types/index.js';
+/**
+ * Sends a current user/bot typing event
+ * to a conversation partner or group.
+ *
+ * This status is set for 6 seconds, and is
+ * automatically cancelled if you send a
+ * message.
+ *
+ * @param chatId  Chat ID
+ * @param status  Typing status
+ * @param params
+ */
+export declare function sendTyping(client: ITelegramClient, chatId: InputPeerLike, status?: Exclude<TypingStatus, 'interaction' | 'interaction_seen'> | tl.TypeSendMessageAction, params?: {
+    /**
+     * For `upload_*` and history import actions, progress of the upload
+     */
+    progress?: number;
+    /**
+     * Unique identifier of the business connection on behalf of which the action will be sent
+     */
+    businessConnectionId?: string;
+    /**
+     * For comment threads, ID of the thread (i.e. top message)
+     */
+    threadId?: number;
+}): Promise<void>;

package/highlevel/methods/messages/send-vote.d.ts

@@ -0,0 +1,15 @@
+import { MaybeArray } from '../../../types/utils.js';
+import { ITelegramClient } from '../../client.types.js';
+import { InputMessageId, Poll } from '../../types/index.js';
+/**
+ * Send or retract a vote in a poll.
+ */
+export declare function sendVote(client: ITelegramClient, params: InputMessageId & {
+    /**
+     * Selected options, or `null` to retract.
+     * You can pass indexes of the answers or the `Buffer`s
+     * representing them. In case of indexes, the poll will first
+     * be requested from the server.
+     */
+    options: null | MaybeArray<number | Uint8Array>;
+}): Promise<Poll>;

package/highlevel/methods/messages/translate-message.d.ts

@@ -0,0 +1,11 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputMessageId, TextWithEntities } from '../../types/index.js';
+/**
+ * Translate message text to a given language.
+ *
+ * Returns `null` if it could not translate the message.
+ */
+export declare function translateMessage(client: ITelegramClient, params: InputMessageId & {
+    /** Target language (two-letter ISO 639-1 language code) */
+    toLanguage: string;
+}): Promise<TextWithEntities>;

package/highlevel/methods/messages/translate-text.d.ts

@@ -0,0 +1,9 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputText, TextWithEntities } from '../../types/misc/entities.js';
+/**
+ * Translate text to a given language.
+ *
+ * @param text  Text to translate
+ * @param toLanguage  Target language (two-letter ISO 639-1 language code)
+ */
+export declare function translateText(client: ITelegramClient, text: InputText, toLanguage: string): Promise<TextWithEntities>;

package/highlevel/methods/messages/unpin-all-messages.d.ts

@@ -0,0 +1,18 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike } from '../../types/index.js';
+/**
+ * Unpin all pinned messages in a chat.
+ *
+ * @param chatId  Chat or user ID
+ */
+export declare function unpinAllMessages(client: ITelegramClient, chatId: InputPeerLike, params?: {
+    /**
+     * For forums - unpin only messages from the given topic
+     */
+    topicId?: number;
+    /**
+     * Whether to dispatch updates that will be generated by this call.
+     * Doesn't follow `disableNoDispatch`
+     */
+    shouldDispatch?: true;
+}): Promise<void>;

package/highlevel/methods/messages/unpin-message.d.ts

@@ -0,0 +1,12 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputMessageId } from '../../types/index.js';
+/**
+ * Unpin a message in a group, supergroup, channel or PM.
+ *
+ * For supergroups/channels, you must have appropriate permissions,
+ * either as an admin, or as default permissions
+ *
+ * @param chatId  Chat ID, username, phone number, `"self"` or `"me"`
+ * @param messageId  Message ID
+ */
+export declare function unpinMessage(client: ITelegramClient, params: InputMessageId): Promise<void>;

package/highlevel/methods/misc/chain-id.d.ts

@@ -0,0 +1,4 @@
+import { tl } from '@mtcute/tl';
+import { ITelegramClient } from '../../client.types.js';
+/** @internal */
+export declare function _getPeerChainId(client: ITelegramClient, peer: tl.TypeInputPeer, prefix?: string): string;

package/highlevel/methods/misc/get-collectible-info.d.ts

@@ -0,0 +1,6 @@
+import { ITelegramClient } from '../../client.types.js';
+import { CollectibleInfo } from '../../types/misc/collectible-info.js';
+/**
+ * Get information about a fragment collectible
+ */
+export declare function getCollectibleInfo(client: ITelegramClient, kind: 'phone' | 'username', item: string): Promise<CollectibleInfo>;

package/highlevel/methods/misc/init-takeout-session.d.ts

@@ -0,0 +1,9 @@
+import { tl } from '@mtcute/tl';
+import { ITelegramClient } from '../../client.types.js';
+import { TakeoutSession } from '../../types/index.js';
+/**
+ * Create a new takeout session
+ *
+ * @param params  Takeout session parameters
+ */
+export declare function initTakeoutSession(client: ITelegramClient, params: Omit<tl.account.RawInitTakeoutSessionRequest, '_'>): Promise<TakeoutSession>;

package/highlevel/methods/misc/normalize-privacy-rules.d.ts

@@ -0,0 +1,8 @@
+import { tl } from '@mtcute/tl';
+import { ITelegramClient } from '../../client.types.js';
+import { InputPrivacyRule } from '../../types/index.js';
+/**
+ * Normalize {@link InputPrivacyRule}[] to `tl.TypeInputPrivacyRule`,
+ * resolving the peers if needed.
+ */
+export declare function _normalizePrivacyRules(client: ITelegramClient, rules: InputPrivacyRule[]): Promise<tl.TypeInputPrivacyRule[]>;

package/highlevel/methods/misc/normalize-text.d.ts

@@ -0,0 +1,5 @@
+import { tl } from '@mtcute/tl';
+import { ITelegramClient } from '../../client.types.js';
+import { InputText } from '../../types/misc/entities.js';
+/** @internal */
+export declare function _normalizeInputText(client: ITelegramClient, input?: InputText): Promise<[string, tl.TypeMessageEntity[] | undefined]>;

package/highlevel/methods/misc/with-params.d.ts

@@ -0,0 +1,10 @@
+import { RpcCallOptions } from '../../../network/index.js';
+import { ITelegramClient } from '../../client.types.js';
+/**
+ * Wrap a client so that all RPC calls will use the specified parameters.
+ *
+ * @param client Client to wrap
+ * @param params RPC call parameters to use by default
+ * @returns The wrapped client
+ */
+export declare function withParams<T extends ITelegramClient>(client: T, params: RpcCallOptions): T;

package/highlevel/methods/password/change-cloud-password.d.ts

@@ -0,0 +1,12 @@
+import { ITelegramClient } from '../../client.types.js';
+/**
+ * Change your 2FA password
+ */
+export declare function changeCloudPassword(client: ITelegramClient, params: {
+    /** Current password as plaintext */
+    currentPassword: string;
+    /** New password as plaintext */
+    newPassword: string;
+    /** Hint for the new password */
+    hint?: string;
+}): Promise<void>;

package/highlevel/methods/password/enable-cloud-password.d.ts

@@ -0,0 +1,17 @@
+import { ITelegramClient } from '../../client.types.js';
+/**
+ * Enable 2FA password on your account
+ *
+ * Note that if you pass `email`, `EmailUnconfirmedError` may be
+ * thrown, and you should use {@link verifyPasswordEmail},
+ * {@link resendPasswordEmail} or {@link cancelPasswordEmail},
+ * and the call this method again
+ */
+export declare function enableCloudPassword(client: ITelegramClient, params: {
+    /** 2FA password as plaintext */
+    password: string;
+    /** Hint for the new password */
+    hint?: string;
+    /** Recovery email */
+    email?: string;
+}): Promise<void>;

package/highlevel/methods/password/password-email.d.ts

@@ -0,0 +1,15 @@
+import { ITelegramClient } from '../../client.types.js';
+/**
+ * Verify an email to use as 2FA recovery method
+ *
+ * @param code  Code which was sent via email
+ */
+export declare function verifyPasswordEmail(client: ITelegramClient, code: string): Promise<void>;
+/**
+ * Resend the code to verify an email to use as 2FA recovery method.
+ */
+export declare function resendPasswordEmail(client: ITelegramClient): Promise<void>;
+/**
+ * Cancel the code that was sent to verify an email to use as 2FA recovery method
+ */
+export declare function cancelPasswordEmail(client: ITelegramClient): Promise<void>;

package/highlevel/methods/password/remove-cloud-password.d.ts

@@ -0,0 +1,7 @@
+import { ITelegramClient } from '../../client.types.js';
+/**
+ * Remove 2FA password from your account
+ *
+ * @param password  2FA password as plaintext
+ */
+export declare function removeCloudPassword(client: ITelegramClient, password: string): Promise<void>;

package/highlevel/methods/premium/apply-boost.d.ts

@@ -0,0 +1,8 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike } from '../../types/index.js';
+/**
+ * Boost a given channel
+ *
+ * @param peerId  Peer ID to boost
+ */
+export declare function applyBoost(client: ITelegramClient, peerId: InputPeerLike): Promise<void>;

package/highlevel/methods/premium/can-apply-boost.d.ts

@@ -0,0 +1,29 @@
+import { ITelegramClient } from '../../client.types.js';
+import { Chat } from '../../types/index.js';
+import { BoostSlot } from '../../types/premium/boost-slot.js';
+export type CanApplyBoostResult = {
+    can: true;
+    replace?: Chat[];
+    slots: BoostSlot[];
+} | {
+    can: false;
+    reason: 'need_premium';
+    slots: BoostSlot[];
+} | {
+    can: false;
+    reason: 'no_slots';
+    slots: BoostSlot[];
+};
+/**
+ * Check if the current user can apply boost to some channel
+ *
+ * @returns
+ *   - `{ can: true }` if the user can apply boost
+ *      - `.replace` - {@link Chat}s that can be replaced with the current one.
+ *        If the user can apply boost without replacing any chats, this field will be `undefined`.
+ *   - `{ can: false }` if the user can't apply boost
+ *      - `.reason == "no_slots"` if the user has no available slots
+ *      - `.reason == "need_premium"` if the user needs Premium to boost
+ *   - In all cases, `slots` will contain all the current user's boost slots
+ */
+export declare function canApplyBoost(client: ITelegramClient): Promise<CanApplyBoostResult>;

package/highlevel/methods/premium/create-business-chat-link.d.ts

@@ -0,0 +1,12 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputText } from '../../types/index.js';
+import { BusinessChatLink } from '../../types/premium/business-chat-link.js';
+/**
+ * Create a new business chat link
+ *
+ * @param text  Text to be inserted into the message input
+ */
+export declare function createBusinessChatLink(client: ITelegramClient, text: InputText, params?: {
+    /** Custom title for the link */
+    title?: string;
+}): Promise<BusinessChatLink>;

package/highlevel/methods/premium/edit-business-chat-link.d.ts

@@ -0,0 +1,20 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputText } from '../../types/index.js';
+import { BusinessChatLink } from '../../types/premium/business-chat-link.js';
+/**
+ * Edit an existing business chat link
+ *
+ * @param link  The link to edit
+ */
+export declare function editBusinessChatLink(client: ITelegramClient, link: string | BusinessChatLink, params: {
+    /** Text to be inserted in the message input */
+    text: InputText;
+    /** Custom title for the link */
+    title?: string;
+}): Promise<BusinessChatLink>;
+/**
+ * Delete a business chat link
+ *
+ * @param link  The link to delete
+ */
+export declare function deleteBusinessChatLink(client: ITelegramClient, link: string | BusinessChatLink): Promise<void>;

package/highlevel/methods/premium/get-boost-stats.d.ts

@@ -0,0 +1,9 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike } from '../../types/index.js';
+import { BoostStats } from '../../types/premium/boost-stats.js';
+/**
+ * Get information about boosts in a channel
+ *
+ * @returns  IDs of stories that were removed
+ */
+export declare function getBoostStats(client: ITelegramClient, peerId: InputPeerLike): Promise<BoostStats>;

package/highlevel/methods/premium/get-boosts.d.ts

@@ -0,0 +1,18 @@
+import { ITelegramClient } from '../../client.types.js';
+import { ArrayPaginated, InputPeerLike } from '../../types/index.js';
+import { Boost } from '../../types/premium/boost.js';
+/**
+ * Get boosts of a channel
+ */
+export declare function getBoosts(client: ITelegramClient, peerId: InputPeerLike, params?: {
+    /**
+     * Offset for pagination
+     */
+    offset?: string;
+    /**
+     * Maximum number of boosters to fetch
+     *
+     * @default  100
+     */
+    limit?: number;
+}): Promise<ArrayPaginated<Boost, string>>;

package/highlevel/methods/premium/get-business-chat-links.d.ts

@@ -0,0 +1,6 @@
+import { ITelegramClient } from '../../client.types.js';
+import { BusinessChatLink } from '../../types/premium/business-chat-link.js';
+/**
+ * Get current user's business chat links
+ */
+export declare function getBusinessChatLinks(client: ITelegramClient): Promise<BusinessChatLink[]>;

package/highlevel/methods/premium/get-business-connection.d.ts

@@ -0,0 +1,8 @@
+import { ITelegramClient } from '../../client.types.js';
+import { BusinessConnection } from '../../types/premium/business-connection.js';
+/**
+ * Get information about the connection of the bot with a business account
+ *
+ * @param connectionId  ID of the business connection
+ */
+export declare function getBusinessConnection(client: ITelegramClient, connectionId: string): Promise<BusinessConnection>;

package/highlevel/methods/premium/get-my-boost-slots.d.ts

@@ -0,0 +1,9 @@
+import { ITelegramClient } from '../../client.types.js';
+import { BoostSlot } from '../../types/premium/boost-slot.js';
+/**
+ * Get boost slots information of the current user.
+ *
+ * Includes information about the currently boosted channels,
+ * as well as the slots that can be used to boost other channels.
+ */
+export declare function getMyBoostSlots(client: ITelegramClient): Promise<BoostSlot[]>;

package/highlevel/methods/premium/get-stars-transactions.d.ts

@@ -0,0 +1,34 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike } from '../../types/index.js';
+import { StarsStatus } from '../../types/premium/stars-status.js';
+/**
+ * Get Telegram Stars transactions for a given peer.
+ *
+ * You can either pass `self` to get your own transactions,
+ * or a chat/bot ID to get transactions of that peer.
+ *
+ * @param peerId  Peer ID
+ * @param params  Additional parameters
+ */
+export declare function getStarsTransactions(client: ITelegramClient, peerId: InputPeerLike, params?: {
+    /**
+     * If passed, only transactions of this direction will be returned
+     */
+    direction?: 'incoming' | 'outgoing';
+    /**
+     * Direction to sort transactions date by (default: desc)
+     */
+    sort?: 'asc' | 'desc';
+    /**
+     * If passed, will only return transactions related to  this subscription ID
+     */
+    subscriptionId?: string;
+    /** Pagination offset */
+    offset?: string;
+    /**
+     * Pagination limit
+     *
+     * @default  100
+     */
+    limit?: number;
+}): Promise<StarsStatus>;

package/highlevel/methods/premium/iter-boosters.d.ts

@@ -0,0 +1,24 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike } from '../../types/index.js';
+import { Boost } from '../../types/premium/boost.js';
+import { getBoosts } from './get-boosts.js';
+/**
+ * Iterate over boosters of a channel.
+ *
+ * Wrapper over {@link getBoosters}
+ */
+export declare function iterBoosters(client: ITelegramClient, peerId: InputPeerLike, params?: Parameters<typeof getBoosts>[2] & {
+    /**
+     * Total number of boosters to fetch
+     *
+     * @default  Infinity, i.e. fetch all boosters
+     */
+    limit?: number;
+    /**
+     * Number of boosters to fetch per request
+     * Usually you don't need to change this
+     *
+     * @default  100
+     */
+    chunkSize?: number;
+}): AsyncIterableIterator<Boost>;

package/highlevel/methods/premium/iter-stars-transactions.d.ts

@@ -0,0 +1,29 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputPeerLike, StarsTransaction } from '../../types/index.js';
+import { getStarsTransactions } from './get-stars-transactions.js';
+/**
+ * Iterate over Telegram Stars transactions for a given peer.
+ *
+ * You can either pass `self` to get your own transactions,
+ * or a chat/bot ID to get transactions of that peer.
+ *
+ * Wrapper over {@link getStarsTransactions}
+ *
+ * @param peerId  Peer ID
+ * @param params  Additional parameters
+ */
+export declare function iterStarsTransactions(client: ITelegramClient, peerId: InputPeerLike, params?: Parameters<typeof getStarsTransactions>[2] & {
+    /**
+     * Total number of boosters to fetch
+     *
+     * @default  Infinity, i.e. fetch all boosters
+     */
+    limit?: number;
+    /**
+     * Number of boosters to fetch per request
+     * Usually you don't need to change this
+     *
+     * @default  100
+     */
+    chunkSize?: number;
+}): AsyncIterableIterator<StarsTransaction>;

package/highlevel/methods/premium/set-business-intro.d.ts

@@ -0,0 +1,22 @@
+import { tl } from '@mtcute/tl';
+import { ITelegramClient } from '../../client.types.js';
+import { InputFileLike, InputMediaSticker } from '../../types/index.js';
+/**
+ * Set current user's business introduction.
+ *
+ * @param intro  Introduction parameters, or `null` to remove
+ */
+export declare function setBusinessIntro(client: ITelegramClient, intro: {
+    /**
+     * Title of the introduction
+     */
+    title?: string;
+    /**
+     * Description of the introduction
+     */
+    description?: string;
+    /**
+     * Sticker to show beneath the introduction
+     */
+    sticker?: InputMediaSticker | InputFileLike | tl.TypeInputDocument;
+} | null): Promise<void>;

package/highlevel/methods/premium/set-business-work-hours.d.ts

@@ -0,0 +1,18 @@
+import { tl } from '@mtcute/tl';
+import { ITelegramClient } from '../../client.types.js';
+import { BusinessWorkHoursDay } from '../../types/premium/business-work-hours.js';
+/**
+ * Set current user's business work hours.
+ */
+export declare function setBusinessWorkHours(client: ITelegramClient, params: ({
+    /** Timezone in which the hours are defined */
+    timezone: string;
+} & ({
+    /**
+     * Business work intervals, per-day (like available in {@link BusinessWorkHours.days})
+     */
+    hours: ReadonlyArray<BusinessWorkHoursDay>;
+} | {
+    /** Business work intervals, raw intervals */
+    intervals: tl.TypeBusinessWeeklyOpen[];
+})) | null): Promise<void>;

package/highlevel/methods/stickers/_utils.d.ts

@@ -0,0 +1,10 @@
+import { tl } from '@mtcute/tl';
+import { ITelegramClient } from '../../client.types.js';
+import { InputStickerSetItem } from '../../types/index.js';
+/**
+ * @internal
+ * @noemit
+ */
+export declare function _normalizeInputStickerSetItem(client: ITelegramClient, sticker: InputStickerSetItem, params?: {
+    progressCallback?: (uploaded: number, total: number) => void;
+}): Promise<tl.TypeInputStickerSetItem>;

package/highlevel/methods/stickers/add-sticker-to-set.d.ts

@@ -0,0 +1,21 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputStickerSet, InputStickerSetItem, StickerSet } from '../../types/index.js';
+/**
+ * Add a sticker to a sticker set.
+ *
+ * For bots the sticker set must have been created by this bot.
+ *
+ * @param setId  Sticker set short name or TL object with input sticker set
+ * @param sticker  Sticker to be added
+ * @param params
+ * @returns  Modfiied sticker set
+ */
+export declare function addStickerToSet(client: ITelegramClient, setId: InputStickerSet, sticker: InputStickerSetItem, params?: {
+    /**
+     * Upload progress callback
+     *
+     * @param uploaded  Number of bytes uploaded
+     * @param total  Total file size
+     */
+    progressCallback?: (uploaded: number, total: number) => void;
+}): Promise<StickerSet>;

package/highlevel/methods/stickers/create-sticker-set.d.ts

@@ -0,0 +1,72 @@
+import { ITelegramClient } from '../../client.types.js';
+import { InputFileLike, InputPeerLike, InputStickerSetItem, StickerSourceType, StickerType, StickerSet } from '../../types/index.js';
+/**
+ * Create a new sticker set.
+ *
+ * @param params
+ * @returns  Newly created sticker set
+ */
+export declare function createStickerSet(client: ITelegramClient, params: {
+    /**
+     * Owner of the sticker set (must be user).
+     *
+     * If this pack is created from a user account,
+     * can only be `"self"`
+     */
+    owner: InputPeerLike;
+    /**
+     * Title of the sticker set (1-64 chars)
+     */
+    title: string;
+    /**
+     * Short name of the sticker set.
+     * Can only contain English letters, digits and underscores
+     * (i.e. must match `/^[a-zA-Z0-9_]+$/),
+     * and (for bots) must end with `_by_<bot username>`
+     * (`<bot username>` is case-insensitive).
+     */
+    shortName: string;
+    /**
+     * Type of the stickers in this set.
+     *
+     * @default  `sticker`, i.e. regular stickers.
+     */
+    type?: StickerType;
+    /**
+     * File source type for the stickers in this set.
+     *
+     * @default  `static`, i.e. regular WEBP stickers.
+     */
+    sourceType?: StickerSourceType;
+    /**
+     * Whether to create "adaptive" emoji set.
+     *
+     * Color of the emoji will be changed depending on the text color.
+     * Only works for TGS-based emoji stickers
+     */
+    adaptive?: boolean;
+    /**
+     * List of stickers to be immediately added into the pack.
+     * There must be at least one sticker in this list.
+     */
+    stickers: InputStickerSetItem[];
+    /**
+     * Thumbnail for the set.
+     *
+     * The file must be either a `.png` file
+     * up to 128kb, having size of exactly `100x100` px,
+     * or a `.tgs` file up to 32kb.
+     *
+     * If not set, Telegram will use the first sticker
+     * in the sticker set as the thumbnail
+     */
+    thumb?: InputFileLike;
+    /**
+     * Upload progress callback.
+     *
+     * @param idx  Index of the sticker
+     * @param uploaded  Number of bytes uploaded
+     * @param total  Total file size
+     */
+    progressCallback?: (idx: number, uploaded: number, total: number) => void;
+}): Promise<StickerSet>;