Yougile API для Python

Информация о библиотеке

Библиотека является разработкой стороннего разработчика для удобства обращения к Yougile API.

Установка

Если вы устанавливаете вручную, перед использованием библиотеки, необходимо установить следующее:

> pip install pydantic
> pip install requests
> pip install httpx

Если вы устанавливаете из PyPI, то эти библиотеки устанавливаются автоматически:

> pip install yougile-api

Wiki

У моделей есть правила:

1. Название моделей полностью копируют URL этой модели на официальном API.
2. У всех моделей есть описания параметров, краткого описания из официального API и ссылка на запрос.
3. Названия параметров модели и их типизация идентичны параметрам из официального API (За исключением параметра token)

Возможности

Токен можно передавать тремя способами:

1. в саму модель
2. в yougile.query(...) / yougile.query_async(...)
3. в yougile.Client(...) / yougile.AsyncClient(...)

Приоритет такой: явный аргумент функции/метода, затем токен клиента, затем токен модели.

Пример передачи токена в функцию запроса:

import requests
import yougile
import yougile.models as models

def yougile_get(model: yougile.BaseModel) -> requests.Response:
    return yougile.query(model, token="TOKEN")

model = models.ChatMessageController_search(chatId="12324")
response = yougile_get(model)

for msg in response.json()["content"]:
    print(msg["text"])

Примеры

1. Получаем список доступных компаний

import yougile  # Импортируем библиотеку
import yougile.models as models  # Импортируем модели

model = models.AuthKeyController_companiesList(
    login="USERNAME",
    password="PASSWORD",
)  # Указываем модель запроса листа компаний через авторизацию
response = yougile.query(model)  # Делаем запрос на сервер
print(response.text)  # Получаем ответ

2. Создаем токен

import yougile
import yougile.models as models

model = models.AuthKeyController_create(
    login="USERNAME",
    password="PASSWORD",
    companyId="12345",
)
response = yougile.query(model)
print(response.json()["key"])

3. Получаем историю сообщений

import yougile
import yougile.models as models

model = models.ChatMessageController_search(token="TOKEN", chatId="12324")
response = yougile.query(model)
for msg in response.json()["content"]:
    print(msg["text"])

4. Асинхронный запрос: Загружаем файл

import asyncio
import yougile
import yougile.models as models

async def main():
    model = models.FileController_uploadFile(
        token="YOUR_TOKEN",
        file=r"C:\Users\txello\Desktop\test.png",
    )
    response = await yougile.query_async(model)
    print(response.json())

asyncio.run(main())

5. Self-hosted: указываем base_url

import yougile
import yougile.models as models

model = models.ChatMessageController_search(token="TOKEN", chatId="12324")
response = yougile.query(
    model,
    base_url="https://yougile.example.com",
)

for msg in response.json()["content"]:
    print(msg["text"])

6. Клиент с настройками подключения

import yougile
import yougile.models as models

client = yougile.Client(
    base_url="https://yougile.example.com",
    token="TOKEN",
)

model = models.ChatMessageController_search(chatId="12324")
response = client.query(model)

for msg in response.json()["content"]:
    print(msg["text"])

7. Асинхронный клиент с настройками подключения

import asyncio
import yougile
import yougile.models as models

async def main():
    client = yougile.AsyncClient(
        base_url="https://yougile.example.com",
        token="TOKEN",
    )
    model = models.ChatMessageController_search(chatId="12324")
    response = await client.query(model)
    print(response.json())

asyncio.run(main())

Версии

v1.4.1

• Исправлена поддержка версии Python с 3.8+ на 3.10+ (Спасибо ilsky69)

v1.4.0

• Добавлена поддержка self-hosted YouGile через параметр base_url в query и query_async
• Добавлены yougile.Client и yougile.AsyncClient для хранения настроек подключения
• Параметр token в API-моделях сделан необязательным: токен теперь можно хранить только в клиенте или передавать в функцию запроса
• Исправлены модели CompanyController_get и CompanyController_update
• Исправлены модели TaskController_search, TaskController_searchReversed, TaskController_create и TaskController_update
• Исправлены модели GroupChatController_create, GroupChatController_update, WebhookController_create и WebhookController_put
• Исправлены модели DepartmentController_search и ChatMessageController_sendMessage
• Исправлены модели CrmContactPersonsController_create и CrmExternalIdController_findContactByExternalId
• Обновлена документация и примеры использования

Спасибо ilsky69 за найденные проблемы и вклад в улучшение проекта.

v1.3.0

• Добавлена асинхронная поддержка через функцию query_async (Через библиотеку httpx).
• Фильтрация версий изменена с последней на первую.
• Исправлены docstrings.

v1.2.0

• Добавлены модели CrmContactPersonsController_create и CrmExternalIdController_findContactByExternalId.
• Изменена лицензия в файле LICENSE с GNU GPL v3.0 на MIT (Спасибо XTerris).

v1.1.0

• Добавлены новые модели: CompanyController_get, CompanyController_update, FileController_uploadFile, TaskController_getChatSubscribers, TaskController_updateChatSubscribers
• Добавлена возможность загрузки файла через FileController_uploadFile
• Добавлено CI/CD
• Исправлены модели TaskController_get и TaskController_update (Спасибо XTerris)
• Исправлены модели в документации
• Улучшена документация: Заменена на Google Docstring
• Выполнен рефакторинг кода

v1.0.1

• Исправлены модели
• Исправлены комментарии

v1.0.0

• Созданы первые модели
• Создано подключение к серверу API