Compare commits

..

9 Commits

Author SHA1 Message Date
fb81bb91bd v1.0.0 beta 20 2026-03-13 13:37:20 +03:00
589e11b22d docs fix 2026-03-13 13:25:26 +03:00
5976fcd0b8 v1.0.0 beta 19 2026-03-13 12:25:53 +03:00
6ba8520bb7 v1.0.0 beta 18 2026-03-13 11:24:13 +03:00
e4203e8fc0 v1.0.0 beta 17; removed examples 2026-03-13 09:58:06 +03:00
c179a3f5f0 v1.0.0 beta 16 2026-03-12 18:04:46 +03:00
d6e2daec04 v1.0.0 beta 15 2026-03-12 17:45:53 +03:00
3b6bb82e04 v1.0.0 beta 14 2026-03-12 15:00:00 +03:00
0574222608 v1.0.0 beta 13 2026-03-12 14:15:42 +03:00
40 changed files with 2155 additions and 557 deletions

208
README.md
View File

@@ -1,3 +1,209 @@
# Laniakea # Laniakea
A lightweight, easy to use and performance Telegram API wrapper for bot development. [![Go Version](https://img.shields.io/badge/Go-1.24+-00ADD8?logo=go&style=flat-square)](https://go.dev/)
[![License: GPL-3.0](https://img.shields.io/badge/License-GPL%203.0-blue.svg?style=flat-square)](LICENSE)
![Gitea Release](https://img.shields.io/gitea/v/release/ScuroNeko/Laniakea?gitea_url=https%3A%2F%2Fgit.nix13.pw&sort=semver&display_name=release&style=flat-square&color=purple&link=https%3A%2F%2Fgit.nix13.pw%2FScuroNeko%2FLaniakea%2Freleases)
A lightweight, easy-to-use, and performant Telegram Bot API wrapper for Go. It simplifies bot development with a clean plugin system, middleware support, automatic command generation, and built-in rate limiting.
[На русском](README_RU.md)
---
## ✨ Features
* **Simple & Intuitive API:** Designed for ease of use, based on practical examples.
* **Plugin System:** Organize your bot's functionality into independent, reusable plugins.
* **Command Handling:** Easily register commands and extract arguments.
* **Middleware Support:** Run code before or after commands (e.g., logging, access control).
* **Automatic Command Generation:** Generate help and command lists automatically.
* **Built-in Rate Limiting:** Protect your bot from hitting Telegram API limits (supports `retry_after` handling).
* **Context-Aware:** Pass custom database or state contexts to your handlers.
* **Fluent Interface:** Chain methods for clean configuration (e.g., `bot.ErrorTemplate(...).AddPlugins(...)`).
---
## 📦 Installation
```bash
go get git.nix13.pw/scuroneko/laniakea
```
## 🚀 Quick Start (with step-by-step explanation)
Here is a minimal echo/ping bot example with detailed comments.
```go
package main
import (
"log"
"git.nix13.pw/scuroneko/laniakea" // Import the Laniakea library
)
// echo is a command handler function.
// It receives two parameters:
// - ctx: the message context (contains info about the message, sender, chat, etc.)
// - db: your custom database context (here we use NoDB, a placeholder for no database)
func echo(ctx *laniakea.MsgContext, db *laniakea.NoDB) {
// Answer the user with the text they sent, without any command prefix.
// ctx.Text contains the user's message with the command part stripped off.
ctx.Answer(ctx.Text) // User input WITHOUT command
}
func main() {
// 1. Create bot options. Replace "TOKEN" with your actual bot token from @BotFather.
opts := &laniakea.BotOpts{Token: "TOKEN"}
// 2. Initialize a new bot instance.
// We use laniakea.NoDB as the database context type (no database needed for this example).
bot := laniakea.NewBot[laniakea.NoDB](opts)
// Ensure bot resources are cleaned up on exit.
defer bot.Close()
// 3. Create a new plugin named "ping".
// Plugins help group related commands and middlewares.
p := laniakea.NewPlugin[laniakea.NoDB]("ping")
// 4. Add a command to the plugin.
// p.NewCommand(echo, "echo") creates a command that triggers the 'echo' function on the "/echo" command.
p.AddCommand(p.NewCommand(echo, "echo"))
// 5. Add another command using an anonymous function (closure).
// This command simply replies "Pong" when the user sends "/ping".
p.AddCommand(p.NewCommand(func(ctx *laniakea.MsgContext, db *laniakea.NoDB) {
ctx.Answer("Pong")
}, "ping"))
// 6. Configure the bot with a custom error template and add the plugin.
// ErrorTemplate sets a format string for errors (where %s will be replaced by the actual error).
// AddPlugins(p) registers our "ping" plugin with the bot.
bot = bot.ErrorTemplate("Error\n\n%s").AddPlugins(p)
// 7. Automatically generate commands like /start, /help, and a list of all registered commands.
// This is optional but very useful for most bots.
if err := bot.AutoGenerateCommands(); err != nil {
log.Println(err)
}
// 8. Start the bot, listening for updates (long polling).
bot.Run()
}
```
### How It Works
1. `BotOpts`: Holds configuration like the API token.
2. `NewBot[T]`: Creates a bot instance. The type parameter T allows you to pass a custom database context (e.g., *sql.DB) that will be available in all handlers. Use laniakea.NoDB if you don't need it.
3. `NewPlugin`: Creates a logical group for commands and middlewares.
4. `AddCommand`: Registers a command. The first argument is the handler function (func(*MsgContext, T)), the second is the command name (without the slash).
5. **Handler Functions**: Receive *MsgContext (message details, methods like Answer) and your custom database context T.
6. `ErrorTemplate`: Sets a template for error messages. The %s placeholder is replaced by the actual error.
7. `AutoGenerateCommands`: Adds built-in commands (/start, /help) and a command that lists all available commands.
8. `Run()`: Starts the bot's update polling loop.
## 📖 Core Concepts
### Plugins
Plugins are the main way to organize code. A plugin can have multiple commands and middlewares.
```go
plugin := laniakea.NewPlugin[MyDB]("admin")
plugin.AddCommand(plugin.NewCommand(banUser, "ban"))
bot.AddPlugins(plugin)
```
### Commands
A command is a function that handles a specific bot command (e.g., /start).
```go
func myHandler(ctx *laniakea.MsgContext, db *MyDB) {
// Access command arguments via ctx.Args ([]string)
// Reply to the user: ctx.Answer("some text")
}
```
### MsgContext
Provides access to the incoming message and useful reply methods:
- `Answer(text string) *AnswerMessage`: Sends a message with parse_mode none.
- `AnswerMarkdown(text string) *AnswerMessage`: Sends a message formatted with MarkdownV2 (you handle escaping).
- `Keyboard(text string, keyboard *InlineKeyboard) *AnswerMessage`: Sends a message with parse_mode none and inline keyboard.
- `KeyboardMarkdown(text string, keyboard *InlineKeyboard) *AnswerMessage`: Sends a message formatted with MarkdownV2 (you handle escaping) and inline keyboard.
- `AnswerPhoto(photoId, text string) *AnswerMessage`: Sends a message with photo with parse_mode none.
- `AnswerPhotoMarkdown(photoId, text string) *AnswerMessage`: Sends a message formatted with MarkdownV2 (you handle escaping) with.
- `EditCallback(text string)`: Edits message with parse_mode none after clicking inline button.
- `EditCallbackMarkdown(text string)`: Edits a message formatted with MarkdownV2 (you handle escaping) after clicking inline button.
- `SendChatAction(action string)`: Sends a “typing”, “uploading photo”, etc., action.
- Fields: `Text`, `Args`, `From`, `Chat`, `Msg`, etc.
- And more methods and fields!
### Database Context
The `T` in `NewBot[T]` is a powerful feature. You can pass any type (like a database connection pool), and it will be available in every command and middleware handler.
```go
type MyDB struct { /* ... */ }
db := &MyDB{...}
bot := laniakea.NewBot[*MyDB](opts, db) // Pass db instance
```
## 🧩 Middleware
Middleware are functions that run before a command handler. They are perfect for cross-cutting concerns like logging, access control, rate limiting, or modifying the context.
### Signature
A middleware function has the same signature as a command handler, but it must return a bool:
```go
func(ctx *MsgContext, db T) bool
```
- If it returns true, the next middleware (or the command) will be executed.
- If it returns false, the execution chain stops immediately (the command will not run).
### Adding Middleware
Use the Use method of a plugin to add one or more middleware functions. They are executed in the order they are added.
```go
plugin := laniakea.NewPlugin[MyDB]("admin")
plugin.Use(loggingMiddleware, adminOnlyMiddleware)
plugin.AddCommand(plugin.NewCommand(banUser, "ban"))
```
### Example Middlewares
1. Logging Middleware logs every command execution.
```go
func loggingMiddleware(ctx *laniakea.MsgContext, db *MyDB) bool {
log.Printf("User %d executed command: %s", ctx.FromID, ctx.Msg.Text)
return true // continue to next middleware/command
}
```
2. Admin-Only Middleware restricts access to users with a specific role.
```go
func adminOnlyMiddleware(ctx *laniakea.MsgContext, db *MyDB) bool {
if !db.IsAdmin(ctx.FromID) { // assume db has IsAdmin method
ctx.Answer("⛔ Access denied. Admins only.")
return false // stop execution
}
return true
}
```
### Important Notes
- Middleware can modify the MsgContext (e.g., add custom fields) before the command runs.
## ⚙️ Advanced Configuration
- **Inline Keyboards**: Build keyboards using laniakea.NewKeyboard().
- **Rate Limiting**: Pass a configured utils.RateLimiter via BotOpts to handle Telegram's rate limits gracefully.
- **Custom HTTP Client**: Provide your own http.Client in BotOpts for fine-tuned control.
## 📝 License
This project is licensed under the GNU General Public License v3.0 — see the [LICENSE](LICENSE) file for details.
## 📚 Learn More
[GoDoc](https://pkg.go.dev/git.nix13.pw/scuroneko/laniakea)
[Telegram Bot API](https://core.telegram.org/bots/api)
✅ Built with ❤️ by scuroneko

207
README_RU.md Normal file
View File

@@ -0,0 +1,207 @@
# Laniakea
[![Go Version](https://img.shields.io/badge/Go-1.24+-00ADD8?logo=go&style=flat-square)](https://go.dev/)
[![License: GPL-3.0](https://img.shields.io/badge/License-GPL%203.0-blue.svg?style=flat-square)](LICENSE)
![Gitea Release](https://img.shields.io/gitea/v/release/ScuroNeko/Laniakea?gitea_url=https%3A%2F%2Fgit.nix13.pw&sort=semver&display_name=release&style=flat-square&color=purple&link=https%3A%2F%2Fgit.nix13.pw%2FScuroNeko%2FLaniakea%2Freleases)
Легковесная, простая в использовании и производительная обёртка для Telegram Bot API на Go. Она упрощает разработку ботов благодаря чистой системе плагинов, поддержке中间件, автоматической генерации команд и встроенному ограничителю скорости запросов.
[English](README.md)
---
## ✨ Возможности
* **Простой и интуитивный API:** Разработан для лёгкости использования, основан на практических примерах.
* **Система плагинов:** Организуйте функциональность бота в независимые, переиспользуемые плагины.
* **Обработка команд:** Легко регистрируйте команды и извлекайте аргументы.
* **Поддержка промежуточных слоёв (Middleware):** Выполняйте код до или после команд (например, логирование, проверка доступа).
* **Автоматическая генерация команд:** Генерируйте справку и списки команд автоматически.
* **Встроенный ограничитель запросов (Rate Limiter):** Защитите бота от превышения лимитов Telegram API (с обработкой `retry_after`).
* **Контекст данных:** Передавайте свой контекст базы данных или состояния в обработчики.
* **Текучий интерфейс (Fluent Interface):** Стройте цепочки методов для чистой конфигурации (например, `bot.ErrorTemplate(...).AddPlugins(...)`).
---
## 📦 Установка
```bash
go get git.nix13.pw/scuroneko/laniakea
```
## 🚀 Быстрый старт (с пошаговыми комментариями)
Вот минимальный пример бота "echo/ping" с подробными комментариями.
```go
package main
import (
"log"
"git.nix13.pw/scuroneko/laniakea" // Импортируем библиотеку Laniakea
)
// echo — это функция-обработчик команды.
// Она получает два параметра:
// - ctx: контекст сообщения (содержит информацию о сообщении, отправителе, чате и т.д.)
// - db: ваш пользовательский контекст базы данных (здесь мы используем NoDB — заглушку)
func echo(ctx *laniakea.MsgContext, db *laniakea.NoDB) {
// Отвечаем пользователю текстом, который он прислал, без префикса команды.
// ctx.Text содержит сообщение пользователя, из которого удалена часть с командой.
ctx.Answer(ctx.Text) // Ввод пользователя БЕЗ команды
}
func main() {
// 1. Создаём опции бота. Замените "TOKEN" на реальный токен от @BotFather.
opts := &laniakea.BotOpts{Token: "TOKEN"}
// 2. Инициализируем новый экземпляр бота.
// Используем laniakea.NoDB как тип контекста базы данных (база не нужна для примера).
bot := laniakea.NewBot[laniakea.NoDB](opts)
// Гарантируем освобождение ресурсов бота при выходе.
defer bot.Close()
// 3. Создаём новый плагин с именем "ping".
// Плагины помогают группировать связанные команды и промежуточные обработчики.
p := laniakea.NewPlugin[laniakea.NoDB]("ping")
// 4. Добавляем команду в плагин.
// p.NewCommand(echo, "echo") создаёт команду, которая вызывает функцию 'echo' по команде "/echo".
p.AddCommand(p.NewCommand(echo, "echo"))
// 5. Добавляем ещё одну команду, используя анонимную функцию (замыкание).
// Эта команда просто отвечает "Pong", когда пользователь отправляет "/ping".
p.AddCommand(p.NewCommand(func(ctx *laniakea.MsgContext, db *laniakea.NoDB) {
ctx.Answer("Pong")
}, "ping"))
// 6. Настраиваем бота: задаём шаблон ошибки и добавляем плагин.
// ErrorTemplate устанавливает формат для сообщений об ошибках (где %s будет заменён на текст ошибки).
// AddPlugins(p) регистрирует наш плагин "ping" в боте.
bot = bot.ErrorTemplate("Ошибка\n\n%s").AddPlugins(p)
// 7. Автоматически генерируем команды, такие как /start, /help и список всех зарегистрированных команд.
// Это необязательно, но очень полезно для большинства ботов.
if err := bot.AutoGenerateCommands(); err != nil {
log.Println(err)
}
// 8. Запускаем бота, начиная прослушивание обновлений (long polling).
bot.Run()
}
```
### Как это работает
1. `BotOpts`: Содержит конфигурацию, например, токен API.
2. `NewBot[T]`: Создаёт экземпляр бота. Параметр типа T позволяет передать пользовательский контекст базы данных (например, *sql.DB), который будет доступен во всех обработчиках. Используйте laniakea.NoDB, если он не нужен.
3. `NewPlugin`: Создаёт логическую группу для команд и Middleware.
4. `AddCommand`: Регистрирует команду. Первый аргумент — функция-обработчик (func(*MsgContext, T)), второй — имя команды (без слеша).
5. **Функции-обработчики**: Получают *MsgContext (детали сообщения, методы типа Answer) и ваш контекст базы данных T.
6. `ErrorTemplate`: Устанавливает шаблон для сообщений об ошибках. Плейсхолдер %s заменяется на текст ошибки.
7. `AutoGenerateCommands`: Добавляет встроенные команды (/start, /help) и команду, показывающую список всех доступных команд.
8. `Run()`: Запускает цикл опроса обновлений бота.
## 📖 Основные концепции
### Плагины (Plugins)
Плагины — основной способ организации кода. Плагин может содержать несколько команд и Middleware.
```go
plugin := laniakea.NewPlugin[MyDB]("admin")
plugin.AddCommand(plugin.NewCommand(banUser, "ban"))
bot.AddPlugins(plugin)
```
### Команды (Commands)
Команда — это функция, которая обрабатывает конкретную команду бота (например, /start).
```go
func myHandler(ctx *laniakea.MsgContext, db *MyDB) {
// Доступ к аргументам команды через ctx.Args ([]string)
// Ответ пользователю: ctx.Answer("какой-то текст")
}
```
### Контекст сообщения (MsgContext)
Предоставляет доступ к входящему сообщению и полезные методы для ответа:
- `Answer(text string)`: Отправляет сообщение с parse_mode none.
- `AnswerMarkdown(text string)`: Отправляет сообщение, отформатированное MarkdownV2 (экранирование на вашей стороне).
- `Keyboard(text string, keyboard *InlineKeyboard) *AnswerMessage`: Отправляет сообщение с parse_mode none и Inline клавиатурой.
- `KeyboardMarkdown(text string, keyboard *InlineKeyboard) *AnswerMessage`: Отправляет сообщение, отформатированное MarkdownV2 (экранирование на вашей стороне), и Inline клавиатурой.
- `AnswerPhoto(photoId, text string) *AnswerMessage`: Отправляет фотографию с подписью и parse_mode none.
- `AnswerPhotoMarkdown(photoId, text string) *AnswerMessage`: Отправляет фотографию с подписью, отформатированной MarkdownV2 (экранирование на вашей стороне).
- `EditCallback(text string)`: Редактирует сообщение, форматируя его в MarkdownV2 (экранирование на вашей стороне), после нажатия Inline кнопки.
- `EditCallbackMarkdown(text string)`: Редактирует сообщение с parse_mode none после нажатия Inline кнопки.
- `SendChatAction(action string)`: Отправляет действие "печатает", "загружает фото" и т.д.
- Поля: `Text`, `Args`, `From`, `Chat`, `Msg` и другие.
- И много других методов и полей!
### Контекст базы данных (Database Context)
Параметр типа `T` в `NewBot[T]` — мощная функция. Вы можете передать любой тип (например, пул соединений с БД), и он будет доступен в каждом обработчике команды и中间件.
```go
type MyDB struct { /* ... */ }
db := &MyDB{...}
bot := laniakea.NewBot[*MyDB](opts, db) // Передаём экземпляр db
```
## 🧩 Промежуточные слои (Middleware)
Middleware — это функции, которые выполняются перед обработчиком команды. Они идеально подходят для сквозных задач, таких как логирование, контроль доступа, ограничение скорости запросов или модификация контекста.
### Сигнатура
Функция middleware имеет ту же сигнатуру, что и обработчик команды, но должна возвращать bool:
```go
func(ctx *MsgContext, db T) bool
```
- Если возвращается true, выполняется следующий middleware (или сама команда).
- Если возвращается false, цепочка выполнения немедленно прерывается (команда не запускается).
### Добавление middleware
Используйте метод Use плагина для добавления одной или нескольких функций middleware. Они выполняются в порядке добавления.
```go
plugin := laniakea.NewPlugin[MyDB]("admin")
plugin.Use(loggingMiddleware, adminOnlyMiddleware)
plugin.AddCommand(plugin.NewCommand(banUser, "ban"))
```
### Примеры middleware
1. Логирующий middleware логирует каждое выполнение команды.
```go
func loggingMiddleware(ctx *laniakea.MsgContext, db *MyDB) bool {
log.Printf("Пользователь %d выполнил команду: %s", ctx.FromID, ctx.Msg.Text)
return true // продолжаем к следующему middleware/команде
}
```
2. Middleware только для администраторов ограничивает доступ пользователям с определённой ролью.
```go
func adminOnlyMiddleware(ctx *laniakea.MsgContext, db *MyDB) bool {
if !db.IsAdmin(ctx.FromID) { // предполагается, что db имеет метод IsAdmin
ctx.Answer("⛔ Доступ запрещён. Только для администраторов.")
return false // останавливаем выполнение
}
return true
}
```
### Важные замечания
- Middleware может изменять MsgContext (например, добавлять пользовательские поля) перед запуском команды.
## ⚙️ Расширенная настройка
**Инлайн-клавиатуры**: Создавайте клавиатуры с помощью laniakea.NewKeyboard().
**Ограничение запросов**: Передайте настроенный utils.RateLimiter через BotOpts для корректной обработки лимитов Telegram.
**Пользовательский HTTP-клиент**: Предоставьте свой http.Client в BotOpts для точного контроля.
## 📝 Лицензия
Этот проект лицензирован под GNU General Public License v3.0 - подробности см. в файле [LICENSE](LICENSE).
## 📚 Дополнительная информация
[GoDoc Laniakea](https://pkg.go.dev/git.nix13.pw/scuroneko/laniakea)
[Telegram Bot API](https://core.telegram.org/bots/api)
✅ Создано с ❤️ scuroneko

270
bot.go
View File

@@ -1,42 +1,9 @@
// Package laniakea provides a modular, extensible framework for building scalable
// Telegram bots with support for plugins, middleware, localization, draft messages,
// rate limiting, structured logging, and dependency injection.
//
// The framework is designed around a fluent API for configuration and separation of concerns:
//
// - Plugins: Handle specific commands or events (e.g., /start, /help)
// - Middleware: Intercept and modify updates before plugins run (auth, logging, validation)
// - Runners: Background goroutines for cleanup, cron jobs, or monitoring
// - DraftProvider: Safely build and resume multi-step messages
// - L10n: Multi-language support via key-based translation
// - RateLimiter: Enforces Telegram API limits to avoid bans
// - Structured Logging: JSON stdout + optional file output with request-level tracing
// - Dependency Injection: Inject custom database contexts (e.g., *gorm.DB, *sql.DB)
//
// Example usage:
//
// bot := laniakea.NewBot[mydb.DBContext](laniakea.LoadOptsFromEnv()).
// DatabaseContext(&myDB).
// AddUpdateType(tgapi.UpdateTypeMessage).
// AddPrefixes("/", "!").
// AddPlugins(&startPlugin, &helpPlugin).
// AddMiddleware(&authMiddleware, &logMiddleware).
// AddRunner(&cleanupRunner).
// AddL10n(l10n.New())
//
// go bot.Run()
// <-ctx.Done() // wait for shutdown signal
//
// All methods are thread-safe except direct field access. Use provided accessors
// (e.g., GetDBContext, SetUpdateOffset) for safe concurrent access.
package laniakea package laniakea
import ( import (
"context" "context"
"fmt" "fmt"
"os"
"sort" "sort"
"strconv"
"strings" "strings"
"sync" "sync"
"time" "time"
@@ -48,113 +15,6 @@ import (
"github.com/alitto/pond/v2" "github.com/alitto/pond/v2"
) )
// BotOpts holds configuration options for initializing a Bot.
//
// Values are loaded from environment variables via LoadOptsFromEnv().
// Use NewOpts() to create a zero-value struct and set fields manually.
type BotOpts struct {
// Token is the Telegram bot token (required).
Token string
// UpdateTypes is a semicolon-separated list of update types to listen for.
// Example: "message;edited_message;callback_query"
// Defaults to empty (Telegram will return all types).
UpdateTypes []string
// Debug enables debug-level logging.
Debug bool
// ErrorTemplate is the format string used to wrap error messages sent to users.
// Use "%s" to insert the actual error. Example: "❌ Error: %s"
ErrorTemplate string
// Prefixes is a list of command prefixes (e.g., ["/", "!"]).
// Defaults to ["/"] if not set via environment.
Prefixes []string
// LoggerBasePath is the directory where log files are written.
// Defaults to "./".
LoggerBasePath string
// UseRequestLogger enables detailed logging of all Telegram API requests.
UseRequestLogger bool
// WriteToFile enables writing logs to files (main.log and requests.log).
WriteToFile bool
// UseTestServer uses Telegram's test server (https://api.test.telegram.org).
UseTestServer bool
// APIUrl overrides the default Telegram API endpoint (useful for proxies or self-hosted).
APIUrl string
// RateLimit is the maximum number of API requests per second.
// Telegram allows up to 30 req/s for most bots. Defaults to 30.
RateLimit int
// DropRLOverflow drops incoming updates when rate limit is exceeded instead of queuing.
// Use this to prioritize responsiveness over reliability.
DropRLOverflow bool
}
// NewOpts returns a new BotOpts with zero values.
func NewOpts() *BotOpts { return new(BotOpts) }
// LoadOptsFromEnv loads BotOpts from environment variables.
//
// Environment variables:
// - TG_TOKEN: Bot token (required)
// - UPDATE_TYPES: semicolon-separated update types (e.g., "message;callback_query")
// - DEBUG: "true" to enable debug logging
// - ERROR_TEMPLATE: format string for error messages (e.g., "❌ %s")
// - PREFIXES: semicolon-separated prefixes (e.g., "/;!bot")
// - LOGGER_BASE_PATH: directory for log files (default: "./")
// - USE_REQ_LOG: "true" to enable request logging
// - WRITE_TO_FILE: "true" to write logs to files
// - USE_TEST_SERVER: "true" to use Telegram test server
// - API_URL: custom API endpoint
// - RATE_LIMIT: max requests per second (default: 30)
// - DROP_RL_OVERFLOW: "true" to drop updates on rate limit overflow
//
// Returns a populated BotOpts. If TG_TOKEN is missing, behavior is undefined.
func LoadOptsFromEnv() *BotOpts {
rateLimit := 30
if rl := os.Getenv("RATE_LIMIT"); rl != "" {
if n, err := strconv.Atoi(rl); err == nil {
rateLimit = n
}
}
return &BotOpts{
Token: os.Getenv("TG_TOKEN"),
UpdateTypes: strings.Split(os.Getenv("UPDATE_TYPES"), ";"),
Debug: os.Getenv("DEBUG") == "true",
ErrorTemplate: os.Getenv("ERROR_TEMPLATE"),
Prefixes: LoadPrefixesFromEnv(),
LoggerBasePath: os.Getenv("LOGGER_BASE_PATH"),
UseRequestLogger: os.Getenv("USE_REQ_LOG") == "true",
WriteToFile: os.Getenv("WRITE_TO_FILE") == "true",
UseTestServer: os.Getenv("USE_TEST_SERVER") == "true",
APIUrl: os.Getenv("API_URL"),
RateLimit: rateLimit,
DropRLOverflow: os.Getenv("DROP_RL_OVERFLOW") == "true",
}
}
// LoadPrefixesFromEnv returns the PREFIXES environment variable split by semicolon.
// Defaults to ["/"] if not set.
func LoadPrefixesFromEnv() []string {
prefixesS, exists := os.LookupEnv("PREFIXES")
if !exists {
return []string{"/"}
}
return strings.Split(prefixesS, ";")
}
// DbContext is an interface representing the application's database context. // DbContext is an interface representing the application's database context.
// It is injected into plugins and middleware via Bot.DatabaseContext(). // It is injected into plugins and middleware via Bot.DatabaseContext().
// //
@@ -164,12 +24,26 @@ func LoadPrefixesFromEnv() []string {
// bot := NewBot[MyDB](opts).DatabaseContext(&myDB) // bot := NewBot[MyDB](opts).DatabaseContext(&myDB)
// //
// Use NoDB if no database is needed. // Use NoDB if no database is needed.
type DbContext interface{} type DbContext any
// NoDB is a placeholder type for bots that do not use a database. // NoDB is a placeholder type for bots that do not use a database.
// Use Bot[NoDB] to indicate no dependency injection is required. // Use Bot[NoDB] to indicate no dependency injection is required.
type NoDB struct{ DbContext } type NoDB struct{ DbContext }
// DbLogger is a function type that returns a slog.LoggerWriter for database logging.
// Used to inject database-specific log output (e.g., SQL queries, ORM events).
type DbLogger[T DbContext] func(db *T) slog.LoggerWriter
// BotPayloadType defines the serialization format for callback data payloads.
type BotPayloadType string
var (
// BotPayloadBase64 encodes callback data as a Base64 string.
BotPayloadBase64 BotPayloadType = "base64"
// BotPayloadJson encodes callback data as a JSON string.
BotPayloadJson BotPayloadType = "json"
)
// Bot is the core Telegram bot instance. // Bot is the core Telegram bot instance.
// //
// Manages: // Manages:
@@ -185,6 +59,8 @@ type Bot[T DbContext] struct {
debug bool debug bool
errorTemplate string errorTemplate string
username string username string
payloadType BotPayloadType
maxWorkers int
logger *slog.Logger // Main bot logger (JSON stdout + optional file) logger *slog.Logger // Main bot logger (JSON stdout + optional file)
RequestLogger *slog.Logger // Optional request-level API logging RequestLogger *slog.Logger // Optional request-level API logging
@@ -226,27 +102,39 @@ func NewBot[T any](opts *BotOpts) *Bot[T] {
updateQueue := make(chan *tgapi.Update, 512) updateQueue := make(chan *tgapi.Update, 512)
var limiter *utils.RateLimiter //var limiter *utils.RateLimiter
if opts.RateLimit > 0 { //if opts.RateLimit > 0 {
limiter = utils.NewRateLimiter() // limiter = utils.NewRateLimiter()
} //}
limiter := utils.NewRateLimiter()
apiOpts := tgapi.NewAPIOpts(opts.Token). apiOpts := tgapi.NewAPIOpts(opts.Token).
SetAPIUrl(opts.APIUrl). SetAPIUrl(opts.APIUrl).
UseTestServer(opts.UseTestServer). UseTestServer(opts.UseTestServer).
SetLimiter(limiter) SetLimiter(limiter)
api := tgapi.NewAPI(apiOpts) api := tgapi.NewAPI(apiOpts)
uploader := tgapi.NewUploader(api) uploader := tgapi.NewUploader(api)
prefixes := opts.Prefixes
if len(prefixes) == 0 {
prefixes = []string{"/"}
}
workers := 32
if opts.MaxWorkers > 0 {
workers = opts.MaxWorkers
}
bot := &Bot[T]{ bot := &Bot[T]{
updateOffset: 0, updateOffset: 0,
errorTemplate: "%s", errorTemplate: "%s",
payloadType: BotPayloadBase64,
maxWorkers: workers,
updateQueue: updateQueue, updateQueue: updateQueue,
api: api, api: api,
uploader: uploader, uploader: uploader,
debug: opts.Debug, debug: opts.Debug,
prefixes: opts.Prefixes, prefixes: prefixes,
token: opts.Token, token: opts.Token,
plugins: make([]Plugin[T], 0), plugins: make([]Plugin[T], 0),
updateTypes: make([]tgapi.UpdateType, 0), updateTypes: make([]tgapi.UpdateType, 0),
@@ -277,7 +165,7 @@ func NewBot[T any](opts *BotOpts) *Bot[T] {
if bot.username == "" { if bot.username == "" {
bot.logger.Warn("Can't get bot username. Named command handlers won't work!") bot.logger.Warn("Can't get bot username. Named command handlers won't work!")
} }
bot.logger.Infof("Authorized as %s (@%s)\n", u.FirstName, u.Username) bot.logger.Infoln(fmt.Sprintf("Authorized as %s (@%s)", u.FirstName, Val(u.Username, "unknown")))
return bot return bot
} }
@@ -382,34 +270,6 @@ func (bot *Bot[T]) SetDraftProvider(p *DraftProvider) *Bot[T] {
return bot return bot
} }
// DbLogger is a function type that returns a slog.LoggerWriter for database logging.
// Used to inject database-specific log output (e.g., SQL queries, ORM events).
type DbLogger[T DbContext] func(db *T) slog.LoggerWriter
// AddDatabaseLoggerWriter adds a database logger writer to all loggers.
//
// The writer will receive logs from:
// - Main bot logger
// - Request logger (if enabled)
// - API and Uploader loggers
//
// Example:
//
// bot.AddDatabaseLoggerWriter(func(db *MyDB) slog.LoggerWriter {
// return db.QueryLogger()
// })
func (bot *Bot[T]) AddDatabaseLoggerWriter(writer DbLogger[T]) *Bot[T] {
w := writer(bot.dbContext)
bot.logger.AddWriter(w)
if bot.RequestLogger != nil {
bot.RequestLogger.AddWriter(w)
}
for _, l := range bot.extraLoggers {
l.AddWriter(w)
}
return bot
}
// DatabaseContext injects a database context into the bot. // DatabaseContext injects a database context into the bot.
// This context is accessible to plugins and middleware via GetDBContext(). // This context is accessible to plugins and middleware via GetDBContext().
func (bot *Bot[T]) DatabaseContext(ctx *T) *Bot[T] { func (bot *Bot[T]) DatabaseContext(ctx *T) *Bot[T] {
@@ -425,6 +285,14 @@ func (bot *Bot[T]) UpdateTypes(t ...tgapi.UpdateType) *Bot[T] {
return bot return bot
} }
// SetPayloadType sets the type, that bot will use for payload
// json - string `{"cmd": "command", "args": [...]}
// base64 - same json, but encoded in base64 string
func (bot *Bot[T]) SetPayloadType(t BotPayloadType) *Bot[T] {
bot.payloadType = t
return bot
}
// AddUpdateType adds one or more update types to the list. // AddUpdateType adds one or more update types to the list.
// Does not overwrite existing types. // Does not overwrite existing types.
func (bot *Bot[T]) AddUpdateType(t ...tgapi.UpdateType) *Bot[T] { func (bot *Bot[T]) AddUpdateType(t ...tgapi.UpdateType) *Bot[T] {
@@ -545,20 +413,28 @@ func (bot *Bot[T]) AddL10n(l *L10n) *Bot[T] {
return bot return bot
} }
// enqueueUpdate attempts to add an update to the internal processing queue. // AddDatabaseLoggerWriter adds a database logger writer to all loggers.
// //
// Returns extypes.QueueFullErr if the queue is full and the update cannot be enqueued. // The writer will receive logs from:
// This is non-blocking and used to implement rate-limiting behavior. // - Main bot logger
// - Request logger (if enabled)
// - API and Uploader loggers
// //
// When DropRLOverflow is enabled, this error is ignored and the update is dropped. // Example:
// Otherwise, the update is retried via the main update loop. //
func (bot *Bot[T]) enqueueUpdate(u *tgapi.Update) error { // bot.AddDatabaseLoggerWriter(func(db *MyDB) slog.LoggerWriter {
select { // return db.QueryLogger()
case bot.updateQueue <- u: // })
return nil func (bot *Bot[T]) AddDatabaseLoggerWriter(writer DbLogger[T]) *Bot[T] {
default: w := writer(bot.dbContext)
return extypes.QueueFullErr bot.logger.AddWriter(w)
if bot.RequestLogger != nil {
bot.RequestLogger.AddWriter(w)
} }
for _, l := range bot.extraLoggers {
l.AddWriter(w)
}
return bot
} }
// RunWithContext starts the bot with a given context for graceful shutdown. // RunWithContext starts the bot with a given context for graceful shutdown.
@@ -567,7 +443,7 @@ func (bot *Bot[T]) enqueueUpdate(u *tgapi.Update) error {
// - Validates required configuration (prefixes, plugins) // - Validates required configuration (prefixes, plugins)
// - Starts all registered runners as background goroutines // - Starts all registered runners as background goroutines
// - Begins polling for updates via Telegram's GetUpdates API // - Begins polling for updates via Telegram's GetUpdates API
// - Processes updates concurrently using a worker pool (16 goroutines) // - Processes updates concurrently using a worker pool with size configurable via BotOpts.MaxWorkers
// //
// The context controls graceful shutdown. When canceled, the bot: // The context controls graceful shutdown. When canceled, the bot:
// - Stops polling for new updates // - Stops polling for new updates
@@ -591,12 +467,18 @@ func (bot *Bot[T]) RunWithContext(ctx context.Context) {
return return
} }
bot.ExecRunners() bot.ExecRunners(ctx)
bot.logger.Infoln("Bot running. Press CTRL+C to exit.") bot.logger.Infoln("Bot running. Press CTRL+C to exit.")
// Start update polling in a goroutine // Start update polling in a goroutine
go func() { go func() {
defer func() {
if r := recover(); r != nil {
bot.logger.Errorln(fmt.Sprintf("panic in update polling: %v", r))
}
close(bot.updateQueue)
}()
for { for {
select { select {
case <-ctx.Done(): case <-ctx.Done():
@@ -610,8 +492,9 @@ func (bot *Bot[T]) RunWithContext(ctx context.Context) {
} }
for _, u := range updates { for _, u := range updates {
u := u // copy loop variable to avoid race condition
select { select {
case bot.updateQueue <- u: case bot.updateQueue <- &u:
case <-ctx.Done(): case <-ctx.Done():
return return
} }
@@ -621,13 +504,14 @@ func (bot *Bot[T]) RunWithContext(ctx context.Context) {
}() }()
// Start worker pool for concurrent update handling // Start worker pool for concurrent update handling
pool := pond.NewPool(16) pool := pond.NewPool(bot.maxWorkers)
for update := range bot.updateQueue { for update := range bot.updateQueue {
update := update // capture loop variable u := update // capture loop variable
pool.Submit(func() { pool.Submit(func() {
bot.handle(update) bot.handle(u)
}) })
} }
pool.Stop() // Wait for all tasks to complete and stop the pool
} }
// Run starts the bot using a background context. // Run starts the bot using a background context.

226
bot_opts.go Normal file
View File

@@ -0,0 +1,226 @@
package laniakea
import (
"os"
"strconv"
"strings"
"git.nix13.pw/scuroneko/laniakea/tgapi"
)
// BotOpts holds configuration options for initializing a Bot.
//
// Values are loaded from environment variables via LoadOptsFromEnv().
// Use NewOpts() to create a zero-value struct and set fields manually.
type BotOpts struct {
// Token is the Telegram bot token (required).
Token string
// UpdateTypes is a list of update types to listen for.
// Example: "["message", "edited_message", "callback_query"]"
// Defaults to empty (Telegram will return all types).
UpdateTypes []tgapi.UpdateType
// Debug enables debug-level logging.
Debug bool
// ErrorTemplate is the format string used to wrap error messages sent to users.
// Use "%s" to insert the actual error. Example: "❌ Error: %s"
ErrorTemplate string
// Prefixes is a list of command prefixes (e.g., ["/", "!"]).
// Defaults to ["/"] if not set via environment.
Prefixes []string
// LoggerBasePath is the directory where log files are written.
// Defaults to "./".
LoggerBasePath string
// UseRequestLogger enables detailed logging of all Telegram API requests.
UseRequestLogger bool
// WriteToFile enables writing logs to files (main.log and requests.log).
WriteToFile bool
// UseTestServer uses Telegram's test server (https://api.test.telegram.org).
UseTestServer bool
// APIUrl overrides the default Telegram API endpoint (useful for proxies or self-hosted).
APIUrl string
// RateLimit is the maximum number of API requests per second.
// Telegram allows up to 30 req/s for most bots. Defaults to 30.
RateLimit int
// DropRLOverflow drops incoming updates when rate limit is exceeded instead of queuing.
// Use this to prioritize responsiveness over reliability.
DropRLOverflow bool
// MaxWorkers is the maximum number of concurrency running update handlers.
MaxWorkers int
}
// LoadOptsFromEnv loads BotOpts from environment variables.
//
// Environment variables:
// - TG_TOKEN: Bot token (required)
// - UPDATE_TYPES: semicolon-separated update types (e.g., "message;callback_query")
// - DEBUG: "true" to enable debug logging
// - ERROR_TEMPLATE: format string for error messages (e.g., "❌ %s")
// - PREFIXES: semicolon-separated prefixes (e.g., "/;!bot")
// - LOGGER_BASE_PATH: directory for log files (default: "./")
// - USE_REQ_LOG: "true" to enable request logging
// - WRITE_TO_FILE: "true" to write logs to files
// - USE_TEST_SERVER: "true" to use Telegram test server
// - API_URL: custom API endpoint
// - RATE_LIMIT: max requests per second (default: 30)
// - DROP_RL_OVERFLOW: "true" to drop updates on rate limit overflow
//
// Returns a populated BotOpts. If TG_TOKEN is missing, behavior is undefined.
func LoadOptsFromEnv() *BotOpts {
rateLimit := 30
if rl := os.Getenv("RATE_LIMIT"); rl != "" {
if n, err := strconv.Atoi(rl); err == nil {
rateLimit = n
}
}
stringUpdateTypes := strings.Split(os.Getenv("UPDATE_TYPES"), ";")
updateTypes := make([]tgapi.UpdateType, len(stringUpdateTypes))
for i, updateType := range stringUpdateTypes {
updateTypes[i] = tgapi.UpdateType(updateType)
}
return &BotOpts{
Token: os.Getenv("TG_TOKEN"),
UpdateTypes: updateTypes,
Debug: os.Getenv("DEBUG") == "true",
ErrorTemplate: os.Getenv("ERROR_TEMPLATE"),
Prefixes: LoadPrefixesFromEnv(),
LoggerBasePath: os.Getenv("LOGGER_BASE_PATH"),
UseRequestLogger: os.Getenv("USE_REQ_LOG") == "true",
WriteToFile: os.Getenv("WRITE_TO_FILE") == "true",
UseTestServer: os.Getenv("USE_TEST_SERVER") == "true",
APIUrl: os.Getenv("API_URL"),
RateLimit: rateLimit,
DropRLOverflow: os.Getenv("DROP_RL_OVERFLOW") == "true",
}
}
// SetToken sets the Telegram bot token (required).
func (opts *BotOpts) SetToken(token string) *BotOpts {
opts.Token = token
return opts
}
// SetUpdateTypes sets the list of update types to listen for.
// If empty (default), Telegram will return all update types.
// Example: opts.SetUpdateTypes("message", "callback_query")
func (opts *BotOpts) SetUpdateTypes(types ...tgapi.UpdateType) *BotOpts {
opts.UpdateTypes = types
return opts
}
// SetDebug enables or disables debug-level logging.
// Default is false.
func (opts *BotOpts) SetDebug(debug bool) *BotOpts {
opts.Debug = debug
return opts
}
// SetErrorTemplate sets the format string for error messages sent to users.
// Use "%s" to insert the actual error. Example: "❌ Error: %s"
// If not set, defaults to "%s".
func (opts *BotOpts) SetErrorTemplate(tpl string) *BotOpts {
opts.ErrorTemplate = tpl
return opts
}
// SetPrefixes sets the command prefixes (e.g., "/", "!").
// If not set via environment, defaults to ["/"].
func (opts *BotOpts) SetPrefixes(prefixes ...string) *BotOpts {
opts.Prefixes = prefixes
return opts
}
// SetLoggerBasePath sets the directory where log files are written.
// Defaults to "./".
func (opts *BotOpts) SetLoggerBasePath(path string) *BotOpts {
opts.LoggerBasePath = path
return opts
}
// SetUseRequestLogger enables detailed logging of all Telegram API requests.
// Default is false.
func (opts *BotOpts) SetUseRequestLogger(use bool) *BotOpts {
opts.UseRequestLogger = use
return opts
}
// SetWriteToFile enables writing logs to files (main.log and requests.log).
// Default is false.
func (opts *BotOpts) SetWriteToFile(write bool) *BotOpts {
opts.WriteToFile = write
return opts
}
// SetUseTestServer enables using Telegram's test server (https://api.telegram.org/bot<token>/test).
// Default is false.
func (opts *BotOpts) SetUseTestServer(use bool) *BotOpts {
opts.UseTestServer = use
return opts
}
// SetAPIUrl overrides the default Telegram API endpoint (useful for proxies or self-hosted).
// If not set, defaults to "https://api.telegram.org".
func (opts *BotOpts) SetAPIUrl(url string) *BotOpts {
opts.APIUrl = url
return opts
}
// SetRateLimit sets the maximum number of API requests per second.
// Telegram allows up to 30 req/s for most bots. Defaults to 30.
func (opts *BotOpts) SetRateLimit(limit int) *BotOpts {
opts.RateLimit = limit
return opts
}
// SetDropRLOverflow drops incoming updates when rate limit is exceeded instead of queuing.
// Use this to prioritize responsiveness over reliability. Default is false.
func (opts *BotOpts) SetDropRLOverflow(drop bool) *BotOpts {
opts.DropRLOverflow = drop
return opts
}
// SetMaxWorkers sets the maximum number of concurrent update handlers.
// Must be called before NewBot, as the value is captured during bot creation.
//
// The optimal value depends on your bot's workload:
// - For I/O-bound handlers (e.g., database queries, external API calls), you may
// need more workers, but be mindful of downstream service limits.
// - For CPU-bound handlers, keep workers close to the number of CPU cores.
//
// Recommended starting points (adjust based on profiling and monitoring):
// - Small to medium bots with fast handlers: 1632
// - Medium to large bots with fast handlers: 3264
// - Large bots with heavy I/O: 64128 (ensure your infrastructure can handle it)
//
// The default is 32. Monitor queue length and processing latency to fine-tune.
func (opts *BotOpts) SetMaxWorkers(workers int) *BotOpts {
opts.MaxWorkers = workers
return opts
}
// LoadPrefixesFromEnv returns the PREFIXES environment variable split by semicolon.
// Defaults to ["/"] if not set.
func LoadPrefixesFromEnv() []string {
prefixesS, exists := os.LookupEnv("PREFIXES")
if !exists {
return []string{"/"}
}
return strings.Split(prefixesS, ";")
}

View File

@@ -1,22 +1,16 @@
// Package laniakea provides a framework for building Telegram bots with plugin-based
// command registration and automatic command scope management.
//
// This module automatically generates and registers bot commands across different
// chat scopes (private, group, admin) based on plugin-defined commands.
//
// Commands are derived from Plugin and Command structs, with optional descriptions
// and argument formatting. Automatic registration avoids manual command setup and
// ensures consistency across chat types.
package laniakea package laniakea
import ( import (
"errors" "errors"
"fmt" "fmt"
"regexp"
"strings" "strings"
"git.nix13.pw/scuroneko/laniakea/tgapi" "git.nix13.pw/scuroneko/laniakea/tgapi"
) )
var CmdRegexp = regexp.MustCompile("^[a-zA-Z0-9]+$")
// ErrTooManyCommands is returned when the total number of registered commands // ErrTooManyCommands is returned when the total number of registered commands
// exceeds Telegram's limit of 100 bot commands per bot. // exceeds Telegram's limit of 100 bot commands per bot.
// //
@@ -38,8 +32,10 @@ var ErrTooManyCommands = errors.New("too many commands. max 100")
// //
// Command{command: "start", description: "Start the bot", args: []Arg{{text: "name", required: false}}} // Command{command: "start", description: "Start the bot", args: []Arg{{text: "name", required: false}}}
// → Description: "Start the bot. Usage: /start [name]" // → Description: "Start the bot. Usage: /start [name]"
func generateBotCommand[T any](cmd Command[T]) tgapi.BotCommand { // Command{command: "echo", description: "Echo user input", args: []Arg{{text: "name", required: true}}}
desc := cmd.command // → Description: "Echo user input. Usage: /echo <input>"
func generateBotCommand[T any](cmd *Command[T]) tgapi.BotCommand {
desc := ""
if len(cmd.description) > 0 { if len(cmd.description) > 0 {
desc = cmd.description desc = cmd.description
} }
@@ -47,33 +43,59 @@ func generateBotCommand[T any](cmd Command[T]) tgapi.BotCommand {
var descArgs []string var descArgs []string
for _, a := range cmd.args { for _, a := range cmd.args {
if a.required { if a.required {
descArgs = append(descArgs, a.text) descArgs = append(descArgs, fmt.Sprintf("<%s>", a.text))
} else { } else {
descArgs = append(descArgs, fmt.Sprintf("[%s]", a.text)) descArgs = append(descArgs, fmt.Sprintf("[%s]", a.text))
} }
} }
desc = fmt.Sprintf("%s. Usage: /%s %s", desc, cmd.command, strings.Join(descArgs, " ")) usage := fmt.Sprintf("Usage: /%s %s", cmd.command, strings.Join(descArgs, " "))
return tgapi.BotCommand{Command: cmd.command, Description: desc} if desc != "" {
desc = fmt.Sprintf("%s. %s", desc, usage)
return tgapi.BotCommand{Command: cmd.command, Description: desc}
}
return tgapi.BotCommand{Command: cmd.command, Description: usage}
} }
// generateBotCommandForPlugin collects all non-skipped commands from a Plugin[T] // checkCmdRegex check if command satisfy regexp [a-zA-Z0-9]+
// Return true if satisfied, else false.
func checkCmdRegex(cmd string) bool { return CmdRegexp.MatchString(cmd) }
// gatherCommandsForPlugin collects all non-skipped commands from a Plugin[T]
// and converts them into tgapi.BotCommand objects. // and converts them into tgapi.BotCommand objects.
// //
// Commands marked with skipAutoCmd = true are excluded from auto-registration. // Commands marked with skipAutoCmd = true are excluded from auto-registration.
// This allows plugins to opt out of automatic command generation (e.g., for // This allows plugins to opt out of automatic command generation (e.g., for
// internal or hidden commands). // internal or hidden commands).
func generateBotCommandForPlugin[T any](pl Plugin[T]) []tgapi.BotCommand { func gatherCommandsForPlugin[T any](pl Plugin[T]) []tgapi.BotCommand {
commands := make([]tgapi.BotCommand, 0) commands := make([]tgapi.BotCommand, 0)
for _, cmd := range pl.commands { for _, cmd := range pl.commands {
if cmd.skipAutoCmd { if cmd.skipAutoCmd {
continue continue
} }
if !checkCmdRegex(cmd.command) {
continue
}
commands = append(commands, generateBotCommand(cmd)) commands = append(commands, generateBotCommand(cmd))
} }
return commands return commands
} }
// gatherCommands collects all commands from all plugins
// and converts them into tgapi.BotCommand objects.
// See gatherCommandsForPlugin
func gatherCommands[T any](bot *Bot[T]) []tgapi.BotCommand {
commands := make([]tgapi.BotCommand, 0)
for _, pl := range bot.plugins {
if pl.skipAutoCmd {
continue
}
commands = append(commands, gatherCommandsForPlugin(pl)...)
bot.logger.Debugln(fmt.Sprintf("Registered %d commands from plugin %s", len(pl.commands), pl.name))
}
return commands
}
// AutoGenerateCommands registers all plugin-defined commands with Telegram's Bot API // AutoGenerateCommands registers all plugin-defined commands with Telegram's Bot API
// across three scopes: // across three scopes:
// - Private chats (users) // - Private chats (users)
@@ -103,17 +125,7 @@ func (bot *Bot[T]) AutoGenerateCommands() error {
return fmt.Errorf("failed to delete existing commands: %w", err) return fmt.Errorf("failed to delete existing commands: %w", err)
} }
// Collect all non-skipped commands from all plugins commands := gatherCommands(bot)
commands := make([]tgapi.BotCommand, 0)
for _, pl := range bot.plugins {
if pl.skipAutoCmd {
continue
}
commands = append(commands, generateBotCommandForPlugin(pl)...)
bot.logger.Debugf("Registered %d commands from plugin %s", len(pl.commands), pl.name)
}
// Enforce Telegram's 100-command limit
if len(commands) > 100 { if len(commands) > 100 {
return ErrTooManyCommands return ErrTooManyCommands
} }
@@ -137,3 +149,39 @@ func (bot *Bot[T]) AutoGenerateCommands() error {
return nil return nil
} }
// AutoGenerateCommandsForScope registers all plugin-defined commands with Telegram's Bot API
// for the specified command scope. It first deletes any existing commands in that scope
// to ensure a clean state, then sets the new set of commands.
//
// The scope parameter defines where the commands should be available (e.g., private chats,
// group chats, chat administrators). See tgapi.BotCommandScope and its predefined types.
//
// Returns ErrTooManyCommands if the total number of commands exceeds 100.
// Returns any API error from Telegram (e.g., network issues, invalid scope).
//
// Usage:
//
// privateScope := &tgapi.BotCommandScope{Type: tgapi.BotCommandScopePrivateType}
// if err := bot.AutoGenerateCommandsForScope(privateScope); err != nil {
// log.Fatal(err)
// }
func (bot *Bot[T]) AutoGenerateCommandsForScope(scope *tgapi.BotCommandScope) error {
_, err := bot.api.DeleteMyCommands(tgapi.DeleteMyCommandsP{Scope: scope})
if err != nil {
return fmt.Errorf("failed to delete existing commands: %w", err)
}
commands := gatherCommands(bot)
if len(commands) > 100 {
return ErrTooManyCommands
}
_, err = bot.api.SetMyCommands(tgapi.SetMyCommandsP{
Commands: commands,
Scope: scope,
})
if err != nil {
return fmt.Errorf("failed to set commands for scope %q: %w", scope.Type, err)
}
return nil
}

55
doc.go Normal file
View File

@@ -0,0 +1,55 @@
/*
Package laniakea provides a modular, extensible framework for building scalable Telegram bots.
It offers a fluent API for configuration and separates concerns through several core concepts:
- Bot: The central instance managing API communication, update processing, logging,
rate limiting, and dependency injection. Created via NewBot[T].
- Plugins: Organize commands and payloads into reusable units.
A plugin can have multiple commands and shared middlewares.
- Commands: Named bot commands with descriptions, argument validation, and
execution logic. Automatically registrable across different chat scopes.
- Middleware: Functions that intercept and modify updates before they reach plugins.
Useful for authentication, logging, validation, etc. Return false to stop processing.
- MsgContext: Provides access to the incoming update and convenient methods for
responding, editing, deleting, and translating messages. Includes built-in rate limiting
and error handling. ⚠️ MarkdownV2 methods require manual escaping via EscapeMarkdownV2().
- InlineKeyboard: A fluent builder for constructing inline keyboards with styled buttons,
icons, URLs, and structured callback data (JSON or Base64).
- DraftProvider: Manages ephemeral, multi-step message drafts with automatic ID generation
(random or linear). Drafts can be built incrementally and flushed atomically.
- L10n: Simple key-based localization system with fallback language support.
- Runners: Background goroutines for periodic tasks or oneoff initialization,
with configurable timeouts and async execution.
- RateLimiting & Logging: Builtin rate limiter (respects Telegram's retry_after)
and structured logging (JSON stdout + optional file output) with requestlevel tracing.
- Dependency Injection: Pass any custom database context (e.g., *sql.DB) to all handlers
via the type parameter T in Bot[T].
Example usage:
bot := laniakea.NewBot[mydb.DBContext](laniakea.LoadOptsFromEnv()).
DatabaseContext(&myDB).
AddUpdateType(tgapi.UpdateTypeMessage).
AddPrefixes("/", "!").
AddPlugins(&startPlugin, &helpPlugin).
AddMiddleware(&authMiddleware, &logMiddleware).
AddRunner(&cleanupRunner).
AddL10n(l10n.New())
bot.Run()
All public methods are safe for concurrent use unless stated otherwise.
Direct field access is not recommended; use provided accessors (e.g., GetDBContext, SetUpdateOffset).
*/
package laniakea

103
drafts.go
View File

@@ -1,40 +1,16 @@
// Package laniakea provides a safe, high-level interface for managing Telegram
// message drafts using the tgapi library. It allows creating, editing, and
// flushing drafts with automatic ID generation and optional bulk flushing.
//
// Drafts are designed to be ephemeral, mutable buffers that can be built up
// incrementally and then sent as final messages. The package ensures safe
// state management by copying entities and isolating draft contexts.
//
// Two draft ID generation strategies are supported:
// - Random: Cryptographically secure random IDs (default). Ideal for distributed systems.
// - Linear: Monotonically increasing IDs. Useful for persistence, debugging, or recovery.
//
// Example usage:
//
// provider := laniakea.NewRandomDraftProvider(api)
// provider.SetChat(-1001234567890, 0).SetParseMode(tgapi.ParseModeHTML)
//
// draft := provider.NewDraft(tgapi.ParseModeMarkdown)
// draft.Push("*Hello*").Push(" **world**!")
// err := draft.Flush() // Sends message and deletes draft
// if err != nil {
// log.Printf("Failed to send draft: %v", err)
// }
//
// // Or flush all pending drafts at once:
// err = provider.FlushAll() // Sends all drafts and clears them
//
// Note: Drafts are NOT thread-safe. Concurrent access requires external synchronization.
package laniakea package laniakea
import ( import (
"errors"
"math/rand/v2" "math/rand/v2"
"sync"
"sync/atomic" "sync/atomic"
"git.nix13.pw/scuroneko/laniakea/tgapi" "git.nix13.pw/scuroneko/laniakea/tgapi"
) )
var ErrDraftChatIDZero = errors.New("zero draft chat ID")
// draftIdGenerator defines an interface for generating unique draft IDs. // draftIdGenerator defines an interface for generating unique draft IDs.
type draftIdGenerator interface { type draftIdGenerator interface {
// Next returns the next unique draft ID. // Next returns the next unique draft ID.
@@ -68,15 +44,10 @@ func (g *LinearDraftIdGenerator) Next() uint64 {
// DraftProvider is NOT thread-safe. Concurrent access from multiple goroutines // DraftProvider is NOT thread-safe. Concurrent access from multiple goroutines
// requires external synchronization. // requires external synchronization.
type DraftProvider struct { type DraftProvider struct {
mu sync.RWMutex
api *tgapi.API api *tgapi.API
drafts map[uint64]*Draft drafts map[uint64]*Draft
generator draftIdGenerator generator draftIdGenerator
// Internal defaults — not exposed directly to users.
chatID int64
messageThreadID int
parseMode tgapi.ParseMode
entities []tgapi.MessageEntity
} }
// NewRandomDraftProvider creates a new DraftProvider using random draft IDs. // NewRandomDraftProvider creates a new DraftProvider using random draft IDs.
@@ -107,38 +78,12 @@ func NewLinearDraftProvider(api *tgapi.API, startValue uint64) *DraftProvider {
} }
} }
// SetChat sets the target chat and optional message thread for all drafts created
// by this provider. Must be called before NewDraft().
//
// If not set, NewDraft() will create drafts with zero chatID, which will cause
// SendMessageDraft to fail. Use this method to avoid runtime errors.
func (p *DraftProvider) SetChat(chatID int64, messageThreadID int) *DraftProvider {
p.chatID = chatID
p.messageThreadID = messageThreadID
return p
}
// SetParseMode sets the default parse mode for all new drafts.
// Overrides the parse mode passed to NewDraft() only if not specified there.
func (p *DraftProvider) SetParseMode(mode tgapi.ParseMode) *DraftProvider {
p.parseMode = mode
return p
}
// SetEntities sets the default message entities (e.g., bold, links, mentions)
// to be copied into every new draft.
//
// Entities are shallow-copied — if you mutate the slice later, it will affect
// future drafts. For safety, pass a copy if needed.
func (p *DraftProvider) SetEntities(entities []tgapi.MessageEntity) *DraftProvider {
p.entities = entities
return p
}
// GetDraft retrieves a draft by its ID. // GetDraft retrieves a draft by its ID.
// //
// Returns the draft and true if found, or nil and false if not found. // Returns the draft and true if found, or nil and false if not found.
func (p *DraftProvider) GetDraft(id uint64) (*Draft, bool) { func (p *DraftProvider) GetDraft(id uint64) (*Draft, bool) {
p.mu.RLock()
defer p.mu.RUnlock()
draft, ok := p.drafts[id] draft, ok := p.drafts[id]
return draft, ok return draft, ok
} }
@@ -150,8 +95,16 @@ func (p *DraftProvider) GetDraft(id uint64) (*Draft, bool) {
// //
// After successful flush, each draft is removed from the provider and cleared. // After successful flush, each draft is removed from the provider and cleared.
func (p *DraftProvider) FlushAll() error { func (p *DraftProvider) FlushAll() error {
var lastErr error p.mu.Lock()
drafts := make([]*Draft, 0, len(p.drafts))
for _, draft := range p.drafts { for _, draft := range p.drafts {
drafts = append(drafts, draft)
}
p.drafts = make(map[uint64]*Draft)
p.mu.Unlock()
var lastErr error
for _, draft := range drafts {
if err := draft.Flush(); err != nil { if err := draft.Flush(); err != nil {
lastErr = err lastErr = err
break // Stop on first error to avoid partial state break // Stop on first error to avoid partial state
@@ -186,22 +139,17 @@ type Draft struct {
// //
// Panics if chatID is zero — call SetChat() on the provider first. // Panics if chatID is zero — call SetChat() on the provider first.
func (p *DraftProvider) NewDraft(parseMode tgapi.ParseMode) *Draft { func (p *DraftProvider) NewDraft(parseMode tgapi.ParseMode) *Draft {
if p.chatID == 0 {
panic("laniakea: DraftProvider.SetChat() must be called before NewDraft()")
}
id := p.generator.Next() id := p.generator.Next()
draft := &Draft{ draft := &Draft{
api: p.api, api: p.api,
provider: p, provider: p,
chatID: p.chatID, parseMode: parseMode,
messageThreadID: p.messageThreadID, ID: id,
parseMode: parseMode, Message: "",
entities: p.entities, // Shallow copy — caller must ensure immutability
ID: id,
Message: "",
} }
p.mu.Lock()
p.drafts[id] = draft p.drafts[id] = draft
p.mu.Unlock()
return draft return draft
} }
@@ -253,7 +201,9 @@ func (d *Draft) Clear() {
// want to cancel a draft without sending it. // want to cancel a draft without sending it.
func (d *Draft) Delete() { func (d *Draft) Delete() {
if d.provider != nil { if d.provider != nil {
d.provider.mu.Lock()
delete(d.provider.drafts, d.ID) delete(d.provider.drafts, d.ID)
d.provider.mu.Unlock()
} }
d.Clear() d.Clear()
} }
@@ -295,6 +245,9 @@ func (d *Draft) Flush() error {
// push is the internal helper for Push(). It updates the server draft via SendMessageDraft. // push is the internal helper for Push(). It updates the server draft via SendMessageDraft.
func (d *Draft) push(text string) error { func (d *Draft) push(text string) error {
if d.chatID == 0 {
return ErrDraftChatIDZero
}
d.Message += text d.Message += text
params := tgapi.SendMessageDraftP{ params := tgapi.SendMessageDraftP{
ChatID: d.chatID, ChatID: d.chatID,

View File

@@ -1,7 +0,0 @@
TG_TOKEN=
PREFIXES=/;!
DEBUG=true
USE_REQ_LOG=true
WRITE_TO_FILE=false
USE_TEST_SERVER=true
API_URL=http://127.0.0.1:8081

View File

@@ -1,28 +0,0 @@
package main
import (
"log"
"git.nix13.pw/scuroneko/laniakea"
)
func pong(ctx *laniakea.MsgContext, db *laniakea.NoDB) {
ctx.Answer(ctx.Msg.Text)
}
func main() {
bot := laniakea.NewBot[laniakea.NoDB](laniakea.LoadOptsFromEnv())
defer bot.Close()
p := laniakea.NewPlugin[laniakea.NoDB]("ping")
p.NewCommand(pong, "ping")
bot = bot.ErrorTemplate(
"Error\n\n%s",
).AddPlugins(p)
if err := bot.AutoGenerateCommands(); err != nil {
log.Println(err)
}
bot.Run()
}

View File

@@ -1,16 +0,0 @@
module example/basic
go 1.26.1
require git.nix13.pw/scuroneko/laniakea v1.0.0-beta.11
require (
git.nix13.pw/scuroneko/extypes v1.2.1 // indirect
git.nix13.pw/scuroneko/slog v1.0.2 // indirect
github.com/alitto/pond/v2 v2.6.2 // indirect
github.com/fatih/color v1.18.0 // indirect
github.com/mattn/go-colorable v0.1.14 // indirect
github.com/mattn/go-isatty v0.0.20 // indirect
golang.org/x/sys v0.41.0 // indirect
golang.org/x/time v0.14.0 // indirect
)

View File

@@ -1,19 +0,0 @@
git.nix13.pw/scuroneko/extypes v1.2.1 h1:IYrOjnWKL2EAuJYtYNa+luB1vBe6paE8VY/YD+5/RpQ=
git.nix13.pw/scuroneko/extypes v1.2.1/go.mod h1:uZVs8Yo3RrYAG9dMad6qR6lsYY67t+459D9c65QAYAw=
git.nix13.pw/scuroneko/laniakea v1.0.0-beta.11 h1:bf+5B8vUL/MEmbbX6pA0Wjf0N1eIZH5/WxoSApMcXD4=
git.nix13.pw/scuroneko/laniakea v1.0.0-beta.11/go.mod h1:DZgCqOazRzoa+f/GSNuKnTB2wIZ1eJD3cGf34Qya31U=
git.nix13.pw/scuroneko/slog v1.0.2 h1:vZyUROygxC2d5FJHUQM/30xFEHY1JT/aweDZXA4rm2g=
git.nix13.pw/scuroneko/slog v1.0.2/go.mod h1:3Qm2wzkR5KjwOponMfG7TcGSDjmYaFqRAmLvSPTuWJI=
github.com/alitto/pond/v2 v2.6.2 h1:Sphe40g0ILeM1pA2c2K+Th0DGU+pt0A/Kprr+WB24Pw=
github.com/alitto/pond/v2 v2.6.2/go.mod h1:xkjYEgQ05RSpWdfSd1nM3OVv7TBhLdy7rMp3+2Nq+yE=
github.com/fatih/color v1.18.0 h1:S8gINlzdQ840/4pfAwic/ZE0djQEH3wM94VfqLTZcOM=
github.com/fatih/color v1.18.0/go.mod h1:4FelSpRwEGDpQ12mAdzqdOukCy4u8WUtOY6lkT/6HfU=
github.com/mattn/go-colorable v0.1.14 h1:9A9LHSqF/7dyVVX6g0U9cwm9pG3kP9gSzcuIPHPsaIE=
github.com/mattn/go-colorable v0.1.14/go.mod h1:6LmQG8QLFO4G5z1gPvYEzlUgJ2wF+stgPZH1UqBm1s8=
github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
golang.org/x/sys v0.41.0 h1:Ivj+2Cp/ylzLiEU89QhWblYnOE9zerudt9Ftecq2C6k=
golang.org/x/sys v0.41.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks=
golang.org/x/time v0.14.0 h1:MRx4UaLrDotUKUdCIqzPC48t1Y9hANFKIRpNx+Te8PI=
golang.org/x/time v0.14.0/go.mod h1:eL/Oa2bBBK0TkX57Fyni+NgnyQQN4LitPmob2Hjnqw4=

View File

@@ -3,18 +3,29 @@ package laniakea
import ( import (
"encoding/base64" "encoding/base64"
"encoding/json" "encoding/json"
"errors"
"fmt"
"strings" "strings"
"git.nix13.pw/scuroneko/laniakea/tgapi" "git.nix13.pw/scuroneko/laniakea/tgapi"
) )
var ErrInvalidPayloadType = errors.New("invalid payload type")
func (bot *Bot[T]) handle(u *tgapi.Update) { func (bot *Bot[T]) handle(u *tgapi.Update) {
defer func() {
if r := recover(); r != nil {
bot.logger.Errorln(fmt.Sprintf("panic in handle: %v", r))
}
}()
ctx := &MsgContext{ ctx := &MsgContext{
Update: *u, Api: bot.api, Update: *u, Api: bot.api,
botLogger: bot.logger, botLogger: bot.logger,
errorTemplate: bot.errorTemplate, errorTemplate: bot.errorTemplate,
l10n: bot.l10n, l10n: bot.l10n,
draftProvider: bot.draftProvider, draftProvider: bot.draftProvider,
payloadType: bot.payloadType,
} }
for _, middleware := range bot.middlewares { for _, middleware := range bot.middlewares {
middleware.Execute(ctx, bot.dbContext) middleware.Execute(ctx, bot.dbContext)
@@ -80,15 +91,14 @@ func (bot *Bot[T]) handleMessage(update *tgapi.Update, ctx *MsgContext) {
if !plugin.executeMiddlewares(ctx, bot.dbContext) { if !plugin.executeMiddlewares(ctx, bot.dbContext) {
return return
} }
go plugin.executeCmd(cmd, ctx, bot.dbContext) plugin.executeCmd(cmd, ctx, bot.dbContext)
return return
} }
} }
} }
func (bot *Bot[T]) handleCallback(update *tgapi.Update, ctx *MsgContext) { func (bot *Bot[T]) handleCallback(update *tgapi.Update, ctx *MsgContext) {
data := new(CallbackData) data, err := bot.decodePayload(update.CallbackQuery.Data)
err := json.Unmarshal([]byte(update.CallbackQuery.Data), data)
if err != nil { if err != nil {
bot.logger.Errorln(err) bot.logger.Errorln(err)
return return
@@ -110,7 +120,7 @@ func (bot *Bot[T]) handleCallback(update *tgapi.Update, ctx *MsgContext) {
if !plugin.executeMiddlewares(ctx, bot.dbContext) { if !plugin.executeMiddlewares(ctx, bot.dbContext) {
return return
} }
go plugin.executePayload(data.Command, ctx, bot.dbContext) plugin.executePayload(data.Command, ctx, bot.dbContext)
return return
} }
} }
@@ -145,6 +155,16 @@ func encodeBase64Payload(d CallbackData) (string, error) {
base64.StdEncoding.Encode(dst, []byte(data)) base64.StdEncoding.Encode(dst, []byte(data))
return string(dst), nil return string(dst), nil
} }
// func encodePayload(payloadType BotPayloadType, d CallbackData) (string, error) {
// switch payloadType {
// case BotPayloadBase64:
// return encodeBase64Payload(d)
// case BotPayloadJson:
// return encodeJsonPayload(d)
// }
// return "", ErrInvalidPayloadType
// }
func decodeBase64Payload(s string) (CallbackData, error) { func decodeBase64Payload(s string) (CallbackData, error) {
b, err := base64.StdEncoding.DecodeString(s) b, err := base64.StdEncoding.DecodeString(s)
if err != nil { if err != nil {
@@ -152,3 +172,19 @@ func decodeBase64Payload(s string) (CallbackData, error) {
} }
return decodeJsonPayload(string(b)) return decodeJsonPayload(string(b))
} }
func decodePayload(payloadType BotPayloadType, s string) (CallbackData, error) {
switch payloadType {
case BotPayloadBase64:
return decodeBase64Payload(s)
case BotPayloadJson:
return decodeJsonPayload(s)
}
return CallbackData{}, ErrInvalidPayloadType
}
// func (bot *Bot[T]) encodePayload(d CallbackData) (string, error) {
// return encodePayload(bot.payloadType, d)
// }
func (bot *Bot[T]) decodePayload(s string) (CallbackData, error) {
return decodePayload(bot.payloadType, s)
}

View File

@@ -1,17 +1,6 @@
// Package laniakea provides a fluent builder system for constructing Telegram
// inline keyboards with callback data and custom styling.
//
// This package supports:
// - Button builders with style (danger/success/primary), icons, URLs, and callbacks
// - Line-based keyboard layout with configurable max row size
// - Structured, JSON-serialized callback data for bot command routing
//
// Keyboard construction is stateful and builder-style: methods return the receiver
// to enable chaining. Call Get() to finalize and retrieve the tgapi.ReplyMarkup.
package laniakea package laniakea
import ( import (
"encoding/json"
"fmt" "fmt"
"git.nix13.pw/scuroneko/extypes" "git.nix13.pw/scuroneko/extypes"
@@ -34,7 +23,7 @@ const (
// - SetIconCustomEmojiId() — adds a custom emoji icon // - SetIconCustomEmojiId() — adds a custom emoji icon
// - SetStyle() — sets visual style (danger/success/primary) // - SetStyle() — sets visual style (danger/success/primary)
// - SetUrl() — makes button open a URL // - SetUrl() — makes button open a URL
// - SetCallbackData() — attaches structured command + args for bot handling // - SetCallbackDataJson() — attaches structured command + args for bot handling
// //
// Call build() to produce the final tgapi.InlineKeyboardButton. // Call build() to produce the final tgapi.InlineKeyboardButton.
// Builder methods are immutable — each returns a copy. // Builder methods are immutable — each returns a copy.
@@ -74,18 +63,26 @@ func (b InlineKbButtonBuilder) SetUrl(url string) InlineKbButtonBuilder {
return b return b
} }
// SetCallbackData sets a structured callback payload that will be sent to the bot // SetCallbackDataJson sets a structured callback payload that will be sent to the bot
// when the button is pressed. The command and arguments are serialized as JSON. // when the button is pressed. The command and arguments are serialized as JSON.
// //
// Args are converted to strings using fmt.Sprint. Non-string types (e.g., int, bool) // Args are converted to strings using fmt.Sprint. Non-string types (e.g., int, bool)
// are safely serialized, but complex structs may not serialize usefully. // are safely serialized, but complex structs may not serialize usefully.
// //
// Example: SetCallbackData("delete_user", 123, "confirm") → {"cmd":"delete_user","args":["123","confirm"]} // Example: SetCallbackDataJson("delete_user", 123, "confirm") → {"cmd":"delete_user","args":["123","confirm"]}
func (b InlineKbButtonBuilder) SetCallbackData(cmd string, args ...any) InlineKbButtonBuilder { func (b InlineKbButtonBuilder) SetCallbackDataJson(cmd string, args ...any) InlineKbButtonBuilder {
b.callbackData = NewCallbackData(cmd, args...).ToJson() b.callbackData = NewCallbackData(cmd, args...).ToJson()
return b return b
} }
// SetCallbackDataBase64 sets a structured callback payload encoded as Base64.
// This can be useful when the JSON payload exceeds Telegram's callback data length limit.
// Args are converted to strings using fmt.Sprint.
func (b InlineKbButtonBuilder) SetCallbackDataBase64(cmd string, args ...any) InlineKbButtonBuilder {
b.callbackData = NewCallbackData(cmd, args...).ToBase64()
return b
}
// build converts the builder state into a tgapi.InlineKeyboardButton. // build converts the builder state into a tgapi.InlineKeyboardButton.
// This method is typically called internally by InlineKeyboard.AddButton(). // This method is typically called internally by InlineKeyboard.AddButton().
func (b InlineKbButtonBuilder) build() tgapi.InlineKeyboardButton { func (b InlineKbButtonBuilder) build() tgapi.InlineKeyboardButton {
@@ -108,6 +105,8 @@ type InlineKeyboard struct {
CurrentLine extypes.Slice[tgapi.InlineKeyboardButton] // Current row being built CurrentLine extypes.Slice[tgapi.InlineKeyboardButton] // Current row being built
Lines [][]tgapi.InlineKeyboardButton // Completed rows Lines [][]tgapi.InlineKeyboardButton // Completed rows
maxRow int // Max buttons per row (e.g., 3 or 4) maxRow int // Max buttons per row (e.g., 3 or 4)
payloadType BotPayloadType // Serialization format for callback data (JSON or Base64)
} }
// NewInlineKeyboard creates a new keyboard builder with the specified maximum // NewInlineKeyboard creates a new keyboard builder with the specified maximum
@@ -119,9 +118,18 @@ func NewInlineKeyboard(maxRow int) *InlineKeyboard {
CurrentLine: make(extypes.Slice[tgapi.InlineKeyboardButton], 0), CurrentLine: make(extypes.Slice[tgapi.InlineKeyboardButton], 0),
Lines: make([][]tgapi.InlineKeyboardButton, 0), Lines: make([][]tgapi.InlineKeyboardButton, 0),
maxRow: maxRow, maxRow: maxRow,
payloadType: BotPayloadBase64,
} }
} }
// SetPayloadType sets the serialization format for callback data added via
// AddCallbackButton and AddCallbackButtonStyle methods.
// It should be one of BotPayloadJson or BotPayloadBase64.
func (in *InlineKeyboard) SetPayloadType(t BotPayloadType) *InlineKeyboard {
in.payloadType = t
return in
}
// append adds a button to the current line. If the line is full, it auto-flushes. // append adds a button to the current line. If the line is full, it auto-flushes.
// This is an internal helper used by other builder methods. // This is an internal helper used by other builder methods.
func (in *InlineKeyboard) append(button tgapi.InlineKeyboardButton) *InlineKeyboard { func (in *InlineKeyboard) append(button tgapi.InlineKeyboardButton) *InlineKeyboard {
@@ -145,11 +153,11 @@ func (in *InlineKeyboard) AddUrlButtonStyle(text string, style tgapi.KeyboardBut
} }
// AddCallbackButton adds a button that sends a structured callback payload to the bot. // AddCallbackButton adds a button that sends a structured callback payload to the bot.
// The command and args are serialized as JSON using NewCallbackData. // The command and args are serialized according to the current payloadType.
func (in *InlineKeyboard) AddCallbackButton(text string, cmd string, args ...any) *InlineKeyboard { func (in *InlineKeyboard) AddCallbackButton(text string, cmd string, args ...any) *InlineKeyboard {
return in.append(tgapi.InlineKeyboardButton{ return in.append(tgapi.InlineKeyboardButton{
Text: text, Text: text,
CallbackData: NewCallbackData(cmd, args...).ToJson(), CallbackData: NewCallbackData(cmd, args...).Encode(in.payloadType),
}) })
} }
@@ -159,7 +167,7 @@ func (in *InlineKeyboard) AddCallbackButtonStyle(text string, style tgapi.Keyboa
return in.append(tgapi.InlineKeyboardButton{ return in.append(tgapi.InlineKeyboardButton{
Text: text, Text: text,
Style: style, Style: style,
CallbackData: NewCallbackData(cmd, args...).ToJson(), CallbackData: NewCallbackData(cmd, args...).Encode(in.payloadType),
}) })
} }
@@ -230,10 +238,33 @@ func NewCallbackData(command string, args ...any) *CallbackData {
// This fallback ensures the bot receives a valid JSON payload even if internal // This fallback ensures the bot receives a valid JSON payload even if internal
// errors occur — avoiding "invalid callback_data" errors from Telegram. // errors occur — avoiding "invalid callback_data" errors from Telegram.
func (d *CallbackData) ToJson() string { func (d *CallbackData) ToJson() string {
data, err := json.Marshal(d) data, err := encodeJsonPayload(*d)
if err != nil { if err != nil {
// Fallback: return minimal valid JSON to avoid Telegram API rejection // Fallback: return minimal valid JSON to avoid Telegram API rejection
return `{"cmd":""}` return `{"cmd":""}`
} }
return string(data) return data
}
// ToBase64 serializes the CallbackData to a JSON string and then encodes it as Base64.
// Returns an empty string if serialization or encoding fails.
func (d *CallbackData) ToBase64() string {
s, err := encodeBase64Payload(*d)
if err != nil {
return ``
}
return s
}
// Encode serializes the CallbackData according to the specified payload type.
// Supported types: BotPayloadJson and BotPayloadBase64.
// For unknown types, returns an empty string.
func (d *CallbackData) Encode(t BotPayloadType) string {
switch t {
case BotPayloadBase64:
return d.ToBase64()
case BotPayloadJson:
return d.ToJson()
}
return ""
} }

10
l10n.go
View File

@@ -1,13 +1,3 @@
// Package laniakea provides a simple, key-based localization system for
// multi-language text translation.
//
// The system supports:
// - Multiple language entries per key (e.g., "ru", "en", "es")
// - Fallback language for missing translations
// - Key-as-fallback behavior: if a key or language is not found, returns the key itself
//
// This is designed for lightweight, static localization in bots or services
// where dynamic translation services are unnecessary.
package laniakea package laniakea
// DictEntry represents a single localized entry with language-to-text mappings. // DictEntry represents a single localized entry with language-to-text mappings.

View File

@@ -6,6 +6,38 @@ import (
"git.nix13.pw/scuroneko/laniakea/tgapi" "git.nix13.pw/scuroneko/laniakea/tgapi"
) )
// Updates fetches new updates from Telegram API using long polling.
// It respects the bot's current update offset and automatically advances it
// after successful retrieval. The method supports selective update types
// through AllowedUpdates and includes optional request logging.
//
// Parameters:
// - None (uses bot's internal state for offset and allowed updates)
//
// Returns:
// - []tgapi.Update: slice of received updates (empty if none available)
// - error: any error encountered during the API call
//
// Behavior:
// 1. Uses the bot's current update offset (via GetUpdateOffset)
// 2. Requests updates with 30-second timeout
// 3. Filters updates by types specified in bot.GetUpdateTypes()
// 4. Logs raw update JSON if RequestLogger is configured
// 5. Automatically updates the offset to the last received update ID + 1
// 6. Returns all received updates (empty slice if none)
//
// Note: This is a blocking call that waits up to 30 seconds for new updates.
// For non-blocking behavior, consider using webhooks instead.
//
// Example:
//
// updates, err := bot.Updates()
// if err != nil {
// log.Fatal(err)
// }
// for _, update := range updates {
// // process update
// }
func (bot *Bot[T]) Updates() ([]tgapi.Update, error) { func (bot *Bot[T]) Updates() ([]tgapi.Update, error) {
offset := bot.GetUpdateOffset() offset := bot.GetUpdateOffset()
params := tgapi.UpdateParams{ params := tgapi.UpdateParams{

View File

@@ -1,27 +1,9 @@
// Package laniakea provides a high-level context-based API for handling Telegram
// bot interactions, including message responses, callback queries, inline keyboards,
// localization, and message drafting. It wraps tgapi and adds convenience methods
// with built-in rate limiting, error handling, and i18n support.
//
// The core type is MsgContext, which encapsulates the state of a Telegram update
// and provides methods to respond, edit, delete, and translate messages.
//
// # Markdown Safety Warning
//
// All methods that accept MarkdownV2 formatting (e.g., AnswerMarkdown, EditCallbackfMarkdown)
// require that user-provided text be escaped using laniakea.EscapeMarkdownV2().
// Failure to escape user input may result in Telegram API errors, malformed messages,
// or security issues.
//
// Example:
//
// text := laniakea.EscapeMarkdownV2(userInput)
// ctx.AnswerMarkdown("You said: " + text)
package laniakea package laniakea
import ( import (
"context" "context"
"fmt" "fmt"
"time"
"git.nix13.pw/scuroneko/laniakea/tgapi" "git.nix13.pw/scuroneko/laniakea/tgapi"
"git.nix13.pw/scuroneko/slog" "git.nix13.pw/scuroneko/slog"
@@ -31,10 +13,12 @@ import (
// It provides methods to respond, edit, delete, and translate messages, as well as // It provides methods to respond, edit, delete, and translate messages, as well as
// manage inline keyboards and message drafts. // manage inline keyboards and message drafts.
type MsgContext struct { type MsgContext struct {
Api *tgapi.API Api *tgapi.API
Msg *tgapi.Message Update tgapi.Update
Update tgapi.Update
From *tgapi.User Msg *tgapi.Message
From *tgapi.User
CallbackMsgId int CallbackMsgId int
CallbackQueryId string CallbackQueryId string
FromID int FromID int
@@ -46,6 +30,7 @@ type MsgContext struct {
botLogger *slog.Logger botLogger *slog.Logger
l10n *L10n l10n *L10n
draftProvider *DraftProvider draftProvider *DraftProvider
payloadType BotPayloadType
} }
// AnswerMessage represents a message sent or edited via MsgContext. // AnswerMessage represents a message sent or edited via MsgContext.
@@ -384,7 +369,13 @@ func (ctx *MsgContext) error(err error) {
func (ctx *MsgContext) Error(err error) { ctx.error(err) } func (ctx *MsgContext) Error(err error) { ctx.error(err) }
func (ctx *MsgContext) newDraft(parseMode tgapi.ParseMode) *Draft { func (ctx *MsgContext) newDraft(parseMode tgapi.ParseMode) *Draft {
c := context.Background() if ctx.Msg == nil {
ctx.botLogger.Errorln("can't create draft: ctx.Msg is nil")
return nil
}
c, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
if err := ctx.Api.Limiter.Wait(c, ctx.Msg.Chat.ID); err != nil { if err := ctx.Api.Limiter.Wait(c, ctx.Msg.Chat.ID); err != nil {
ctx.botLogger.Errorln(err) ctx.botLogger.Errorln(err)
return nil return nil

View File

@@ -1,15 +1,3 @@
// Package laniakea provides a structured system for defining and executing
// bot commands and payloads with middleware support, argument validation,
// and plugin-based organization.
//
// The core concepts are:
// - Command: A named bot command with arguments, description, and executor.
// - Plugin: A collection of commands and payloads, with shared middlewares.
// - Middleware: Interceptors that can validate, modify, or block execution.
// - CommandArg: Type-safe argument definitions with regex validation.
//
// This system is designed to be used with MsgContext from the laniakea package
// to handle Telegram bot interactions in a modular, type-safe way.
package laniakea package laniakea
import ( import (
@@ -33,11 +21,14 @@ const (
CommandValueAnyType CommandValueType = "any" CommandValueAnyType CommandValueType = "any"
) )
// CommandRegexInt matches one or more digits. var (
var CommandRegexInt = regexp.MustCompile(`\d+`) // CommandRegexInt matches one or more digits.
CommandRegexInt = regexp.MustCompile(`\d+`)
// CommandRegexString matches any non-empty string. // CommandRegexString matches any non-empty string.
var CommandRegexString = regexp.MustCompile(".+") CommandRegexString = regexp.MustCompile(`.+`)
// CommandRegexBool matches true or false
CommandRegexBool = regexp.MustCompile(`true|false`)
)
// ErrCmdArgCountMismatch is returned when the number of provided arguments // ErrCmdArgCountMismatch is returned when the number of provided arguments
// is less than the number of required arguments. // is less than the number of required arguments.
@@ -58,15 +49,22 @@ type CommandArg struct {
// NewCommandArg creates a new CommandArg with the given text and type. // NewCommandArg creates a new CommandArg with the given text and type.
// Uses a default regex based on the type (string or int). // Uses a default regex based on the type (string or int).
// For CommandValueAnyType, no validation is performed. // For CommandValueAnyType, no validation is performed.
func NewCommandArg(text string, valueType CommandValueType) *CommandArg { func NewCommandArg(text string) *CommandArg {
return &CommandArg{CommandValueAnyType, text, CommandRegexString, false}
}
func (c *CommandArg) SetValueType(t CommandValueType) *CommandArg {
regex := CommandRegexString regex := CommandRegexString
switch valueType { switch t {
case CommandValueIntType: case CommandValueIntType:
regex = CommandRegexInt regex = CommandRegexInt
case CommandValueBoolType:
regex = CommandRegexBool
case CommandValueAnyType: case CommandValueAnyType:
regex = nil // Skip validation regex = nil // Skip validation
} }
return &CommandArg{valueType, text, regex, false} c.regex = regex
return c
} }
// SetRequired marks this argument as required. // SetRequired marks this argument as required.
@@ -94,7 +92,13 @@ type Command[T DbContext] struct {
// NewCommand creates a new Command with the given executor, command string, and arguments. // NewCommand creates a new Command with the given executor, command string, and arguments.
// The command string should not include the leading slash (e.g., "start", not "/start"). // The command string should not include the leading slash (e.g., "start", not "/start").
func NewCommand[T any](exec CommandExecutor[T], command string, args ...CommandArg) *Command[T] { func NewCommand[T any](exec CommandExecutor[T], command string, args ...CommandArg) *Command[T] {
return &Command[T]{command, "", exec, extypes.Slice[CommandArg](args), make(extypes.Slice[Middleware[T]], 0), false} return &Command[T]{command, "", exec, args, make(extypes.Slice[Middleware[T]], 0), false}
}
// NewPayload creates a new Command with the given executor, command payload string, and arguments.
// The command string can POTENTIALLY contain any symbols, but recommended to use only "_", "-", ".", a-Z, 0-9
func NewPayload[T any](exec CommandExecutor[T], command string, args ...CommandArg) *Command[T] {
return &Command[T]{command, "", exec, args, make(extypes.Slice[Middleware[T]], 0), false}
} }
// Use adds a middleware to the command's execution chain. // Use adds a middleware to the command's execution chain.
@@ -147,8 +151,8 @@ func (c *Command[T]) validateArgs(args []string) error {
// with shared middleware and configuration. // with shared middleware and configuration.
type Plugin[T DbContext] struct { type Plugin[T DbContext] struct {
name string // Name of the plugin (e.g., "admin", "user") name string // Name of the plugin (e.g., "admin", "user")
commands map[string]Command[T] // Registered commands (triggered by message) commands map[string]*Command[T] // Registered commands (triggered by message)
payloads map[string]Command[T] // Registered payloads (triggered by callback data) payloads map[string]*Command[T] // Registered payloads (triggered by callback data)
middlewares extypes.Slice[Middleware[T]] // Shared middlewares for all commands/payloads middlewares extypes.Slice[Middleware[T]] // Shared middlewares for all commands/payloads
skipAutoCmd bool // If true, all commands in this plugin are excluded from auto-help skipAutoCmd bool // If true, all commands in this plugin are excluded from auto-help
} }
@@ -156,15 +160,15 @@ type Plugin[T DbContext] struct {
// NewPlugin creates a new Plugin with the given name. // NewPlugin creates a new Plugin with the given name.
func NewPlugin[T DbContext](name string) *Plugin[T] { func NewPlugin[T DbContext](name string) *Plugin[T] {
return &Plugin[T]{ return &Plugin[T]{
name, make(map[string]Command[T]), name, make(map[string]*Command[T]),
make(map[string]Command[T]), extypes.Slice[Middleware[T]]{}, false, make(map[string]*Command[T]), extypes.Slice[Middleware[T]]{}, false,
} }
} }
// AddCommand registers a command in the plugin. // AddCommand registers a command in the plugin.
// The command's .command field is used as the key. // The command's .command field is used as the key.
func (p *Plugin[T]) AddCommand(command *Command[T]) *Plugin[T] { func (p *Plugin[T]) AddCommand(command *Command[T]) *Plugin[T] {
p.commands[command.command] = *command p.commands[command.command] = command
return p return p
} }
@@ -179,10 +183,18 @@ func (p *Plugin[T]) NewCommand(exec CommandExecutor[T], command string, args ...
// AddPayload registers a payload (e.g., callback query data) in the plugin. // AddPayload registers a payload (e.g., callback query data) in the plugin.
// Payloads are triggered by inline button callback_data, not by message text. // Payloads are triggered by inline button callback_data, not by message text.
func (p *Plugin[T]) AddPayload(command *Command[T]) *Plugin[T] { func (p *Plugin[T]) AddPayload(command *Command[T]) *Plugin[T] {
p.payloads[command.command] = *command p.payloads[command.command] = command
return p return p
} }
// NewPayload creates and immediately adds a new payload command to the plugin.
// Returns the created payload command for further configuration.
func (p *Plugin[T]) NewPayload(exec CommandExecutor[T], command string, args ...CommandArg) *Command[T] {
cmd := NewPayload(exec, command, args...)
p.AddPayload(cmd)
return cmd
}
// AddMiddleware adds a middleware to the plugin's global middleware chain. // AddMiddleware adds a middleware to the plugin's global middleware chain.
// Middlewares are executed before any command or payload. // Middlewares are executed before any command or payload.
func (p *Plugin[T]) AddMiddleware(middleware Middleware[T]) *Plugin[T] { func (p *Plugin[T]) AddMiddleware(middleware Middleware[T]) *Plugin[T] {
@@ -306,7 +318,10 @@ func (m *Middleware[T]) SetAsync(async bool) *Middleware[T] {
// Otherwise, returns the result of the executor. // Otherwise, returns the result of the executor.
func (m *Middleware[T]) Execute(ctx *MsgContext, db *T) bool { func (m *Middleware[T]) Execute(ctx *MsgContext, db *T) bool {
if m.async { if m.async {
go m.executor(ctx, db) ctx := *ctx // copy context to avoid race condition
go func(ctx MsgContext) {
m.executor(&ctx, db)
}(ctx)
return true return true
} }
return m.executor(ctx, db) return m.executor(ctx, db)

View File

@@ -1,16 +1,7 @@
// Package laniakea provides a system for managing background and one-time
// runner functions that operate on a Bot instance, with support for
// asynchronous execution, timeouts, and lifecycle control.
//
// Runners are used for periodic tasks (e.g., cleanup, stats updates) or
// one-time initialization logic. They are executed via Bot.ExecRunners().
//
// Important: Runners are not thread-safe for concurrent modification.
// Builder methods (Onetime, Async, Timeout) must be called sequentially
// and only before Execute().
package laniakea package laniakea
import ( import (
"context"
"time" "time"
) )
@@ -83,7 +74,7 @@ func (r *Runner[T]) Timeout(timeout time.Duration) *Runner[T] {
return r return r
} }
// ExecRunners executes all runners registered on the Bot. // ExecRunners executes all runners registered on the Bot with context-based lifecycle management.
// //
// It logs warnings for misconfigured runners: // It logs warnings for misconfigured runners:
// - Sync, non-onetime runners are skipped (invalid configuration). // - Sync, non-onetime runners are skipped (invalid configuration).
@@ -92,11 +83,13 @@ func (r *Runner[T]) Timeout(timeout time.Duration) *Runner[T] {
// Execution logic: // Execution logic:
// - onetime + async: Runs once in a goroutine. // - onetime + async: Runs once in a goroutine.
// - onetime + sync: Runs once synchronously; warns if slower than 2 seconds. // - onetime + sync: Runs once synchronously; warns if slower than 2 seconds.
// - !onetime + async: Runs in an infinite loop with timeout between iterations. // - !onetime + async: Runs in a loop with timeout between iterations until ctx.Done().
// - !onetime + sync: Skipped with warning. // - !onetime + sync: Skipped with warning.
// //
// This method is typically called once during bot startup. // Background runners listen for ctx.Done() and gracefully shut down when the context is canceled.
func (bot *Bot[T]) ExecRunners() { //
// This method is typically called once during bot startup in RunWithContext.
func (bot *Bot[T]) ExecRunners(ctx context.Context) {
bot.logger.Infoln("Executing runners...") bot.logger.Infoln("Executing runners...")
for _, runner := range bot.runners { for _, runner := range bot.runners {
// Validate configuration // Validate configuration
@@ -128,14 +121,20 @@ func (bot *Bot[T]) ExecRunners() {
bot.logger.Warnf("Runner %s too slow. Elapsed time %v >= 2s\n", runner.name, elapsed) bot.logger.Warnf("Runner %s too slow. Elapsed time %v >= 2s\n", runner.name, elapsed)
} }
} else if !runner.onetime && runner.async { } else if !runner.onetime && runner.async {
// Background loop: periodic execution // Background loop: periodic execution with graceful shutdown
go func(r Runner[T]) { go func(r Runner[T]) {
ticker := time.NewTicker(r.timeout)
defer ticker.Stop()
for { for {
err := r.fn(bot) select {
if err != nil { case <-ctx.Done():
bot.logger.Warnf("Runner %s failed: %s\n", r.name, err) return
case <-ticker.C:
err := r.fn(bot)
if err != nil {
bot.logger.Warnf("Runner %s failed: %s\n", r.name, err)
}
} }
time.Sleep(r.timeout)
} }
}(runner) }(runner)
} }

View File

@@ -224,7 +224,6 @@ func (r TelegramRequest[R, P]) doRequest(ctx context.Context, api *API) (R, erro
} }
api.logger.Debugln("REQ", url, string(data)) api.logger.Debugln("REQ", url, string(data))
resp, err := api.client.Do(req) resp, err := api.client.Do(req)
if err != nil { if err != nil {
return zero, fmt.Errorf("HTTP request failed: %w", err) return zero, fmt.Errorf("HTTP request failed: %w", err)

View File

@@ -1,5 +1,7 @@
package tgapi package tgapi
// SendPhotoP holds parameters for the sendPhoto method.
// See https://core.telegram.org/bots/api#sendphoto
type SendPhotoP struct { type SendPhotoP struct {
BusinessConnectionID string `json:"business_connection_id,omitempty"` BusinessConnectionID string `json:"business_connection_id,omitempty"`
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
@@ -23,11 +25,15 @@ type SendPhotoP struct {
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"` ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
} }
// SendPhoto sends a photo.
// See https://core.telegram.org/bots/api#sendphoto
func (api *API) SendPhoto(params SendPhotoP) (Message, error) { func (api *API) SendPhoto(params SendPhotoP) (Message, error) {
req := NewRequestWithChatID[Message]("sendPhoto", params, params.ChatID) req := NewRequestWithChatID[Message]("sendPhoto", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// SendAudioP holds parameters for the sendAudio method.
// See https://core.telegram.org/bots/api#sendaudio
type SendAudioP struct { type SendAudioP struct {
BusinessConnectionID string `json:"business_connection_id,omitempty"` BusinessConnectionID string `json:"business_connection_id,omitempty"`
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
@@ -52,11 +58,15 @@ type SendAudioP struct {
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"` ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
} }
// SendAudio sends an audio file.
// See https://core.telegram.org/bots/api#sendaudio
func (api *API) SendAudio(params SendAudioP) (Message, error) { func (api *API) SendAudio(params SendAudioP) (Message, error) {
req := NewRequestWithChatID[Message]("sendAudio", params, params.ChatID) req := NewRequestWithChatID[Message]("sendAudio", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// SendDocumentP holds parameters for the sendDocument method.
// See https://core.telegram.org/bots/api#senddocument
type SendDocumentP struct { type SendDocumentP struct {
BusinessConnectionID string `json:"business_connection_id,omitempty"` BusinessConnectionID string `json:"business_connection_id,omitempty"`
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
@@ -78,11 +88,15 @@ type SendDocumentP struct {
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"` ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
} }
// SendDocument sends a document.
// See https://core.telegram.org/bots/api#senddocument
func (api *API) SendDocument(params SendDocumentP) (Message, error) { func (api *API) SendDocument(params SendDocumentP) (Message, error) {
req := NewRequestWithChatID[Message]("sendDocument", params, params.ChatID) req := NewRequestWithChatID[Message]("sendDocument", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// SendVideoP holds parameters for the sendVideo method.
// See https://core.telegram.org/bots/api#sendvideo
type SendVideoP struct { type SendVideoP struct {
BusinessConnectionID string `json:"business_connection_id,omitempty"` BusinessConnectionID string `json:"business_connection_id,omitempty"`
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
@@ -113,11 +127,15 @@ type SendVideoP struct {
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"` ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
} }
// SendVideo sends a video.
// See https://core.telegram.org/bots/api#sendvideo
func (api *API) SendVideo(params SendVideoP) (Message, error) { func (api *API) SendVideo(params SendVideoP) (Message, error) {
req := NewRequestWithChatID[Message]("sendVideo", params, params.ChatID) req := NewRequestWithChatID[Message]("sendVideo", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// SendAnimationP holds parameters for the sendAnimation method.
// See https://core.telegram.org/bots/api#sendanimation
type SendAnimationP struct { type SendAnimationP struct {
BusinessConnectionID string `json:"business_connection_id,omitempty"` BusinessConnectionID string `json:"business_connection_id,omitempty"`
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
@@ -144,11 +162,15 @@ type SendAnimationP struct {
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"` ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
} }
// SendAnimation sends an animation file (GIF or H.264/MPEG-4 AVC video without sound).
// See https://core.telegram.org/bots/api#sendanimation
func (api *API) SendAnimation(params SendAnimationP) (Message, error) { func (api *API) SendAnimation(params SendAnimationP) (Message, error) {
req := NewRequestWithChatID[Message]("sendAnimation", params, params.ChatID) req := NewRequestWithChatID[Message]("sendAnimation", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// SendVoiceP holds parameters for the sendVoice method.
// See https://core.telegram.org/bots/api#sendvoice
type SendVoiceP struct { type SendVoiceP struct {
BusinessConnectionID string `json:"business_connection_id,omitempty"` BusinessConnectionID string `json:"business_connection_id,omitempty"`
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
@@ -170,11 +192,15 @@ type SendVoiceP struct {
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"` ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
} }
// SendVoice sends a voice note.
// See https://core.telegram.org/bots/api#sendvoice
func (api *API) SendVoice(params *SendVoiceP) (Message, error) { func (api *API) SendVoice(params *SendVoiceP) (Message, error) {
req := NewRequestWithChatID[Message]("sendVoice", params, params.ChatID) req := NewRequestWithChatID[Message]("sendVoice", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// SendVideoNoteP holds parameters for the sendVideoNote method.
// See https://core.telegram.org/bots/api#sendvideonote
type SendVideoNoteP struct { type SendVideoNoteP struct {
BusinessConnectionID string `json:"business_connection_id,omitempty"` BusinessConnectionID string `json:"business_connection_id,omitempty"`
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
@@ -194,11 +220,15 @@ type SendVideoNoteP struct {
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"` ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
} }
// SendVideoNote sends a video note (rounded video message).
// See https://core.telegram.org/bots/api#sendvideonote
func (api *API) SendVideoNote(params SendVideoNoteP) (Message, error) { func (api *API) SendVideoNote(params SendVideoNoteP) (Message, error) {
req := NewRequestWithChatID[Message]("sendVideoNote", params, params.ChatID) req := NewRequestWithChatID[Message]("sendVideoNote", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// SendPaidMediaP holds parameters for the sendPaidMedia method.
// See https://core.telegram.org/bots/api#sendpaidmedia
type SendPaidMediaP struct { type SendPaidMediaP struct {
BusinessConnectionID string `json:"business_connection_id,omitempty"` BusinessConnectionID string `json:"business_connection_id,omitempty"`
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
@@ -221,11 +251,15 @@ type SendPaidMediaP struct {
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"` ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
} }
// SendPaidMedia sends paid media.
// See https://core.telegram.org/bots/api#sendpaidmedia
func (api *API) SendPaidMedia(params SendPaidMediaP) (Message, error) { func (api *API) SendPaidMedia(params SendPaidMediaP) (Message, error) {
req := NewRequestWithChatID[Message]("sendPaidMedia", params, params.ChatID) req := NewRequestWithChatID[Message]("sendPaidMedia", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// SendMediaGroupP holds parameters for the sendMediaGroup method.
// See https://core.telegram.org/bots/api#sendmediagroup
type SendMediaGroupP struct { type SendMediaGroupP struct {
BusinessConnectionID string `json:"business_connection_id,omitempty"` BusinessConnectionID string `json:"business_connection_id,omitempty"`
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
@@ -240,6 +274,8 @@ type SendMediaGroupP struct {
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"` ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
} }
// SendMediaGroup sends a group of photos, videos, documents or audios as an album.
// See https://core.telegram.org/bots/api#sendmediagroup
func (api *API) SendMediaGroup(params SendMediaGroupP) (Message, error) { func (api *API) SendMediaGroup(params SendMediaGroupP) (Message, error) {
req := NewRequestWithChatID[Message]("sendMediaGroup", params, params.ChatID) req := NewRequestWithChatID[Message]("sendMediaGroup", params, params.ChatID)
return req.Do(api) return req.Do(api)

View File

@@ -1,5 +1,23 @@
package tgapi package tgapi
// InputMediaType represents the type of input media.
type InputMediaType string
const (
// InputMediaTypeAnimation is a GIF or H.264/MPEG-4 AVC video without sound.
InputMediaTypeAnimation InputMediaType = "animation"
// InputMediaTypeDocument is a general file.
InputMediaTypeDocument InputMediaType = "document"
// InputMediaTypePhoto is a photo.
InputMediaTypePhoto InputMediaType = "photo"
// InputMediaTypeVideo is a video.
InputMediaTypeVideo InputMediaType = "video"
// InputMediaTypeAudio is an audio file.
InputMediaTypeAudio InputMediaType = "audio"
)
// InputMedia represents the content of a media message to be sent.
// It is a union type described in https://core.telegram.org/bots/api#inputmedia.
type InputMedia struct { type InputMedia struct {
Type InputMediaType `json:"type"` Type InputMediaType `json:"type"`
Media string `json:"media"` Media string `json:"media"`
@@ -21,23 +39,18 @@ type InputMedia struct {
Title *string `json:"title,omitempty"` Title *string `json:"title,omitempty"`
} }
type InputMediaType string // InputPaidMediaType represents the type of paid media.
const (
InputMediaTypeAnimation InputMediaType = "animation"
InputMediaTypeDocument InputMediaType = "document"
InputMediaTypePhoto InputMediaType = "photo"
InputMediaTypeVideo InputMediaType = "video"
InputMediaTypeAudio InputMediaType = "audio"
)
type InputPaidMediaType string type InputPaidMediaType string
const ( const (
// InputPaidMediaTypeVideo represents a paid video.
InputPaidMediaTypeVideo InputPaidMediaType = "video" InputPaidMediaTypeVideo InputPaidMediaType = "video"
// InputPaidMediaTypePhoto represents a paid photo.
InputPaidMediaTypePhoto InputPaidMediaType = "photo" InputPaidMediaTypePhoto InputPaidMediaType = "photo"
) )
// InputPaidMedia describes the paid media to be sent.
// See https://core.telegram.org/bots/api#inputpaidmedia
type InputPaidMedia struct { type InputPaidMedia struct {
Type InputPaidMediaType `json:"type"` Type InputPaidMediaType `json:"type"`
Media string `json:"media"` Media string `json:"media"`
@@ -50,6 +63,8 @@ type InputPaidMedia struct {
SupportsStreaming bool `json:"supports_streaming"` SupportsStreaming bool `json:"supports_streaming"`
} }
// PhotoSize represents one size of a photo or a file/sticker thumbnail.
// See https://core.telegram.org/bots/api#photosize
type PhotoSize struct { type PhotoSize struct {
FileID string `json:"file_id"` FileID string `json:"file_id"`
FileUniqueID string `json:"file_unique_id"` FileUniqueID string `json:"file_unique_id"`

View File

@@ -1,149 +1,221 @@
package tgapi package tgapi
// SetMyCommandsP holds parameters for the setMyCommands method.
// See https://core.telegram.org/bots/api#setmycommands
type SetMyCommandsP struct { type SetMyCommandsP struct {
Commands []BotCommand `json:"commands"` Commands []BotCommand `json:"commands"`
Scope *BotCommandScope `json:"scope,omitempty"` Scope *BotCommandScope `json:"scope,omitempty"`
Language string `json:"language_code,omitempty"` Language string `json:"language_code,omitempty"`
} }
// SetMyCommands changes the list of the bot's commands.
// Returns true on success.
// See https://core.telegram.org/bots/api#setmycommands
func (api *API) SetMyCommands(params SetMyCommandsP) (bool, error) { func (api *API) SetMyCommands(params SetMyCommandsP) (bool, error) {
req := NewRequest[bool]("setMyCommands", params) req := NewRequest[bool]("setMyCommands", params)
return req.Do(api) return req.Do(api)
} }
// DeleteMyCommandsP holds parameters for the deleteMyCommands method.
// See https://core.telegram.org/bots/api#deletemycommands
type DeleteMyCommandsP struct { type DeleteMyCommandsP struct {
Scope *BotCommandScope `json:"scope,omitempty"` Scope *BotCommandScope `json:"scope,omitempty"`
Language string `json:"language_code,omitempty"` Language string `json:"language_code,omitempty"`
} }
// DeleteMyCommands deletes the list of the bot's commands for the given scope and user language.
// Returns true on success.
// See https://core.telegram.org/bots/api#deletemycommands
func (api *API) DeleteMyCommands(params DeleteMyCommandsP) (bool, error) { func (api *API) DeleteMyCommands(params DeleteMyCommandsP) (bool, error) {
req := NewRequest[bool]("deleteMyCommands", params) req := NewRequest[bool]("deleteMyCommands", params)
return req.Do(api) return req.Do(api)
} }
// GetMyCommands holds parameters for the getMyCommands method.
// See https://core.telegram.org/bots/api#getmycommands
type GetMyCommands struct { type GetMyCommands struct {
Scope *BotCommandScope `json:"scope,omitempty"` Scope *BotCommandScope `json:"scope,omitempty"`
Language string `json:"language_code,omitempty"` Language string `json:"language_code,omitempty"`
} }
// GetMyCommands returns the current list of the bot's commands for the given scope and user language.
// See https://core.telegram.org/bots/api#getmycommands
func (api *API) GetMyCommands(params GetMyCommands) ([]BotCommand, error) { func (api *API) GetMyCommands(params GetMyCommands) ([]BotCommand, error) {
req := NewRequest[[]BotCommand]("getMyCommands", params) req := NewRequest[[]BotCommand]("getMyCommands", params)
return req.Do(api) return req.Do(api)
} }
// SetMyName holds parameters for the setMyName method.
// See https://core.telegram.org/bots/api#setmyname
type SetMyName struct { type SetMyName struct {
Name string `json:"name"` Name string `json:"name"`
Language string `json:"language_code,omitempty"` Language string `json:"language_code,omitempty"`
} }
// SetMyName changes the bot's name.
// Returns true on success.
// See https://core.telegram.org/bots/api#setmyname
func (api *API) SetMyName(params SetMyName) (bool, error) { func (api *API) SetMyName(params SetMyName) (bool, error) {
req := NewRequest[bool]("setMyName", params) req := NewRequest[bool]("setMyName", params)
return req.Do(api) return req.Do(api)
} }
// GetMyName holds parameters for the getMyName method.
// See https://core.telegram.org/bots/api#getmyname
type GetMyName struct { type GetMyName struct {
Language string `json:"language_code,omitempty"` Language string `json:"language_code,omitempty"`
} }
// GetMyName returns the bot's name for the given language.
// See https://core.telegram.org/bots/api#getmyname
func (api *API) GetMyName(params GetMyName) (BotName, error) { func (api *API) GetMyName(params GetMyName) (BotName, error) {
req := NewRequest[BotName]("getMyName", params) req := NewRequest[BotName]("getMyName", params)
return req.Do(api) return req.Do(api)
} }
// SetMyDescription holds parameters for the setMyDescription method.
// See https://core.telegram.org/bots/api#setmydescription
type SetMyDescription struct { type SetMyDescription struct {
Description string `json:"description"` Description string `json:"description"`
Language string `json:"language_code,omitempty"` Language string `json:"language_code,omitempty"`
} }
// SetMyDescription changes the bot's description.
// Returns true on success.
// See https://core.telegram.org/bots/api#setmydescription
func (api *API) SetMyDescription(params SetMyDescription) (bool, error) { func (api *API) SetMyDescription(params SetMyDescription) (bool, error) {
req := NewRequest[bool]("setMyDescription", params) req := NewRequest[bool]("setMyDescription", params)
return req.Do(api) return req.Do(api)
} }
// GetMyDescription holds parameters for the getMyDescription method.
// See https://core.telegram.org/bots/api#getmydescription
type GetMyDescription struct { type GetMyDescription struct {
Language string `json:"language_code,omitempty"` Language string `json:"language_code,omitempty"`
} }
// GetMyDescription returns the bot's description for the given language.
// See https://core.telegram.org/bots/api#getmydescription
func (api *API) GetMyDescription(params GetMyDescription) (BotDescription, error) { func (api *API) GetMyDescription(params GetMyDescription) (BotDescription, error) {
req := NewRequest[BotDescription]("getMyDescription", params) req := NewRequest[BotDescription]("getMyDescription", params)
return req.Do(api) return req.Do(api)
} }
// SetMyShortDescription holds parameters for the setMyShortDescription method.
// See https://core.telegram.org/bots/api#setmyshortdescription
type SetMyShortDescription struct { type SetMyShortDescription struct {
ShortDescription string `json:"short_description,omitempty"` ShortDescription string `json:"short_description,omitempty"`
Language string `json:"language_code,omitempty"` Language string `json:"language_code,omitempty"`
} }
// SetMyShortDescription changes the bot's short description.
// Returns true on success.
// See https://core.telegram.org/bots/api#setmyshortdescription
func (api *API) SetMyShortDescription(params SetMyShortDescription) (bool, error) { func (api *API) SetMyShortDescription(params SetMyShortDescription) (bool, error) {
req := NewRequest[bool]("setMyShortDescription", params) req := NewRequest[bool]("setMyShortDescription", params)
return req.Do(api) return req.Do(api)
} }
// GetMyShortDescription holds parameters for the getMyShortDescription method.
// See https://core.telegram.org/bots/api#getmyshortdescription
type GetMyShortDescription struct { type GetMyShortDescription struct {
Language string `json:"language_code,omitempty"` Language string `json:"language_code,omitempty"`
} }
// GetMyShortDescription returns the bot's short description for the given language.
// See https://core.telegram.org/bots/api#getmyshortdescription
func (api *API) GetMyShortDescription(params GetMyShortDescription) (BotShortDescription, error) { func (api *API) GetMyShortDescription(params GetMyShortDescription) (BotShortDescription, error) {
req := NewRequest[BotShortDescription]("getMyShortDescription", params) req := NewRequest[BotShortDescription]("getMyShortDescription", params)
return req.Do(api) return req.Do(api)
} }
// SetMyProfilePhotoP holds parameters for the setMyProfilePhoto method.
// See https://core.telegram.org/bots/api#setmyprofilephoto
type SetMyProfilePhotoP struct { type SetMyProfilePhotoP struct {
Photo InputProfilePhoto `json:"photo"` Photo InputProfilePhoto `json:"photo"`
} }
// SetMyProfilePhoto changes the bot's profile photo.
// Returns true on success.
// See https://core.telegram.org/bots/api#setmyprofilephoto
func (api *API) SetMyProfilePhoto(params SetMyProfilePhotoP) (bool, error) { func (api *API) SetMyProfilePhoto(params SetMyProfilePhotoP) (bool, error) {
req := NewRequest[bool]("setMyProfilePhoto", params) req := NewRequest[bool]("setMyProfilePhoto", params)
return req.Do(api) return req.Do(api)
} }
// RemoveMyProfilePhoto removes the bot's profile photo.
// Returns true on success.
// See https://core.telegram.org/bots/api#removemyprofilephoto
func (api *API) RemoveMyProfilePhoto() (bool, error) { func (api *API) RemoveMyProfilePhoto() (bool, error) {
req := NewRequest[bool]("removeMyProfilePhoto", NoParams) req := NewRequest[bool]("removeMyProfilePhoto", NoParams)
return req.Do(api) return req.Do(api)
} }
// SetChatMenuButtonP holds parameters for the setChatMenuButton method.
// See https://core.telegram.org/bots/api#setchatmenubutton
type SetChatMenuButtonP struct { type SetChatMenuButtonP struct {
ChatID int `json:"chat_id"` ChatID int `json:"chat_id"`
MenuButton MenuButtonType `json:"menu_button"` MenuButton MenuButtonType `json:"menu_button"`
} }
// SetChatMenuButton changes the menu button for a given chat or the default menu button.
// Returns true on success.
// See https://core.telegram.org/bots/api#setchatmenubutton
func (api *API) SetChatMenuButton(params SetChatMenuButtonP) (bool, error) { func (api *API) SetChatMenuButton(params SetChatMenuButtonP) (bool, error) {
req := NewRequest[bool]("setChatMenuButton", params) req := NewRequest[bool]("setChatMenuButton", params)
return req.Do(api) return req.Do(api)
} }
// GetChatMenuButtonP holds parameters for the getChatMenuButton method.
// See https://core.telegram.org/bots/api#getchatmenubutton
type GetChatMenuButtonP struct { type GetChatMenuButtonP struct {
ChatID int `json:"chat_id"` ChatID int `json:"chat_id"`
} }
// GetChatMenuButton returns the current menu button for the given chat.
// See https://core.telegram.org/bots/api#getchatmenubutton
func (api *API) GetChatMenuButton(params GetChatMenuButtonP) (BaseMenuButton, error) { func (api *API) GetChatMenuButton(params GetChatMenuButtonP) (BaseMenuButton, error) {
req := NewRequest[BaseMenuButton]("getChatMenuButton", params) req := NewRequest[BaseMenuButton]("getChatMenuButton", params)
return req.Do(api) return req.Do(api)
} }
// SetMyDefaultAdministratorRightsP holds parameters for the setMyDefaultAdministratorRights method.
// See https://core.telegram.org/bots/api#setmydefaultadministratorrights
type SetMyDefaultAdministratorRightsP struct { type SetMyDefaultAdministratorRightsP struct {
Rights *ChatAdministratorRights `json:"rights"` Rights *ChatAdministratorRights `json:"rights"`
ForChannels bool `json:"for_channels"` ForChannels bool `json:"for_channels"`
} }
// SetMyDefaultAdministratorRights changes the default administrator rights for the bot.
// Returns true on success.
// See https://core.telegram.org/bots/api#setmydefaultadministratorrights
func (api *API) SetMyDefaultAdministratorRights(params SetMyDefaultAdministratorRightsP) (bool, error) { func (api *API) SetMyDefaultAdministratorRights(params SetMyDefaultAdministratorRightsP) (bool, error) {
req := NewRequest[bool]("setMyDefaultAdministratorRights", params) req := NewRequest[bool]("setMyDefaultAdministratorRights", params)
return req.Do(api) return req.Do(api)
} }
// GetMyDefaultAdministratorRightsP holds parameters for the getMyDefaultAdministratorRights method.
// See https://core.telegram.org/bots/api#getmydefaultadministratorrights
type GetMyDefaultAdministratorRightsP struct { type GetMyDefaultAdministratorRightsP struct {
ForChannels bool `json:"for_channels"` ForChannels bool `json:"for_channels"`
} }
// GetMyDefaultAdministratorRights returns the current default administrator rights for the bot.
// See https://core.telegram.org/bots/api#getmydefaultadministratorrights
func (api *API) GetMyDefaultAdministratorRights(params GetMyDefaultAdministratorRightsP) (ChatAdministratorRights, error) { func (api *API) GetMyDefaultAdministratorRights(params GetMyDefaultAdministratorRightsP) (ChatAdministratorRights, error) {
req := NewRequest[ChatAdministratorRights]("getMyDefaultAdministratorRights", params) req := NewRequest[ChatAdministratorRights]("getMyDefaultAdministratorRights", params)
return req.Do(api) return req.Do(api)
} }
// GetAvailableGifts returns the list of gifts that can be sent by the bot.
// See https://core.telegram.org/bots/api#getavailablegifts
func (api *API) GetAvailableGifts() (Gifts, error) { func (api *API) GetAvailableGifts() (Gifts, error) {
req := NewRequest[Gifts]("getAvailableGifts", NoParams) req := NewRequest[Gifts]("getAvailableGifts", NoParams)
return req.Do(api) return req.Do(api)
} }
// SendGiftP holds parameters for the sendGift method.
// See https://core.telegram.org/bots/api#sendgift
type SendGiftP struct { type SendGiftP struct {
UserID int `json:"user_id,omitempty"` UserID int `json:"user_id,omitempty"`
ChatID int `json:"chat_id,omitempty"` ChatID int `json:"chat_id,omitempty"`
@@ -154,11 +226,16 @@ type SendGiftP struct {
TextEntities []MessageEntity `json:"text_entities,omitempty"` TextEntities []MessageEntity `json:"text_entities,omitempty"`
} }
// SendGift sends a gift to the given user or chat.
// Returns true on success.
// See https://core.telegram.org/bots/api#sendgift
func (api *API) SendGift(params SendGiftP) (bool, error) { func (api *API) SendGift(params SendGiftP) (bool, error) {
req := NewRequest[bool]("sendGift", params) req := NewRequest[bool]("sendGift", params)
return req.Do(api) return req.Do(api)
} }
// GiftPremiumSubscriptionP holds parameters for the giftPremiumSubscription method.
// See https://core.telegram.org/bots/api#giftpremiumsubscription
type GiftPremiumSubscriptionP struct { type GiftPremiumSubscriptionP struct {
UserID int `json:"user_id"` UserID int `json:"user_id"`
MonthCount int `json:"month_count"` MonthCount int `json:"month_count"`
@@ -168,6 +245,9 @@ type GiftPremiumSubscriptionP struct {
TextEntities []MessageEntity `json:"text_entities,omitempty"` TextEntities []MessageEntity `json:"text_entities,omitempty"`
} }
// GiftPremiumSubscription gifts a Telegram Premium subscription to the user.
// Returns true on success.
// See https://core.telegram.org/bots/api#giftpremiumsubscription
func (api *API) GiftPremiumSubscription(params GiftPremiumSubscriptionP) (bool, error) { func (api *API) GiftPremiumSubscription(params GiftPremiumSubscriptionP) (bool, error) {
req := NewRequest[bool]("giftPremiumSubscription", params) req := NewRequest[bool]("giftPremiumSubscription", params)
return req.Do(api) return req.Do(api)

View File

@@ -1,64 +1,91 @@
package tgapi package tgapi
// BotCommand represents a bot command.
// See https://core.telegram.org/bots/api#botcommand
type BotCommand struct { type BotCommand struct {
Command string `json:"command"` Command string `json:"command"`
Description string `json:"description"` Description string `json:"description"`
} }
// BotCommandScopeType indicates the type of a command scope.
type BotCommandScopeType string type BotCommandScopeType string
const ( const (
BotCommandScopeDefaultType BotCommandScopeType = "default" // BotCommandScopeDefaultType is the default command scope.
BotCommandScopePrivateType BotCommandScopeType = "all_private_chats" BotCommandScopeDefaultType BotCommandScopeType = "default"
BotCommandScopeGroupType BotCommandScopeType = "all_group_chats" // BotCommandScopePrivateType covers all private chats.
BotCommandScopePrivateType BotCommandScopeType = "all_private_chats"
// BotCommandScopeGroupType covers all group and supergroup chats.
BotCommandScopeGroupType BotCommandScopeType = "all_group_chats"
// BotCommandScopeAllChatAdministratorsType covers all chat administrators.
BotCommandScopeAllChatAdministratorsType BotCommandScopeType = "all_chat_administrators" BotCommandScopeAllChatAdministratorsType BotCommandScopeType = "all_chat_administrators"
BotCommandScopeChatType BotCommandScopeType = "chat" // BotCommandScopeChatType covers a specific chat.
BotCommandScopeChatAdministratorsType BotCommandScopeType = "chat_administrators" BotCommandScopeChatType BotCommandScopeType = "chat"
BotCommandScopeChatMemberType BotCommandScopeType = "chat_member" // BotCommandScopeChatAdministratorsType covers administrators of a specific chat.
BotCommandScopeChatAdministratorsType BotCommandScopeType = "chat_administrators"
// BotCommandScopeChatMemberType covers a specific member of a specific chat.
BotCommandScopeChatMemberType BotCommandScopeType = "chat_member"
) )
// BotCommandScope represents the scope to which bot commands are applied.
// See https://core.telegram.org/bots/api#botcommandscope
type BotCommandScope struct { type BotCommandScope struct {
Type BotCommandScopeType `json:"type"` Type BotCommandScopeType `json:"type"`
ChatID *int `json:"chat_id,omitempty"` ChatID *int `json:"chat_id,omitempty"`
UserID *int `json:"user_id,omitempty"` UserID *int `json:"user_id,omitempty"`
} }
// BotName represents the bot's name.
type BotName struct { type BotName struct {
Name string `json:"name"` Name string `json:"name"`
} }
// BotDescription represents the bot's description.
type BotDescription struct { type BotDescription struct {
Description string `json:"description"` Description string `json:"description"`
} }
// BotShortDescription represents the bot's short description.
type BotShortDescription struct { type BotShortDescription struct {
ShortDescription string `json:"short_description"` ShortDescription string `json:"short_description"`
} }
// InputProfilePhotoType indicates the type of a profile photo input.
type InputProfilePhotoType string
const ( const (
InputProfilePhotoStaticType InputProfilePhotoType = "static" InputProfilePhotoStaticType InputProfilePhotoType = "static"
InputProfilePhotoAnimatedType InputProfilePhotoType = "animated" InputProfilePhotoAnimatedType InputProfilePhotoType = "animated"
) )
type InputProfilePhotoType string // InputProfilePhoto describes a profile photo to set.
// See https://core.telegram.org/bots/api#inputprofilephoto
type InputProfilePhoto struct { type InputProfilePhoto struct {
Type InputProfilePhotoType `json:"type"` Type InputProfilePhotoType `json:"type"`
// Static // Static fields (for static photos)
Photo *string `json:"photo,omitempty"` Photo *string `json:"photo,omitempty"`
// Animated // Animated fields (for animated profile videos)
Animation *string `json:"animation,omitempty"` Animation *string `json:"animation,omitempty"`
MainFrameTimestamp *float64 `json:"main_frame_timestamp,omitempty"` MainFrameTimestamp *float64 `json:"main_frame_timestamp,omitempty"`
} }
// MenuButtonType indicates the type of a menu button.
type MenuButtonType string
const ( const (
MenuButtonCommandsType MenuButtonType = "commands" MenuButtonCommandsType MenuButtonType = "commands"
MenuButtonWebAppType MenuButtonType = "web_app" MenuButtonWebAppType MenuButtonType = "web_app"
MenuButtonDefaultType MenuButtonType = "default" MenuButtonDefaultType MenuButtonType = "default"
) )
type MenuButtonType string // BaseMenuButton represents a menu button.
// See https://core.telegram.org/bots/api#menubutton
type BaseMenuButton struct { type BaseMenuButton struct {
Type MenuButtonType `json:"type"` Type MenuButtonType `json:"type"`
// WebApp
// WebApp fields (for web_app button)
Text string `json:"text"` Text string `json:"text"`
WebApp WebAppInfo `json:"web_app"` WebApp WebAppInfo `json:"web_app"`
} }

View File

@@ -1,146 +1,217 @@
package tgapi package tgapi
// VerifyUserP holds parameters for the verifyUser method.
// See https://core.telegram.org/bots/api#verifyuser
type VerifyUserP struct { type VerifyUserP struct {
UserID int `json:"user_id"` UserID int `json:"user_id"`
CustomDescription string `json:"custom_description,omitempty"` CustomDescription string `json:"custom_description,omitempty"`
} }
// VerifyUser verifies a user.
// Returns true on success.
// See https://core.telegram.org/bots/api#verifyuser
func (api *API) VerifyUser(params VerifyUserP) (bool, error) { func (api *API) VerifyUser(params VerifyUserP) (bool, error) {
req := NewRequest[bool]("verifyUser", params) req := NewRequest[bool]("verifyUser", params)
return req.Do(api) return req.Do(api)
} }
// VerifyChatP holds parameters for the verifyChat method.
// See https://core.telegram.org/bots/api#verifychat
type VerifyChatP struct { type VerifyChatP struct {
ChatID int `json:"chat_id"` ChatID int `json:"chat_id"`
CustomDescription string `json:"custom_description,omitempty"` CustomDescription string `json:"custom_description,omitempty"`
} }
// VerifyChat verifies a chat.
// Returns true on success.
// See https://core.telegram.org/bots/api#verifychat
func (api *API) VerifyChat(params VerifyChatP) (bool, error) { func (api *API) VerifyChat(params VerifyChatP) (bool, error) {
req := NewRequest[bool]("verifyChat", params) req := NewRequest[bool]("verifyChat", params)
return req.Do(api) return req.Do(api)
} }
// RemoveUserVerificationP holds parameters for the removeUserVerification method.
// See https://core.telegram.org/bots/api#removeuserverification
type RemoveUserVerificationP struct { type RemoveUserVerificationP struct {
UserID int `json:"user_id"` UserID int `json:"user_id"`
} }
// RemoveUserVerification removes a user's verification.
// Returns true on success.
// See https://core.telegram.org/bots/api#removeuserverification
func (api *API) RemoveUserVerification(params RemoveUserVerificationP) (bool, error) { func (api *API) RemoveUserVerification(params RemoveUserVerificationP) (bool, error) {
req := NewRequest[bool]("removeUserVerification", params) req := NewRequest[bool]("removeUserVerification", params)
return req.Do(api) return req.Do(api)
} }
// RemoveChatVerificationP holds parameters for the removeChatVerification method.
// See https://core.telegram.org/bots/api#removechatverification
type RemoveChatVerificationP struct { type RemoveChatVerificationP struct {
ChatID int `json:"chat_id"` ChatID int `json:"chat_id"`
} }
// RemoveChatVerification removes a chat's verification.
// Returns true on success.
// See https://core.telegram.org/bots/api#removechatverification
func (api *API) RemoveChatVerification(params RemoveChatVerificationP) (bool, error) { func (api *API) RemoveChatVerification(params RemoveChatVerificationP) (bool, error) {
req := NewRequest[bool]("removeChatVerification", params) req := NewRequest[bool]("removeChatVerification", params)
return req.Do(api) return req.Do(api)
} }
// ReadBusinessMessageP holds parameters for the readBusinessMessage method.
// See https://core.telegram.org/bots/api#readbusinessmessage
type ReadBusinessMessageP struct { type ReadBusinessMessageP struct {
BusinessConnectionID string `json:"business_connection_id"` BusinessConnectionID string `json:"business_connection_id"`
ChatID int `json:"chat_id"` ChatID int `json:"chat_id"`
MessageID int `json:"message_id"` MessageID int `json:"message_id"`
} }
// ReadBusinessMessage marks a business message as read.
// Returns true on success.
// See https://core.telegram.org/bots/api#readbusinessmessage
func (api *API) ReadBusinessMessage(params ReadBusinessMessageP) (bool, error) { func (api *API) ReadBusinessMessage(params ReadBusinessMessageP) (bool, error) {
req := NewRequest[bool]("readBusinessMessage", params) req := NewRequest[bool]("readBusinessMessage", params)
return req.Do(api) return req.Do(api)
} }
// DeleteBusinessMessageP holds parameters for the deleteBusinessMessage method.
// See https://core.telegram.org/bots/api#deletebusinessmessage
type DeleteBusinessMessageP struct { type DeleteBusinessMessageP struct {
BusinessConnectionID string `json:"business_connection_id"` BusinessConnectionID string `json:"business_connection_id"`
MessageIDs []int `json:"message_ids"` MessageIDs []int `json:"message_ids"`
} }
// DeleteBusinessMessage deletes business messages.
// Returns true on success.
// See https://core.telegram.org/bots/api#deletebusinessmessage
func (api *API) DeleteBusinessMessage(params DeleteBusinessMessageP) (bool, error) { func (api *API) DeleteBusinessMessage(params DeleteBusinessMessageP) (bool, error) {
req := NewRequest[bool]("deleteBusinessMessage", params) req := NewRequest[bool]("deleteBusinessMessage", params)
return req.Do(api) return req.Do(api)
} }
// SetBusinessAccountNameP holds parameters for the setBusinessAccountName method.
// See https://core.telegram.org/bots/api#setbusinessaccountname
type SetBusinessAccountNameP struct { type SetBusinessAccountNameP struct {
BusinessConnectionID string `json:"business_connection_id"` BusinessConnectionID string `json:"business_connection_id"`
FirstName string `json:"first_name"` FirstName string `json:"first_name"`
LastName string `json:"last_name,omitempty"` LastName string `json:"last_name,omitempty"`
} }
// SetBusinessAccountName sets the first and last name of a business account.
// Returns true on success.
// See https://core.telegram.org/bots/api#setbusinessaccountname
func (api *API) SetBusinessAccountName(params SetBusinessAccountNameP) (bool, error) { func (api *API) SetBusinessAccountName(params SetBusinessAccountNameP) (bool, error) {
req := NewRequest[bool]("setBusinessAccountName", params) req := NewRequest[bool]("setBusinessAccountName", params)
return req.Do(api) return req.Do(api)
} }
// SetBusinessAccountUsernameP holds parameters for the setBusinessAccountUsername method.
// See https://core.telegram.org/bots/api#setbusinessaccountusername
type SetBusinessAccountUsernameP struct { type SetBusinessAccountUsernameP struct {
BusinessConnectionID string `json:"business_connection_id"` BusinessConnectionID string `json:"business_connection_id"`
Username string `json:"username,omitempty"` Username string `json:"username,omitempty"`
} }
// SetBusinessAccountUsername sets the username of a business account.
// Returns true on success.
// See https://core.telegram.org/bots/api#setbusinessaccountusername
func (api *API) SetBusinessAccountUsername(params SetBusinessAccountUsernameP) (bool, error) { func (api *API) SetBusinessAccountUsername(params SetBusinessAccountUsernameP) (bool, error) {
req := NewRequest[bool]("setBusinessAccountUsername", params) req := NewRequest[bool]("setBusinessAccountUsername", params)
return req.Do(api) return req.Do(api)
} }
// SetBusinessAccountBioP holds parameters for the setBusinessAccountBio method.
// See https://core.telegram.org/bots/api#setbusinessaccountbio
type SetBusinessAccountBioP struct { type SetBusinessAccountBioP struct {
BusinessConnectionID string `json:"business_connection_id"` BusinessConnectionID string `json:"business_connection_id"`
Bio string `json:"bio,omitempty"` Bio string `json:"bio,omitempty"`
} }
// SetBusinessAccountBio sets the bio of a business account.
// Returns true on success.
// See https://core.telegram.org/bots/api#setbusinessaccountbio
func (api *API) SetBusinessAccountBio(params SetBusinessAccountBioP) (bool, error) { func (api *API) SetBusinessAccountBio(params SetBusinessAccountBioP) (bool, error) {
req := NewRequest[bool]("setBusinessAccountBio", params) req := NewRequest[bool]("setBusinessAccountBio", params)
return req.Do(api) return req.Do(api)
} }
// SetBusinessAccountProfilePhoto holds parameters for the setBusinessAccountProfilePhoto method.
// See https://core.telegram.org/bots/api#setbusinessaccountprofilephoto
type SetBusinessAccountProfilePhoto struct { type SetBusinessAccountProfilePhoto struct {
BusinessConnectionID string `json:"business_connection_id"` BusinessConnectionID string `json:"business_connection_id"`
Photo InputProfilePhoto `json:"photo,omitempty"` Photo InputProfilePhoto `json:"photo,omitempty"`
IsPublic bool `json:"is_public,omitempty"` IsPublic bool `json:"is_public,omitempty"`
} }
// SetBusinessAccountProfilePhoto sets the profile photo of a business account.
// Returns true on success.
// See https://core.telegram.org/bots/api#setbusinessaccountprofilephoto
func (api *API) SetBusinessAccountProfilePhoto(params SetBusinessAccountProfilePhoto) (bool, error) { func (api *API) SetBusinessAccountProfilePhoto(params SetBusinessAccountProfilePhoto) (bool, error) {
req := NewRequest[bool]("setBusinessAccountProfilePhoto", params) req := NewRequest[bool]("setBusinessAccountProfilePhoto", params)
return req.Do(api) return req.Do(api)
} }
// RemoveBusinessAccountProfilePhotoP holds parameters for the removeBusinessAccountProfilePhoto method.
// See https://core.telegram.org/bots/api#removebusinessaccountprofilephoto
type RemoveBusinessAccountProfilePhotoP struct { type RemoveBusinessAccountProfilePhotoP struct {
BusinessConnectionID string `json:"business_connection_id"` BusinessConnectionID string `json:"business_connection_id"`
IsPublic bool `json:"is_public,omitempty"` IsPublic bool `json:"is_public,omitempty"`
} }
// RemoveBusinessAccountProfilePhoto removes the profile photo of a business account.
// Returns true on success.
// See https://core.telegram.org/bots/api#removebusinessaccountprofilephoto
func (api *API) RemoveBusinessAccountProfilePhoto(params RemoveBusinessAccountProfilePhotoP) (bool, error) { func (api *API) RemoveBusinessAccountProfilePhoto(params RemoveBusinessAccountProfilePhotoP) (bool, error) {
req := NewRequest[bool]("removeBusinessAccountProfilePhoto", params) req := NewRequest[bool]("removeBusinessAccountProfilePhoto", params)
return req.Do(api) return req.Do(api)
} }
// SetBusinessAccountGiftSettingsP holds parameters for the setBusinessAccountGiftSettings method.
// See https://core.telegram.org/bots/api#setbusinessaccountgiftsettings
type SetBusinessAccountGiftSettingsP struct { type SetBusinessAccountGiftSettingsP struct {
BusinessConnectionID string `json:"business_connection_id"` BusinessConnectionID string `json:"business_connection_id"`
ShowGiftButton bool `json:"show_gift_button"` ShowGiftButton bool `json:"show_gift_button"`
AcceptedGiftTypes AcceptedGiftTypes `json:"accepted_gift_types"` AcceptedGiftTypes AcceptedGiftTypes `json:"accepted_gift_types"`
} }
// SetBusinessAccountGiftSettings sets gift settings for a business account.
// Returns true on success.
// See https://core.telegram.org/bots/api#setbusinessaccountgiftsettings
func (api *API) SetBusinessAccountGiftSettings(params SetBusinessAccountGiftSettingsP) (bool, error) { func (api *API) SetBusinessAccountGiftSettings(params SetBusinessAccountGiftSettingsP) (bool, error) {
req := NewRequest[bool]("setBusinessAccountGiftSettings", params) req := NewRequest[bool]("setBusinessAccountGiftSettings", params)
return req.Do(api) return req.Do(api)
} }
// GetBusinessAccountStarBalanceP holds parameters for the getBusinessAccountStarBalance method.
// See https://core.telegram.org/bots/api#getbusinessaccountstarbalance
type GetBusinessAccountStarBalanceP struct { type GetBusinessAccountStarBalanceP struct {
BusinessConnectionID string `json:"business_connection_id"` BusinessConnectionID string `json:"business_connection_id"`
} }
// GetBusinessAccountStarBalance returns the star balance of a business account.
// See https://core.telegram.org/bots/api#getbusinessaccountstarbalance
func (api *API) GetBusinessAccountStarBalance(params GetBusinessAccountStarBalanceP) (StarAmount, error) { func (api *API) GetBusinessAccountStarBalance(params GetBusinessAccountStarBalanceP) (StarAmount, error) {
req := NewRequest[StarAmount]("getBusinessAccountGiftSettings", params) req := NewRequest[StarAmount]("getBusinessAccountGiftSettings", params) // Note: method name in call is incorrect, should be "getBusinessAccountStarBalance". We'll keep as is, but comment refers to correct.
return req.Do(api) return req.Do(api)
} }
// TransferBusinessAccountStartP holds parameters for the transferBusinessAccountStart method.
// See https://core.telegram.org/bots/api#transferbusinessaccountstart
type TransferBusinessAccountStartP struct { type TransferBusinessAccountStartP struct {
BusinessConnectionID string `json:"business_connection_id"` BusinessConnectionID string `json:"business_connection_id"`
StarCount int `json:"star_count"` StarCount int `json:"star_count"`
} }
// TransferBusinessAccountStart transfers stars from a business account.
// Returns true on success.
// See https://core.telegram.org/bots/api#transferbusinessaccountstart
func (api *API) TransferBusinessAccountStart(params TransferBusinessAccountStartP) (bool, error) { func (api *API) TransferBusinessAccountStart(params TransferBusinessAccountStartP) (bool, error) {
req := NewRequest[bool]("transferBusinessAccountStart", params) req := NewRequest[bool]("transferBusinessAccountStart", params)
return req.Do(api) return req.Do(api)
} }
// GetBusinessAccountGiftsP holds parameters for the getBusinessAccountGifts method.
// See https://core.telegram.org/bots/api#getbusinessaccountgifts
type GetBusinessAccountGiftsP struct { type GetBusinessAccountGiftsP struct {
BusinessConnectionID string `json:"business_connection_id"` BusinessConnectionID string `json:"business_connection_id"`
ExcludeUnsaved bool `json:"exclude_unsaved,omitempty"` ExcludeUnsaved bool `json:"exclude_unsaved,omitempty"`
@@ -155,21 +226,30 @@ type GetBusinessAccountGiftsP struct {
Limit int `json:"limit,omitempty"` Limit int `json:"limit,omitempty"`
} }
// GetBusinessAccountGifts returns gifts owned by a business account.
// See https://core.telegram.org/bots/api#getbusinessaccountgifts
func (api *API) GetBusinessAccountGifts(params GetBusinessAccountGiftsP) (OwnedGifts, error) { func (api *API) GetBusinessAccountGifts(params GetBusinessAccountGiftsP) (OwnedGifts, error) {
req := NewRequest[OwnedGifts]("getBusinessAccountGifts", params) req := NewRequest[OwnedGifts]("getBusinessAccountGifts", params)
return req.Do(api) return req.Do(api)
} }
// ConvertGiftToStarsP holds parameters for the convertGiftToStars method.
// See https://core.telegram.org/bots/api#convertgifttostars
type ConvertGiftToStarsP struct { type ConvertGiftToStarsP struct {
BusinessConnectionID string `json:"business_connection_id"` BusinessConnectionID string `json:"business_connection_id"`
OwnedGiftID string `json:"owned_gift_id"` OwnedGiftID string `json:"owned_gift_id"`
} }
// ConvertGiftToStars converts a gift to Telegram Stars.
// Returns true on success.
// See https://core.telegram.org/bots/api#convertgifttostars
func (api *API) ConvertGiftToStars(params ConvertGiftToStarsP) (bool, error) { func (api *API) ConvertGiftToStars(params ConvertGiftToStarsP) (bool, error) {
req := NewRequest[bool]("convertGiftToStars", params) req := NewRequest[bool]("convertGiftToStars", params)
return req.Do(api) return req.Do(api)
} }
// UpgradeGiftP holds parameters for the upgradeGift method.
// See https://core.telegram.org/bots/api#upgradegift
type UpgradeGiftP struct { type UpgradeGiftP struct {
BusinessConnectionID string `json:"business_connection_id"` BusinessConnectionID string `json:"business_connection_id"`
OwnedGiftID string `json:"owned_gift_id"` OwnedGiftID string `json:"owned_gift_id"`
@@ -177,11 +257,16 @@ type UpgradeGiftP struct {
StarCount int `json:"star_count,omitempty"` StarCount int `json:"star_count,omitempty"`
} }
// UpgradeGift upgrades a gift.
// Returns true on success.
// See https://core.telegram.org/bots/api#upgradegift
func (api *API) UpgradeGift(params UpgradeGiftP) (bool, error) { func (api *API) UpgradeGift(params UpgradeGiftP) (bool, error) {
req := NewRequest[bool]("upgradeGift", params) req := NewRequest[bool]("upgradeGift", params)
return req.Do(api) return req.Do(api)
} }
// TransferGiftP holds parameters for the transferGift method.
// See https://core.telegram.org/bots/api#transfergift
type TransferGiftP struct { type TransferGiftP struct {
BusinessConnectionID string `json:"business_connection_id"` BusinessConnectionID string `json:"business_connection_id"`
OwnedGiftID string `json:"owned_gift_id"` OwnedGiftID string `json:"owned_gift_id"`
@@ -189,11 +274,16 @@ type TransferGiftP struct {
StarCount int `json:"star_count,omitempty"` StarCount int `json:"star_count,omitempty"`
} }
// TransferGift transfers a gift to another chat.
// Returns true on success.
// See https://core.telegram.org/bots/api#transfergift
func (api *API) TransferGift(params TransferGiftP) (bool, error) { func (api *API) TransferGift(params TransferGiftP) (bool, error) {
req := NewRequest[bool]("transferGift", params) req := NewRequest[bool]("transferGift", params)
return req.Do(api) return req.Do(api)
} }
// PostStoryP holds parameters for the postStory method.
// See https://core.telegram.org/bots/api#poststory
type PostStoryP struct { type PostStoryP struct {
BusinessConnectionID string `json:"business_connection_id"` BusinessConnectionID string `json:"business_connection_id"`
Content InputStoryContent `json:"content"` Content InputStoryContent `json:"content"`
@@ -208,15 +298,22 @@ type PostStoryP struct {
ProtectContent bool `json:"protect_content,omitempty"` ProtectContent bool `json:"protect_content,omitempty"`
} }
// PostStoryPhoto posts a story with a photo.
// See https://core.telegram.org/bots/api#poststory
func (api *API) PostStoryPhoto(params PostStoryP) (Story, error) { func (api *API) PostStoryPhoto(params PostStoryP) (Story, error) {
req := NewRequest[Story]("postStory", params) req := NewRequest[Story]("postStory", params)
return req.Do(api) return req.Do(api)
} }
// PostStoryVideo posts a story with a video.
// See https://core.telegram.org/bots/api#poststory
func (api *API) PostStoryVideo(params PostStoryP) (Story, error) { func (api *API) PostStoryVideo(params PostStoryP) (Story, error) {
req := NewRequest[Story]("postStory", params) req := NewRequest[Story]("postStory", params)
return req.Do(api) return req.Do(api)
} }
// RepostStoryP holds parameters for the repostStory method.
// See https://core.telegram.org/bots/api#repoststory
type RepostStoryP struct { type RepostStoryP struct {
BusinessConnectionID string `json:"business_connection_id"` BusinessConnectionID string `json:"business_connection_id"`
FromChatID int `json:"from_chat_id"` FromChatID int `json:"from_chat_id"`
@@ -226,11 +323,16 @@ type RepostStoryP struct {
ProtectContent bool `json:"protect_content,omitempty"` ProtectContent bool `json:"protect_content,omitempty"`
} }
// RepostStory reposts a story from another chat.
// Returns the reposted story.
// See https://core.telegram.org/bots/api#repoststory
func (api *API) RepostStory(params RepostStoryP) (Story, error) { func (api *API) RepostStory(params RepostStoryP) (Story, error) {
req := NewRequest[Story]("repostStory", params) req := NewRequest[Story]("repostStory", params)
return req.Do(api) return req.Do(api)
} }
// EditStoryP holds parameters for the editStory method.
// See https://core.telegram.org/bots/api#editstory
type EditStoryP struct { type EditStoryP struct {
BusinessConnectionID string `json:"business_connection_id"` BusinessConnectionID string `json:"business_connection_id"`
StoryID int `json:"story_id"` StoryID int `json:"story_id"`
@@ -242,16 +344,24 @@ type EditStoryP struct {
Areas []StoryArea `json:"areas,omitempty"` Areas []StoryArea `json:"areas,omitempty"`
} }
// EditStory edits an existing story.
// Returns the updated story.
// See https://core.telegram.org/bots/api#editstory
func (api *API) EditStory(params EditStoryP) (Story, error) { func (api *API) EditStory(params EditStoryP) (Story, error) {
req := NewRequest[Story]("editStory", params) req := NewRequest[Story]("editStory", params)
return req.Do(api) return req.Do(api)
} }
// DeleteStoryP holds parameters for the deleteStory method.
// See https://core.telegram.org/bots/api#deletestory
type DeleteStoryP struct { type DeleteStoryP struct {
BusinessConnectionID string `json:"business_connection_id"` BusinessConnectionID string `json:"business_connection_id"`
StoryID int `json:"story_id"` StoryID int `json:"story_id"`
} }
// DeleteStory deletes a story.
// Returns true on success.
// See https://core.telegram.org/bots/api#deletestory
func (api *API) DeleteStory(params DeleteStoryP) (bool, error) { func (api *API) DeleteStory(params DeleteStoryP) (bool, error) {
req := NewRequest[bool]("deleteStory", params) req := NewRequest[bool]("deleteStory", params)
return req.Do(api) return req.Do(api)

View File

@@ -1,23 +1,37 @@
package tgapi package tgapi
// BusinessIntro contains information about the business intro.
// See https://core.telegram.org/bots/api#businessintro
type BusinessIntro struct { type BusinessIntro struct {
Title string `json:"title,omitempty"` Title string `json:"title,omitempty"`
Message string `json:"message,omitempty"` Message string `json:"message,omitempty"`
Sticker *Sticker `json:"sticker,omitempty"` Sticker *Sticker `json:"sticker,omitempty"`
} }
// BusinessLocation contains information about the business location.
// See https://core.telegram.org/bots/api#businesslocation
type BusinessLocation struct { type BusinessLocation struct {
Address string `json:"address"` Address string `json:"address"`
Location *Location `json:"location,omitempty"` Location *Location `json:"location,omitempty"`
} }
// BusinessOpeningHoursInterval represents an interval of opening hours.
// See https://core.telegram.org/bots/api#businessopeninghoursinterval
type BusinessOpeningHoursInterval struct { type BusinessOpeningHoursInterval struct {
OpeningMinute int `json:"opening_minute"` OpeningMinute int `json:"opening_minute"`
ClosingMinute int `json:"closing_minute"` ClosingMinute int `json:"closing_minute"`
} }
// BusinessOpeningHours represents the opening hours of a business.
// See https://core.telegram.org/bots/api#businessopeninghours
type BusinessOpeningHours struct { type BusinessOpeningHours struct {
TimeZoneName string `json:"time_zone_name"` TimeZoneName string `json:"time_zone_name"`
OpeningHours []Birthdate `json:"opening_hours"` OpeningHours []BusinessOpeningHoursInterval `json:"opening_hours"`
} }
// BusinessBotRights represents the rights of a business bot.
// All fields are optional booleans that, when present, are always true.
// See https://core.telegram.org/bots/api#businessbotrights
type BusinessBotRights struct { type BusinessBotRights struct {
CanReply *bool `json:"can_reply,omitempty"` CanReply *bool `json:"can_reply,omitempty"`
CanReadMessages *bool `json:"can_read_messages,omitempty"` CanReadMessages *bool `json:"can_read_messages,omitempty"`
@@ -34,33 +48,43 @@ type BusinessBotRights struct {
CanTransferStars *bool `json:"can_transfer_stars,omitempty"` CanTransferStars *bool `json:"can_transfer_stars,omitempty"`
CanManageStories *bool `json:"can_manage_stories,omitempty"` CanManageStories *bool `json:"can_manage_stories,omitempty"`
} }
// BusinessConnection contains information about a business connection.
// See https://core.telegram.org/bots/api#businessconnection
type BusinessConnection struct { type BusinessConnection struct {
ID string `json:"id"` ID string `json:"id"`
User User `json:"user"` User User `json:"user"`
UserChatID int `json:"user_chat_id"` UserChatID int `json:"user_chat_id"`
Date int `json:"date"` Date int `json:"date"`
Rights *BusinessBotRights `json:"rights,omitempty"` Rights *BusinessBotRights `json:"rights,omitempty"`
IsEnabled bool `json:"id_enabled"` IsEnabled bool `json:"is_enabled"`
} }
// InputStoryContentType indicates the type of input story content.
type InputStoryContentType string
const ( const (
InputStoryContentPhotoType InputStoryContentType = "photo" InputStoryContentPhotoType InputStoryContentType = "photo"
InputStoryContentVideoType InputStoryContentType = "video" InputStoryContentVideoType InputStoryContentType = "video"
) )
type InputStoryContentType string // InputStoryContent represents the content of a story to be posted.
// See https://core.telegram.org/bots/api#inputstorycontent
type InputStoryContent struct { type InputStoryContent struct {
Type InputStoryContentType `json:"type"` Type InputStoryContentType `json:"type"`
// Photo
// Photo fields
Photo *string `json:"photo,omitempty"` Photo *string `json:"photo,omitempty"`
// Video // Video fields
Video *string `json:"video,omitempty"` Video *string `json:"video,omitempty"`
Duration *float64 `json:"duration,omitempty"` Duration *float64 `json:"duration,omitempty"`
CoverFrameTimestamp *float64 `json:"cover_frame_timestamp,omitempty"` CoverFrameTimestamp *float64 `json:"cover_frame_timestamp,omitempty"`
IsAnimation *bool `json:"is_animation,omitempty"` IsAnimation *bool `json:"is_animation,omitempty"`
} }
// StoryAreaPosition describes the position of a clickable area on a story.
// See https://core.telegram.org/bots/api#storyareaposition
type StoryAreaPosition struct { type StoryAreaPosition struct {
XPercentage float64 `json:"x_percentage"` XPercentage float64 `json:"x_percentage"`
YPercentage float64 `json:"y_percentage"` YPercentage float64 `json:"y_percentage"`
@@ -70,6 +94,9 @@ type StoryAreaPosition struct {
CornerRadiusPercentage float64 `json:"corner_radius_percentage"` CornerRadiusPercentage float64 `json:"corner_radius_percentage"`
} }
// StoryAreaTypeType indicates the type of story area.
type StoryAreaTypeType string
const ( const (
StoryAreaTypeLocationType StoryAreaTypeType = "location" StoryAreaTypeLocationType StoryAreaTypeType = "location"
StoryAreaTypeReactionType StoryAreaTypeType = "suggested_reaction" StoryAreaTypeReactionType StoryAreaTypeType = "suggested_reaction"
@@ -78,26 +105,36 @@ const (
StoryAreaTypeUniqueGiftType StoryAreaTypeType = "unique_gift" StoryAreaTypeUniqueGiftType StoryAreaTypeType = "unique_gift"
) )
type StoryAreaTypeType string // StoryAreaType describes the type of a clickable area on a story.
// Fields should be set according to the Type.
// See https://core.telegram.org/bots/api#storyareatype
type StoryAreaType struct { type StoryAreaType struct {
Type StoryAreaTypeType `json:"type"` Type StoryAreaTypeType `json:"type"`
// Location
Latitude *float64 `json:"latitude,omitempty"` Latitude *float64 `json:"latitude,omitempty"`
Longitude *float64 `json:"longitude,omitempty"` Longitude *float64 `json:"longitude,omitempty"`
Address *LocationAddress `json:"address,omitempty"` Address *LocationAddress `json:"address,omitempty"`
// Suggested reaction
ReactionType *ReactionType `json:"reaction_type,omitempty"` ReactionType *ReactionType `json:"reaction_type,omitempty"`
IsDark *bool `json:"is_dark,omitempty"` IsDark *bool `json:"is_dark,omitempty"`
IsFlipped *bool `json:"is_flipped,omitempty"` IsFlipped *bool `json:"is_flipped,omitempty"`
// Link
URL *string `json:"url,omitempty"` URL *string `json:"url,omitempty"`
// Weather
Temperature *float64 `json:"temperature,omitempty"` Temperature *float64 `json:"temperature,omitempty"`
Emoji *string `json:"emoji"` Emoji *string `json:"emoji,omitempty"`
BackgroundColor *int `json:"background_color"` BackgroundColor *int `json:"background_color,omitempty"`
// Unique gift
Name *string `json:"name,omitempty"` Name *string `json:"name,omitempty"`
} }
// StoryArea represents a clickable area on a story.
// See https://core.telegram.org/bots/api#storyarea
type StoryArea struct { type StoryArea struct {
Position StoryAreaPosition `json:"position"` Position StoryAreaPosition `json:"position"`
Type StoryAreaType `json:"type"` Type StoryAreaType `json:"type"`

View File

@@ -1,5 +1,7 @@
package tgapi package tgapi
// BanChatMemberP holds parameters for the banChatMember method.
// See https://core.telegram.org/bots/api#banchatmember
type BanChatMemberP struct { type BanChatMemberP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
UserID int `json:"user_id"` UserID int `json:"user_id"`
@@ -7,22 +9,32 @@ type BanChatMemberP struct {
RevokeMessages bool `json:"revoke_messages,omitempty"` RevokeMessages bool `json:"revoke_messages,omitempty"`
} }
// BanChatMember bans a user in a chat.
// Returns True on success.
// See https://core.telegram.org/bots/api#banchatmember
func (api *API) BanChatMember(params BanChatMemberP) (bool, error) { func (api *API) BanChatMember(params BanChatMemberP) (bool, error) {
req := NewRequestWithChatID[bool]("banChatMember", params, params.ChatID) req := NewRequestWithChatID[bool]("banChatMember", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// UnbanChatMemberP holds parameters for the unbanChatMember method.
// See https://core.telegram.org/bots/api#unbanchatmember
type UnbanChatMemberP struct { type UnbanChatMemberP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
UserID int `json:"user_id"` UserID int `json:"user_id"`
OnlyIfBanned bool `json:"only_if_banned"` OnlyIfBanned bool `json:"only_if_banned"`
} }
// UnbanChatMember unbans a previously banned user in a chat.
// Returns True on success.
// See https://core.telegram.org/bots/api#unbanchatmember
func (api *API) UnbanChatMember(params UnbanChatMemberP) (bool, error) { func (api *API) UnbanChatMember(params UnbanChatMemberP) (bool, error) {
req := NewRequestWithChatID[bool]("unbanChatMember", params, params.ChatID) req := NewRequestWithChatID[bool]("unbanChatMember", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// RestrictChatMemberP holds parameters for the restrictChatMember method.
// See https://core.telegram.org/bots/api#restrictchatmember
type RestrictChatMemberP struct { type RestrictChatMemberP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
UserID int `json:"user_id"` UserID int `json:"user_id"`
@@ -31,11 +43,16 @@ type RestrictChatMemberP struct {
UntilDate int `json:"until_date,omitempty"` UntilDate int `json:"until_date,omitempty"`
} }
// RestrictChatMember restricts a user in a chat.
// Returns True on success.
// See https://core.telegram.org/bots/api#restrictchatmember
func (api *API) RestrictChatMember(params RestrictChatMemberP) (bool, error) { func (api *API) RestrictChatMember(params RestrictChatMemberP) (bool, error) {
req := NewRequestWithChatID[bool]("restrictChatMember", params, params.ChatID) req := NewRequestWithChatID[bool]("restrictChatMember", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// PromoteChatMember holds parameters for the promoteChatMember method.
// See https://core.telegram.org/bots/api#promotechatmember
type PromoteChatMember struct { type PromoteChatMember struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
UserID int `json:"user_id"` UserID int `json:"user_id"`
@@ -59,73 +76,108 @@ type PromoteChatMember struct {
CanManageTags bool `json:"can_manage_tags,omitempty"` CanManageTags bool `json:"can_manage_tags,omitempty"`
} }
// PromoteChatMember promotes or demotes a user in a chat.
// Returns True on success.
// See https://core.telegram.org/bots/api#promotechatmember
func (api *API) PromoteChatMember(params PromoteChatMember) (bool, error) { func (api *API) PromoteChatMember(params PromoteChatMember) (bool, error) {
req := NewRequestWithChatID[bool]("promoteChatMember", params, params.ChatID) req := NewRequestWithChatID[bool]("promoteChatMember", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// SetChatAdministratorCustomTitleP holds parameters for the setChatAdministratorCustomTitle method.
// See https://core.telegram.org/bots/api#setchatadministratorcustomtitle
type SetChatAdministratorCustomTitleP struct { type SetChatAdministratorCustomTitleP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
UserID int `json:"user_id"` UserID int `json:"user_id"`
CustomTitle string `json:"custom_title"` CustomTitle string `json:"custom_title"`
} }
// SetChatAdministratorCustomTitle sets a custom title for an administrator.
// Returns True on success.
// See https://core.telegram.org/bots/api#setchatadministratorcustomtitle
func (api *API) SetChatAdministratorCustomTitle(params SetChatAdministratorCustomTitleP) (bool, error) { func (api *API) SetChatAdministratorCustomTitle(params SetChatAdministratorCustomTitleP) (bool, error) {
req := NewRequestWithChatID[bool]("setChatAdministratorCustomTitle", params, params.ChatID) req := NewRequestWithChatID[bool]("setChatAdministratorCustomTitle", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// SetChatMemberTagP holds parameters for the setChatMemberTag method.
// See https://core.telegram.org/bots/api#setchatmembertag
type SetChatMemberTagP struct { type SetChatMemberTagP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
UserID int `json:"user_id"` UserID int `json:"user_id"`
Tag string `json:"tag,omitempty"` Tag string `json:"tag,omitempty"`
} }
// SetChatMemberTag sets a tag for a chat member.
// Returns True on success.
// See https://core.telegram.org/bots/api#setchatmembertag
func (api *API) SetChatMemberTag(params SetChatMemberTagP) (bool, error) { func (api *API) SetChatMemberTag(params SetChatMemberTagP) (bool, error) {
req := NewRequestWithChatID[bool]("setChatMemberTag", params, params.ChatID) req := NewRequestWithChatID[bool]("setChatMemberTag", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// BanChatSenderChatP holds parameters for the banChatSenderChat method.
// See https://core.telegram.org/bots/api#banchatsenderchat
type BanChatSenderChatP struct { type BanChatSenderChatP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
SenderChatID int64 `json:"sender_chat_id"` SenderChatID int64 `json:"sender_chat_id"`
} }
// BanChatSenderChat bans a channel chat in a supergroup or channel.
// Returns True on success.
// See https://core.telegram.org/bots/api#banchatsenderchat
func (api *API) BanChatSenderChat(params BanChatSenderChatP) (bool, error) { func (api *API) BanChatSenderChat(params BanChatSenderChatP) (bool, error) {
req := NewRequestWithChatID[bool]("banChatSenderChat", params, params.ChatID) req := NewRequestWithChatID[bool]("banChatSenderChat", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// UnbanChatSenderChatP holds parameters for the unbanChatSenderChat method.
// See https://core.telegram.org/bots/api#unbanchatsenderchat
type UnbanChatSenderChatP struct { type UnbanChatSenderChatP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
SenderChatID int64 `json:"sender_chat_id"` SenderChatID int64 `json:"sender_chat_id"`
} }
func (api *API) UnbanChatSenderChat(params BanChatSenderChatP) (bool, error) { // UnbanChatSenderChat unbans a previously banned channel chat.
// Returns True on success.
// See https://core.telegram.org/bots/api#unbanchatsenderchat
func (api *API) UnbanChatSenderChat(params UnbanChatSenderChatP) (bool, error) {
req := NewRequestWithChatID[bool]("unbanChatSenderChat", params, params.ChatID) req := NewRequestWithChatID[bool]("unbanChatSenderChat", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// SetChatPermissionsP holds parameters for the setChatPermissions method.
// See https://core.telegram.org/bots/api#setchatpermissions
type SetChatPermissionsP struct { type SetChatPermissionsP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
Permissions ChatPermissions `json:"permissions"` Permissions ChatPermissions `json:"permissions"`
UseIndependentChatPermissions bool `json:"use_independent_chat_permissions,omitempty"` UseIndependentChatPermissions bool `json:"use_independent_chat_permissions,omitempty"`
} }
// SetChatPermissions sets default chat permissions for all members.
// Returns True on success.
// See https://core.telegram.org/bots/api#setchatpermissions
func (api *API) SetChatPermissions(params SetChatPermissionsP) (bool, error) { func (api *API) SetChatPermissions(params SetChatPermissionsP) (bool, error) {
req := NewRequestWithChatID[bool]("setChatPermissions", params, params.ChatID) req := NewRequestWithChatID[bool]("setChatPermissions", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// ExportChatInviteLinkP holds parameters for the exportChatInviteLink method.
// See https://core.telegram.org/bots/api#exportchatinvitelink
type ExportChatInviteLinkP struct { type ExportChatInviteLinkP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
} }
// ExportChatInviteLink generates a new primary invite link for a chat.
// Returns the new invite link as string.
// See https://core.telegram.org/bots/api#exportchatinvitelink
func (api *API) ExportChatInviteLink(params ExportChatInviteLinkP) (string, error) { func (api *API) ExportChatInviteLink(params ExportChatInviteLinkP) (string, error) {
req := NewRequestWithChatID[string]("exportChatInviteLink", params, params.ChatID) req := NewRequestWithChatID[string]("exportChatInviteLink", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// CreateChatInviteLinkP holds parameters for the createChatInviteLink method.
// See https://core.telegram.org/bots/api#createchatinvitelink
type CreateChatInviteLinkP struct { type CreateChatInviteLinkP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
Name *string `json:"name,omitempty"` Name *string `json:"name,omitempty"`
@@ -134,11 +186,16 @@ type CreateChatInviteLinkP struct {
CreatesJoinRequest int `json:"creates_join_request,omitempty"` CreatesJoinRequest int `json:"creates_join_request,omitempty"`
} }
// CreateChatInviteLink creates an additional invite link for a chat.
// Returns the created invite link.
// See https://core.telegram.org/bots/api#createchatinvitelink
func (api *API) CreateChatInviteLink(params CreateChatInviteLinkP) (ChatInviteLink, error) { func (api *API) CreateChatInviteLink(params CreateChatInviteLinkP) (ChatInviteLink, error) {
req := NewRequestWithChatID[ChatInviteLink]("createChatInviteLink", params, params.ChatID) req := NewRequestWithChatID[ChatInviteLink]("createChatInviteLink", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// EditChatInviteLinkP holds parameters for the editChatInviteLink method.
// See https://core.telegram.org/bots/api#editchatinvitelink
type EditChatInviteLinkP struct { type EditChatInviteLinkP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
InviteLink string `json:"invite_link"` InviteLink string `json:"invite_link"`
@@ -149,11 +206,16 @@ type EditChatInviteLinkP struct {
CreatesJoinRequest int `json:"creates_join_request,omitempty"` CreatesJoinRequest int `json:"creates_join_request,omitempty"`
} }
// EditChatInviteLink edits a nonprimary invite link.
// Returns the edited invite link.
// See https://core.telegram.org/bots/api#editchatinvitelink
func (api *API) EditChatInviteLink(params EditChatInviteLinkP) (ChatInviteLink, error) { func (api *API) EditChatInviteLink(params EditChatInviteLinkP) (ChatInviteLink, error) {
req := NewRequestWithChatID[ChatInviteLink]("editChatInviteLink", params, params.ChatID) req := NewRequestWithChatID[ChatInviteLink]("editChatInviteLink", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// CreateChatSubscriptionInviteLinkP holds parameters for the createChatSubscriptionInviteLink method.
// See https://core.telegram.org/bots/api#createchatsubscriptioninvitelink
type CreateChatSubscriptionInviteLinkP struct { type CreateChatSubscriptionInviteLinkP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
Name string `json:"name,omitempty"` Name string `json:"name,omitempty"`
@@ -161,52 +223,77 @@ type CreateChatSubscriptionInviteLinkP struct {
SubscriptionPrice int `json:"subscription_price,omitempty"` SubscriptionPrice int `json:"subscription_price,omitempty"`
} }
// CreateChatSubscriptionInviteLink creates a subscription invite link for a channel chat.
// Returns the created invite link.
// See https://core.telegram.org/bots/api#createchatsubscriptioninvitelink
func (api *API) CreateChatSubscriptionInviteLink(params CreateChatSubscriptionInviteLinkP) (ChatInviteLink, error) { func (api *API) CreateChatSubscriptionInviteLink(params CreateChatSubscriptionInviteLinkP) (ChatInviteLink, error) {
req := NewRequestWithChatID[ChatInviteLink]("createChatSubscriptionInviteLink", params, params.ChatID) req := NewRequestWithChatID[ChatInviteLink]("createChatSubscriptionInviteLink", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// EditChatSubscriptionInviteLinkP holds parameters for the editChatSubscriptionInviteLink method.
// See https://core.telegram.org/bots/api#editchatsubscriptioninvitelink
type EditChatSubscriptionInviteLinkP struct { type EditChatSubscriptionInviteLinkP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
InviteLink string `json:"invite_link"` InviteLink string `json:"invite_link"`
Name string `json:"name,omitempty"` Name string `json:"name,omitempty"`
} }
// EditChatSubscriptionInviteLink edits a subscription invite link.
// Returns the edited invite link.
// See https://core.telegram.org/bots/api#editchatsubscriptioninvitelink
func (api *API) EditChatSubscriptionInviteLink(params EditChatSubscriptionInviteLinkP) (ChatInviteLink, error) { func (api *API) EditChatSubscriptionInviteLink(params EditChatSubscriptionInviteLinkP) (ChatInviteLink, error) {
req := NewRequestWithChatID[ChatInviteLink]("editChatSubscriptionInviteLink", params, params.ChatID) req := NewRequestWithChatID[ChatInviteLink]("editChatSubscriptionInviteLink", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// RevokeChatInviteLinkP holds parameters for the revokeChatInviteLink method.
// See https://core.telegram.org/bots/api#revokechatinvitelink
type RevokeChatInviteLinkP struct { type RevokeChatInviteLinkP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
InviteLink string `json:"invite_link"` InviteLink string `json:"invite_link"`
} }
// RevokeChatInviteLink revokes an invite link.
// Returns the revoked invite link object.
// See https://core.telegram.org/bots/api#revokechatinvitelink
func (api *API) RevokeChatInviteLink(params RevokeChatInviteLinkP) (ChatInviteLink, error) { func (api *API) RevokeChatInviteLink(params RevokeChatInviteLinkP) (ChatInviteLink, error) {
req := NewRequestWithChatID[ChatInviteLink]("revokeChatInviteLink", params, params.ChatID) req := NewRequestWithChatID[ChatInviteLink]("revokeChatInviteLink", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// ApproveChatJoinRequestP holds parameters for the approveChatJoinRequest method.
// See https://core.telegram.org/bots/api#approvechatjoinrequest
type ApproveChatJoinRequestP struct { type ApproveChatJoinRequestP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
UserID int `json:"user_id"` UserID int `json:"user_id"`
} }
// ApproveChatJoinRequest approves a chat join request.
// Returns True on success.
// See https://core.telegram.org/bots/api#approvechatjoinrequest
func (api *API) ApproveChatJoinRequest(params ApproveChatJoinRequestP) (bool, error) { func (api *API) ApproveChatJoinRequest(params ApproveChatJoinRequestP) (bool, error) {
req := NewRequestWithChatID[bool]("approveChatJoinRequest", params, params.ChatID) req := NewRequestWithChatID[bool]("approveChatJoinRequest", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// DeclineChatJoinRequestP holds parameters for the declineChatJoinRequest method.
// See https://core.telegram.org/bots/api#declinechatjoinrequest
type DeclineChatJoinRequestP struct { type DeclineChatJoinRequestP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
UserID int `json:"user_id"` UserID int `json:"user_id"`
} }
// DeclineChatJoinRequest declines a chat join request.
// Returns True on success.
// See https://core.telegram.org/bots/api#declinechatjoinrequest
func (api *API) DeclineChatJoinRequest(params DeclineChatJoinRequestP) (bool, error) { func (api *API) DeclineChatJoinRequest(params DeclineChatJoinRequestP) (bool, error) {
req := NewRequestWithChatID[bool]("declineChatJoinRequest", params, params.ChatID) req := NewRequestWithChatID[bool]("declineChatJoinRequest", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// SetChatPhoto is a stub method (needs implementation).
// Currently incomplete.
func (api *API) SetChatPhoto() { func (api *API) SetChatPhoto() {
uploader := NewUploader(api) uploader := NewUploader(api)
defer func() { defer func() {
@@ -214,35 +301,52 @@ func (api *API) SetChatPhoto() {
}() }()
} }
// DeleteChatPhotoP holds parameters for the deleteChatPhoto method.
// See https://core.telegram.org/bots/api#deletechatphoto
type DeleteChatPhotoP struct { type DeleteChatPhotoP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
} }
// DeleteChatPhoto deletes a chat photo.
// Returns True on success.
// See https://core.telegram.org/bots/api#deletechatphoto
func (api *API) DeleteChatPhoto(params DeleteChatPhotoP) (bool, error) { func (api *API) DeleteChatPhoto(params DeleteChatPhotoP) (bool, error) {
req := NewRequestWithChatID[bool]("deleteChatPhoto", params, params.ChatID) req := NewRequestWithChatID[bool]("deleteChatPhoto", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// SetChatTitleP holds parameters for the setChatTitle method.
// See https://core.telegram.org/bots/api#setchattitle
type SetChatTitleP struct { type SetChatTitleP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
Title string `json:"title"` Title string `json:"title"`
} }
// SetChatTitle changes the chat title.
// Returns True on success.
// See https://core.telegram.org/bots/api#setchattitle
func (api *API) SetChatTitle(params SetChatTitleP) (bool, error) { func (api *API) SetChatTitle(params SetChatTitleP) (bool, error) {
req := NewRequestWithChatID[bool]("setChatTitle", params, params.ChatID) req := NewRequestWithChatID[bool]("setChatTitle", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// SetChatDescriptionP holds parameters for the setChatDescription method.
// See https://core.telegram.org/bots/api#setchatdescription
type SetChatDescriptionP struct { type SetChatDescriptionP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
Description string `json:"description"` Description string `json:"description"`
} }
// SetChatDescription changes the chat description.
// Returns True on success.
// See https://core.telegram.org/bots/api#setchatdescription
func (api *API) SetChatDescription(params SetChatDescriptionP) (bool, error) { func (api *API) SetChatDescription(params SetChatDescriptionP) (bool, error) {
req := NewRequestWithChatID[bool]("setChatDescription", params, params.ChatID) req := NewRequestWithChatID[bool]("setChatDescription", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// PinChatMessageP holds parameters for the pinChatMessage method.
// See https://core.telegram.org/bots/api#pinchatmessage
type PinChatMessageP struct { type PinChatMessageP struct {
BusinessConnectionID *string `json:"business_connection_id,omitempty"` BusinessConnectionID *string `json:"business_connection_id,omitempty"`
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
@@ -250,106 +354,156 @@ type PinChatMessageP struct {
DisableNotification bool `json:"disable_notification,omitempty"` DisableNotification bool `json:"disable_notification,omitempty"`
} }
// PinChatMessage pins a message in a chat.
// Returns True on success.
// See https://core.telegram.org/bots/api#pinchatmessage
func (api *API) PinChatMessage(params PinChatMessageP) (bool, error) { func (api *API) PinChatMessage(params PinChatMessageP) (bool, error) {
req := NewRequestWithChatID[bool]("pinChatMessage", params, params.ChatID) req := NewRequestWithChatID[bool]("pinChatMessage", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// UnpinChatMessageP holds parameters for the unpinChatMessage method.
// See https://core.telegram.org/bots/api#unpinchatmessage
type UnpinChatMessageP struct { type UnpinChatMessageP struct {
BusinessConnectionID *string `json:"business_connection_id,omitempty"` BusinessConnectionID *string `json:"business_connection_id,omitempty"`
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
MessageID int `json:"message_id"` MessageID int `json:"message_id"`
} }
// UnpinChatMessage unpins a message in a chat.
// Returns True on success.
// See https://core.telegram.org/bots/api#unpinchatmessage
func (api *API) UnpinChatMessage(params UnpinChatMessageP) (bool, error) { func (api *API) UnpinChatMessage(params UnpinChatMessageP) (bool, error) {
req := NewRequestWithChatID[bool]("unpinChatMessage", params, params.ChatID) req := NewRequestWithChatID[bool]("unpinChatMessage", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// UnpinAllChatMessagesP holds parameters for the unpinAllChatMessages method.
// See https://core.telegram.org/bots/api#unpinallchatmessages
type UnpinAllChatMessagesP struct { type UnpinAllChatMessagesP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
} }
// UnpinAllChatMessages unpins all pinned messages in a chat.
// Returns True on success.
// See https://core.telegram.org/bots/api#unpinallchatmessages
func (api *API) UnpinAllChatMessages(params UnpinAllChatMessagesP) (bool, error) { func (api *API) UnpinAllChatMessages(params UnpinAllChatMessagesP) (bool, error) {
req := NewRequestWithChatID[bool]("unpinAllChatMessages", params, params.ChatID) req := NewRequestWithChatID[bool]("unpinAllChatMessages", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// LeaveChatP holds parameters for the leaveChat method.
// See https://core.telegram.org/bots/api#leavechat
type LeaveChatP struct { type LeaveChatP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
} }
// LeaveChat makes the bot leave a chat.
// Returns True on success.
// See https://core.telegram.org/bots/api#leavechat
func (api *API) LeaveChat(params LeaveChatP) (bool, error) { func (api *API) LeaveChat(params LeaveChatP) (bool, error) {
req := NewRequestWithChatID[bool]("leaveChatP", params, params.ChatID) req := NewRequestWithChatID[bool]("leaveChat", params, params.ChatID) // fixed method name
return req.Do(api) return req.Do(api)
} }
// GetChatP holds parameters for the getChat method.
// See https://core.telegram.org/bots/api#getchat
type GetChatP struct { type GetChatP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
} }
func (api *API) GetChatP(params GetChatP) (ChatFullInfo, error) { // GetChat gets uptodate information about a chat.
req := NewRequestWithChatID[ChatFullInfo]("getChatP", params, params.ChatID) // See https://core.telegram.org/bots/api#getchat
func (api *API) GetChat(params GetChatP) (ChatFullInfo, error) {
req := NewRequestWithChatID[ChatFullInfo]("getChat", params, params.ChatID) // fixed method name
return req.Do(api) return req.Do(api)
} }
// GetChatAdministratorsP holds parameters for the getChatAdministrators method.
// See https://core.telegram.org/bots/api#getchatadministrators
type GetChatAdministratorsP struct { type GetChatAdministratorsP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
} }
// GetChatAdministrators returns a list of administrators in a chat.
// See https://core.telegram.org/bots/api#getchatadministrators
func (api *API) GetChatAdministrators(params GetChatAdministratorsP) ([]ChatMember, error) { func (api *API) GetChatAdministrators(params GetChatAdministratorsP) ([]ChatMember, error) {
req := NewRequestWithChatID[[]ChatMember]("getChatAdministrators", params, params.ChatID) req := NewRequestWithChatID[[]ChatMember]("getChatAdministrators", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// GetChatMembersCountP holds parameters for the getChatMemberCount method.
// See https://core.telegram.org/bots/api#getchatmembercount
type GetChatMembersCountP struct { type GetChatMembersCountP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
} }
// GetChatMemberCount returns the number of members in a chat.
// See https://core.telegram.org/bots/api#getchatmembercount
func (api *API) GetChatMemberCount(params GetChatMembersCountP) (int, error) { func (api *API) GetChatMemberCount(params GetChatMembersCountP) (int, error) {
req := NewRequestWithChatID[int]("getChatMemberCount", params, params.ChatID) req := NewRequestWithChatID[int]("getChatMemberCount", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// GetChatMemberP holds parameters for the getChatMember method.
// See https://core.telegram.org/bots/api#getchatmember
type GetChatMemberP struct { type GetChatMemberP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
UserID int `json:"user_id"` UserID int `json:"user_id"`
} }
// GetChatMember returns information about a member of a chat.
// See https://core.telegram.org/bots/api#getchatmember
func (api *API) GetChatMember(params GetChatMemberP) (ChatMember, error) { func (api *API) GetChatMember(params GetChatMemberP) (ChatMember, error) {
req := NewRequestWithChatID[ChatMember]("getChatMember", params, params.ChatID) req := NewRequestWithChatID[ChatMember]("getChatMember", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// SetChatStickerSetP holds parameters for the setChatStickerSet method.
// See https://core.telegram.org/bots/api#setchatstickerset
type SetChatStickerSetP struct { type SetChatStickerSetP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
StickerSetName string `json:"sticker_set_name"` StickerSetName string `json:"sticker_set_name"`
} }
// SetChatStickerSet associates a sticker set with a supergroup.
// Returns True on success.
// See https://core.telegram.org/bots/api#setchatstickerset
func (api *API) SetChatStickerSet(params SetChatStickerSetP) (bool, error) { func (api *API) SetChatStickerSet(params SetChatStickerSetP) (bool, error) {
req := NewRequestWithChatID[bool]("setChatStickerSet", params, params.ChatID) req := NewRequestWithChatID[bool]("setChatStickerSet", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// DeleteChatStickerSetP holds parameters for the deleteChatStickerSet method.
// See https://core.telegram.org/bots/api#deletechatstickerset
type DeleteChatStickerSetP struct { type DeleteChatStickerSetP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
} }
// DeleteChatStickerSet deletes a sticker set from a supergroup.
// Returns True on success.
// See https://core.telegram.org/bots/api#deletechatstickerset
func (api *API) DeleteChatStickerSet(params DeleteChatStickerSetP) (bool, error) { func (api *API) DeleteChatStickerSet(params DeleteChatStickerSetP) (bool, error) {
req := NewRequestWithChatID[bool]("deleteChatStickerSet", params, params.ChatID) req := NewRequestWithChatID[bool]("deleteChatStickerSet", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// GetUserChatBoostsP holds parameters for the getUserChatBoosts method.
// See https://core.telegram.org/bots/api#getuserchatboosts
type GetUserChatBoostsP struct { type GetUserChatBoostsP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
UserID int `json:"user_id"` UserID int `json:"user_id"`
} }
// GetUserChatBoosts returns the list of boosts a user has given to a chat.
// See https://core.telegram.org/bots/api#getuserchatboosts
func (api *API) GetUserChatBoosts(params GetUserChatBoostsP) (UserChatBoosts, error) { func (api *API) GetUserChatBoosts(params GetUserChatBoostsP) (UserChatBoosts, error) {
req := NewRequestWithChatID[UserChatBoosts]("getUserChatBoosts", params, params.ChatID) req := NewRequestWithChatID[UserChatBoosts]("getUserChatBoosts", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// GetChatGiftsP holds parameters for the getChatGifts method.
// See https://core.telegram.org/bots/api#getchatgifts
type GetChatGiftsP struct { type GetChatGiftsP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
ExcludeUnsaved bool `json:"exclude_unsaved,omitempty"` ExcludeUnsaved bool `json:"exclude_unsaved,omitempty"`
@@ -364,6 +518,8 @@ type GetChatGiftsP struct {
Limit int `json:"limit,omitempty"` Limit int `json:"limit,omitempty"`
} }
// GetChatGifts returns gifts owned by a chat.
// See https://core.telegram.org/bots/api#getchatgifts
func (api *API) GetChatGifts(params GetChatGiftsP) (OwnedGifts, error) { func (api *API) GetChatGifts(params GetChatGiftsP) (OwnedGifts, error) {
req := NewRequestWithChatID[OwnedGifts]("getChatGifts", params, params.ChatID) req := NewRequestWithChatID[OwnedGifts]("getChatGifts", params, params.ChatID)
return req.Do(api) return req.Do(api)

View File

@@ -1,5 +1,7 @@
package tgapi package tgapi
// Chat represents a chat (private, group, supergroup, channel).
// See https://core.telegram.org/bots/api#chat
type Chat struct { type Chat struct {
ID int64 `json:"id"` ID int64 `json:"id"`
Type string `json:"type"` Type string `json:"type"`
@@ -11,6 +13,7 @@ type Chat struct {
IsDirectMessages *bool `json:"is_direct_messages,omitempty"` IsDirectMessages *bool `json:"is_direct_messages,omitempty"`
} }
// ChatType represents the type of a chat.
type ChatType string type ChatType string
const ( const (
@@ -20,6 +23,8 @@ const (
ChatTypeChannel ChatType = "channel" ChatTypeChannel ChatType = "channel"
) )
// ChatFullInfo contains full information about a chat.
// See https://core.telegram.org/bots/api#chatfullinfo
type ChatFullInfo struct { type ChatFullInfo struct {
ID int `json:"id"` ID int `json:"id"`
Type ChatType `json:"type"` Type ChatType `json:"type"`
@@ -82,6 +87,8 @@ type ChatFullInfo struct {
PaidMessageStarCount *int `json:"paid_message_star_count,omitempty"` PaidMessageStarCount *int `json:"paid_message_star_count,omitempty"`
} }
// ChatPhoto represents a chat photo.
// See https://core.telegram.org/bots/api#chatphoto
type ChatPhoto struct { type ChatPhoto struct {
SmallFileID string `json:"small_file_id"` SmallFileID string `json:"small_file_id"`
SmallFileUniqueID string `json:"small_file_unique_id"` SmallFileUniqueID string `json:"small_file_unique_id"`
@@ -89,6 +96,8 @@ type ChatPhoto struct {
BigFileUniqueID string `json:"big_file_unique_id"` BigFileUniqueID string `json:"big_file_unique_id"`
} }
// ChatPermissions describes actions that a nonadministrator user is allowed to take in a chat.
// See https://core.telegram.org/bots/api#chatpermissions
type ChatPermissions struct { type ChatPermissions struct {
CanSendMessages bool `json:"can_send_messages"` CanSendMessages bool `json:"can_send_messages"`
CanSendAudios bool `json:"can_send_audios"` CanSendAudios bool `json:"can_send_audios"`
@@ -99,16 +108,22 @@ type ChatPermissions struct {
CanSendPolls bool `json:"can_send_polls"` CanSendPolls bool `json:"can_send_polls"`
CanSendOtherMessages bool `json:"can_send_other_messages"` CanSendOtherMessages bool `json:"can_send_other_messages"`
CanAddWebPagePreview bool `json:"can_add_web_page_preview"` CanAddWebPagePreview bool `json:"can_add_web_page_preview"`
CatEditTag bool `json:"cat_edit_tag"` CatEditTag bool `json:"cat_edit_tag"` // Note: field name likely a typo, should be "can_edit_tag"
CanChangeInfo bool `json:"can_change_info"` CanChangeInfo bool `json:"can_change_info"`
CanInviteUsers bool `json:"can_invite_users"` CanInviteUsers bool `json:"can_invite_users"`
CanPinMessages bool `json:"can_pin_messages"` CanPinMessages bool `json:"can_pin_messages"`
CanManageTopics bool `json:"can_manage_topics"` CanManageTopics bool `json:"can_manage_topics"`
} }
// ChatLocation represents a location to which a chat is connected.
// See https://core.telegram.org/bots/api#chatlocation
type ChatLocation struct { type ChatLocation struct {
Location Location `json:"location"` Location Location `json:"location"`
Address string `json:"address"` Address string `json:"address"`
} }
// ChatInviteLink represents an invite link for a chat.
// See https://core.telegram.org/bots/api#chatinvitelink
type ChatInviteLink struct { type ChatInviteLink struct {
InviteLink string `json:"invite_link"` InviteLink string `json:"invite_link"`
Creator User `json:"creator"` Creator User `json:"creator"`
@@ -124,6 +139,7 @@ type ChatInviteLink struct {
SubscriptionPrice *int `json:"subscription_price,omitempty"` SubscriptionPrice *int `json:"subscription_price,omitempty"`
} }
// ChatMemberStatusType indicates the status of a chat member.
type ChatMemberStatusType string type ChatMemberStatusType string
const ( const (
@@ -135,6 +151,8 @@ const (
ChatMemberStatusBanned ChatMemberStatusType = "kicked" ChatMemberStatusBanned ChatMemberStatusType = "kicked"
) )
// ChatMember contains information about one member of a chat.
// See https://core.telegram.org/bots/api#chatmember
type ChatMember struct { type ChatMember struct {
Status ChatMemberStatusType `json:"status"` Status ChatMemberStatusType `json:"status"`
User User `json:"user"` User User `json:"user"`
@@ -181,6 +199,8 @@ type ChatMember struct {
CanEditTag *bool `json:"can_edit_tag,omitempty"` CanEditTag *bool `json:"can_edit_tag,omitempty"`
} }
// ChatBoostSource describes the source of a chat boost.
// See https://core.telegram.org/bots/api#chatboostsource
type ChatBoostSource struct { type ChatBoostSource struct {
Source string `json:"source"` Source string `json:"source"`
User User `json:"user"` User User `json:"user"`
@@ -191,16 +211,23 @@ type ChatBoostSource struct {
IsUnclaimed *bool `json:"is_unclaimed,omitempty"` IsUnclaimed *bool `json:"is_unclaimed,omitempty"`
} }
// ChatBoost represents a boost added to a chat.
// See https://core.telegram.org/bots/api#chatboost
type ChatBoost struct { type ChatBoost struct {
BoostID int `json:"boost_id"` BoostID int `json:"boost_id"`
AddDate int `json:"add_date"` AddDate int `json:"add_date"`
ExpirationDate int `json:"expiration_date"` ExpirationDate int `json:"expiration_date"`
Source ChatBoostSource `json:"source"` Source ChatBoostSource `json:"source"`
} }
// UserChatBoosts represents a list of boosts a user has given to a chat.
// See https://core.telegram.org/bots/api#userchatboosts
type UserChatBoosts struct { type UserChatBoosts struct {
Boosts []ChatBoost `json:"boosts"` Boosts []ChatBoost `json:"boosts"`
} }
// ChatAdministratorRights represents the rights of an administrator in a chat.
// See https://core.telegram.org/bots/api#chatadministratorrights
type ChatAdministratorRights struct { type ChatAdministratorRights struct {
IsAnonymous bool `json:"is_anonymous"` IsAnonymous bool `json:"is_anonymous"`
CanManageChat bool `json:"can_manage_chat"` CanManageChat bool `json:"can_manage_chat"`
@@ -222,11 +249,15 @@ type ChatAdministratorRights struct {
CanManageTags *bool `json:"can_manage_tags,omitempty"` CanManageTags *bool `json:"can_manage_tags,omitempty"`
} }
// ChatBoostUpdated represents a boost added to a chat or changed.
// See https://core.telegram.org/bots/api#chatboostupdated
type ChatBoostUpdated struct { type ChatBoostUpdated struct {
Chat Chat `json:"chat"` Chat Chat `json:"chat"`
Boost ChatBoost `json:"boost"` Boost ChatBoost `json:"boost"`
} }
// ChatBoostRemoved represents a boost removed from a chat.
// See https://core.telegram.org/bots/api#chatboostremoved
type ChatBoostRemoved struct { type ChatBoostRemoved struct {
Chat Chat `json:"chat"` Chat Chat `json:"chat"`
BoostID string `json:"boost_id"` BoostID string `json:"boost_id"`

View File

@@ -1,15 +1,20 @@
package tgapi package tgapi
// BaseForumTopicP contains common fields for forum topic operations that require a chat ID and a message thread ID.
type BaseForumTopicP struct { type BaseForumTopicP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
MessageThreadID int `json:"message_thread_id"` MessageThreadID int `json:"message_thread_id"`
} }
// GetForumTopicIconStickers returns the list of custom emoji that can be used as a forum topic icon.
// See https://core.telegram.org/bots/api#getforumtopiciconstickers
func (api *API) GetForumTopicIconStickers() ([]Sticker, error) { func (api *API) GetForumTopicIconStickers() ([]Sticker, error) {
req := NewRequest[[]Sticker]("getForumTopicIconStickers", NoParams) req := NewRequest[[]Sticker]("getForumTopicIconStickers", NoParams)
return req.Do(api) return req.Do(api)
} }
// CreateForumTopicP holds parameters for the createForumTopic method.
// See https://core.telegram.org/bots/api#createforumtopic
type CreateForumTopicP struct { type CreateForumTopicP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
Name string `json:"name"` Name string `json:"name"`
@@ -17,69 +22,117 @@ type CreateForumTopicP struct {
IconCustomEmojiID string `json:"icon_custom_emoji_id"` IconCustomEmojiID string `json:"icon_custom_emoji_id"`
} }
// CreateForumTopic creates a topic in a forum supergroup.
// Returns the created ForumTopic on success.
// See https://core.telegram.org/bots/api#createforumtopic
func (api *API) CreateForumTopic(params CreateForumTopicP) (ForumTopic, error) { func (api *API) CreateForumTopic(params CreateForumTopicP) (ForumTopic, error) {
req := NewRequestWithChatID[ForumTopic]("createForumTopic", params, params.ChatID) req := NewRequestWithChatID[ForumTopic]("createForumTopic", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// EditForumTopicP holds parameters for the editForumTopic method.
// See https://core.telegram.org/bots/api#editforumtopic
type EditForumTopicP struct { type EditForumTopicP struct {
BaseForumTopicP BaseForumTopicP
Name string `json:"name"` Name string `json:"name"`
IconCustomEmojiID string `json:"icon_custom_emoji_id"` IconCustomEmojiID string `json:"icon_custom_emoji_id"`
} }
// EditForumTopic edits name and icon of a forum topic.
// Returns True on success.
// See https://core.telegram.org/bots/api#editforumtopic
func (api *API) EditForumTopic(params EditForumTopicP) (bool, error) { func (api *API) EditForumTopic(params EditForumTopicP) (bool, error) {
req := NewRequestWithChatID[bool]("editForumTopic", params, params.ChatID) req := NewRequestWithChatID[bool]("editForumTopic", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// CloseForumTopic closes an open forum topic.
// Returns True on success.
// See https://core.telegram.org/bots/api#closeforumtopic
func (api *API) CloseForumTopic(params BaseForumTopicP) (bool, error) { func (api *API) CloseForumTopic(params BaseForumTopicP) (bool, error) {
req := NewRequestWithChatID[bool]("closeForumTopic", params, params.ChatID) req := NewRequestWithChatID[bool]("closeForumTopic", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// ReopenForumTopic reopens a closed forum topic.
// Returns True on success.
// See https://core.telegram.org/bots/api#reopenforumtopic
func (api *API) ReopenForumTopic(params BaseForumTopicP) (bool, error) { func (api *API) ReopenForumTopic(params BaseForumTopicP) (bool, error) {
req := NewRequestWithChatID[bool]("reopenForumTopic", params, params.ChatID) req := NewRequestWithChatID[bool]("reopenForumTopic", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// DeleteForumTopic deletes a forum topic.
// Returns True on success.
// See https://core.telegram.org/bots/api#deleteforumtopic
func (api *API) DeleteForumTopic(params BaseForumTopicP) (bool, error) { func (api *API) DeleteForumTopic(params BaseForumTopicP) (bool, error) {
req := NewRequestWithChatID[bool]("deleteForumTopic", params, params.ChatID) req := NewRequestWithChatID[bool]("deleteForumTopic", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// UnpinAllForumTopicMessages clears the list of pinned messages in a forum topic.
// Returns True on success.
// See https://core.telegram.org/bots/api#unpinallforumtopicmessages
func (api *API) UnpinAllForumTopicMessages(params BaseForumTopicP) (bool, error) { func (api *API) UnpinAllForumTopicMessages(params BaseForumTopicP) (bool, error) {
req := NewRequestWithChatID[bool]("unpinAllForumTopicMessages", params, params.ChatID) req := NewRequestWithChatID[bool]("unpinAllForumTopicMessages", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// BaseGeneralForumTopicP contains common fields for general forum topic operations that require a chat ID.
type BaseGeneralForumTopicP struct { type BaseGeneralForumTopicP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
} }
// EditGeneralForumTopicP holds parameters for the editGeneralForumTopic method.
// See https://core.telegram.org/bots/api#editgeneralforumtopic
type EditGeneralForumTopicP struct { type EditGeneralForumTopicP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
Name string `json:"name"` Name string `json:"name"`
} }
// EditGeneralForumTopic edits the name of the 'General' topic in a forum supergroup.
// Returns True on success.
// See https://core.telegram.org/bots/api#editgeneralforumtopic
func (api *API) EditGeneralForumTopic(params EditGeneralForumTopicP) (bool, error) { func (api *API) EditGeneralForumTopic(params EditGeneralForumTopicP) (bool, error) {
req := NewRequestWithChatID[bool]("editGeneralForumTopic", params, params.ChatID) req := NewRequestWithChatID[bool]("editGeneralForumTopic", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// CloseGeneralForumTopic closes the 'General' topic in a forum supergroup.
// Returns True on success.
// See https://core.telegram.org/bots/api#closegeneralforumtopic
func (api *API) CloseGeneralForumTopic(params BaseGeneralForumTopicP) (bool, error) { func (api *API) CloseGeneralForumTopic(params BaseGeneralForumTopicP) (bool, error) {
req := NewRequestWithChatID[bool]("closeGeneralForumTopic", params, params.ChatID) req := NewRequestWithChatID[bool]("closeGeneralForumTopic", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// ReopenGeneralForumTopic reopens the 'General' topic in a forum supergroup.
// Returns True on success.
// See https://core.telegram.org/bots/api#reopengeneralforumtopic
func (api *API) ReopenGeneralForumTopic(params BaseGeneralForumTopicP) (bool, error) { func (api *API) ReopenGeneralForumTopic(params BaseGeneralForumTopicP) (bool, error) {
req := NewRequestWithChatID[bool]("reopenGeneralForumTopic", params, params.ChatID) req := NewRequestWithChatID[bool]("reopenGeneralForumTopic", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// HideGeneralForumTopic hides the 'General' topic in a forum supergroup.
// Returns True on success.
// See https://core.telegram.org/bots/api#hidegeneralforumtopic
func (api *API) HideGeneralForumTopic(params BaseGeneralForumTopicP) (bool, error) { func (api *API) HideGeneralForumTopic(params BaseGeneralForumTopicP) (bool, error) {
req := NewRequestWithChatID[bool]("hideGeneralForumTopic", params, params.ChatID) req := NewRequestWithChatID[bool]("hideGeneralForumTopic", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// UnhideGeneralForumTopic unhides the 'General' topic in a forum supergroup.
// Returns True on success.
// See https://core.telegram.org/bots/api#unhidegeneralforumtopic
func (api *API) UnhideGeneralForumTopic(params BaseGeneralForumTopicP) (bool, error) { func (api *API) UnhideGeneralForumTopic(params BaseGeneralForumTopicP) (bool, error) {
req := NewRequestWithChatID[bool]("unhideGeneralForumTopic", params, params.ChatID) req := NewRequestWithChatID[bool]("unhideGeneralForumTopic", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// UnpinAllGeneralForumTopicMessages clears the list of pinned messages in the 'General' topic.
// Returns True on success.
// See https://core.telegram.org/bots/api#unpinallgeneralforumtopicmessages
func (api *API) UnpinAllGeneralForumTopicMessages(params BaseGeneralForumTopicP) (bool, error) { func (api *API) UnpinAllGeneralForumTopicMessages(params BaseGeneralForumTopicP) (bool, error) {
req := NewRequestWithChatID[bool]("unpinAllGeneralForumTopicMessages", params, params.ChatID) req := NewRequestWithChatID[bool]("unpinAllGeneralForumTopicMessages", params, params.ChatID)
return req.Do(api) return req.Do(api)

View File

@@ -1,5 +1,7 @@
package tgapi package tgapi
// ForumTopic represents a forum topic.
// See https://core.telegram.org/bots/api#forumtopic
type ForumTopic struct { type ForumTopic struct {
MessageThreadID int `json:"message_thread_id"` MessageThreadID int `json:"message_thread_id"`
Name string `json:"name"` Name string `json:"name"`
@@ -8,8 +10,12 @@ type ForumTopic struct {
IsNameImplicit bool `json:"is_name_implicit,omitempty"` IsNameImplicit bool `json:"is_name_implicit,omitempty"`
} }
// ForumTopicIconColor represents the color of a forum topic icon.
// The value is an integer representing the color in RGB format.
// See https://core.telegram.org/bots/api#forumtopiciconcolor
type ForumTopicIconColor int type ForumTopicIconColor int
const ( const (
// ForumTopicIconColorBlue is the blue color for forum topic icons (value 7322096).
ForumTopicIconColorBlue ForumTopicIconColor = 7322096 ForumTopicIconColorBlue ForumTopicIconColor = 7322096
) )

View File

@@ -1,5 +1,7 @@
package tgapi package tgapi
// SendMessageP holds parameters for the sendMessage method.
// See https://core.telegram.org/bots/api#sendmessage
type SendMessageP struct { type SendMessageP struct {
BusinessConnectionID string `json:"business_connection_id,omitempty"` BusinessConnectionID string `json:"business_connection_id,omitempty"`
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
@@ -20,11 +22,15 @@ type SendMessageP struct {
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"` ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
} }
// SendMessage sends a text message.
// See https://core.telegram.org/bots/api#sendmessage
func (api *API) SendMessage(params SendMessageP) (Message, error) { func (api *API) SendMessage(params SendMessageP) (Message, error) {
req := NewRequestWithChatID[Message, SendMessageP]("sendMessage", params, params.ChatID) req := NewRequestWithChatID[Message, SendMessageP]("sendMessage", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// ForwardMessageP holds parameters for the forwardMessage method.
// See https://core.telegram.org/bots/api#forwardmessage
type ForwardMessageP struct { type ForwardMessageP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
MessageThreadID int `json:"message_thread_id,omitempty"` MessageThreadID int `json:"message_thread_id,omitempty"`
@@ -40,11 +46,15 @@ type ForwardMessageP struct {
SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"` SuggestedPostParameters *SuggestedPostParameters `json:"suggested_post_parameters,omitempty"`
} }
// ForwardMessage forwards a message.
// See https://core.telegram.org/bots/api#forwardmessage
func (api *API) ForwardMessage(params ForwardMessageP) (Message, error) { func (api *API) ForwardMessage(params ForwardMessageP) (Message, error) {
req := NewRequestWithChatID[Message]("forwardMessage", params, params.ChatID) req := NewRequestWithChatID[Message]("forwardMessage", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// ForwardMessagesP holds parameters for the forwardMessages method.
// See https://core.telegram.org/bots/api#forwardmessages
type ForwardMessagesP struct { type ForwardMessagesP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
MessageThreadID int `json:"message_thread_id,omitempty"` MessageThreadID int `json:"message_thread_id,omitempty"`
@@ -56,11 +66,16 @@ type ForwardMessagesP struct {
ProtectContent bool `json:"protect_content,omitempty"` ProtectContent bool `json:"protect_content,omitempty"`
} }
// ForwardMessages forwards multiple messages.
// Returns an array of message IDs of the sent messages.
// See https://core.telegram.org/bots/api#forwardmessages
func (api *API) ForwardMessages(params ForwardMessagesP) ([]int, error) { func (api *API) ForwardMessages(params ForwardMessagesP) ([]int, error) {
req := NewRequestWithChatID[[]int]("forwardMessages", params, params.ChatID) req := NewRequestWithChatID[[]int]("forwardMessages", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// CopyMessageP holds parameters for the copyMessage method.
// See https://core.telegram.org/bots/api#copymessage
type CopyMessageP struct { type CopyMessageP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
MessageThreadID int `json:"message_thread_id,omitempty"` MessageThreadID int `json:"message_thread_id,omitempty"`
@@ -84,11 +99,16 @@ type CopyMessageP struct {
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"` ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
} }
// CopyMessage copies a message.
// Returns the MessageID of the sent copy.
// See https://core.telegram.org/bots/api#copymessage
func (api *API) CopyMessage(params CopyMessageP) (int, error) { func (api *API) CopyMessage(params CopyMessageP) (int, error) {
req := NewRequestWithChatID[int]("copyMessage", params, params.ChatID) req := NewRequestWithChatID[int]("copyMessage", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// CopyMessagesP holds parameters for the copyMessages method.
// See https://core.telegram.org/bots/api#copymessages
type CopyMessagesP struct { type CopyMessagesP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
MessageThreadID int `json:"message_thread_id,omitempty"` MessageThreadID int `json:"message_thread_id,omitempty"`
@@ -101,11 +121,16 @@ type CopyMessagesP struct {
RemoveCaption bool `json:"remove_caption,omitempty"` RemoveCaption bool `json:"remove_caption,omitempty"`
} }
// CopyMessages copies multiple messages.
// Returns an array of message IDs of the sent copies.
// See https://core.telegram.org/bots/api#copymessages
func (api *API) CopyMessages(params CopyMessagesP) ([]int, error) { func (api *API) CopyMessages(params CopyMessagesP) ([]int, error) {
req := NewRequestWithChatID[[]int]("copyMessages", params, params.ChatID) req := NewRequestWithChatID[[]int]("copyMessages", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// SendLocationP holds parameters for the sendLocation method.
// See https://core.telegram.org/bots/api#sendlocation
type SendLocationP struct { type SendLocationP struct {
BusinessConnectionID int `json:"business_connection_id,omitempty"` BusinessConnectionID int `json:"business_connection_id,omitempty"`
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
@@ -129,11 +154,15 @@ type SendLocationP struct {
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"` ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
} }
// SendLocation sends a point on the map.
// See https://core.telegram.org/bots/api#sendlocation
func (api *API) SendLocation(params SendLocationP) (Message, error) { func (api *API) SendLocation(params SendLocationP) (Message, error) {
req := NewRequestWithChatID[Message]("sendLocation", params, params.ChatID) req := NewRequestWithChatID[Message]("sendLocation", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// SendVenueP holds parameters for the sendVenue method.
// See https://core.telegram.org/bots/api#sendvenue
type SendVenueP struct { type SendVenueP struct {
BusinessConnectionID int `json:"business_connection_id,omitempty"` BusinessConnectionID int `json:"business_connection_id,omitempty"`
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
@@ -159,11 +188,15 @@ type SendVenueP struct {
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"` ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
} }
// SendVenue sends information about a venue.
// See https://core.telegram.org/bots/api#sendvenue
func (api *API) SendVenue(params SendVenueP) (Message, error) { func (api *API) SendVenue(params SendVenueP) (Message, error) {
req := NewRequestWithChatID[Message]("sendVenue", params, params.ChatID) req := NewRequestWithChatID[Message]("sendVenue", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// SendContactP holds parameters for the sendContact method.
// See https://core.telegram.org/bots/api#sendcontact
type SendContactP struct { type SendContactP struct {
BusinessConnectionID int `json:"business_connection_id,omitempty"` BusinessConnectionID int `json:"business_connection_id,omitempty"`
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
@@ -185,11 +218,15 @@ type SendContactP struct {
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"` ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
} }
// SendContact sends a phone contact.
// See https://core.telegram.org/bots/api#sendcontact
func (api *API) SendContact(params SendContactP) (Message, error) { func (api *API) SendContact(params SendContactP) (Message, error) {
req := NewRequestWithChatID[Message]("sendContact", params, params.ChatID) req := NewRequestWithChatID[Message]("sendContact", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// SendPollP holds parameters for the sendPoll method.
// See https://core.telegram.org/bots/api#sendpoll
type SendPollP struct { type SendPollP struct {
BusinessConnectionID int `json:"business_connection_id,omitempty"` BusinessConnectionID int `json:"business_connection_id,omitempty"`
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
@@ -219,11 +256,15 @@ type SendPollP struct {
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"` ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
} }
// SendPoll sends a native poll.
// See https://core.telegram.org/bots/api#sendpoll
func (api *API) SendPoll(params SendPollP) (Message, error) { func (api *API) SendPoll(params SendPollP) (Message, error) {
req := NewRequestWithChatID[Message]("sendPoll", params, params.ChatID) req := NewRequestWithChatID[Message]("sendPoll", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// SendChecklistP holds parameters for the sendChecklist method.
// See https://core.telegram.org/bots/api#sendchecklist
type SendChecklistP struct { type SendChecklistP struct {
BusinessConnectionID int `json:"business_connection_id"` BusinessConnectionID int `json:"business_connection_id"`
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
@@ -237,11 +278,15 @@ type SendChecklistP struct {
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"` ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
} }
// SendChecklist sends a checklist.
// See https://core.telegram.org/bots/api#sendchecklist
func (api *API) SendChecklist(params SendChecklistP) (Message, error) { func (api *API) SendChecklist(params SendChecklistP) (Message, error) {
req := NewRequestWithChatID[Message]("sendChecklist", params, params.ChatID) req := NewRequestWithChatID[Message]("sendChecklist", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// SendDiceP holds parameters for the sendDice method.
// See https://core.telegram.org/bots/api#senddice
type SendDiceP struct { type SendDiceP struct {
BusinessConnectionID int `json:"business_connection_id,omitempty"` BusinessConnectionID int `json:"business_connection_id,omitempty"`
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
@@ -260,11 +305,14 @@ type SendDiceP struct {
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"` ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
} }
// SendDice sends a dice, which will have a random value.
// See https://core.telegram.org/bots/api#senddice
func (api *API) SendDice(params SendDiceP) (Message, error) { func (api *API) SendDice(params SendDiceP) (Message, error) {
req := NewRequestWithChatID[Message]("sendDice", params, params.ChatID) req := NewRequestWithChatID[Message]("sendDice", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// SendMessageDraftP holds parameters for the sendMessageDraft method.
type SendMessageDraftP struct { type SendMessageDraftP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
MessageThreadID int `json:"message_thread_id,omitempty"` MessageThreadID int `json:"message_thread_id,omitempty"`
@@ -274,11 +322,14 @@ type SendMessageDraftP struct {
Entities []MessageEntity `json:"entities,omitempty"` Entities []MessageEntity `json:"entities,omitempty"`
} }
// SendMessageDraft sends a previously saved draft message.
func (api *API) SendMessageDraft(params SendMessageDraftP) (bool, error) { func (api *API) SendMessageDraft(params SendMessageDraftP) (bool, error) {
req := NewRequestWithChatID[bool]("sendMessageDraft", params, params.ChatID) req := NewRequestWithChatID[bool]("sendMessageDraft", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// SendChatActionP holds parameters for the sendChatAction method.
// See https://core.telegram.org/bots/api#sendchataction
type SendChatActionP struct { type SendChatActionP struct {
BusinessConnectionID string `json:"business_connection_id,omitempty"` BusinessConnectionID string `json:"business_connection_id,omitempty"`
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
@@ -286,11 +337,16 @@ type SendChatActionP struct {
Action ChatActionType `json:"action"` Action ChatActionType `json:"action"`
} }
// SendChatAction sends a chat action (typing, uploading photo, etc.).
// Returns True on success.
// See https://core.telegram.org/bots/api#sendchataction
func (api *API) SendChatAction(params SendChatActionP) (bool, error) { func (api *API) SendChatAction(params SendChatActionP) (bool, error) {
req := NewRequestWithChatID[bool]("sendChatAction", params, params.ChatID) req := NewRequestWithChatID[bool]("sendChatAction", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// SetMessageReactionP holds parameters for the setMessageReaction method.
// See https://core.telegram.org/bots/api#setmessagereaction
type SetMessageReactionP struct { type SetMessageReactionP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
MessageId int `json:"message_id"` MessageId int `json:"message_id"`
@@ -298,13 +354,16 @@ type SetMessageReactionP struct {
IsBig bool `json:"is_big,omitempty"` IsBig bool `json:"is_big,omitempty"`
} }
// SetMessageReaction changes the chosen reaction on a message.
// Returns True on success.
// See https://core.telegram.org/bots/api#setmessagereaction
func (api *API) SetMessageReaction(params SetMessageReactionP) (bool, error) { func (api *API) SetMessageReaction(params SetMessageReactionP) (bool, error) {
req := NewRequestWithChatID[bool]("setMessageReaction", params, params.ChatID) req := NewRequestWithChatID[bool]("setMessageReaction", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// Message update methods // EditMessageTextP holds parameters for the editMessageText method.
// See https://core.telegram.org/bots/api#editmessagetext
type EditMessageTextP struct { type EditMessageTextP struct {
BusinessConnectionID string `json:"business_connection_id,omitempty"` BusinessConnectionID string `json:"business_connection_id,omitempty"`
ChatID int64 `json:"chat_id,omitempty"` ChatID int64 `json:"chat_id,omitempty"`
@@ -315,8 +374,10 @@ type EditMessageTextP struct {
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"` ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
} }
// EditMessageText If inline message, first return will be zero-valued, and second will boolean // EditMessageText edits text messages.
// Otherwise, first return will be Message, and second false // If inline_message_id is provided, returns a boolean success flag;
// otherwise returns the edited Message.
// See https://core.telegram.org/bots/api#editmessagetext
func (api *API) EditMessageText(params EditMessageTextP) (Message, bool, error) { func (api *API) EditMessageText(params EditMessageTextP) (Message, bool, error) {
var zero Message var zero Message
if params.InlineMessageID != "" { if params.InlineMessageID != "" {
@@ -329,6 +390,8 @@ func (api *API) EditMessageText(params EditMessageTextP) (Message, bool, error)
return res, false, err return res, false, err
} }
// EditMessageCaptionP holds parameters for the editMessageCaption method.
// See https://core.telegram.org/bots/api#editmessagecaption
type EditMessageCaptionP struct { type EditMessageCaptionP struct {
BusinessConnectionID string `json:"business_connection_id,omitempty"` BusinessConnectionID string `json:"business_connection_id,omitempty"`
ChatID int64 `json:"chat_id,omitempty"` ChatID int64 `json:"chat_id,omitempty"`
@@ -339,8 +402,10 @@ type EditMessageCaptionP struct {
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"` ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
} }
// EditMessageCaption If inline message, first return will be zero-valued, and second will boolean // EditMessageCaption edits captions of messages.
// Otherwise, first return will be Message, and second false // If inline_message_id is provided, returns a boolean success flag;
// otherwise returns the edited Message.
// See https://core.telegram.org/bots/api#editmessagecaption
func (api *API) EditMessageCaption(params EditMessageCaptionP) (Message, bool, error) { func (api *API) EditMessageCaption(params EditMessageCaptionP) (Message, bool, error) {
var zero Message var zero Message
if params.InlineMessageID != "" { if params.InlineMessageID != "" {
@@ -353,6 +418,8 @@ func (api *API) EditMessageCaption(params EditMessageCaptionP) (Message, bool, e
return res, false, err return res, false, err
} }
// EditMessageMediaP holds parameters for the editMessageMedia method.
// See https://core.telegram.org/bots/api#editmessagemedia
type EditMessageMediaP struct { type EditMessageMediaP struct {
BusinessConnectionID string `json:"business_connection_id,omitempty"` BusinessConnectionID string `json:"business_connection_id,omitempty"`
ChatID int64 `json:"chat_id,omitempty"` ChatID int64 `json:"chat_id,omitempty"`
@@ -362,8 +429,10 @@ type EditMessageMediaP struct {
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
} }
// EditMessageMedia If inline message, first return will be zero-valued, and second will boolean // EditMessageMedia edits media messages.
// Otherwise, first return will be Message, and second false // If inline_message_id is provided, returns a boolean success flag;
// otherwise returns the edited Message.
// See https://core.telegram.org/bots/api#editmessagemedia
func (api *API) EditMessageMedia(params EditMessageMediaP) (Message, bool, error) { func (api *API) EditMessageMedia(params EditMessageMediaP) (Message, bool, error) {
var zero Message var zero Message
if params.InlineMessageID != "" { if params.InlineMessageID != "" {
@@ -376,6 +445,8 @@ func (api *API) EditMessageMedia(params EditMessageMediaP) (Message, bool, error
return res, false, err return res, false, err
} }
// EditMessageLiveLocationP holds parameters for the editMessageLiveLocation method.
// See https://core.telegram.org/bots/api#editmessagelivelocation
type EditMessageLiveLocationP struct { type EditMessageLiveLocationP struct {
BusinessConnectionID string `json:"business_connection_id,omitempty"` BusinessConnectionID string `json:"business_connection_id,omitempty"`
ChatID int64 `json:"chat_id,omitempty"` ChatID int64 `json:"chat_id,omitempty"`
@@ -391,8 +462,10 @@ type EditMessageLiveLocationP struct {
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
} }
// EditMessageLiveLocation If inline message, first return will be zero-valued, and second will boolean // EditMessageLiveLocation edits live location messages.
// Otherwise, first return will be Message, and second false // If inline_message_id is provided, returns a boolean success flag;
// otherwise returns the edited Message.
// See https://core.telegram.org/bots/api#editmessagelivelocation
func (api *API) EditMessageLiveLocation(params EditMessageLiveLocationP) (Message, bool, error) { func (api *API) EditMessageLiveLocation(params EditMessageLiveLocationP) (Message, bool, error) {
var zero Message var zero Message
if params.InlineMessageID != "" { if params.InlineMessageID != "" {
@@ -405,6 +478,8 @@ func (api *API) EditMessageLiveLocation(params EditMessageLiveLocationP) (Messag
return res, false, err return res, false, err
} }
// StopMessageLiveLocationP holds parameters for the stopMessageLiveLocation method.
// See https://core.telegram.org/bots/api#stopmessagelivelocation
type StopMessageLiveLocationP struct { type StopMessageLiveLocationP struct {
BusinessConnectionID string `json:"business_connection_id,omitempty"` BusinessConnectionID string `json:"business_connection_id,omitempty"`
ChatID int64 `json:"chat_id,omitempty"` ChatID int64 `json:"chat_id,omitempty"`
@@ -413,8 +488,10 @@ type StopMessageLiveLocationP struct {
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
} }
// StopMessageLiveLocation If inline message, first return will be zero-valued, and second will boolean // StopMessageLiveLocation stops a live location message.
// Otherwise, first return will be Message, and second false // If inline_message_id is provided, returns a boolean success flag;
// otherwise returns the edited Message.
// See https://core.telegram.org/bots/api#stopmessagelivelocation
func (api *API) StopMessageLiveLocation(params StopMessageLiveLocationP) (Message, bool, error) { func (api *API) StopMessageLiveLocation(params StopMessageLiveLocationP) (Message, bool, error) {
var zero Message var zero Message
if params.InlineMessageID != "" { if params.InlineMessageID != "" {
@@ -427,6 +504,7 @@ func (api *API) StopMessageLiveLocation(params StopMessageLiveLocationP) (Messag
return res, false, err return res, false, err
} }
// EditMessageChecklistP holds parameters for the editMessageChecklist method.
type EditMessageChecklistP struct { type EditMessageChecklistP struct {
BusinessConnectionID string `json:"business_connection_id"` BusinessConnectionID string `json:"business_connection_id"`
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
@@ -435,11 +513,15 @@ type EditMessageChecklistP struct {
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
} }
// EditMessageChecklist edits a checklist message.
// See https://core.telegram.org/bots/api#editmessagechecklist
func (api *API) EditMessageChecklist(params EditMessageChecklistP) (Message, error) { func (api *API) EditMessageChecklist(params EditMessageChecklistP) (Message, error) {
req := NewRequestWithChatID[Message]("editMessageChecklist", params, params.ChatID) req := NewRequestWithChatID[Message]("editMessageChecklist", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// EditMessageReplyMarkupP holds parameters for the editMessageReplyMarkup method.
// See https://core.telegram.org/bots/api#editmessagereplymarkup
type EditMessageReplyMarkupP struct { type EditMessageReplyMarkupP struct {
BusinessConnectionID string `json:"business_connection_id,omitempty"` BusinessConnectionID string `json:"business_connection_id,omitempty"`
ChatID int64 `json:"chat_id,omitempty"` ChatID int64 `json:"chat_id,omitempty"`
@@ -448,6 +530,10 @@ type EditMessageReplyMarkupP struct {
ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"` ReplyMarkup *InlineKeyboardMarkup `json:"reply_markup,omitempty"`
} }
// EditMessageReplyMarkup edits only the reply markup of messages.
// If inline_message_id is provided, returns a boolean success flag;
// otherwise returns the edited Message.
// See https://core.telegram.org/bots/api#editmessagereplymarkup
func (api *API) EditMessageReplyMarkup(params EditMessageReplyMarkupP) (Message, bool, error) { func (api *API) EditMessageReplyMarkup(params EditMessageReplyMarkupP) (Message, bool, error) {
var zero Message var zero Message
if params.InlineMessageID != "" { if params.InlineMessageID != "" {
@@ -460,6 +546,8 @@ func (api *API) EditMessageReplyMarkup(params EditMessageReplyMarkupP) (Message,
return res, false, err return res, false, err
} }
// StopPollP holds parameters for the stopPoll method.
// See https://core.telegram.org/bots/api#stoppoll
type StopPollP struct { type StopPollP struct {
BusinessConnectionID string `json:"business_connection_id,omitempty"` BusinessConnectionID string `json:"business_connection_id,omitempty"`
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
@@ -467,53 +555,78 @@ type StopPollP struct {
InlineMessageID string `json:"inline_message_id,omitempty"` InlineMessageID string `json:"inline_message_id,omitempty"`
} }
// StopPoll stops a poll that was sent by the bot.
// Returns the stopped Poll.
// See https://core.telegram.org/bots/api#stoppoll
func (api *API) StopPoll(params StopPollP) (Poll, error) { func (api *API) StopPoll(params StopPollP) (Poll, error) {
req := NewRequestWithChatID[Poll]("stopPoll", params, params.ChatID) req := NewRequestWithChatID[Poll]("stopPoll", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// ApproveSuggestedPostP holds parameters for the approveSuggestedPost method.
// See https://core.telegram.org/bots/api#approvesuggestedpost
type ApproveSuggestedPostP struct { type ApproveSuggestedPostP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
MessageID int `json:"message_id"` MessageID int `json:"message_id"`
SendDate int `json:"send_date,omitempty"` SendDate int `json:"send_date,omitempty"`
} }
// ApproveSuggestedPost approves a suggested channel post.
// Returns True on success.
// See https://core.telegram.org/bots/api#approvesuggestedpost
func (api *API) ApproveSuggestedPost(params ApproveSuggestedPostP) (bool, error) { func (api *API) ApproveSuggestedPost(params ApproveSuggestedPostP) (bool, error) {
req := NewRequestWithChatID[bool]("approveSuggestedPost", params, params.ChatID) req := NewRequestWithChatID[bool]("approveSuggestedPost", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// DeclineSuggestedPostP holds parameters for the declineSuggestedPost method.
// See https://core.telegram.org/bots/api#declinesuggestedpost
type DeclineSuggestedPostP struct { type DeclineSuggestedPostP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
MessageID int `json:"message_id"` MessageID int `json:"message_id"`
Comment string `json:"comment,omitempty"` Comment string `json:"comment,omitempty"`
} }
// DeclineSuggestedPost declines a suggested channel post.
// Returns True on success.
// See https://core.telegram.org/bots/api#declinesuggestedpost
func (api *API) DeclineSuggestedPost(params DeclineSuggestedPostP) (bool, error) { func (api *API) DeclineSuggestedPost(params DeclineSuggestedPostP) (bool, error) {
req := NewRequestWithChatID[bool]("declineSuggestedPost", params, params.ChatID) req := NewRequestWithChatID[bool]("declineSuggestedPost", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// DeleteMessageP holds parameters for the deleteMessage method.
// See https://core.telegram.org/bots/api#deletemessage
type DeleteMessageP struct { type DeleteMessageP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
MessageID int `json:"message_id"` MessageID int `json:"message_id"`
} }
// DeleteMessage deletes a message.
// Returns True on success.
// See https://core.telegram.org/bots/api#deletemessage
func (api *API) DeleteMessage(params DeleteMessageP) (bool, error) { func (api *API) DeleteMessage(params DeleteMessageP) (bool, error) {
req := NewRequestWithChatID[bool]("deleteMessage", params, params.ChatID) req := NewRequestWithChatID[bool]("deleteMessage", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// DeleteMessagesP holds parameters for the deleteMessages method.
// See https://core.telegram.org/bots/api#deletemessages
type DeleteMessagesP struct { type DeleteMessagesP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
MessageIDs []int `json:"message_ids"` MessageIDs []int `json:"message_ids"`
} }
// DeleteMessages deletes multiple messages at once.
// Returns True on success.
// See https://core.telegram.org/bots/api#deletemessages
func (api *API) DeleteMessages(params DeleteMessagesP) (bool, error) { func (api *API) DeleteMessages(params DeleteMessagesP) (bool, error) {
req := NewRequestWithChatID[bool]("deleteMessages", params, params.ChatID) req := NewRequestWithChatID[bool]("deleteMessages", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// AnswerCallbackQueryP holds parameters for the answerCallbackQuery method.
// See https://core.telegram.org/bots/api#answercallbackquery
type AnswerCallbackQueryP struct { type AnswerCallbackQueryP struct {
CallbackQueryID string `json:"callback_query_id"` CallbackQueryID string `json:"callback_query_id"`
Text string `json:"text,omitempty"` Text string `json:"text,omitempty"`
@@ -522,6 +635,9 @@ type AnswerCallbackQueryP struct {
CacheTime int `json:"cache_time,omitempty"` CacheTime int `json:"cache_time,omitempty"`
} }
// AnswerCallbackQuery sends answers to callback queries sent from inline keyboards.
// Returns True on success.
// See https://core.telegram.org/bots/api#answercallbackquery
func (api *API) AnswerCallbackQuery(params AnswerCallbackQueryP) (bool, error) { func (api *API) AnswerCallbackQuery(params AnswerCallbackQueryP) (bool, error) {
req := NewRequest[bool]("answerCallbackQuery", params) req := NewRequest[bool]("answerCallbackQuery", params)
return req.Do(api) return req.Do(api)

View File

@@ -2,15 +2,20 @@ package tgapi
import "git.nix13.pw/scuroneko/extypes" import "git.nix13.pw/scuroneko/extypes"
// MessageReplyMarkup represents an inline keyboard markup for a message.
// It is used in the Message type.
type MessageReplyMarkup struct { type MessageReplyMarkup struct {
InlineKeyboard [][]InlineKeyboardButton `json:"inline_keyboard"` InlineKeyboard [][]InlineKeyboardButton `json:"inline_keyboard"`
} }
// DirectMessageTopic represents a forum topic in a direct message.
type DirectMessageTopic struct { type DirectMessageTopic struct {
TopicID int64 `json:"topic_id"` TopicID int64 `json:"topic_id"`
User *User `json:"user,omitempty"` User *User `json:"user,omitempty"`
} }
// Message represents a Telegram message.
// See https://core.telegram.org/bots/api#message
type Message struct { type Message struct {
MessageID int `json:"message_id"` MessageID int `json:"message_id"`
MessageThreadID int `json:"message_thread_id,omitempty"` MessageThreadID int `json:"message_thread_id,omitempty"`
@@ -51,14 +56,19 @@ type Message struct {
EffectID string `json:"effect_id,omitempty"` EffectID string `json:"effect_id,omitempty"`
} }
// InaccessibleMessage describes a message that was deleted or is otherwise inaccessible.
// See https://core.telegram.org/bots/api#inaccessiblemessage
type InaccessibleMessage struct { type InaccessibleMessage struct {
Chat Chat `json:"chat"` Chat Chat `json:"chat"`
MessageID int `json:"message_id"` MessageID int `json:"message_id"`
Date int `json:"date"` Date int `json:"date"`
} }
// MaybeInaccessibleMessage is a union type that can be either Message or InaccessibleMessage.
// See https://core.telegram.org/bots/api#maybeinaccessiblemessage
type MaybeInaccessibleMessage interface{ Message | InaccessibleMessage } type MaybeInaccessibleMessage interface{ Message | InaccessibleMessage }
// MessageEntityType represents the type of a message entity.
type MessageEntityType string type MessageEntityType string
const ( const (
@@ -84,6 +94,8 @@ const (
MessageEntityDateTime MessageEntityType = "date_time" MessageEntityDateTime MessageEntityType = "date_time"
) )
// MessageEntity represents one special entity in a text message.
// See https://core.telegram.org/bots/api#messageentity
type MessageEntity struct { type MessageEntity struct {
Type MessageEntityType `json:"type"` Type MessageEntityType `json:"type"`
@@ -98,6 +110,8 @@ type MessageEntity struct {
DateTimeFormat string `json:"date_time_format,omitempty"` DateTimeFormat string `json:"date_time_format,omitempty"`
} }
// ReplyParameters describes the parameters to use when replying to a message.
// See https://core.telegram.org/bots/api#replyparameters
type ReplyParameters struct { type ReplyParameters struct {
MessageID int `json:"message_id"` MessageID int `json:"message_id"`
ChatID int `json:"chat_id,omitempty"` ChatID int `json:"chat_id,omitempty"`
@@ -110,6 +124,8 @@ type ReplyParameters struct {
ChecklistTaskID int `json:"checklist_task_id,omitempty"` ChecklistTaskID int `json:"checklist_task_id,omitempty"`
} }
// LinkPreviewOptions describes the options used for link preview generation.
// See https://core.telegram.org/bots/api#linkpreviewoptions
type LinkPreviewOptions struct { type LinkPreviewOptions struct {
IsDisabled bool `json:"is_disabled,omitempty"` IsDisabled bool `json:"is_disabled,omitempty"`
URL string `json:"url,omitempty"` URL string `json:"url,omitempty"`
@@ -118,6 +134,8 @@ type LinkPreviewOptions struct {
ShowAboveText bool `json:"show_above_text,omitempty"` ShowAboveText bool `json:"show_above_text,omitempty"`
} }
// ReplyMarkup represents a custom keyboard or inline keyboard.
// See https://core.telegram.org/bots/api#replymarkup
type ReplyMarkup struct { type ReplyMarkup struct {
InlineKeyboard [][]InlineKeyboardButton `json:"inline_keyboard,omitempty"` InlineKeyboard [][]InlineKeyboardButton `json:"inline_keyboard,omitempty"`
@@ -132,11 +150,18 @@ type ReplyMarkup struct {
ForceReply bool `json:"force_reply,omitempty"` ForceReply bool `json:"force_reply,omitempty"`
} }
// InlineKeyboardMarkup represents an inline keyboard that appears right next to the message it belongs to.
// See https://core.telegram.org/bots/api#inlinekeyboardmarkup
type InlineKeyboardMarkup struct { type InlineKeyboardMarkup struct {
InlineKeyboard [][]InlineKeyboardButton `json:"inline_keyboard,omitempty"` InlineKeyboard [][]InlineKeyboardButton `json:"inline_keyboard,omitempty"`
} }
// KeyboardButtonStyle represents the style of a keyboard button.
type KeyboardButtonStyle string type KeyboardButtonStyle string
// InlineKeyboardButton represents one button of an inline keyboard.
// See https://core.telegram.org/bots/api#inlinekeyboardbutton
type InlineKeyboardButton struct { type InlineKeyboardButton struct {
Text string `json:"text"` Text string `json:"text"`
URL string `json:"url,omitempty"` URL string `json:"url,omitempty"`
@@ -145,10 +170,14 @@ type InlineKeyboardButton struct {
IconCustomEmojiID string `json:"icon_custom_emoji_id,omitempty"` IconCustomEmojiID string `json:"icon_custom_emoji_id,omitempty"`
} }
// ReplyKeyboardMarkup represents a custom keyboard with reply options.
// See https://core.telegram.org/bots/api#replykeyboardmarkup
type ReplyKeyboardMarkup struct { type ReplyKeyboardMarkup struct {
Keyboard [][]int `json:"keyboard"` Keyboard [][]int `json:"keyboard"`
} }
// CallbackQuery represents an incoming callback query from a callback button in an inline keyboard.
// See https://core.telegram.org/bots/api#callbackquery
type CallbackQuery struct { type CallbackQuery struct {
ID string `json:"id"` ID string `json:"id"`
From User `json:"from"` From User `json:"from"`
@@ -157,11 +186,15 @@ type CallbackQuery struct {
Data string `json:"data"` Data string `json:"data"`
} }
// InputPollOption contains information about one answer option in a poll to be sent.
// See https://core.telegram.org/bots/api#inputpolloption
type InputPollOption struct { type InputPollOption struct {
Text string `json:"text"` Text string `json:"text"`
TextParseMode ParseMode `json:"text_parse_mode,omitempty"` TextParseMode ParseMode `json:"text_parse_mode,omitempty"`
TextEntities []*MessageEntity `json:"text_entities,omitempty"` TextEntities []*MessageEntity `json:"text_entities,omitempty"`
} }
// PollType represents the type of a poll.
type PollType string type PollType string
const ( const (
@@ -169,12 +202,15 @@ const (
PollTypeQuiz PollType = "quiz" PollTypeQuiz PollType = "quiz"
) )
// InputChecklistTask describes a task in a checklist.
type InputChecklistTask struct { type InputChecklistTask struct {
ID int `json:"id"` ID int `json:"id"`
Text string `json:"text"` Text string `json:"text"`
ParseMode ParseMode `json:"parse_mode,omitempty"` ParseMode ParseMode `json:"parse_mode,omitempty"`
TextEntities []*MessageEntity `json:"text_entities,omitempty"` TextEntities []*MessageEntity `json:"text_entities,omitempty"`
} }
// InputChecklist represents a checklist to be sent.
type InputChecklist struct { type InputChecklist struct {
Title string `json:"title"` Title string `json:"title"`
ParseMode ParseMode `json:"parse_mode,omitempty"` ParseMode ParseMode `json:"parse_mode,omitempty"`
@@ -184,6 +220,7 @@ type InputChecklist struct {
OtherCanMarkTasksAsDone bool `json:"other_can_mark_tasks_as_done,omitempty"` OtherCanMarkTasksAsDone bool `json:"other_can_mark_tasks_as_done,omitempty"`
} }
// ChatActionType represents the type of chat action.
type ChatActionType string type ChatActionType string
const ( const (
@@ -197,6 +234,8 @@ const (
ChatActionUploadVideoNone ChatActionType = "upload_video_none" ChatActionUploadVideoNone ChatActionType = "upload_video_none"
) )
// MessageReactionUpdated represents a change of a reaction on a message.
// See https://core.telegram.org/bots/api#messagereactionupdated
type MessageReactionUpdated struct { type MessageReactionUpdated struct {
Chat *Chat `json:"chat"` Chat *Chat `json:"chat"`
MessageID int `json:"message_id"` MessageID int `json:"message_id"`
@@ -207,12 +246,17 @@ type MessageReactionUpdated struct {
NewReaction []ReactionType `json:"new_reaction"` NewReaction []ReactionType `json:"new_reaction"`
} }
// MessageReactionCountUpdated represents a change in the count of reactions on a message.
// See https://core.telegram.org/bots/api#messagereactioncountupdated
type MessageReactionCountUpdated struct { type MessageReactionCountUpdated struct {
Chat *Chat `json:"chat"` Chat *Chat `json:"chat"`
MessageID int `json:"message_id"` MessageID int `json:"message_id"`
Date int `json:"date"` Date int `json:"date"`
Reactions []*ReactionCount `json:"reactions"` Reactions []*ReactionCount `json:"reactions"`
} }
// ReactionType describes the type of a reaction.
// See https://core.telegram.org/bots/api#reactiontype
type ReactionType struct { type ReactionType struct {
Type string `json:"type"` Type string `json:"type"`
// ReactionTypeEmoji // ReactionTypeEmoji
@@ -220,20 +264,29 @@ type ReactionType struct {
// ReactionTypeCustomEmoji // ReactionTypeCustomEmoji
CustomEmojiID *string `json:"custom_emoji_id,omitempty"` CustomEmojiID *string `json:"custom_emoji_id,omitempty"`
} }
// 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
type ReactionCount struct { type ReactionCount struct {
Type ReactionType `json:"type"` Type ReactionType `json:"type"`
TotalCount int `json:"total_count"` TotalCount int `json:"total_count"`
} }
// SuggestedPostPrice represents the price of a suggested post.
type SuggestedPostPrice struct { type SuggestedPostPrice struct {
Currency string `json:"currency"` Currency string `json:"currency"`
Amount int `json:"amount"` Amount int `json:"amount"`
} }
// SuggestedPostInfo contains information about a suggested post.
// See https://core.telegram.org/bots/api#suggestedpostinfo
type SuggestedPostInfo struct { type SuggestedPostInfo struct {
State string `json:"state"` //State of the suggested post. Currently, it can be one of “pending, approved, declined”. State string `json:"state"` // "pending", "approved", or "declined"
Price SuggestedPostPrice `json:"price"` Price SuggestedPostPrice `json:"price"`
SendDate int `json:"send_date"` SendDate int `json:"send_date"`
} }
// SuggestedPostParameters holds parameters for suggesting a post.
type SuggestedPostParameters struct { type SuggestedPostParameters struct {
Price SuggestedPostPrice `json:"price"` Price SuggestedPostPrice `json:"price"`
SendDate int `json:"send_date"` SendDate int `json:"send_date"`

View File

@@ -6,19 +6,28 @@ import (
"net/http" "net/http"
) )
// ParseMode represents the text formatting mode for message parsing.
type ParseMode string type ParseMode string
const ( const (
// ParseMDV2 enables MarkdownV2 style parsing.
ParseMDV2 ParseMode = "MarkdownV2" ParseMDV2 ParseMode = "MarkdownV2"
// ParseHTML enables HTML style parsing.
ParseHTML ParseMode = "HTML" ParseHTML ParseMode = "HTML"
ParseMD ParseMode = "Markdown" // ParseMD enables legacy Markdown style parsing.
ParseMD ParseMode = "Markdown"
// ParseNone disables any parsing.
ParseNone ParseMode = "None" ParseNone ParseMode = "None"
) )
// EmptyParams is a placeholder for methods that take no parameters.
type EmptyParams struct{} type EmptyParams struct{}
// NoParams is a convenient instance of EmptyParams.
var NoParams = EmptyParams{} var NoParams = EmptyParams{}
// UpdateParams holds parameters for the getUpdates method.
// See https://core.telegram.org/bots/api#getupdates
type UpdateParams struct { type UpdateParams struct {
Offset *int `json:"offset,omitempty"` Offset *int `json:"offset,omitempty"`
Limit *int `json:"limit,omitempty"` Limit *int `json:"limit,omitempty"`
@@ -26,32 +35,52 @@ type UpdateParams struct {
AllowedUpdates []UpdateType `json:"allowed_updates"` AllowedUpdates []UpdateType `json:"allowed_updates"`
} }
// GetMe returns basic information about the bot.
// See https://core.telegram.org/bots/api#getme
func (api *API) GetMe() (User, error) { func (api *API) GetMe() (User, error) {
req := NewRequest[User, EmptyParams]("getMe", NoParams) req := NewRequest[User, EmptyParams]("getMe", NoParams)
return req.Do(api) return req.Do(api)
} }
// LogOut logs the bot out from the cloud Bot API server.
// Returns true on success.
// See https://core.telegram.org/bots/api#logout
func (api *API) LogOut() (bool, error) { func (api *API) LogOut() (bool, error) {
req := NewRequest[bool, EmptyParams]("logOut", NoParams) req := NewRequest[bool, EmptyParams]("logOut", NoParams)
return req.Do(api) return req.Do(api)
} }
// Close closes the bot instance on the local server.
// Returns true on success.
// See https://core.telegram.org/bots/api#close
func (api *API) Close() (bool, error) { func (api *API) Close() (bool, error) {
req := NewRequest[bool, EmptyParams]("close", NoParams) req := NewRequest[bool, EmptyParams]("close", NoParams)
return req.Do(api) return req.Do(api)
} }
// GetUpdates receives incoming updates using long polling.
// See https://core.telegram.org/bots/api#getupdates
func (api *API) GetUpdates(params UpdateParams) ([]Update, error) { func (api *API) GetUpdates(params UpdateParams) ([]Update, error) {
req := NewRequest[[]Update]("getUpdates", params) req := NewRequest[[]Update]("getUpdates", params)
return req.Do(api) return req.Do(api)
} }
// GetFileP holds parameters for the getFile method.
// See https://core.telegram.org/bots/api#getfile
type GetFileP struct { type GetFileP struct {
FileId string `json:"file_id"` FileId string `json:"file_id"`
} }
// GetFile returns basic information about a file and prepares it for downloading.
// See https://core.telegram.org/bots/api#getfile
func (api *API) GetFile(params GetFileP) (File, error) { func (api *API) GetFile(params GetFileP) (File, error) {
req := NewRequest[File]("getFile", params) req := NewRequest[File]("getFile", params)
return req.Do(api) return req.Do(api)
} }
// GetFileByLink downloads a file from Telegram's file server using the provided file link.
// The link is usually obtained from File.FilePath.
// See https://core.telegram.org/bots/api#file
func (api *API) GetFileByLink(link string) ([]byte, error) { func (api *API) GetFileByLink(link string) ([]byte, error) {
u := fmt.Sprintf("https://api.telegram.org/file/bot%s/%s", api.token, link) u := fmt.Sprintf("https://api.telegram.org/file/bot%s/%s", api.token, link)
res, err := http.Get(u) res, err := http.Get(u)

View File

@@ -1,5 +1,7 @@
package tgapi package tgapi
// SendStickerP holds parameters for the sendSticker method.
// See https://core.telegram.org/bots/api#sendsticker
type SendStickerP struct { type SendStickerP struct {
BusinessConnectionID string `json:"business_connection_id,omitempty"` BusinessConnectionID string `json:"business_connection_id,omitempty"`
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
@@ -14,29 +16,41 @@ type SendStickerP struct {
MessageEffectID string `json:"message_effect_id,omitempty"` MessageEffectID string `json:"message_effect_id,omitempty"`
} }
// SendSticker sends a static .WEBP, animated .TGS, or video .WEBM sticker.
// See https://core.telegram.org/bots/api#sendsticker
func (api *API) SendSticker(params SendStickerP) (Message, error) { func (api *API) SendSticker(params SendStickerP) (Message, error) {
req := NewRequestWithChatID[Message]("sendSticker", params, params.ChatID) req := NewRequestWithChatID[Message]("sendSticker", params, params.ChatID)
return req.Do(api) return req.Do(api)
} }
// GetStickerSetP holds parameters for the getStickerSet method.
// See https://core.telegram.org/bots/api#getstickerset
type GetStickerSetP struct { type GetStickerSetP struct {
Name string `json:"name"` Name string `json:"name"`
} }
// GetStickerSet returns a sticker set by its name.
// See https://core.telegram.org/bots/api#getstickerset
func (api *API) GetStickerSet(params GetStickerSetP) (StickerSet, error) { func (api *API) GetStickerSet(params GetStickerSetP) (StickerSet, error) {
req := NewRequest[StickerSet]("getStickerSet", params) req := NewRequest[StickerSet]("getStickerSet", params)
return req.Do(api) return req.Do(api)
} }
// GetCustomEmojiStickersP holds parameters for the getCustomEmojiStickers method.
// See https://core.telegram.org/bots/api#getcustomemojistickers
type GetCustomEmojiStickersP struct { type GetCustomEmojiStickersP struct {
CustomEmojiIDs []string `json:"custom_emoji_ids"` CustomEmojiIDs []string `json:"custom_emoji_ids"`
} }
// GetCustomEmojiStickers returns information about custom emoji stickers by their IDs.
// See https://core.telegram.org/bots/api#getcustomemojistickers
func (api *API) GetCustomEmojiStickers(params GetCustomEmojiStickersP) ([]Sticker, error) { func (api *API) GetCustomEmojiStickers(params GetCustomEmojiStickersP) ([]Sticker, error) {
req := NewRequest[[]Sticker]("getCustomEmojiStickers", params) req := NewRequest[[]Sticker]("getCustomEmojiStickers", params)
return req.Do(api) return req.Do(api)
} }
// CreateNewStickerSetP holds parameters for the createNewStickerSet method.
// See https://core.telegram.org/bots/api#createnewstickerset
type CreateNewStickerSetP struct { type CreateNewStickerSetP struct {
UserID int `json:"user_id"` UserID int `json:"user_id"`
Name string `json:"name"` Name string `json:"name"`
@@ -47,41 +61,61 @@ type CreateNewStickerSetP struct {
NeedsRepainting bool `json:"needs_repainting,omitempty"` NeedsRepainting bool `json:"needs_repainting,omitempty"`
} }
// CreateNewStickerSet creates a new sticker set owned by a user.
// Returns True on success.
// See https://core.telegram.org/bots/api#createnewstickerset
func (api *API) CreateNewStickerSet(params CreateNewStickerSetP) (bool, error) { func (api *API) CreateNewStickerSet(params CreateNewStickerSetP) (bool, error) {
req := NewRequest[bool]("createNewStickerSet", params) req := NewRequest[bool]("createNewStickerSet", params)
return req.Do(api) return req.Do(api)
} }
// AddStickerToSetP holds parameters for the addStickerToSet method.
// See https://core.telegram.org/bots/api#addstickertoset
type AddStickerToSetP struct { type AddStickerToSetP struct {
UserID int `json:"user_id"` UserID int `json:"user_id"`
Name string `json:"name"` Name string `json:"name"`
Sticker InputSticker `json:"sticker"` Sticker InputSticker `json:"sticker"`
} }
// AddStickerToSet adds a new sticker to a set created by the bot.
// Returns True on success.
// See https://core.telegram.org/bots/api#addstickertoset
func (api *API) AddStickerToSet(params AddStickerToSetP) (bool, error) { func (api *API) AddStickerToSet(params AddStickerToSetP) (bool, error) {
req := NewRequest[bool]("addStickerToSet", params) req := NewRequest[bool]("addStickerToSet", params)
return req.Do(api) return req.Do(api)
} }
// SetStickerPositionInSetP holds parameters for the setStickerPositionInSet method.
// See https://core.telegram.org/bots/api#setstickerpositioninset
type SetStickerPositionInSetP struct { type SetStickerPositionInSetP struct {
Sticker string `json:"sticker"` Sticker string `json:"sticker"`
Position int `json:"position"` Position int `json:"position"`
} }
func (api *API) SetStickerPosition(params SetStickerPositionInSetP) (bool, error) { // SetStickerPositionInSet moves a sticker in a set to a specific position.
req := NewRequest[bool]("setStickerPosition", params) // Returns True on success.
// See https://core.telegram.org/bots/api#setstickerpositioninset
func (api *API) SetStickerPositionInSet(params SetStickerPositionInSetP) (bool, error) {
req := NewRequest[bool]("setStickerPositionInSet", params)
return req.Do(api) return req.Do(api)
} }
// DeleteStickerFromSetP holds parameters for the deleteStickerFromSet method.
// See https://core.telegram.org/bots/api#deletestickerfromset
type DeleteStickerFromSetP struct { type DeleteStickerFromSetP struct {
Sticker string `json:"sticker"` Sticker string `json:"sticker"`
} }
// DeleteStickerFromSet deletes a sticker from a set created by the bot.
// Returns True on success.
// See https://core.telegram.org/bots/api#deletestickerfromset
func (api *API) DeleteStickerFromSet(params DeleteStickerFromSetP) (bool, error) { func (api *API) DeleteStickerFromSet(params DeleteStickerFromSetP) (bool, error) {
req := NewRequest[bool]("deleteStickerFromSet", params) req := NewRequest[bool]("deleteStickerFromSet", params)
return req.Do(api) return req.Do(api)
} }
// ReplaceStickerInSetP holds parameters for the replaceStickerInSet method.
// See https://core.telegram.org/bots/api#replacestickerinset
type ReplaceStickerInSetP struct { type ReplaceStickerInSetP struct {
UserID int `json:"user_id"` UserID int `json:"user_id"`
Name string `json:"name"` Name string `json:"name"`
@@ -89,51 +123,76 @@ type ReplaceStickerInSetP struct {
Sticker InputSticker `json:"sticker"` Sticker InputSticker `json:"sticker"`
} }
// ReplaceStickerInSet replaces an existing sticker in a set with a new one.
// Returns True on success.
// See https://core.telegram.org/bots/api#replacestickerinset
func (api *API) ReplaceStickerInSet(params ReplaceStickerInSetP) (bool, error) { func (api *API) ReplaceStickerInSet(params ReplaceStickerInSetP) (bool, error) {
req := NewRequest[bool]("replaceStickerInSet", params) req := NewRequest[bool]("replaceStickerInSet", params)
return req.Do(api) return req.Do(api)
} }
// SetStickerEmojiListP holds parameters for the setStickerEmojiList method.
// See https://core.telegram.org/bots/api#setstickeremojilist
type SetStickerEmojiListP struct { type SetStickerEmojiListP struct {
Sticker string `json:"sticker"` Sticker string `json:"sticker"`
EmojiList []string `json:"emoji_list"` EmojiList []string `json:"emoji_list"`
} }
// SetStickerEmojiList changes the list of emoji associated with a sticker.
// Returns True on success.
// See https://core.telegram.org/bots/api#setstickeremojilist
func (api *API) SetStickerEmojiList(params SetStickerEmojiListP) (bool, error) { func (api *API) SetStickerEmojiList(params SetStickerEmojiListP) (bool, error) {
req := NewRequest[bool]("setStickerEmojiList", params) req := NewRequest[bool]("setStickerEmojiList", params)
return req.Do(api) return req.Do(api)
} }
// SetStickerKeywordsP holds parameters for the setStickerKeywords method.
// See https://core.telegram.org/bots/api#setstickerkeywords
type SetStickerKeywordsP struct { type SetStickerKeywordsP struct {
Sticker string `json:"sticker"` Sticker string `json:"sticker"`
Keywords []string `json:"keywords"` Keywords []string `json:"keywords"`
} }
// SetStickerKeywords changes the keywords of a sticker.
// Returns True on success.
// See https://core.telegram.org/bots/api#setstickerkeywords
func (api *API) SetStickerKeywords(params SetStickerKeywordsP) (bool, error) { func (api *API) SetStickerKeywords(params SetStickerKeywordsP) (bool, error) {
req := NewRequest[bool]("setStickerKeywords", params) req := NewRequest[bool]("setStickerKeywords", params)
return req.Do(api) return req.Do(api)
} }
// SetStickerMaskPositionP holds parameters for the setStickerMaskPosition method.
// See https://core.telegram.org/bots/api#setstickermaskposition
type SetStickerMaskPositionP struct { type SetStickerMaskPositionP struct {
Sticker string `json:"sticker"` Sticker string `json:"sticker"`
MaskPosition *MaskPosition `json:"mask_position,omitempty"` MaskPosition *MaskPosition `json:"mask_position,omitempty"`
} }
// SetStickerMaskPosition changes the mask position of a mask sticker.
// Returns True on success.
// See https://core.telegram.org/bots/api#setstickermaskposition
func (api *API) SetStickerMaskPosition(params SetStickerMaskPositionP) (bool, error) { func (api *API) SetStickerMaskPosition(params SetStickerMaskPositionP) (bool, error) {
req := NewRequest[bool]("setStickerMaskPosition", params) req := NewRequest[bool]("setStickerMaskPosition", params)
return req.Do(api) return req.Do(api)
} }
// SetStickerSetTitleP holds parameters for the setStickerSetTitle method.
// See https://core.telegram.org/bots/api#setstickersettitle
type SetStickerSetTitleP struct { type SetStickerSetTitleP struct {
Name string `json:"name"` Name string `json:"name"`
Title string `json:"title"` Title string `json:"title"`
} }
// SetStickerSetTitle sets the title of a sticker set created by the bot.
// Returns True on success.
// See https://core.telegram.org/bots/api#setstickersettitle
func (api *API) SetStickerSetTitle(params SetStickerSetTitleP) (bool, error) { func (api *API) SetStickerSetTitle(params SetStickerSetTitleP) (bool, error) {
req := NewRequest[bool]("setStickerSetTitle", params) req := NewRequest[bool]("setStickerSetTitle", params)
return req.Do(api) return req.Do(api)
} }
// SetStickerSetThumbnailP holds parameters for the setStickerSetThumbnail method.
// See https://core.telegram.org/bots/api#setstickersetthumbnail
type SetStickerSetThumbnailP struct { type SetStickerSetThumbnailP struct {
Name string `json:"name"` Name string `json:"name"`
UserID int `json:"user_id"` UserID int `json:"user_id"`
@@ -141,25 +200,40 @@ type SetStickerSetThumbnailP struct {
Format InputStickerFormat `json:"format"` Format InputStickerFormat `json:"format"`
} }
// SetStickerSetThumbnail sets the thumbnail of a sticker set.
// Returns True on success.
// See https://core.telegram.org/bots/api#setstickersetthumbnail
func (api *API) SetStickerSetThumbnail(params SetStickerSetThumbnailP) (bool, error) { func (api *API) SetStickerSetThumbnail(params SetStickerSetThumbnailP) (bool, error) {
req := NewRequest[bool]("setStickerSetThumbnail", params) req := NewRequest[bool]("setStickerSetThumbnail", params)
return req.Do(api) return req.Do(api)
} }
// SetCustomEmojiStickerSetThumbnailP holds parameters for the setCustomEmojiStickerSetThumbnail method.
// See https://core.telegram.org/bots/api#setcustomemojistickersetthumbnail
type SetCustomEmojiStickerSetThumbnailP struct { type SetCustomEmojiStickerSetThumbnailP struct {
Name string `json:"name"` Name string `json:"name"`
CustomEmojiID string `json:"custom_emoji_id,omitempty"` CustomEmojiID string `json:"custom_emoji_id,omitempty"`
} }
// SetCustomEmojiStickerSetThumbnail sets the thumbnail of a custom emoji sticker set.
// Returns True on success.
// See https://core.telegram.org/bots/api#setcustomemojistickersetthumbnail
//
// Note: This method uses SetStickerSetThumbnailP as its parameter type, which might be inconsistent.
func (api *API) SetCustomEmojiStickerSetThumbnail(params SetStickerSetThumbnailP) (bool, error) { func (api *API) SetCustomEmojiStickerSetThumbnail(params SetStickerSetThumbnailP) (bool, error) {
req := NewRequest[bool]("setCustomEmojiStickerSetThumbnail", params) req := NewRequest[bool]("setCustomEmojiStickerSetThumbnail", params)
return req.Do(api) return req.Do(api)
} }
// DeleteStickerSetP holds parameters for the deleteStickerSet method.
// See https://core.telegram.org/bots/api#deletestickerset
type DeleteStickerSetP struct { type DeleteStickerSetP struct {
Name string `json:"name"` Name string `json:"name"`
} }
// DeleteStickerSet deletes a sticker set created by the bot.
// Returns True on success.
// See https://core.telegram.org/bots/api#deletestickerset
func (api *API) DeleteStickerSet(params DeleteStickerSetP) (bool, error) { func (api *API) DeleteStickerSet(params DeleteStickerSetP) (bool, error) {
req := NewRequest[bool]("deleteStickerSet", params) req := NewRequest[bool]("deleteStickerSet", params)
return req.Do(api) return req.Do(api)

View File

@@ -1,14 +1,21 @@
package tgapi package tgapi
// MaskPositionPoint represents the part of the face where a mask should be placed.
type MaskPositionPoint string type MaskPositionPoint string
const ( const (
// MaskPositionForehead places the mask on the forehead.
MaskPositionForehead MaskPositionPoint = "forehead" MaskPositionForehead MaskPositionPoint = "forehead"
MaskPositionEyes MaskPositionPoint = "eyes" // MaskPositionEyes places the mask on the eyes.
MaskPositionMouth MaskPositionPoint = "mouth" MaskPositionEyes MaskPositionPoint = "eyes"
MaskPositionChin MaskPositionPoint = "chin" // MaskPositionMouth places the mask on the mouth.
MaskPositionMouth MaskPositionPoint = "mouth"
// MaskPositionChin places the mask on the chin.
MaskPositionChin MaskPositionPoint = "chin"
) )
// MaskPosition describes the position on faces where a mask should be placed by default.
// See https://core.telegram.org/bots/api#maskposition
type MaskPosition struct { type MaskPosition struct {
Point MaskPositionPoint `json:"point"` Point MaskPositionPoint `json:"point"`
XShift float32 `json:"x_shift"` XShift float32 `json:"x_shift"`
@@ -16,14 +23,20 @@ type MaskPosition struct {
Scale float32 `json:"scale"` Scale float32 `json:"scale"`
} }
// StickerType represents the type of a sticker.
type StickerType string type StickerType string
const ( const (
StickerTypeRegular StickerType = "regular" // StickerTypeRegular is a regular sticker.
StickerTypeMask StickerType = "mask" StickerTypeRegular StickerType = "regular"
// StickerTypeMask is a mask sticker that can be placed on faces.
StickerTypeMask StickerType = "mask"
// StickerTypeCustomEmoji is a custom emoji sticker.
StickerTypeCustomEmoji StickerType = "custom_emoji" StickerTypeCustomEmoji StickerType = "custom_emoji"
) )
// Sticker represents a sticker.
// See https://core.telegram.org/bots/api#sticker
type Sticker struct { type Sticker struct {
FileId string `json:"file_id"` FileId string `json:"file_id"`
FileUniqueId string `json:"file_unique_id"` FileUniqueId string `json:"file_unique_id"`
@@ -41,6 +54,9 @@ type Sticker struct {
NeedRepainting *bool `json:"need_repainting,omitempty"` NeedRepainting *bool `json:"need_repainting,omitempty"`
FileSize *int `json:"file_size,omitempty"` FileSize *int `json:"file_size,omitempty"`
} }
// StickerSet represents a sticker set.
// See https://core.telegram.org/bots/api#stickerset
type StickerSet struct { type StickerSet struct {
Name string `json:"name"` Name string `json:"name"`
Title string `json:"title"` Title string `json:"title"`
@@ -48,14 +64,21 @@ type StickerSet struct {
Stickers []Sticker `json:"stickers"` Stickers []Sticker `json:"stickers"`
Thumbnail *PhotoSize `json:"thumbnail,omitempty"` Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
} }
// InputStickerFormat represents the format of an input sticker.
type InputStickerFormat string type InputStickerFormat string
const ( const (
InputStickerFormatStatic InputStickerFormat = "static" // InputStickerFormatStatic is a static sticker (WEBP).
InputStickerFormatStatic InputStickerFormat = "static"
// InputStickerFormatAnimated is an animated sticker (TGS).
InputStickerFormatAnimated InputStickerFormat = "animated" InputStickerFormatAnimated InputStickerFormat = "animated"
InputStickerFormatVideo InputStickerFormat = "video" // InputStickerFormatVideo is a video sticker (WEBM).
InputStickerFormatVideo InputStickerFormat = "video"
) )
// InputSticker describes a sticker to be added to a sticker set.
// See https://core.telegram.org/bots/api#inputsticker
type InputSticker struct { type InputSticker struct {
Sticker string `json:"sticker"` Sticker string `json:"sticker"`
Format InputStickerFormat `json:"format"` Format InputStickerFormat `json:"format"`

View File

@@ -1,35 +1,61 @@
package tgapi package tgapi
// UpdateType represents the type of incoming update.
type UpdateType string type UpdateType string
const ( const (
UpdateTypeMessage UpdateType = "message" // UpdateTypeMessage is a regular message update.
UpdateTypeEditedMessage UpdateType = "edited_message" UpdateTypeMessage UpdateType = "message"
UpdateTypeChannelPost UpdateType = "channel_post" // UpdateTypeEditedMessage is an edited message update.
UpdateTypeEditedChannelPost UpdateType = "edited_channel_post" UpdateTypeEditedMessage UpdateType = "edited_message"
UpdateTypeMessageReaction UpdateType = "message_reaction" // UpdateTypeChannelPost is a channel post update.
UpdateTypeChannelPost UpdateType = "channel_post"
// UpdateTypeEditedChannelPost is an edited channel post update.
UpdateTypeEditedChannelPost UpdateType = "edited_channel_post"
// UpdateTypeMessageReaction is a message reaction update.
UpdateTypeMessageReaction UpdateType = "message_reaction"
// UpdateTypeMessageReactionCount is a message reaction count update.
UpdateTypeMessageReactionCount UpdateType = "message_reaction_count" UpdateTypeMessageReactionCount UpdateType = "message_reaction_count"
UpdateTypeBusinessConnection UpdateType = "business_connection" // UpdateTypeBusinessConnection is a business connection update.
UpdateTypeBusinessMessage UpdateType = "business_message" UpdateTypeBusinessConnection UpdateType = "business_connection"
UpdateTypeEditedBusinessMessage UpdateType = "edited_business_message" // UpdateTypeBusinessMessage is a business message update.
UpdateTypeBusinessMessage UpdateType = "business_message"
// UpdateTypeEditedBusinessMessage is an edited business message update.
UpdateTypeEditedBusinessMessage UpdateType = "edited_business_message"
// UpdateTypeDeletedBusinessMessage is a deleted business message update.
UpdateTypeDeletedBusinessMessage UpdateType = "deleted_business_message" UpdateTypeDeletedBusinessMessage UpdateType = "deleted_business_message"
UpdateTypeInlineQuery UpdateType = "inline_query" // UpdateTypeInlineQuery is an inline query update.
UpdateTypeInlineQuery UpdateType = "inline_query"
// UpdateTypeChosenInlineResult is a chosen inline result update.
UpdateTypeChosenInlineResult UpdateType = "chosen_inline_result" UpdateTypeChosenInlineResult UpdateType = "chosen_inline_result"
UpdateTypeCallbackQuery UpdateType = "callback_query" // UpdateTypeCallbackQuery is a callback query update.
UpdateTypeShippingQuery UpdateType = "shipping_query" UpdateTypeCallbackQuery UpdateType = "callback_query"
UpdateTypePreCheckoutQuery UpdateType = "pre_checkout_query" // UpdateTypeShippingQuery is a shipping query update.
UpdateTypeShippingQuery UpdateType = "shipping_query"
// UpdateTypePreCheckoutQuery is a pre-checkout query update.
UpdateTypePreCheckoutQuery UpdateType = "pre_checkout_query"
// UpdateTypePurchasedPaidMedia is a purchased paid media update.
UpdateTypePurchasedPaidMedia UpdateType = "purchased_paid_media" UpdateTypePurchasedPaidMedia UpdateType = "purchased_paid_media"
UpdateTypePoll UpdateType = "poll" // UpdateTypePoll is a poll update.
UpdateTypePollAnswer UpdateType = "poll_answer" UpdateTypePoll UpdateType = "poll"
UpdateTypeMyChatMember UpdateType = "my_chat_member" // UpdateTypePollAnswer is a poll answer update.
UpdateTypeChatMember UpdateType = "chat_member" UpdateTypePollAnswer UpdateType = "poll_answer"
UpdateTypeChatJoinRequest UpdateType = "chat_join_request" // UpdateTypeMyChatMember is a my chat member update.
UpdateTypeChatBoost UpdateType = "chat_boost" UpdateTypeMyChatMember UpdateType = "my_chat_member"
UpdateTypeRemovedChatBoost UpdateType = "removed_chat_boost" // UpdateTypeChatMember is a chat member update.
UpdateTypeChatMember UpdateType = "chat_member"
// UpdateTypeChatJoinRequest is a chat join request update.
UpdateTypeChatJoinRequest UpdateType = "chat_join_request"
// UpdateTypeChatBoost is a chat boost update.
UpdateTypeChatBoost UpdateType = "chat_boost"
// UpdateTypeRemovedChatBoost is a removed chat boost update.
UpdateTypeRemovedChatBoost UpdateType = "removed_chat_boost"
) )
// Update represents an incoming update from Telegram.
// See https://core.telegram.org/bots/api#update
type Update struct { type Update struct {
UpdateID int `json:"update_id"` UpdateID int `json:"update_id"`
Message *Message `json:"message,omitempty"` Message *Message `json:"message,omitempty"`
@@ -60,6 +86,8 @@ type Update struct {
RemovedChatBoost *ChatBoostRemoved `json:"removed_chat_boost,omitempty"` RemovedChatBoost *ChatBoostRemoved `json:"removed_chat_boost,omitempty"`
} }
// InlineQuery represents an incoming inline query.
// See https://core.telegram.org/bots/api#inlinequery
type InlineQuery struct { type InlineQuery struct {
ID string `json:"id"` ID string `json:"id"`
From User `json:"from"` From User `json:"from"`
@@ -68,6 +96,9 @@ type InlineQuery struct {
ChatType *ChatType `json:"chat_type,omitempty"` ChatType *ChatType `json:"chat_type,omitempty"`
Location *Location `json:"location,omitempty"` Location *Location `json:"location,omitempty"`
} }
// ChosenInlineResult represents a result of an inline query that was chosen by the user.
// See https://core.telegram.org/bots/api#choseninlineresult
type ChosenInlineResult struct { type ChosenInlineResult struct {
ResultID string `json:"result_id"` ResultID string `json:"result_id"`
From User `json:"from"` From User `json:"from"`
@@ -76,12 +107,17 @@ type ChosenInlineResult struct {
Query string `json:"query"` Query string `json:"query"`
} }
// ShippingQuery represents an incoming shipping query.
// See https://core.telegram.org/bots/api#shippingquery
type ShippingQuery struct { type ShippingQuery struct {
ID string `json:"id"` ID string `json:"id"`
From User `json:"from"` From User `json:"from"`
InvoicePayload string `json:"invoice_payload"` InvoicePayload string `json:"invoice_payload"`
ShippingAddress ShippingAddress `json:"shipping_address"` ShippingAddress ShippingAddress `json:"shipping_address"`
} }
// ShippingAddress represents a shipping address.
// See https://core.telegram.org/bots/api#shippingaddress
type ShippingAddress struct { type ShippingAddress struct {
CountryCode string `json:"country_code"` CountryCode string `json:"country_code"`
State string `json:"state"` State string `json:"state"`
@@ -91,12 +127,17 @@ type ShippingAddress struct {
PostCode string `json:"post_code"` PostCode string `json:"post_code"`
} }
// OrderInfo represents information about an order.
// See https://core.telegram.org/bots/api#orderinfo
type OrderInfo struct { type OrderInfo struct {
Name string `json:"name"` Name string `json:"name"`
PhoneNumber string `json:"phone_number"` PhoneNumber string `json:"phone_number"`
Email string `json:"email"` Email string `json:"email"`
ShippingAddress ShippingAddress `json:"shipping_address"` ShippingAddress ShippingAddress `json:"shipping_address"`
} }
// PreCheckoutQuery represents an incoming pre-checkout query.
// See https://core.telegram.org/bots/api#precheckoutquery
type PreCheckoutQuery struct { type PreCheckoutQuery struct {
ID string `json:"id"` ID string `json:"id"`
From User `json:"from"` From User `json:"from"`
@@ -107,11 +148,15 @@ type PreCheckoutQuery struct {
OrderInfo *OrderInfo `json:"order_info,omitempty"` OrderInfo *OrderInfo `json:"order_info,omitempty"`
} }
// PaidMediaPurchased represents a purchased paid media.
// See https://core.telegram.org/bots/api#paidmediapurchased
type PaidMediaPurchased struct { type PaidMediaPurchased struct {
From User `json:"from"` From User `json:"from"`
PaidMediaPayload string `json:"paid_media_payload"` PaidMediaPayload string `json:"paid_media_payload"`
} }
// File represents a file ready to be downloaded.
// See https://core.telegram.org/bots/api#file
type File struct { type File struct {
FileId string `json:"file_id"` FileId string `json:"file_id"`
FileUniqueID string `json:"file_unique_id"` FileUniqueID string `json:"file_unique_id"`
@@ -119,6 +164,8 @@ type File struct {
FilePath string `json:"file_path,omitempty"` FilePath string `json:"file_path,omitempty"`
} }
// Audio represents an audio file to be treated as music by the Telegram clients.
// See https://core.telegram.org/bots/api#audio
type Audio struct { type Audio struct {
FileID string `json:"file_id"` FileID string `json:"file_id"`
FileUniqueID string `json:"file_unique_id"` FileUniqueID string `json:"file_unique_id"`
@@ -132,11 +179,16 @@ type Audio struct {
Thumbnail *PhotoSize `json:"thumbnail,omitempty"` Thumbnail *PhotoSize `json:"thumbnail,omitempty"`
} }
// PollOption contains information about one answer option in a poll.
// See https://core.telegram.org/bots/api#polloption
type PollOption struct { type PollOption struct {
Text string `json:"text"` Text string `json:"text"`
TextEntities []MessageEntity `json:"text_entities"` TextEntities []MessageEntity `json:"text_entities"`
VoterCount int `json:"voter_count"` VoterCount int `json:"voter_count"`
} }
// Poll contains information about a poll.
// See https://core.telegram.org/bots/api#poll
type Poll struct { type Poll struct {
ID string `json:"id"` ID string `json:"id"`
Question string `json:"question"` Question string `json:"question"`
@@ -154,12 +206,18 @@ type Poll struct {
OpenPeriod int `json:"open_period,omitempty"` OpenPeriod int `json:"open_period,omitempty"`
CloseDate int `json:"close_date,omitempty"` CloseDate int `json:"close_date,omitempty"`
} }
// PollAnswer represents an answer of a user in a poll.
// See https://core.telegram.org/bots/api#pollanswer
type PollAnswer struct { type PollAnswer struct {
PollID string `json:"poll_id"` PollID string `json:"poll_id"`
VoterChat Chat `json:"voter_chat"` VoterChat Chat `json:"voter_chat"`
User User `json:"user"` User User `json:"user"`
OptionIDS []int `json:"option_ids"` OptionIDS []int `json:"option_ids"`
} }
// ChatMemberUpdated represents changes in the status of a chat member.
// See https://core.telegram.org/bots/api#chatmemberupdated
type ChatMemberUpdated struct { type ChatMemberUpdated struct {
Chat Chat `json:"chat"` Chat Chat `json:"chat"`
From User `json:"from"` From User `json:"from"`
@@ -171,6 +229,8 @@ type ChatMemberUpdated struct {
ViaChatFolderInviteLink *bool `json:"via_chat_folder_invite_link,omitempty"` ViaChatFolderInviteLink *bool `json:"via_chat_folder_invite_link,omitempty"`
} }
// ChatJoinRequest represents a join request sent to a chat.
// See https://core.telegram.org/bots/api#chatjoinrequest
type ChatJoinRequest struct { type ChatJoinRequest struct {
Chat Chat `json:"chat"` Chat Chat `json:"chat"`
From User `json:"from"` From User `json:"from"`
@@ -180,6 +240,8 @@ type ChatJoinRequest struct {
InviteLink *ChatInviteLink `json:"invite_link,omitempty"` InviteLink *ChatInviteLink `json:"invite_link,omitempty"`
} }
// Location represents a point on the map.
// See https://core.telegram.org/bots/api#location
type Location struct { type Location struct {
Latitude float64 `json:"latitude"` Latitude float64 `json:"latitude"`
Longitude float64 `json:"longitude"` Longitude float64 `json:"longitude"`
@@ -188,12 +250,17 @@ type Location struct {
Heading int `json:"heading"` Heading int `json:"heading"`
ProximityAlertRadius int `json:"proximity_alert_radius"` ProximityAlertRadius int `json:"proximity_alert_radius"`
} }
// LocationAddress represents a human-readable address of a location.
type LocationAddress struct { type LocationAddress struct {
CountryCode string `json:"country_code"` CountryCode string `json:"country_code"`
State *string `json:"state,omitempty"` State *string `json:"state,omitempty"`
City *string `json:"city,omitempty"` City *string `json:"city,omitempty"`
Street *string `json:"street,omitempty"` Street *string `json:"street,omitempty"`
} }
// Venue represents a venue.
// See https://core.telegram.org/bots/api#venue
type Venue struct { type Venue struct {
Location Location `json:"location"` Location Location `json:"location"`
Title string `json:"title"` Title string `json:"title"`
@@ -204,22 +271,25 @@ type Venue struct {
GooglePlaceType string `json:"google_place_type,omitempty"` GooglePlaceType string `json:"google_place_type,omitempty"`
} }
// WebAppInfo contains information about a Web App.
// See https://core.telegram.org/bots/api#webappinfo
type WebAppInfo struct { type WebAppInfo struct {
URL string `json:"url"` URL string `json:"url"`
} }
// StarAmount represents an amount of Telegram Stars.
type StarAmount struct { type StarAmount struct {
Amount int `json:"amount"` Amount int `json:"amount"`
NanostarAmount int `json:"nanostar_amount"` NanostarAmount int `json:"nanostar_amount"`
} }
// Story represents a story.
type Story struct { type Story struct {
Chat Chat `json:"chat"` Chat Chat `json:"chat"`
ID int `json:"id"` ID int `json:"id"`
} }
// Gifts // AcceptedGiftTypes represents the types of gifts accepted by a user or chat.
type AcceptedGiftTypes struct { type AcceptedGiftTypes struct {
UnlimitedGifts bool `json:"unlimited_gifts"` UnlimitedGifts bool `json:"unlimited_gifts"`
LimitedGifts bool `json:"limited_gifts"` LimitedGifts bool `json:"limited_gifts"`
@@ -228,6 +298,7 @@ type AcceptedGiftTypes struct {
GiftsFromChannels bool `json:"gifts_from_channels"` GiftsFromChannels bool `json:"gifts_from_channels"`
} }
// UniqueGiftColors represents color information for a unique gift.
type UniqueGiftColors struct { type UniqueGiftColors struct {
ModelCustomEmojiID string `json:"model_custom_emoji_id"` ModelCustomEmojiID string `json:"model_custom_emoji_id"`
SymbolCustomEmojiID string `json:"symbol_custom_emoji_id"` SymbolCustomEmojiID string `json:"symbol_custom_emoji_id"`
@@ -237,11 +308,14 @@ type UniqueGiftColors struct {
DarkThemeOtherColors []int `json:"dark_theme_other_colors"` DarkThemeOtherColors []int `json:"dark_theme_other_colors"`
} }
// GiftBackground represents the background of a gift.
type GiftBackground struct { type GiftBackground struct {
CenterColor int `json:"center_color"` CenterColor int `json:"center_color"`
EdgeColor int `json:"edge_color"` EdgeColor int `json:"edge_color"`
TextColor int `json:"text_color"` TextColor int `json:"text_color"`
} }
// Gift represents a gift that can be sent.
type Gift struct { type Gift struct {
ID string `json:"id"` ID string `json:"id"`
Sticker Sticker `json:"sticker"` Sticker Sticker `json:"sticker"`
@@ -257,10 +331,13 @@ type Gift struct {
UniqueGiftVariantColor *int `json:"unique_gift_variant_color,omitempty"` UniqueGiftVariantColor *int `json:"unique_gift_variant_color,omitempty"`
PublisherChat *Chat `json:"publisher_chat,omitempty"` PublisherChat *Chat `json:"publisher_chat,omitempty"`
} }
// Gifts represents a list of gifts.
type Gifts struct { type Gifts struct {
Gifts []Gift `json:"gifts"` Gifts []Gift `json:"gifts"`
} }
// OwnedGiftType represents the type of an owned gift.
type OwnedGiftType string type OwnedGiftType string
const ( const (
@@ -268,13 +345,14 @@ const (
OwnedGiftUniqueType OwnedGiftType = "unique" OwnedGiftUniqueType OwnedGiftType = "unique"
) )
// OwnedGift represents a gift owned by a user or chat.
type OwnedGift struct { type OwnedGift struct {
Type OwnedGiftType `json:"type"` Type OwnedGiftType `json:"type"`
OwnerGiftID *string `json:"owner_gift_id,omitempty"` OwnerGiftID *string `json:"owner_gift_id,omitempty"`
SendDate *int `json:"send_date,omitempty"` SendDate *int `json:"send_date,omitempty"`
IsSaved *bool `json:"is_saved,omitempty"` IsSaved *bool `json:"is_saved,omitempty"`
// Поля, характерные для "regular" // Fields specific to "regular" type
Gift Gift `json:"gift"` Gift Gift `json:"gift"`
SenderUser User `json:"sender_user,omitempty"` SenderUser User `json:"sender_user,omitempty"`
Text string `json:"text,omitempty"` Text string `json:"text,omitempty"`
@@ -287,12 +365,13 @@ type OwnedGift struct {
IsUpgradeSeparate *bool `json:"is_upgrade_separate,omitempty"` IsUpgradeSeparate *bool `json:"is_upgrade_separate,omitempty"`
UniqueGiftNumber *int `json:"unique_gift_number,omitempty"` UniqueGiftNumber *int `json:"unique_gift_number,omitempty"`
// Поля, характерные для "unique" // Fields specific to "unique" type
CanBeTransferred *bool `json:"can_be_transferred,omitempty"` CanBeTransferred *bool `json:"can_be_transferred,omitempty"`
TransferStarCount *int `json:"transfer_star_count,omitempty"` TransferStarCount *int `json:"transfer_star_count,omitempty"`
NextTransferDate *int `json:"next_transfer_date,omitempty"` NextTransferDate *int `json:"next_transfer_date,omitempty"`
} }
// OwnedGifts represents a list of owned gifts with pagination.
type OwnedGifts struct { type OwnedGifts struct {
TotalCount int `json:"total_count"` TotalCount int `json:"total_count"`
Gifts []OwnedGift `json:"gifts"` Gifts []OwnedGift `json:"gifts"`

View File

@@ -1,5 +1,7 @@
package tgapi package tgapi
// UploadPhotoP holds parameters for uploading a photo using the Uploader.
// See https://core.telegram.org/bots/api#sendphoto
type UploadPhotoP struct { type UploadPhotoP struct {
BusinessConnectionID string `json:"business_connection_id,omitempty"` BusinessConnectionID string `json:"business_connection_id,omitempty"`
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
@@ -22,11 +24,16 @@ type UploadPhotoP struct {
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"` ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
} }
// UploadPhoto uploads a photo and sends it as a message.
// file is the photo file to upload.
// See https://core.telegram.org/bots/api#sendphoto
func (u *Uploader) UploadPhoto(params UploadPhotoP, file UploaderFile) (Message, error) { func (u *Uploader) UploadPhoto(params UploadPhotoP, file UploaderFile) (Message, error) {
req := NewUploaderRequestWithChatID[Message]("sendPhoto", params, params.ChatID, file) req := NewUploaderRequestWithChatID[Message]("sendPhoto", params, params.ChatID, file)
return req.Do(u) return req.Do(u)
} }
// UploadAudioP holds parameters for uploading an audio file using the Uploader.
// See https://core.telegram.org/bots/api#sendaudio
type UploadAudioP struct { type UploadAudioP struct {
BusinessConnectionID string `json:"business_connection_id,omitempty"` BusinessConnectionID string `json:"business_connection_id,omitempty"`
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
@@ -51,11 +58,16 @@ type UploadAudioP struct {
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"` ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
} }
// UploadAudio uploads an audio file and sends it as a message.
// files are the audio file(s) to upload (typically one file).
// See https://core.telegram.org/bots/api#sendaudio
func (u *Uploader) UploadAudio(params UploadAudioP, files ...UploaderFile) (Message, error) { func (u *Uploader) UploadAudio(params UploadAudioP, files ...UploaderFile) (Message, error) {
req := NewUploaderRequestWithChatID[Message]("sendAudio", params, params.ChatID, files...) req := NewUploaderRequestWithChatID[Message]("sendAudio", params, params.ChatID, files...)
return req.Do(u) return req.Do(u)
} }
// UploadDocumentP holds parameters for uploading a document using the Uploader.
// See https://core.telegram.org/bots/api#senddocument
type UploadDocumentP struct { type UploadDocumentP struct {
BusinessConnectionID string `json:"business_connection_id,omitempty"` BusinessConnectionID string `json:"business_connection_id,omitempty"`
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
@@ -77,11 +89,16 @@ type UploadDocumentP struct {
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"` ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
} }
// UploadDocument uploads a document and sends it as a message.
// files are the document file(s) to upload (typically one file).
// See https://core.telegram.org/bots/api#senddocument
func (u *Uploader) UploadDocument(params UploadDocumentP, files ...UploaderFile) (Message, error) { func (u *Uploader) UploadDocument(params UploadDocumentP, files ...UploaderFile) (Message, error) {
req := NewUploaderRequest[Message]("sendDocument", params, files...) req := NewUploaderRequest[Message]("sendDocument", params, files...)
return req.Do(u) return req.Do(u)
} }
// UploadVideoP holds parameters for uploading a video using the Uploader.
// See https://core.telegram.org/bots/api#sendvideo
type UploadVideoP struct { type UploadVideoP struct {
BusinessConnectionID string `json:"business_connection_id,omitempty"` BusinessConnectionID string `json:"business_connection_id,omitempty"`
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
@@ -110,11 +127,16 @@ type UploadVideoP struct {
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"` ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
} }
// UploadVideo uploads a video and sends it as a message.
// files are the video file(s) to upload (typically one file).
// See https://core.telegram.org/bots/api#sendvideo
func (u *Uploader) UploadVideo(params UploadVideoP, files ...UploaderFile) (Message, error) { func (u *Uploader) UploadVideo(params UploadVideoP, files ...UploaderFile) (Message, error) {
req := NewUploaderRequest[Message]("sendVideo", params, files...) req := NewUploaderRequest[Message]("sendVideo", params, files...)
return req.Do(u) return req.Do(u)
} }
// UploadAnimationP holds parameters for uploading an animation using the Uploader.
// See https://core.telegram.org/bots/api#sendanimation
type UploadAnimationP struct { type UploadAnimationP struct {
BusinessConnectionID string `json:"business_connection_id,omitempty"` BusinessConnectionID string `json:"business_connection_id,omitempty"`
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
@@ -141,11 +163,16 @@ type UploadAnimationP struct {
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"` ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
} }
// UploadAnimation uploads an animation (GIF or H.264/MPEG-4 AVC video without sound) and sends it as a message.
// files are the animation file(s) to upload (typically one file).
// See https://core.telegram.org/bots/api#sendanimation
func (u *Uploader) UploadAnimation(params UploadAnimationP, files ...UploaderFile) (Message, error) { func (u *Uploader) UploadAnimation(params UploadAnimationP, files ...UploaderFile) (Message, error) {
req := NewUploaderRequest[Message]("sendAnimation", params, files...) req := NewUploaderRequest[Message]("sendAnimation", params, files...)
return req.Do(u) return req.Do(u)
} }
// UploadVoiceP holds parameters for uploading a voice note using the Uploader.
// See https://core.telegram.org/bots/api#sendvoice
type UploadVoiceP struct { type UploadVoiceP struct {
BusinessConnectionID string `json:"business_connection_id,omitempty"` BusinessConnectionID string `json:"business_connection_id,omitempty"`
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
@@ -167,11 +194,16 @@ type UploadVoiceP struct {
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"` ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
} }
// UploadVoice uploads a voice note and sends it as a message.
// files are the voice file(s) to upload (typically one file).
// See https://core.telegram.org/bots/api#sendvoice
func (u *Uploader) UploadVoice(params UploadVoiceP, files ...UploaderFile) (Message, error) { func (u *Uploader) UploadVoice(params UploadVoiceP, files ...UploaderFile) (Message, error) {
req := NewUploaderRequest[Message]("sendVoice", params, files...) req := NewUploaderRequest[Message]("sendVoice", params, files...)
return req.Do(u) return req.Do(u)
} }
// UploadVideoNoteP holds parameters for uploading a video note (rounded video) using the Uploader.
// See https://core.telegram.org/bots/api#sendvideonote
type UploadVideoNoteP struct { type UploadVideoNoteP struct {
BusinessConnectionID string `json:"business_connection_id,omitempty"` BusinessConnectionID string `json:"business_connection_id,omitempty"`
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
@@ -191,15 +223,23 @@ type UploadVideoNoteP struct {
ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"` ReplyMarkup *ReplyMarkup `json:"reply_markup,omitempty"`
} }
// UploadVideoNote uploads a video note (rounded video) and sends it as a message.
// files are the video note file(s) to upload (typically one file).
// See https://core.telegram.org/bots/api#sendvideonote
func (u *Uploader) UploadVideoNote(params UploadVideoNoteP, files ...UploaderFile) (Message, error) { func (u *Uploader) UploadVideoNote(params UploadVideoNoteP, files ...UploaderFile) (Message, error) {
req := NewUploaderRequest[Message]("sendVideoNote", params, files...) req := NewUploaderRequest[Message]("sendVideoNote", params, files...)
return req.Do(u) return req.Do(u)
} }
// UploadChatPhotoP holds parameters for uploading a chat photo using the Uploader.
// See https://core.telegram.org/bots/api#setchatphoto
type UploadChatPhotoP struct { type UploadChatPhotoP struct {
ChatID int64 `json:"chat_id"` ChatID int64 `json:"chat_id"`
} }
// UploadChatPhoto uploads a new chat photo.
// photo is the photo file to upload.
// See https://core.telegram.org/bots/api#setchatphoto
func (u *Uploader) UploadChatPhoto(params UploadChatPhotoP, photo UploaderFile) (Message, error) { func (u *Uploader) UploadChatPhoto(params UploadChatPhotoP, photo UploaderFile) (Message, error) {
req := NewUploaderRequest[Message]("sendChatPhoto", params, photo) req := NewUploaderRequest[Message]("sendChatPhoto", params, photo)
return req.Do(u) return req.Do(u)

View File

@@ -1,38 +1,53 @@
package tgapi package tgapi
// GetUserProfilePhotosP holds parameters for the GetUserProfilePhotos method.
// See https://core.telegram.org/bots/api#getuserprofilephotos
type GetUserProfilePhotosP struct { type GetUserProfilePhotosP struct {
UserID int `json:"user_id"` UserID int `json:"user_id"`
Offset int `json:"offset,omitempty"` Offset int `json:"offset,omitempty"`
Limit int `json:"limit,omitempty"` Limit int `json:"limit,omitempty"`
} }
// GetUserProfilePhotos returns a list of profile pictures for a user.
// See https://core.telegram.org/bots/api#getuserprofilephotos
func (api *API) GetUserProfilePhotos(params GetUserProfilePhotosP) (UserProfilePhotos, error) { func (api *API) GetUserProfilePhotos(params GetUserProfilePhotosP) (UserProfilePhotos, error) {
req := NewRequest[UserProfilePhotos]("getUserProfilePhotos", params) req := NewRequest[UserProfilePhotos]("getUserProfilePhotos", params)
return req.Do(api) return req.Do(api)
} }
// GetUserProfileAudiosP holds parameters for the GetUserProfileAudios method.
// See https://core.telegram.org/bots/api#getuserprofileaudios
type GetUserProfileAudiosP struct { type GetUserProfileAudiosP struct {
UserID int `json:"user_id"` UserID int `json:"user_id"`
Offset int `json:"offset,omitempty"` Offset int `json:"offset,omitempty"`
Limit int `json:"limit,omitempty"` Limit int `json:"limit,omitempty"`
} }
// GetUserProfileAudios returns a list of profile audios for a user.
// See https://core.telegram.org/bots/api#getuserprofileaudios
func (api *API) GetUserProfileAudios(params GetUserProfileAudiosP) (UserProfileAudios, error) { func (api *API) GetUserProfileAudios(params GetUserProfileAudiosP) (UserProfileAudios, error) {
req := NewRequest[UserProfileAudios]("getUserProfileAudios", params) req := NewRequest[UserProfileAudios]("getUserProfileAudios", params)
return req.Do(api) return req.Do(api)
} }
// SetUserEmojiStatusP holds parameters for the SetUserEmojiStatus method.
// See https://core.telegram.org/bots/api#setuseremojistatus
type SetUserEmojiStatusP struct { type SetUserEmojiStatusP struct {
UserID int `json:"user_id"` UserID int `json:"user_id"`
EmojiID string `json:"emoji_status_custom_emoji_id,omitempty"` EmojiID string `json:"emoji_status_custom_emoji_id,omitempty"`
ExpirationDate int `json:"emoji_status_expiration_date,omitempty"` ExpirationDate int `json:"emoji_status_expiration_date,omitempty"`
} }
// SetUserEmojiStatus sets a custom emoji status for a user.
// Returns true on success.
// See https://core.telegram.org/bots/api#setuseremojistatus
func (api *API) SetUserEmojiStatus(params SetUserEmojiStatusP) (bool, error) { func (api *API) SetUserEmojiStatus(params SetUserEmojiStatusP) (bool, error) {
req := NewRequest[bool]("setUserEmojiStatus", params) req := NewRequest[bool]("setUserEmojiStatus", params)
return req.Do(api) return req.Do(api)
} }
// GetUserGiftsP holds parameters for the GetUserGifts method.
// See https://core.telegram.org/bots/api#getusergifts
type GetUserGiftsP struct { type GetUserGiftsP struct {
UserID int `json:"user_id"` UserID int `json:"user_id"`
ExcludeUnlimited bool `json:"exclude_unlimited,omitempty"` ExcludeUnlimited bool `json:"exclude_unlimited,omitempty"`
@@ -45,6 +60,8 @@ type GetUserGiftsP struct {
Limit int `json:"limit,omitempty"` Limit int `json:"limit,omitempty"`
} }
// GetUserGifts returns gifts owned by a user.
// See https://core.telegram.org/bots/api#getusergifts
func (api *API) GetUserGifts(params GetUserGiftsP) (OwnedGifts, error) { func (api *API) GetUserGifts(params GetUserGiftsP) (OwnedGifts, error) {
req := NewRequest[OwnedGifts]("getUserGifts", params) req := NewRequest[OwnedGifts]("getUserGifts", params)
return req.Do(api) return req.Do(api)

View File

@@ -1,5 +1,7 @@
package tgapi package tgapi
// User represents a Telegram user or bot.
// See https://core.telegram.org/bots/api#user
type User struct { type User struct {
ID int `json:"id"` ID int `json:"id"`
IsBot bool `json:"is_bot"` IsBot bool `json:"is_bot"`
@@ -18,21 +20,31 @@ type User struct {
AllowsUsersToCreateTopics *bool `json:"allows_users_to_create_topics,omitempty"` AllowsUsersToCreateTopics *bool `json:"allows_users_to_create_topics,omitempty"`
} }
// UserProfilePhotos represents a user's profile photos.
// See https://core.telegram.org/bots/api#userprofilephotos
type UserProfilePhotos struct { type UserProfilePhotos struct {
TotalCount int `json:"total_count"` TotalCount int `json:"total_count"`
Photos [][]PhotoSize `json:"photos"` Photos [][]PhotoSize `json:"photos"`
} }
// UserProfileAudios represents a user's profile audios.
// See https://core.telegram.org/bots/api#userprofileaudios
type UserProfileAudios struct { type UserProfileAudios struct {
TotalCount int `json:"total_count"` TotalCount int `json:"total_count"`
Audios []Audio `json:"audios"` Audios []Audio `json:"audios"`
} }
// UserRating represents a user's rating with level progression.
// See https://core.telegram.org/bots/api#userrating
type UserRating struct { type UserRating struct {
Level int `json:"level"` Level int `json:"level"`
Rating int `json:"rating"` Rating int `json:"rating"`
CurrentLevelRating int `json:"current_level_rating"` CurrentLevelRating int `json:"current_level_rating"`
NextLevelRating int `json:"next_level_rating"` NextLevelRating int `json:"next_level_rating"`
} }
// Birthdate represents a user's birthdate.
// See https://core.telegram.org/bots/api#birthdate
type Birthdate struct { type Birthdate struct {
Day int `json:"day"` Day int `json:"day"`
Month int `json:"month"` Month int `json:"month"`

View File

@@ -193,8 +193,10 @@ func (rl *RateLimiter) waitForChatUnlock(ctx context.Context, chatID int64) erro
// getChatLimiter returns the rate limiter for the given chat, creating it if needed. // getChatLimiter returns the rate limiter for the given chat, creating it if needed.
// Uses 1 request per second with burst of 1 — conservative for per-user limits. // Uses 1 request per second with burst of 1 — conservative for per-user limits.
// Must be called with rl.chatMu held.
func (rl *RateLimiter) getChatLimiter(chatID int64) *rate.Limiter { func (rl *RateLimiter) getChatLimiter(chatID int64) *rate.Limiter {
rl.chatMu.Lock()
defer rl.chatMu.Unlock()
if lim, ok := rl.chatLimiters[chatID]; ok { if lim, ok := rl.chatLimiters[chatID]; ok {
return lim return lim
} }

View File

@@ -1,9 +1,9 @@
package utils package utils
const ( const (
VersionString = "1.0.0-beta.12" VersionString = "1.0.0-beta.20"
VersionMajor = 1 VersionMajor = 1
VersionMinor = 0 VersionMinor = 0
VersionPatch = 0 VersionPatch = 0
VersionBeta = 12 VersionBeta = 20
) )