bx-rest 0.21.2 → 0.21.3

package/request-navvy/entity/section.d.ts

@@ -1,8 +1,20 @@
 import { iBXRestGenericObject, iBXRestGenericParams } from '../../typification/rest/common';
 export declare class BXRestNavvyEntitySection {
     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/eventlog/field.d.ts

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

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

@@ -2,8 +2,20 @@ import { iBXRestGenericObject, iBXRestGenericParams } from '../../typification/r
 import { BXRestNavvyEventLogField } from './field';
 export declare class BXRestNavvyEventLog {
     private readonly Navvy;
+    /**
+     * Поля записи журнала событий (`main.eventlog.field.*`).
+     */
     readonly field: BXRestNavvyEventLogField;
+    /**
+     * Возвращает запись журнала событий по идентификатору.
+     */
     get(param?: iBXRestGenericParams): import("../../services/navvy").NavvySimple<iBXRestGenericObject, iBXRestGenericObject, iBXRestGenericParams | undefined>;
+    /**
+     * Возвращает список записей журнала событий по фильтру.
+     */
     list(param?: iBXRestGenericParams): import("../../services/navvy").NavvySimple<iBXRestGenericObject, iBXRestGenericObject, iBXRestGenericParams | undefined>;
+    /**
+     * Возвращает новые записи журнала событий после точки отсчёта.
+     */
     tail(param?: iBXRestGenericParams): import("../../services/navvy").NavvySimple<iBXRestGenericObject, iBXRestGenericObject, iBXRestGenericParams | undefined>;
 }

package/request-navvy/im/chat/user.d.ts

@@ -6,7 +6,13 @@ export declare class BXRestNavvyImChatUser {
         list: string[];
         delete: string[];
     };
+    /**
+     * Возвращает идентификаторы участников чата.
+     */
     list(param: iBXRestImChatUserListParam): import("../../../services/navvy").NavvySimple<number[], number[], iBXRestImChatUserListParam | undefined>;
+    /**
+     * Исключает участников из чата.
+     */
     delete(param: iBXRestImChatUserDeleteParam): import("../../../services/navvy").NavvySimple<number, number, iBXRestImChatUserDeleteParam | undefined>;
     /**
      * Приглаcить участников в чат

package/request-navvy/im/chat.d.ts

@@ -12,6 +12,9 @@ export declare class BXRestNavvyImChat {
         mute: string[];
     };
     private Navvy;
+    /**
+     * Участники чата (`im.chat.user.*`).
+     */
     readonly user: BXRestNavvyImChatUser;
     /**
      * Создать чат

package/request-navvy/im/counters.d.ts

@@ -1,5 +1,8 @@
 import { iBXRestImCounters } from '../../typification/rest/im';
 export declare class BXRestNavvyImCounters {
     private Navvy;
+    /**
+     * Возвращает счётчики сообщений и уведомлений.
+     */
     get(): import("../../services/navvy").NavvySimple<iBXRestImCounters, iBXRestImCounters, undefined>;
 }

package/request-navvy/im/department/colleagues.d.ts

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

package/request-navvy/im/department/employees.d.ts

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

package/request-navvy/im/department/managers.d.ts

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

package/request-navvy/im/department.d.ts

@@ -4,8 +4,20 @@ import { BXRestNavvyImDepartmentEmployees } from './department/employees';
 import { BXRestNavvyImDepartmentManagers } from './department/managers';
 export declare class BXRestNavvyImDepartment {
     private readonly Navvy;
+    /**
+     * Коллеги пользователя (`im.department.colleagues.*`).
+     */
     readonly colleagues: BXRestNavvyImDepartmentColleagues;
+    /**
+     * Сотрудники подразделения (`im.department.employees.*`).
+     */
     readonly employees: BXRestNavvyImDepartmentEmployees;
+    /**
+     * Руководители подразделений (`im.department.managers.*`).
+     */
     readonly managers: BXRestNavvyImDepartmentManagers;
+    /**
+     * Возвращает информацию о подразделении.
+     */
     get(param: iBXRestParamImDepartmentGet): import("../../services/navvy").NavvySimple<iBXRestImObject[], iBXRestImObject[], iBXRestParamImDepartmentGet | undefined>;
 }

package/request-navvy/im/dialog/messages.d.ts

@@ -1,6 +1,12 @@
 import { iBXRestImDialogMessagesGet, iBXRestImDialogMessagesGetHttp, iBXRestImDialogMessagesGetParam, iBXRestImObject, iBXRestParamImDialogMessagesSearch } from '../../../typification/rest/im';
 export declare class BXRestNavvyImDialogMessages {
     private Navvy;
+    /**
+     * Возвращает список последних сообщений чата.
+     */
     get(param: iBXRestImDialogMessagesGetParam): import("../../../services/navvy").NavvySimple<iBXRestImDialogMessagesGetHttp, iBXRestImDialogMessagesGet, iBXRestImDialogMessagesGetParam | undefined>;
+    /**
+     * Ищет сообщения в чате.
+     */
     search(param: iBXRestParamImDialogMessagesSearch): import("../../../services/navvy").NavvySimple<iBXRestImObject, iBXRestImObject, iBXRestParamImDialogMessagesSearch | undefined>;
 }

package/request-navvy/im/dialog/users.d.ts

@@ -1,5 +1,8 @@
 import { iBXRestImDialogUserGet, iBXRestImDialogUserGetHttp, iBXRestImDialogUserGetParam } from '../../../typification/rest/im';
 export declare class BXRestNavvyImDialogUsers {
     private Navvy;
+    /**
+     * Возвращает список участников чата.
+     */
     list(param: iBXRestImDialogUserGetParam): import("../../../services/navvy").NavvySimple<iBXRestImDialogUserGetHttp, iBXRestImDialogUserGet, iBXRestImDialogUserGetParam | undefined>;
 }

package/request-navvy/im/dialog.d.ts

@@ -3,7 +3,13 @@ import { iBXRestImDialogGet, iBXRestImDialogGetHttp, iBXRestImDialogGetParam, iB
 import { BXRestNavvyImDialogMessages } from './dialog/messages';
 export declare class BXRestNavvyImDialog {
     private Navvy;
+    /**
+     * Участники диалога (`im.dialog.users.*`).
+     */
     readonly users: BXRestNavvyImDialogUsers;
+    /**
+     * Сообщения диалога (`im.dialog.messages.*`).
+     */
     readonly messages: BXRestNavvyImDialogMessages;
     readonly read: {
         (param: import("../../typification/rest/im").iBXRestImDialogReadParam): import("../../services/navvy").NavvySimple<import("../../typification/rest/im").iBXRestImDialogRead, import("../../typification/rest/im").iBXRestImDialogRead, import("../../typification/rest/im").iBXRestImDialogReadParam | undefined>;

package/request-navvy/im/disk/file.d.ts

@@ -1,7 +1,16 @@
 import { iBXRestImObject, iBXRestParamImDiskFileCommit, iBXRestParamImDiskFileDelete, iBXRestParamImDiskFileSave } from '../../../typification/rest/im';
 export declare class BXRestNavvyImDiskFile {
     private readonly Navvy;
+    /**
+     * Добавляет файл в чат (устаревший метод).
+     */
     commit(param: iBXRestParamImDiskFileCommit): import("../../../services/navvy").NavvySimple<iBXRestImObject, iBXRestImObject, iBXRestParamImDiskFileCommit | undefined>;
+    /**
+     * Удаляет файл из папки чата.
+     */
     delete(param: iBXRestParamImDiskFileDelete): import("../../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamImDiskFileDelete | undefined>;
+    /**
+     * Сохраняет файл чата на Диск.
+     */
     save(param: iBXRestParamImDiskFileSave): import("../../../services/navvy").NavvySimple<iBXRestImObject, iBXRestImObject, iBXRestParamImDiskFileSave | undefined>;
 }

package/request-navvy/im/disk/folder.d.ts

@@ -1,5 +1,8 @@
 import { iBXRestImObject, iBXRestParamImDiskFolderGet } from '../../../typification/rest/im';
 export declare class BXRestNavvyImDiskFolder {
     private readonly Navvy;
+    /**
+     * Возвращает папку файлового хранилища чата (устаревший метод).
+     */
     get(param: iBXRestParamImDiskFolderGet): import("../../../services/navvy").NavvySimple<iBXRestImObject, iBXRestImObject, iBXRestParamImDiskFolderGet | undefined>;
 }

package/request-navvy/im/disk.d.ts

@@ -1,6 +1,12 @@
 import { BXRestNavvyImDiskFile } from './disk/file';
 import { BXRestNavvyImDiskFolder } from './disk/folder';
 export declare class BXRestNavvyImDisk {
+    /**
+     * Файлы Диска в чате (`im.disk.file.*`).
+     */
     readonly file: BXRestNavvyImDiskFile;
+    /**
+     * Папка файлового хранилища чата (`im.disk.folder.*`).
+     */
     readonly folder: BXRestNavvyImDiskFolder;
 }

package/request-navvy/im/message.d.ts

@@ -1,10 +1,28 @@
 import { iBXRestParamImMessageAdd, iBXRestParamImMessageCommand, iBXRestParamImMessageDelete, iBXRestParamImMessageLike, iBXRestParamImMessageShare, iBXRestParamImMessageUpdate } from '../../typification/rest/im';
 export declare class BXRestNavvyImMessage {
     private readonly Navvy;
+    /**
+     * Добавляет сообщение в чат.
+     */
     add(param: iBXRestParamImMessageAdd): import("../../services/navvy").NavvySimple<number, number, iBXRestParamImMessageAdd | undefined>;
+    /**
+     * Выполняет команду чат-бота.
+     */
     command(param: iBXRestParamImMessageCommand): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamImMessageCommand | undefined>;
+    /**
+     * Удаляет сообщение.
+     */
     delete(param: iBXRestParamImMessageDelete): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamImMessageDelete | undefined>;
+    /**
+     * Изменяет статус «Мне нравится» у сообщения.
+     */
     like(param: iBXRestParamImMessageLike): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamImMessageLike | undefined>;
+    /**
+     * Создаёт чат, задачу или сообщение Ленты новостей из сообщения.
+     */
     share(param: iBXRestParamImMessageShare): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamImMessageShare | undefined>;
+    /**
+     * Изменяет отправленное сообщение.
+     */
     update(param: iBXRestParamImMessageUpdate): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamImMessageUpdate | undefined>;
 }

package/request-navvy/im/notify/history.d.ts

@@ -1,5 +1,8 @@
 import { iBXRestImObject, iBXRestParamImNotifyHistorySearch } from '../../../typification/rest/im';
 export declare class BXRestNavvyImNotifyHistory {
     private readonly Navvy;
+    /**
+     * Выполняет поиск по истории уведомлений.
+     */
     search(param?: iBXRestParamImNotifyHistorySearch): import("../../../services/navvy").NavvySimple<iBXRestImObject, iBXRestImObject, iBXRestParamImNotifyHistorySearch | undefined>;
 }

package/request-navvy/im/notify/personal.d.ts

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

package/request-navvy/im/notify/read.d.ts

@@ -1,7 +1,16 @@
 import { iBXRestImObject, iBXRestParamImNotifyRead, iBXRestParamImNotifyReadList } from '../../../typification/rest/im';
 export declare class BXRestNavvyImNotifyRead {
     private readonly Navvy;
+    /**
+     * Отмечает прочитанным уведомление.
+     */
     one(param?: iBXRestParamImNotifyRead): import("../../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamImNotifyRead | undefined>;
+    /**
+     * Отмечает прочитанными все уведомления.
+     */
     all(): import("../../../services/navvy").NavvySimple<iBXRestImObject, iBXRestImObject, undefined>;
+    /**
+     * Отмечает прочитанными несколько уведомлений.
+     */
     list(param: iBXRestParamImNotifyReadList): import("../../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamImNotifyReadList | undefined>;
 }

package/request-navvy/im/notify/schema.d.ts

@@ -1,5 +1,8 @@
 import { iBXRestImObject } from '../../../typification/rest/im';
 export declare class BXRestNavvyImNotifySchema {
     private readonly Navvy;
+    /**
+     * Возвращает схему типов уведомлений.
+     */
     get(): import("../../../services/navvy").NavvySimple<iBXRestImObject[], iBXRestImObject[], undefined>;
 }

package/request-navvy/im/notify/system.d.ts

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

package/request-navvy/im/notify.d.ts

@@ -6,14 +6,44 @@ import { BXRestNavvyImNotifySchema } from './notify/schema';
 import { BXRestNavvyImNotifySystem } from './notify/system';
 export declare class BXRestNavvyImNotify {
     private readonly Navvy;
+    /**
+     * История уведомлений (`im.notify.history.*`).
+     */
     readonly history: BXRestNavvyImNotifyHistory;
+    /**
+     * Персональные уведомления (`im.notify.personal.*`).
+     */
     readonly personal: BXRestNavvyImNotifyPersonal;
+    /**
+     * Признак прочтения уведомлений (`im.notify.read.*`).
+     */
     readonly read: BXRestNavvyImNotifyRead;
+    /**
+     * Схемы типов уведомлений (`im.notify.schema.*`).
+     */
     readonly schema: BXRestNavvyImNotifySchema;
+    /**
+     * Системные уведомления (`im.notify.system.*`).
+     */
     readonly system: BXRestNavvyImNotifySystem;
+    /**
+     * Отправляет уведомление.
+     */
     send(param: iBXRestParamImNotifySend): import("../../services/navvy").NavvySimple<number, number, iBXRestParamImNotifySend | undefined>;
+    /**
+     * Отвечает на уведомление с быстрым ответом.
+     */
     answer(param: iBXRestParamImNotifyAnswer): import("../../services/navvy").NavvySimple<iBXRestImObject, iBXRestImObject, iBXRestParamImNotifyAnswer | undefined>;
+    /**
+     * Обрабатывает нажатие кнопки уведомления.
+     */
     confirm(param: iBXRestParamImNotifyConfirm): import("../../services/navvy").NavvySimple<iBXRestImObject, iBXRestImObject, iBXRestParamImNotifyConfirm | undefined>;
+    /**
+     * Удаляет уведомления.
+     */
     delete(param: iBXRestParamImNotifyDelete): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamImNotifyDelete | undefined>;
+    /**
+     * Возвращает уведомления пользователя.
+     */
     get(param?: iBXRestParamImNotifyGet): import("../../services/navvy").NavvySimple<iBXRestImObject, iBXRestImObject, iBXRestParamImNotifyGet | undefined>;
 }

package/request-navvy/im/revision.d.ts

@@ -1,5 +1,8 @@
 import { iBXRestImObject } from '../../typification/rest/im';
 export declare class BXRestNavvyImRevision {
     private readonly Navvy;
+    /**
+     * Возвращает ревизии API модуля IM.
+     */
     get(): import("../../services/navvy").NavvySimple<iBXRestImObject, iBXRestImObject, undefined>;
 }

package/request-navvy/im/search/chat.d.ts

@@ -1,5 +1,8 @@
 import { iBXRestImObject, iBXRestParamImSearchChatList } from '../../../typification/rest/im';
 export declare class BXRestNavvyImSearchChat {
     private readonly Navvy;
+    /**
+     * Ищет чаты по названию.
+     */
     list(param: iBXRestParamImSearchChatList): import("../../../services/navvy").NavvySimple<iBXRestImObject[], iBXRestImObject[], iBXRestParamImSearchChatList | undefined>;
 }

package/request-navvy/im/search/department.d.ts

@@ -1,5 +1,8 @@
 import { iBXRestImObject, iBXRestParamImSearchDepartmentList } from '../../../typification/rest/im';
 export declare class BXRestNavvyImSearchDepartment {
     private readonly Navvy;
+    /**
+     * Ищет подразделения.
+     */
     list(param: iBXRestParamImSearchDepartmentList): import("../../../services/navvy").NavvySimple<iBXRestImObject[], iBXRestImObject[], iBXRestParamImSearchDepartmentList | undefined>;
 }

package/request-navvy/im/search/last.d.ts

@@ -1,7 +1,16 @@
 import { iBXRestImObject, iBXRestParamImSearchLastDialog, iBXRestParamImSearchLastGet } from '../../../typification/rest/im';
 export declare class BXRestNavvyImSearchLast {
     private readonly Navvy;
+    /**
+     * Добавляет запрос в историю поиска.
+     */
     add(param: iBXRestParamImSearchLastDialog): import("../../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamImSearchLastDialog | undefined>;
+    /**
+     * Удаляет запрос из истории поиска.
+     */
     delete(param: iBXRestParamImSearchLastDialog): import("../../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamImSearchLastDialog | undefined>;
+    /**
+     * Возвращает историю поиска.
+     */
     get(param?: iBXRestParamImSearchLastGet): import("../../../services/navvy").NavvySimple<iBXRestImObject[], iBXRestImObject[], iBXRestParamImSearchLastGet | undefined>;
 }

package/request-navvy/im/search/user.d.ts

@@ -1,5 +1,8 @@
 import { iBXRestImObject, iBXRestParamImSearchUserList } from '../../../typification/rest/im';
 export declare class BXRestNavvyImSearchUser {
     private readonly Navvy;
+    /**
+     * Ищет пользователей.
+     */
     list(param: iBXRestParamImSearchUserList): import("../../../services/navvy").NavvySimple<iBXRestImObject[], iBXRestImObject[], iBXRestParamImSearchUserList | undefined>;
 }

package/request-navvy/im/search.d.ts

@@ -3,8 +3,20 @@ import { BXRestNavvyImSearchDepartment } from './search/department';
 import { BXRestNavvyImSearchLast } from './search/last';
 import { BXRestNavvyImSearchUser } from './search/user';
 export declare class BXRestNavvyImSearch {
+    /**
+     * Поиск чатов (`im.search.chat.*`).
+     */
     readonly chat: BXRestNavvyImSearchChat;
+    /**
+     * Поиск подразделений (`im.search.department.*`).
+     */
     readonly department: BXRestNavvyImSearchDepartment;
+    /**
+     * История поиска (`im.search.last.*`).
+     */
     readonly last: BXRestNavvyImSearchLast;
+    /**
+     * Поиск пользователей (`im.search.user.*`).
+     */
     readonly user: BXRestNavvyImSearchUser;
 }

package/request-navvy/im/user/status/idle.d.ts

@@ -1,6 +1,12 @@
 import { iBXRestImUserStatusIdleStartParam } from '../../../../typification/rest/im';
 export declare class BXRestNavvyImUserStatusIdle {
     private Navvy;
+    /**
+     * Устанавливает автоматический статус «Отошёл».
+     */
     start(param: iBXRestImUserStatusIdleStartParam): import("../../../../services/navvy").NavvySimple<boolean, boolean, iBXRestImUserStatusIdleStartParam | undefined>;
+    /**
+     * Отключает автоматический статус «Отошёл».
+     */
     end(): import("../../../../services/navvy").NavvySimple<boolean, boolean, undefined>;
 }

package/request-navvy/im/user/status.d.ts

@@ -2,6 +2,9 @@ import { iBXRestImUserStatusGet, iBXRestImUserStatusSet } from '../../../typific
 import { BXRestNavvyImUserStatusIdle } from './status/idle';
 export declare class BXRestNavvyImUserStatus {
     private Navvy;
+    /**
+     * Автоматический статус «Отошёл» (`im.user.status.idle.*`).
+     */
     readonly idle: BXRestNavvyImUserStatusIdle;
     /**
      * Получить информацию об установленном статусе пользователя

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

@@ -3,7 +3,13 @@ import { BXRestNavvyImUserStatus } from './user/status';
 import { BXRestNavvyImUserList } from './user/list';
 export declare class BXRestNavvyImUser {
     private Navvy;
+    /**
+     * Данные о списке пользователей (`im.user.list.*`).
+     */
     readonly list: BXRestNavvyImUserList;
+    /**
+     * Статус пользователя в чате (`im.user.status.*`).
+     */
     readonly status: BXRestNavvyImUserStatus;
     /**
      * Получить данные о пользователе

package/request-navvy/im/v2/chat/bot.d.ts

@@ -1,5 +1,8 @@
 import { iBXRestGenericObject, iBXRestGenericParams } from '../../../../typification/rest/common';
 export declare class BXRestNavvyImV2ChatBot {
     private readonly Navvy;
+    /**
+     * Отправляет боту контекст сообщений чата.
+     */
     sendContext(param: iBXRestGenericParams): import("../../../../services/navvy").NavvySimple<iBXRestGenericObject, iBXRestGenericObject, iBXRestGenericParams | undefined>;
 }

package/request-navvy/im/v2/chat.d.ts

@@ -1,4 +1,7 @@
 import { BXRestNavvyImV2ChatBot } from './chat/bot';
 export declare class BXRestNavvyImV2Chat {
+    /**
+     * Контекст бота в чате (`im.v2.Chat.Bot.*`).
+     */
     readonly bot: BXRestNavvyImV2ChatBot;
 }

package/request-navvy/im/v2/event.d.ts

@@ -1,7 +1,16 @@
 import { iBXRestGenericObject, iBXRestGenericParams } from '../../../typification/rest/common';
 export declare class BXRestNavvyImV2Event {
     private readonly Navvy;
+    /**
+     * Возвращает накопленные события в режиме polling.
+     */
     get(param?: iBXRestGenericParams): import("../../../services/navvy").NavvySimple<iBXRestGenericObject, iBXRestGenericObject, iBXRestGenericParams | undefined>;
+    /**
+     * Подписывает текущего пользователя на запись событий.
+     */
     subscribe(param?: iBXRestGenericParams): import("../../../services/navvy").NavvySimple<iBXRestGenericObject, iBXRestGenericObject, iBXRestGenericParams | undefined>;
+    /**
+     * Отписывает текущего пользователя от записи событий.
+     */
     unsubscribe(param?: iBXRestGenericParams): import("../../../services/navvy").NavvySimple<iBXRestGenericObject, iBXRestGenericObject, iBXRestGenericParams | undefined>;
 }

package/request-navvy/im/v2/file.d.ts

@@ -1,6 +1,12 @@
 import { iBXRestGenericObject, iBXRestGenericParams } from '../../../typification/rest/common';
 export declare class BXRestNavvyImV2File {
     private readonly Navvy;
+    /**
+     * Возвращает ссылку для скачивания файла.
+     */
     download(param: iBXRestGenericParams): import("../../../services/navvy").NavvySimple<iBXRestGenericObject, iBXRestGenericObject, iBXRestGenericParams | undefined>;
+    /**
+     * Загружает файл в чат.
+     */
     upload(param: iBXRestGenericParams): import("../../../services/navvy").NavvySimple<iBXRestGenericObject, iBXRestGenericObject, iBXRestGenericParams | undefined>;
 }

package/request-navvy/im/v2/index.d.ts

@@ -2,7 +2,16 @@ import { BXRestNavvyImV2Chat } from './chat';
 import { BXRestNavvyImV2Event } from './event';
 import { BXRestNavvyImV2File } from './file';
 export declare class BXRestNavvyImV2 {
+    /**
+     * Чаты модуля IM v2 (`im.v2.Chat.*`).
+     */
     readonly chat: BXRestNavvyImV2Chat;
+    /**
+     * События модуля IM v2 (`im.v2.Event.*`).
+     */
     readonly event: BXRestNavvyImV2Event;
+    /**
+     * Файлы модуля IM v2 (`im.v2.File.*`).
+     */
     readonly file: BXRestNavvyImV2File;
 }

package/request-navvy/im.d.ts

@@ -11,16 +11,52 @@ import { BXRestNavvyImSearch } from './im/search';
 import { BXRestNavvyImUser } from './im/user';
 import { BXRestNavvyImV2 } from './im/v2';
 export declare class BXRestNavvyIm {
+    /**
+     * Методы модуля IM версии 2: события, файлы, чаты (`im.v2.*`).
+     */
     readonly v2: BXRestNavvyImV2;
+    /**
+     * Чаты (`im.chat.*`).
+     */
     readonly chat: BXRestNavvyImChat;
+    /**
+     * Счётчики сообщений и уведомлений (`im.counters.*`).
+     */
     readonly counters: BXRestNavvyImCounters;
+    /**
+     * Диалоги чата (`im.dialog.*`).
+     */
     readonly dialog: BXRestNavvyImDialog;
+    /**
+     * Подразделения (`im.department.*`).
+     */
     readonly department: BXRestNavvyImDepartment;
+    /**
+     * Файлы Диска в чатах (`im.disk.*`).
+     */
     readonly disk: BXRestNavvyImDisk;
+    /**
+     * Сообщения чата (`im.message.*`).
+     */
     readonly message: BXRestNavvyImMessage;
+    /**
+     * Уведомления (`im.notify.*`).
+     */
     readonly notify: BXRestNavvyImNotify;
+    /**
+     * Список последних чатов (`im.recent.*`).
+     */
     readonly recent: BXRestNavvyImRecent;
+    /**
+     * Ревизии API модуля IM (`im.revision.*`).
+     */
     readonly revision: BXRestNavvyImRevision;
+    /**
+     * Поиск в чатах (`im.search.*`).
+     */
     readonly search: BXRestNavvyImSearch;
+    /**
+     * Пользователи чата (`im.user.*`).
+     */
     readonly user: BXRestNavvyImUser;
 }

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

@@ -1,4 +1,7 @@
 import { BXRestNavvyImBotV2 } from './v2';
 export declare class BXRestNavvyImBot {
+    /**
+     * Бот-платформа 2.0 (`imbot.v2.*`).
+     */
     readonly v2: BXRestNavvyImBotV2;
 }