### Runtime Specific Imports

Source: https://ref.mtcute.dev/media/modules.html

Package installation and import examples for Bun and Deno runtimes.

```bash
bun add @mtcute/bun
```

```typescript
import { TelegramClient } from 'jsr:@mtcute/deno'
```

--------------------------------

### Install @mtcute/postgres

Source: https://ref.mtcute.dev/modules/_mtcute_postgres.html

Install the package and the required pg driver.

```bash
pnpm add @mtcute/postgres pg
```

--------------------------------

### Optional setup Method

Source: https://ref.mtcute.dev/interfaces/_mtcute_core.index.IStorageDriver.html

The optional setup method initializes the driver with a logger instance and platform object. This is useful for drivers that require logging or platform-specific functionalities.

```typescript
setup?: (log: Logger, platform: ICorePlatform) => void
```

--------------------------------

### Function start

Source: https://ref.mtcute.dev/funcs/_mtcute_bun.methods.start.html

Starts the client in an interactive and declarative manner, handling login, sign up, and 2FA processes.

```APIDOC
## start(client, params)

### Description
Starts the client in an interactive and declarative manner, by providing callbacks for authorization details. This method handles both login and sign up, and also handles 2FA.

### Parameters
- **client** (ITelegramClient) - Required - The Telegram client instance.
- **params** (Object) - Required - Configuration parameters for the authorization flow.

#### params Object
- **abortSignal** (AbortSignal) - Optional - Abort signal.
- **botToken** (MaybeDynamic<string>) - Optional - Bot token to use. Ignored if phone is supplied.
- **code** (MaybeDynamic<string>) - Optional - Code sent to the phone. Ignored if botToken is supplied.
- **codeSentCallback** (Function) - Optional - Custom method called when a code is sent.
- **codeSettings** (Object) - Optional - Additional code settings to pass to the server.
- **forceSms** (boolean) - Optional - Whether to force code delivery through SMS.
- **futureAuthTokens** (Uint8Array[]) - Optional - Saved future auth tokens.
- **invalidCodeCallback** (Function) - Optional - Called if provided code or 2FA password was invalid.
- **password** (MaybeDynamic<string>) - Optional - 2FA password. Ignored if botToken is supplied.
- **phone** (MaybeDynamic<string>) - Optional - Phone number of the account.
- **qrCodeHandler** (Function) - Optional - Enables QR login flow when provided.
- **session** (string | InputStringSessionData) - Optional - String session exported using TelegramClient.exportSession.
- **sessionForce** (boolean) - Optional - Whether to overwrite existing session.

### Returns
- **Promise<User>** - Returns a promise that resolves to the authenticated User object.
```

--------------------------------

### Installation

Source: https://ref.mtcute.dev/modules/_mtcute_postgres.html

Install the @mtcute/postgres module and the pg package using pnpm.

```APIDOC
## Installation
```
pnpm add @mtcute/postgres pg
```
```

--------------------------------

### Function start

Source: https://ref.mtcute.dev/funcs/_mtcute_node.methods.start.html

Starts the client in an interactive and declarative manner, handling authorization details through provided callbacks. This method supports both login and sign-up flows, including two-factor authentication.

```APIDOC
## Function start

### Description
Start the client in an interactive and declarative manner, by providing callbacks for authorization details. This method handles both login and sign up, and also handles 2FV. All parameters are `MaybeDynamic<T>`, meaning you can either supply `T`, or a function that returns `MaybePromise<T>`. This method is intended for _interactive_ login. If you are building some kind of headless service, you will most likely want to use the underlying authorization methods directly.

### Method
POST

### Endpoint
/start

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **client** (ITelegramClient) - Required - The Telegram client instance.
- **params** (object) - Optional - Parameters for starting the client.
  - **abortSignal** (AbortSignal) - Optional - Abort signal.
  - **botToken** (MaybeDynamic<string>) - Optional - Bot token to use. Ignored if `phone` is supplied.
  - **code** (MaybeDynamic<string>) - Optional - Code sent to the phone. Ignored if `botToken` is supplied, must be present if `phone` is supplied.
  - **codeSentCallback** ((code: SentCode) => MaybePromise<void>) - Optional - Custom method called when a code is sent. Called before `start.params.code`. Default: `console.log`.
  - **codeSettings** (Omit<RawCodeSettings, "_" | "logoutTokens">) - Optional - Additional code settings to pass to the server.
  - **forceSms** (boolean) - Optional - Whether to force code delivery through SMS.
  - **futureAuthTokens** (Uint8Array<ArrayBufferLike>[]) - Optional - Saved future auth tokens, if any.
  - **invalidCodeCallback** ((type: "code" | "password") => MaybePromise<void>) - Optional - Called if the provided code or 2FA password was invalid. New code/password will be requested later.
  - **password** (MaybeDynamic<string>) - Optional - 2FA password. Ignored if `botToken` is supplied.
  - **phone** (MaybeDynamic<string>) - Optional - Phone number of the account. If account does not exist, it will be created.
  - **qrCodeHandler** ((url: string, expires: Date) => void) - Optional - When passed, QR login flow will be used instead of the regular login flow. This function will be called whenever the login URL is changed, and the app is expected to display it as a QR code to the user.
  - **session** (string | InputStringSessionData) - Optional - String session exported using TelegramClient.exportSession. This simply calls TelegramClient.importSession before anything else. Note that passed session will be ignored in case storage already contains authorization.
  - **sessionForce** (boolean) - Optional - Whether to overwrite existing session.

### Request Example
```json
{
  "client": "<ITelegramClient_instance>",
  "params": {
    "phone": "+1234567890",
    "codeSentCallback": "(code) => console.log('Code sent:', code)",
    "password": "my2FApassword"
  }
}
```

### Response
#### Success Response (200)
- **User** (User) - Information about the logged-in user.

#### Response Example
```json
{
  "id": 123456789,
  "firstName": "John",
  "lastName": "Doe",
  "username": "johndoe"
}
```
```

--------------------------------

### startUpdatesLoop

Source: https://ref.mtcute.dev/classes/_mtcute_deno.index.BaseTelegramClient.html

Starts the loop for receiving updates from the server.

```APIDOC
## startUpdatesLoop

### Description
Start the updates loop.

### Method
POST

### Endpoint
/updates/start_loop

### Returns
Promise<void>
```

--------------------------------

### Optional setup Method Signature

Source: https://ref.mtcute.dev/interfaces/_mtcute_bun.index.TelegramTransport.html

The optional setup method allows for initializing the transport with crypto and logging capabilities. It takes ICryptoProvider and Logger as parameters and returns void.

```typescript
setup?(crypto: ICryptoProvider, log: Logger): void
```

--------------------------------

### Deno Import Example

Source: https://ref.mtcute.dev/media/crypto

Importing the Telegram client in a Deno environment.

```typescript
import { TelegramClient } from 'jsr:@mtcute/deno'
```

--------------------------------

### Installation Commands

Source: https://ref.mtcute.dev/media/crypto

Commands to initialize a new project or add mtcute packages to existing environments.

```bash
pnpm create @mtcute/bot
```

```bash
pnpm add @mtcute/node
```

```bash
pnpm add @mtcute/web
```

```bash
bun add @mtcute/bun
```

--------------------------------

### startLoop

Source: https://ref.mtcute.dev/classes/_mtcute_core.index.UpdatesManager.html

Starts the background updates processing loop.

```APIDOC
## startLoop

### Description
Start updates loop. You must first call enableUpdatesProcessing to use this method.

### Returns
- **Promise<void>**
```

--------------------------------

### startLoop

Source: https://ref.mtcute.dev/classes/_mtcute_web.index.UpdatesManager.html

Starts the updates processing loop.

```APIDOC
## startLoop

### Description
Start updates loop. You must first call enableUpdatesProcessing to use this method.

### Response
- **Returns** (Promise<void>)
```

--------------------------------

### Basic Usage

Source: https://ref.mtcute.dev/modules/_mtcute_postgres.html

Example of how to use PostgresStorage with a TelegramClient.

```APIDOC
## Usage
```typescript
import { TelegramClient } from '@mtcute/node'
import { PostgresStorage } from '@mtcute/postgres'
import pg from 'pg'

const pool = new pg.Pool({ connectionString: 'postgres://localhost/mydb' })

const tg = new TelegramClient({
    apiId: 12345,
    apiHash: 'abcdef',
    storage: new PostgresStorage(pool),
})

const self = await tg.start()
console.log(`logged in as ${self.displayName}`)
```
```

--------------------------------

### Start Updates Loop

Source: https://ref.mtcute.dev/classes/_mtcute_bun.index.BaseTelegramClient.html

Starts the loop for receiving and processing updates from the server.

```APIDOC
## POST /updates/start_loop

### Description
Start the updates loop.

### Method
POST

### Endpoint
/updates/start_loop

### Response
#### Success Response (200)
- **status** (string) - Indicates that the updates loop has started.

#### Response Example
```json
{
  "status": "started"
}
```
```

--------------------------------

### get Method

Source: https://ref.mtcute.dev/classes/_mtcute_core.index.MemoryAuthKeysRepository.html

Retrieves the authentication key for a specific data center.

```APIDOC
## get

### Description
Get auth_key for the given DC.

### Method
GET

### Endpoint
/api/authkeys/dc/{dc}

### Parameters
#### Path Parameters
- **dc** (number) - Required - The data center ID.

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **Uint8Array<ArrayBufferLike> | null** - The authentication key for the specified DC, or null if not found.

#### Response Example
```json
{
  "key": "base64EncodedKey"
}
```
```

--------------------------------

### Initialize TelegramClient with PostgresStorage

Source: https://ref.mtcute.dev/modules/_mtcute_postgres.html

Basic setup for using PostgreSQL as the storage backend for a Telegram client.

```typescript
import { TelegramClient } from '@mtcute/node'  
import { PostgresStorage } from '@mtcute/postgres'  
import pg from 'pg'  
  
const pool = new pg.Pool({ connectionString: 'postgres://localhost/mydb' })  
  
const tg = new TelegramClient({  
    apiId: 12345,  
    apiHash: 'abcdef',  
    storage: new PostgresStorage(pool),  
})  
  
const self = await tg.start()  
console.log(`logged in as ${self.displayName}`)
```

--------------------------------

### Get Video Start Timestamp

Source: https://ref.mtcute.dev/classes/_mtcute_web.index.Video.html

Returns the video start timestamp in seconds, or null if not available.

```typescript
get videoStartTs(): number | null
```

--------------------------------

### Prepare Client

Source: https://ref.mtcute.dev/interfaces/_mtcute_web.index.ITelegramClient.html

The `prepare` method performs necessary initializations for the client before it can be used. This might include setting up storage or other internal components.

```typescript
prepare(): Promise<void>
```

--------------------------------

### Example: Predicate

Source: https://ref.mtcute.dev/interfaces/_mtcute_tl-utils.index.TlTypeModifiers.html

Provides an example of a predicate, which is used to specify conditions or flags for an argument.

```typescript
`flags.3`
```

--------------------------------

### Date-time Entity Examples - @mtcute/html-parser

Source: https://ref.mtcute.dev/modules/_mtcute_html-parser

Examples of using `<tg-time>` and `<time>` tags for date-time entities. The `format` attribute controls the output.

```html
<tg-time unix="1647531900" format="t">22:45</tg-time>  
<time datetime="2022-03-17T22:45:00" format="t">22:45</time>
```

--------------------------------

### Function iterInviteLinks

Source: https://ref.mtcute.dev/funcs/_mtcute_core.highlevel_methods.iterInviteLinks.html

Iterate over invite links created by an administrator in a chat. As an administrator, you can only get your own links, while as a creator, you can get any other admin's links.

```APIDOC
## Function iterInviteLinks

### Description
Iterate over invite links created by some administrator in the chat.

### Parameters
- **client** (ITelegramClient) - Required - The Telegram client instance.
- **chatId** (InputPeerLike) - Required - The ID of the chat.
- **params** (Object) - Optional - Configuration parameters for fetching links.
  - **admin** (InputPeerLike) - Optional - Only return this admin's links. Default: "self".
  - **limit** (number) - Optional - Limit the number of invite links to be fetched. Default: 100.
  - **offset** (GetInviteLinksOffset) - Optional - Offset for pagination.
  - **revoked** (boolean) - Optional - Whether to fetch revoked invite links.
  - **chunkSize** (number) - Optional - Size of chunks which are fetched. Default: 100.

### Returns
- **AsyncIterableIterator<ChatInviteLink>** - An async iterator yielding ChatInviteLink objects.
```

--------------------------------

### initialize Method

Source: https://ref.mtcute.dev/interfaces/_mtcute_bun.utils.ICryptoProvider.html

Initializes the crypto provider. This method is optional.

```APIDOC
## Method: initialize (Optional)

### Description
Initializes the crypto provider. This method is optional.

### Returns
- MaybePromise<void> - A promise that resolves when initialization is complete.
```

--------------------------------

### BotKeyboardBuilder Constructor

Source: https://ref.mtcute.dev/classes/_mtcute_bun.index.BotKeyboardBuilder.html

Initializes a new instance of the BotKeyboardBuilder class.

```APIDOC
## constructor BotKeyboardBuilder

### Description
Initializes a new instance of the BotKeyboardBuilder class.

### Method
constructor

### Parameters
#### Path Parameters
- **maxRowWidth** (number | null) - Optional - Defaults to 3. The maximum width of a row in the keyboard.

### Returns
BotKeyboardBuilder - A new instance of BotKeyboardBuilder.
```

--------------------------------

### Start Command Filter

Source: https://ref.mtcute.dev/variables/_mtcute_dispatcher.filters.start.html

The 'start' filter is a convenient way to match /start commands sent to the bot's private messages. It simplifies the process of handling initial user interactions.

```APIDOC
## Variable start

### Description
Shorthand filter that matches /start commands sent to bot's private messages.

### Method
N/A (This is a filter definition, not an API endpoint)

### Endpoint
N/A

### Parameters
This filter does not have direct parameters in the traditional API sense. It operates on the message context.

### Request Example
N/A

### Response
N/A (This is a filter definition)
```

--------------------------------

### BunPlatform Class Overview

Source: https://ref.mtcute.dev/classes/_mtcute_bun.index.BunPlatform.html

Provides an overview of the BunPlatform class, its constructors, properties, and methods.

```APIDOC
## Class BunPlatform

#### Implements
  * ICorePlatform

##### Index
### Constructors
constructor
### Properties
beforeExit log normalizeFile
### Methods
getDefaultLogLevel getDeviceModel
```

--------------------------------

### PaidMedia Constructor

Source: https://ref.mtcute.dev/classes/_mtcute_core.index.PaidMedia.html

Initializes a new PaidMedia object.

```APIDOC
## new PaidMedia

### Description
Initializes a new PaidMedia object.

### Parameters
#### Parameters
- **raw** (RawMessageMediaPaidMedia) - Description of the raw media data.
- **_extendedMedia** (MessageMedia[]) - An array of extended media objects.

### Returns
PaidMedia - A new instance of the PaidMedia class.
```

--------------------------------

### Clone mtcute Repository and Install Dependencies

Source: https://ref.mtcute.dev/index.html

Clones the mtcute repository from GitHub and installs project dependencies using pnpm. It also includes instructions for setting up the Node.js version manager (fnm or nvm) and generating code from the TL schema.

```bash
git clone https://github.com/mtcute/mtcute  
fnm use # or `nvm use`  
cd mtcute  
pnpm install --frozen-lockfile  
  
# generate code from tl schema  
pnpm -C packages/core run gen-tl
```

--------------------------------

### botStart Utility

Source: https://ref.mtcute.dev/variables/_mtcute_bun.utils.links.botStart.html

Details regarding the botStart constant used for handling bot deeplinks.

```APIDOC
## botStart

### Description
A constant used to represent bot deeplinks, allowing users to link to bots with a specific start parameter.

### Type
`Deeplink<{ parameter: string; username: string }>`

### Usage
Used to facilitate deep linking to bots with predefined start parameters and usernames.
```

--------------------------------

### Set Business Introduction

Source: https://ref.mtcute.dev/funcs/_mtcute_deno.methods.setBusinessIntro.html

Allows setting or removing the current user's business introduction, including a description, title, and associated sticker.

```APIDOC
## POST /setBusinessIntro

### Description
Set current user's business introduction.

### Method
POST

### Endpoint
/setBusinessIntro

### Parameters
#### Request Body
- **client** (ITelegramClient) - Required - The Telegram client instance.
- **intro** (object | null) - Optional - Introduction parameters, or `null` to remove.
  - **description** (string) - Optional - Description of the introduction.
  - **sticker** (TypeInputDocument | InputFileLike | InputMediaSticker) - Optional - Sticker to show beneath the introduction.
  - **title** (string) - Optional - Title of the introduction.

### Response
#### Success Response (200)
- **void** - Indicates the operation was successful.

#### Response Example
(No specific response body is defined for a void return type, success is indicated by the absence of an error.)
```

--------------------------------

### Initialize BaseTelegramClient

Source: https://ref.mtcute.dev/modules/_mtcute_core.index

Demonstrates manual configuration of the base client using custom providers for crypto, storage, and transport.

```typescript
import { BaseTelegramClient } from '@mtcute/core/client.js'  
  
const tg = new BaseTelegramClient({  
    apiId: 12345,  
    apiHash: '0123456789abcdef0123456789abcdef',  
    crypto: new MyCryptoProvider(),  
    storage: new MyStorage(),  
    transport: () => new MyTransport(),  
})  
  
tg.call({ _: 'help.getConfig' })  
    .then(console.log)
```

--------------------------------

### GET /stickerSet

Source: https://ref.mtcute.dev/funcs/_mtcute_bun.methods.getStickerSet.html

Retrieves a sticker set and its stickers.

```APIDOC
## GET /stickerSet

### Description
Retrieves a sticker set and the stickers contained within it.

### Method
GET

### Endpoint
/stickerSet

### Parameters
#### Query Parameters
- **setId** (InputStickerSet) - Required - Sticker set identifier

### Request Example
```json
{
  "setId": "some_sticker_set_id"
}
```

### Response
#### Success Response (200)
- **StickerSet** (object) - An object containing the sticker set details and its stickers.

#### Response Example
```json
{
  "id": 12345,
  "title": "Example Stickers",
  "stickers": [
    {
      "id": "sticker_id_1",
      "width": 512,
      "height": 512,
      "emoji": "😀"
    },
    {
      "id": "sticker_id_2",
      "width": 512,
      "height": 512,
      "emoji": "😂"
    }
  ]
}
```
```

--------------------------------

### Main Mini App Link

Source: https://ref.mtcute.dev/types/_mtcute_node.index.InputWebview.html

Configuration for opening a main Mini App.

```APIDOC
## Main Mini App Link

### Description
Configuration for opening a main Mini App.

### Parameters
#### Request Body
- **compact** (boolean) - Optional - If set, requests to open the mini app in compact mode (as opposed to fullview mode). Must be set if the `mode` parameter of the Main Mini App link is equal to `compact`.
- **startParam** (string) - Optional - Start parameter from the deep link for the mini app
- **type** (string) - Required - Must be set to "main"
```

--------------------------------

### PostgresAuthKeysRepository Constructor

Source: https://ref.mtcute.dev/classes/_mtcute_postgres.PostgresAuthKeysRepository.html

Initializes a new instance of the PostgresAuthKeysRepository.

```APIDOC
## constructor new PostgresAuthKeysRepository

### Description
Initializes a new instance of the PostgresAuthKeysRepository.

### Method
CONSTRUCTOR

### Parameters
#### Path Parameters
- **_driver** (PostgresStorageDriver) - Required - The PostgreSQL storage driver instance.

### Returns
PostgresAuthKeysRepository
```

--------------------------------

### Get Video Height

Source: https://ref.mtcute.dev/classes/_mtcute_web.index.Video.html

Returns the video height in pixels.

```typescript
get height(): number
```

--------------------------------

### GET value

Source: https://ref.mtcute.dev/classes/_mtcute_deno.index.Dice.html

Retrieves the interactive value associated with an emoji.

```APIDOC
## GET value

### Description
Returns the interactive value of the emoji. Refer to the corresponding type's documentation (in Dice static fields) to understand what this value represents.

### Returns
- **number** - The interactive value.
```

--------------------------------

### Main Mini App Link

Source: https://ref.mtcute.dev/types/_mtcute_bun.index.InputWebview.html

Configuration for opening a Mini App in main view, with optional compact mode and start parameters.

```APIDOC
## Main Mini App Link

### Description
Represents a link to open a Mini App in the main view. Supports opening in compact mode and passing start parameters.

### Method
N/A (Configuration Object)

### Endpoint
N/A

### Parameters
#### Request Body
- **compact** (boolean) - Optional - If set, requests to open the mini app in compact mode (as opposed to fullview mode). Must be set if the `mode` parameter of the Main Mini App link is equal to `compact`.
- **startParam** (string) - Optional - Start parameter from the deep link for the mini app
- **type** (string) - Required - Must be set to "main"
```

--------------------------------

### getInstalledStickers

Source: https://ref.mtcute.dev/funcs/_mtcute_web.methods.getInstalledStickers.html

Retrieves a list of all installed sticker packs for the current client.

```APIDOC
## getInstalledStickers

### Description
Get a list of all installed sticker packs. Note that this method returns brief meta information about the packs, which does not include the stickers themselves. Use getStickerSet to retrieve a full sticker set including the stickers.

### Parameters
- **client** (ITelegramClient) - Required - The Telegram client instance.

### Response
- **Returns** (Promise<StickerSet[]>) - A promise that resolves to an array of sticker set objects.
```

--------------------------------

### Video Class Constructor

Source: https://ref.mtcute.dev/classes/_mtcute_core.index.Video.html

Initializes a new Video instance from raw document data and attributes.

```APIDOC
## Constructor: new Video(doc, attr, media?)

### Description
Creates a new instance of the Video class.

### Parameters
- **doc** (RawDocument) - Required - The raw document object.
- **attr** (RawDocumentAttributeImageSize | RawDocumentAttributeVideo) - Required - Attributes describing the video or image size.
- **media** (RawMessageMediaDocument) - Optional - The raw message media document.

### Returns
- **Video** - A new Video instance.
```

--------------------------------

### Function: basic

Source: https://ref.mtcute.dev/funcs/_mtcute_deno.index.networkMiddlewares.basic

Initializes basic network middlewares for mtcute.

```APIDOC
## basic

### Description
Returns an array of RpcCallMiddleware instances configured with the provided options.

### Parameters
#### Options
- **options** (networkMiddlewares.BasicMiddlewaresOptions) - Optional - Configuration options for the basic middlewares.

### Returns
- **RpcCallMiddleware[]** - An array of configured RPC call middlewares.
```

--------------------------------

### Define ActionGiveawayStarted interface

Source: https://ref.mtcute.dev/interfaces/_mtcute_bun.index.ActionGiveawayStarted.html

Represents the start of a Telegram Premium giveaway.

```typescript
interface ActionGiveawayStarted {  
type: "giveaway_started";  
}
```

--------------------------------

### Function game

Source: https://ref.mtcute.dev/funcs/_mtcute_node.index.BotKeyboard.game.html

Creates a button to start a game for inline keyboards.

```APIDOC
## game

### Description
Creates a button to start a game. This button is intended for use in inline keyboards, not reply keyboards. Note that this button must always be the first button in the first row, and the game ID is inferred from InputMedia.game.

### Parameters
- **text** (string) - Required - The text displayed on the button.
- **options** (object) - Optional - Configuration options.
  - **style** (RawKeyboardButtonStyle) - Optional - The style of the button.

### Returns
- **RawKeyboardButtonGame** - The constructed game button object.
```

--------------------------------

### Bot Start Deeplink

Source: https://ref.mtcute.dev/variables/_mtcute_deno.utils.links.botStart.html

The botStart constant is used to create deeplinks for bots. These links can include a 'parameter' and a 'username' to direct users to a specific bot interaction.

```APIDOC
## Bot Deeplinks

### Description
Used to link to bots with a start parameter.

### Method
N/A (This is a constant definition, not an API endpoint)

### Endpoint
N/A

### Parameters
This constant is of type `Deeplink<{ parameter: string; username: string }>`. It defines the structure for deeplink parameters.

### Request Example
```json
{
  "parameter": "your_start_parameter",
  "username": "your_bot_username"
}
```

### Response
N/A (This is a constant definition, not an API endpoint)
```

--------------------------------

### Constructor: BaseSqliteStorage

Source: https://ref.mtcute.dev/classes/_mtcute_deno.index.BaseSqliteStorage.html

Initializes a new instance of the BaseSqliteStorage class with a provided driver.

```APIDOC
## constructor

### Description
Creates a new instance of BaseSqliteStorage.

### Parameters
- **driver** (BaseSqliteStorageDriver) - Required - The SQLite storage driver instance.

### Returns
- **BaseSqliteStorage** - A new instance of the storage provider.
```

--------------------------------

### Example: Vector Type

Source: https://ref.mtcute.dev/interfaces/_mtcute_tl-utils.index.TlTypeModifiers.html

Demonstrates the representation of a standard Vector type.

```typescript
`type=long, isVector=true => Vector<long>
```

--------------------------------

### botStart Constant

Source: https://ref.mtcute.dev/variables/_mtcute_web.utils.links.botStart.html

The botStart constant provides functionality for managing bot deeplinks that include a start parameter.

```APIDOC
## botStart

### Description
A constant used to handle Telegram bot deeplinks that include a start parameter. It is typed as a Deeplink object containing a parameter and a username.

### Type
`Deeplink<{ parameter: string; username: string }>`
```

--------------------------------

### GET /api/getProfilePhotos

Source: https://ref.mtcute.dev/funcs/_mtcute_web.methods.getProfilePhotos.html

Retrieves a list of profile pictures for a given user.

```APIDOC
## GET /api/getProfilePhotos

### Description
Get a list of profile pictures of a user.

### Method
GET

### Endpoint
/api/getProfilePhotos

### Parameters
#### Query Parameters
- **userId** (InputPeerLike) - Required - User ID, username, phone number, `"me"` or `"self"`
- **limit** (number) - Optional - Maximum number of items to fetch (up to 100). Defaults to 100.
- **offset** (number) - Optional - Offset from which to fetch. Defaults to 0.

### Response
#### Success Response (200)
- **photos** (Array<Photo>) - List of profile photos.
- **nextOffset** (number) - Offset for the next page of results.

#### Response Example
```json
{
  "photos": [
    {
      "id": 12345,
      "photoSmall": "/path/to/small/photo.jpg",
      "photoBig": "/path/to/big/photo.jpg"
    }
  ],
  "nextOffset": 10
}
```
```

--------------------------------

### Get Folders

Source: https://ref.mtcute.dev/funcs/_mtcute_core.highlevel_methods.getFolders.html

Retrieves a list of dialog folders from the Telegram client.

```APIDOC
## Function getFolders

### Description
Get list of folders.

### Method
GET

### Endpoint
/getFolders

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **folders** (RawDialogFilters) - A list of dialog folders.

#### Response Example
{
  "folders": [
    {
      "id": 1,
      "title": "Work",
      "emojis": "💼"
    }
  ]
}
```

--------------------------------

### PreCheckoutQuery Constructor

Source: https://ref.mtcute.dev/classes/_mtcute_web.index.PreCheckoutQuery.html

Initializes a new instance of the PreCheckoutQuery class.

```APIDOC
## constructor PreCheckoutQuery

### Description
Initializes a new instance of the PreCheckoutQuery class.

### Parameters
- **raw** (RawUpdateBotPrecheckoutQuery) - The raw update object.
- **_peers** (PeersIndex) - The peers index.

### Returns
PreCheckoutQuery - The newly created PreCheckoutQuery instance.
```

--------------------------------

### GET getProfilePhoto

Source: https://ref.mtcute.dev/funcs/_mtcute_bun.methods.getProfilePhoto.html

Retrieves a single profile picture of a user by its ID.

```APIDOC
## GET getProfilePhoto

### Description
Get a single profile picture of a user by its ID.

### Parameters
#### Path Parameters
- **client** (ITelegramClient) - Required - The Telegram client instance.
- **userId** (InputPeerLike) - Required - User ID, username, phone number, "me" or "self".
- **photoId** (Long) - Required - ID of the photo to fetch.

### Response
#### Success Response (200)
- **result** (Promise<Photo | null>) - Returns the photo object or null if not found.
```

--------------------------------

### Initialize TelegramClient with High-Level API

Source: https://ref.mtcute.dev/modules/_mtcute_core.index

Shows how to use the high-level client to start a session with phone authentication and 2FA support.

```typescript
import { TelegramClient } from '@mtcute/core/client.js'  
  
const tg = new TelegramClient({  
    // ... same options as above  
})  
  
const self = await tg.start({  
    phone: '+1234567890',  
    code: () => prompt('Enter the code:'),  
    password: 'my-password',  
})  
console.log(`✨ logged in as ${self.displayName}`)
```

--------------------------------

### Define ActionGroupCallStarted interface

Source: https://ref.mtcute.dev/interfaces/_mtcute_bun.index.ActionGroupCallStarted.html

Represents the structure of a group call started event.

```typescript
interface ActionGroupCallStarted {  
call: TypeInputGroupCall;  
type: "group_call_started";  
}
```

--------------------------------

### Using with PGlite

Source: https://ref.mtcute.dev/modules/_mtcute_postgres.html

Example of integrating PostgresStorage with PGlite for an embedded PostgreSQL instance.

```APIDOC
## Using with PGlite
```typescript
import { PGlite } from '@electric-sql/pglite'
import { PostgresStorage } from '@mtcute/postgres'

const pglite = await PGlite.create()
const storage = new PostgresStorage(pglite)
```

PGlite satisfies the `PgClient` interface out of the box, so no adapters are needed.
```

--------------------------------

### WebPageMedia Constructor

Source: https://ref.mtcute.dev/classes/_mtcute_node.index.WebPageMedia.html

Initializes a new instance of the WebPageMedia class.

```APIDOC
## Constructor WebPageMedia

### Description
Initializes a new instance of the WebPageMedia class.

### Method
constructor

### Parameters
#### Parameters
- **raw** (RawMessageMediaWebPage) - Required - The raw media data for the web page.

### Returns
WebPageMedia - A new instance of the WebPageMedia class.
```

--------------------------------

### Get Peer Stories

Source: https://ref.mtcute.dev/funcs/_mtcute_deno.methods.getPeerStories.html

Fetches the stories associated with a specific peer ID.

```APIDOC
## GET /api/getPeerStories

### Description
Get stories of a given peer.

### Method
GET

### Endpoint
/api/getPeerStories

### Parameters
#### Query Parameters
- **client** (ITelegramClient) - Required - The Telegram client instance.
- **peerId** (InputPeerLike) - Required - Peer ID whose stories to fetch.

### Response
#### Success Response (200)
- **stories** (PeerStories) - An object containing the peer's stories.
```

--------------------------------

### WebPageMedia Constructor

Source: https://ref.mtcute.dev/classes/_mtcute_node.index.WebPageMedia

Initializes a new instance of the WebPageMedia class.

```APIDOC
## Constructor WebPageMedia

### Description
Initializes a new instance of the WebPageMedia class.

### Method
constructor

### Parameters
#### Path Parameters
- **raw** (RawMessageMediaWebPage) - Required - The raw media data for the web page.

### Response
#### Success Response (200)
- **WebPageMedia** (WebPageMedia) - An instance of the WebPageMedia class.

### Request Example
```json
{
  "raw": { ... } 
}
```

### Response Example
```json
{
  "instance": "WebPageMedia"
}
```
```

--------------------------------

### GET /getBoosts

Source: https://ref.mtcute.dev/funcs/_mtcute_node.methods.getBoosts.html

Fetches a paginated list of boosts for a given Telegram channel.

```APIDOC
## GET /getBoosts

### Description
Fetches boosts of a channel.

### Method
GET

### Endpoint
/getBoosts

### Parameters
#### Query Parameters
- **client** (ITelegramClient) - Required - The Telegram client instance.
- **peerId** (InputPeerLike) - Required - The ID of the peer (channel) to fetch boosts from.
- **params** (object) - Optional - Additional parameters for fetching boosts.
  - **limit** (number) - Optional - Maximum number of boosters to fetch. Defaults to 100.
  - **offset** (string) - Optional - Offset for pagination.

### Response
#### Success Response (200)
- **ArrayPaginated<Boost, string>** - An array of Boost objects and a pagination offset.

### Response Example
```json
{
  "boosts": [
    {
      "userId": 12345,
      "date": 1678886400,
      "giftedBy": null
    }
  ],
  "nextOffset": "some_offset_string"
}
```
```

--------------------------------

### PaidMedia Constructor

Source: https://ref.mtcute.dev/classes/_mtcute_deno.index.PaidMedia.html

Initializes a new PaidMedia object. It requires the raw media data and any extended media information.

```APIDOC
## constructor PaidMedia

### Description
Initializes a new PaidMedia object.

### Parameters
- **raw** (RawMessageMediaPaidMedia) - The raw paid media data.
- **_extendedMedia** (MessageMedia[]) - An array of extended media objects.
```

--------------------------------

### GET /getFolders

Source: https://ref.mtcute.dev/funcs/_mtcute_deno.methods.getFolders.html

Retrieves a list of dialog folders associated with the Telegram client.

```APIDOC
## GET /getFolders

### Description
Get list of folders.

### Method
GET

### Endpoint
/getFolders

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **folders** (RawDialogFilters) - A list of dialog filters.

#### Response Example
```json
{
  "folders": [
    {
      "id": 1,
      "title": "Work",
      "icons": []
    }
  ]
}
```
```

--------------------------------

### BunCryptoProvider Constructor

Source: https://ref.mtcute.dev/classes/_mtcute_bun.index.BunCryptoProvider.html

Initializes a new instance of the BunCryptoProvider.

```APIDOC
## Constructor BunCryptoProvider

### Description
Creates a new instance of BunCryptoProvider.

### Method
constructor

### Endpoint
N/A

### Parameters
None

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **BunCryptoProvider** (object) - An instance of BunCryptoProvider.

#### Response Example
```json
{
  "instance": "BunCryptoProvider"
}
```
```

--------------------------------

### Get Profile Photos

Source: https://ref.mtcute.dev/funcs/_mtcute_core.highlevel_methods.getProfilePhotos.html

Retrieves a list of profile pictures for a given user.

```APIDOC
## GET /api/users/{userId}/profilePhotos

### Description
Get a list of profile pictures of a user.

### Method
GET

### Endpoint
/api/users/{userId}/profilePhotos

### Parameters
#### Path Parameters
- **userId** (InputPeerLike) - Required - User ID, username, phone number, `"me"` or `"self"

#### Query Parameters
- **limit** (number) - Optional - Maximum number of items to fetch (up to 100). Default: `100`
- **offset** (number) - Optional - Offset from which to fetch. Default: `0`

### Response
#### Success Response (200)
- **photos** (Array<Photo>) - List of photos.
- **nextOffset** (number) - Offset for the next page of results.

#### Response Example
{
  "photos": [
    {
      "id": 12345,
      "sizes": [
        {
          "type": "s",
          "width": 80,
          "height": 80,
          "file_id": "..."
        }
      ]
    }
  ],
  "nextOffset": 10
}
```

--------------------------------

### PostgresPeersRepository Constructor

Source: https://ref.mtcute.dev/classes/_mtcute_postgres.PostgresPeersRepository.html

Initializes a new instance of the PostgresPeersRepository class.

```APIDOC
## Constructor PostgresPeersRepository

### Description
Initializes a new instance of the PostgresPeersRepository class.

### Parameters
- **_driver** (PostgresStorageDriver) - Required - The PostgreSQL storage driver instance.

### Returns
- PostgresPeersRepository
```

--------------------------------

### Get Peer Settings

Source: https://ref.mtcute.dev/funcs/_mtcute_core.highlevel_methods.getPeerSettings.html

Retrieves the settings for a specific peer (user or chat).

```APIDOC
## Function getPeerSettings

### Description
Get PeerSettings for a peer.

### Method
N/A (This is a function call, not an HTTP endpoint)

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
```typescript
// Example usage (assuming client and peerId are defined)
// const settings = await getPeerSettings(client, peerId);
```

### Response
#### Success Response (200)
- **PeerSettings** (Promise<PeerSettings>) - An object containing the peer's settings.

#### Response Example
```json
{
  "example": "// PeerSettings object structure would be defined elsewhere in the library"
}
```
```

--------------------------------

### GET /api/chat/members

Source: https://ref.mtcute.dev/funcs/_mtcute_core.highlevel_methods.getChatMembers.html

Retrieves a paginated and filterable list of members from a specified chat.

```APIDOC
## GET /api/chat/members

### Description
Get a chunk of members of some chat. You can retrieve up to 200 members at once.

### Method
GET

### Endpoint
/api/chat/members

### Parameters
#### Query Parameters
- **client** (ITelegramClient) - Required - The Telegram client instance.
- **chatId** (InputPeerLike) - Required - The chat ID or username.
- **limit** (number) - Optional - Maximum number of members to be retrieved. Defaults to 200. Note: Telegram currently only allows retrieval of at most 200 members.
- **offset** (number) - Optional - Sequential number of the first member to be returned.
- **query** (string) - Optional - Search query to filter members by display names and usernames. Only used for `all`, `banned`, `restricted`, `mention`, `contacts` types. Defaults to an empty string.
- **type** (string) - Optional - Type of the query. Can be one of: `restricted`, `contacts`, `bots`, `banned`, `admins`, `mention`, `all`, `recent`. Defaults to `recent`. Only used for channels and supergroups.

### Response
#### Success Response (200)
- **ArrayWithTotal<ChatMember>** - An array containing chat members and the total count.

#### Response Example
{
  "result": [
    {
      "id": 123456789,
      "firstName": "John",
      "lastName": "Doe",
      "username": "johndoe",
      "isBot": false
    }
  ],
  "totalCount": 500
}
```

--------------------------------

### BoostSlot Constructor

Source: https://ref.mtcute.dev/classes/_mtcute_node.index.BoostSlot.html

Initializes a new BoostSlot instance.

```APIDOC
## Constructor BoostSlot

### Description
Initializes a new BoostSlot instance.

### Parameters
#### Parameters
- **raw** (RawMyBoost) - Description: Raw boost data.
- **_peers** (PeersIndex) - Description: Peers index for resolving entities.

### Returns
BoostSlot - The newly created BoostSlot instance.
```

--------------------------------

### Get Video Timestamp

Source: https://ref.mtcute.dev/classes/_mtcute_web.index.Video.html

Returns the video timestamp in seconds, or null if not available.

```typescript
get videoTimestamp(): number | null
```

--------------------------------

### Create New mtcute Bot Project

Source: https://ref.mtcute.dev/index.html

Use this command to scaffold a new mtcute bot project. It's the recommended way to start a new bot.

```bash
pnpm create @mtcute/bot
```

--------------------------------

### Get Video Codec

Source: https://ref.mtcute.dev/classes/_mtcute_web.index.Video.html

Retrieves the video codec as a string, or null if not available.

```typescript
get codec(): string | null
```

--------------------------------

### Method: connect

Source: https://ref.mtcute.dev/classes/_mtcute_web.index.WebSocketTransport.html

Establishes a connection to a specific Data Center.

```APIDOC
## Method: connect

### Description
Connects to the specified Data Center.

### Parameters
- **dc** (BasicDcOption) - Required - The Data Center configuration to connect to.

### Returns
- **Promise<ITelegramConnection>** - A promise that resolves to the established connection.
```

--------------------------------

### GET inputMedia

Source: https://ref.mtcute.dev/classes/_mtcute_deno.index.Dice.html

Retrieves the input media TL object for use in TelegramClient.sendMedia.

```APIDOC
## GET inputMedia

### Description
Returns the Input media TL object generated from this object, intended for use inside InputMediaLike and TelegramClient.sendMedia. Note that a new value is generated upon usage.

### Returns
- **TypeInputMedia** - The generated TL object.
```

--------------------------------

### Function initSync

Source: https://ref.mtcute.dev/funcs/_mtcute_wasm.initSync.html

Initializes the WASM blob synchronously using a provided module instance.

```APIDOC
## initSync

### Description
Init the WASM blob synchronously (e.g. by passing a WebAssembly.Module instance).

### Parameters
- **module** (SyncInitInput) - Required - The WASM module instance to initialize.

### Returns
- **void**
```

--------------------------------

### Prepare Client

Source: https://ref.mtcute.dev/classes/_mtcute_bun.index.BaseTelegramClient.html

Performs initial preparations for the client without establishing a connection.

```APIDOC
## POST /client/prepare

### Description
**ADVANCED** Do all the preparations, but don't connect just yet. Useful when you want to do some preparations before connecting, like setting up the session. Call `connect` to actually connect.

### Method
POST

### Endpoint
/client/prepare

### Response
#### Success Response (200)
- **status** (string) - Indicates the preparation status.

#### Response Example
```json
{
  "status": "prepared"
}
```
```

--------------------------------

### Get Sticker Width

Source: https://ref.mtcute.dev/classes/_mtcute_bun.index.Sticker.html

Obtain the width of a sticker in pixels. This is a read-only property.

```typescript
sticker.width()
```

--------------------------------

### Initialize BotKeyboardBuilder

Source: https://ref.mtcute.dev/classes/_mtcute_web.index.BotKeyboardBuilder.html

Instantiate BotKeyboardBuilder with an optional maximum row width. Defaults to 3.

```typescript
new BotKeyboardBuilder(maxRowWidth?: number | null): BotKeyboardBuilder
```

--------------------------------

### Get User Parsing Status

Source: https://ref.mtcute.dev/classes/_mtcute_bun.index.FullUser.html

Retrieves the parsing status for a specific user.

```APIDOC
## GET /websites/ref_mtcute_dev/users/status

### Description
Retrieves the parsing status for a specific user.

### Method
GET

### Endpoint
/websites/ref_mtcute_dev/users/status

### Parameters
#### Query Parameters
- **userId** (string) - Required - The ID of the user to retrieve the status for.

### Response
#### Success Response (200)
- **status** (string) - The parsing status of the user (e.g., "parsed", "parsing", "failed").

#### Response Example
```json
{
  "status": "parsed"
}
```
```

--------------------------------

### StoryElement Constructor and Static Methods

Source: https://ref.mtcute.dev/classes/_mtcute_core.index.StoryElement.html

Information about creating and initializing StoryElement instances.

```APIDOC
## Class StoryElement

Constructor for interactive story elements.

### Example
```javascript
     const element = StoryElement  
         .at({ x: 0, y: 0, width: 10, height: 10 })
         .reaction('👍', { dark: true })
```

## Static Methods

### `Static`at

- **at**(params: { height: number; rotation?: number; width: number; x: number; y: number }): StoryElement

#### Parameters
- **params** (object) - Required - Parameters for positioning and sizing the element.
  - **x** (number) - Required - The x-coordinate of the element.
  - **y** (number) - Required - The y-coordinate of the element.
  - **width** (number) - Required - The width of the element.
  - **height** (number) - Required - The height of the element.
  - **rotation** (number) - Optional - The rotation of the element in degrees.

#### Returns
- **StoryElement** - The StoryElement instance with the specified position and size.
```

--------------------------------

### getInstalledStickers Method

Source: https://ref.mtcute.dev/funcs/_mtcute_bun.methods.getInstalledStickers.html

Retrieves a list of all installed sticker packs for the provided Telegram client.

```APIDOC
## getInstalledStickers

### Description
Get a list of all installed sticker packs. This method returns brief meta information about the packs, that does not include the stickers themselves. Use getStickerSet to get a stickerset that will include the stickers.

### Parameters
- **client** (ITelegramClient) - Required - The Telegram client instance.

### Returns
- **Promise<StickerSet[]>** - A promise that resolves to an array of sticker set objects.
```

--------------------------------

### Access type property

Source: https://ref.mtcute.dev/interfaces/_mtcute_bun.index.ActionGroupCallStarted.html

The literal string identifier for the group call started event.

```typescript
type: "group_call_started"
```

--------------------------------

### Interface WebCryptoProviderOptions

Source: https://ref.mtcute.dev/interfaces/_mtcute_web.index.WebCryptoProviderOptions.html

Configuration interface for initializing the WebCryptoProvider.

```APIDOC
## Interface WebCryptoProviderOptions

### Description
Configuration options for the WebCryptoProvider used in @mtcute/web.

### Properties
- **crypto** (Crypto) - Optional - An instance of the Web Crypto API. If not provided, the global crypto object is used.
- **wasmInput** (WasmInitInput) - Optional - Input for initializing WebAssembly modules required by the provider.
```