API Reference
Автоматически сгенерированная документация из JSDoc-комментариев исходного кода (src/) и TypeScript-описаний DTO (src/dto/).
Сервисы
Клиенты, воркеры и пользователи
| Сервис | Описание |
|---|---|
| clientService | Клиенты |
| 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 |
Коммуникации
| Сервис | Описание |
|---|---|
| chatService | Чат |
| emailService | |
| mailService | Почта |
| notificationService | Уведомления |
Обучение
| Сервис | Описание |
|---|---|
| courseService | Курсы |
| quizService | Квизы |
| proctoringService | Прокторинг |
Документы, задачи и интеграции
| Сервис | Описание |
|---|---|
| fileService | Файлы |
| docTemplateService | Шаблоны документов |
| historyService | История изменений |
| taskService | Задачи |
| searchService | Поиск |
| permissionService | Права доступа |
DTO
Типы запросов и ответов организованы по доменам в src/dto/<домен>/. Каждая страница содержит таблицу полей (тип, обязательность, описание) и пример JSON; при наличии бэкенд-snapshot добавляются C#-типы и коды enum.
| Домен | Описание |
|---|---|
| common | Общие типы: пагинация, фильтры, enum |
| address | Адреса и координаты |
| allocation | Аллокации |
| chat | Чат |
| client | Клиенты |
| complaint | Жалобы |
| contact | Контакты |
| document | Документы и шаблоны |
| file | Файлы |
| history | История изменений |
| insurance | Страховые компании |
| lead/worker | Лиды воркеров |
| learning | Обучение: курсы, квизы |
| Почта | |
| managerTimeTracker | Учёт рабочего времени |
| monthlyReport | Ежемесячные отчёты |
| partner | Партнёры |
| publicHoliday | Государственные праздники |
| recall | Перезвоны |
| region | Регионы |
| search | Поиск |
| tag | Теги |
| task | Задачи |
| user | Пользователи |
| worker | Воркеры |
| workerAssignment | Назначения воркеров |
| worktime | Рабочее время |