bx-rest 0.21.2 → 0.22.0

package/request-navvy/crm/type.d.ts

@@ -1,11 +1,32 @@
 import { iBXRestCrmObject, iBXRestParamCrmEntityType, iBXRestParamCrmTypeAdd, iBXRestParamCrmTypeId, iBXRestParamCrmTypeList, iBXRestParamCrmTypeUpdate } from '../../typification/rest/crm';
 export declare class BXRestNavvyCrmType {
     private readonly Navvy;
+    /**
+     * Создаёт новый смарт-процесс.
+     */
     add(param: iBXRestParamCrmTypeAdd): import("../../services/navvy").NavvySimple<iBXRestCrmObject, iBXRestCrmObject, iBXRestParamCrmTypeAdd | undefined>;
+    /**
+     * Удаляет смарт-процесс.
+     */
     delete(param: iBXRestParamCrmTypeId): import("../../services/navvy").NavvySimple<null, null, iBXRestParamCrmTypeId | undefined>;
+    /**
+     * Возвращает поля смарт-процесса.
+     */
     fields(): import("../../services/navvy").NavvySimple<iBXRestCrmObject, iBXRestCrmObject, undefined>;
+    /**
+     * Возвращает смарт-процесс по идентификатору.
+     */
     get(param: iBXRestParamCrmTypeId): import("../../services/navvy").NavvySimple<iBXRestCrmObject, iBXRestCrmObject, iBXRestParamCrmTypeId | undefined>;
+    /**
+     * Возвращает смарт-процесс по entityTypeId.
+     */
     getByEntityTypeId(param: iBXRestParamCrmEntityType): import("../../services/navvy").NavvySimple<iBXRestCrmObject, iBXRestCrmObject, iBXRestParamCrmEntityType | undefined>;
+    /**
+     * Возвращает список смарт-процессов.
+     */
     list(param?: iBXRestParamCrmTypeList): import("../../services/navvy").NavvyPagNavResultKey<iBXRestCrmObject, iBXRestCrmObject, iBXRestParamCrmTypeList, "types">;
+    /**
+     * Обновляет смарт-процесс.
+     */
     update(param: iBXRestParamCrmTypeUpdate): import("../../services/navvy").NavvySimple<iBXRestCrmObject, iBXRestCrmObject, iBXRestParamCrmTypeUpdate | undefined>;
 }

package/request-navvy/crm/userfield/enumeration.d.ts

@@ -1,5 +1,8 @@
 import { iBXRestCrmObject } from '../../../typification/rest/crm';
 export declare class BXRestNavvyCrmUserFieldEnumeration {
     private readonly Navvy;
+    /**
+     * Возвращает описание полей для пользовательского поля типа enumeration.
+     */
     fields(): import("../../../services/navvy").NavvySimple<iBXRestCrmObject, iBXRestCrmObject, undefined>;
 }

package/request-navvy/crm/userfield/settings.d.ts

@@ -1,5 +1,8 @@
 import { iBXRestCrmObject } from '../../../typification/rest/crm';
 export declare class BXRestNavvyCrmUserFieldSettings {
     private readonly Navvy;
+    /**
+     * Возвращает описание полей настроек для указанного типа пользовательского поля.
+     */
     fields(): import("../../../services/navvy").NavvySimple<iBXRestCrmObject, iBXRestCrmObject, undefined>;
 }

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

@@ -3,8 +3,20 @@ import { BXRestNavvyCrmUserFieldEnumeration } from './userfield/enumeration';
 import { BXRestNavvyCrmUserFieldSettings } from './userfield/settings';
 export declare class BXRestNavvyCrmUserField {
     private readonly Navvy;
+    /**
+     * Поля пользовательского поля типа enumeration (`crm.userfield.enumeration.*`).
+     */
     readonly enumeration: BXRestNavvyCrmUserFieldEnumeration;
+    /**
+     * Настройки пользовательских полей (`crm.userfield.settings.*`).
+     */
     readonly settings: BXRestNavvyCrmUserFieldSettings;
+    /**
+     * Возвращает описание характеристик пользовательских полей.
+     */
     fields(): import("../../services/navvy").NavvySimple<iBXRestCrmObject, iBXRestCrmObject, undefined>;
+    /**
+     * Возвращает список типов пользовательских полей.
+     */
     types(): import("../../services/navvy").NavvySimple<iBXRestCrmObject[], iBXRestCrmObject[], undefined>;
 }

package/request-navvy/crm.d.ts

@@ -26,14 +26,41 @@ import { BXRestNavvyCrmOrderEntity } from './crm/orderentity';
 import { BXRestNavvyCrmStageHistory } from './crm/stagehistory';
 import { BXRestNavvyCrmTracking } from './crm/tracking';
 export declare class BXRestNavvyCrm {
+    /**
+     * Дела CRM: звонки, письма, встречи и настраиваемые типы (`crm.activity.*`).
+     */
     readonly activity: BXRestNavvyCrmActivity;
+    /**
+     * Воронки CRM (`crm.category.*`).
+     */
     readonly category: BXRestNavvyCrmCategory;
+    /**
+     * Элементы смарт-процессов и универсальные объекты CRM (`crm.item.*`).
+     */
     readonly item: BXRestNavvyCrmItem;
+    /**
+     * Настройки CRM (`crm.settings.*`).
+     */
     readonly settings: BXRestNavvyCrmSettings;
+    /**
+     * Типы смарт-процессов (`crm.type.*`).
+     */
     readonly type: BXRestNavvyCrmType;
+    /**
+     * Пользовательские поля CRM (`crm.userfield.*`).
+     */
     readonly userField: BXRestNavvyCrmUserField;
+    /**
+     * Привязки заказов интернет-магазина к объектам CRM (`crm.orderentity.*`).
+     */
     readonly orderEntity: BXRestNavvyCrmOrderEntity;
+    /**
+     * История движения по стадиям (`crm.stagehistory.*`).
+     */
     readonly stageHistory: BXRestNavvyCrmStageHistory;
+    /**
+     * Сквозная аналитика (`crm.tracking.*`).
+     */
     readonly tracking: BXRestNavvyCrmTracking;
     /** Таймлайн CRM: комментарии, заметки, связи и лог-записи (`crm.timeline.*`). */
     readonly timeline: BXRestNavvyCrmTimeline;
@@ -61,9 +88,21 @@ export declare class BXRestNavvyCrm {
     readonly enum: BXRestNavvyCrmEnum;
     /** Описание множественных полей CRM (`crm.multifield.*`). */
     readonly multifield: BXRestNavvyCrmMultifield;
+    /**
+     * Лиды (`crm.lead.*`).
+     */
     readonly lead: BXRestNavvyCrmLead;
+    /**
+     * Сделки (`crm.deal.*`).
+     */
     readonly deal: BXRestNavvyCrmDeal;
+    /**
+     * Контакты (`crm.contact.*`).
+     */
     readonly contact: BXRestNavvyCrmContact;
+    /**
+     * Компании (`crm.company.*`).
+     */
     readonly company: BXRestNavvyCrmCompany;
     /** Коммерческие предложения и связанные с ними товарные и пользовательские поля. */
     readonly quote: BXRestNavvyCrmQuote;

package/request-navvy/department.d.ts

@@ -11,8 +11,20 @@ export declare class BXRestNavvyDepartment {
     protected Navvy: Navvy;
     /** Returns names and descriptions of the available department fields. */
     fields(): import("../services/navvy").NavvySimple<iBXRestDepartmentFields, iBXRestDepartmentFields, undefined>;
+    /**
+     * Возвращает список подразделений.
+     */
     get(param?: iBXRestParamDepartmentGet): import("../services/navvy").NavvyPag<import("../typification/rest/department").iBXRestDepartmentHttp, import("../typification/rest/department").iBXRestDepartment, iBXRestParamDepartmentGet>;
+    /**
+     * Создаёт подразделение.
+     */
     add(param: iBXRestParamDepartmentAdd): import("../services/navvy").NavvySimple<number, number, iBXRestParamDepartmentAdd | undefined>;
+    /**
+     * Удаляет подразделение.
+     */
     del(id: number): import("../services/navvy").NavvySimple<boolean, boolean, iBXRestParamDepartmentDel | undefined>;
+    /**
+     * Изменяет подразделение.
+     */
     update(param: iBXRestDepartmentUpdate): import("../services/navvy").NavvySimple<boolean, boolean, iBXRestDepartmentUpdate | undefined>;
 }

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

@@ -1,5 +1,8 @@
 import { iBXRestParamRestDiskAttachedObject } from '../../typification/rest/disk';
 export declare class BXRestNavvyDiskAttachedObject {
     private Navvy;
+    /**
+     * Возвращает информацию о прикреплённом файле.
+     */
     get(param: iBXRestParamRestDiskAttachedObject): import("../../services/navvy").NavvySimple<import("../../typification/rest/disk").iBXRestDiskAttachedObjectHttp, import("../../typification/rest/disk").iBXRestDiskAttachedObject, iBXRestParamRestDiskAttachedObject | undefined>;
 }

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

@@ -2,17 +2,56 @@ import { iBXRestDiskFileHttp, iBXRestDiskVersion, iBXRestParamDiskFileGet, iBXRe
 export declare class BXRestNavvyDiskFile {
     private readonly Navvy;
     private readonly url;
+    /**
+     * Возвращает файл по идентификатору.
+     */
     get(param: iBXRestParamDiskFileGet): import("../../services/navvy").NavvySimple<iBXRestDiskFileHttp, import("../../typification/rest/disk").iBXRestDiskFile, import("../../typification/rest/disk").iBXRestParamDiskFile | undefined>;
+    /**
+     * Возвращает описание полей файла.
+     */
     getFields(): import("../../services/navvy").NavvySimple<Record<string, unknown>, Record<string, unknown>, undefined>;
+    /**
+     * Переименовывает файл.
+     */
     rename(param: iBXRestParamDiskFileRename): import("../../services/navvy").NavvySimple<iBXRestDiskFileHttp, iBXRestDiskFileHttp, iBXRestParamDiskFileRename | undefined>;
+    /**
+     * Копирует файл в указанную папку.
+     */
     copyTo(param: iBXRestParamDiskFileTarget): import("../../services/navvy").NavvySimple<iBXRestDiskFileHttp, iBXRestDiskFileHttp, iBXRestParamDiskFileTarget | undefined>;
+    /**
+     * Перемещает файл в указанную папку.
+     */
     moveTo(param: iBXRestParamDiskFileTarget): import("../../services/navvy").NavvySimple<iBXRestDiskFileHttp, iBXRestDiskFileHttp, iBXRestParamDiskFileTarget | undefined>;
+    /**
+     * Уничтожает файл навсегда.
+     */
     delete(param: iBXRestParamDiskFileGet): import("../../services/navvy").NavvySimple<boolean, boolean, import("../../typification/rest/disk").iBXRestParamDiskFile | undefined>;
+    /**
+     * Перемещает файл в корзину.
+     */
     markDeleted(param: iBXRestParamDiskFileMarkDeleted): import("../../services/navvy").NavvySimple<iBXRestDiskFileHttp, import("../../typification/rest/disk").iBXRestDiskFile, import("../../typification/rest/disk").iBXRestParamDiskFile | undefined>;
+    /**
+     * Восстанавливает файл из корзины.
+     */
     restore(param: iBXRestParamDiskFileGet): import("../../services/navvy").NavvySimple<iBXRestDiskFileHttp, iBXRestDiskFileHttp, import("../../typification/rest/disk").iBXRestParamDiskFile | undefined>;
+    /**
+     * Загружает новую версию файла.
+     */
     uploadVersion(param: iBXRestParamDiskFileUploadVersion): import("../../services/navvy").NavvySimple<iBXRestDiskFileHttp, iBXRestDiskFileHttp, iBXRestParamDiskFileUploadVersion | undefined>;
+    /**
+     * Возвращает список версий файла.
+     */
     getVersions(param: iBXRestParamDiskFileGetVersions): import("../../services/navvy").NavvyPag<iBXRestDiskVersion, iBXRestDiskVersion, iBXRestParamDiskFileGetVersions>;
+    /**
+     * Восстанавливает файл из указанной версии.
+     */
     restoreFromVersion(param: iBXRestParamDiskFileRestoreFromVersion): import("../../services/navvy").NavvySimple<iBXRestDiskFileHttp, iBXRestDiskFileHttp, iBXRestParamDiskFileRestoreFromVersion | undefined>;
+    /**
+     * Возвращает публичную ссылку на файл.
+     */
     getExternalLink(param: iBXRestParamDiskFileGet): import("../../services/navvy").NavvySimple<string, string, import("../../typification/rest/disk").iBXRestParamDiskFile | undefined>;
+    /**
+     * Находит файлы и папки по текстовому запросу.
+     */
     search(param: iBXRestParamDiskFileSearch): import("../../services/navvy").NavvyPag<import("../../typification/rest/disk").iBXRestFolderOrFileHttp, import("../../typification/rest/disk").iBXRestFolderOrFileHttp, iBXRestParamDiskFileSearch>;
 }

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

@@ -75,6 +75,9 @@ export declare class BXRestNavvyDiskFolder {
      * Возвращает описание полей папки
      */
     getFields(): import("../../services/navvy").NavvySimple<iBXRestDiskFolderGetFieldsHttp, iBXRestDiskFolderGetFieldsHttp, undefined>;
+    /**
+     * Назначает права доступа на папку.
+     */
     shareToUser(param: iBXRestParamDiskFolderShareToUser): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestParamDiskFolderShareToUser | undefined>;
     /**
      * Загружает новый файл в указанную папку

package/request-navvy/disk/operation/storage.d.ts

@@ -7,13 +7,25 @@ import { iBXRestAnswer } from '../../../typification/rest/base';
  */
 export declare class BXRestNavvyOperationDiskStorage {
     private readonly BXRestDiskStorage;
+    /**
+     * Возвращает (с кэшированием в сессии) общее хранилище приложения.
+     */
     getForApp(): import("rxjs").Observable<iBXRestAnswer<iBXRestFolderInfo> | undefined>;
+    /**
+     * Возвращает список файлов и папок в хранилище приложения.
+     */
     getChildren(param: iBXRestParamGetchildren): import("rxjs").Observable<iBXRestAnswer<(import("../../../typification/rest/disk").iBXRestFolderHttp | import("../../../typification/rest/disk").iBXRestDiskFileHttp)[]> | undefined>;
+    /**
+     * Создаёт папку в хранилище приложения.
+     */
     addFolder(param: {
         id: number;
         data: {
             NAME: string;
         };
     }): import("rxjs").Observable<iBXRestAnswer<import("../../../typification/rest/disk").iBXRestFolderHttp> | undefined>;
+    /**
+     * Загружает файл в хранилище приложения.
+     */
     uploadFile(param: iBXRestParamUploadFile): import("rxjs").Observable<iBXRestAnswer<import("../../../typification/rest/disk").iBXRestDiskFile> | undefined>;
 }

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

@@ -1,14 +1,29 @@
 import { BXRestNavvyDiskFolder } from './folder';
 import { BXRestNavvyDiskFile } from './file';
 export declare class BXRestNavvyDiskOperation {
+    /**
+     * Папки на Диске (`disk.folder.*`).
+     */
     readonly folder: BXRestNavvyDiskFolder;
+    /**
+     * Файлы на Диске (`disk.file.*`).
+     */
     readonly disk: BXRestNavvyDiskFile;
     private readonly storage;
+    /**
+     * Загружает файл (в base64) в общее хранилище приложения.
+     */
     loadFileInAppFolder(file: {
         name: string;
         val: string;
     }): import("rxjs").Observable<import("../../typification/rest/disk").iBXRestDiskFile | undefined>;
+    /**
+     * Возвращает содержимое корневой папки приложения, создавая её при отсутствии.
+     */
     getOfCreateRootContentFolderApp(folderName: string): import("rxjs").Observable<import("../../typification/rest/disk").iBXRestDiskFileAndFolderMap | undefined>;
+    /**
+     * Возвращает список папок и файлов в общем хранилище приложения.
+     */
     getRootFoldersApp(): import("rxjs").Observable<import("../../typification/rest/disk").iBXRestDiskFileAndFolderMap | undefined>;
     /**
      * Получать или создать папку, если её нет, с определенным именем для приложения

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

@@ -2,5 +2,8 @@ import { iBXRestDiskAccessTask } from '../../typification/rest/disk';
 export declare class BXRestNavvyDiskRights {
     private readonly Navvy;
     private readonly url;
+    /**
+     * Возвращает список уровней доступа для назначения прав.
+     */
     getTasks(): import("../../services/navvy").NavvySimple<iBXRestDiskAccessTask[], iBXRestDiskAccessTask[], undefined>;
 }

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

@@ -14,8 +14,17 @@ export declare class BXRestNavvyDiskStorage {
     };
     operation: BXRestNavvyOperationDiskStorage;
     private Navvy;
+    /**
+     * Возвращает описание хранилища приложения.
+     */
     getForApp(): import("../../services/navvy").NavvySimple<iBXRestFolderInfo, iBXRestFolderInfo, undefined>;
+    /**
+     * Возвращает список файлов и папок в корне хранилища.
+     */
     getChildren(param: iBXRestParamGetchildren): import("../../services/navvy").NavvySimple<(iBXRestFolderHttp | iBXRestDiskFileHttp)[], iBXRestDiskFileAndFolderMap, iBXRestParamGetchildren | undefined>;
+    /**
+     * Создаёт папку в корне хранилища.
+     */
     addFolder(param: {
         id: number;
         data: {
@@ -27,5 +36,8 @@ export declare class BXRestNavvyDiskStorage {
             NAME: string;
         };
     } | undefined>;
+    /**
+     * Загружает новый файл в корень хранилища.
+     */
     uploadFile(param: iBXRestParamUploadFile): import("../../services/navvy").NavvySimple<iBXRestDiskFileHttp, iBXRestDiskFile, iBXRestParamUploadFile | undefined>;
 }

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

@@ -2,5 +2,8 @@ import { iBXRestDiskVersion, iBXRestParamDiskVersionGet } from '../../typificati
 export declare class BXRestNavvyDiskVersion {
     private readonly Navvy;
     private readonly url;
+    /**
+     * Возвращает версию файла по идентификатору.
+     */
     get(param: iBXRestParamDiskVersionGet): import("../../services/navvy").NavvySimple<iBXRestDiskVersion, iBXRestDiskVersion, iBXRestParamDiskVersionGet | undefined>;
 }

package/request-navvy/disk.d.ts

@@ -5,10 +5,28 @@ import { BXRestNavvyDiskAttachedObject } from './disk/attachedObject';
 import { BXRestNavvyDiskRights } from './disk/rights';
 import { BXRestNavvyDiskVersion } from './disk/version';
 export declare class BXRestNavvyDisk {
+    /**
+     * Вспомогательные комплексные операции с Диском — обёртки над `disk.folder.*`, `disk.file.*` и `disk.storage.*`.
+     */
     readonly operation: BXRestNavvyDiskOperation;
+    /**
+     * Файлы на Диске (`disk.file.*`).
+     */
     readonly file: BXRestNavvyDiskFile;
+    /**
+     * Папки на Диске (`disk.folder.*`).
+     */
     readonly folder: BXRestNavvyDiskFolder;
+    /**
+     * Прикреплённые к записям файлы (`disk.attachedObject.*`).
+     */
     readonly attachedObject: BXRestNavvyDiskAttachedObject;
+    /**
+     * Права доступа на Диске (`disk.rights.*`).
+     */
     readonly rights: BXRestNavvyDiskRights;
+    /**
+     * Версии файлов на Диске (`disk.version.*`).
+     */
     readonly version: BXRestNavvyDiskVersion;
 }

package/request-navvy/documentgenerator/document.d.ts

@@ -1,11 +1,32 @@
 import { iBXRestGenericObject, iBXRestGenericParams } from '../../typification/rest/common';
 export declare class BXRestNavvyDocumentGeneratorDocument {
     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>;
+    /**
+     * Включает или выключает публичную ссылку на документ.
+     */
     enablePublicUrl(param: iBXRestGenericParams): import("../../services/navvy").NavvySimple<iBXRestGenericObject, iBXRestGenericObject, iBXRestGenericParams | undefined>;
+    /**
+     * Возвращает документ по идентификатору.
+     */
     get(param: iBXRestGenericParams): import("../../services/navvy").NavvySimple<iBXRestGenericObject, iBXRestGenericObject, iBXRestGenericParams | undefined>;
+    /**
+     * Возвращает список полей документа.
+     */
     getFields(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/documentgenerator/index.d.ts

@@ -4,9 +4,24 @@ import { BXRestNavvyDocumentGeneratorRegion } from './region';
 import { BXRestNavvyDocumentGeneratorRole } from './role';
 import { BXRestNavvyDocumentGeneratorTemplate } from './template';
 export declare class BXRestNavvyDocumentGenerator {
+    /**
+     * Документы генератора документов (`documentgenerator.document.*`).
+     */
     readonly document: BXRestNavvyDocumentGeneratorDocument;
+    /**
+     * Нумераторы генератора документов (`documentgenerator.numerator.*`).
+     */
     readonly numerator: BXRestNavvyDocumentGeneratorNumerator;
+    /**
+     * Регионы генератора документов (`documentgenerator.region.*`).
+     */
     readonly region: BXRestNavvyDocumentGeneratorRegion;
+    /**
+     * Роли и права генератора документов (`documentgenerator.role.*`).
+     */
     readonly role: BXRestNavvyDocumentGeneratorRole;
+    /**
+     * Шаблоны генератора документов (`documentgenerator.template.*`).
+     */
     readonly template: BXRestNavvyDocumentGeneratorTemplate;
 }

package/request-navvy/documentgenerator/numerator.d.ts

@@ -1,9 +1,24 @@
 import { iBXRestGenericObject, iBXRestGenericParams } from '../../typification/rest/common';
 export declare class BXRestNavvyDocumentGeneratorNumerator {
     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>;
+    /**
+     * Возвращает нумератор по идентификатору.
+     */
     get(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/documentgenerator/region.d.ts

@@ -1,9 +1,24 @@
 import { iBXRestGenericObject, iBXRestGenericParams } from '../../typification/rest/common';
 export declare class BXRestNavvyDocumentGeneratorRegion {
     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>;
+    /**
+     * Возвращает данные региона по идентификатору или коду.
+     */
     get(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/documentgenerator/role.d.ts

@@ -1,10 +1,28 @@
 import { iBXRestGenericObject, iBXRestGenericParams } from '../../typification/rest/common';
 export declare class BXRestNavvyDocumentGeneratorRole {
     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>;
+    /**
+     * Полностью перезаписывает привязки роли к кодам доступа.
+     */
     fillAccesses(param: iBXRestGenericParams): import("../../services/navvy").NavvySimple<iBXRestGenericObject, iBXRestGenericObject, iBXRestGenericParams | undefined>;
+    /**
+     * Возвращает роль по идентификатору вместе с правами.
+     */
     get(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/documentgenerator/template.d.ts

@@ -1,10 +1,28 @@
 import { iBXRestGenericObject, iBXRestGenericParams } from '../../typification/rest/common';
 export declare class BXRestNavvyDocumentGeneratorTemplate {
     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>;
+    /**
+     * Возвращает шаблон документа по идентификатору.
+     */
     get(param: iBXRestGenericParams): import("../../services/navvy").NavvySimple<iBXRestGenericObject, iBXRestGenericObject, iBXRestGenericParams | undefined>;
+    /**
+     * Возвращает карту полей шаблона.
+     */
     getFields(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/entity/index.d.ts

@@ -3,11 +3,32 @@ import { BXRestNavvyEntityItem } from './item';
 import { BXRestNavvyEntitySection } from './section';
 export declare class BXRestNavvyEntity {
     private readonly Navvy;
+    /**
+     * Элементы хранилища данных (`entity.item.*`).
+     */
     readonly item: BXRestNavvyEntityItem;
+    /**
+     * Разделы хранилища данных (`entity.section.*`).
+     */
     readonly section: BXRestNavvyEntitySection;
+    /**
+     * Создаёт хранилище данных.
+     */
     add(param: iBXRestGenericParams): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestGenericParams | undefined>;
+    /**
+     * Удаляет хранилище.
+     */
     delete(param: iBXRestGenericParams): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestGenericParams | undefined>;
+    /**
+     * Возвращает параметры хранилища или список всех хранилищ приложения.
+     */
     get(param?: iBXRestGenericParams): import("../../services/navvy").NavvySimple<iBXRestGenericObject[], iBXRestGenericObject[], iBXRestGenericParams | undefined>;
+    /**
+     * Возвращает или изменяет права доступа к хранилищу.
+     */
     rights(param: iBXRestGenericParams): import("../../services/navvy").NavvySimple<iBXRestGenericObject, iBXRestGenericObject, iBXRestGenericParams | undefined>;
+    /**
+     * Изменяет параметры хранилища данных.
+     */
     update(param: iBXRestGenericParams): import("../../services/navvy").NavvySimple<boolean, boolean, iBXRestGenericParams | undefined>;
 }

package/request-navvy/entity/item/property.d.ts

@@ -1,8 +1,20 @@
 import { iBXRestGenericObject, iBXRestGenericParams } from '../../../typification/rest/common';
 export declare class BXRestNavvyEntityItemProperty {
     private readonly Navvy;
+    /**
+     * Добавляет дополнительное свойство элементов.
+     */
     add(param: iBXRestGenericParams): import("../../../services/navvy").NavvySimple<boolean, boolean, 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/entity/item.d.ts

@@ -2,9 +2,24 @@ import { iBXRestGenericObject, iBXRestGenericParams } from '../../typification/r
 import { BXRestNavvyEntityItemProperty } from './item/property';
 export declare class BXRestNavvyEntityItem {
     private readonly Navvy;
+    /**
+     * Дополнительные свойства элементов хранилища (`entity.item.property.*`).
+     */
     readonly property: BXRestNavvyEntityItemProperty;
+    /**
+     * Добавляет элемент хранилища.
+     */
     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>;
 }