orm-bitrix24 0.1.4

ORM for Bitrix24 REST API

ORM-система для работы с Bitrix24

Работа библиотеки находится в стадии разработки. (рекомендуется только для локальной разработки)

Библиотека для удобной работы с API Bitrix24 в объектно-ориентированном стиле.

Особенности

• ORM-подобный доступ к данным через точечную нотацию
• Удобные методы для создания, обновления и поиска сущностей
• Поддержка связанных объектов и отношений между ними
• Поддержка пользовательских полей
• Работа с товарными позициями сделок
• Асинхронный подход для лучшей производительности
• Поддержка комментариев в таймлайне
• для поддержки анотации в IDE используйте конструкцию вида:

from orm_bitrix24.entity import _Deal, TextCustomField
class Deal(_Deal):
    new_string_user = TextCustomField("UF_CRM_1748463696180")
deal:Deal=await Deal.objects.get_by_id(123)
deal.new_string_user="test_source"
await deal.save()

Установка

uv add orm-bitrix24

Запуск тестов

cd tests
uv run pytest

Использование

Инициализация

from fast_bitrix24 import Bitrix
from entity import Deal

# Инициализация Bitrix клиента
bitrix = Bitrix('https://your-domain.bitrix24.ru/rest/1/your_webhook_token/')

# Инициализация менеджера сущностей
Deal.get_manager(bitrix)

Получение сделок

# Получение всех сделок
deals = await Deal.objects.get_all()

# Фильтрация сделок
deals = await Deal.objects.filter(type_id="SALE", stage_id="NEW")

# Получение сделки по ID
deal = await Deal.get_by_id(bitrix, "123")

Работа со сделкой

# Чтение полей
print(deal.title)
print(deal.opportunity)
print(deal.created_at)  # Автоматически преобразуется в datetime объект

# Чтение связанных объектов (необходимо использовать await)
company = await deal.company
if company:
    print(company.name)

# Изменение значений
deal.title = "Новое название"
deal.opportunity = 15000
deal.tags.append("новый_тег")
await deal.save()

# Создание примечаний
note = await deal.notes.create(text="Примечание к сделке")

Создание новой сделки

# Создание через менеджер объектов
deal = await Deal.objects.create(
    title="Новая сделка",
    opportunity=10000,
    currency_id="RUB",
    stage_id="NEW"
)

# Альтернативный способ создания
deal = Deal(bitrix)
deal.title = "Новая сделка"
deal.opportunity = 10000
deal.currency_id = "RUB"
deal.stage_id = "NEW"
await deal.save()

Работа с товарами сделки

# Получение товаров сделки
products = await deal.products.get_all()
print(f"В сделке {len(products)} товаров")

# Добавление товара
product = deal.products.add(
    product_id=123,  # ID товара из каталога Bitrix24
    price=1000,
    quantity=2,
    discount_rate=10  # 10% скидка
)

# Изменение параметров товара
product.quantity = 3
product.discount_sum = 500  # Скидка фиксированной суммой

# Сохранение товаров сделки
await deal.save()

Пользовательские поля

from entity import Deal, CustomField, TextCustomField, SelectCustomField

# Добавление пользовательских полей напрямую в класс Deal
Deal.add_custom_field('utm_source', CustomField("UTM_SOURCE"))
Deal.add_custom_field('delivery_address', TextCustomField("UF_CRM_DELIVERY_ADDRESS"))
Deal.add_custom_field('delivery_type', SelectCustomField("UF_CRM_DELIVERY_TYPE"))

# Инициализация менеджера
Deal.get_manager(bitrix)

# Использование пользовательских полей
deals = await Deal.objects.get_all()
deal = deals[0]
deal.delivery_address = "ул. Примерная, д. 1, кв. 2"
await deal.save()

Работа со связанными объектами

Важно! Связанные объекты (company, contact и др.) возвращают корутины, которые нужно ожидать с помощью await:

# Получение связанной компании
company = await deal.company
if company:
    print(f"Компания: {company.title}")

# Получение связанного контакта
contact = await deal.contact
if contact:
    print(f"Контакт: {contact.full_name}")

# Изменение связанного объекта произойдет только после сохранения сделки
deal.company_id = 5  # Смена компании
await deal.save()

Перемещение лида в сделку

для переноса лида в сделку необходимо создать компанию и контакт, если они не существуют. И привязать их к лиду

from orm_bitrix24.entity import _Lead, Company
# Инициализация клиента Bitrix24
webhook = os.environ.get("WEBHOOK")
if not webhook:
    print("Необходимо установить переменную окружения WEBHOOK")
    return

bitrix = Bitrix(webhook)

# Инициализация менеджеров сущностей
Lead.get_manager(bitrix)
leads = await Lead.objects.get_all()
print(f"Найдено лидов: {len(leads)}")
lead = leads[0]

deal=await lead.move_to_deal(isCreateCompany=True, isCreateContact=False)
print(deal)

Работа с активностями

на данный момент поддерживаются только email-активности создает дело письмо и отправляет его контакту из сделки (если email несколько то только на первый)

email_activity = await deal.activity.mail(
    subject="Коммерческое предложение из ORM просто ответьте",
    message="Добрый день! Высылаем коммерческое предложение через новую ORM-систему.",
    contact_id=deal.contact_id,
    from_email="почта@из.битрикса")

чтобы получить комментарии у связанной сущности необходимо получить сделку и затем сущность например контакт

await deal.contact
    
await deal.contact.timeline.comments.create("Тестовый комментарий через ORM3")

comments = await deal.contact.timeline.comments.get_all()
logger.info(f"Найдено {len(comments)} комментариев таймлайна")
for comment in comments:
    logger.info(f"Комментарий ID {comment.id}: {comment.comment} от {comment.author_id}")

Работа с порталом

from orm_bitrix24.entity import Portal
portal = Portal(bitrix)

# Получение всех полей сделки
deal_fields = await portal.deal.fields.get_all()

# Получение всех полей контакта
contact_fields = await portal.contact.fields.get_all()

# Создание поля сделки
new_field = await portal.deal.fields.create(
    field_name="TEST_FIELD",
    field_title="Тестовое поле",
    field_type="string",
    is_required=False
)
# получение пользовательских полей сделки в человеческом виде
custom_fields = await portal.deal.fields.get_custom_fields()
print(f"Пользовательских полей: {len(custom_fields)}")

for field in custom_fields:
    print(f"- {field.name}: {field.title} ({field.type})")
    if field.type == 'enumeration':
        for value in field.values:
            print(f'  {value.value} ({value.id})')

# Удаление поля сделки
await portal.deal.fields.delete("UF_CRM_TEST_FIELD")

Требования

• Python 3.12+
• fast-bitrix24

Лицензия

MIT