Skip to content

API Reference

Автоматически сгенерированная документация из JSDoc-комментариев исходного кода (src/) и TypeScript-описаний DTO (src/dto/).

Сервисы

Клиенты, воркеры и пользователи

СервисОписание
clientServiceКлиенты
clientLeadServiceЛиды клиентов (CRM)
workerServiceВоркеры
workerLeadServiceЛиды воркеров (CRM)
workerAssignmentServiceНазначения воркеров
userServiceПользователи
contactServiceКонтакты

Бизнес-сущности и справочники

СервисОписание
partnerServiceПартнёры
allocationServiceАллокации
complaintsServiceЖалобы
addressServiceАдреса
regionServiceРегионы
insuranceCompanyServiceСтраховые компании
socialServiceServiceСоциальные службы
publicHolidayAccessServiceГосударственные праздники
recallServiceПерезвоны
ratePerHourServiceПочасовые ставки
costPerKilometerServiceСтоимость за километр
tagServiceТеги
monthlyReportServiceЕжемесячные отчёты

Учёт рабочего времени (Manager Time Tracker)

СервисОписание
worktimeServiceРабочее время
workTimeEntryAccessServiceЗаписи учёта рабочего времени
workTimeSummaryAccessServiceСводки за день и месяц
workTimeReportsAccessServiceОтчёты по рабочему времени
workTimeSettingsAccessServiceНастройки учёта рабочего времени
workTimeBacklogStateAccessServiceСостояние бэклога рабочего времени
workScheduleAccessServiceГрафики работы
absenceEntryAccessServiceЗаписи об отсутствии
datevExportAccessServiceЭкспорт рабочего времени в DATEV

Колл-центр

СервисОписание
agentServiceАгенты
callsServiceЗвонки
callSessionServiceСессии звонков
queueServiceОчередь

Коммуникации

СервисОписание
chatServiceЧат
emailServiceEmail
mailServiceПочта
notificationServiceУведомления

Обучение

СервисОписание
courseServiceКурсы
quizServiceКвизы
proctoringServiceПрокторинг

Документы, задачи и интеграции

СервисОписание
fileServiceФайлы
docTemplateServiceШаблоны документов
historyServiceИстория изменений
taskServiceЗадачи
searchServiceПоиск
permissionServiceПрава доступа
mondayImportServiceBootstrap-импорт из Monday
mondaySyncServiceСинхронизация изменений из Monday

DTO

Типы запросов и ответов организованы по доменам в src/dto/<домен>/. Каждая страница содержит таблицу полей (тип, обязательность, описание) и пример JSON; при наличии бэкенд-snapshot добавляются C#-типы и коды enum.

ДоменОписание
commonОбщие типы: пагинация, фильтры, enum
addressАдреса и координаты
allocationАллокации
callCenterКолл-центр: агенты, звонки, очереди
chatЧат
clientКлиенты
complaintЖалобы
contactКонтакты
documentДокументы и шаблоны
emailEmail
fileФайлы
historyИстория изменений
insuranceСтраховые компании
lead/clientЛиды клиентов
lead/workerЛиды воркеров
learningОбучение: курсы, квизы
mailПочта
managerTimeTrackerУчёт рабочего времени
mondayИмпорт и синхронизация Monday
monthlyReportЕжемесячные отчёты
partnerПартнёры
publicHolidayГосударственные праздники
recallПерезвоны
regionРегионы
searchПоиск
tagТеги
taskЗадачи
userПользователи
workerВоркеры
workerAssignmentНазначения воркеров
worktimeРабочее время