botix 1.0.0__tar.gz

botix-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 BOTIX (IE Shpagin V.V.)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

botix-1.0.0/PKG-INFO

@@ -0,0 +1,187 @@
+Metadata-Version: 2.4
+Name: botix
+Version: 1.0.0
+Summary: Официальный Python SDK для публичного API BOTIX
+Author-email: BOTIX <info@botix.pro>
+License: MIT
+Project-URL: Homepage, https://botix.pro
+Project-URL: Documentation, https://developers.botix.pro
+Project-URL: Repository, https://github.com/BOTIX-pro/sdk-python
+Project-URL: Issues, https://github.com/BOTIX-pro/sdk-python/issues
+Project-URL: Changelog, https://github.com/BOTIX-pro/sdk-python/blob/main/CHANGELOG.md
+Keywords: botix,chatbot,api,sdk,telegram,whatsapp,vk,messenger
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Communications :: Chat
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: urllib3<3.0.0,>=2.1.0
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: pydantic>=2.11
+Requires-Dist: typing-extensions>=4.7.1
+Provides-Extra: test
+Requires-Dist: pytest>=7.2; extra == "test"
+Requires-Dist: pytest-cov>=4.0; extra == "test"
+Dynamic: license-file
+
+# BOTIX SDK для Python
+
+Официальная клиентская библиотека для публичного API BOTIX — платформы визуального конструктора чат-ботов и AI-ассистентов.
+
+[![PyPI version](https://img.shields.io/pypi/v/botix.svg)](https://pypi.org/project/botix/)
+[![Python versions](https://img.shields.io/pypi/pyversions/botix.svg)](https://pypi.org/project/botix/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![CI](https://github.com/BOTIX-pro/sdk-python/actions/workflows/test.yml/badge.svg)](https://github.com/BOTIX-pro/sdk-python/actions/workflows/test.yml)
+
+## Что это
+
+BOTIX — облачная SaaS-платформа визуального конструктора чат-ботов: Telegram, WhatsApp, ВКонтакте, виджет на сайте. SDK даёт типизированный доступ к публичному REST API BOTIX из Python-приложений: контакты, сообщения, сценарии, чаты, webhooks.
+
+## Установка
+
+```bash
+pip install botix
+```
+
+Минимальная версия Python — 3.9.
+
+## Первый запрос
+
+Получите API-ключ в кабинете BOTIX: «Настройки → API-ключи → Создать ключ». Ключ показывается один раз — сохраните его.
+
+```python
+import botix
+
+client = botix.Client("btx_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx")
+
+me = client.me()
+print(me.data.project_id, me.data.scopes, me.data.plan_key)
+```
+
+Возвращается контекст текущего ключа: ID проекта, разрешённые scopes, тариф клиента и остаток rate-limit.
+
+## Отправка сообщения
+
+```python
+response = client.messages.send(
+    contact_id=42,
+    content="Привет! Это сообщение из BOTIX SDK.",
+    channel="telegram",  # опционально — иначе берётся last_channel контакта
+)
+print(response.data.id, response.data.status)
+if response.replayed:
+    print("Сервер вернул кешированный ответ по совпадению Idempotency-Key")
+```
+
+SDK автоматически генерирует `Idempotency-Key` (UUID v4) для защиты от случайных дублей при сетевых сбоях. Чтобы отключить: `botix.Client(api_key, auto_idempotency=False)`. Свой ключ — `client.messages.send(..., idempotency_key="my-uuid")`.
+
+## Webhooks: проверка подписи
+
+BOTIX подписывает каждое входящее webhook-сообщение HMAC-SHA256 над сырым телом запроса. Секрет вы получили один раз при создании подписки через `client.webhooks.create(...)`.
+
+```python
+from flask import Flask, request, abort
+import botix
+
+app = Flask(__name__)
+WEBHOOK_SECRET = "ваш_секрет_подписки"
+
+@app.route("/botix-webhook", methods=["POST"])
+def botix_webhook():
+    raw_body = request.get_data()  # ВАЖНО: сырое тело, не request.json
+    signature = request.headers.get("X-Botix-Signature", "")
+
+    if not botix.verify_webhook(raw_body, signature, WEBHOOK_SECRET):
+        abort(401, "Invalid signature")
+
+    event = request.json
+    print(event["event"], event["data"])
+    return "", 200
+```
+
+## Работа с ошибками
+
+SDK кидает `botix.ApiException` на любой не-2xx ответ. Код ошибки BOTIX лежит в теле ответа.
+
+```python
+import botix
+import json
+
+client = botix.Client("btx_live_...")
+
+try:
+    contact = client.contacts.get(99999)
+except botix.ApiException as e:
+    body = json.loads(e.body) if e.body else {}
+    code = body.get("error", {}).get("code")
+    print(f"HTTP {e.status} / {code}: {body.get('error', {}).get('message')}")
+```
+
+Возможные коды (полный список — в [документации API](https://developers.botix.pro)):
+
+| Код | HTTP | Когда |
+|---|---|---|
+| `MISSING_API_KEY` | 401 | Нет заголовка Authorization |
+| `INVALID_API_KEY` | 401 | Ключ не существует или подделан |
+| `KEY_REVOKED` | 401 | Ключ отозван |
+| `INSUFFICIENT_SCOPE` | 403 | У ключа нет нужного scope |
+| `API_NOT_AVAILABLE_ON_PLAN` | 403 | Тариф клиента не включает API |
+| `TRIAL_READ_ONLY` | 403 | Триал — мутирующие методы запрещены |
+| `RATE_LIMIT_EXCEEDED` | 429 | Превышен per-minute или per-day лимит |
+| `NO_CHANNEL_AVAILABLE` | 422 | Не удалось определить канал отправки |
+| `CHANNEL_NOT_SUPPORTED_YET` | 422 | Канал ещё не подключён к API |
+| `CONTACT_NOT_REACHABLE` | 422 | У контакта нет chat_id/phone для канала |
+| `DELIVERY_FAILED` | 502 | Канал отверг отправку |
+
+## Доступные ресурсы
+
+```python
+client.me()                                        # GET  /me
+client.contacts.list(page=1, per_page=50, ...)     # GET  /contacts
+client.contacts.get(id)                            # GET  /contacts/{id}
+client.contacts.create(**fields)                   # POST /contacts
+client.contacts.update(id, **fields)               # PUT  /contacts/{id}
+client.contacts.delete(id)                         # DELETE /contacts/{id}
+client.contacts.add_tag(id, tag)                   # POST /contacts/{id}/tags
+client.contacts.remove_tag(id, tag)                # DELETE /contacts/{id}/tags/{tag}
+
+client.messages.list(...)                          # GET  /messages
+client.messages.send(contact_id, content, ...)     # POST /messages
+
+client.scenarios.list()                            # GET  /scenarios
+client.scenarios.run(id, contact_id, ...)          # POST /scenarios/{id}/run
+
+client.chats.list(...)                             # GET  /chats
+client.chats.messages(chat_id)                     # GET  /chats/{id}/messages
+
+client.channels.list()                             # GET  /channels
+
+client.webhooks.list()                             # GET  /webhooks
+client.webhooks.create(url, events)                # POST /webhooks
+client.webhooks.update(id, ...)                    # PUT  /webhooks/{id}
+client.webhooks.delete(id)                         # DELETE /webhooks/{id}
+client.webhooks.test(id)                           # POST /webhooks/{id}/test
+```
+
+Примеры в [examples/](./examples).
+
+## Ссылки
+
+- Полная документация API: [developers.botix.pro](https://developers.botix.pro)
+- Платформа BOTIX: [botix.pro](https://botix.pro)
+- Для разработчиков: [botix.pro/developers](https://botix.pro/developers)
+- Issues: [github.com/BOTIX-pro/sdk-python/issues](https://github.com/BOTIX-pro/sdk-python/issues)
+- PyPI: [pypi.org/project/botix](https://pypi.org/project/botix)
+
+## Лицензия
+
+[MIT](./LICENSE) © 2026 BOTIX (ИП Шпагин В.В.)

botix-1.0.0/README.md

@@ -0,0 +1,152 @@
+# BOTIX SDK для Python
+
+Официальная клиентская библиотека для публичного API BOTIX — платформы визуального конструктора чат-ботов и AI-ассистентов.
+
+[![PyPI version](https://img.shields.io/pypi/v/botix.svg)](https://pypi.org/project/botix/)
+[![Python versions](https://img.shields.io/pypi/pyversions/botix.svg)](https://pypi.org/project/botix/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![CI](https://github.com/BOTIX-pro/sdk-python/actions/workflows/test.yml/badge.svg)](https://github.com/BOTIX-pro/sdk-python/actions/workflows/test.yml)
+
+## Что это
+
+BOTIX — облачная SaaS-платформа визуального конструктора чат-ботов: Telegram, WhatsApp, ВКонтакте, виджет на сайте. SDK даёт типизированный доступ к публичному REST API BOTIX из Python-приложений: контакты, сообщения, сценарии, чаты, webhooks.
+
+## Установка
+
+```bash
+pip install botix
+```
+
+Минимальная версия Python — 3.9.
+
+## Первый запрос
+
+Получите API-ключ в кабинете BOTIX: «Настройки → API-ключи → Создать ключ». Ключ показывается один раз — сохраните его.
+
+```python
+import botix
+
+client = botix.Client("btx_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx")
+
+me = client.me()
+print(me.data.project_id, me.data.scopes, me.data.plan_key)
+```
+
+Возвращается контекст текущего ключа: ID проекта, разрешённые scopes, тариф клиента и остаток rate-limit.
+
+## Отправка сообщения
+
+```python
+response = client.messages.send(
+    contact_id=42,
+    content="Привет! Это сообщение из BOTIX SDK.",
+    channel="telegram",  # опционально — иначе берётся last_channel контакта
+)
+print(response.data.id, response.data.status)
+if response.replayed:
+    print("Сервер вернул кешированный ответ по совпадению Idempotency-Key")
+```
+
+SDK автоматически генерирует `Idempotency-Key` (UUID v4) для защиты от случайных дублей при сетевых сбоях. Чтобы отключить: `botix.Client(api_key, auto_idempotency=False)`. Свой ключ — `client.messages.send(..., idempotency_key="my-uuid")`.
+
+## Webhooks: проверка подписи
+
+BOTIX подписывает каждое входящее webhook-сообщение HMAC-SHA256 над сырым телом запроса. Секрет вы получили один раз при создании подписки через `client.webhooks.create(...)`.
+
+```python
+from flask import Flask, request, abort
+import botix
+
+app = Flask(__name__)
+WEBHOOK_SECRET = "ваш_секрет_подписки"
+
+@app.route("/botix-webhook", methods=["POST"])
+def botix_webhook():
+    raw_body = request.get_data()  # ВАЖНО: сырое тело, не request.json
+    signature = request.headers.get("X-Botix-Signature", "")
+
+    if not botix.verify_webhook(raw_body, signature, WEBHOOK_SECRET):
+        abort(401, "Invalid signature")
+
+    event = request.json
+    print(event["event"], event["data"])
+    return "", 200
+```
+
+## Работа с ошибками
+
+SDK кидает `botix.ApiException` на любой не-2xx ответ. Код ошибки BOTIX лежит в теле ответа.
+
+```python
+import botix
+import json
+
+client = botix.Client("btx_live_...")
+
+try:
+    contact = client.contacts.get(99999)
+except botix.ApiException as e:
+    body = json.loads(e.body) if e.body else {}
+    code = body.get("error", {}).get("code")
+    print(f"HTTP {e.status} / {code}: {body.get('error', {}).get('message')}")
+```
+
+Возможные коды (полный список — в [документации API](https://developers.botix.pro)):
+
+| Код | HTTP | Когда |
+|---|---|---|
+| `MISSING_API_KEY` | 401 | Нет заголовка Authorization |
+| `INVALID_API_KEY` | 401 | Ключ не существует или подделан |
+| `KEY_REVOKED` | 401 | Ключ отозван |
+| `INSUFFICIENT_SCOPE` | 403 | У ключа нет нужного scope |
+| `API_NOT_AVAILABLE_ON_PLAN` | 403 | Тариф клиента не включает API |
+| `TRIAL_READ_ONLY` | 403 | Триал — мутирующие методы запрещены |
+| `RATE_LIMIT_EXCEEDED` | 429 | Превышен per-minute или per-day лимит |
+| `NO_CHANNEL_AVAILABLE` | 422 | Не удалось определить канал отправки |
+| `CHANNEL_NOT_SUPPORTED_YET` | 422 | Канал ещё не подключён к API |
+| `CONTACT_NOT_REACHABLE` | 422 | У контакта нет chat_id/phone для канала |
+| `DELIVERY_FAILED` | 502 | Канал отверг отправку |
+
+## Доступные ресурсы
+
+```python
+client.me()                                        # GET  /me
+client.contacts.list(page=1, per_page=50, ...)     # GET  /contacts
+client.contacts.get(id)                            # GET  /contacts/{id}
+client.contacts.create(**fields)                   # POST /contacts
+client.contacts.update(id, **fields)               # PUT  /contacts/{id}
+client.contacts.delete(id)                         # DELETE /contacts/{id}
+client.contacts.add_tag(id, tag)                   # POST /contacts/{id}/tags
+client.contacts.remove_tag(id, tag)                # DELETE /contacts/{id}/tags/{tag}
+
+client.messages.list(...)                          # GET  /messages
+client.messages.send(contact_id, content, ...)     # POST /messages
+
+client.scenarios.list()                            # GET  /scenarios
+client.scenarios.run(id, contact_id, ...)          # POST /scenarios/{id}/run
+
+client.chats.list(...)                             # GET  /chats
+client.chats.messages(chat_id)                     # GET  /chats/{id}/messages
+
+client.channels.list()                             # GET  /channels
+
+client.webhooks.list()                             # GET  /webhooks
+client.webhooks.create(url, events)                # POST /webhooks
+client.webhooks.update(id, ...)                    # PUT  /webhooks/{id}
+client.webhooks.delete(id)                         # DELETE /webhooks/{id}
+client.webhooks.test(id)                           # POST /webhooks/{id}/test
+```
+
+Примеры в [examples/](./examples).
+
+## Ссылки
+
+- Полная документация API: [developers.botix.pro](https://developers.botix.pro)
+- Платформа BOTIX: [botix.pro](https://botix.pro)
+- Для разработчиков: [botix.pro/developers](https://botix.pro/developers)
+- Issues: [github.com/BOTIX-pro/sdk-python/issues](https://github.com/BOTIX-pro/sdk-python/issues)
+- PyPI: [pypi.org/project/botix](https://pypi.org/project/botix)
+
+## Лицензия
+
+[MIT](./LICENSE) © 2026 BOTIX (ИП Шпагин В.В.)

botix-1.0.0/botix/__init__.py

@@ -0,0 +1,98 @@
+# coding: utf-8
+
+"""
+BOTIX SDK для Python — официальная клиентская библиотека публичного API BOTIX.
+
+Точка входа — :class:`botix.Client`. Хелпер :func:`botix.verify_webhook`
+сверяет подпись входящих webhook-сообщений.
+
+Пример:
+
+    import botix
+
+    client = botix.Client("btx_live_...")
+    print(client.me())
+"""
+
+__version__ = "1.0.0"
+
+# Высокоуровневое API — то, что использует разработчик в 99% случаев.
+from botix.client import Client as Client
+from botix.idempotency import Response as Response
+from botix.idempotency import generate_idempotency_key as generate_idempotency_key
+from botix.webhook import verify_webhook as verify_webhook
+
+# Низкоуровневые компоненты сгенерированного клиента — для опытных пользователей,
+# которым нужен прямой доступ к сырому ApiClient / Configuration / типизированным
+# pydantic-моделям ответов.
+from botix.api.channels_api import ChannelsApi as ChannelsApi
+from botix.api.chats_api import ChatsApi as ChatsApi
+from botix.api.contacts_api import ContactsApi as ContactsApi
+from botix.api.messages_api import MessagesApi as MessagesApi
+from botix.api.scenarios_api import ScenariosApi as ScenariosApi
+from botix.api.system_api import SystemApi as SystemApi
+from botix.api.webhooks_api import WebhooksApi as WebhooksApi
+from botix.api_client import ApiClient as ApiClient
+from botix.api_response import ApiResponse as ApiResponse
+from botix.configuration import Configuration as Configuration
+from botix.exceptions import ApiAttributeError as ApiAttributeError
+from botix.exceptions import ApiException as ApiException
+from botix.exceptions import ApiKeyError as ApiKeyError
+from botix.exceptions import ApiTypeError as ApiTypeError
+from botix.exceptions import ApiValueError as ApiValueError
+from botix.exceptions import OpenApiException as OpenApiException
+
+# Типизированные модели данных — для type hints и сериализации.
+from botix.models.channel import Channel as Channel
+from botix.models.chat import Chat as Chat
+from botix.models.contact import Contact as Contact
+from botix.models.contact_writable import ContactWritable as ContactWritable
+from botix.models.error import Error as Error
+from botix.models.error_error import ErrorError as ErrorError
+from botix.models.me_response import MeResponse as MeResponse
+from botix.models.me_response_data import MeResponseData as MeResponseData
+from botix.models.message import Message as Message
+from botix.models.scenario import Scenario as Scenario
+from botix.models.webhook import Webhook as Webhook
+from botix.models.webhook_event import WebhookEvent as WebhookEvent
+
+__all__ = [
+    "__version__",
+    # High-level
+    "Client",
+    "Response",
+    "verify_webhook",
+    "generate_idempotency_key",
+    # Low-level (advanced) — resource API classes
+    "ChannelsApi",
+    "ChatsApi",
+    "ContactsApi",
+    "MessagesApi",
+    "ScenariosApi",
+    "SystemApi",
+    "WebhooksApi",
+    # Low-level — core
+    "ApiClient",
+    "ApiResponse",
+    "Configuration",
+    # Exceptions
+    "ApiException",
+    "ApiAttributeError",
+    "ApiKeyError",
+    "ApiTypeError",
+    "ApiValueError",
+    "OpenApiException",
+    # Models
+    "Channel",
+    "Chat",
+    "Contact",
+    "ContactWritable",
+    "Error",
+    "ErrorError",
+    "MeResponse",
+    "MeResponseData",
+    "Message",
+    "Scenario",
+    "Webhook",
+    "WebhookEvent",
+]

botix-1.0.0/botix/api/__init__.py

@@ -0,0 +1,11 @@
+# flake8: noqa
+
+# import apis into api package
+from botix.api.channels_api import ChannelsApi
+from botix.api.chats_api import ChatsApi
+from botix.api.contacts_api import ContactsApi
+from botix.api.messages_api import MessagesApi
+from botix.api.scenarios_api import ScenariosApi
+from botix.api.system_api import SystemApi
+from botix.api.webhooks_api import WebhooksApi
+