botix 1.0.0__py3-none-any.whl

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/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
+

botix/api/channels_api.py

@@ -0,0 +1,279 @@
+"""
+    BOTIX Public API
+
+    Публичный программный интерфейс платформы BOTIX (botix.pro) — позволяет интеграторам и сторонним разработчикам встраивать функционал BOTIX в свои продукты: магазины, CRM, мобильные приложения, бэкенды.  **Авторизация:** заголовок `Authorization: Bearer btx_live_…`. Каждый ключ привязан к одному `project_id`. Каждый ключ имеет список `scopes` — операций, которые им разрешены. Без нужного scope — `403 INSUFFICIENT_SCOPE`.  **Гейтинг по тарифу:** - тариф без `api_enabled` — `403 API_NOT_AVAILABLE_ON_PLAN` - триальный тариф (`api_write_enabled=0`) — read-only, POST/PUT/PATCH/DELETE → `403 TRIAL_READ_ONLY` - лимиты `api_rate_per_minute` / `api_rate_per_day` — из настроек тарифа (см. ЛК `/billing`)  **Стандарт ответов:** обёртка `{success, data, meta}` для успеха и `{success:false, error:{code,message,details}}` для ошибки.  **Версионирование:** `/public/v1/*` фиксирован. Новые поля в ответах могут добавляться, удаление/смена типов запрещены. 
+
+    The version of the OpenAPI document: 1.0.0
+    Contact: hello@botix.pro
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from botix.models.channels_list200_response import ChannelsList200Response
+
+from botix.api_client import ApiClient, RequestSerialized
+from botix.api_response import ApiResponse
+from botix.rest import RESTResponseType
+
+
+class ChannelsApi:
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None) -> None:
+        if api_client is None:
+            api_client = ApiClient.get_default()
+        self.api_client = api_client
+
+
+    @validate_call
+    def channels_list(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ChannelsList200Response:
+        """Каналы проекта
+
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._channels_list_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ChannelsList200Response",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def channels_list_with_http_info(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[ChannelsList200Response]:
+        """Каналы проекта
+
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._channels_list_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ChannelsList200Response",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def channels_list_without_preload_content(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Каналы проекта
+
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._channels_list_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ChannelsList200Response",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _channels_list_serialize(
+        self,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'bearerAuth'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/public/v1/channels',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+