bx-rest 0.21.2 → 0.22.0

package/request-navvy/tasks/task.d.ts

@@ -69,34 +69,109 @@ export declare class BXRestNavvyTasksTask {
             deleteFromComment: string[];
         };
     };
+    /**
+     * Результаты задачи (`tasks.task.result.*`).
+     */
     readonly result: BXRestNavvyTasksTaskResult;
+    /**
+     * Права доступа к задаче (`tasks.task.access.*`).
+     */
     readonly access: BXRestNavvyTasksTaskAccess;
+    /**
+     * Чат задачи (`tasks.task.chat.*`).
+     */
     readonly chat: BXRestNavvyTasksTaskChat;
+    /**
+     * Счётчики задач (`tasks.task.counters.*`).
+     */
     readonly counters: BXRestNavvyTasksTaskCounters;
+    /**
+     * Избранные задачи (`tasks.task.favorite.*`).
+     */
     readonly favorite: BXRestNavvyTasksTaskFavorite;
+    /**
+     * Поля задачи (`tasks.task.field.*`).
+     */
     readonly field: BXRestNavvyTasksTaskField;
+    /**
+     * Файлы задачи, REST 3.0 (`tasks.task.file.*`).
+     */
     readonly file: BXRestNavvyTasksTaskFile;
+    /**
+     * Файлы задачи (`tasks.task.files.*`).
+     */
     readonly files: BXRestNavvyTasksTaskFiles;
+    /**
+     * История задачи (`tasks.task.history.*`).
+     */
     readonly history: BXRestNavvyTasksTaskHistory;
     private readonly Navvy;
     add<CustomFields extends object = object>(param: iBXRestParamTaskAdd<CustomFields>): import("../../services/navvy").NavvySimple<iBXRestTasksTaskBaseAnswer<iBXRestTasksTaskGetHttpDefault>, iBXRestTask, iBXRestParamTaskAdd<CustomFields> | undefined>;
+    /**
+     * Принимает задачу.
+     */
     approve(param: iBXRestParamTasksTaskApprove): import("../../services/navvy").NavvySimple<iBXRestTasksTaskBaseAnswer<iBXRestTasksTaskApproveHttp>, iBXRestTasksTaskBaseAnswer<iBXRestTasksTaskApproveHttp>, iBXRestParamTasksTaskApprove | undefined>;
+    /**
+     * Переводит задачу в статус «завершена».
+     */
     complete(param: iBXRestParamTasksTaskComplete): import("../../services/navvy").NavvySimple<iBXRestTasksTaskBaseAnswer<iBXRestTasksTaskCompleteHttp>, iBXRestTasksTaskBaseAnswer<iBXRestTasksTaskCompleteHttp>, iBXRestParamTasksTaskComplete | undefined>;
+    /**
+     * Переводит задачу в статус «отложена».
+     */
     defer(param: iBXRestParamTasksTaskDefer): import("../../services/navvy").NavvySimple<iBXRestTasksTaskBaseAnswer<iBXRestTasksTaskDeferHttp>, iBXRestTasksTaskBaseAnswer<iBXRestTasksTaskDeferHttp>, iBXRestParamTasksTaskDefer | undefined>;
     update<CustomFields extends object>(task: AllKeyFree<iBXRestTasksTaskGet<iBXRestTaskFieldsName[], CustomFields>>, updateFields: (iBXRestTasksTaskFieldsCanUpdate | keyof ToUpperCaseKeys<ObjectToSnake<CustomFields>>)[]): import("../../services/navvy").NavvySimple<iBXRestTasksTaskBaseAnswer<iBXRestTasksTaskDeferHttp>, iBXRestTasksTaskBaseAnswer<iBXRestTasksTaskDeferHttp>, any>;
     get<S extends iBXRestTaskFieldsName[], CustomFields extends object = object>(param: iBXRestParamTasksTaskGet<CustomFields>): import("../../services/navvy").NavvySimple<iBXRestTasksTaskGetHttp<S, CustomFields>, iBXRestTasksTaskGet<S, CustomFields>, iBXRestParamTasksTaskGet<CustomFields> | undefined>;
     list<S extends iBXRestTaskFieldsName[], CustomFields extends object = object>(param?: iBXRestParamTasksList<CustomFields>): import("../../services/navvy").NavvyPagNavTasks<import("../../typification/rest/tasks").iBXRestHttpTasksTaskList<S, CustomFields>, import("../../typification/rest/tasks").iBXRestTasksTaskList<S, CustomFields>, iBXRestParamTasksList<CustomFields>>;
+    /**
+     * Возвращает список полей задачи.
+     */
     getFields(): import("../../services/navvy").NavvySimple<iBXRestTasksTaskGetFields, iBXRestTasksTaskGetFields, undefined>;
+    /**
+     * Проверяет доступ к задаче.
+     */
     getAccess(param: iBXRestParamTaskGetAccess): import("../../services/navvy").NavvySimple<iBXRestTaskGetAccess, Record<number, iBXRestTaskGetAccessItem>, iBXRestParamTaskGetAccess | undefined>;
+    /**
+     * Удаляет задачу.
+     */
     delete(param: iBXRestParamTasksTaskId): import("../../services/navvy").NavvySimple<iBXRestTasksObject, iBXRestTasksObject, iBXRestParamTasksTaskId | undefined>;
+    /**
+     * Отклоняет задачу.
+     */
     disapprove(param: iBXRestParamTasksTaskId): import("../../services/navvy").NavvySimple<iBXRestTasksObject, iBXRestTasksObject, iBXRestParamTasksTaskId | undefined>;
+    /**
+     * Включает режим «Без звука» для задачи.
+     */
     mute(param: iBXRestParamTasksTaskId): import("../../services/navvy").NavvySimple<iBXRestTasksObject, iBXRestTasksObject, iBXRestParamTasksTaskId | undefined>;
+    /**
+     * Останавливает выполнение задачи и переводит в статус «ждёт».
+     */
     pause(param: iBXRestParamTasksTaskId): import("../../services/navvy").NavvySimple<iBXRestTasksObject, iBXRestTasksObject, iBXRestParamTasksTaskId | undefined>;
+    /**
+     * Закрепляет задачу в списке.
+     */
     pin(param: iBXRestParamTasksTaskId): import("../../services/navvy").NavvySimple<iBXRestTasksObject, iBXRestTasksObject, iBXRestParamTasksTaskId | undefined>;
+    /**
+     * Возобновляет задачу после завершения.
+     */
     renew(param: iBXRestParamTasksTaskId): import("../../services/navvy").NavvySimple<iBXRestTasksObject, iBXRestTasksObject, iBXRestParamTasksTaskId | undefined>;
+    /**
+     * Переводит задачу в статус «выполняется».
+     */
     start(param: iBXRestParamTasksTaskId): import("../../services/navvy").NavvySimple<iBXRestTasksObject, iBXRestTasksObject, iBXRestParamTasksTaskId | undefined>;
+    /**
+     * Включает наблюдение за задачей.
+     */
     startWatch(param: iBXRestParamTasksTaskId): import("../../services/navvy").NavvySimple<iBXRestTasksObject, iBXRestTasksObject, iBXRestParamTasksTaskId | undefined>;
+    /**
+     * Отключает наблюдение за задачей.
+     */
     stopWatch(param: iBXRestParamTasksTaskId): import("../../services/navvy").NavvySimple<iBXRestTasksObject, iBXRestTasksObject, iBXRestParamTasksTaskId | undefined>;
+    /**
+     * Выключает режим «Без звука» для задачи.
+     */
     unmute(param: iBXRestParamTasksTaskId): import("../../services/navvy").NavvySimple<iBXRestTasksObject, iBXRestTasksObject, iBXRestParamTasksTaskId | undefined>;
+    /**
+     * Открепляет задачу в списке.
+     */
     unpin(param: iBXRestParamTasksTaskId): import("../../services/navvy").NavvySimple<iBXRestTasksObject, iBXRestTasksObject, iBXRestParamTasksTaskId | undefined>;
 }

package/request-navvy/tasks/template/checklist.d.ts

@@ -1,16 +1,52 @@
 import { iBXRestTasksObject, iBXRestTasksParams } from '../../../typification/rest/tasks';
 export declare class BXRestNavvyTasksTemplateChecklist {
     private readonly Navvy;
+    /**
+     * Добавляет пункт чек-листа шаблона задачи.
+     */
     add(param: iBXRestTasksParams): import("../../../services/navvy").NavvySimple<iBXRestTasksObject, iBXRestTasksObject, iBXRestTasksParams | undefined>;
+    /**
+     * Добавляет вложение из содержимого к пункту чек-листа.
+     */
     addAttachmentByContent(param: iBXRestTasksParams): import("../../../services/navvy").NavvySimple<iBXRestTasksObject, iBXRestTasksObject, iBXRestTasksParams | undefined>;
+    /**
+     * Добавляет вложения с Диска к пункту чек-листа.
+     */
     addAttachmentsFromDisk(param: iBXRestTasksParams): import("../../../services/navvy").NavvySimple<iBXRestTasksObject, iBXRestTasksObject, iBXRestTasksParams | undefined>;
+    /**
+     * Отмечает пункт чек-листа как выполненный.
+     */
     complete(param: iBXRestTasksParams): import("../../../services/navvy").NavvySimple<iBXRestTasksObject, iBXRestTasksObject, iBXRestTasksParams | undefined>;
+    /**
+     * Удаляет пункт чек-листа.
+     */
     delete(param: iBXRestTasksParams): import("../../../services/navvy").NavvySimple<iBXRestTasksObject, iBXRestTasksObject, iBXRestTasksParams | undefined>;
+    /**
+     * Возвращает пункт чек-листа по идентификатору.
+     */
     get(param: iBXRestTasksParams): import("../../../services/navvy").NavvySimple<iBXRestTasksObject, iBXRestTasksObject, iBXRestTasksParams | undefined>;
+    /**
+     * Возвращает список пунктов чек-листа.
+     */
     list(param: iBXRestTasksParams): import("../../../services/navvy").NavvySimple<iBXRestTasksObject, iBXRestTasksObject, iBXRestTasksParams | undefined>;
+    /**
+     * Перемещает пункт чек-листа после указанного.
+     */
     moveAfter(param: iBXRestTasksParams): import("../../../services/navvy").NavvySimple<iBXRestTasksObject, iBXRestTasksObject, iBXRestTasksParams | undefined>;
+    /**
+     * Перемещает пункт чек-листа перед указанным.
+     */
     moveBefore(param: iBXRestTasksParams): import("../../../services/navvy").NavvySimple<iBXRestTasksObject, iBXRestTasksObject, iBXRestTasksParams | undefined>;
+    /**
+     * Удаляет вложения пункта чек-листа.
+     */
     removeAttachments(param: iBXRestTasksParams): import("../../../services/navvy").NavvySimple<iBXRestTasksObject, iBXRestTasksObject, iBXRestTasksParams | undefined>;
+    /**
+     * Возвращает пункт чек-листа в невыполненное состояние.
+     */
     renew(param: iBXRestTasksParams): import("../../../services/navvy").NavvySimple<iBXRestTasksObject, iBXRestTasksObject, iBXRestTasksParams | undefined>;
+    /**
+     * Обновляет пункт чек-листа.
+     */
     update(param: iBXRestTasksParams): import("../../../services/navvy").NavvySimple<iBXRestTasksObject, iBXRestTasksObject, iBXRestTasksParams | undefined>;
 }

package/request-navvy/tasks/template.d.ts

@@ -2,10 +2,28 @@ import { iBXRestParamTasksTemplateFields, iBXRestParamTasksTemplateId, iBXRestPa
 import { BXRestNavvyTasksTemplateChecklist } from './template/checklist';
 export declare class BXRestNavvyTasksTemplate {
     private readonly Navvy;
+    /**
+     * Чек-листы шаблона задачи (`tasks.template.checklist.*`).
+     */
     readonly checklist: BXRestNavvyTasksTemplateChecklist;
+    /**
+     * Добавляет шаблон задачи.
+     */
     add(param: iBXRestParamTasksTemplateFields): import("../../services/navvy").NavvySimple<iBXRestTasksObject, iBXRestTasksObject, iBXRestParamTasksTemplateFields | undefined>;
+    /**
+     * Удаляет шаблон задачи.
+     */
     delete(param: iBXRestParamTasksTemplateId): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamTasksTemplateId | undefined>;
+    /**
+     * Возвращает описание полей шаблона задачи.
+     */
     fields(): import("../../services/navvy").NavvySimple<iBXRestTasksObject, iBXRestTasksObject, undefined>;
+    /**
+     * Возвращает шаблон задачи по идентификатору.
+     */
     get(param: iBXRestParamTasksTemplateId): import("../../services/navvy").NavvySimple<iBXRestTasksObject, iBXRestTasksObject, iBXRestParamTasksTemplateId | undefined>;
+    /**
+     * Изменяет шаблон задачи.
+     */
     update(param: iBXRestParamTasksTemplateUpdate): import("../../services/navvy").NavvySimple<iBXRestTasksObject, iBXRestTasksObject, iBXRestParamTasksTemplateUpdate | undefined>;
 }

package/request-navvy/tasks.d.ts

@@ -1,7 +1,16 @@
 import { BXRestNavvyTasksTask } from './tasks/task';
 import { BXRestNavvyTasksFlow, BXRestNavvyTasksTemplate } from './tasks/extended';
 export declare class BXRestNavvyTasks {
+    /**
+     * Потоки задач (`tasks.flow.*`).
+     */
     readonly flow: BXRestNavvyTasksFlow;
+    /**
+     * Задачи (`tasks.task.*`).
+     */
     readonly task: BXRestNavvyTasksTask;
+    /**
+     * Шаблоны задач (`tasks.template.*`).
+     */
     readonly template: BXRestNavvyTasksTemplate;
 }

package/request-navvy/telephony/call.d.ts

@@ -1,5 +1,8 @@
 import { iBXRestGenericParams } from '../../typification/rest/common';
 export declare class BXRestNavvyTelephonyCall {
     private readonly Navvy;
+    /**
+     * Добавляет расшифровку записи к звонку.
+     */
     attachTranscription(param: iBXRestGenericParams): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestGenericParams | undefined>;
 }

package/request-navvy/telephony/externalcall.d.ts

@@ -1,10 +1,28 @@
 import { iBXRestGenericObject, iBXRestGenericParams } from '../../typification/rest/common';
 export declare class BXRestNavvyTelephonyExternalCall {
     private readonly Navvy;
+    /**
+     * Прикрепляет запись звонка.
+     */
     attachRecord(param: iBXRestGenericParams): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestGenericParams | undefined>;
+    /**
+     * Завершает звонок.
+     */
     finish(param: iBXRestGenericParams): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestGenericParams | undefined>;
+    /**
+     * Скрывает карточку звонка у пользователя.
+     */
     hide(param: iBXRestGenericParams): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestGenericParams | undefined>;
+    /**
+     * Регистрирует начало звонка.
+     */
     register(param: iBXRestGenericParams): import("../../services/navvy").NavvySimple<iBXRestGenericObject, iBXRestGenericObject, iBXRestGenericParams | undefined>;
+    /**
+     * Ищет клиентские объекты CRM по номеру телефона.
+     */
     searchCrmEntities(param: iBXRestGenericParams): import("../../services/navvy").NavvySimple<iBXRestGenericObject[], iBXRestGenericObject[], iBXRestGenericParams | undefined>;
+    /**
+     * Открывает карточку звонка у пользователя.
+     */
     show(param: iBXRestGenericParams): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestGenericParams | undefined>;
 }

package/request-navvy/telephony/externalline.d.ts

@@ -1,8 +1,20 @@
 import { iBXRestGenericObject, iBXRestGenericParams } from '../../typification/rest/common';
 export declare class BXRestNavvyTelephonyExternalLine {
     private readonly Navvy;
+    /**
+     * Регистрирует внешнюю линию.
+     */
     add(param: iBXRestGenericParams): import("../../services/navvy").NavvySimple<iBXRestGenericObject, iBXRestGenericObject, iBXRestGenericParams | undefined>;
+    /**
+     * Удаляет внешнюю линию.
+     */
     delete(param: iBXRestGenericParams): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestGenericParams | undefined>;
+    /**
+     * Возвращает список внешних линий.
+     */
     get(param?: iBXRestGenericParams): import("../../services/navvy").NavvySimple<iBXRestGenericObject, iBXRestGenericObject, iBXRestGenericParams | undefined>;
+    /**
+     * Изменяет внешнюю линию.
+     */
     update(param: iBXRestGenericParams): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestGenericParams | undefined>;
 }

package/request-navvy/telephony/index.d.ts

@@ -2,7 +2,16 @@ import { BXRestNavvyTelephonyCall } from './call';
 import { BXRestNavvyTelephonyExternalCall } from './externalcall';
 import { BXRestNavvyTelephonyExternalLine } from './externalline';
 export declare class BXRestNavvyTelephony {
+    /**
+     * Расшифровка записи звонка (`telephony.call.*`).
+     */
     readonly call: BXRestNavvyTelephonyCall;
+    /**
+     * Звонки внешней телефонии (`telephony.externalCall.*`).
+     */
     readonly externalCall: BXRestNavvyTelephonyExternalCall;
+    /**
+     * Внешние линии телефонии (`telephony.externalLine.*`).
+     */
     readonly externalLine: BXRestNavvyTelephonyExternalLine;
 }

package/request-navvy/timeman/networkrange.d.ts

@@ -2,7 +2,16 @@ import { iBXRestParamTimemanNetworkRangeCheck, iBXRestParamTimemanNetworkRangeSe
 export declare class BXRestNavvyTimemanNetworkRange {
     private readonly Navvy;
     private readonly url;
+    /**
+     * Проверяет, входит ли IP-адрес в диапазоны сетевых адресов офисной сети.
+     */
     check(param?: iBXRestParamTimemanNetworkRangeCheck): import("../../services/navvy").NavvySimple<iBXRestTimemanObject, iBXRestTimemanObject, iBXRestParamTimemanNetworkRangeCheck | undefined>;
+    /**
+     * Возвращает диапазоны сетевых адресов офисной сети.
+     */
     get(): import("../../services/navvy").NavvySimple<iBXRestTimemanNetworkRange[], iBXRestTimemanNetworkRange[], undefined>;
+    /**
+     * Устанавливает диапазоны сетевых адресов офисной сети.
+     */
     set(param: iBXRestParamTimemanNetworkRangeSet): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamTimemanNetworkRangeSet | undefined>;
 }

package/request-navvy/timeman/record/field.d.ts

@@ -1,6 +1,12 @@
 import { iBXRestParamTimemanRecordFieldGet, iBXRestParamTimemanRecordFieldList, iBXRestTimemanItemResult, iBXRestTimemanItemsResult } from '../../../typification/rest/timeman';
 export declare class BXRestNavvyTimemanRecordField {
     private readonly Navvy;
+    /**
+     * Возвращает описание поля записи о рабочем времени.
+     */
     get(param: iBXRestParamTimemanRecordFieldGet): import("../../../services/navvy").NavvySimple<iBXRestTimemanItemResult<import("../../../typification/rest/timeman").iBXRestTimemanObject>, iBXRestTimemanItemResult<import("../../../typification/rest/timeman").iBXRestTimemanObject>, iBXRestParamTimemanRecordFieldGet | undefined>;
+    /**
+     * Возвращает список полей записи о рабочем времени.
+     */
     list(param?: iBXRestParamTimemanRecordFieldList): import("../../../services/navvy").NavvySimple<iBXRestTimemanItemsResult<import("../../../typification/rest/timeman").iBXRestTimemanObject>, iBXRestTimemanItemsResult<import("../../../typification/rest/timeman").iBXRestTimemanObject>, iBXRestParamTimemanRecordFieldList | undefined>;
 }

package/request-navvy/timeman/record.d.ts

@@ -2,6 +2,12 @@ import { iBXRestParamTimemanRecordList, iBXRestTimemanItemsResult } from '../../
 import { BXRestNavvyTimemanRecordField } from './record/field';
 export declare class BXRestNavvyTimemanRecord {
     private readonly Navvy;
+    /**
+     * Поля записи о рабочем времени (`timeman.record.field.*`).
+     */
     readonly field: BXRestNavvyTimemanRecordField;
+    /**
+     * Возвращает список записей о рабочем времени сотрудника.
+     */
     list(param: iBXRestParamTimemanRecordList): import("../../services/navvy").NavvySimple<iBXRestTimemanItemsResult<import("../../typification/rest/timeman").iBXRestTimemanObject>, iBXRestTimemanItemsResult<import("../../typification/rest/timeman").iBXRestTimemanObject>, iBXRestParamTimemanRecordList | undefined>;
 }

package/request-navvy/timeman/schedule.d.ts

@@ -1,5 +1,8 @@
 import { iBXRestParamTimemanScheduleGet, iBXRestTimemanObject } from '../../typification/rest/timeman';
 export declare class BXRestNavvyTimemanSchedule {
     private readonly Navvy;
+    /**
+     * Возвращает рабочий график по идентификатору.
+     */
     get(param?: iBXRestParamTimemanScheduleGet): import("../../services/navvy").NavvySimple<iBXRestTimemanObject, iBXRestTimemanObject, iBXRestParamTimemanScheduleGet | undefined>;
 }

package/request-navvy/timeman/timecontrol/report.d.ts

@@ -1,5 +1,8 @@
 import { iBXRestParamTimemanTimeControlReportAdd } from '../../../typification/rest/timeman';
 export declare class BXRestNavvyTimemanTimeControlReport {
     private readonly Navvy;
+    /**
+     * Отправляет отчёт о выявленном отсутствии.
+     */
     add(param: iBXRestParamTimemanTimeControlReportAdd): import("../../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamTimemanTimeControlReportAdd | undefined>;
 }

package/request-navvy/timeman/timecontrol/reports/settings.d.ts

@@ -1,5 +1,8 @@
 import { iBXRestTimemanTimeControlSettings } from '../../../../typification/rest/timeman';
 export declare class BXRestNavvyTimemanTimeControlReportsSettings {
     private readonly Navvy;
+    /**
+     * Возвращает настройки интерфейса отчётов пользователя.
+     */
     get(): import("../../../../services/navvy").NavvySimple<iBXRestTimemanTimeControlSettings, iBXRestTimemanTimeControlSettings, undefined>;
 }

package/request-navvy/timeman/timecontrol/reports/users.d.ts

@@ -1,5 +1,8 @@
 import { iBXRestParamTimemanTimeControlReportsUsersGet, iBXRestTimemanObject } from '../../../../typification/rest/timeman';
 export declare class BXRestNavvyTimemanTimeControlReportsUsers {
     private readonly Navvy;
+    /**
+     * Возвращает список пользователей указанного подразделения.
+     */
     get(param?: iBXRestParamTimemanTimeControlReportsUsersGet): import("../../../../services/navvy").NavvySimple<iBXRestTimemanObject[], iBXRestTimemanObject[], iBXRestParamTimemanTimeControlReportsUsersGet | undefined>;
 }

package/request-navvy/timeman/timecontrol/reports.d.ts

@@ -3,7 +3,16 @@ import { BXRestNavvyTimemanTimeControlReportsSettings } from './reports/settings
 import { BXRestNavvyTimemanTimeControlReportsUsers } from './reports/users';
 export declare class BXRestNavvyTimemanTimeControlReports {
     private readonly Navvy;
+    /**
+     * Настройки интерфейса отчётов контроля времени (`timeman.timecontrol.reports.settings.*`).
+     */
     readonly settings: BXRestNavvyTimemanTimeControlReportsSettings;
+    /**
+     * Список пользователей подразделения для отчётов контроля времени (`timeman.timecontrol.reports.users.*`).
+     */
     readonly users: BXRestNavvyTimemanTimeControlReportsUsers;
+    /**
+     * Возвращает отчёт о выявленных отсутствиях.
+     */
     get(param: iBXRestParamTimemanTimeControlReportsGet): import("../../../services/navvy").NavvySimple<iBXRestTimemanObject, iBXRestTimemanObject, iBXRestParamTimemanTimeControlReportsGet | undefined>;
 }

package/request-navvy/timeman/timecontrol/settings.d.ts

@@ -1,6 +1,12 @@
 import { iBXRestParamTimemanTimeControlSettingsSet, iBXRestTimemanTimeControlSettings } from '../../../typification/rest/timeman';
 export declare class BXRestNavvyTimemanTimeControlSettings {
     private readonly Navvy;
+    /**
+     * Возвращает настройки инструмента контроля времени.
+     */
     get(): import("../../../services/navvy").NavvySimple<iBXRestTimemanTimeControlSettings, iBXRestTimemanTimeControlSettings, undefined>;
+    /**
+     * Устанавливает настройки инструмента контроля времени.
+     */
     set(param: iBXRestParamTimemanTimeControlSettingsSet): import("../../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamTimemanTimeControlSettingsSet | undefined>;
 }

package/request-navvy/timeman/timecontrol.d.ts

@@ -2,7 +2,16 @@ import { BXRestNavvyTimemanTimeControlReport } from './timecontrol/report';
 import { BXRestNavvyTimemanTimeControlReports } from './timecontrol/reports';
 import { BXRestNavvyTimemanTimeControlSettings } from './timecontrol/settings';
 export declare class BXRestNavvyTimemanTimeControl {
+    /**
+     * Отчёты о выявленном отсутствии (`timeman.timecontrol.report.*`).
+     */
     readonly report: BXRestNavvyTimemanTimeControlReport;
+    /**
+     * Отчёты контроля рабочего времени (`timeman.timecontrol.reports.*`).
+     */
     readonly reports: BXRestNavvyTimemanTimeControlReports;
+    /**
+     * Настройки инструмента контроля времени (`timeman.timecontrol.settings.*`).
+     */
     readonly settings: BXRestNavvyTimemanTimeControlSettings;
 }

package/request-navvy/timeman.d.ts

@@ -5,9 +5,21 @@ import { BXRestNavvyTimemanRecord } from './timeman/record';
 import { BXRestNavvyTimemanSchedule } from './timeman/schedule';
 import { BXRestNavvyTimemanTimeControl } from './timeman/timecontrol';
 export declare class BXRestNavvyTimeMan {
+    /**
+     * Офисные сети (`timeman.networkrange.*`).
+     */
     readonly networkRange: BXRestNavvyTimemanNetworkRange;
+    /**
+     * Записи о рабочем времени (`timeman.record.*`).
+     */
     readonly record: BXRestNavvyTimemanRecord;
+    /**
+     * Рабочий график (`timeman.schedule.*`).
+     */
     readonly schedule: BXRestNavvyTimemanSchedule;
+    /**
+     * Контроль рабочего времени (`timeman.timecontrol.*`).
+     */
     readonly timeControl: BXRestNavvyTimemanTimeControl;
     protected readonly url: {
         /**
@@ -32,9 +44,24 @@ export declare class BXRestNavvyTimeMan {
         pause: string[];
     };
     protected Navvy: Navvy;
+    /**
+     * Возвращает информацию о текущем рабочем дне пользователя.
+     */
     status(param?: iBXRestParamTimeManStatus | undefined): import("../services/navvy").NavvySimple<iBXRestTimeManStatusHttp, iBXRestTimeManStatus, iBXRestParamTimeManStatus | undefined>;
+    /**
+     * Начинает новый рабочий день или возобновляет закрытый.
+     */
     open(param?: iBXRestParamTimeManOpen): import("../services/navvy").NavvySimple<iBXRestTimeManStatusHttp, iBXRestTimeManStatus, iBXRestParamTimeManOpen | undefined>;
+    /**
+     * Ставит рабочий день на паузу.
+     */
     pause(param?: iBXRestParamTimeManPause): import("../services/navvy").NavvySimple<iBXRestTimeManStatusHttp, iBXRestTimeManStatus, iBXRestParamTimeManPause | undefined>;
+    /**
+     * Закрывает рабочий день.
+     */
     close(param?: iBXRestParamTimeManClose): import("../services/navvy").NavvySimple<iBXRestTimeManStatusHttp, iBXRestTimeManStatus, iBXRestParamTimeManClose | undefined>;
+    /**
+     * Возвращает настройки рабочего времени пользователя.
+     */
     settings(param?: iBXRestParamTimeManSettings): import("../services/navvy").NavvySimple<iBXRestTimeManSettings, iBXRestTimeManSettings, iBXRestParamTimeManSettings | undefined>;
 }

package/request-navvy/user/userfield.d.ts

@@ -2,5 +2,8 @@ import { iBXRestUserUserField } from '../../typification/rest/user';
 export declare class BXRestNavvyUserUserfield {
     private url;
     private readonly Navvy;
+    /**
+     * Возвращает список пользовательских полей.
+     */
     list(): import("../../services/navvy").NavvySimple<iBXRestUserUserField[], iBXRestUserUserField[], undefined>;
 }

package/request-navvy/user.d.ts

@@ -18,6 +18,9 @@ export declare class BXRestNavvyUser {
         access: string[];
         fields: string[];
     };
+    /**
+     * Пользовательские поля профиля (`user.userfield.*`).
+     */
     readonly userField: BXRestNavvyUserUserfield;
     /** Персональные настройки текущего пользователя для приложения. */
     readonly option: BXRestNavvyUserOption;
@@ -31,7 +34,13 @@ export declare class BXRestNavvyUser {
      * правами и `false` в остальных случаях.
      */
     admin(): import("../services/navvy").NavvySimple<boolean, boolean, undefined>;
+    /**
+     * Возвращает список пользователей по фильтру.
+     */
     get(params?: iBXRestParamUserGet): import("../services/navvy").NavvyPag<iBXRestUserHttp, iBXRestUser, iBXRestParamUserGet>;
+    /**
+     * Возвращает информацию о текущем пользователе.
+     */
     current(): import("../services/navvy").NavvySimple<iBXRestUserHttp, iBXRestUser, undefined>;
     search(params: iBXRestParamUserSearch): import("../services/navvy").NavvyPag<iBXRestUserHttp, iBXRestUser, iBXRestParamUserSearch>;
     /**
@@ -41,6 +50,12 @@ export declare class BXRestNavvyUser {
      * `{ ACCESS: ['G2', 'AU'] }`, так и непосредственно массив кодов.
      */
     access(params: iBXRestParamUserAccess | string[]): import("../services/navvy").NavvySimple<boolean, boolean, iBXRestParamUserAccess | undefined>;
+    /**
+     * Возвращает список полей профиля пользователя.
+     */
     fields(): import("../services/navvy").NavvySimple<iBXRestUserHttpField, iBXRestUserHttpField, undefined>;
+    /**
+     * Дополняет параметры запроса пользователей значениями по умолчанию (ACTIVE, start).
+     */
     private setDefParam;
 }

package/request-navvy/userconsent/agreement.d.ts

@@ -1,6 +1,12 @@
 import { iBXRestGenericObject, iBXRestGenericParams } from '../../typification/rest/common';
 export declare class BXRestNavvyUserConsentAgreement {
     private readonly Navvy;
+    /**
+     * Возвращает список соглашений.
+     */
     list(param?: iBXRestGenericParams): import("../../services/navvy").NavvySimple<iBXRestGenericObject[], iBXRestGenericObject[], iBXRestGenericParams | undefined>;
+    /**
+     * Возвращает текст соглашения.
+     */
     text(param: iBXRestGenericParams): import("../../services/navvy").NavvySimple<string, string, iBXRestGenericParams | undefined>;
 }

package/request-navvy/userconsent/consent.d.ts

@@ -1,5 +1,8 @@
 import { iBXRestGenericParams } from '../../typification/rest/common';
 export declare class BXRestNavvyUserConsentConsent {
     private readonly Navvy;
+    /**
+     * Сохраняет полученное согласие пользователя.
+     */
     add(param: iBXRestGenericParams): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestGenericParams | undefined>;
 }

package/request-navvy/userconsent/index.d.ts

@@ -1,6 +1,12 @@
 import { BXRestNavvyUserConsentAgreement } from './agreement';
 import { BXRestNavvyUserConsentConsent } from './consent';
 export declare class BXRestNavvyUserConsent {
+    /**
+     * Соглашения пользователя (`userconsent.agreement.*`).
+     */
     readonly agreement: BXRestNavvyUserConsentAgreement;
+    /**
+     * Согласия пользователя (`userconsent.consent.*`).
+     */
     readonly consent: BXRestNavvyUserConsentConsent;
 }

package/request-navvy/userfieldtype.d.ts

@@ -1,8 +1,20 @@
 import { iBXRestGenericObject, iBXRestGenericParams } from '../typification/rest/common';
 export declare class BXRestNavvyUserFieldType {
     private readonly Navvy;
+    /**
+     * Регистрирует новый тип пользовательских полей.
+     */
     add(param?: iBXRestGenericParams): import("../services/navvy").NavvySimple<iBXRestGenericObject, iBXRestGenericObject, iBXRestGenericParams | undefined>;
+    /**
+     * Удаляет зарегистрированный приложением тип пользовательских полей.
+     */
     delete(param?: iBXRestGenericParams): import("../services/navvy").NavvySimple<iBXRestGenericObject, iBXRestGenericObject, iBXRestGenericParams | undefined>;
+    /**
+     * Возвращает список типов пользовательских полей, зарегистрированных приложением.
+     */
     list(param?: iBXRestGenericParams): import("../services/navvy").NavvySimple<iBXRestGenericObject, iBXRestGenericObject, iBXRestGenericParams | undefined>;
+    /**
+     * Изменяет настройки зарегистрированного приложением типа пользовательских полей.
+     */
     update(param?: iBXRestGenericParams): import("../services/navvy").NavvySimple<iBXRestGenericObject, iBXRestGenericObject, iBXRestGenericParams | undefined>;
 }

package/request-navvy/vote/attachedvote.d.ts

@@ -1,13 +1,40 @@
 import { iBXRestGenericObject, iBXRestGenericParams } from '../../typification/rest/common';
 export declare class BXRestNavvyVoteAttachedVote {
     private readonly Navvy;
+    /**
+     * Скачивает отчёт по голосованию.
+     */
     download(param: iBXRestGenericParams): import("../../services/navvy").NavvySimple<iBXRestGenericObject, iBXRestGenericObject, iBXRestGenericParams | undefined>;
+    /**
+     * Возвращает данные прикреплённого голосования.
+     */
     get(param: iBXRestGenericParams): import("../../services/navvy").NavvySimple<iBXRestGenericObject, iBXRestGenericObject, iBXRestGenericParams | undefined>;
+    /**
+     * Возвращает список проголосовавших за ответ.
+     */
     getAnswerVoted(param: iBXRestGenericParams): import("../../services/navvy").NavvySimple<iBXRestGenericObject, iBXRestGenericObject, iBXRestGenericParams | undefined>;
+    /**
+     * Возвращает несколько голосований.
+     */
     getMany(param?: iBXRestGenericParams): import("../../services/navvy").NavvySimple<iBXRestGenericObject[], iBXRestGenericObject[], iBXRestGenericParams | undefined>;
+    /**
+     * Возвращает данные голосования вместе со списком проголосовавших.
+     */
     getWithVoted(param: iBXRestGenericParams): import("../../services/navvy").NavvySimple<iBXRestGenericObject, iBXRestGenericObject, iBXRestGenericParams | undefined>;
+    /**
+     * Отзывает голос.
+     */
     recall(param: iBXRestGenericParams): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestGenericParams | undefined>;
+    /**
+     * Возобновляет голосование.
+     */
     resume(param: iBXRestGenericParams): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestGenericParams | undefined>;
+    /**
+     * Останавливает голосование.
+     */
     stop(param: iBXRestGenericParams): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestGenericParams | undefined>;
+    /**
+     * Голосует в прикреплённом голосовании.
+     */
     vote(param: iBXRestGenericParams): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestGenericParams | undefined>;
 }