maxbot-api-client-python 1.1.1__tar.gz → 2.0.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (30) hide show
  1. {maxbot_api_client_python-1.1.1 → maxbot_api_client_python-2.0.0}/PKG-INFO +35 -46
  2. {maxbot_api_client_python-1.1.1 → maxbot_api_client_python-2.0.0}/README.md +33 -36
  3. {maxbot_api_client_python-1.1.1 → maxbot_api_client_python-2.0.0}/maxbot_api_client_python/__init__.py +2 -1
  4. {maxbot_api_client_python-1.1.1 → maxbot_api_client_python-2.0.0}/maxbot_api_client_python/api.py +2 -1
  5. {maxbot_api_client_python-1.1.1 → maxbot_api_client_python-2.0.0}/maxbot_api_client_python/client.py +80 -82
  6. {maxbot_api_client_python-1.1.1 → maxbot_api_client_python-2.0.0}/maxbot_api_client_python/exceptions.py +1 -1
  7. maxbot_api_client_python-2.0.0/maxbot_api_client_python/tools/bots.py +56 -0
  8. maxbot_api_client_python-2.0.0/maxbot_api_client_python/tools/chats.py +479 -0
  9. {maxbot_api_client_python-1.1.1 → maxbot_api_client_python-2.0.0}/maxbot_api_client_python/tools/helpers.py +87 -62
  10. maxbot_api_client_python-2.0.0/maxbot_api_client_python/tools/messages.py +210 -0
  11. maxbot_api_client_python-2.0.0/maxbot_api_client_python/tools/subscriptions.py +109 -0
  12. {maxbot_api_client_python-1.1.1 → maxbot_api_client_python-2.0.0}/maxbot_api_client_python/tools/uploads.py +41 -15
  13. {maxbot_api_client_python-1.1.1 → maxbot_api_client_python-2.0.0}/maxbot_api_client_python/types/constants.py +1 -1
  14. {maxbot_api_client_python-1.1.1 → maxbot_api_client_python-2.0.0}/maxbot_api_client_python/types/models.py +82 -65
  15. {maxbot_api_client_python-1.1.1 → maxbot_api_client_python-2.0.0}/maxbot_api_client_python/utils.py +3 -1
  16. {maxbot_api_client_python-1.1.1 → maxbot_api_client_python-2.0.0}/maxbot_api_client_python.egg-info/PKG-INFO +35 -46
  17. {maxbot_api_client_python-1.1.1 → maxbot_api_client_python-2.0.0}/maxbot_api_client_python.egg-info/SOURCES.txt +1 -1
  18. maxbot_api_client_python-2.0.0/pyproject.toml +25 -0
  19. maxbot_api_client_python-1.1.1/maxbot_api_client_python/tools/bots.py +0 -52
  20. maxbot_api_client_python-1.1.1/maxbot_api_client_python/tools/chats.py +0 -445
  21. maxbot_api_client_python-1.1.1/maxbot_api_client_python/tools/messages.py +0 -194
  22. maxbot_api_client_python-1.1.1/maxbot_api_client_python/tools/subscriptions.py +0 -101
  23. maxbot_api_client_python-1.1.1/setup.py +0 -27
  24. {maxbot_api_client_python-1.1.1 → maxbot_api_client_python-2.0.0}/LICENSE +0 -0
  25. {maxbot_api_client_python-1.1.1 → maxbot_api_client_python-2.0.0}/maxbot_api_client_python/tools/__init__.py +0 -0
  26. {maxbot_api_client_python-1.1.1 → maxbot_api_client_python-2.0.0}/maxbot_api_client_python/types/__init__.py +0 -0
  27. {maxbot_api_client_python-1.1.1 → maxbot_api_client_python-2.0.0}/maxbot_api_client_python.egg-info/dependency_links.txt +0 -0
  28. {maxbot_api_client_python-1.1.1 → maxbot_api_client_python-2.0.0}/maxbot_api_client_python.egg-info/requires.txt +0 -0
  29. {maxbot_api_client_python-1.1.1 → maxbot_api_client_python-2.0.0}/maxbot_api_client_python.egg-info/top_level.txt +0 -0
  30. {maxbot_api_client_python-1.1.1 → maxbot_api_client_python-2.0.0}/setup.cfg +0 -0
{maxbot_api_client_python-1.1.1 → maxbot_api_client_python-2.0.0}/PKG-INFO RENAMED
@@ -1,9 +1,9 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: maxbot-api-client-python
3
- Version: 1.1.1
3
+ Version: 2.0.0
4
4
  Summary: Python client for MAX Bot API with Sync and Async support
5
- Home-page: https://github.com/green-api/maxbot-api-client-python
6
5
  Author: Green API
6
+ Project-URL: Homepage, https://github.com/green-api/maxbot-api-client-python
7
7
  Classifier: Programming Language :: Python :: 3
8
8
  Classifier: License :: OSI Approved :: MIT License
9
9
  Classifier: Operating System :: OS Independent
@@ -14,15 +14,7 @@ Requires-Dist: httpx>=0.24.0
14
14
  Requires-Dist: aiofiles>=23.1.0
15
15
  Requires-Dist: pydantic>=2.0.0
16
16
  Requires-Dist: tenacity>=9.1.2
17
- Dynamic: author
18
- Dynamic: classifier
19
- Dynamic: description
20
- Dynamic: description-content-type
21
- Dynamic: home-page
22
17
  Dynamic: license-file
23
- Dynamic: requires-dist
24
- Dynamic: requires-python
25
- Dynamic: summary
26
18
 
27
19
  # MAX BOT API Client (Python)
28
20
 
@@ -73,10 +65,10 @@ from maxbot_api_client_python import API, Config
73
65
 
74
66
  **Параметры конфигурации:**
75
67
 
76
- - `base_url` - Базовый URL-адрес серверов платформы MaxBot. Все методы API будут маршрутизироваться по этому корневому адресу. Актуальный адрес указан в [официальной документации](https://dev.max.ru/docs-api).
77
- - `token` - Уникальный секретный ключ авторизации (API-ключ) вашего бота. Получить его можно в личном кабинете после [регистрации или создании бота](https://green-api.com/max-bot-api/docs/before-start/) на платформе [business.max.ru](https://business.max.ru/).
78
- - `ratelimiter` - Встроенный ограничитель частоты запросов. Он контролирует количество исходящих запросов в секунду (RPS), защищая бота от блокировки со стороны сервера за превышение лимитов. Рекомендуемое значение — не менее 25.
79
- - `timeout` - Максимальное время ожидания ответа от сервера (в секундах). Если сервер не ответит в течение этого времени, запрос будет завершен с ошибкой. Оптимальное значение — 30 секунд.
68
+ - `base_url` - Базовый URL-адрес серверов платформы MaxBot. Все методы API будут отправляться по этому корневому адресу. Актуальный адрес указан в [официальной документации](https://dev.max.ru/docs-api).
69
+ - `token` - Уникальный секретный ключ авторизации (API-ключ) вашего бота. Получить его можно в личном кабинете после [регистрации или создании бота](https://green-api.com/max-bot-api/docs/before-start/) на платформе [business.max.ru](https://business.max.ru/).
70
+ - `ratelimiter` - Встроенный ограничитель частоты запросов. Он контролирует количество исходящих запросов в секунду (RPS), защищая бота от блокировки со стороны сервера за превышение лимитов. Рекомендуемое значение — не менее 25.
71
+ - `timeout` - Максимальное время ожидания ответа от сервера (в секундах). Если сервер не ответит в течение этого времени, запрос будет завершен с ошибкой. Оптимальное значение — 30 секунд.
80
72
 
81
73
  **Как инициализировать клиент:**
82
74
 
@@ -101,18 +93,18 @@ async with API(cfg) as bot:
101
93
 
102
94
  **Как получить информацию о боте:**
103
95
 
104
- * Ссылка на синхронный пример: [GetBot.py](./examples/sync/GetBot.py)
96
+ * Ссылка на синхронный пример: [get_bot.py](./examples/sync/get_bot.py)
105
97
 
106
98
  ```python
107
99
  with API(cfg) as bot:
108
- response = bot.bots.GetBot()
100
+ response = bot.bots.get_bot()
109
101
  ```
110
102
 
111
- * Ссылка на асинхронный пример: [GetBotAsync.py](./examples/async/GetBotAsync.py)
103
+ * Ссылка на асинхронный пример: [get_bot_async.py](./examples/async/get_bot_async.py)
112
104
 
113
105
  ```python
114
106
  async with API(cfg) as bot:
115
- response = await bot.bots.GetBotAsync()
107
+ response = await bot.bots.get_bot_async()
116
108
  ```
117
109
 
118
110
  **Как отправить сообщение:**
@@ -122,17 +114,17 @@ async with API(cfg) as bot:
122
114
 
123
115
  ```python
124
116
  with API(cfg) as bot:
125
- response = bot.messages.SendMessage(
117
+ response = bot.messages.get_messages(
126
118
  user_id=1234567890,
127
119
  text="Hello world!"
128
120
  )
129
121
  ```
130
122
 
131
- * Ссылка на асинхронный пример: [SendMessageAsync.py](./examples/async/SendMessageAsync.py)
123
+ * Ссылка на асинхронный пример: [get_messages_async.py](./examples/async/get_messages_async.py)
132
124
 
133
125
  ```python
134
126
  async with API(cfg) as bot:
135
- response = await bot.messages.SendMessageAsync(
127
+ response = await bot.messages.get_messages_async(
136
128
  user_id=1234567890,
137
129
  text="Hello world from Async!"
138
130
  )
@@ -140,21 +132,21 @@ async with API(cfg) as bot:
140
132
 
141
133
  **Как легко отправить файл (по ссылке или локальный):**
142
134
 
143
- * Ссылка на синхронный пример: [SendFile.py](./examples/sync/SendFile.py)
135
+ * Ссылка на синхронный пример: [send_file.py](./examples/sync/send_file.py)
144
136
 
145
137
  ```python
146
138
  with API(cfg) as bot:
147
- response = bot.helpers.SendFile(
139
+ response = bot.helpers.send_file(
148
140
  chat_id=1234567890,
149
141
  text="Check this!",
150
142
  file_source="[https://http.cat/200.jpg](https://http.cat/200.jpg)"
151
143
  )
152
144
  ```
153
- * Ссылка на асинхронный пример: [SendFileAsync.py](./examples/async/SendFileAsync.py)
145
+ * Ссылка на асинхронный пример: [send_file_async.py](./examples/async/send_file_async.py)
154
146
 
155
147
  ```python
156
148
  async with API(cfg) as bot:
157
- response = await bot.helpers.SendFileAsync(
149
+ response = await bot.helpers.send_file_async(
158
150
  chat_id=1234567890,
159
151
  text="Посмотри на этот файл!",
160
152
  file_source="[https://http.cat/200.jpg](https://http.cat/200.jpg)"
@@ -163,25 +155,25 @@ async with API(cfg) as bot:
163
155
 
164
156
  **Как вручную загрузить файл (для кастомных вложений):**
165
157
 
166
- * Ссылка на синхронный пример: [UploadFile.py](./examples/sync/UploadFile.py)
158
+ * Ссылка на синхронный пример: [upload_file.py](./examples/sync/upload_file.py)
167
159
 
168
160
  ```python
169
161
  from maxbot_api_client_python.types.constants import UploadType
170
162
 
171
163
  with API(cfg) as bot:
172
- response = bot.uploads.UploadFile(
164
+ response = bot.uploads.upload_file(
173
165
  type=UploadType.image,
174
166
  file_path="examples/assets/file.jpg"
175
167
  )
176
168
  ```
177
169
 
178
- * Ссылка на асинхронный пример: [UploadFileAsync.py](./examples/async/UploadFileAsync.py)
170
+ * Ссылка на асинхронный пример: [upload_file_async.py](./examples/async/upload_file_async.py)
179
171
 
180
172
  ```python
181
173
  from maxbot_api_client_python.types.constants import UploadType
182
174
 
183
175
  async with API(cfg) as bot:
184
- response = await bot.uploads.UploadFileAsync(
176
+ response = await bot.uploads.upload_file_async(
185
177
  type=UploadType.image,
186
178
  file_path="examples/assets/file.jpg"
187
179
  )
@@ -216,13 +208,13 @@ async with API(cfg) as bot:
216
208
  | Описание | Ссылка на пример |
217
209
  | ---------------------------------------------- | ------------------------------------------------------------ |
218
210
  | Как отправить сообщение | [SendMessage.py](./examples/sync/SendMessage.py) |
219
- | Как отправить сообщение *асинхронно* | [SendMessageAsync.py](./examples/async/SendMessageAsync.py) |
220
- | Как получить информацию о боте | [GetBot.py](./examples/sync/GetBot.py) |
221
- | Как получить информацию о боте *асинхронно* | [GetBotAsync.py](./examples/async/GetBotAsync.py) |
222
- | Как загрузить файл | [UploadFile.py](./examples/sync/UploadFile.py) |
223
- | Как загрузить файл *асинхронно* | [UploadFileAsync.py](./examples/async/UploadFileAsync.py) |
224
- | Как отправить файл | [SendFile.py](./examples/sync/SendFile.py) |
225
- | Как отправить файл *асинхронно* | [SendFileAsync.py](./examples/async/SendFileAsync.py) |
211
+ | Как отправить сообщение *асинхронно* | [get_messages_async.py](./examples/async/get_messages_async.py) |
212
+ | Как получить информацию о боте | [get_bot.py](./examples/sync/get_bot.py) |
213
+ | Как получить информацию о боте *асинхронно* | [get_bot_async.py](./examples/async/get_bot_async.py) |
214
+ | Как загрузить файл | [upload_file.py](./examples/sync/upload_file.py) |
215
+ | Как загрузить файл *асинхронно* | [upload_file_async.py](./examples/async/upload_file_async.py) |
216
+ | Как отправить файл | [send_file.py](./examples/sync/send_file.py) |
217
+ | Как отправить файл *асинхронно* | [send_file_async.py](./examples/async/send_file_async.py) |
226
218
  | Как получить входящее уведомление | [GetUpdates.py](./examples/sync/GetUpdates.py) |
227
219
  | Как получить входящее уведомление *асинхронно* | [GetUpdatesAsync.py](./examples/async/GetUpdatesAsync.py) |
228
220
 
@@ -230,10 +222,10 @@ async with API(cfg) as bot:
230
222
 
231
223
  | Метод API | Описание | Ссылка на документацию MAX | Ссылка на документацию библиотеки |
232
224
  |-----------------|-------------------------|------------------------------------------------|----------------------------------------------|
233
- | `Bots.GetBot` | Получает информацию о боте | [GetBot](https://dev.max.ru/docs-api/methods/GET/me) | [GetBot](https://green-api.com/max-bot-api/docs/api/bots/GetBot/) |
234
- | `Bots.PatchBot` | Изменяет информацию о боте | | [PatchBot](https://green-api.com/max-bot-api/docs/api/bots/PatchBot/) |
235
- | `Chats.GetChats` | Возвращает список групповых чатов, в которых участвовал бот | [GetChats](https://dev.max.ru/docs-api/methods/GET/chats) | [GetChats](https://green-api.com/max-bot-api/docs/api/chats/GetChats) |
236
- | `Chats.GetChat` | Возвращает информацию о групповом чате по его ID | [GetChat](https://dev.max.ru/docs-api/methods/GET/chats/-chatId-) | [GetChat](https://green-api.com/max-bot-api/docs/api/chats/GetChat) |
225
+ | `Bots.get_bot` | Получает информацию о боте | [get_bot](https://dev.max.ru/docs-api/methods/GET/me) | [get_bot](https://green-api.com/max-bot-api/docs/api/bots/get_bot/) |
226
+ | `Bots.patch_bot` | Изменяет информацию о боте | | [patch_bot](https://green-api.com/max-bot-api/docs/api/bots/patch_bot/) |
227
+ | `Chats.get_chats` | Возвращает список групповых чатов, в которых участвовал бот | [get_chats](https://dev.max.ru/docs-api/methods/GET/chats) | [get_chats](https://green-api.com/max-bot-api/docs/api/chats/get_chats) |
228
+ | `Chats.get_chat` | Возвращает информацию о групповом чате по его ID | [get_chat](https://dev.max.ru/docs-api/methods/GET/chats/-chatId-) | [get_chat](https://green-api.com/max-bot-api/docs/api/chats/get_chat) |
237
229
  | `Chats.EditChat` | Позволяет редактировать информацию о групповом чате | [EditChat](https://dev.max.ru/docs-api/methods/PATCH/chats/-chatId-) | [EditChat](https://green-api.com/max-bot-api/docs/api/chats/EditChat) |
238
230
  | `Chats.DeleteChat` | Удаляет групповой чат для всех участников | [DeleteChat](https://dev.max.ru/docs-api/methods/DELETE/chats/-chatId-) | [DeleteChat](https://green-api.com/max-bot-api/docs/api/chats/DeleteChat) |
239
231
  | `Chats.SendAction` | Позволяет отправлять следующие действия бота в групповой чат | [SendAction](https://dev.max.ru/docs-api/methods/POST/chats/-chatId-/actions) | [SendAction](https://green-api.com/max-bot-api/docs/api/chats/SendAction) |
@@ -242,7 +234,7 @@ async with API(cfg) as bot:
242
234
  | `Chats.UnpinMessage` | Удаляет закрепленное сообщение в групповом чате | [UnpinMessage](https://dev.max.ru/docs-api/methods/DELETE/chats/-chatId-/pin) | [UnpinMessage](https://green-api.com/max-bot-api/docs/api/chats/UnpinMessage) |
243
235
  | `Chats.GetChatMembership` | Возвращает членство бота в групповом чате | [GetChatMembership](https://dev.max.ru/docs-api/methods/GET/chats/-chatId-/members/me) | [GetChatMembership](https://green-api.com/max-bot-api/docs/api/chats/GetChatMembership) |
244
236
  | `Chats.LeaveChat` | Удаляет бота из группового чата | [LeaveChat](https://dev.max.ru/docs-api/methods/DELETE/chats/-chatId-/members/me) | [LeaveChat](https://green-api.com/max-bot-api/docs/api/chats/LeaveChat) |
245
- | `Chats.GetChatAdmins` | Возвращает список всех администраторов группового чата | [GetChatAdmins](https://dev.max.ru/docs-api/methods/GET/chats/-chatId-/members/admins) | [GetChatAdmins](https://green-api.com/max-bot-api/docs/api/chats/GetChatAdmins) |
237
+ | `Chats.get_chatAdmins` | Возвращает список всех администраторов группового чата | [get_chatAdmins](https://dev.max.ru/docs-api/methods/GET/chats/-chatId-/members/admins) | [get_chatAdmins](https://green-api.com/max-bot-api/docs/api/chats/get_chatAdmins) |
246
238
  | `Chats.SetChatAdmins` | Назначает участника группы администратором | [SetChatAdmins](https://dev.max.ru/docs-api/methods/POST/chats/-chatId-/members/admins) | [SetChatAdmins](https://green-api.com/max-bot-api/docs/api/chats/SetChatAdmins) |
247
239
  | `Chats.DeleteAdmin` | Отменяет права администратора пользователя в групповом чате | [DeleteAdmin](https://dev.max.ru/docs-api/methods/DELETE/chats/-chatId-/members/admins/-userId-) | [DeleteAdmin](https://green-api.com/max-bot-api/docs/api/chats/DeleteAdmin) |
248
240
  | `Chats.GetChatMembers` | Возвращает список участников группового чата | [GetChatMembers](https://dev.max.ru/docs-api/methods/GET/chats/-chatId-/members) | [GetChatMembers](https://green-api.com/max-bot-api/docs/api/chats/GetChatMembers) |
@@ -252,8 +244,8 @@ async with API(cfg) as bot:
252
244
  | `Subscriptions.Subscribe` | Настраивает доставку событий бота через веб-хук | [Subscribe](https://dev.max.ru/docs-api/methods/POST/subscriptions) | [Subscribe](https://green-api.com/max-bot-api/docs/api/subscriptions/Subscribe.md) |
253
245
  | `Subscriptions.Unsubscribe` | Отменяет подписку бота на получение обновлений через веб-хук | [Unsubscribe](https://dev.max.ru/docs-api/methods/DELETE/subscriptions) | [Unsubscribe](https://green-api.com/max-bot-api/docs/api/subscriptions/Unsubscribe) |
254
246
  | `Subscriptions.GetUpdates` | Получает входящие обновления | [GetUpdates](https://dev.max.ru/docs-api/methods/GET/updates) | [GetUpdates](https://green-api.com/max-bot-api/docs/api/subscriptions/GetUpdates) |
255
- | `Upload.UploadFile` | Загружает файл на серверы MAX для последующей передачи | [UploadFile](https://dev.max.ru/docs-api/methods/POST/uploads) | [UploadFile](https://green-api.com/max-bot-api/docs/upload/UploadFile) |
256
- | `Helpers.SendFile` | Упрощает отправку файлов, автоматически определяя URL или путь | | [SendFile](https://green-api.com/max-bot-api/docs/helpers/SendFile) |
247
+ | `Upload.upload_file` | Загружает файл на серверы MAX для последующей передачи | [upload_file](https://dev.max.ru/docs-api/methods/POST/uploads) | [upload_file](https://green-api.com/max-bot-api/docs/upload/upload_file) |
248
+ | `Helpers.send_file` | Упрощает отправку файлов, автоматически определяя URL или путь | | [send_file](https://green-api.com/max-bot-api/docs/helpers/send_file) |
257
249
  | `Messages.GetMessages` | Возвращает информацию о сообщении или массив сообщений из чата | [GetMessages](https://dev.max.ru/docs-api/methods/GET/messages) | [GetMessages](https://green-api.com/max-bot-api/docs/api/messages/GetMessages) |
258
250
  | `Messages.SendMessage` | Отправляет текстовое или медиа-сообщение указанному пользователю или в чат | [SendMessage](https://dev.max.ru/docs-api/methods/POST/messages) | [SendMessage](https://green-api.com/max-bot-api/docs/api/messages/SendMessage) |
259
251
  | `Messages.EditMessage` | Редактирует текст или медиафайл ранее отправленного сообщения | [EditMessage](https://dev.max.ru/docs-api/methods/PUT/messages) | [EditMessage](https://green-api.com/max-bot-api/docs/api/messages/EditMessage) |
@@ -261,6 +253,3 @@ async with API(cfg) as bot:
261
253
  | `Messages.GetMessage` | Извлекает содержимое и метаданные конкретного сообщения по его ID | [GetMessage](https://dev.max.ru/docs-api/methods/GET/messages/-messageId-) | [GetMessage](https://green-api.com/max-bot-api/docs/api/messages/GetMessage) |
262
254
  | `Messages.GetVideoInfo` | Возвращает подробную информацию о прикрепленном видео | [GetVideoInfo](https://dev.max.ru/docs-api/methods/GET/videos/-videoToken-) | [GetVideoInfo](https://green-api.com/max-bot-api/docs/api/messages/GetVideoInfo) |
263
255
  | `Messages.AnswerCallback` | Отправляет ответ после того, как пользователь нажмет кнопку | [AnswerCallback](https://dev.max.ru/docs-api/methods/POST/answers) | [AnswerCallback](https://green-api.com/max-bot-api/docs/api/messages/AnswerCallback )|
264
-
265
- ```
266
- ```
{maxbot_api_client_python-1.1.1 → maxbot_api_client_python-2.0.0}/README.md RENAMED
@@ -47,10 +47,10 @@ from maxbot_api_client_python import API, Config
47
47
 
48
48
  **Параметры конфигурации:**
49
49
 
50
- - `base_url` - Базовый URL-адрес серверов платформы MaxBot. Все методы API будут маршрутизироваться по этому корневому адресу. Актуальный адрес указан в [официальной документации](https://dev.max.ru/docs-api).
51
- - `token` - Уникальный секретный ключ авторизации (API-ключ) вашего бота. Получить его можно в личном кабинете после [регистрации или создании бота](https://green-api.com/max-bot-api/docs/before-start/) на платформе [business.max.ru](https://business.max.ru/).
52
- - `ratelimiter` - Встроенный ограничитель частоты запросов. Он контролирует количество исходящих запросов в секунду (RPS), защищая бота от блокировки со стороны сервера за превышение лимитов. Рекомендуемое значение — не менее 25.
53
- - `timeout` - Максимальное время ожидания ответа от сервера (в секундах). Если сервер не ответит в течение этого времени, запрос будет завершен с ошибкой. Оптимальное значение — 30 секунд.
50
+ - `base_url` - Базовый URL-адрес серверов платформы MaxBot. Все методы API будут отправляться по этому корневому адресу. Актуальный адрес указан в [официальной документации](https://dev.max.ru/docs-api).
51
+ - `token` - Уникальный секретный ключ авторизации (API-ключ) вашего бота. Получить его можно в личном кабинете после [регистрации или создании бота](https://green-api.com/max-bot-api/docs/before-start/) на платформе [business.max.ru](https://business.max.ru/).
52
+ - `ratelimiter` - Встроенный ограничитель частоты запросов. Он контролирует количество исходящих запросов в секунду (RPS), защищая бота от блокировки со стороны сервера за превышение лимитов. Рекомендуемое значение — не менее 25.
53
+ - `timeout` - Максимальное время ожидания ответа от сервера (в секундах). Если сервер не ответит в течение этого времени, запрос будет завершен с ошибкой. Оптимальное значение — 30 секунд.
54
54
 
55
55
  **Как инициализировать клиент:**
56
56
 
@@ -75,18 +75,18 @@ async with API(cfg) as bot:
75
75
 
76
76
  **Как получить информацию о боте:**
77
77
 
78
- * Ссылка на синхронный пример: [GetBot.py](./examples/sync/GetBot.py)
78
+ * Ссылка на синхронный пример: [get_bot.py](./examples/sync/get_bot.py)
79
79
 
80
80
  ```python
81
81
  with API(cfg) as bot:
82
- response = bot.bots.GetBot()
82
+ response = bot.bots.get_bot()
83
83
  ```
84
84
 
85
- * Ссылка на асинхронный пример: [GetBotAsync.py](./examples/async/GetBotAsync.py)
85
+ * Ссылка на асинхронный пример: [get_bot_async.py](./examples/async/get_bot_async.py)
86
86
 
87
87
  ```python
88
88
  async with API(cfg) as bot:
89
- response = await bot.bots.GetBotAsync()
89
+ response = await bot.bots.get_bot_async()
90
90
  ```
91
91
 
92
92
  **Как отправить сообщение:**
@@ -96,17 +96,17 @@ async with API(cfg) as bot:
96
96
 
97
97
  ```python
98
98
  with API(cfg) as bot:
99
- response = bot.messages.SendMessage(
99
+ response = bot.messages.get_messages(
100
100
  user_id=1234567890,
101
101
  text="Hello world!"
102
102
  )
103
103
  ```
104
104
 
105
- * Ссылка на асинхронный пример: [SendMessageAsync.py](./examples/async/SendMessageAsync.py)
105
+ * Ссылка на асинхронный пример: [get_messages_async.py](./examples/async/get_messages_async.py)
106
106
 
107
107
  ```python
108
108
  async with API(cfg) as bot:
109
- response = await bot.messages.SendMessageAsync(
109
+ response = await bot.messages.get_messages_async(
110
110
  user_id=1234567890,
111
111
  text="Hello world from Async!"
112
112
  )
@@ -114,21 +114,21 @@ async with API(cfg) as bot:
114
114
 
115
115
  **Как легко отправить файл (по ссылке или локальный):**
116
116
 
117
- * Ссылка на синхронный пример: [SendFile.py](./examples/sync/SendFile.py)
117
+ * Ссылка на синхронный пример: [send_file.py](./examples/sync/send_file.py)
118
118
 
119
119
  ```python
120
120
  with API(cfg) as bot:
121
- response = bot.helpers.SendFile(
121
+ response = bot.helpers.send_file(
122
122
  chat_id=1234567890,
123
123
  text="Check this!",
124
124
  file_source="[https://http.cat/200.jpg](https://http.cat/200.jpg)"
125
125
  )
126
126
  ```
127
- * Ссылка на асинхронный пример: [SendFileAsync.py](./examples/async/SendFileAsync.py)
127
+ * Ссылка на асинхронный пример: [send_file_async.py](./examples/async/send_file_async.py)
128
128
 
129
129
  ```python
130
130
  async with API(cfg) as bot:
131
- response = await bot.helpers.SendFileAsync(
131
+ response = await bot.helpers.send_file_async(
132
132
  chat_id=1234567890,
133
133
  text="Посмотри на этот файл!",
134
134
  file_source="[https://http.cat/200.jpg](https://http.cat/200.jpg)"
@@ -137,25 +137,25 @@ async with API(cfg) as bot:
137
137
 
138
138
  **Как вручную загрузить файл (для кастомных вложений):**
139
139
 
140
- * Ссылка на синхронный пример: [UploadFile.py](./examples/sync/UploadFile.py)
140
+ * Ссылка на синхронный пример: [upload_file.py](./examples/sync/upload_file.py)
141
141
 
142
142
  ```python
143
143
  from maxbot_api_client_python.types.constants import UploadType
144
144
 
145
145
  with API(cfg) as bot:
146
- response = bot.uploads.UploadFile(
146
+ response = bot.uploads.upload_file(
147
147
  type=UploadType.image,
148
148
  file_path="examples/assets/file.jpg"
149
149
  )
150
150
  ```
151
151
 
152
- * Ссылка на асинхронный пример: [UploadFileAsync.py](./examples/async/UploadFileAsync.py)
152
+ * Ссылка на асинхронный пример: [upload_file_async.py](./examples/async/upload_file_async.py)
153
153
 
154
154
  ```python
155
155
  from maxbot_api_client_python.types.constants import UploadType
156
156
 
157
157
  async with API(cfg) as bot:
158
- response = await bot.uploads.UploadFileAsync(
158
+ response = await bot.uploads.upload_file_async(
159
159
  type=UploadType.image,
160
160
  file_path="examples/assets/file.jpg"
161
161
  )
@@ -190,13 +190,13 @@ async with API(cfg) as bot:
190
190
  | Описание | Ссылка на пример |
191
191
  | ---------------------------------------------- | ------------------------------------------------------------ |
192
192
  | Как отправить сообщение | [SendMessage.py](./examples/sync/SendMessage.py) |
193
- | Как отправить сообщение *асинхронно* | [SendMessageAsync.py](./examples/async/SendMessageAsync.py) |
194
- | Как получить информацию о боте | [GetBot.py](./examples/sync/GetBot.py) |
195
- | Как получить информацию о боте *асинхронно* | [GetBotAsync.py](./examples/async/GetBotAsync.py) |
196
- | Как загрузить файл | [UploadFile.py](./examples/sync/UploadFile.py) |
197
- | Как загрузить файл *асинхронно* | [UploadFileAsync.py](./examples/async/UploadFileAsync.py) |
198
- | Как отправить файл | [SendFile.py](./examples/sync/SendFile.py) |
199
- | Как отправить файл *асинхронно* | [SendFileAsync.py](./examples/async/SendFileAsync.py) |
193
+ | Как отправить сообщение *асинхронно* | [get_messages_async.py](./examples/async/get_messages_async.py) |
194
+ | Как получить информацию о боте | [get_bot.py](./examples/sync/get_bot.py) |
195
+ | Как получить информацию о боте *асинхронно* | [get_bot_async.py](./examples/async/get_bot_async.py) |
196
+ | Как загрузить файл | [upload_file.py](./examples/sync/upload_file.py) |
197
+ | Как загрузить файл *асинхронно* | [upload_file_async.py](./examples/async/upload_file_async.py) |
198
+ | Как отправить файл | [send_file.py](./examples/sync/send_file.py) |
199
+ | Как отправить файл *асинхронно* | [send_file_async.py](./examples/async/send_file_async.py) |
200
200
  | Как получить входящее уведомление | [GetUpdates.py](./examples/sync/GetUpdates.py) |
201
201
  | Как получить входящее уведомление *асинхронно* | [GetUpdatesAsync.py](./examples/async/GetUpdatesAsync.py) |
202
202
 
@@ -204,10 +204,10 @@ async with API(cfg) as bot:
204
204
 
205
205
  | Метод API | Описание | Ссылка на документацию MAX | Ссылка на документацию библиотеки |
206
206
  |-----------------|-------------------------|------------------------------------------------|----------------------------------------------|
207
- | `Bots.GetBot` | Получает информацию о боте | [GetBot](https://dev.max.ru/docs-api/methods/GET/me) | [GetBot](https://green-api.com/max-bot-api/docs/api/bots/GetBot/) |
208
- | `Bots.PatchBot` | Изменяет информацию о боте | | [PatchBot](https://green-api.com/max-bot-api/docs/api/bots/PatchBot/) |
209
- | `Chats.GetChats` | Возвращает список групповых чатов, в которых участвовал бот | [GetChats](https://dev.max.ru/docs-api/methods/GET/chats) | [GetChats](https://green-api.com/max-bot-api/docs/api/chats/GetChats) |
210
- | `Chats.GetChat` | Возвращает информацию о групповом чате по его ID | [GetChat](https://dev.max.ru/docs-api/methods/GET/chats/-chatId-) | [GetChat](https://green-api.com/max-bot-api/docs/api/chats/GetChat) |
207
+ | `Bots.get_bot` | Получает информацию о боте | [get_bot](https://dev.max.ru/docs-api/methods/GET/me) | [get_bot](https://green-api.com/max-bot-api/docs/api/bots/get_bot/) |
208
+ | `Bots.patch_bot` | Изменяет информацию о боте | | [patch_bot](https://green-api.com/max-bot-api/docs/api/bots/patch_bot/) |
209
+ | `Chats.get_chats` | Возвращает список групповых чатов, в которых участвовал бот | [get_chats](https://dev.max.ru/docs-api/methods/GET/chats) | [get_chats](https://green-api.com/max-bot-api/docs/api/chats/get_chats) |
210
+ | `Chats.get_chat` | Возвращает информацию о групповом чате по его ID | [get_chat](https://dev.max.ru/docs-api/methods/GET/chats/-chatId-) | [get_chat](https://green-api.com/max-bot-api/docs/api/chats/get_chat) |
211
211
  | `Chats.EditChat` | Позволяет редактировать информацию о групповом чате | [EditChat](https://dev.max.ru/docs-api/methods/PATCH/chats/-chatId-) | [EditChat](https://green-api.com/max-bot-api/docs/api/chats/EditChat) |
212
212
  | `Chats.DeleteChat` | Удаляет групповой чат для всех участников | [DeleteChat](https://dev.max.ru/docs-api/methods/DELETE/chats/-chatId-) | [DeleteChat](https://green-api.com/max-bot-api/docs/api/chats/DeleteChat) |
213
213
  | `Chats.SendAction` | Позволяет отправлять следующие действия бота в групповой чат | [SendAction](https://dev.max.ru/docs-api/methods/POST/chats/-chatId-/actions) | [SendAction](https://green-api.com/max-bot-api/docs/api/chats/SendAction) |
@@ -216,7 +216,7 @@ async with API(cfg) as bot:
216
216
  | `Chats.UnpinMessage` | Удаляет закрепленное сообщение в групповом чате | [UnpinMessage](https://dev.max.ru/docs-api/methods/DELETE/chats/-chatId-/pin) | [UnpinMessage](https://green-api.com/max-bot-api/docs/api/chats/UnpinMessage) |
217
217
  | `Chats.GetChatMembership` | Возвращает членство бота в групповом чате | [GetChatMembership](https://dev.max.ru/docs-api/methods/GET/chats/-chatId-/members/me) | [GetChatMembership](https://green-api.com/max-bot-api/docs/api/chats/GetChatMembership) |
218
218
  | `Chats.LeaveChat` | Удаляет бота из группового чата | [LeaveChat](https://dev.max.ru/docs-api/methods/DELETE/chats/-chatId-/members/me) | [LeaveChat](https://green-api.com/max-bot-api/docs/api/chats/LeaveChat) |
219
- | `Chats.GetChatAdmins` | Возвращает список всех администраторов группового чата | [GetChatAdmins](https://dev.max.ru/docs-api/methods/GET/chats/-chatId-/members/admins) | [GetChatAdmins](https://green-api.com/max-bot-api/docs/api/chats/GetChatAdmins) |
219
+ | `Chats.get_chatAdmins` | Возвращает список всех администраторов группового чата | [get_chatAdmins](https://dev.max.ru/docs-api/methods/GET/chats/-chatId-/members/admins) | [get_chatAdmins](https://green-api.com/max-bot-api/docs/api/chats/get_chatAdmins) |
220
220
  | `Chats.SetChatAdmins` | Назначает участника группы администратором | [SetChatAdmins](https://dev.max.ru/docs-api/methods/POST/chats/-chatId-/members/admins) | [SetChatAdmins](https://green-api.com/max-bot-api/docs/api/chats/SetChatAdmins) |
221
221
  | `Chats.DeleteAdmin` | Отменяет права администратора пользователя в групповом чате | [DeleteAdmin](https://dev.max.ru/docs-api/methods/DELETE/chats/-chatId-/members/admins/-userId-) | [DeleteAdmin](https://green-api.com/max-bot-api/docs/api/chats/DeleteAdmin) |
222
222
  | `Chats.GetChatMembers` | Возвращает список участников группового чата | [GetChatMembers](https://dev.max.ru/docs-api/methods/GET/chats/-chatId-/members) | [GetChatMembers](https://green-api.com/max-bot-api/docs/api/chats/GetChatMembers) |
@@ -226,8 +226,8 @@ async with API(cfg) as bot:
226
226
  | `Subscriptions.Subscribe` | Настраивает доставку событий бота через веб-хук | [Subscribe](https://dev.max.ru/docs-api/methods/POST/subscriptions) | [Subscribe](https://green-api.com/max-bot-api/docs/api/subscriptions/Subscribe.md) |
227
227
  | `Subscriptions.Unsubscribe` | Отменяет подписку бота на получение обновлений через веб-хук | [Unsubscribe](https://dev.max.ru/docs-api/methods/DELETE/subscriptions) | [Unsubscribe](https://green-api.com/max-bot-api/docs/api/subscriptions/Unsubscribe) |
228
228
  | `Subscriptions.GetUpdates` | Получает входящие обновления | [GetUpdates](https://dev.max.ru/docs-api/methods/GET/updates) | [GetUpdates](https://green-api.com/max-bot-api/docs/api/subscriptions/GetUpdates) |
229
- | `Upload.UploadFile` | Загружает файл на серверы MAX для последующей передачи | [UploadFile](https://dev.max.ru/docs-api/methods/POST/uploads) | [UploadFile](https://green-api.com/max-bot-api/docs/upload/UploadFile) |
230
- | `Helpers.SendFile` | Упрощает отправку файлов, автоматически определяя URL или путь | | [SendFile](https://green-api.com/max-bot-api/docs/helpers/SendFile) |
229
+ | `Upload.upload_file` | Загружает файл на серверы MAX для последующей передачи | [upload_file](https://dev.max.ru/docs-api/methods/POST/uploads) | [upload_file](https://green-api.com/max-bot-api/docs/upload/upload_file) |
230
+ | `Helpers.send_file` | Упрощает отправку файлов, автоматически определяя URL или путь | | [send_file](https://green-api.com/max-bot-api/docs/helpers/send_file) |
231
231
  | `Messages.GetMessages` | Возвращает информацию о сообщении или массив сообщений из чата | [GetMessages](https://dev.max.ru/docs-api/methods/GET/messages) | [GetMessages](https://green-api.com/max-bot-api/docs/api/messages/GetMessages) |
232
232
  | `Messages.SendMessage` | Отправляет текстовое или медиа-сообщение указанному пользователю или в чат | [SendMessage](https://dev.max.ru/docs-api/methods/POST/messages) | [SendMessage](https://green-api.com/max-bot-api/docs/api/messages/SendMessage) |
233
233
  | `Messages.EditMessage` | Редактирует текст или медиафайл ранее отправленного сообщения | [EditMessage](https://dev.max.ru/docs-api/methods/PUT/messages) | [EditMessage](https://green-api.com/max-bot-api/docs/api/messages/EditMessage) |
@@ -235,6 +235,3 @@ async with API(cfg) as bot:
235
235
  | `Messages.GetMessage` | Извлекает содержимое и метаданные конкретного сообщения по его ID | [GetMessage](https://dev.max.ru/docs-api/methods/GET/messages/-messageId-) | [GetMessage](https://green-api.com/max-bot-api/docs/api/messages/GetMessage) |
236
236
  | `Messages.GetVideoInfo` | Возвращает подробную информацию о прикрепленном видео | [GetVideoInfo](https://dev.max.ru/docs-api/methods/GET/videos/-videoToken-) | [GetVideoInfo](https://green-api.com/max-bot-api/docs/api/messages/GetVideoInfo) |
237
237
  | `Messages.AnswerCallback` | Отправляет ответ после того, как пользователь нажмет кнопку | [AnswerCallback](https://dev.max.ru/docs-api/methods/POST/answers) | [AnswerCallback](https://green-api.com/max-bot-api/docs/api/messages/AnswerCallback )|
238
-
239
- ```
240
- ```
{maxbot_api_client_python-1.1.1 → maxbot_api_client_python-2.0.0}/maxbot_api_client_python/__init__.py RENAMED
@@ -1,5 +1,6 @@
1
1
  from maxbot_api_client_python.api import API
2
- from maxbot_api_client_python.client import Config, Client
2
+ from maxbot_api_client_python.client import Client
3
+ from maxbot_api_client_python.types.models import Config
3
4
  from maxbot_api_client_python.types import models
4
5
  from maxbot_api_client_python.types import constants
5
6
  from maxbot_api_client_python import utils
{maxbot_api_client_python-1.1.1 → maxbot_api_client_python-2.0.0}/maxbot_api_client_python/api.py RENAMED
@@ -1,6 +1,7 @@
1
1
  from typing import Any, Self
2
2
 
3
- from maxbot_api_client_python.client import Client, Config
3
+ from maxbot_api_client_python.client import Client
4
+ from maxbot_api_client_python.types.models import Config
4
5
  from maxbot_api_client_python import tools
5
6
 
6
7
  class API: